sdk-js

@nevermined-io/sdk - v3.1.2 / NeverminedNode

Class: NeverminedNode

Provides a interface with Nevermined Node. The Nevermined Node is the technical component executed by the Publishers allowing to them to provide extended data services.

Hierarchy

Instantiable

↳ NeverminedNode

Constructors

constructor

Accessors

Methods

Constructors

constructor

• new NeverminedNode(config): NeverminedNode

Parameters

Name	Type
`config`	`InstantiableConfig`

Accessors

artifactsFolder

• get artifactsFolder(): undefined | string

Returns

undefined | string

Inherited from

Instantiable.artifactsFolder

Defined in

src/Instantiable.abstract.ts:136

circuitsFolder

• get circuitsFolder(): undefined | string

Returns

undefined | string

Inherited from

Instantiable.circuitsFolder

Defined in

src/Instantiable.abstract.ts:140

client

• get client(): Web3Clients

Returns

Web3Clients

Inherited from

Instantiable.client

Defined in

src/Instantiable.abstract.ts:88

config

• get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

Instantiable.config

Defined in

src/Instantiable.abstract.ts:119

instanceConfig

• get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

Instantiable.instanceConfig

Defined in

src/Instantiable.abstract.ts:144

instantiableConfig

• get instantiableConfig(): undefined | InstantiableConfig

Returns

undefined | InstantiableConfig

Inherited from

Instantiable.instantiableConfig

Defined in

src/Instantiable.abstract.ts:112

logger

• get logger(): Logger

Returns

Logger

Inherited from

Instantiable.logger

Defined in

src/Instantiable.abstract.ts:127

nevermined

• get nevermined(): Nevermined

Returns

Nevermined

Inherited from

Instantiable.nevermined

Defined in

