sdk-js

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

Class: BaseTemplate<Params, S>

Type parameters

Name	Type
`Params`	`Params`
`S`	extends `Service`

Hierarchy

AgreementTemplate<Params>

↳ BaseTemplate

↳↳ AccessTemplate

↳↳ DIDSalesTemplate

↳↳ EscrowComputeExecutionTemplate

↳↳ NFT721AccessTemplate

↳↳ NFT721SalesTemplate

↳↳ NFTAccessTemplate

↳↳ NFTSalesTemplate

Implements

ServicePlugin<S>

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new BaseTemplate<Params, S>(contractName): BaseTemplate<Params, S>

Type parameters

Name	Type
`Params`	`Params`
`S`	extends `ServiceCommon`

Parameters

Name	Type
`contractName`	`string`

Returns

BaseTemplate<Params, S>

Inherited from

AgreementTemplate.constructor

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51

Properties

address

• address: `0x${string}`

Inherited from

AgreementTemplate.address

Defined in

src/keeper/contracts/ContractBase.ts:22

contract

• contract: any

Inherited from

AgreementTemplate.contract

Defined in

src/keeper/contracts/ContractBase.ts:19

contractName

• Readonly contractName: string

version

• version: string

Inherited from

AgreementTemplate.version

Defined in

src/keeper/contracts/ContractBase.ts:21

Accessors

artifactsFolder

• get artifactsFolder(): undefined | string

Returns

undefined | string

Inherited from

AgreementTemplate.artifactsFolder

Defined in

src/Instantiable.abstract.ts:137

circuitsFolder

• get circuitsFolder(): undefined | string

Returns

undefined | string

Inherited from

AgreementTemplate.circuitsFolder

Defined in

src/Instantiable.abstract.ts:141

client

• get client(): Web3Clients

Returns

Web3Clients

Inherited from

AgreementTemplate.client

Defined in

src/Instantiable.abstract.ts:89

config

• get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

AgreementTemplate.config

Defined in

src/Instantiable.abstract.ts:120

instanceConfig

• get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

AgreementTemplate.instanceConfig

Defined in

src/Instantiable.abstract.ts:145

instantiableConfig

• get instantiableConfig(): undefined | InstantiableConfig

Returns

undefined | InstantiableConfig

Inherited from

AgreementTemplate.instantiableConfig

Defined in

src/Instantiable.abstract.ts:113

logger

• get logger(): Logger

Returns

Logger

Inherited from

AgreementTemplate.logger

Defined in

src/Instantiable.abstract.ts:128

nevermined

• get nevermined(): Nevermined

Returns

Nevermined

Inherited from

AgreementTemplate.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

AgreementTemplate.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

AgreementTemplate.walletClient

Defined in

src/Instantiable.abstract.ts:105

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

agreementId

▸ agreementId(agreementIdSeed, creator): Promise<string>

Parameters

Name	Type
`agreementIdSeed`	`string`
`creator`	`string`

Returns

Promise<string>

Inherited from

AgreementTemplate.agreementId

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202

call

▸ call<T>(functionName, args, from?): Promise<T>

Type parameters

Name
`T`

Parameters

Name	Type
`functionName`	`string`
`args`	`any`[]
`from?`	`string`

Returns

Promise<T>

Inherited from

AgreementTemplate.call

Defined in

src/keeper/contracts/ContractBase.ts:92

conditions

▸ conditions(): Condition<any, any>[]

Returns

Condition<any, any>[]

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:42

createAgreement

▸ createAgreement(agreementId, did, conditionIds, timeLocks, timeOuts, extraArgs, from, txParams?): Promise<any>

Parameters

Name	Type
`agreementId`	`string`
`did`	`string`
`conditionIds`	`string`[]
`timeLocks`	`number`[]
`timeOuts`	`number`[]
`extraArgs`	`any`[]
`from`	`NvmAccount`
`txParams?`	`TxParameters`

Returns

Promise<any>

Inherited from

AgreementTemplate.createAgreement

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73

createAgreementAndPay

