sdk-js

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

Class: NFT721SalesTemplate

Hierarchy

• BaseTemplate<NFT721SalesTemplateParams, ServiceNFTSales>

  ↳ NFT721SalesTemplate

Table of contents

Constructors

• constructor

Properties

• address
• contract
• contractName
• events
• version

Accessors

• artifactsFolder
• circuitsFolder
• client
• config
• instanceConfig
• instantiableConfig
• logger
• nevermined
• publicClient
• walletClient

Methods

• accept
• agreementId
• call
• conditions
• createAgreement
• createAgreementAndPay
• createAgreementFromDDO
• createAgreementWithPaymentFromDDO
• createService
• description
• extraGen
• getAgreementCreatedEvent
• getAgreementData
• getAgreementIdsFromDDO
• getAgreementStatus
• getAgreementsForDID
• getConditionTypes
• getConditions
• getFromAddress
• getServiceAgreementTemplate
• getServiceAgreementTemplateConditionByRef
• getServiceAgreementTemplateConditions
• getServiceAgreementTemplateDependencies
• getTransactionLogs
• init
• instanceFromDDO
• lockConditionIndex
• lockTokens
• name
• params
• paramsGen
• paymentData
• printAgreementStatus
• process
• send
• sendFrom
• service
• serviceEndpoint
• setInstanceConfig
• someLog
• standardContext
• track
• validateAgreement
• getInstance
• setInstanceConfig

Constructors

constructor

• new NFT721SalesTemplate(contractName): NFT721SalesTemplate

Parameters

Name	Type
contractName	string

Returns

NFT721SalesTemplate

Inherited from

BaseTemplate.constructor

Defined in

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

Properties

address

• address: `0x${string}`

Inherited from

BaseTemplate.address

Defined in

src/keeper/contracts/ContractBase.ts:21

---

contract

• contract: any

Inherited from

BaseTemplate.contract

Defined in

src/keeper/contracts/ContractBase.ts:18

---

contractName

• Readonly contractName: string

Inherited from

BaseTemplate.contractName

Defined in

src/keeper/contracts/ContractBase.ts:17

---

events

• events: ContractEvent | SubgraphEvent

Inherited from

BaseTemplate.events

Defined in

src/keeper/contracts/ContractBase.ts:19

---

version

• version: string

Inherited from

BaseTemplate.version

Defined in

src/keeper/contracts/ContractBase.ts:20

Accessors

artifactsFolder

• get artifactsFolder(): undefined | string

Returns

undefined | string

Inherited from

BaseTemplate.artifactsFolder

Defined in

src/Instantiable.abstract.ts:136

---

circuitsFolder

• get circuitsFolder(): undefined | string

Returns

undefined | string

Inherited from

BaseTemplate.circuitsFolder

Defined in

src/Instantiable.abstract.ts:140

---

client

• get client(): Web3Clients

Returns

Web3Clients

Inherited from

BaseTemplate.client

Defined in

src/Instantiable.abstract.ts:88

---

config

• get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

BaseTemplate.config

Defined in

src/Instantiable.abstract.ts:119

---

instanceConfig

• get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

BaseTemplate.instanceConfig

Defined in

src/Instantiable.abstract.ts:144

---

instantiableConfig

• get instantiableConfig(): undefined | InstantiableConfig

Returns

undefined | InstantiableConfig

Inherited from

BaseTemplate.instantiableConfig

Defined in

src/Instantiable.abstract.ts:112

---

logger

• get logger(): Logger

Returns

Logger

Inherited from

BaseTemplate.logger

Defined in

src/Instantiable.abstract.ts:127

---

nevermined

• get nevermined(): Nevermined

Returns

Nevermined

Inherited from

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

BaseTemplate.publicClient

Defined in

src/Instantiable.abstract.ts:96

---

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

BaseTemplate.walletClient

Defined in

src/Instantiable.abstract.ts:104

Methods

accept

▸ accept(_params): Promise<boolean>

Parameters

Name	Type
_params	ValidationParams

Returns

Promise<boolean>

Inherited from

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

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

BaseTemplate.call

Defined in

src/keeper/contracts/ContractBase.ts:91

---

conditions

▸ conditions(): [LockPaymentCondition, TransferNFT721Condition, EscrowPaymentCondition]

Returns

[LockPaymentCondition, TransferNFT721Condition, EscrowPaymentCondition]

Overrides

BaseTemplate.conditions

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:55

---

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

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

BaseTemplate.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	NFT721SalesTemplateParams
consumer	NvmAccount	-
timeOuts?	number[]	-
txParams?	TxParameters	-

Returns

Promise<string>

true if the call was successful.

Inherited from

BaseTemplate.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	NFT721SalesTemplateParams
consumer	NvmAccount
from	NvmAccount
txParams?	TxParameters
observer?	(orderProgressStep: OrderProgressStep) => void

Returns

Promise<string>

Inherited from

BaseTemplate.createAgreementWithPaymentFromDDO

Defined in

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

---

createService

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

Parameters

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

Returns

ServiceNFTSales

Inherited from

BaseTemplate.createService

Defined in

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

---

description

▸ description(): string

Returns

string

Overrides

BaseTemplate.description

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:37

---

extraGen

▸ extraGen(_params): Promise<any>

Parameters

Name	Type
_params	ValidationParams

Returns

Promise<any>

Inherited from

