AccountsApi

@nevermined-io/sdk - v3.0.44 / AccountsApi

Class: AccountsApi

Nevermined Accounts API. It allows execute operations related with Ethereum accounts.

Hierarchy

Instantiable
↳ AccountsApi

Constructors

constructor

Accessors

Methods

Constructors

constructor

• new AccountsApi(config): AccountsApi

Creates a new AccountsApi

Parameters

Name	Type	Description
`config`	`InstantiableConfig`	Configuration of the Nevermined instance

Accessors

artifactsFolder

• get artifactsFolder(): undefined | string

Returns

undefined | string

Inherited from

Instantiable.artifactsFolder

Defined in

src/Instantiable.abstract.ts:137

circuitsFolder

• get circuitsFolder(): undefined | string

Returns

undefined | string

Inherited from

Instantiable.circuitsFolder

Defined in

src/Instantiable.abstract.ts:141

client

• get client(): Web3Clients

Returns

Web3Clients

Inherited from

Instantiable.client

Defined in

src/Instantiable.abstract.ts:89

config

• get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

Instantiable.config

Defined in

src/Instantiable.abstract.ts:120

instanceConfig

• get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

Instantiable.instanceConfig

Defined in

src/Instantiable.abstract.ts:145

instantiableConfig

• get instantiableConfig(): undefined | InstantiableConfig

Returns

undefined | InstantiableConfig

Inherited from

Instantiable.instantiableConfig

Defined in

src/Instantiable.abstract.ts:113

logger

• get logger(): Logger

Returns

Logger

Inherited from

Instantiable.logger

Defined in

src/Instantiable.abstract.ts:128

nevermined

• get nevermined(): Nevermined

Returns

Nevermined

Inherited from

Instantiable.nevermined

Defined in

src/Instantiable.abstract.ts:81

publicClient

• get publicClient(): Object