src/Instantiable.abstract.ts:80

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.
`createAccessList`	(`parameters`: `CreateAccessListParameters`<`undefined` \| `Chain`>) => `Promise`<{ `accessList`: `AccessList` ; `gasUsed`: `bigint` }>	-
`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`	<abi, eventName, args, strict, fromBlock, toBlock>(`args`: `CreateContractEventFilterParameters`<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`>) => `Promise`<`CreateContractEventFilterReturnType`<`abi`, `eventName`, `args`, `strict`, `fromBlock`, `toBlock`>>	-
`createEventFilter`	<abiEvent, abiEvents, strict, fromBlock, toBlock, _EventName, _Args>(`args?`: `CreateEventFilterParameters`<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`, `_EventName`, `_Args`>) => `Promise`<{ [K in string \| number \| symbol]: Filter<“event”, abiEvents, _EventName, _Args, strict, fromBlock, toBlock>[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`	<chain, abi, functionName, args>(`args`: `EstimateContractGasParameters`<`abi`, `functionName`, `args`, `chain`>) => `Promise`<`bigint`>	-
`estimateFeesPerGas`	<chainOverride, type>(`args?`: `EstimateFeesPerGasParameters`<`undefined` \| `Chain`, `chainOverride`, `type`>) => `Promise`<`EstimateFeesPerGasReturnType`<`type`>>	-
`estimateGas`	(`args`: `EstimateGasParameters`<`undefined` \| `Chain`>) => `Promise`<`bigint`>	-
`estimateMaxPriorityFeePerGas`	<chainOverride>(`args?`: { `chain`: `null` \| `chainOverride` }) => `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`	<includeTransactions, blockTag>(`args?`: `GetBlockParameters`<`includeTransactions`, `blockTag`>) => `Promise`<{ `baseFeePerGas`: `null` \| `bigint` ; `blobGasUsed`: `bigint` ; `difficulty`: `bigint` ; `excessBlobGas`: `bigint` ; `extraData`: `0x${string}` ; `gasLimit`: `bigint` ; `gasUsed`: `bigint` ; `hash`: `blockTag` extends `"pending"` ? `null` : `0x${string}` ; `logsBloom`: `blockTag` extends `"pending"` ? `null` : `0x${string}` ; `miner`: `0x${string}` ; `mixHash`: `0x${string}` ; `nonce`: `blockTag` extends `"pending"` ? `null` : `0x${string}` ; `number`: `blockTag` extends `"pending"` ? `null` : `bigint` ; `parentBeaconBlockRoot?`: `0x${string}` ; `parentHash`: `0x${string}` ; `receiptsRoot`: `0x${string}` ; `sealFields`: `0x${string}`[] ; `sha3Uncles`: `0x${string}` ; `size`: `bigint` ; `stateRoot`: `0x${string}` ; `timestamp`: `bigint` ; `totalDifficulty`: `null` \| `bigint` ; `transactions`: `includeTransactions` extends `true` ? ({ `accessList?`: `undefined` ; `authorizationList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| { `accessList`: `AccessList` ; `authorizationList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| { `accessList`: `AccessList` ; `authorizationList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| { `accessList`: `AccessList` ; `authorizationList?`: `undefined` ; `blobVersionedHashes`: readonly `0x${string}`[] ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| { `accessList`: `AccessList` ; `authorizationList`: `SignedAuthorizationList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip7702"` ; `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`: `GetCodeParameters`) => `Promise`<`GetCodeReturnType`>	-
`getChainId`	() => `Promise`<`number`>	-
`getCode`	(`args`: `GetCodeParameters`) => `Promise`<`GetCodeReturnType`>	-
`getContractEvents`	<abi, eventName, strict, fromBlock, toBlock>(`args`: `GetContractEventsParameters`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`>) => `Promise`<`GetContractEventsReturnType`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`>>	-
`getEip712Domain`	(`args`: `GetEip712DomainParameters`) => `Promise`<`GetEip712DomainReturnType`>	-
`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`	<filterType, abi, eventName, strict, fromBlock, toBlock>(`args`: `GetFilterChangesParameters`<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`>) => `Promise`<`GetFilterChangesReturnType`<`filterType`, `abi`, `eventName`, `strict`, `fromBlock`, `toBlock`>>	-
`getFilterLogs`	<abi, eventName, strict, fromBlock, toBlock>(`args`: `GetFilterLogsParameters`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`>) => `Promise`<`GetFilterLogsReturnType`<`abi`, `eventName`, `strict`, `fromBlock`, `toBlock`>>	-
`getGasPrice`	() => `Promise`<`bigint`>	-
`getLogs`	<abiEvent, abiEvents, strict, fromBlock, toBlock>(`args?`: `GetLogsParameters`<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`>) => `Promise`<`GetLogsReturnType`<`abiEvent`, `abiEvents`, `strict`, `fromBlock`, `toBlock`>>	-
`getProof`	(`args`: `GetProofParameters`) => `Promise`<`GetProofReturnType`>	-
`getStorageAt`	(`args`: `GetStorageAtParameters`) => `Promise`<`GetStorageAtReturnType`>	-
`getTransaction`	<blockTag>(`args`: `GetTransactionParameters`<`blockTag`>) => `Promise`<{ `accessList?`: `undefined` ; `authorizationList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId?`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"legacy"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity?`: `undefined` } \| { `accessList`: `AccessList` ; `authorizationList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice`: `bigint` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas?`: `undefined` ; `maxPriorityFeePerGas?`: `undefined` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip2930"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| { `accessList`: `AccessList` ; `authorizationList?`: `undefined` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip1559"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| { `accessList`: `AccessList` ; `authorizationList?`: `undefined` ; `blobVersionedHashes`: readonly `0x${string}`[] ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas`: `bigint` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip4844"` ; `typeHex`: `null` \| `0x${string}` ; `v`: `bigint` ; `value`: `bigint` ; `yParity`: `number` } \| { `accessList`: `AccessList` ; `authorizationList`: `SignedAuthorizationList` ; `blobVersionedHashes?`: `undefined` ; `blockHash`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `0x${string}` ; `blockNumber`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `bigint` ; `chainId`: `number` ; `from`: `0x${string}` ; `gas`: `bigint` ; `gasPrice?`: `undefined` ; `hash`: `0x${string}` ; `input`: `0x${string}` ; `maxFeePerBlobGas?`: `undefined` ; `maxFeePerGas`: `bigint` ; `maxPriorityFeePerGas`: `bigint` ; `nonce`: `number` ; `r`: `0x${string}` ; `s`: `0x${string}` ; `to`: `null` \| `0x${string}` ; `transactionIndex`: `blockTag` extends `"pending"` ? `true` : `false` extends `true` ? `null` : `number` ; `type`: `"eip7702"` ; `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`	<request, chainOverride, accountOverride>(`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`, `request`>) => `Promise`<{ [K in string \| number \| symbol]: (UnionRequiredBy<Extract<UnionOmit<(…), (…)> & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)), IsNever<(…)> extends true ? unknown : ExactPartial<(…)>> & Object, ParameterTypeToParameters<request[“parameters”] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : “type” \| “fees” \| “gas” \| “nonce” \| “blobVersionedHashes” \| “chainId”>> & (unknown extends request[“kzg”] ? Object : Pick<request, “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}`>	-
`simulate`	<calls>(`args`: `SimulateParameters`<`calls`>) => `Promise`<`SimulateReturnType`<`calls`>>	-
`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`: { `address`: `0x${string}` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `factory?`: `0x${string}` ; `factoryData?`: `0x${string}` ; `message`: `SignableMessage` ; `signature`: `0x${string}` \| `Signature` \| `Uint8Array` ; `universalSignatureVerifierAddress?`: `0x${string}` }) => `Promise`<`boolean`>	-
`verifySiweMessage`	(`args`: { `address?`: `0x${string}` ; `blockNumber?`: `bigint` ; `blockTag?`: `BlockTag` ; `domain?`: `string` ; `message`: `string` ; `nonce?`: `string` ; `scheme?`: `string` ; `signature`: `0x${string}` ; `time?`: `Date` }) => `Promise`<`boolean`>	-
`verifyTypedData`	(`args`: `VerifyTypedDataParameters`) => `Promise`<`boolean`>	-
`waitForTransactionReceipt`	(`args`: `WaitForTransactionReceiptParameters`<`undefined` \| `Chain`>) => `Promise`<`TransactionReceipt`>	-
`watchBlockNumber`	(`args`: `WatchBlockNumberParameters`) => `WatchBlockNumberReturnType`	-
`watchBlocks`	<includeTransactions, blockTag>(`args`: `WatchBlocksParameters`<`Transport`, `undefined` \| `Chain`, `includeTransactions`, `blockTag`>) => `WatchBlocksReturnType`	-
`watchContractEvent`	<abi, eventName, strict>(`args`: `WatchContractEventParameters`<`abi`, `eventName`, `strict`, `Transport`>) => `WatchContractEventReturnType`	-
`watchEvent`	<abiEvent, abiEvents, strict>(`args`: `WatchEventParameters`<`abiEvent`, `abiEvents`, `strict`, `Transport`>) => `WatchEventReturnType`	-
`watchPendingTransactions`	(`args`: `WatchPendingTransactionsParameters`<`Transport`>) => `WatchPendingTransactionsReturnType`	-

Inherited from

Instantiable.publicClient

Defined in

src/Instantiable.abstract.ts:96

url

• get url(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:35

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`	<request, chainOverride, accountOverride>(`args`: `PrepareTransactionRequestParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `accountOverride`, `request`>) => `Promise`<{ [K in string \| number \| symbol]: (UnionRequiredBy<Extract<UnionOmit<(…), (…)> & ((…) extends (…) ? (…) : (…)) & ((…) extends (…) ? (…) : (…)), IsNever<(…)> extends true ? unknown : ExactPartial<(…)>> & Object, ParameterTypeToParameters<request[“parameters”] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : “type” \| “fees” \| “gas” \| “nonce” \| “blobVersionedHashes” \| “chainId”>> & (unknown extends request[“kzg”] ? Object : Pick<request, “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`	<request, chainOverride>(`args`: `SendTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `request`>) => `Promise`<`0x${string}`>	-
`signMessage`	(`args`: `SignMessageParameters`<`undefined` \| `Account`>) => `Promise`<`0x${string}`>	-
`signTransaction`	<chainOverride, request>(`args`: `SignTransactionParameters`<`undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`, `request`>) => `Promise`<`TransactionSerialized`<`GetTransactionType`<`request`, `request` extends `LegacyProperties` ? `"legacy"` : `never` \| `request` extends `EIP1559Properties` ? `"eip1559"` : `never` \| `request` extends `EIP2930Properties` ? `"eip2930"` : `never` \| `request` extends `EIP4844Properties` ? `"eip4844"` : `never` \| `request` extends `EIP7702Properties` ? `"eip7702"` : `never` \| `request`[`"type"`] extends `undefined` \| `string` ? `Extract`<`any`[`any`], `string`> : `never`>, `GetTransactionType`<`request`, `request` extends `LegacyProperties` ? `"legacy"` : `never` \| `request` extends `EIP1559Properties` ? `"eip1559"` : `never` \| `request` extends `EIP2930Properties` ? `"eip2930"` : `never` \| `request` extends `EIP4844Properties` ? `"eip4844"` : `never` \| `request` extends `EIP7702Properties` ? `"eip7702"` : `never` \| `request`[`"type"`] extends `undefined` \| `string` ? `Extract`<`any`[`any`], `string`> : `never`> extends `"eip1559"` ? `0x02${string}` : `never` \| `GetTransactionType`<`request`, `request` extends `LegacyProperties` ? `"legacy"` : `never` \| `request` extends `EIP1559Properties` ? `"eip1559"` : `never` \| `request` extends `EIP2930Properties` ? `"eip2930"` : `never` \| `request` extends `EIP4844Properties` ? `"eip4844"` : `never` \| `request` extends `EIP7702Properties` ? `"eip7702"` : `never` \| `request`[`"type"`] extends `undefined` \| `string` ? `Extract`<`any`[`any`], `string`> : `never`> extends `"eip2930"` ? `0x01${string}` : `never` \| `GetTransactionType`<`request`, `request` extends `LegacyProperties` ? `"legacy"` : `never` \| `request` extends `EIP1559Properties` ? `"eip1559"` : `never` \| `request` extends `EIP2930Properties` ? `"eip2930"` : `never` \| `request` extends `EIP4844Properties` ? `"eip4844"` : `never` \| `request` extends `EIP7702Properties` ? `"eip7702"` : `never` \| `request`[`"type"`] extends `undefined` \| `string` ? `Extract`<`any`[`any`], `string`> : `never`> extends `"eip4844"` ? `0x03${string}` : `never` \| `GetTransactionType`<`request`, `request` extends `LegacyProperties` ? `"legacy"` : `never` \| `request` extends `EIP1559Properties` ? `"eip1559"` : `never` \| `request` extends `EIP2930Properties` ? `"eip2930"` : `never` \| `request` extends `EIP4844Properties` ? `"eip4844"` : `never` \| `request` extends `EIP7702Properties` ? `"eip7702"` : `never` \| `request`[`"type"`] extends `undefined` \| `string` ? `Extract`<`any`[`any`], `string`> : `never`> extends `"eip7702"` ? `0x04${string}` : `never` \| `GetTransactionType`<`request`, `request` extends `LegacyProperties` ? `"legacy"` : `never` \| `request` extends `EIP1559Properties` ? `"eip1559"` : `never` \| `request` extends `EIP2930Properties` ? `"eip2930"` : `never` \| `request` extends `EIP4844Properties` ? `"eip4844"` : `never` \| `request` extends `EIP7702Properties` ? `"eip7702"` : `never` \| `request`[`"type"`] extends `undefined` \| `string` ? `Extract`<`any`[`any`], `string`> : `never`> extends `"legacy"` ? `TransactionSerializedLegacy` : `never`>>	-
`signTypedData`	<typedData, primaryType>(`args`: `SignTypedDataParameters`<`typedData`, `primaryType`, `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, chainOverride>(`args`: `WriteContractParameters`<`abi`, `functionName`, `args`, `undefined` \| `Chain`, `undefined` \| `Account`, `chainOverride`>) => `Promise`<`0x${string}`>	-

Inherited from

Instantiable.walletClient

Defined in

src/Instantiable.abstract.ts:104

Methods

claimNFT

▸ claimNFT(agreementId, nftHolder, nftReceiver, nftAmount, ercType?, did?, serviceIndex?): Promise<boolean>

Parameters

Name	Type	Default value
`agreementId`	`string`	`undefined`
`nftHolder`	`string`	`undefined`
`nftReceiver`	`string`	`undefined`
`nftAmount`	`bigint`	`undefined`
`ercType`	`ERCType`	`1155`
`did?`	`string`	`undefined`
`serviceIndex?`	`number`	`undefined`

Returns

Promise<boolean>

Defined in

src/services/node/NeverminedNode.ts:383

computeLogs

▸ computeLogs(agreementId, executionId, account): Promise<any>

Parameters

Name	Type
`agreementId`	`string`
`executionId`	`string`
`account`	`NvmAccount`

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:313

computeStatus

▸ computeStatus(agreementId, executionId, account): Promise<any>

Parameters

Name	Type
`agreementId`	`string`
`executionId`	`string`
`account`	`NvmAccount`

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:348

consumeService

▸ consumeService(did, agreementId, serviceEndpoint, account, files, destination, index?, result?, buyer?, babysig?): Promise<string>

Parameters

Name	Type	Default value
`did`	`string`	`undefined`
`agreementId`	`string`	`undefined`
`serviceEndpoint`	`string`	`undefined`
`account`	`NvmAccount`	`undefined`
`files`	`MetaDataExternalResource`[]	`undefined`
`destination`	`undefined` \| `string`	`undefined`
`index`	`number`	`-1`
`result`	`AssetResult`	`AssetResult.DATA`
`buyer?`	`string`	`undefined`
`babysig?`	`Babysig`	`undefined`

Returns

Promise<string>

Defined in

src/services/node/NeverminedNode.ts:177

downloadService

▸ downloadService(files, destination, index?, headers?, result?): Promise<string>

Parameters

Name	Type	Default value
`files`	`MetaDataExternalResource`[]	`undefined`
`destination`	`undefined` \| `string`	`undefined`
`index`	`number`	`-1`
`headers?`	`Object`	`undefined`
`result`	`AssetResult`	`AssetResult.DATA`

Returns

Promise<string>

Defined in

src/services/node/NeverminedNode.ts:244

encrypt

▸ encrypt(did, document, method): Promise<any>

Parameters

Name	Type
`did`	`any`
`document`	`any`
`method`	`any`

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:224

execute

▸ execute(agreementId, workflowDid, account): Promise<any>

Parameters

Name	Type
`agreementId`	`string`
`workflowDid`	`string`
`account`	`NvmAccount`

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:273

fetchToken

▸ fetchToken(grantToken, numberTries?, nvmApiKey?): Promise<string>

Parameters

Name	Type	Default value
`grantToken`	`string`	`undefined`
`numberTries`	`number`	`3`
`nvmApiKey?`	`string`	`undefined`

Returns

Promise<string>

Defined in

src/services/node/NeverminedNode.ts:432

getAccessEndpoint

▸ getAccessEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:56

getAccessProofEndpoint

▸ getAccessProofEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:60

getBabyjubPublicKey

▸ getBabyjubPublicKey(): Promise<any>

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:143

getClaimNftEndpoint

▸ getClaimNftEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:116

getComputeLogsEndpoint

▸ getComputeLogsEndpoint(executionId): string

Parameters

Name	Type
`executionId`	`string`

Returns

string

Defined in

src/services/node/NeverminedNode.ts:68

getComputeStatusEndpoint

▸ getComputeStatusEndpoint(executionId): string

Parameters

Name	Type
`executionId`	`string`

Returns

string

Defined in

src/services/node/NeverminedNode.ts:72

getConsumeEndpoint

▸ getConsumeEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:52

getDownloadEndpoint

▸ getDownloadEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:148

getEcdsaPublicKey

▸ getEcdsaPublicKey(): Promise<any>

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:138

getEncryptEndpoint

▸ getEncryptEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:80

getExecuteEndpoint

▸ getExecuteEndpoint(serviceAgreementId): string

Parameters

Name	Type
`serviceAgreementId`	`string`

Returns

string

Defined in

src/services/node/NeverminedNode.ts:76

getFetchTokenEndpoint

▸ getFetchTokenEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:84

getFetchTokenWithNvmApiKeyEndpoint

▸ getFetchTokenWithNvmApiKeyEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:88

getNeverminedNodeInfo

▸ getNeverminedNodeInfo(): Promise<any>

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:124

getNft721Endpoint

▸ getNft721Endpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:108

getNftAccessEndpoint

▸ getNftAccessEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:112

getNftEndpoint

▸ getNftEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:104

getProviderAddress

▸ getProviderAddress(): Promise<any>

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:128

getPurchaseEndpoint

▸ getPurchaseEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:48

getRsaPublicKey

▸ getRsaPublicKey(): Promise<any>

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:133

getServiceEndpoint

▸ getServiceEndpoint(service): string

Parameters

Name	Type
`service`	`string`

Returns

string

Defined in

src/services/node/NeverminedNode.ts:64

getSubscriptionToken

▸ getSubscriptionToken(did, account): Promise<SubscriptionToken>

Parameters

Name	Type
`did`	`string`
`account`	`NvmAccount`

Returns

Promise<SubscriptionToken>

Defined in

src/services/node/NeverminedNode.ts:507

getSubscriptionsEndpoint

▸ getSubscriptionsEndpoint(did): string

Parameters

Name	Type
`did`	`string`

Returns

string

Defined in

src/services/node/NeverminedNode.ts:120

getUploadFilecoinEndpoint

▸ getUploadFilecoinEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:92

getUploadIPFSEndpoint

▸ getUploadIPFSEndpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:96

getUploadS3Endpoint

▸ getUploadS3Endpoint(): string

Returns

string

Defined in

src/services/node/NeverminedNode.ts:100

getVersionInfo

▸ getVersionInfo(): Promise<any>

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:44

initializeServiceAgreement

▸ initializeServiceAgreement(did, serviceAgreementId, serviceIndex, signature, consumerAddress): Promise<any>

Parameters

Name	Type
`did`	`string`
`serviceAgreementId`	`string`
`serviceIndex`	`number`
`signature`	`string`
`consumerAddress`	`string`

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:152

publishImmutableContent

▸ publishImmutableContent(ddo, publishMetadata?): Promise<{ backend: ImmutableBackends ; url: string }>

Parameters

Name	Type	Default value
`ddo`	`DDO`	`undefined`
`publishMetadata`	`PublishMetadataOptions`	`PublishMetadataOptions.IPFS`

Returns

Promise<{ backend: ImmutableBackends ; url: string }>

Defined in

src/services/node/NeverminedNode.ts:453

setInstanceConfig

▸ setInstanceConfig(config): void

Parameters

Name	Type
`config`	`InstantiableConfig`

Returns

void

Inherited from

Instantiable.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:162

uploadContent

▸ uploadContent(data, encrypt?, backend?): Promise<any>

Parameters

Name	Type	Default value
`data`	`string` \| `ReadStream`	`undefined`
`encrypt?`	`boolean`	`undefined`
`backend`	`NodeUploadBackends`	`NodeUploadBackends.Filecoin`

Returns

Promise<any>

Defined in

src/services/node/NeverminedNode.ts:479

getInstance

▸ getInstance(..._args): any

Parameters

Name	Type
`..._args`	`any`

Returns

any

Inherited from

Instantiable.getInstance

Defined in

src/Instantiable.abstract.ts:149

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:153

This site is open source. Improve this page.

sdk-js

Class: NeverminedNode

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

url

Returns

Defined in

walletClient

Returns

Inherited from

Defined in

Methods

claimNFT

Parameters

Returns

Defined in

computeLogs

Parameters

Returns

Defined in

computeStatus

Parameters

Returns

Defined in

consumeService

Parameters

Returns

Defined in

downloadService

Parameters

Returns

Defined in

encrypt

Parameters