@nevermined-io/sdk - v3.0.44 / EscrowComputeExecutionTemplate
BaseTemplate
<EscrowComputeExecutionParams
, ServiceCompute
>
âł EscrowComputeExecutionTemplate
⢠new EscrowComputeExecutionTemplate(contractName
): EscrowComputeExecutionTemplate
Name | Type |
---|---|
contractName |
string |
EscrowComputeExecutionTemplate
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:51
⢠address: `0x${string}`
src/keeper/contracts/ContractBase.ts:22
⢠contract: any
src/keeper/contracts/ContractBase.ts:19
⢠Readonly
contractName: string
src/keeper/contracts/ContractBase.ts:18
⢠events: ContractEvent
| SubgraphEvent
src/keeper/contracts/ContractBase.ts:20
⢠version: string
src/keeper/contracts/ContractBase.ts:21
⢠get
artifactsFolder(): undefined
| string
undefined
| string
BaseTemplate.artifactsFolder
src/Instantiable.abstract.ts:137
⢠get
circuitsFolder(): undefined
| string
undefined
| string
BaseTemplate.circuitsFolder
src/Instantiable.abstract.ts:141
⢠get
client(): Web3Clients
BaseTemplate.client
src/Instantiable.abstract.ts:89
⢠get
config(): NeverminedOptions
BaseTemplate.config
src/Instantiable.abstract.ts:120
⢠get
instanceConfig(): InstantiableConfig
BaseTemplate.instanceConfig
src/Instantiable.abstract.ts:145
⢠get
instantiableConfig(): undefined
| InstantiableConfig
undefined
| InstantiableConfig
BaseTemplate.instantiableConfig
src/Instantiable.abstract.ts:113
⢠get
logger(): Logger
Logger
BaseTemplate.logger
src/Instantiable.abstract.ts:128
⢠get
nevermined(): Nevermined
BaseTemplate.nevermined
src/Instantiable.abstract.ts:81
⢠get
publicClient(): Object
Object
Name | Type | Description |
---|---|---|
account |
undefined |
The Account of the Client. |
batch? |
{ multicall? : boolean | { batchSize? : number ; wait? : number } } |
Flags for batch settings. |
batch.multicall? |
boolean | { batchSize? : number ; wait? : number } |
Toggle to enable eth_call multicall aggregation. |
cacheTime |
number |
Time (in ms) that cached data will remain in memory. |
call |
(parameters : CallParameters <undefined | Chain >) => Promise <CallReturnType > |
- |
ccipRead? |
false | { request? : (parameters : CcipRequestParameters ) => Promise <`0x${string}`> } |
CCIP Read configuration. |
chain |
undefined | Chain |
Chain for the client. |
createBlockFilter |
() => Promise <{ id : `0x${string}` ; request : EIP1193RequestFn <readonly [{ Method : "eth_getFilterChanges" ; Parameters : [filterId: `0x${string}`] ; ReturnType : `0x${string}`[] | RpcLog [] }, { Method : "eth_getFilterLogs" ; Parameters : [filterId: `0x${string}`] ; ReturnType : RpcLog [] }, { Method : "eth_uninstallFilter" ; Parameters : [filterId: `0x${string}`] ; ReturnType : boolean }]> ; type : "block" }> |
- |
createContractEventFilter |
<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args : CreateContractEventFilterParameters <TAbi , TEventName , TArgs , TStrict , TFromBlock , TToBlock >) => Promise <CreateContractEventFilterReturnType <TAbi , TEventName , TArgs , TStrict , TFromBlock , TToBlock >> |
- |
createEventFilter |
<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args? : CreateEventFilterParameters <TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock , _EventName , _Args >) => Promise <{ [K in string | number | symbol]: Filter<âeventâ, TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>[K] }> |
- |
createPendingTransactionFilter |
() => Promise <{ id : `0x${string}` ; request : EIP1193RequestFn <readonly [{ Method : "eth_getFilterChanges" ; Parameters : [filterId: `0x${string}`] ; ReturnType : `0x${string}`[] | RpcLog [] }, { Method : "eth_getFilterLogs" ; Parameters : [filterId: `0x${string}`] ; ReturnType : RpcLog [] }, { Method : "eth_uninstallFilter" ; Parameters : [filterId: `0x${string}`] ; ReturnType : boolean }]> ; type : "transaction" }> |
- |
estimateContractGas |
<TChain, abi, functionName, args>(args : EstimateContractGasParameters <abi , functionName , args , TChain >) => Promise <bigint > |
- |
estimateFeesPerGas |
<TChainOverride, TType>(args? : EstimateFeesPerGasParameters <undefined | Chain , TChainOverride , TType >) => Promise <EstimateFeesPerGasReturnType > |
- |
estimateGas |
(args : EstimateGasParameters <undefined | Chain >) => Promise <bigint > |
- |
estimateMaxPriorityFeePerGas |
<TChainOverride>(args? : { chain : null | TChainOverride }) => Promise <bigint > |
- |
extend |
<client>(fn : (client : Client <Transport , undefined | Chain , undefined , PublicRpcSchema , PublicActions <Transport , undefined | Chain >>) => client ) => Client <Transport , undefined | Chain , undefined , PublicRpcSchema , { [K in string | number | symbol]: client[K] } & PublicActions <Transport , undefined | Chain >> |
- |
getBalance |
(args : GetBalanceParameters ) => Promise <bigint > |
- |
getBlobBaseFee |
() => Promise <bigint > |
- |
getBlock |
<TIncludeTransactions, TBlockTag>(args? : GetBlockParameters <TIncludeTransactions , TBlockTag >) => Promise <{ baseFeePerGas : null | bigint ; blobGasUsed : bigint ; difficulty : bigint ; excessBlobGas : bigint ; extraData : `0x${string}` ; gasLimit : bigint ; gasUsed : bigint ; hash : TBlockTag extends "pending" ? null : `0x${string}` ; logsBloom : TBlockTag extends "pending" ? null : `0x${string}` ; miner : `0x${string}` ; mixHash : `0x${string}` ; nonce : TBlockTag extends "pending" ? null : `0x${string}` ; number : TBlockTag extends "pending" ? null : bigint ; parentHash : `0x${string}` ; receiptsRoot : `0x${string}` ; sealFields : `0x${string}`[] ; sha3Uncles : `0x${string}` ; size : bigint ; stateRoot : `0x${string}` ; timestamp : bigint ; totalDifficulty : null | bigint ; transactions : TIncludeTransactions extends true ? ({ accessList? : undefined ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId? : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "legacy" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity? : undefined } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip2930" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip1559" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes : `0x${string}`[] ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas : bigint ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip4844" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number })[] : `0x${string}`[] ; transactionsRoot : `0x${string}` ; uncles : `0x${string}`[] ; withdrawals? : Withdrawal [] ; withdrawalsRoot? : `0x${string}` }> |
- |
getBlockNumber |
(args? : GetBlockNumberParameters ) => Promise <bigint > |
- |
getBlockTransactionCount |
(args? : GetBlockTransactionCountParameters ) => Promise <number > |
- |
getBytecode |
(args : GetBytecodeParameters ) => Promise <GetBytecodeReturnType > |
- |
getChainId |
() => Promise <number > |
- |
getContractEvents |
<abi, eventName, strict, fromBlock, toBlock>(args : GetContractEventsParameters <abi , eventName , strict , fromBlock , toBlock >) => Promise <GetContractEventsReturnType <abi , eventName , strict , fromBlock , toBlock >> |
- |
getEnsAddress |
(args : { blockNumber? : bigint ; blockTag? : BlockTag ; coinType? : number ; gatewayUrls? : string [] ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise <GetEnsAddressReturnType > |
- |
getEnsAvatar |
(args : { assetGatewayUrls? : AssetGatewayUrls ; blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise <GetEnsAvatarReturnType > |
- |
getEnsName |
(args : { address : `0x${string}` ; blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise <GetEnsNameReturnType > |
- |
getEnsResolver |
(args : { blockNumber? : bigint ; blockTag? : BlockTag ; name : string ; universalResolverAddress? : `0x${string}` }) => Promise <`0x${string}`> |
- |
getEnsText |
(args : { blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; key : string ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise <GetEnsTextReturnType > |
- |
getFeeHistory |
(args : GetFeeHistoryParameters ) => Promise <GetFeeHistoryReturnType > |
- |
getFilterChanges |
<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args : GetFilterChangesParameters <TFilterType , TAbi , TEventName , TStrict , TFromBlock , TToBlock >) => Promise <GetFilterChangesReturnType <TFilterType , TAbi , TEventName , TStrict , TFromBlock , TToBlock >> |
- |
getFilterLogs |
<TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args : GetFilterLogsParameters <TAbi , TEventName , TStrict , TFromBlock , TToBlock >) => Promise <GetFilterLogsReturnType <TAbi , TEventName , TStrict , TFromBlock , TToBlock >> |
- |
getGasPrice |
() => Promise <bigint > |
- |
getLogs |
<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>(args? : GetLogsParameters <TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock >) => Promise <GetLogsReturnType <TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock >> |
- |
getProof |
(args : GetProofParameters ) => Promise <GetProofReturnType > |
- |
getStorageAt |
(args : GetStorageAtParameters ) => Promise <GetStorageAtReturnType > |
- |
getTransaction |
<TBlockTag>(args : GetTransactionParameters <TBlockTag >) => Promise <{ accessList? : undefined ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId? : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "legacy" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity? : undefined } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip2930" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip1559" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes : `0x${string}`[] ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas : bigint ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip4844" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number }> |
- |
getTransactionConfirmations |
(args : GetTransactionConfirmationsParameters <undefined | Chain >) => Promise <bigint > |
- |
getTransactionCount |
(args : GetTransactionCountParameters ) => Promise <number > |
- |
getTransactionReceipt |
(args : GetTransactionReceiptParameters ) => Promise <TransactionReceipt > |
- |
key |
string |
A key for the client. |
multicall |
<contracts, allowFailure>(args : MulticallParameters <contracts , allowFailure >) => Promise <MulticallReturnType <contracts , allowFailure >> |
- |
name |
string |
A name for the client. |
pollingInterval |
number |
Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. |
prepareTransactionRequest |
<TRequest, TChainOverride, TAccountOverride>(args : PrepareTransactionRequestParameters <undefined | Chain , undefined | Account , TChainOverride , TAccountOverride , TRequest >) => Promise <{ [K in string | number | symbol]: (UnionRequiredBy<Extract<UnionOmit<(âŚ), (âŚ)> & ((âŚ) extends (âŚ) ? (âŚ) : (âŚ)) & ((âŚ) extends (âŚ) ? (âŚ) : (âŚ)), IsNever<(âŚ)> extends true ? unknown : ExactPartial<(âŚ)>> & Object, ParameterTypeToParameters<TRequest[âparametersâ] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : âtypeâ | âgasâ | ânonceâ | âblobVersionedHashesâ | âchainIdâ | âfeesâ>> & (unknown extends TRequest[âkzgâ] ? Object : Pick<TRequest, âkzgâ>))[K] }> |
- |
readContract |
<abi, functionName, args>(args : ReadContractParameters <abi , functionName , args >) => Promise <ReadContractReturnType <abi , functionName , args >> |
- |
request |
EIP1193RequestFn <PublicRpcSchema > |
Request function wrapped with friendly error handling |
sendRawTransaction |
(args : SendRawTransactionParameters ) => Promise <`0x${string}`> |
- |
simulateContract |
<abi, functionName, args, chainOverride, accountOverride>(args : SimulateContractParameters <abi , functionName , args , undefined | Chain , chainOverride , accountOverride >) => Promise <SimulateContractReturnType <abi , functionName , args , undefined | Chain , undefined | Account , chainOverride , accountOverride >> |
- |
transport |
TransportConfig <string , EIP1193RequestFn > & Record <string , any > |
The RPC transport |
type |
string |
The type of client. |
uid |
string |
A unique ID for the client. |
uninstallFilter |
(args : UninstallFilterParameters ) => Promise <boolean > |
- |
verifyMessage |
(args : VerifyMessageParameters ) => Promise <boolean > |
- |
verifyTypedData |
(args : VerifyTypedDataParameters ) => Promise <boolean > |
- |
waitForTransactionReceipt |
(args : WaitForTransactionReceiptParameters <undefined | Chain >) => Promise <TransactionReceipt > |
- |
watchBlockNumber |
(args : WatchBlockNumberParameters ) => WatchBlockNumberReturnType |
- |
watchBlocks |
<TIncludeTransactions, TBlockTag>(args : WatchBlocksParameters <Transport , undefined | Chain , TIncludeTransactions , TBlockTag >) => WatchBlocksReturnType |
- |
watchContractEvent |
<TAbi, TEventName, TStrict>(args : WatchContractEventParameters <TAbi , TEventName , TStrict , Transport >) => WatchContractEventReturnType |
- |
watchEvent |
<TAbiEvent, TAbiEvents, TStrict>(args : WatchEventParameters <TAbiEvent , TAbiEvents , TStrict , Transport >) => WatchEventReturnType |
- |
watchPendingTransactions |
(args : WatchPendingTransactionsParameters <Transport >) => WatchPendingTransactionsReturnType |
- |
BaseTemplate.publicClient
src/Instantiable.abstract.ts:97
⢠get
walletClient(): Object
Object
Name | Type | Description |
---|---|---|
account |
undefined | Account |
The Account of the Client. |
addChain |
(args : AddChainParameters ) => Promise <void > |
- |
batch? |
{ multicall? : boolean | { batchSize? : number ; wait? : number } } |
Flags for batch settings. |
batch.multicall? |
boolean | { batchSize? : number ; wait? : number } |
Toggle to enable eth_call multicall aggregation. |
cacheTime |
number |
Time (in ms) that cached data will remain in memory. |
ccipRead? |
false | { request? : (parameters : CcipRequestParameters ) => Promise <`0x${string}`> } |
CCIP Read configuration. |
chain |
undefined | Chain |
Chain for the client. |
deployContract |
<abi, chainOverride>(args : DeployContractParameters <abi , undefined | Chain , undefined | Account , chainOverride >) => Promise <`0x${string}`> |
- |
extend |
<client>(fn : (client : Client <Transport , undefined | Chain , undefined | Account , WalletRpcSchema , WalletActions <undefined | Chain , undefined | Account >>) => client ) => Client <Transport , undefined | Chain , undefined | Account , WalletRpcSchema , { [K in string | number | symbol]: client[K] } & WalletActions <undefined | Chain , undefined | Account >> |
- |
getAddresses |
() => Promise <GetAddressesReturnType > |
- |
getChainId |
() => Promise <number > |
- |
getPermissions |
() => Promise <GetPermissionsReturnType > |
- |
key |
string |
A key for the client. |
name |
string |
A name for the client. |
pollingInterval |
number |
Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. |
prepareTransactionRequest |
<TRequest, TChainOverride, TAccountOverride>(args : PrepareTransactionRequestParameters <undefined | Chain , undefined | Account , TChainOverride , TAccountOverride , TRequest >) => Promise <{ [K in string | number | symbol]: (UnionRequiredBy<Extract<UnionOmit<(âŚ), (âŚ)> & ((âŚ) extends (âŚ) ? (âŚ) : (âŚ)) & ((âŚ) extends (âŚ) ? (âŚ) : (âŚ)), IsNever<(âŚ)> extends true ? unknown : ExactPartial<(âŚ)>> & Object, ParameterTypeToParameters<TRequest[âparametersâ] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : âtypeâ | âgasâ | ânonceâ | âblobVersionedHashesâ | âchainIdâ | âfeesâ>> & (unknown extends TRequest[âkzgâ] ? Object : Pick<TRequest, âkzgâ>))[K] }> |
- |
request |
EIP1193RequestFn <WalletRpcSchema > |
Request function wrapped with friendly error handling |
requestAddresses |
() => Promise <RequestAddressesReturnType > |
- |
requestPermissions |
(args : { eth_accounts : Record <string , any > }) => Promise <RequestPermissionsReturnType > |
- |
sendRawTransaction |
(args : SendRawTransactionParameters ) => Promise <`0x${string}`> |
- |
sendTransaction |
<TRequest, TChainOverride>(args : SendTransactionParameters <undefined | Chain , undefined | Account , TChainOverride , TRequest >) => Promise <`0x${string}`> |
- |
signMessage |
(args : SignMessageParameters <undefined | Account >) => Promise <`0x${string}`> |
- |
signTransaction |
<TChainOverride>(args : SignTransactionParameters <undefined | Chain , undefined | Account , TChainOverride >) => Promise <`0x02${string}` | `0x01${string}` | `0x03${string}` | TransactionSerializedLegacy > |
- |
signTypedData |
<TTypedData, TPrimaryType>(args : SignTypedDataParameters <TTypedData , TPrimaryType , undefined | Account >) => Promise <`0x${string}`> |
- |
switchChain |
(args : SwitchChainParameters ) => Promise <void > |
- |
transport |
TransportConfig <string , EIP1193RequestFn > & Record <string , any > |
The RPC transport |
type |
string |
The type of client. |
uid |
string |
A unique ID for the client. |
watchAsset |
(args : WatchAssetParams ) => Promise <boolean > |
- |
writeContract |
<abi, functionName, args, TChainOverride>(args : WriteContractParameters <abi , functionName , args , undefined | Chain , undefined | Account , TChainOverride >) => Promise <`0x${string}`> |
- |
BaseTemplate.walletClient
src/Instantiable.abstract.ts:105
⸠accept(_params
): Promise
<boolean
>
Name | Type |
---|---|
_params |
ValidationParams |
Promise
<boolean
>
src/keeper/contracts/templates/BaseTemplate.abstract.ts:114
⸠agreementId(agreementIdSeed
, creator
): Promise
<string
>
Name | Type |
---|---|
agreementIdSeed |
string |
creator |
string |
Promise
<string
>
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:202
⸠call<T
>(functionName
, args
, from?
): Promise
<T
>
Name |
---|
T |
Name | Type |
---|---|
functionName |
string |
args |
any [] |
from? |
string |
Promise
<T
>
src/keeper/contracts/ContractBase.ts:92
⸠conditions(): [ComputeExecutionCondition
, LockPaymentCondition
, EscrowPaymentCondition
]
[ComputeExecutionCondition
, LockPaymentCondition
, EscrowPaymentCondition
]
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:125
⸠createAgreement(agreementId
, did
, conditionIds
, timeLocks
, timeOuts
, extraArgs
, from
, txParams?
): Promise
<any
>
Name | Type |
---|---|
agreementId |
string |
did |
string |
conditionIds |
string [] |
timeLocks |
number [] |
timeOuts |
number [] |
extraArgs |
any [] |
from |
NvmAccount |
txParams? |
TxParameters |
Promise
<any
>
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:73
⸠createAgreementAndPay(agreementId
, did
, conditionIds
, timeLocks
, timeOuts
, accessConsumer
, condIdx
, rewardAddress
, tokenAddress
, amounts
, receivers
, from
, txParams?
): Promise
<any
>
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 |
Promise
<any
>
BaseTemplate.createAgreementAndPay
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:98
⸠createAgreementFromDDO(agreementIdSeed
, ddo
, parameters
, consumer
, timeOuts?
, txParams?
): Promise
<string
>
Create a new agreement using the data of a DDO.
Name | Type | Description |
---|---|---|
agreementIdSeed |
string |
- |
ddo |
DDO |
DDO. |
parameters |
EscrowComputeExecutionParams |
 |
consumer |
NvmAccount |
- |
timeOuts? |
number [] |
- |
txParams? |
TxParameters |
- |
Promise
<string
>
true if the call was successful.
BaseTemplate.createAgreementFromDDO
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:211
⸠createAgreementWithPaymentFromDDO(agreementIdSeed
, ddo
, serviceReference
, parameters
, consumer
, from
, txParams?
, observer?
): Promise
<string
>
Name | Type |
---|---|
agreementIdSeed |
string |
ddo |
DDO |
serviceReference |
number | ServiceType |
parameters |
EscrowComputeExecutionParams |
consumer |
NvmAccount |
from |
NvmAccount |
txParams? |
TxParameters |
observer? |
(orderProgressStep : OrderProgressStep ) => void |
Promise
<string
>
BaseTemplate.createAgreementWithPaymentFromDDO
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:240
⸠createService(publisher
, metadata
, serviceAttributes
, nftAttributes?
, priceData?
): ServiceCompute
Name | Type |
---|---|
publisher |
NvmAccount |
metadata |
MetaData |
serviceAttributes |
ServiceAttributes |
nftAttributes? |
NFTAttributes |
priceData? |
PricedMetadataInformation |
src/keeper/contracts/templates/BaseTemplate.abstract.ts:48
⸠description(): string
string
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:38
⸠extraGen(_params
): Promise
<any
>
Name | Type |
---|---|
_params |
ValidationParams |
Promise
<any
>
src/keeper/contracts/templates/BaseTemplate.abstract.ts:110
⸠getAgreementCreatedEvent(agreementId
): Promise
<any
[]>
Generates and returns the agreement creation event.
Name | Type | Description |
---|---|---|
agreementId |
string |
Agreement ID. |
Promise
<any
[]>
Agreement created event.
BaseTemplate.getAgreementCreatedEvent
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:450
⸠getAgreementData(agreementId
): Promise
<{ accessConsumer
: string
; accessProvider
: string
; did
: string
}>
Name | Type |
---|---|
agreementId |
string |
Promise
<{ accessConsumer
: string
; accessProvider
: string
; did
: string
}>
src/keeper/contracts/templates/BaseTemplate.abstract.ts:29
⸠getAgreementIdsFromDDO(agreementId
, ddo
, creator
, params
): Promise
<string
[]>
Get agreement conditions IDs.
Name | Type | Description |
---|---|---|
agreementId |
string |
Agreement ID. |
ddo |
DDO |
DDO. |
creator |
string |
- |
params |
EscrowComputeExecutionParams |
- |
Promise
<string
[]>
The condition IDs.
BaseTemplate.getAgreementIdsFromDDO
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:169
⸠getAgreementStatus(agreementId
): Promise
<false
| AgreementConditionsStatus
>
Returns the status of the conditions.
Name | Type | Description |
---|---|---|
agreementId |
string |
Agreement ID. |
Promise
<false
| AgreementConditionsStatus
>
The conditions status.
BaseTemplate.getAgreementStatus
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:331
⸠getAgreementsForDID(did
): Promise
<string
[]>
Name | Type |
---|---|
did |
string |
Promise
<string
[]>
BaseTemplate.getAgreementsForDID
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:476
⸠getConditionTypes(): Promise
<string
[]>
Conditions address list.
Promise
<string
[]>
A list of condition addresses.
BaseTemplate.getConditionTypes
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:137
⸠getConditions(): Promise
<ConditionSmall
[]>
List of condition contracts.
Promise
<ConditionSmall
[]>
A list of condition contracts.
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:148
⸠getFromAddress(from?
): Promise
<string
>
Name | Type |
---|---|
from? |
string |
Promise
<string
>
src/keeper/contracts/ContractBase.ts:68
⸠getServiceAgreementTemplate(): Object
Object
Name | Type |
---|---|
conditionDependency |
{ escrowPaymentCondition : string [] ; lockPayment : never [] = []; serviceExecution : never [] = [] } |
conditionDependency.escrowPaymentCondition |
string [] |
conditionDependency.lockPayment |
never [] |
conditionDependency.serviceExecution |
never [] |
conditions |
{ contractName : string = âLockPaymentConditionâ; events : { actorType : string = âpublisherâ; handler : { functionName : string = âfulfillAccessConditionâ; moduleName : string = âlockPaymentConditionâ; version : string = â0.1â } ; name : string = âFulfilledâ }[] ; functionName : string = âfulfillâ; name : string = âlockPaymentâ; parameters : ({ name : string = â_didâ; type : string = âbytes32â; value : string = ââ } | { name : string = â_amountsâ; type : string = âuint256[]â; value : never [] = [] })[] ; timelock : number = 0; timeout : number = 0 }[] |
contractName |
string |
events |
{ actorType : string = âconsumerâ; handler : { functionName : string = âfulfillLockPaymentConditionâ; moduleName : string = âserviceExecutionTemplateâ; version : string = â0.1â } ; name : string = âAgreementCreatedâ }[] |
fulfillmentOrder |
string [] |
BaseTemplate.getServiceAgreementTemplate
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:89
⸠getServiceAgreementTemplateConditionByRef(ref
): Promise
<undefined
| ConditionSmall
>
Name | Type |
---|---|
ref |
string |
Promise
<undefined
| ConditionSmall
>
BaseTemplate.getServiceAgreementTemplateConditionByRef
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:314
⸠getServiceAgreementTemplateConditions(): ServiceAgreementTemplateCondition
[]
ServiceAgreementTemplateCondition
[]
BaseTemplate.getServiceAgreementTemplateConditions
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:309
⸠getServiceAgreementTemplateDependencies(): Promise
<{ [condition: string]
: string
[]; }>
Promise
<{ [condition: string]
: string
[]; }>
BaseTemplate.getServiceAgreementTemplateDependencies
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:321
⸠getTransactionLogs(txReceipt
, eventName
): ParseEventLogsReturnType
<any
, string
, false
, string
>
Name | Type |
---|---|
txReceipt |
TransactionReceipt |
eventName |
string |
ParseEventLogsReturnType
<any
, string
, false
, string
>
BaseTemplate.getTransactionLogs
src/keeper/contracts/ContractBase.ts:76
⸠init(config
, optional?
, contractAddress?
): Promise
<void
>
Name | Type | Default value |
---|---|---|
config |
InstantiableConfig |
undefined |
optional |
boolean |
false |
contractAddress? |
string |
undefined |
Promise
<void
>
src/keeper/contracts/ContractBase.ts:29
⸠instanceFromDDO(agreementIdSeed
, ddo
, creator
, parameters
): Promise
<AgreementInstance
<EscrowComputeExecutionParams
>>
Name | Type |
---|---|
agreementIdSeed |
string |
ddo |
DDO |
creator |
string |
parameters |
EscrowComputeExecutionParams |
Promise
<AgreementInstance
<EscrowComputeExecutionParams
>>
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:131
⸠lockConditionIndex(): number
number
BaseTemplate.lockConditionIndex
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:57
⸠lockTokens(tokenAddress
, amounts
, from
, txParams?
): Promise
<void
>
Name | Type |
---|---|
tokenAddress |
any |
amounts |
any |
from |
NvmAccount |
txParams? |
TxParameters |
Promise
<void
>
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:382
⸠name(): string
string
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:35
⸠params(consumer
): EscrowComputeExecutionParams
Name | Type |
---|---|
consumer |
NvmAccount |
EscrowComputeExecutionParams
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:121
⸠paramsGen(params
): Promise
<EscrowComputeExecutionParams
>
Specialize params
Name | Type | Description |
---|---|---|
params |
ValidationParams |
Generic parameters |
Promise
<EscrowComputeExecutionParams
>
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:21
⸠paymentData(service
): Promise
<PaymentData
>
Name | Type |
---|---|
service |
ServiceCommon |
Promise
<PaymentData
>
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:61
⸠printAgreementStatus(agreementId
): Promise
<void
>
Prints the agreement status.
Name | Type | Description |
---|---|---|
agreementId |
string |
Agreement ID. |
Promise
<void
>
BaseTemplate.printAgreementStatus
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:418
⸠process(params
, from
, txparams?
): Promise
<void
>
Name | Type |
---|---|
params |
ValidationParams |
from |
NvmAccount |
txparams? |
TxParameters |
Promise
<void
>
src/keeper/contracts/templates/BaseTemplate.abstract.ts:126
⸠providerConfig(): Promise
<{ description
: string
= ââ; environment
: { cluster
: { type
: string
= âKubernetesâ; url
: string
= âhttp://10.0.0.17/xxxâ } ; supportedContainers
: { checksum
: string
= âsha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadcâ; image
: string
= âtensorflow/tensorflowâ; tag
: string
= âlatestâ }[] ; supportedServers
: { cpu
: string
= â16â; disk
: string
= â160gbâ; gpu
: string
= â0â; maxExecutionTime
: number
= 86400; memory
: string
= â128gbâ; price
: string
= â50â; serverId
: string
= â1â; serverType
: string
= âxlsizeâ }[] } ; type
: string
= âAzureâ }>
Promise
<{ description
: string
= ââ; environment
: { cluster
: { type
: string
= âKubernetesâ; url
: string
= âhttp://10.0.0.17/xxxâ } ; supportedContainers
: { checksum
: string
= âsha256:cb57ecfa6ebbefd8ffc7f75c0f00e57a7fa739578a429b6f72a0df19315deadcâ; image
: string
= âtensorflow/tensorflowâ; tag
: string
= âlatestâ }[] ; supportedServers
: { cpu
: string
= â16â; disk
: string
= â160gbâ; gpu
: string
= â0â; maxExecutionTime
: number
= 86400; memory
: string
= â128gbâ; price
: string
= â50â; serverId
: string
= â1â; serverType
: string
= âxlsizeâ }[] } ; type
: string
= âAzureâ }>
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:42
⸠send(functionName
, from
, args
, params?
): Promise
<any
>
Name | Type |
---|---|
functionName |
string |
from |
NvmAccount |
args |
any [] |
params |
TxParameters |
Promise
<any
>
src/keeper/contracts/ContractBase.ts:128
⸠sendFrom(functionName
, args
, from
, value?
): Promise
<any
>
Name | Type |
---|---|
functionName |
string |
args |
any [] |
from |
NvmAccount |
value? |
TxParameters |
Promise
<any
>
src/keeper/contracts/ContractBase.ts:109
⸠service(): ServiceType
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:117
⸠serviceEndpoint(): string
string
src/keeper/contracts/templates/BaseTemplate.abstract.ts:44
⸠setInstanceConfig(config
): void
Name | Type |
---|---|
config |
InstantiableConfig |
void
BaseTemplate.setInstanceConfig
src/Instantiable.abstract.ts:163
⸠someLog(logs
): undefined
Name | Type |
---|---|
logs |
any [] |
undefined
src/keeper/contracts/ContractBase.ts:85
⸠standardContext(ddo
, creator
, serviceIndex?
): ConditionContext
Name | Type |
---|---|
ddo |
DDO |
creator |
string |
serviceIndex? |
number |
ConditionContext
src/keeper/contracts/templates/AgreementTemplate.abstract.ts:189
⸠track(_params
, _from
, _txparams?
): Promise
<boolean
>
Name | Type |
---|---|
_params |
ValidationParams |
_from |
NvmAccount |
_txparams? |
TxParameters |
Promise
<boolean
>
src/keeper/contracts/templates/BaseTemplate.abstract.ts:118
⸠validateAgreement(agreement_id
, did
, params
, from
, extra?
, txparams?
): Promise
<void
>
Name | Type |
---|---|
agreement_id |
string |
did |
string |
params |
EscrowComputeExecutionParams |
from |
NvmAccount |
extra |
any |
txparams? |
TxParameters |
Promise
<void
>
BaseTemplate.validateAgreement
src/keeper/contracts/templates/BaseTemplate.abstract.ts:141
⸠getInstance(config
): Promise
<EscrowComputeExecutionTemplate
>
Name | Type |
---|---|
config |
InstantiableConfig |
Promise
<EscrowComputeExecutionTemplate
>
src/keeper/contracts/templates/EscrowComputeExecutionTemplate.ts:26
⸠setInstanceConfig<T
>(instance
, instantiableConfig
): void
Name | Type |
---|---|
T |
extends Instantiable |
Name | Type |
---|---|
instance |
T |
instantiableConfig |
InstantiableConfig |
void
BaseTemplate.setInstanceConfig