Skip to main content

LockPaymentCondition

@nevermined-io/sdk - v3.1.0 / LockPaymentCondition

Class: LockPaymentCondition

Hierarchy

  • ConsumerCondition\<ConditionContext>

    LockPaymentCondition

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new LockPaymentCondition(contractName): LockPaymentCondition

Parameters

NameType
contractNamestring

Returns

LockPaymentCondition

Inherited from

ConsumerCondition\<ConditionContext>.constructor

Defined in

src/keeper/contracts/ContractBase.ts:23

Properties

address

address: `0x${string}`

Inherited from

ConsumerCondition.address

Defined in

src/keeper/contracts/ContractBase.ts:21


contract

contract: any

Inherited from

ConsumerCondition.contract

Defined in

src/keeper/contracts/ContractBase.ts:18


contractName

Readonly contractName: string

Inherited from

ConsumerCondition.contractName

Defined in

src/keeper/contracts/ContractBase.ts:17


events

events: ContractEvent | SubgraphEvent

Inherited from

ConsumerCondition.events

Defined in

src/keeper/contracts/ContractBase.ts:19


version

version: string

Inherited from

ConsumerCondition.version

Defined in

src/keeper/contracts/ContractBase.ts:20

Accessors

artifactsFolder

get artifactsFolder(): undefined | string

Returns

undefined | string

Inherited from

ConsumerCondition.artifactsFolder

Defined in

src/Instantiable.abstract.ts:136


circuitsFolder

get circuitsFolder(): undefined | string

Returns

undefined | string

Inherited from

ConsumerCondition.circuitsFolder

Defined in

src/Instantiable.abstract.ts:140


client

get client(): Web3Clients

Returns

Web3Clients

Inherited from

ConsumerCondition.client

Defined in

src/Instantiable.abstract.ts:88


config

get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

ConsumerCondition.config

Defined in

src/Instantiable.abstract.ts:119


instanceConfig

get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

ConsumerCondition.instanceConfig

Defined in

src/Instantiable.abstract.ts:144


instantiableConfig

get instantiableConfig(): undefined | InstantiableConfig

Returns

undefined | InstantiableConfig

Inherited from

ConsumerCondition.instantiableConfig

Defined in

src/Instantiable.abstract.ts:112


logger

get logger(): Logger

Returns

Logger

Inherited from

ConsumerCondition.logger

Defined in

src/Instantiable.abstract.ts:127


nevermined

get nevermined(): Nevermined

Returns

Nevermined

Inherited from

ConsumerCondition.nevermined

Defined in

src/Instantiable.abstract.ts:80


publicClient

get publicClient(): Object

Returns

Object

