ProvenanceApi
@nevermined-io/sdk - v3.0.44 / ProvenanceApi
Class: ProvenanceApi
The Nevermined Provenance API allows to register and search entries in the Nevermined W3C Provenance registry You can find more information about Nevermined Provenance here: https://docs.nevermined.io/docs/architecture/specs/Spec-PROVENANCE
Hierarchy
↳
ProvenanceApi
Table of contents
Constructors
Accessors
- artifactsFolder
- circuitsFolder
- client
- config
- instanceConfig
- instantiableConfig
- logger
- nevermined
- publicClient
- walletClient
Methods
- actedOnBehalf
- addDidProvenanceDelegate
- getDIDProvenanceEvents
- getProvenanceEntry
- getProvenanceMethodEvents
- getProvenanceOwner
- isProvenanceDelegate
- removeDidProvenanceDelegate
- setInstanceConfig
- used
- wasAssociatedWith
- wasDerivedFrom
- getInstance
- setInstanceConfig
Constructors
constructor
• new ProvenanceApi(config): ProvenanceApi
Creates a new ProvenanceApi
Parameters
| Name | Type | Description |
|---|---|---|
config | InstantiableConfig | Configuration of the Nevermined instance |
Returns
Overrides
Defined in
src/nevermined/api/ProvenanceApi.ts:18
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
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
actedOnBehalf
▸ actedOnBehalf(provenanceId, did, delegateAgentId, responsibleAgentId, activityId, signature, attributes, from, txParams?): Promise\<boolean>
Implements the W3C PROV Delegation action.
Parameters
| Name | Type | Description |
|---|---|---|
provenanceId | string | Provenance ID |
did | string | Identifier of the entity created |
delegateAgentId | string | Delegate Agent Identifier |
responsibleAgentId | string | Responsible Agent Identifier |
activityId | string | Identifier of the activity creating the new entity |
signature | string | Signature provided by the delegated agent |
attributes | string | Attributes associated with the action |
from | NvmAccount | Sender account. |
txParams? | TxParameters | Transaction parameters |
Returns
Promise\<boolean>
true if the call succeeded.
Remarks
This method can be called when want to track the delegation of an agent to act on behalf of another agent.
Defined in
src/nevermined/api/ProvenanceApi.ts:163
addDidProvenanceDelegate
▸ addDidProvenanceDelegate(did, delegatedAddress, from, txParams?): Promise\<boolean>
Add new DID provenance delegate. The delegate will be able to perform actions on behalf of the DID owner.
Parameters
| Name | Type | Description |
|---|---|---|
did | string | Identifier of the entity created |
delegatedAddress | string | Delegate Address |
from | NvmAccount | Sender account. |
txParams? | TxParameters | Transaction parameters |
Returns
Promise\<boolean>
true if the call succeeded.
Defined in
src/nevermined/api/ProvenanceApi.ts:196
getDIDProvenanceEvents
▸ getDIDProvenanceEvents(did): Promise\<{ activityId: string ; agentId: string ; agentInvolvedId: string ; attributes?: string ; blockNumberUpdated: number ; did: string ; id: string ; method: number ; provId: string ; relatedDid: string }[]>
Search for ProvenanceAttributeRegistered events related with a specific DID
Parameters
| Name | Type | Description |
|---|---|---|
did | string | identifier of the entity created |
Returns
Promise\<{ activityId: string ; agentId: string ; agentInvolvedId: string ; attributes?: string ; blockNumberUpdated: number ; did: string ; id: string ; method: number ; provId: string ; relatedDid: string }[]>
A list of provenance events.
Defined in
src/nevermined/api/ProvenanceApi.ts:258
getProvenanceEntry
▸ getProvenanceEntry(provenanceId): Promise\<undefined | { activityId: any ; agentId: any ; agentInvolvedId: any ; blockNumberUpdated: any ; createdBy: any ; did: any ; method: ProvenanceMethod ; relatedDid: any ; signatureDelegate: any }>
Given a provenance id it returns the provenance details
Parameters
| Name | Type | Description |
|---|---|---|
provenanceId | string | Unique identifier of a provenance entry |
Returns
Promise\<undefined | { activityId: any ; agentId: any ; agentInvolvedId: any ; blockNumberUpdated: any ; createdBy: any ; did: any ; method: ProvenanceMethod ; relatedDid: any ; signatureDelegate: any }>
ProvenanceRegistry object with the provenance details
Defined in
src/nevermined/api/ProvenanceApi.ts:28
getProvenanceMethodEvents
▸ getProvenanceMethodEvents\<T>(method, did): Promise\<ProvenanceEvent\<T>[]>
Search for ProvenanceAttributeRegistered events related with a specific DID
Type parameters
| Name | Type |
|---|---|
T | extends ProvenanceMethod |
Parameters
| Name | Type | Description |
|---|---|---|
method | T | Method |
did | string | Identifier of the entity created |
Returns
Promise\<ProvenanceEvent\<T>[]>
A list of provenance method events.
Defined in
src/nevermined/api/ProvenanceApi.ts:268
getProvenanceOwner
▸ getProvenanceOwner(did): Promise\<unknown>
Retrieve the owner of the provenance record.
Parameters
| Name | Type | Description |
|---|---|---|
did | string | Identifier of the entity created |
Returns
Promise\<unknown>
Address of the provenance owner.
Defined in
src/nevermined/api/ProvenanceApi.ts:249
isProvenanceDelegate
▸ isProvenanceDelegate(did, delegatedAddress): Promise\<unknown>
Check whether a given DID delegate exists
Parameters
| Name | Type | Description |
|---|---|---|
did | string | Identifier of the entity created |
delegatedAddress | string | Delegate Address |
Returns
Promise\<unknown>
true if the address is a delegate.
Defined in
src/nevermined/api/ProvenanceApi.ts:240
removeDidProvenanceDelegate
▸ removeDidProvenanceDelegate(did, delegatedAddress, from, txParams?): Promise\<boolean>
Remove an existing DID as delegate.
Parameters
| Name | Type | Description |
|---|---|---|
did | string | Identifier of the entity created |
delegatedAddress | string | Delegate Address |
from | NvmAccount | Sender account. |
txParams? | TxParameters | Transaction parameters |
Returns
Promise\<boolean>
true if the call succeeded.
Defined in
src/nevermined/api/ProvenanceApi.ts:219
setInstanceConfig
▸ setInstanceConfig(config): void
Parameters
| Name | Type |
|---|---|
config | InstantiableConfig |
Returns
void
Inherited from
Instantiable.setInstanceConfig
Defined in
src/Instantiable.abstract.ts:163
used
▸ used(provenanceId, did, agentId, activityId, signature, attributes, from, txParams?): Promise\<boolean>
Implements the W3C PROV Usage action.
Parameters
| Name | Type | Description |
|---|---|---|
provenanceId | string | Provenance ID |
did | string | Identifier of the entity created |
agentId | string | Agent Identifier |
activityId | string | Identifier of the activity creating the new entity |
signature | string | Signature (optional) provided by the agent involved |
attributes | string | Attributes associated with the action |
from | NvmAccount | Sender account. |
txParams? | TxParameters | Transaction parameters |
Returns
Promise\<boolean>
true if the call succeeded.
Remarks
This method can be called when want to track the usage of a DID.
Defined in
src/nevermined/api/ProvenanceApi.ts:48
wasAssociatedWith
▸ wasAssociatedWith(provenanceId, did, agentId, activityId, attributes, from, txParams?): Promise\<boolean>
Implements the W3C PROV Association action
Parameters
| Name | Type | Description |
|---|---|---|
provenanceId | string | Provenance ID |
did | string | Identifier of the entity created |
agentId | string | Agent Identifier |
activityId | string | Identifier of the activity creating the new entity |
attributes | string | Attributes associated with the action |
from | NvmAccount | Sender account. |
txParams? | TxParameters | Transaction parameters |
Returns
Promise\<boolean>
true if the call succeeded.
Remarks
This method can be called when want to track the association of an agent with a DID.
Defined in
src/nevermined/api/ProvenanceApi.ts:125
wasDerivedFrom
▸ wasDerivedFrom(provenanceId, newEntityDid, usedEntityDid, agentId, activityId, attributes, from, txParams?): Promise\<boolean>
Implements the W3C PROV Derivation action
Parameters
| Name | Type | Description |
|---|---|---|
provenanceId | string | Provenance ID |
newEntityDid | string | Identifier of the new entity derived |
usedEntityDid | string | Identifier of the entity used to derive the new entity |
agentId | string | Agent Identifier |
activityId | string | Identifier of the activity creating the new entity |
attributes | string | Attributes associated with the action |
from | NvmAccount | Sender account. |
txParams? | TxParameters | Transaction parameters |
Returns
Promise\<boolean>
true if the call succeeded.
Remarks
This method can be called when want to track the derivation of a new DID from an existing DID.
Defined in
src/nevermined/api/ProvenanceApi.ts:87
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