Skip to main content

TransferNFTCondition

@nevermined-io/sdk - v3.0.40 / TransferNFTCondition

Class: TransferNFTCondition

Condition allowing to transfer an NFT between the original owner and a receiver

Hierarchy

  • ProviderCondition\<TransferNFTConditionContext>

    TransferNFTCondition

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new TransferNFTCondition(contractName): TransferNFTCondition

Parameters

NameType
contractNamestring

Returns

TransferNFTCondition

Inherited from

ProviderCondition\<TransferNFTConditionContext>.constructor

Defined in

src/keeper/contracts/ContractBase.ts:24

Properties

address

address: `0x${string}`

Inherited from

ProviderCondition.address

Defined in

src/keeper/contracts/ContractBase.ts:22


contract

contract: any

Inherited from

ProviderCondition.contract

Defined in

src/keeper/contracts/ContractBase.ts:19


contractName

Readonly contractName: string

Inherited from

ProviderCondition.contractName

Defined in

src/keeper/contracts/ContractBase.ts:18


events

events: ContractEvent | SubgraphEvent

Inherited from

ProviderCondition.events

Defined in

src/keeper/contracts/ContractBase.ts:20


version

version: string

Inherited from

ProviderCondition.version

Defined in

src/keeper/contracts/ContractBase.ts:21


NO_EXPIRY

Static Readonly NO_EXPIRY: 0

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:27

Accessors

artifactsFolder

get artifactsFolder(): undefined | string

Returns

undefined | string

Inherited from

ProviderCondition.artifactsFolder

Defined in

src/Instantiable.abstract.ts:137


circuitsFolder

get circuitsFolder(): undefined | string

Returns

undefined | string

Inherited from

ProviderCondition.circuitsFolder

Defined in

src/Instantiable.abstract.ts:141


client

get client(): Web3Clients

Returns

Web3Clients

Inherited from

ProviderCondition.client

Defined in

src/Instantiable.abstract.ts:89


config

get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

ProviderCondition.config

Defined in

src/Instantiable.abstract.ts:120


instanceConfig

get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

ProviderCondition.instanceConfig

Defined in

src/Instantiable.abstract.ts:145


instantiableConfig

get instantiableConfig(): undefined | InstantiableConfig

Returns

undefined | InstantiableConfig

Inherited from

ProviderCondition.instantiableConfig

Defined in

src/Instantiable.abstract.ts:113


logger

get logger(): Logger

Returns

Logger

Inherited from

ProviderCondition.logger

Defined in

src/Instantiable.abstract.ts:128


nevermined

get nevermined(): Nevermined

Returns

Nevermined

Inherited from

ProviderCondition.nevermined

Defined in

src/Instantiable.abstract.ts:81


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.
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>-
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\<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>>-
requestEIP1193RequestFn\<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>>-
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: 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

ProviderCondition.publicClient

Defined in

src/Instantiable.abstract.ts:97


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\<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] }>-
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\<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>-
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, TChainOverride>(args: WriteContractParameters\<abi, functionName, args, undefined | Chain, undefined | Account, TChainOverride>) => Promise\<`0x${string}`>-

Inherited from

ProviderCondition.walletClient

Defined in

src/Instantiable.abstract.ts:105

Methods

abortByTimeOut

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

Parameters

NameType
conditionIdstring
fromNvmAccount
params?TxParameters

Returns

Promise\<any>

Inherited from

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

ProviderCondition.call

Defined in

src/keeper/contracts/ContractBase.ts:92


fulfill

fulfill(agreementId, did, nftReceiver, nftAmount, nftContractAddress, lockPaymentCondition, from, willBeTransferred?, expiration?, txParams?): Promise\<any>

Fulfill the transfer NFT condition.

Parameters

NameTypeDefault valueDescription
agreementIdstringundefinedThe agreement identifier.
didstringundefinedThe DID of the asset with NFTs.
nftReceiverstringundefinedThe address of the account to receive the NFT.
nftAmountbigintundefinedamount of NFTs to transfer.
nftContractAddressstringundefinedAddress of the nft contract
lockPaymentConditionstringundefinedlock payment condition identifier.
fromNvmAccountundefined
willBeTransferredbooleantrueIndicates if the asset will be transferred or minted
expirationnumber0-
txParams?TxParametersundefined-

Returns

Promise\<any>

Condition state.

Remarks

Only DID owner or DID provider can call this method.

Overrides

ProviderCondition.fulfill

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:146


fulfillForDelegate

fulfillForDelegate(agreementId, did, nftHolder, nftReceiver, nftAmount, lockPaymentCondition, nftAddress, willBeTransferred?, expiration?, from, txParams?): Promise\<any>

Fulfill the transfer NFT condition.

Parameters

