DIDRegistry
@nevermined-io/sdk - v3.0.32 / DIDRegistry
Class: DIDRegistry
Hierarchy
↳
DIDRegistry
Table of contents
Constructors
Properties
Accessors
- artifactsFolder
- circuitsFolder
- client
- config
- instanceConfig
- instantiableConfig
- logger
- nevermined
- publicClient
- walletClient
Methods
- actedOnBehalf
- addDidProvenanceDelegate
- addProvider
- burn
- call
- enableAndMintDidNft
- enableAndMintDidNft721
- getAttributesByDid
- getAttributesByOwner
- getBlockNumberUpdated
- getDIDOwner
- getDIDProvenanceEvents
- getDIDProvenanceMethodEvents
- getDIDRegister
- getDIDRoyalties
- getFromAddress
- getNFTInfo
- getPermission
- getProvenanceEntry
- getProvenanceOwner
- getProviders
- getTransactionLogs
- grantPermission
- grantRegistryOperatorRole
- hashDID
- init
- isDIDProvider
- isProvenanceDelegate
- mint
- registerAttribute
- registerDID
- registerMintableDID
- registerMintableDID721
- removeDidProvenanceDelegate
- removeProvider
- revokePermission
- send
- sendFrom
- setDIDRoyalties
- setInstanceConfig
- someLog
- transferDIDOwnership
- updateMetadataUrl
- used
- wasAssociatedWith
- wasDerivedFrom
- getInstance
- setInstanceConfig
Constructors
constructor
• new DIDRegistry(contractName
): DIDRegistry
Parameters
Name | Type |
---|---|
contractName | string |
Returns
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:24
Properties
address
• address: `0x${string}`
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:22
contract
• contract: any
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:19
contractName
• Readonly
contractName: string
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:18
events
• events: ContractEvent
| SubgraphEvent
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:20
version
• version: string
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:21
Accessors
artifactsFolder
• get
artifactsFolder(): undefined
| string
Returns
undefined
| string
Inherited from
ContractBase.artifactsFolder
Defined in
src/Instantiable.abstract.ts:137
circuitsFolder
• get
circuitsFolder(): undefined
| string
Returns
undefined
| string
Inherited from
ContractBase.circuitsFolder
Defined in
src/Instantiable.abstract.ts:141
client
• get
client(): Web3Clients
Returns
Inherited from
ContractBase.client
Defined in
src/Instantiable.abstract.ts:89
config
• get
config(): NeverminedOptions
Returns
Inherited from
ContractBase.config
Defined in
src/Instantiable.abstract.ts:120
instanceConfig
• get
instanceConfig(): InstantiableConfig
Returns
Inherited from
ContractBase.instanceConfig
Defined in
src/Instantiable.abstract.ts:145
instantiableConfig
• get
instantiableConfig(): undefined
| InstantiableConfig
Returns
undefined
| InstantiableConfig
Inherited from
ContractBase.instantiableConfig
Defined in
src/Instantiable.abstract.ts:113
logger
• get
logger(): Logger
Returns
Logger
Inherited from
ContractBase.logger
Defined in
src/Instantiable.abstract.ts:128
nevermined
• get
nevermined(): Nevermined
Returns
Inherited from
ContractBase.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
ContractBase.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
ContractBase.walletClient
Defined in
src/Instantiable.abstract.ts:105
Methods
actedOnBehalf
▸ actedOnBehalf(provId
, did
, delegateAgentId
, responsibleAgentId
, activityId
, signatureDelegate
, attributes
, owner
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
provId | string |
did | string |
delegateAgentId | string |
responsibleAgentId | string |
activityId | string |
signatureDelegate | string |
attributes | string |
owner | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:552
addDidProvenanceDelegate
▸ addDidProvenanceDelegate(did
, delegateAddress
, owner
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
delegateAddress | string |
owner | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:579
addProvider
▸ addProvider(did
, provider
, from
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
provider | string |
from | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:623
burn
▸ burn(did
, amount
, from
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
amount | bigint |
from | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:619
call
▸ call\<T
>(functionName
, args
, from?
): Promise
\<T
>
Type parameters
Name |
---|
T |
Parameters
Name | Type |
---|---|
functionName | string |
args | any [] |
from? | string |
Returns
Promise
\<T
>
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:92
enableAndMintDidNft
▸ enableAndMintDidNft(did
, cap
, royalties
, preMint
, owner
, nftMetadata
, txParams?
): Promise
\<any
>
It activates a NFT associated to a NFT (ERC-1155) and allows to pre-mint. This method only can be called once per DID, so if this was called
or executed before internally the method will fail.
Only use if the intention is to register a mintable asset and it was registered via registerDID
or registerAttribute
Parameters
Name | Type | Description |
---|---|---|
did | string | The unique identifier of the asset |
cap | number | Max number of editions |
royalties | number | Asset royalties in the secondary market |
preMint | boolean | If true pre-mints the editions of NFT |
owner | NvmAccount | Account of the user registering the DID |
nftMetadata | string | URL to the metadata describing the NFT |
txParams? | TxParameters | Transaction additional parameters |
Returns
Promise
\<any
>
Contract Receipt
Defined in
src/keeper/contracts/DIDRegistry.ts:216
enableAndMintDidNft721
▸ enableAndMintDidNft721(did
, royalties
, preMint
, owner
, nftMetadata
, txParams?
): Promise
\<any
>
It activates a NFT associated to a NFT (ERC-721) and allows to pre-mint. This method only can be called once per DID, so if this was called
or executed before internally the method will fail.
Only use if the intention is to register a mintable asset and it was registered via registerDID
or registerAttribute
Parameters
Name | Type | Description |
---|---|---|
did | string | The unique identifier of the asset |
royalties | number | Asset royalties in the secondary market |
preMint | boolean | If true pre-mints the editions of NFT |
owner | NvmAccount | Account of the user registering the DID |
nftMetadata | string | URL to the metadata describing the NFT |
txParams? | TxParameters | Transaction additional parameters |
Returns
Promise
\<any
>
Contract Receipt
Defined in
src/keeper/contracts/DIDRegistry.ts:246
getAttributesByDid
▸ getAttributesByDid(did
): Promise
\<{ checksum
: string
; did
: string
; immutableUrl
: string
; nftInitialized
: boolean
; owner
: string
; providers
: string
[] ; royalties
: bigint
; serviceEndpoint
: string
}>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<{ checksum
: string
; did
: string
; immutableUrl
: string
; nftInitialized
: boolean
; owner
: string
; providers
: string
[] ; royalties
: bigint
; serviceEndpoint
: string
}>
Defined in
src/keeper/contracts/DIDRegistry.ts:300
getAttributesByOwner
▸ getAttributesByOwner(owner
): Promise
\<string
[]>
Parameters
Name | Type |
---|---|
owner | string |
Returns
Promise
\<string
[]>
Defined in
src/keeper/contracts/DIDRegistry.ts:275
getBlockNumberUpdated
▸ getBlockNumberUpdated(did
): Promise
\<number
>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<number
>
Defined in
src/keeper/contracts/DIDRegistry.ts:266
getDIDOwner
▸ getDIDOwner(did
): Promise
\<string
>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<string
>
Defined in
src/keeper/contracts/DIDRegistry.ts:262
getDIDProvenanceEvents
▸ getDIDProvenanceEvents(did
): Promise
\<{ activityId
: string
; agentId
: string
; agentInvolvedId
: string
; attributes?
: string
; blockNumberUpdated
: number
; did
: string
; id
: string
; method
: number
; provId
: string
; relatedDid
: string
}[]>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<{ activityId
: string
; agentId
: string
; agentInvolvedId
: string
; attributes?
: string
; blockNumberUpdated
: number
; did
: string
; id
: string
; method
: number
; provId
: string
; relatedDid
: string
}[]>
Defined in
src/keeper/contracts/DIDRegistry.ts:371
getDIDProvenanceMethodEvents
▸ getDIDProvenanceMethodEvents\<T
>(did
, method
): Promise
\<ProvenanceEvent
\<T
>[]>
Type parameters
Name | Type |
---|---|
T | extends ProvenanceMethod |
Parameters
Name | Type |
---|---|
did | string |
method | T |
Returns
Promise
\<ProvenanceEvent
\<T
>[]>
Defined in
src/keeper/contracts/DIDRegistry.ts:416
getDIDRegister
▸ getDIDRegister(did
): Promise
\<unknown
>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<unknown
>
Defined in
src/keeper/contracts/DIDRegistry.ts:636
getDIDRoyalties
▸ getDIDRoyalties(did
): Promise
\<unknown
>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<unknown
>
Defined in
src/keeper/contracts/DIDRegistry.ts:353
getFromAddress
▸ getFromAddress(from?
): Promise
\<string
>
Parameters
Name | Type |
---|---|
from? | string |
Returns
Promise
\<string
>
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:68
getNFTInfo
▸ getNFTInfo(did
): Promise
\<unknown
>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<unknown
>
Defined in
src/keeper/contracts/DIDRegistry.ts:640
getPermission
▸ getPermission(did
, grantee
): Promise
\<boolean
>
Parameters
Name | Type |
---|---|
did | string |
grantee | string |
Returns
Promise
\<boolean
>
Defined in
src/keeper/contracts/DIDRegistry.ts:357
getProvenanceEntry
▸ getProvenanceEntry(provId
): Promise
\<undefined
| { activityId
: any
; agentId
: any
; agentInvolvedId
: any
; blockNumberUpdated
: any
; createdBy
: any
; did
: any
; method
: ProvenanceMethod
; relatedDid
: any
; signatureDelegate
: any
}>
Parameters
Name | Type |
---|---|
provId | string |
Returns
Promise
\<undefined
| { activityId
: any
; agentId
: any
; agentInvolvedId
: any
; blockNumberUpdated
: any
; createdBy
: any
; did
: any
; method
: ProvenanceMethod
; relatedDid
: any
; signatureDelegate
: any
}>
Defined in
src/keeper/contracts/DIDRegistry.ts:465
getProvenanceOwner
▸ getProvenanceOwner(did
): Promise
\<unknown
>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<unknown
>
Defined in
src/keeper/contracts/DIDRegistry.ts:611
getProviders
▸ getProviders(did
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:631
getTransactionLogs
▸ getTransactionLogs(txReceipt
, eventName
): ParseEventLogsReturnType
\<any
, string
, false
, string
>
Parameters
Name | Type |
---|---|
txReceipt | TransactionReceipt |
eventName | string |
Returns
ParseEventLogsReturnType
\<any
, string
, false
, string
>
Inherited from
ContractBase.getTransactionLogs
Defined in
src/keeper/contracts/ContractBase.ts:76
grantPermission
▸ grantPermission(did
, grantee
, owner
, txParams?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
grantee | string |
owner | NvmAccount |
txParams? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:326
grantRegistryOperatorRole
▸ grantRegistryOperatorRole(manager
, from
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
manager | string |
from | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:648
hashDID
▸ hashDID(didSeed
, creator
): Promise
\<string
>
Parameters
Name | Type |
---|---|
didSeed | string |
creator | string |
Returns
Promise
\<string
>
Defined in
src/keeper/contracts/DIDRegistry.ts:644
init
▸ init(config
, optional?
, contractAddress?
): Promise
\<void
>
Parameters
Name | Type | Default value |
---|---|---|
config | InstantiableConfig | undefined |
optional | boolean | false |
contractAddress? | string | undefined |
Returns
Promise
\<void
>
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:29
isDIDProvider
▸ isDIDProvider(did
, provider
): Promise
\<string
>
Parameters
Name | Type |
---|---|
did | string |
provider | string |
Returns
Promise
\<string
>
Defined in
src/keeper/contracts/DIDRegistry.ts:271
isProvenanceDelegate
▸ isProvenanceDelegate(did
, delegateAddress
): Promise
\<unknown
>
Parameters
Name | Type |
---|---|
did | string |
delegateAddress | string |
Returns
Promise
\<unknown
>
Defined in
src/keeper/contracts/DIDRegistry.ts:607
mint
▸ mint(did
, amount
, from
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
amount | bigint |
from | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:615
registerAttribute
▸ registerAttribute(did
, checksum
, providers
, url
, owner
, txParams?
): Promise
\<any
>
It registers a decentralized identifier (aka DID) in the DIDRegistry
smart contract
Parameters
Name | Type | Description |
---|---|---|
did | string | The unique identifier of the asset |
checksum | string | Checksum resulted of hash the asset metadata |
providers | string [] | List of addresses in charge of interact with the asset |
url | string | URL to the metadata in the Metadata/Marketplace API |
owner | NvmAccount | Account of the user registering the DID |
txParams? | TxParameters | Transaction additional parameters |
Returns
Promise
\<any
>
Contract Receipt
Defined in
src/keeper/contracts/DIDRegistry.ts:38
registerDID
▸ registerDID(did
, checksum
, providers
, owner
, url
, immutableUrl?
, activityId?
, txParams?
): Promise
\<any
>
It registers a decentralized identifier (aka DID) in the DIDRegistry
smart contract
Parameters
Name | Type | Default value | Description |
---|---|---|---|
did | string | undefined | The unique identifier of the asset |
checksum | string | undefined | Checksum resulted of hash the asset metadata |
providers | string [] | undefined | List of addresses in charge of interact with the asset |
owner | NvmAccount | undefined | Account of the user registering the DID |
url | string | undefined | URL to the metadata in the Metadata/Marketplace API |
immutableUrl | string | '' | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc |
activityId | string | undefined | Provenance identifier about the asset registration action |
txParams? | TxParameters | undefined | Transaction additional parameters |
Returns
Promise
\<any
>
Contract Receipt
Defined in
src/keeper/contracts/DIDRegistry.ts:67
registerMintableDID
▸ registerMintableDID(did
, nftContractAddress
, checksum
, providers
, owner
, nftAttributes
, url
, immutableUrl?
, activityId?
, txParams?
): Promise
\<any
>
It registers a decentralized identifier (aka DID) in the DIDRegistry
smart contract with a ERC-1155 NFT attached to it
Parameters
Name | Type | Default value | Description |
---|---|---|---|
did | string | undefined | The unique identifier of the asset |
nftContractAddress | string | undefined | - |
checksum | string | undefined | Checksum resulted of hash the asset metadata |
providers | string [] | undefined | List of addresses in charge of interact with the asset |
owner | NvmAccount | undefined | Address of the user registering the DID |
nftAttributes | NFTAttributes | undefined | Attributes of the NFT associated to the NFT |
url | string | undefined | URL to the metadata in the Metadata/Marketplace API |
immutableUrl | string | '' | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc |
activityId | string | undefined | Provenance identifier about the asset registration action |
txParams? | TxParameters | undefined | Transaction additional parameters |
Returns
Promise
\<any
>
Contract Receipt
Defined in
src/keeper/contracts/DIDRegistry.ts:99
registerMintableDID721
▸ registerMintableDID721(did
, nftContractAddress
, checksum
, providers
, owner
, nftAttributes
, url
, immutableUrl?
, activityId?
, txParams?
): Promise
\<any
>
It registers a decentralized identifier (aka DID) in the DIDRegistry
smart contract with a ERC-721 NFT attached to it
Parameters
Name | Type | Default value | Description |
---|---|---|---|
did | string | undefined | The unique identifier of the asset |
nftContractAddress | string | undefined | - |
checksum | string | undefined | Checksum resulted of hash the asset metadata |
providers | string [] | undefined | List of addresses in charge of interact with the asset |
owner | NvmAccount | undefined | Account of the user registering the DID |
nftAttributes | NFTAttributes | undefined | Attributes of the NFT associated to the NFT |
url | string | undefined | URL to the metadata in the Metadata/Marketplace API |
immutableUrl | string | '' | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc |
activityId | string | undefined | Provenance identifier about the asset registration action |
txParams? | TxParameters | undefined | Transaction additional parameters |
Returns
Promise
\<any
>
Contract Receipt
Defined in
src/keeper/contracts/DIDRegistry.ts:145
removeDidProvenanceDelegate
▸ removeDidProvenanceDelegate(did
, delegateAddress
, owner
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
delegateAddress | string |
owner | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:593
removeProvider
▸ removeProvider(did
, provider
, from
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
provider | string |
from | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:627
revokePermission
▸ revokePermission(did
, grantee
, owner
, txParams?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
grantee | string |
owner | NvmAccount |
txParams? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:335
send
▸ send(functionName
, from
, args
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
functionName | string |
from | NvmAccount |
args | any [] |
params | TxParameters |
Returns
Promise
\<any
>
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:128
sendFrom
▸ sendFrom(functionName
, args
, from
, value?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
functionName | string |
args | any [] |
from | NvmAccount |
value? | TxParameters |
Returns
Promise
\<any
>
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:109
setDIDRoyalties
▸ setDIDRoyalties(did
, scheme
, owner
, txParams?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
scheme | string |
owner | NvmAccount |
txParams? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:344
setInstanceConfig
▸ setInstanceConfig(config
): void
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
void
Inherited from
ContractBase.setInstanceConfig
Defined in
src/Instantiable.abstract.ts:163
someLog
▸ someLog(logs
): undefined
Parameters
Name | Type |
---|---|
logs | any [] |
Returns
undefined
Inherited from
Defined in
src/keeper/contracts/ContractBase.ts:85
transferDIDOwnership
▸ transferDIDOwnership(did
, newOwnerAddress
, owner
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
did | string |
newOwnerAddress | string |
owner | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:361
updateMetadataUrl
▸ updateMetadataUrl(did
, checksum
, owner
, url
, immutableUrl?
, txParams?
): Promise
\<any
>
It registers a decentralized identifier (aka DID) in the DIDRegistry
smart contract with a ERC-721 NFT attached to it
Parameters
Name | Type | Default value | Description |
---|---|---|---|
did | string | undefined | The unique identifier of the asset |
checksum | string | undefined | Checksum resulted of hash the asset metadata |
owner | NvmAccount | undefined | Account of the user registering the DID |
url | string | undefined | URL to the metadata in the Metadata/Marketplace API |
immutableUrl | string | '' | Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc |
txParams? | TxParameters | undefined | Transaction additional parameters |
Returns
Promise
\<any
>
Contract Receipt
Defined in
src/keeper/contracts/DIDRegistry.ts:186
used
▸ used(provId
, did
, agentId
, activityId
, signatureUsing
, attributes
, owner
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
provId | string |
did | string |
agentId | string |
activityId | string |
signatureUsing | string |
attributes | string |
owner | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:485
wasAssociatedWith
▸ wasAssociatedWith(provId
, did
, agentId
, activityId
, attributes
, owner
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
provId | string |
did | string |
agentId | string |
activityId | string |
attributes | string |
owner | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:535
wasDerivedFrom
▸ wasDerivedFrom(provId
, newEntityDid
, usedEntityDid
, agentId
, activityId
, attributes
, owner
, params?
): Promise
\<any
>
Parameters
Name | Type |
---|---|
provId | string |
newEntityDid | string |
usedEntityDid | string |
agentId | string |
activityId | string |
attributes | string |
owner | NvmAccount |
params? | TxParameters |
Returns
Promise
\<any
>
Defined in
src/keeper/contracts/DIDRegistry.ts:510
getInstance
▸ getInstance(config
): Promise
\<DIDRegistry
>
Parameters
Name | Type |
---|---|
config | InstantiableConfig |
Returns
Promise
\<DIDRegistry
>
Overrides
Defined in
src/keeper/contracts/DIDRegistry.ts:21
setInstanceConfig
▸ setInstanceConfig\<T
>(instance
, instantiableConfig
): void
Type parameters
Name | Type |
---|---|
T | extends Instantiable |
Parameters
Name | Type |
---|---|
instance | T |
instantiableConfig | InstantiableConfig |
Returns
void
Inherited from
ContractBase.setInstanceConfig