Returns

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 configuration.
`chain`	`undefined` \| `Chain`	Chain for the client.
`createBlockFilter`	() => `Promise`\<{ `id`: `0x${string}` ; `request`: `EIP1193RequestFn`\<readonly [{ `Method`: `"eth_getFilterChanges"` ; `Parameters`: [filterId: `0x${string}`] ; `ReturnType`: `0x${string}`[] \| `RpcLog`[] }, { `Method`: `"eth_getFilterLogs"` ; `Parameters`: [filterId: `0x${string}`] ; `ReturnType`: `RpcLog`[] }, { `Method`: `"eth_uninstallFilter"` ; `Parameters`: [filterId: `0x${string}`] ; `ReturnType`: `boolean` }]> ; `type`: `"block"` }>	-
`createContractEventFilter`	\<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(`args`: `CreateContractEventFilterParameters`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`>) => `Promise`\<`CreateContractEventFilterReturnType`\<`TAbi`, `TEventName`, `TArgs`, `TStrict`, `TFromBlock`, `TToBlock`>>	-
`createEventFilter`	\<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(`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`\<readonly [{ `Method`: `"eth_getFilterChanges"` ; `Parameters`: [filterId: `0x${string}`] ; `ReturnType`: `0x${string}`[] \| `RpcLog`[] }, { `Method`: `"eth_getFilterLogs"` ; `Parameters`: [filterId: `0x${string}`] ; `ReturnType`: `RpcLog`[] }, { `Method`: `"eth_uninstallFilter"` ; `Parameters`: [filterId: `0x${string}`] ; `ReturnType`: `boolean` }]> ; `type`: `"transaction"` }>	-
`estimateContractGas`	\<TChain, abi, functionName, args>(`args`: `EstimateContractGasParameters`\<`abi`, `functionName`, `args`, `TChain`>) => `Promise`\<`bigint`>	-
`estimateFeesPerGas`	\<TChainOverride, TType>(`args?`: `EstimateFeesPerGasParameters`\<`undefined` \| `Chain`, `TChainOverride`, `TType`>) => `Promise`\<`EstimateFeesPerGasReturnType`>	-
`estimateGas`	(`args`: `EstimateGasParameters`\<`undefined` \| `Chain`>) => `Promise`\<`bigint`>	-
`estimateMaxPriorityFeePerGas`	\<TChainOverride>(`args?`: { `chain`: `null` \| `TChainOverride` }) => `Promise`\<`bigint`>	-
`extend`	\<client>(`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`	\<TIncludeTransactions, TBlockTag>(`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`	\<abi, eventName, strict, fromBlock, toBlock>(`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`	\<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>(`args`: `GetFilterChangesParameters`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`>) => `Promise`\<`GetFilterChangesReturnType`\<`TFilterType`, `TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`>>	-
`getFilterLogs`	\<TAbi, TEventName, TStrict, TFromBlock, TToBlock>(`args`: `GetFilterLogsParameters`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`>) => `Promise`\<`GetFilterLogsReturnType`\<`TAbi`, `TEventName`, `TStrict`, `TFromBlock`, `TToBlock`>>	-
`getGasPrice`	() => `Promise`\<`bigint`>	-
`getLogs`	\<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>(`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`	\<TBlockTag>(`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`	\<contracts, allowFailure>(`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`	\<TRequest, TChainOverride, TAccountOverride>(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`>) => `Promise`\<{ [K in string \| number \| symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" \| "gas" \| "nonce" \| "blobVersionedHashes" \| "chainId" \| "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[K] }>	-
`readContract`	\<abi, functionName, args>(`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`	\<abi, functionName, args, chainOverride, accountOverride>(`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`	\<TIncludeTransactions, TBlockTag>(`args`: `WatchBlocksParameters`\<`Transport`, `undefined` \| `Chain`, `TIncludeTransactions`, `TBlockTag`>) => `WatchBlocksReturnType`	-
`watchContractEvent`	\<TAbi, TEventName, TStrict>(`args`: `WatchContractEventParameters`\<`TAbi`, `TEventName`, `TStrict`, `Transport`>) => `WatchContractEventReturnType`	-
`watchEvent`	\<TAbiEvent, TAbiEvents, TStrict>(`args`: `WatchEventParameters`\<`TAbiEvent`, `TAbiEvents`, `TStrict`, `Transport`>) => `WatchEventReturnType`	-
`watchPendingTransactions`	(`args`: `WatchPendingTransactionsParameters`\<`Transport`>) => `WatchPendingTransactionsReturnType`	-

Inherited from

Instantiable.publicClient

Defined in

src/Instantiable.abstract.ts:97

walletClient

• get walletClient(): Object

Returns

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 configuration.
`chain`	`undefined` \| `Chain`	Chain for the client.
`deployContract`	\<abi, chainOverride>(`args`: `DeployContractParameters`\<`abi`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`>) => `Promise`\<`0x${string}`>	-
`extend`	\<client>(`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`	\<TRequest, TChainOverride, TAccountOverride>(`args`: `PrepareTransactionRequestParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TAccountOverride`, `TRequest`>) => `Promise`\<{ [K in string \| number \| symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" \| "gas" \| "nonce" \| "blobVersionedHashes" \| "chainId" \| "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[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`	\<TRequest, TChainOverride>(`args`: `SendTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`, `TRequest`>) => `Promise`\<`0x${string}`>	-
`signMessage`	(`args`: `SignMessageParameters`\<`undefined` \| `Account`>) => `Promise`\<`0x${string}`>	-
`signTransaction`	\<TChainOverride>(`args`: `SignTransactionParameters`\<`undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`>) => `Promise`\<`0x02${string}` \| `0x01${string}` \| `0x03${string}` \| `TransactionSerializedLegacy`>	-
`signTypedData`	\<TTypedData, TPrimaryType>(`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`	\<abi, functionName, args, TChainOverride>(`args`: `WriteContractParameters`\<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `TChainOverride`>) => `Promise`\<`0x${string}`>	-

Inherited from

Instantiable.walletClient

Defined in

src/Instantiable.abstract.ts:105

Methods

addresses

▸ addresses(): Promise\<string[]>

Returns the list of addresses (Local or Json-Rpc)

Returns

Promise\<string[]>

The list of addresses.

Defined in

src/nevermined/api/AccountsApi.ts:70

findAccount

▸ findAccount(from): undefined | NvmAccount

Given an address, it returns the account if it exists in the list of accounts.

Parameters

Name	Type
`from`	`string`

Returns

undefined | NvmAccount

Defined in

src/nevermined/api/AccountsApi.ts:56

getAccount

▸ getAccount(address): NvmAccount

Returns an account initialized with existing web3 provider

Parameters

Name	Type	Description
`address`	`string`	The account address

Returns

NvmAccount

The account

Defined in

src/nevermined/api/AccountsApi.ts:47

getBalance

▸ getBalance(account): Promise\<Balance>

It gets the balance of the native token (i.e ETH) and the ERC20 token associated to the account

Parameters

Name	Type	Description
`account`	`string` \| `NvmAccount`	Account instance or the address of the account to get the balance

Returns

Promise\<Balance>

The balance of the ERC20 and Native tokens

Defined in

src/nevermined/api/AccountsApi.ts:188

getEtherBalance

▸ getEtherBalance(account): Promise\<bigint>

It gets the native token (i.e ETH) balance of an account

Parameters

Name	Type	Description
`account`	`string` \| `NvmAccount`	Account instance or the address of the account to get the balance

Returns

Promise\<bigint>

the balance of the native token

Defined in

src/nevermined/api/AccountsApi.ts:177

getNeverminedBalance

▸ getNeverminedBalance(account): Promise\<bigint>

It gets the balance of the ERC20 Token loaded in the Nevermined instance

Parameters

Name	Type	Description
`account`	`string` \| `NvmAccount`	Account instance or the address of the account to get the balance

Returns

Promise\<bigint>

the balance of ERC20 Token related to the account

Defined in

src/nevermined/api/AccountsApi.ts:164

list

▸ list(): NvmAccount[]

Returns the list of accounts (Local or Json-Rpc)

Returns

NvmAccount[]

The list of accounts.

Defined in

src/nevermined/api/AccountsApi.ts:25

listBrowserAccounts

▸ listBrowserAccounts(): Promise\<NvmAccount[]>

Returns the list of accounts (JSON-RPC), only can be used by providers like metamask, Status or Trustwallet but not by default provider

Returns

Promise\<NvmAccount[]>

The list of accounts.

Defined in

src/nevermined/api/AccountsApi.ts:35

requestTokens

▸ requestTokens(account, amount, txParams?): Promise\<boolean>

Request tokens for an account.

Parameters

Name	Type	Description
`account`	`string` \| `NvmAccount`	Account instance or the address of the account to receive the tokens
`amount`	`bigint`	Token amount to request
`txParams?`	`TxParameters`	Transaction parameters

Returns

Promise\<boolean>

true if the call was successful. false otherwise.

Defined in

src/nevermined/api/AccountsApi.ts:138

setInstanceConfig

▸ setInstanceConfig(config): void

Parameters

Name	Type
`config`	`InstantiableConfig`

Returns

void

Inherited from

Instantiable.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:163

signTextWithRemoteAccount

▸ signTextWithRemoteAccount(text, from): Promise\<`0x${string}`>

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

Returns

Promise\<`0x${string}`>

the message signed message

Defined in

src/nevermined/api/AccountsApi.ts:80

signTransactionWithRemoteAccount

▸ signTransactionWithRemoteAccount(data, from): Promise\<`0x${string}`>

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

Returns

Promise\<`0x${string}`>

the signed transaction

Defined in

src/nevermined/api/AccountsApi.ts:97

signTypedData

▸ signTypedData(domain, types, value, from): Promise\<`0x${string}`>

It signs a typed data using a remote account

Parameters

Name	Type	Description
`domain`	`TypedDataDomain`	the domain of the typed data
`types`	`TypedDataTypes`	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

Promise\<`0x${string}`>

the signed typed data

Defined in

src/nevermined/api/AccountsApi.ts:116

getInstance

▸ getInstance(..._args): any

Parameters

Name	Type
`..._args`	`any`

Returns

any

Inherited from

Instantiable.getInstance

Defined in

src/Instantiable.abstract.ts:150

setInstanceConfig

▸ setInstanceConfig\<T>(instance, instantiableConfig): void

Type parameters

Name	Type
`T`	extends `Instantiable`

Parameters

Name	Type
`instance`	`T`
`instantiableConfig`	`InstantiableConfig`

Returns

void

Inherited from

Instantiable.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:154

Class: AccountsApi

Hierarchy​

Table of contents​

Constructors​

Accessors​

Methods​

Constructors​

constructor​

Parameters​

Returns​

Overrides​

Defined in​

Accessors​

artifactsFolder​

Returns​

Inherited from​

Defined in​

circuitsFolder​

Returns​

Inherited from​

Defined in​

client​

Returns​

Inherited from​

Defined in​

config​

Returns​

Inherited from​

Defined in​

instanceConfig​

Returns​

Inherited from​

Defined in​

instantiableConfig​

Returns​

Inherited from​

Defined in​

logger​

Returns​

Inherited from​

Defined in​

nevermined​

Returns​

Inherited from​

Defined in​

publicClient​

Returns​

Inherited from​

Defined in​

walletClient​

Returns​

Inherited from​

Defined in​

Methods​

addresses​

Returns​

Defined in​

findAccount​

Parameters​

Returns​

Defined in​

getAccount​

Parameters​

Returns​

Defined in​

getBalance​

Parameters​

Returns​

Defined in​

getEtherBalance​

Parameters​

Returns​

Defined in​

getNeverminedBalance​

Parameters​

Returns​

Defined in​

list​

Returns​

Defined in​

Hierarchy

Table of contents

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns

Overrides

Defined in

Accessors

artifactsFolder

Returns

Inherited from

Defined in

circuitsFolder

Returns

Inherited from

Defined in

client

Returns

Inherited from

Defined in

config

Returns

Inherited from

Defined in

instanceConfig

Returns

Inherited from

Defined in

instantiableConfig

Returns

Inherited from

Defined in

logger

Returns

Inherited from

Defined in

nevermined

Returns

Inherited from

Defined in

publicClient

Returns

Inherited from

Defined in

walletClient

Returns

Inherited from

Defined in

Methods

addresses

Returns

Defined in

findAccount

Parameters

Returns

Defined in

getAccount

Parameters

Returns

Defined in

getBalance

Parameters

Returns

Defined in

getEtherBalance

Parameters

Returns

Defined in

getNeverminedBalance

Parameters

Returns

Defined in

list

Returns

Defined in

listBrowserAccounts