NameTypeDefault valueDescription
agreementIdstringundefinedThe agreement identifier.
didstringundefinedThe DID of the asset with NFTs.
nftHolderstringundefinedThe address of the account currently holding the NFT.
nftReceiverstringundefinedThe address of the account to receive the NFT.
nftAmountbigintundefinedThe amount of NFTs to transfer.
lockPaymentConditionstringundefinedThe lock payment condition identifier.
nftAddressstringundefined-
willBeTransferredbooleantrueIndicates if the asset will be transferred or minted
expirationbigintundefinedBlock in which the token expires. If zero means no expiration
fromNvmAccountundefinedAccount sending the transaction
txParams?TxParametersundefinedTransaction parameters

Returns

Promise\<any>

Condition state.

Remarks

Only DID owner or DID provider can call this method.

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:192


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

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

ProviderCondition.fulfillPlain

Defined in

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


fulfillWithNode

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

Parameters

NameType
condConditionInstance\<Record\<string, unknown>>
additionalParamsRecord\<string, unknown>
fromNvmAccount
txParams?TxParameters

Returns

Promise\<any>

Inherited from

ProviderCondition.fulfillWithNode

Defined in

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


generateId

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

Parameters

NameType
agreementIdstring
valueHashstring

Returns

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

Inherited from

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

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

ProviderCondition.generateIdWithSeed

Defined in

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


getConditionFulfilledEvent

getConditionFulfilledEvent(agreementId): EventResult

Parameters

NameType
agreementIdstring

Returns

EventResult

Inherited from

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

ProviderCondition.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:68


getTransactionLogs

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

Parameters

NameType
txReceiptTransactionReceipt
eventNamestring

Returns

ParseEventLogsReturnType\<any, string, false, string>

Inherited from

ProviderCondition.getTransactionLogs

Defined in

src/keeper/contracts/ContractBase.ts:76


hashValues

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

Parameters

NameType
...argsany[]

Returns

Promise\<string>

Inherited from

ProviderCondition.hashValues

Defined in

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


hashValuesPlain

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

Parameters

NameType
...argsany[]

Returns

Promise\<string>

Inherited from

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

ProviderCondition.init

Defined in

src/keeper/contracts/ContractBase.ts:29


instance

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

Parameters

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

Returns

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

Inherited from

ProviderCondition.instance

Defined in

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


instanceFromDDO

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

Parameters

NameType
agreementIdstring
ctxTransferNFTConditionContext
...argsConditionInstanceSmall[]

Returns

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

Inherited from

ProviderCondition.instanceFromDDO

Defined in

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


nftContractFromService

nftContractFromService(service): string

Parameters

NameType
serviceServiceCommon

Returns

string

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:97


nodeMethod

nodeMethod(): ConditionMethod

Returns

ConditionMethod

Overrides

ProviderCondition.nodeMethod

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:218


params

params(did, nftHolder, nftReceiver, nftAmount, lockCondition, nftContractAddress?, willBeTransferred?, expiration?): ConditionParameters\<Record\<string, unknown>>

Generates the hash of condition inputs.

Parameters

NameTypeDefault valueDescription
didstringundefinedThe DID of the asset with NFTs.
nftHolderstringundefinedThe address of the holder of the NFT.
nftReceiverstringundefinedThe address of the granted user or the DID provider.
nftAmountbigintundefinedAmount of NFTs to transfer.
lockConditionstringundefinedLock condition identifier.
nftContractAddress?stringundefinedThe address of the NFT token to use.
willBeTransferredbooleantrueIndicates if the asset will be transferred or minted
expirationnumber0-

Returns

ConditionParameters\<Record\<string, unknown>>

Hash of all the values

Overrides

ProviderCondition.params

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:45


paramsFromDDO

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

Parameters

NameType
«destructured»TransferNFTConditionContext
lockConditionany

Returns

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

Overrides

ProviderCondition.paramsFromDDO

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:104


send

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

Parameters

NameType
functionNamestring
fromNvmAccount
argsany[]
paramsTxParameters

Returns

Promise\<any>

Inherited from

ProviderCondition.send

Defined in

src/keeper/contracts/ContractBase.ts:128


sendFrom

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

Parameters

NameType
functionNamestring
argsany[]
fromNvmAccount
value?TxParameters

Returns

Promise\<any>

Inherited from

ProviderCondition.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:109


setInstanceConfig

setInstanceConfig(config): void

Parameters

NameType
configInstantiableConfig

Returns

void

Inherited from

ProviderCondition.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:163


someLog

someLog(logs): undefined

Parameters

NameType
logsany[]

Returns

undefined

Inherited from

ProviderCondition.someLog

Defined in

src/keeper/contracts/ContractBase.ts:85


getInstance

getInstance(config): Promise\<TransferNFTCondition>

Parameters

NameType
configInstantiableConfig

Returns

Promise\<TransferNFTCondition>

Overrides

ProviderCondition.getInstance

Defined in

src/keeper/contracts/conditions/NFTs/TransferNFTCondition.ts:29


setInstanceConfig

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

Type parameters

NameType
Textends Instantiable

Parameters

NameType
instanceT
instantiableConfigInstantiableConfig

Returns

void

Inherited from

ProviderCondition.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:154