BaseTemplate.extraGen

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

BaseTemplate.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 }>

Inherited from

BaseTemplate.getAgreementData

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	NFT721SalesTemplateParams	-

Returns

Promise<string[]>

The condition IDs.

Inherited from

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

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

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

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

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

BaseTemplate.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:67

---

getServiceAgreementTemplate

▸ getServiceAgreementTemplate(): ServiceAgreementTemplate

Returns

ServiceAgreementTemplate

Overrides

BaseTemplate.getServiceAgreementTemplate

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:104

---

getServiceAgreementTemplateConditionByRef

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

Parameters

Name	Type
ref	string

Returns

Promise<undefined | ConditionSmall>

Inherited from

BaseTemplate.getServiceAgreementTemplateConditionByRef

Defined in

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

---

getServiceAgreementTemplateConditions

▸ getServiceAgreementTemplateConditions(): ServiceAgreementTemplateCondition[]

Returns

ServiceAgreementTemplateCondition[]

Inherited from

BaseTemplate.getServiceAgreementTemplateConditions

Defined in

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

---

getServiceAgreementTemplateDependencies

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

Returns

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

Inherited from

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

BaseTemplate.getTransactionLogs

Defined in

src/keeper/contracts/ContractBase.ts:75

---

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

BaseTemplate.init

Defined in

src/keeper/contracts/ContractBase.ts:28

---

instanceFromDDO

▸ instanceFromDDO(agreementIdSeed, ddo, creator, parameters, serviceReference?): Promise<AgreementInstance<NFT721SalesTemplateParams>>

Parameters

Name	Type
agreementIdSeed	string
ddo	DDO
creator	string
parameters	NFT721SalesTemplateParams
serviceReference?	number

Returns

Promise<AgreementInstance<NFT721SalesTemplateParams>>

Overrides

BaseTemplate.instanceFromDDO

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:61

---

lockConditionIndex

▸ lockConditionIndex(): number

Returns

number

Overrides

BaseTemplate.lockConditionIndex

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:51

---

lockTokens

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

Parameters

Name	Type
tokenAddress	any
amounts	any
from	NvmAccount
txParams?	TxParameters

Returns

Promise<void>

Inherited from

BaseTemplate.lockTokens

Defined in

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

---

name

▸ name(): string

Returns

string

Overrides

BaseTemplate.name

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:34

---

params

▸ params(consumerId, expiration?): NFT721SalesTemplateParams

Parameters

Name	Type	Default value
consumerId	string	undefined
expiration	number	0

Returns

NFT721SalesTemplateParams

Overrides

BaseTemplate.params

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:41

---

paramsGen

▸ paramsGen(«destructured»): Promise<NFT721SalesTemplateParams>

Specialize params

Parameters

Name	Type	Description
«destructured»	ValidationParams	Generic parameters

Returns

Promise<NFT721SalesTemplateParams>

Overrides

BaseTemplate.paramsGen

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:44

---

paymentData

▸ paymentData(service): Promise<PaymentData>

Parameters

Name	Type
service	ServiceCommon

Returns

Promise<PaymentData>

Inherited from

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

BaseTemplate.printAgreementStatus

Defined in

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

---

process

▸ process(params, from, txparams?): Promise<void | { [key: string]: any; }>

Parameters

Name	Type
params	ValidationParams
from	NvmAccount
txparams?	TxParameters

Returns

Promise<void | { [key: string]: any; }>

Inherited from

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

BaseTemplate.send

Defined in

src/keeper/contracts/ContractBase.ts:127

---

sendFrom

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

Parameters

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

Returns

Promise<any>

Inherited from

BaseTemplate.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:108

---

service

▸ service(): ServiceType

Returns

ServiceType

Overrides

BaseTemplate.service

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:27

---

serviceEndpoint

▸ serviceEndpoint(): string

Returns

string

Overrides

BaseTemplate.serviceEndpoint

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:30

---

setInstanceConfig

▸ setInstanceConfig(config): void

Parameters

Name	Type
config	InstantiableConfig

Returns

void

Inherited from

BaseTemplate.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:162

---

someLog

▸ someLog(logs): undefined

Parameters

Name	Type
logs	any[]

Returns

undefined

Inherited from

BaseTemplate.someLog

Defined in

src/keeper/contracts/ContractBase.ts:84

---

standardContext

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

Parameters

Name	Type
ddo	DDO
creator	string
serviceIndex?	number

Returns

ConditionContext

Inherited from

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

Inherited from

BaseTemplate.track

Defined in

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

---

validateAgreement

▸ validateAgreement(agreement_id, did, params, from, extra?, txparams?): Promise<void | { [key: string]: any; }>

Parameters

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

Returns

Promise<void | { [key: string]: any; }>

Inherited from

BaseTemplate.validateAgreement

Defined in

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

---

getInstance

▸ getInstance(config): Promise<NFT721SalesTemplate>

Parameters

Name	Type
config	InstantiableConfig

Returns

Promise<NFT721SalesTemplate>

Overrides

BaseTemplate.getInstance

Defined in

src/keeper/contracts/templates/NFT721SalesTemplate.ts:23

---

setInstanceConfig

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

Type parameters

Name	Type
T	extends Instantiable

Parameters

Name	Type
instance	T
instantiableConfig	InstantiableConfig

Returns

void

Inherited from

BaseTemplate.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:153

This site is open source. Improve this page.