▸ createAgreementAndPay(agreementId, did, conditionIds, timeLocks, timeOuts, accessConsumer, condIdx, rewardAddress, tokenAddress, amounts, receivers, from, txParams?): Promise<any>

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`
`txParams?`	`TxParameters`

Returns

Promise<any>

Inherited from

AgreementTemplate.createAgreementAndPay

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98

createAgreementFromDDO

▸ createAgreementFromDDO(agreementIdSeed, ddo, parameters, consumer, timeOuts?, txParams?): Promise<string>

Create a new agreement using the data of a DDO.

Parameters

Name	Type	Description
`agreementIdSeed`	`string`	-
`ddo`	`DDO`	DDO.
`parameters`	`Params`
`consumer`	`NvmAccount`	-
`timeOuts?`	`number`[]	-
`txParams?`	`TxParameters`	-

Returns

Promise<string>

true if the call was successful.

Inherited from

AgreementTemplate.createAgreementFromDDO

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211

createAgreementWithPaymentFromDDO

▸ createAgreementWithPaymentFromDDO(agreementIdSeed, ddo, serviceReference, parameters, consumer, from, txParams?, observer?): Promise<string>

Parameters

Name	Type
`agreementIdSeed`	`string`
`ddo`	`DDO`
`serviceReference`	`number` \| `ServiceType`
`parameters`	`Params`
`consumer`	`NvmAccount`
`from`	`NvmAccount`
`txParams?`	`TxParameters`
`observer?`	(`orderProgressStep`: `OrderProgressStep`) => `void`

Returns

Promise<string>

Inherited from

AgreementTemplate.createAgreementWithPaymentFromDDO

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240

createService

▸ createService(publisher, metadata, serviceAttributes, nftAttributes?, priceData?): S

Parameters

Name	Type
`publisher`	`NvmAccount`
`metadata`	`MetaData`
`serviceAttributes`	`ServiceAttributes`
`nftAttributes?`	`NFTAttributes`
`priceData?`	`PricedMetadataInformation`

Returns

S

Implementation of

ServicePlugin.createService

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:48

description

▸ description(): string

Returns

string

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:41

extraGen

▸ extraGen(_params): Promise<any>

Parameters

Name	Type
`_params`	`ValidationParams`

Returns

Promise<any>

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:110

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.getAgreementCreatedEvent

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450

getAgreementData

▸ getAgreementData(agreementId): Promise<{ accessConsumer: string ; accessProvider: string ; did: string }>

Parameters

Name	Type
`agreementId`	`string`

Returns

Promise<{ accessConsumer: string ; accessProvider: string ; did: string }>

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:29

getAgreementIdsFromDDO

▸ getAgreementIdsFromDDO(agreementId, ddo, creator, params): Promise<string[]>

Get agreement conditions IDs.

Parameters

Name	Type	Description
`agreementId`	`string`	Agreement ID.
`ddo`	`DDO`	DDO.
`creator`	`string`	-
`params`	`Params`	-

Returns

Promise<string[]>

The condition IDs.

Inherited from

AgreementTemplate.getAgreementIdsFromDDO

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169

getAgreementStatus

▸ getAgreementStatus(agreementId): Promise<false | AgreementConditionsStatus>

Returns the status of the conditions.

Parameters

Name	Type	Description
`agreementId`	`string`	Agreement ID.

Returns

Promise<false | AgreementConditionsStatus>

The conditions status.

Inherited from

AgreementTemplate.getAgreementStatus

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331

getAgreementsForDID

▸ getAgreementsForDID(did): Promise<string[]>

Parameters

Name	Type
`did`	`string`

Returns

Promise<string[]>

Inherited from

AgreementTemplate.getAgreementsForDID

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476

getConditionTypes

▸ getConditionTypes(): Promise<string[]>

Conditions address list.

Returns

Promise<string[]>

A list of condition addresses.

Inherited from

AgreementTemplate.getConditionTypes

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137

getConditions

▸ getConditions(): Promise<ConditionSmall[]>

List of condition contracts.

Returns

Promise<ConditionSmall[]>

A list of condition contracts.

Inherited from

AgreementTemplate.getConditions

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148

getFromAddress

▸ getFromAddress(from?): Promise<string>

Parameters

Name	Type
`from?`	`string`

Returns

Promise<string>

Inherited from

AgreementTemplate.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:68

getServiceAgreementTemplate

▸ getServiceAgreementTemplate(): ServiceAgreementTemplate

Returns

ServiceAgreementTemplate

Inherited from

AgreementTemplate.getServiceAgreementTemplate

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:307

getServiceAgreementTemplateConditionByRef

▸ getServiceAgreementTemplateConditionByRef(ref): Promise<undefined | ConditionSmall>

Parameters

Name	Type
`ref`	`string`

Returns

Promise<undefined | ConditionSmall>

Inherited from

AgreementTemplate.getServiceAgreementTemplateConditionByRef

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314

getServiceAgreementTemplateConditions

▸ getServiceAgreementTemplateConditions(): ServiceAgreementTemplateCondition[]

Returns

ServiceAgreementTemplateCondition[]

Inherited from

AgreementTemplate.getServiceAgreementTemplateConditions

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309

getServiceAgreementTemplateDependencies

▸ getServiceAgreementTemplateDependencies(): Promise<{ [condition: string]: string[]; }>

Returns

Promise<{ [condition: string]: string[]; }>

Inherited from

AgreementTemplate.getServiceAgreementTemplateDependencies

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321

getTransactionLogs

▸ getTransactionLogs(txReceipt, eventName): ParseEventLogsReturnType<any, string, false, string>

Parameters

Name	Type
`txReceipt`	`TransactionReceipt`
`eventName`	`string`

Returns

ParseEventLogsReturnType<any, string, false, string>

Inherited from

AgreementTemplate.getTransactionLogs

Defined in

src/keeper/contracts/ContractBase.ts:76

init

▸ init(config, optional?, contractAddress?): Promise<void>

Parameters

Name	Type	Default value
`config`	`InstantiableConfig`	`undefined`
`optional`	`boolean`	`false`
`contractAddress?`	`string`	`undefined`

Returns

Promise<void>

Inherited from

AgreementTemplate.init

Defined in

src/keeper/contracts/ContractBase.ts:29

instanceFromDDO

▸ instanceFromDDO(agreementIdSeed, ddo, creator, parameters, serviceIndex?): Promise<AgreementInstance<Params>>

Parameters

Name	Type
`agreementIdSeed`	`string`
`ddo`	`DDO`
`creator`	`string`
`parameters`	`Params`
`serviceIndex?`	`number`

Returns

Promise<AgreementInstance<Params>>

Inherited from

AgreementTemplate.instanceFromDDO

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:179

lockConditionIndex

▸ lockConditionIndex(): number

Returns

number

Inherited from

AgreementTemplate.lockConditionIndex

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57

lockTokens

▸ lockTokens(tokenAddress, amounts, from, txParams?): Promise<void>

Parameters

Name	Type
`tokenAddress`	`any`
`amounts`	`any`
`from`	`NvmAccount`
`txParams?`	`TxParameters`

Returns

Promise<void>

Inherited from

AgreementTemplate.lockTokens

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382

name

▸ name(): string

Returns

string

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:40

params

▸ params(...args): Params

Parameters

Name	Type
`...args`	`any`[]

Returns

Params

Inherited from

AgreementTemplate.params

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:55

paramsGen

▸ 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:108

paymentData

▸ paymentData(service): Promise<PaymentData>

Parameters

Name	Type
`service`	`ServiceCommon`

Returns

Promise<PaymentData>

Inherited from

AgreementTemplate.paymentData

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61

printAgreementStatus

▸ printAgreementStatus(agreementId): Promise<void>

Prints the agreement status.

Parameters

Name	Type	Description
`agreementId`	`string`	Agreement ID.

Returns

Promise<void>

Inherited from

AgreementTemplate.printAgreementStatus

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418

process

▸ process(params, from, txparams?): Promise<void>

Parameters

Name	Type
`params`	`ValidationParams`
`from`	`NvmAccount`
`txparams?`	`TxParameters`

Returns

Promise<void>

Implementation of

ServicePlugin.process

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:126

send

▸ send(functionName, from, args, params?): Promise<any>

Parameters

Name	Type
`functionName`	`string`
`from`	`NvmAccount`
`args`	`any`[]
`params`	`TxParameters`

Returns

Promise<any>

Inherited from

AgreementTemplate.send

Defined in

src/keeper/contracts/ContractBase.ts:128

sendFrom

▸ sendFrom(functionName, args, from, value?): Promise<any>

Parameters

Name	Type
`functionName`	`string`
`args`	`any`[]
`from`	`NvmAccount`
`value?`	`TxParameters`

Returns

Promise<any>

Inherited from

AgreementTemplate.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:109

service

▸ service(): ServiceType

Returns

ServiceType

Inherited from

AgreementTemplate.service

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:187

serviceEndpoint

▸ serviceEndpoint(): string

Returns

string

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:44

setInstanceConfig

▸ setInstanceConfig(config): void

Parameters

Name	Type
`config`	`InstantiableConfig`

Returns

void

Inherited from

AgreementTemplate.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:163

someLog

▸ someLog(logs): undefined

Parameters

Name	Type
`logs`	`any`[]

Returns

undefined

Inherited from

AgreementTemplate.someLog

Defined in

src/keeper/contracts/ContractBase.ts:85

standardContext

▸ standardContext(ddo, creator, serviceIndex?): ConditionContext

Parameters

Name	Type
`ddo`	`DDO`
`creator`	`string`
`serviceIndex?`	`number`

Returns

ConditionContext

Inherited from

AgreementTemplate.standardContext

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189

track

▸ track(_params, _from, _txparams?): Promise<boolean>

Parameters

Name	Type
`_params`	`ValidationParams`
`_from`	`NvmAccount`
`_txparams?`	`TxParameters`

Returns

Promise<boolean>

Implementation of

ServicePlugin.track

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:118

validateAgreement

▸ validateAgreement(agreement_id, did, params, from, extra?, txparams?): Promise<void>

Parameters

Name	Type
`agreement_id`	`string`
`did`	`string`
`params`	`Params`
`from`	`NvmAccount`
`extra`	`any`
`txparams?`	`TxParameters`

Returns

Promise<void>

Defined in

src/keeper/contracts/templates/BaseTemplate.abstract.ts:141

getInstance

▸ 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.getInstance

Defined in

src/keeper/contracts/templates/AgreementTemplate.abstract.ts:38

setInstanceConfig

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

Type parameters

Name	Type
`T`	extends `Instantiable`

Parameters

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

Returns

void

Inherited from

AgreementTemplate.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:154

This site is open source. Improve this page.

sdk-js

Class: BaseTemplate<Params, S>

Type parameters

Hierarchy

Implements

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type parameters

Parameters

Returns

Inherited from

Defined in

Properties

address

Inherited from

Defined in

contract

Inherited from

Defined in

contractName

Inherited from

Defined in

events

Inherited from

Defined in

version

Inherited from

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

accept

Parameters

Returns

Implementation of

Defined in