NeverminedNode
@nevermined-io/sdk - v3.0.41 / NeverminedNode
Class: NeverminedNode
Provides a interface with Nevermined Node. The Nevermined Node is the technical component executed by the Publishers allowing to them to provide extended data services.
Hierarchy
↳
NeverminedNode
Table of contents
Constructors
Accessors
- artifactsFolder
- circuitsFolder
- client
- config
- instanceConfig
- instantiableConfig
- logger
- nevermined
- publicClient
- url
- walletClient
Methods
- claimNFT
- computeLogs
- computeStatus
- consumeService
- downloadService
- encrypt
- execute
- fetchToken
- getAccessEndpoint
- getAccessProofEndpoint
- getBabyjubPublicKey
- getClaimNftEndpoint
- getComputeLogsEndpoint
- getComputeStatusEndpoint
- getConsumeEndpoint
- getDownloadEndpoint
- getEcdsaPublicKey
- getEncryptEndpoint
- getExecuteEndpoint
- getFetchTokenEndpoint
- getFetchTokenWithNvmApiKeyEndpoint
- getNeverminedNodeInfo
- getNft721Endpoint
- getNftAccessEndpoint
- getNftEndpoint
- getProviderAddress
- getPurchaseEndpoint
- getRsaPublicKey
- getServiceEndpoint
- getSubscriptionToken
- getSubscriptionsEndpoint
- getUploadFilecoinEndpoint
- getUploadIPFSEndpoint
- getUploadS3Endpoint
- getVersionInfo
- initializeServiceAgreement
- publishImmutableContent
- setInstanceConfig
- uploadContent
- getInstance
- setInstanceConfig
Constructors
constructor
• new NeverminedNode(config
): NeverminedNode
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
Overrides
Defined in
src/services/node/NeverminedNode.ts:39
Accessors
artifactsFolder
• get
artifactsFolder(): undefined
| string
Returns
undefined
| string
Inherited from
Instantiable.artifactsFolder
Defined in
src/Instantiable.abstract.ts:137
circuitsFolder
• get
circuitsFolder(): undefined
| string
Returns
undefined
| string
Inherited from
Instantiable.circuitsFolder
Defined in
src/Instantiable.abstract.ts:141
client
• get
client(): Web3Clients
Returns
Inherited from
Instantiable.client
Defined in
src/Instantiable.abstract.ts:89
config
• get
config(): NeverminedOptions
Returns
Inherited from
Instantiable.config
Defined in
src/Instantiable.abstract.ts:120
instanceConfig
• get
instanceConfig(): InstantiableConfig
Returns
Inherited from
Instantiable.instanceConfig
Defined in
src/Instantiable.abstract.ts:145
instantiableConfig
• get
instantiableConfig(): undefined
| InstantiableConfig
Returns
undefined
| InstantiableConfig
Inherited from
Instantiable.instantiableConfig
Defined in
src/Instantiable.abstract.ts:113
logger
• get
logger(): Logger
Returns
Logger
Inherited from
Instantiable.logger
Defined in
src/Instantiable.abstract.ts:128
nevermined
• get
nevermined(): Nevermined
Returns
Inherited from
Instantiable.nevermined
Defined in
src/Instantiable.abstract.ts:81
publicClient
• get
publicClient(): Object
Returns
Object
Name | Type | Description |
---|---|---|
account | undefined | The Account of the Client. |
batch? | { multicall? : boolean | { batchSize? : number ; wait? : number } } | Flags for batch settings. |
batch.multicall? | boolean | { batchSize? : number ; wait? : number } | Toggle to enable eth_call multicall aggregation. |
cacheTime | number | Time (in ms) that cached data will remain in memory. |
call | (parameters : CallParameters \<undefined | Chain >) => Promise \<CallReturnType > | - |
ccipRead? | false | { request? : (parameters : CcipRequestParameters ) => Promise \<`0x${string}`> } | CCIP Read configuration. |
chain | undefined | Chain | Chain for the client. |
createBlockFilter | () => Promise \<{ id : `0x${string}` ; request : EIP1193RequestFn \<readonly [{ Method : "eth_getFilterChanges" ; Parameters : [filterId: `0x${string}`] ; ReturnType : `0x${string}`[] | RpcLog [] }, { Method : "eth_getFilterLogs" ; Parameters : [filterId: `0x${string}`] ; ReturnType : RpcLog [] }, { Method : "eth_uninstallFilter" ; Parameters : [filterId: `0x${string}`] ; ReturnType : boolean }]> ; type : "block" }> | - |
createContractEventFilter | \<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args : CreateContractEventFilterParameters \<TAbi , TEventName , TArgs , TStrict , TFromBlock , TToBlock >) => Promise \<CreateContractEventFilterReturnType \<TAbi , TEventName , TArgs , TStrict , TFromBlock , TToBlock >> | - |
createEventFilter | \<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args? : CreateEventFilterParameters \<TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock , _EventName , _Args >) => Promise \<{ [K in string | number | symbol]: Filter\<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>[K] }> | - |
createPendingTransactionFilter | () => Promise \<{ id : `0x${string}` ; request : EIP1193RequestFn \<readonly [{ Method : "eth_getFilterChanges" ; Parameters : [filterId: `0x${string}`] ; ReturnType : `0x${string}`[] | RpcLog [] }, { Method : "eth_getFilterLogs" ; Parameters : [filterId: `0x${string}`] ; ReturnType : RpcLog [] }, { Method : "eth_uninstallFilter" ; Parameters : [filterId: `0x${string}`] ; ReturnType : boolean }]> ; type : "transaction" }> | - |
estimateContractGas | \<TChain, abi, functionName, args>(args : EstimateContractGasParameters \<abi , functionName , args , TChain >) => Promise \<bigint > | - |
estimateFeesPerGas | \<TChainOverride, TType>(args? : EstimateFeesPerGasParameters \<undefined | Chain , TChainOverride , TType >) => Promise \<EstimateFeesPerGasReturnType > | - |
estimateGas | (args : EstimateGasParameters \<undefined | Chain >) => Promise \<bigint > | - |
estimateMaxPriorityFeePerGas | \<TChainOverride>(args? : { chain : null | TChainOverride }) => Promise \<bigint > | - |
extend | \<client>(fn : (client : Client \<Transport , undefined | Chain , undefined , PublicRpcSchema , PublicActions \<Transport , undefined | Chain >>) => client ) => Client \<Transport , undefined | Chain , undefined , PublicRpcSchema , { [K in string | number | symbol]: client[K] } & PublicActions \<Transport , undefined | Chain >> | - |
getBalance | (args : GetBalanceParameters ) => Promise \<bigint > | - |
getBlobBaseFee | () => Promise \<bigint > | - |
getBlock | \<TIncludeTransactions, TBlockTag>(args? : GetBlockParameters \<TIncludeTransactions , TBlockTag >) => Promise \<{ baseFeePerGas : null | bigint ; blobGasUsed : bigint ; difficulty : bigint ; excessBlobGas : bigint ; extraData : `0x${string}` ; gasLimit : bigint ; gasUsed : bigint ; hash : TBlockTag extends "pending" ? null : `0x${string}` ; logsBloom : TBlockTag extends "pending" ? null : `0x${string}` ; miner : `0x${string}` ; mixHash : `0x${string}` ; nonce : TBlockTag extends "pending" ? null : `0x${string}` ; number : TBlockTag extends "pending" ? null : bigint ; parentHash : `0x${string}` ; receiptsRoot : `0x${string}` ; sealFields : `0x${string}`[] ; sha3Uncles : `0x${string}` ; size : bigint ; stateRoot : `0x${string}` ; timestamp : bigint ; totalDifficulty : null | bigint ; transactions : TIncludeTransactions extends true ? ({ accessList? : undefined ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId? : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "legacy" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity? : undefined } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip2930" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip1559" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes : `0x${string}`[] ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas : bigint ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip4844" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number })[] : `0x${string}`[] ; transactionsRoot : `0x${string}` ; uncles : `0x${string}`[] ; withdrawals? : Withdrawal [] ; withdrawalsRoot? : `0x${string}` }> | - |
getBlockNumber | (args? : GetBlockNumberParameters ) => Promise \<bigint > | - |
getBlockTransactionCount | (args? : GetBlockTransactionCountParameters ) => Promise \<number > | - |
getBytecode | (args : GetBytecodeParameters ) => Promise \<GetBytecodeReturnType > | - |
getChainId | () => Promise \<number > | - |
getContractEvents | \<abi, eventName, strict, fromBlock, toBlock>(args : GetContractEventsParameters \<abi , eventName , strict , fromBlock , toBlock >) => Promise \<GetContractEventsReturnType \<abi , eventName , strict , fromBlock , toBlock >> | - |
getEnsAddress | (args : { blockNumber? : bigint ; blockTag? : BlockTag ; coinType? : number ; gatewayUrls? : string [] ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsAddressReturnType > | - |
getEnsAvatar | (args : { assetGatewayUrls? : AssetGatewayUrls ; blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsAvatarReturnType > | - |
getEnsName | (args : { address : `0x${string}` ; blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsNameReturnType > | - |
getEnsResolver | (args : { blockNumber? : bigint ; blockTag? : BlockTag ; name : string ; universalResolverAddress? : `0x${string}` }) => Promise \<`0x${string}`> | - |
getEnsText | (args : { blockNumber? : bigint ; blockTag? : BlockTag ; gatewayUrls? : string [] ; key : string ; name : string ; strict? : boolean ; universalResolverAddress? : `0x${string}` }) => Promise \<GetEnsTextReturnType > | - |
getFeeHistory | (args : GetFeeHistoryParameters ) => Promise \<GetFeeHistoryReturnType > | - |
getFilterChanges | \<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args : GetFilterChangesParameters \<TFilterType , TAbi , TEventName , TStrict , TFromBlock , TToBlock >) => Promise \<GetFilterChangesReturnType \<TFilterType , TAbi , TEventName , TStrict , TFromBlock , TToBlock >> | - |
getFilterLogs | \<TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args : GetFilterLogsParameters \<TAbi , TEventName , TStrict , TFromBlock , TToBlock >) => Promise \<GetFilterLogsReturnType \<TAbi , TEventName , TStrict , TFromBlock , TToBlock >> | - |
getGasPrice | () => Promise \<bigint > | - |
getLogs | \<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>(args? : GetLogsParameters \<TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock >) => Promise \<GetLogsReturnType \<TAbiEvent , TAbiEvents , TStrict , TFromBlock , TToBlock >> | - |
getProof | (args : GetProofParameters ) => Promise \<GetProofReturnType > | - |
getStorageAt | (args : GetStorageAtParameters ) => Promise \<GetStorageAtReturnType > | - |
getTransaction | \<TBlockTag>(args : GetTransactionParameters \<TBlockTag >) => Promise \<{ accessList? : undefined ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId? : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "legacy" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity? : undefined } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice : bigint ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas? : undefined ; maxPriorityFeePerGas? : undefined ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip2930" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes? : undefined ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas? : undefined ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip1559" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number } | { accessList : AccessList ; blobVersionedHashes : `0x${string}`[] ; blockHash : TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber : TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId : number ; from : `0x${string}` ; gas : bigint ; gasPrice? : undefined ; hash : `0x${string}` ; input : `0x${string}` ; maxFeePerBlobGas : bigint ; maxFeePerGas : bigint ; maxPriorityFeePerGas : bigint ; nonce : number ; r : `0x${string}` ; s : `0x${string}` ; to : null | `0x${string}` ; transactionIndex : TBlockTag extends "pending" ? true : false extends true ? null : number ; type : "eip4844" ; typeHex : null | `0x${string}` ; v : bigint ; value : bigint ; yParity : number }> | - |
getTransactionConfirmations | (args : GetTransactionConfirmationsParameters \<undefined | Chain >) => Promise \<bigint > | - |
getTransactionCount | (args : GetTransactionCountParameters ) => Promise \<number > | - |
getTransactionReceipt | (args : GetTransactionReceiptParameters ) => Promise \<TransactionReceipt > | - |
key | string | A key for the client. |
multicall | \<contracts, allowFailure>(args : MulticallParameters \<contracts , allowFailure >) => Promise \<MulticallReturnType \<contracts , allowFailure >> | - |
name | string | A name for the client. |
pollingInterval | number | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. |
prepareTransactionRequest | \<TRequest, TChainOverride, TAccountOverride>(args : PrepareTransactionRequestParameters \<undefined | Chain , undefined | Account , TChainOverride , TAccountOverride , TRequest >) => Promise \<{ [K in string | number | symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" | "gas" | "nonce" | "blobVersionedHashes" | "chainId" | "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[K] }> | - |
readContract | \<abi, functionName, args>(args : ReadContractParameters \<abi , functionName , args >) => Promise \<ReadContractReturnType \<abi , functionName , args >> | - |
request | EIP1193RequestFn \<PublicRpcSchema > | Request function wrapped with friendly error handling |
sendRawTransaction | (args : SendRawTransactionParameters ) => Promise \<`0x${string}`> | - |
simulateContract | \<abi, functionName, args, chainOverride, accountOverride>(args : SimulateContractParameters \<abi , functionName , args , undefined | Chain , chainOverride , accountOverride >) => Promise \<SimulateContractReturnType \<abi , functionName , args , undefined | Chain , undefined | Account , chainOverride , accountOverride >> | - |
transport | TransportConfig \<string , EIP1193RequestFn > & Record \<string , any > | The RPC transport |
type | string | The type of client. |
uid | string | A unique ID for the client. |
uninstallFilter | (args : UninstallFilterParameters ) => Promise \<boolean > | - |
verifyMessage | (args : VerifyMessageParameters ) => Promise \<boolean > | - |
verifyTypedData | (args : VerifyTypedDataParameters ) => Promise \<boolean > | - |
waitForTransactionReceipt | (args : WaitForTransactionReceiptParameters \<undefined | Chain >) => Promise \<TransactionReceipt > | - |
watchBlockNumber | (args : WatchBlockNumberParameters ) => WatchBlockNumberReturnType | - |
watchBlocks | \<TIncludeTransactions, TBlockTag>(args : WatchBlocksParameters \<Transport , undefined | Chain , TIncludeTransactions , TBlockTag >) => WatchBlocksReturnType | - |
watchContractEvent | \<TAbi, TEventName, TStrict>(args : WatchContractEventParameters \<TAbi , TEventName , TStrict , Transport >) => WatchContractEventReturnType | - |
watchEvent | \<TAbiEvent, TAbiEvents, TStrict>(args : WatchEventParameters \<TAbiEvent , TAbiEvents , TStrict , Transport >) => WatchEventReturnType | - |
watchPendingTransactions | (args : WatchPendingTransactionsParameters \<Transport >) => WatchPendingTransactionsReturnType | - |
Inherited from
Instantiable.publicClient
Defined in
src/Instantiable.abstract.ts:97
url
• get
url(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:35
walletClient
• get
walletClient(): Object
Returns
Object
Name | Type | Description |
---|---|---|
account | undefined | Account | The Account of the Client. |
addChain | (args : AddChainParameters ) => Promise \<void > | - |
batch? | { multicall? : boolean | { batchSize? : number ; wait? : number } } | Flags for batch settings. |
batch.multicall? | boolean | { batchSize? : number ; wait? : number } | Toggle to enable eth_call multicall aggregation. |
cacheTime | number | Time (in ms) that cached data will remain in memory. |
ccipRead? | false | { request? : (parameters : CcipRequestParameters ) => Promise \<`0x${string}`> } | CCIP Read configuration. |
chain | undefined | Chain | Chain for the client. |
deployContract | \<abi, chainOverride>(args : DeployContractParameters \<abi , undefined | Chain , undefined | Account , chainOverride >) => Promise \<`0x${string}`> | - |
extend | \<client>(fn : (client : Client \<Transport , undefined | Chain , undefined | Account , WalletRpcSchema , WalletActions \<undefined | Chain , undefined | Account >>) => client ) => Client \<Transport , undefined | Chain , undefined | Account , WalletRpcSchema , { [K in string | number | symbol]: client[K] } & WalletActions \<undefined | Chain , undefined | Account >> | - |
getAddresses | () => Promise \<GetAddressesReturnType > | - |
getChainId | () => Promise \<number > | - |
getPermissions | () => Promise \<GetPermissionsReturnType > | - |
key | string | A key for the client. |
name | string | A name for the client. |
pollingInterval | number | Frequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds. |
prepareTransactionRequest | \<TRequest, TChainOverride, TAccountOverride>(args : PrepareTransactionRequestParameters \<undefined | Chain , undefined | Account , TChainOverride , TAccountOverride , TRequest >) => Promise \<{ [K in string | number | symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" | "gas" | "nonce" | "blobVersionedHashes" | "chainId" | "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[K] }> | - |
request | EIP1193RequestFn \<WalletRpcSchema > | Request function wrapped with friendly error handling |
requestAddresses | () => Promise \<RequestAddressesReturnType > | - |
requestPermissions | (args : { eth_accounts : Record \<string , any > }) => Promise \<RequestPermissionsReturnType > | - |
sendRawTransaction | (args : SendRawTransactionParameters ) => Promise \<`0x${string}`> | - |
sendTransaction | \<TRequest, TChainOverride>(args : SendTransactionParameters \<undefined | Chain , undefined | Account , TChainOverride , TRequest >) => Promise \<`0x${string}`> | - |
signMessage | (args : SignMessageParameters \<undefined | Account >) => Promise \<`0x${string}`> | - |
signTransaction | \<TChainOverride>(args : SignTransactionParameters \<undefined | Chain , undefined | Account , TChainOverride >) => Promise \<`0x02${string}` | `0x01${string}` | `0x03${string}` | TransactionSerializedLegacy > | - |
signTypedData | \<TTypedData, TPrimaryType>(args : SignTypedDataParameters \<TTypedData , TPrimaryType , undefined | Account >) => Promise \<`0x${string}`> | - |
switchChain | (args : SwitchChainParameters ) => Promise \<void > | - |
transport | TransportConfig \<string , EIP1193RequestFn > & Record \<string , any > | The RPC transport |
type | string | The type of client. |
uid | string | A unique ID for the client. |
watchAsset | (args : WatchAssetParams ) => Promise \<boolean > | - |
writeContract | \<abi, functionName, args, TChainOverride>(args : WriteContractParameters \<abi , functionName , args , undefined | Chain , undefined | Account , TChainOverride >) => Promise \<`0x${string}`> | - |
Inherited from
Instantiable.walletClient
Defined in
src/Instantiable.abstract.ts:105
Methods
claimNFT
▸ claimNFT(agreementId
, nftHolder
, nftReceiver
, nftAmount
, ercType?
, did?
, serviceIndex?
): Promise
\<boolean
>
Parameters
Name | Type | Default value |
---|---|---|
agreementId | string | undefined |
nftHolder | string | undefined |
nftReceiver | string | undefined |
nftAmount | bigint | undefined |
ercType | ERCType | 1155 |
did? | string | undefined |
serviceIndex? | number | undefined |
Returns
Promise
\<boolean
>
Defined in
src/services/node/NeverminedNode.ts:383
computeLogs
▸ computeLogs(agreementId
, executionId
, account
): Promise
\<any
>
Parameters
Name | Type |
---|---|
agreementId | string |
executionId | string |
account | NvmAccount |
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:313
computeStatus
▸ computeStatus(agreementId
, executionId
, account
): Promise
\<any
>
Parameters
Name | Type |
---|---|
agreementId | string |
executionId | string |
account | NvmAccount |
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:348
consumeService
▸ consumeService(did
, agreementId
, serviceEndpoint
, account
, files
, destination
, index?
, result?
, buyer?
, babysig?
): Promise
\<string
>
Parameters
Name | Type | Default value |
---|---|---|
did | string | undefined |
agreementId | string | undefined |
serviceEndpoint | string | undefined |
account | NvmAccount | undefined |
files | MetaDataExternalResource [] | undefined |
destination | undefined | string | undefined |
index | number | -1 |
result | AssetResult | AssetResult.DATA |
buyer? | string | undefined |
babysig? | Babysig | undefined |
Returns
Promise
\<string
>
Defined in
src/services/node/NeverminedNode.ts:177
downloadService
▸ downloadService(files
, destination
, index?
, headers?
, result?
): Promise
\<string
>
Parameters
Name | Type | Default value |
---|---|---|
files | MetaDataExternalResource [] | undefined |
destination | undefined | string | undefined |
index | number | -1 |
headers? | Object | undefined |
result | AssetResult | AssetResult.DATA |
Returns
Promise
\<string
>
Defined in
src/services/node/NeverminedNode.ts:244
encrypt
▸ encrypt(did
, document
, method
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | any |
document | any |
method | any |
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:224
execute
▸ execute(agreementId
, workflowDid
, account
): Promise
\<any
>
Parameters
Name | Type |
---|---|
agreementId | string |
workflowDid | string |
account | NvmAccount |
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:273
fetchToken
▸ fetchToken(grantToken
, numberTries?
, nvmApiKey?
): Promise
\<string
>
Parameters
Name | Type | Default value |
---|---|---|
grantToken | string | undefined |
numberTries | number | 3 |
nvmApiKey? | string | undefined |
Returns
Promise
\<string
>
Defined in
src/services/node/NeverminedNode.ts:432
getAccessEndpoint
▸ getAccessEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:56
getAccessProofEndpoint
▸ getAccessProofEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:60
getBabyjubPublicKey
▸ getBabyjubPublicKey(): Promise
\<any
>
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:143
getClaimNftEndpoint
▸ getClaimNftEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:116
getComputeLogsEndpoint
▸ getComputeLogsEndpoint(executionId
): string
Parameters
Name | Type |
---|---|
executionId | string |
Returns
string
Defined in
src/services/node/NeverminedNode.ts:68
getComputeStatusEndpoint
▸ getComputeStatusEndpoint(executionId
): string
Parameters
Name | Type |
---|---|
executionId | string |
Returns
string
Defined in
src/services/node/NeverminedNode.ts:72
getConsumeEndpoint
▸ getConsumeEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:52
getDownloadEndpoint
▸ getDownloadEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:148
getEcdsaPublicKey
▸ getEcdsaPublicKey(): Promise
\<any
>
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:138
getEncryptEndpoint
▸ getEncryptEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:80
getExecuteEndpoint
▸ getExecuteEndpoint(serviceAgreementId
): string
Parameters
Name | Type |
---|---|
serviceAgreementId | string |
Returns
string
Defined in
src/services/node/NeverminedNode.ts:76
getFetchTokenEndpoint
▸ getFetchTokenEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:84
getFetchTokenWithNvmApiKeyEndpoint
▸ getFetchTokenWithNvmApiKeyEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:88
getNeverminedNodeInfo
▸ getNeverminedNodeInfo(): Promise
\<any
>
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:124
getNft721Endpoint
▸ getNft721Endpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:108
getNftAccessEndpoint
▸ getNftAccessEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:112
getNftEndpoint
▸ getNftEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:104
getProviderAddress
▸ getProviderAddress(): Promise
\<any
>
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:128
getPurchaseEndpoint
▸ getPurchaseEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:48
getRsaPublicKey
▸ getRsaPublicKey(): Promise
\<any
>
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:133
getServiceEndpoint
▸ getServiceEndpoint(service
): string
Parameters
Name | Type |
---|---|
service | string |
Returns
string
Defined in
src/services/node/NeverminedNode.ts:64
getSubscriptionToken
▸ getSubscriptionToken(did
, account
): Promise
\<SubscriptionToken
>
Parameters
Name | Type |
---|---|
did | string |
account | NvmAccount |
Returns
Promise
\<SubscriptionToken
>
Defined in
src/services/node/NeverminedNode.ts:507
getSubscriptionsEndpoint
▸ getSubscriptionsEndpoint(did
): string
Parameters
Name | Type |
---|---|
did | string |
Returns
string
Defined in
src/services/node/NeverminedNode.ts:120
getUploadFilecoinEndpoint
▸ getUploadFilecoinEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:92
getUploadIPFSEndpoint
▸ getUploadIPFSEndpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:96
getUploadS3Endpoint
▸ getUploadS3Endpoint(): string
Returns
string
Defined in
src/services/node/NeverminedNode.ts:100
getVersionInfo
▸ getVersionInfo(): Promise
\<any
>
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:44
initializeServiceAgreement
▸ initializeServiceAgreement(did
, serviceAgreementId
, serviceIndex
, signature
, consumerAddress
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
serviceAgreementId | string |
serviceIndex | number |
signature | string |
consumerAddress | string |
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:152
publishImmutableContent
▸ publishImmutableContent(ddo
, publishMetadata?
): Promise
\<{ backend
: ImmutableBackends
; url
: string
}>
Parameters
Name | Type | Default value |
---|---|---|
ddo | DDO | undefined |
publishMetadata | PublishMetadataOptions | PublishMetadataOptions.IPFS |
Returns
Promise
\<{ backend
: ImmutableBackends
; url
: string
}>
Defined in
src/services/node/NeverminedNode.ts:453
setInstanceConfig
▸ setInstanceConfig(config
): void
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
void
Inherited from
Instantiable.setInstanceConfig
Defined in
src/Instantiable.abstract.ts:163
uploadContent
▸ uploadContent(data
, encrypt?
, backend?
): Promise
\<any
>
Parameters
Name | Type | Default value |
---|---|---|
data | string | ReadStream | undefined |
encrypt? | boolean | undefined |
backend | NodeUploadBackends | NodeUploadBackends.Filecoin |
Returns
Promise
\<any
>
Defined in
src/services/node/NeverminedNode.ts:479
getInstance
▸ getInstance(..._args
): any
Parameters
Name | Type |
---|---|
..._args | any |
Returns
any
Inherited from
Defined in
src/Instantiable.abstract.ts:150
setInstanceConfig
▸ setInstanceConfig\<T
>(instance
, instantiableConfig
): void
Type parameters
Name | Type |
---|---|
T | extends Instantiable |
Parameters
Name | Type |
---|---|
instance | T |
instantiableConfig | InstantiableConfig |
Returns
void
Inherited from
Instantiable.setInstanceConfig