NameTypeDescription
accountundefinedThe 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.
cacheTimenumberTime (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.
chainundefined | ChainChain 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>-
keystringA key for the client.
multicall\<contracts, allowFailure>(args: MulticallParameters\<contracts, allowFailure>) => Promise\<MulticallReturnType\<contracts, allowFailure>>-
namestringA name for the client.
pollingIntervalnumberFrequency (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>>-
requestEIP1193RequestFn\<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>>-
transportTransportConfig\<string, EIP1193RequestFn> & Record\<string, any>The RPC transport
typestringThe type of client.
uidstringA 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

ConsumerCondition.publicClient

Defined in

src/Instantiable.abstract.ts:96


walletClient

get walletClient(): Object

Returns

Object

NameTypeDescription
accountundefined | AccountThe 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.
cacheTimenumberTime (in ms) that cached data will remain in memory.
ccipRead?false | { request?: (parameters: CcipRequestParameters) => Promise\<`0x${string}`> }CCIP Read configuration.
chainundefined | ChainChain 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>-
keystringA key for the client.
namestringA name for the client.
pollingIntervalnumberFrequency (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] }>-
requestEIP1193RequestFn\<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>-
transportTransportConfig\<string, EIP1193RequestFn> & Record\<string, any>The RPC transport
typestringThe type of client.
uidstringA 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

ConsumerCondition.walletClient

Defined in

src/Instantiable.abstract.ts:104

Methods

abortByTimeOut

abortByTimeOut(conditionId, from, params?): Promise\<any>

Parameters

NameType
conditionIdstring
fromNvmAccount
params?TxParameters

Returns

Promise\<any>

Inherited from

ConsumerCondition.abortByTimeOut

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:75


call

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

Type parameters

Name
T

Parameters

NameType
functionNamestring
argsany[]
from?string

Returns

Promise\<T>

Inherited from

ConsumerCondition.call

Defined in

src/keeper/contracts/ContractBase.ts:91


fulfill

fulfill(agreementId, did, rewardAddress, tokenAddress, amounts, receivers, from, txParams?): Promise\<any>

Parameters

NameType
agreementIdstring
didstring
rewardAddressstring
tokenAddressstring
amountsbigint[]
receiversstring[]
fromNvmAccount
txParams?TxParameters

Returns

Promise\<any>

Overrides

ConsumerCondition.fulfill

Defined in

src/keeper/contracts/conditions/LockPaymentCondition.ts:42


fulfillInstance

fulfillInstance(cond, additionalParams, from, txParams?, method?): Promise\<any>

Parameters

NameTypeDefault value
condConditionInstance\<Record\<string, unknown>>undefined
additionalParamsRecord\<string, unknown>undefined
fromNvmAccountundefined
txParams?TxParametersundefined
methodConditionMethod'fulfill'

Returns

Promise\<any>

Inherited from

ConsumerCondition.fulfillInstance

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:139


fulfillPlain

fulfillPlain(agreementId, args, from, txParams?, method?): Promise\<any>

Parameters

NameTypeDefault value
agreementIdstringundefined
argsany[]undefined
fromNvmAccountundefined
txParams?TxParametersundefined
methodConditionMethod'fulfill'

Returns

Promise\<any>

Inherited from

ConsumerCondition.fulfillPlain

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:47


fulfillWithNode

fulfillWithNode(_cond, _additionalParams, _from, _txParams?): Promise\<void>

Parameters

NameType
_condConditionInstance\<Record\<string, unknown>>
_additionalParamsRecord\<string, unknown>
_fromNvmAccount
_txParams?TxParameters

Returns

Promise\<void>

Inherited from

ConsumerCondition.fulfillWithNode

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:209


generateId

generateId(agreementId, valueHash): Promise\<`0x${string}`>

Parameters

NameType
agreementIdstring
valueHashstring

Returns

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

Inherited from

ConsumerCondition.generateId

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:61


generateIdHash

generateIdHash(agreementId, ...values): Promise\<`0x${string}`>

Parameters

NameType
agreementIdstring
...valuesany[]

Returns

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

Inherited from

ConsumerCondition.generateIdHash

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:57


generateIdWithSeed

generateIdWithSeed(agreementId, valueHash): Promise\<[string, string]>

Parameters

NameType
agreementIdstring
valueHashstring

Returns

Promise\<[string, string]>

Inherited from

ConsumerCondition.generateIdWithSeed

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:65


getConditionFulfilledEvent

getConditionFulfilledEvent(agreementId): EventResult

Parameters

NameType
agreementIdstring

Returns

EventResult

Inherited from

ConsumerCondition.getConditionFulfilledEvent

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:79


getFromAddress

getFromAddress(from?): Promise\<string>

Parameters

NameType
from?string

Returns

Promise\<string>

Inherited from

ConsumerCondition.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:67


getTransactionLogs

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

Parameters

NameType
txReceiptTransactionReceipt
eventNamestring

Returns

ParseEventLogsReturnType\<any, string, false, string>

Inherited from

ConsumerCondition.getTransactionLogs

Defined in

src/keeper/contracts/ContractBase.ts:75


hashValues

hashValues(...args): Promise\<string>

Parameters

NameType
...argsany[]

Returns

Promise\<string>

Inherited from

ConsumerCondition.hashValues

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:116


hashValuesPlain

hashValuesPlain(...args): Promise\<string>

Parameters

NameType
...argsany[]

Returns

Promise\<string>

Inherited from

ConsumerCondition.hashValuesPlain

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:122


init

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

Parameters

NameTypeDefault value
configInstantiableConfigundefined
optionalbooleanfalse
contractAddress?stringundefined

Returns

Promise\<void>

Inherited from

ConsumerCondition.init

Defined in

src/keeper/contracts/ContractBase.ts:28


instance

instance(agreementId, params): Promise\<ConditionInstance\<Record\<string, unknown>>>

Parameters

NameType
agreementIdstring
paramsConditionParameters\<Record\<string, unknown>>

Returns

Promise\<ConditionInstance\<Record\<string, unknown>>>

Inherited from

ConsumerCondition.instance

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:163


instanceFromDDO

instanceFromDDO(agreementId, ctx, ...args): Promise\<ConditionInstance\<Record\<string, unknown>>>

Parameters

NameType
agreementIdstring
ctxConditionContext
...argsConditionInstanceSmall[]

Returns

Promise\<ConditionInstance\<Record\<string, unknown>>>

Inherited from

ConsumerCondition.instanceFromDDO

Defined in

src/keeper/contracts/conditions/Condition.abstract.ts:131


params

params(did, rewardAddress, tokenAddress, amounts, receivers): ConditionParameters\<Record\<string, unknown>>

Parameters

NameType
didstring
rewardAddressstring
tokenAddressstring
amountsbigint[]
receiversstring[]

Returns

ConditionParameters\<Record\<string, unknown>>

Overrides

ConsumerCondition.params

Defined in

src/keeper/contracts/conditions/LockPaymentCondition.ts:13


paramsFromDDO

paramsFromDDO(«destructured»): Promise\<ConditionParameters\<Record\<string, unknown>>>

Parameters

NameType
«destructured»ConditionContext

Returns

Promise\<ConditionParameters\<Record\<string, unknown>>>

Overrides

ConsumerCondition.paramsFromDDO

Defined in

src/keeper/contracts/conditions/LockPaymentCondition.ts:31


send

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

Parameters

NameType
functionNamestring
fromNvmAccount
argsany[]
paramsTxParameters

Returns

Promise\<any>

Inherited from

ConsumerCondition.send

Defined in

src/keeper/contracts/ContractBase.ts:127


sendFrom

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

Parameters

NameType
functionNamestring
argsany[]
fromNvmAccount
value?TxParameters

Returns

Promise\<any>

Inherited from

ConsumerCondition.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:108


setInstanceConfig

setInstanceConfig(config): void

Parameters

NameType
configInstantiableConfig

Returns

void

Inherited from

ConsumerCondition.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:162


someLog

someLog(logs): undefined

Parameters

NameType
logsany[]

Returns

undefined

Inherited from

ConsumerCondition.someLog

Defined in

src/keeper/contracts/ContractBase.ts:84


getInstance

getInstance(config): Promise\<LockPaymentCondition>

Parameters

NameType
configInstantiableConfig

Returns

Promise\<LockPaymentCondition>

Overrides

ConsumerCondition.getInstance

Defined in

src/keeper/contracts/conditions/LockPaymentCondition.ts:9


setInstanceConfig

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

Type parameters

NameType
Textends Instantiable

Parameters

NameType
instanceT
instantiableConfigInstantiableConfig

Returns

void

Inherited from

ConsumerCondition.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:153