Skip to main content

DIDRegistry

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

Class: DIDRegistry

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new DIDRegistry(contractName): DIDRegistry

Parameters

NameType
contractNamestring

Returns

DIDRegistry

Inherited from

ContractBase.constructor

Defined in

src/keeper/contracts/ContractBase.ts:24

Properties

address

address: `0x${string}`

Inherited from

ContractBase.address

Defined in

src/keeper/contracts/ContractBase.ts:22


contract

contract: any

Inherited from

ContractBase.contract

Defined in

src/keeper/contracts/ContractBase.ts:19


contractName

Readonly contractName: string

Inherited from

ContractBase.contractName

Defined in

src/keeper/contracts/ContractBase.ts:18


events

events: ContractEvent | SubgraphEvent

Inherited from

ContractBase.events

Defined in

src/keeper/contracts/ContractBase.ts:20


version

version: string

Inherited from

ContractBase.version

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

Web3Clients

Inherited from

ContractBase.client

Defined in

src/Instantiable.abstract.ts:89


config

get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

ContractBase.config

Defined in

src/Instantiable.abstract.ts:120


instanceConfig

get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

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

Nevermined

Inherited from

ContractBase.nevermined

Defined in

src/Instantiable.abstract.ts:81


publicClient

get publicClient(): Object

Returns

Object

NameTypeDescription
accountundefinedThe Account of the Client.
batch?{ multicall?: boolean | { batchSize?: number ; wait?: number } }Flags for batch settings.
batch.multicall?boolean | { batchSize?: number ; wait?: number }Toggle to enable eth_call multicall aggregation.
cacheTimenumberTime (in ms) that cached data will remain in memory.
call(parameters: CallParameters\<undefined | Chain>) => Promise\<CallReturnType>-
ccipRead?false | { request?: (parameters: CcipRequestParameters) => Promise\<`0x${string}`> }CCIP Read configuration.
chainundefined | ChainChain for the client.
createBlockFilter() => Promise\<{ id: `0x${string}` ; request: EIP1193RequestFn\<readonly [{ Method: "eth_getFilterChanges" ; Parameters: [filterId: `0x${string}`] ; ReturnType: `0x${string}`[] | RpcLog[] }, { Method: "eth_getFilterLogs" ; Parameters: [filterId: `0x${string}`] ; ReturnType: RpcLog[] }, { Method: "eth_uninstallFilter" ; Parameters: [filterId: `0x${string}`] ; ReturnType: boolean }]> ; type: "block" }>-
createContractEventFilter\<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>(args: CreateContractEventFilterParameters\<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>) => Promise\<CreateContractEventFilterReturnType\<TAbi, TEventName, TArgs, TStrict, TFromBlock, TToBlock>>-
createEventFilter\<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>(args?: CreateEventFilterParameters\<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock, _EventName, _Args>) => Promise\<{ [K in string | number | symbol]: Filter\<"event", TAbiEvents, _EventName, _Args, TStrict, TFromBlock, TToBlock>[K] }>-
createPendingTransactionFilter() => Promise\<{ id: `0x${string}` ; request: EIP1193RequestFn\<readonly [{ Method: "eth_getFilterChanges" ; Parameters: [filterId: `0x${string}`] ; ReturnType: `0x${string}`[] | RpcLog[] }, { Method: "eth_getFilterLogs" ; Parameters: [filterId: `0x${string}`] ; ReturnType: RpcLog[] }, { Method: "eth_uninstallFilter" ; Parameters: [filterId: `0x${string}`] ; ReturnType: boolean }]> ; type: "transaction" }>-
estimateContractGas\<TChain, abi, functionName, args>(args: EstimateContractGasParameters\<abi, functionName, args, TChain>) => Promise\<bigint>-
estimateFeesPerGas\<TChainOverride, TType>(args?: EstimateFeesPerGasParameters\<undefined | Chain, TChainOverride, TType>) => Promise\<EstimateFeesPerGasReturnType>-
estimateGas(args: EstimateGasParameters\<undefined | Chain>) => Promise\<bigint>-
estimateMaxPriorityFeePerGas\<TChainOverride>(args?: { chain: null | TChainOverride }) => Promise\<bigint>-
extend\<client>(fn: (client: Client\<Transport, undefined | Chain, undefined, PublicRpcSchema, PublicActions\<Transport, undefined | Chain>>) => client) => Client\<Transport, undefined | Chain, undefined, PublicRpcSchema, { [K in string | number | symbol]: client[K] } & PublicActions\<Transport, undefined | Chain>>-
getBalance(args: GetBalanceParameters) => Promise\<bigint>-
getBlobBaseFee() => Promise\<bigint>-
getBlock\<TIncludeTransactions, TBlockTag>(args?: GetBlockParameters\<TIncludeTransactions, TBlockTag>) => Promise\<{ baseFeePerGas: null | bigint ; blobGasUsed: bigint ; difficulty: bigint ; excessBlobGas: bigint ; extraData: `0x${string}` ; gasLimit: bigint ; gasUsed: bigint ; hash: TBlockTag extends "pending" ? null : `0x${string}` ; logsBloom: TBlockTag extends "pending" ? null : `0x${string}` ; miner: `0x${string}` ; mixHash: `0x${string}` ; nonce: TBlockTag extends "pending" ? null : `0x${string}` ; number: TBlockTag extends "pending" ? null : bigint ; parentHash: `0x${string}` ; receiptsRoot: `0x${string}` ; sealFields: `0x${string}`[] ; sha3Uncles: `0x${string}` ; size: bigint ; stateRoot: `0x${string}` ; timestamp: bigint ; totalDifficulty: null | bigint ; transactions: TIncludeTransactions extends true ? ({ accessList?: undefined ; blobVersionedHashes?: undefined ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId?: number ; from: `0x${string}` ; gas: bigint ; gasPrice: bigint ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas?: undefined ; maxFeePerGas?: undefined ; maxPriorityFeePerGas?: undefined ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "legacy" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity?: undefined } | { accessList: AccessList ; blobVersionedHashes?: undefined ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId: number ; from: `0x${string}` ; gas: bigint ; gasPrice: bigint ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas?: undefined ; maxFeePerGas?: undefined ; maxPriorityFeePerGas?: undefined ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "eip2930" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity: number } | { accessList: AccessList ; blobVersionedHashes?: undefined ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId: number ; from: `0x${string}` ; gas: bigint ; gasPrice?: undefined ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas?: undefined ; maxFeePerGas: bigint ; maxPriorityFeePerGas: bigint ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "eip1559" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity: number } | { accessList: AccessList ; blobVersionedHashes: `0x${string}`[] ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId: number ; from: `0x${string}` ; gas: bigint ; gasPrice?: undefined ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas: bigint ; maxFeePerGas: bigint ; maxPriorityFeePerGas: bigint ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "eip4844" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity: number })[] : `0x${string}`[] ; transactionsRoot: `0x${string}` ; uncles: `0x${string}`[] ; withdrawals?: Withdrawal[] ; withdrawalsRoot?: `0x${string}` }>-
getBlockNumber(args?: GetBlockNumberParameters) => Promise\<bigint>-
getBlockTransactionCount(args?: GetBlockTransactionCountParameters) => Promise\<number>-
getBytecode(args: GetBytecodeParameters) => Promise\<GetBytecodeReturnType>-
getChainId() => Promise\<number>-
getContractEvents\<abi, eventName, strict, fromBlock, toBlock>(args: GetContractEventsParameters\<abi, eventName, strict, fromBlock, toBlock>) => Promise\<GetContractEventsReturnType\<abi, eventName, strict, fromBlock, toBlock>>-
getEnsAddress(args: { blockNumber?: bigint ; blockTag?: BlockTag ; coinType?: number ; gatewayUrls?: string[] ; name: string ; strict?: boolean ; universalResolverAddress?: `0x${string}` }) => Promise\<GetEnsAddressReturnType>-
getEnsAvatar(args: { assetGatewayUrls?: AssetGatewayUrls ; blockNumber?: bigint ; blockTag?: BlockTag ; gatewayUrls?: string[] ; name: string ; strict?: boolean ; universalResolverAddress?: `0x${string}` }) => Promise\<GetEnsAvatarReturnType>-
getEnsName(args: { address: `0x${string}` ; blockNumber?: bigint ; blockTag?: BlockTag ; gatewayUrls?: string[] ; strict?: boolean ; universalResolverAddress?: `0x${string}` }) => Promise\<GetEnsNameReturnType>-
getEnsResolver(args: { blockNumber?: bigint ; blockTag?: BlockTag ; name: string ; universalResolverAddress?: `0x${string}` }) => Promise\<`0x${string}`>-
getEnsText(args: { blockNumber?: bigint ; blockTag?: BlockTag ; gatewayUrls?: string[] ; key: string ; name: string ; strict?: boolean ; universalResolverAddress?: `0x${string}` }) => Promise\<GetEnsTextReturnType>-
getFeeHistory(args: GetFeeHistoryParameters) => Promise\<GetFeeHistoryReturnType>-
getFilterChanges\<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args: GetFilterChangesParameters\<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>) => Promise\<GetFilterChangesReturnType\<TFilterType, TAbi, TEventName, TStrict, TFromBlock, TToBlock>>-
getFilterLogs\<TAbi, TEventName, TStrict, TFromBlock, TToBlock>(args: GetFilterLogsParameters\<TAbi, TEventName, TStrict, TFromBlock, TToBlock>) => Promise\<GetFilterLogsReturnType\<TAbi, TEventName, TStrict, TFromBlock, TToBlock>>-
getGasPrice() => Promise\<bigint>-
getLogs\<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>(args?: GetLogsParameters\<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>) => Promise\<GetLogsReturnType\<TAbiEvent, TAbiEvents, TStrict, TFromBlock, TToBlock>>-
getProof(args: GetProofParameters) => Promise\<GetProofReturnType>-
getStorageAt(args: GetStorageAtParameters) => Promise\<GetStorageAtReturnType>-
getTransaction\<TBlockTag>(args: GetTransactionParameters\<TBlockTag>) => Promise\<{ accessList?: undefined ; blobVersionedHashes?: undefined ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId?: number ; from: `0x${string}` ; gas: bigint ; gasPrice: bigint ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas?: undefined ; maxFeePerGas?: undefined ; maxPriorityFeePerGas?: undefined ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "legacy" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity?: undefined } | { accessList: AccessList ; blobVersionedHashes?: undefined ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId: number ; from: `0x${string}` ; gas: bigint ; gasPrice: bigint ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas?: undefined ; maxFeePerGas?: undefined ; maxPriorityFeePerGas?: undefined ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "eip2930" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity: number } | { accessList: AccessList ; blobVersionedHashes?: undefined ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId: number ; from: `0x${string}` ; gas: bigint ; gasPrice?: undefined ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas?: undefined ; maxFeePerGas: bigint ; maxPriorityFeePerGas: bigint ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "eip1559" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity: number } | { accessList: AccessList ; blobVersionedHashes: `0x${string}`[] ; blockHash: TBlockTag extends "pending" ? true : false extends true ? null : `0x${string}` ; blockNumber: TBlockTag extends "pending" ? true : false extends true ? null : bigint ; chainId: number ; from: `0x${string}` ; gas: bigint ; gasPrice?: undefined ; hash: `0x${string}` ; input: `0x${string}` ; maxFeePerBlobGas: bigint ; maxFeePerGas: bigint ; maxPriorityFeePerGas: bigint ; nonce: number ; r: `0x${string}` ; s: `0x${string}` ; to: null | `0x${string}` ; transactionIndex: TBlockTag extends "pending" ? true : false extends true ? null : number ; type: "eip4844" ; typeHex: null | `0x${string}` ; v: bigint ; value: bigint ; yParity: number }>-
getTransactionConfirmations(args: GetTransactionConfirmationsParameters\<undefined | Chain>) => Promise\<bigint>-
getTransactionCount(args: GetTransactionCountParameters) => Promise\<number>-
getTransactionReceipt(args: GetTransactionReceiptParameters) => Promise\<TransactionReceipt>-
keystringA key for the client.
multicall\<contracts, allowFailure>(args: MulticallParameters\<contracts, allowFailure>) => Promise\<MulticallReturnType\<contracts, allowFailure>>-
namestringA name for the client.
pollingIntervalnumberFrequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.
prepareTransactionRequest\<TRequest, TChainOverride, TAccountOverride>(args: PrepareTransactionRequestParameters\<undefined | Chain, undefined | Account, TChainOverride, TAccountOverride, TRequest>) => Promise\<{ [K in string | number | symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" | "gas" | "nonce" | "blobVersionedHashes" | "chainId" | "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[K] }>-
readContract\<abi, functionName, args>(args: ReadContractParameters\<abi, functionName, args>) => Promise\<ReadContractReturnType\<abi, functionName, args>>-
requestEIP1193RequestFn\<PublicRpcSchema>Request function wrapped with friendly error handling
sendRawTransaction(args: SendRawTransactionParameters) => Promise\<`0x${string}`>-
simulateContract\<abi, functionName, args, chainOverride, accountOverride>(args: SimulateContractParameters\<abi, functionName, args, undefined | Chain, chainOverride, accountOverride>) => Promise\<SimulateContractReturnType\<abi, functionName, args, undefined | Chain, undefined | Account, chainOverride, accountOverride>>-
transportTransportConfig\<string, EIP1193RequestFn> & Record\<string, any>The RPC transport
typestringThe type of client.
uidstringA unique ID for the client.
uninstallFilter(args: UninstallFilterParameters) => Promise\<boolean>-
verifyMessage(args: VerifyMessageParameters) => Promise\<boolean>-
verifyTypedData(args: VerifyTypedDataParameters) => Promise\<boolean>-
waitForTransactionReceipt(args: WaitForTransactionReceiptParameters\<undefined | Chain>) => Promise\<TransactionReceipt>-
watchBlockNumber(args: WatchBlockNumberParameters) => WatchBlockNumberReturnType-
watchBlocks\<TIncludeTransactions, TBlockTag>(args: WatchBlocksParameters\<Transport, undefined | Chain, TIncludeTransactions, TBlockTag>) => WatchBlocksReturnType-
watchContractEvent\<TAbi, TEventName, TStrict>(args: WatchContractEventParameters\<TAbi, TEventName, TStrict, Transport>) => WatchContractEventReturnType-
watchEvent\<TAbiEvent, TAbiEvents, TStrict>(args: WatchEventParameters\<TAbiEvent, TAbiEvents, TStrict, Transport>) => WatchEventReturnType-
watchPendingTransactions(args: WatchPendingTransactionsParameters\<Transport>) => WatchPendingTransactionsReturnType-

Inherited from

ContractBase.publicClient

Defined in

src/Instantiable.abstract.ts:97


walletClient

get walletClient(): Object

Returns

Object

NameTypeDescription
accountundefined | AccountThe Account of the Client.
addChain(args: AddChainParameters) => Promise\<void>-
batch?{ multicall?: boolean | { batchSize?: number ; wait?: number } }Flags for batch settings.
batch.multicall?boolean | { batchSize?: number ; wait?: number }Toggle to enable eth_call multicall aggregation.
cacheTimenumberTime (in ms) that cached data will remain in memory.
ccipRead?false | { request?: (parameters: CcipRequestParameters) => Promise\<`0x${string}`> }CCIP Read configuration.
chainundefined | ChainChain for the client.
deployContract\<abi, chainOverride>(args: DeployContractParameters\<abi, undefined | Chain, undefined | Account, chainOverride>) => Promise\<`0x${string}`>-
extend\<client>(fn: (client: Client\<Transport, undefined | Chain, undefined | Account, WalletRpcSchema, WalletActions\<undefined | Chain, undefined | Account>>) => client) => Client\<Transport, undefined | Chain, undefined | Account, WalletRpcSchema, { [K in string | number | symbol]: client[K] } & WalletActions\<undefined | Chain, undefined | Account>>-
getAddresses() => Promise\<GetAddressesReturnType>-
getChainId() => Promise\<number>-
getPermissions() => Promise\<GetPermissionsReturnType>-
keystringA key for the client.
namestringA name for the client.
pollingIntervalnumberFrequency (in ms) for polling enabled actions & events. Defaults to 4_000 milliseconds.
prepareTransactionRequest\<TRequest, TChainOverride, TAccountOverride>(args: PrepareTransactionRequestParameters\<undefined | Chain, undefined | Account, TChainOverride, TAccountOverride, TRequest>) => Promise\<{ [K in string | number | symbol]: (UnionRequiredBy\<Extract\<UnionOmit\<(...), (...)> & ((...) extends (...) ? (...) : (...)) & ((...) extends (...) ? (...) : (...)), IsNever\<(...)> extends true ? unknown : ExactPartial\<(...)>> & Object, ParameterTypeToParameters\<TRequest["parameters"] extends readonly PrepareTransactionRequestParameterType[] ? any[any][number] : "type" | "gas" | "nonce" | "blobVersionedHashes" | "chainId" | "fees">> & (unknown extends TRequest["kzg"] ? Object : Pick\<TRequest, "kzg">))[K] }>-
requestEIP1193RequestFn\<WalletRpcSchema>Request function wrapped with friendly error handling
requestAddresses() => Promise\<RequestAddressesReturnType>-
requestPermissions(args: { eth_accounts: Record\<string, any> }) => Promise\<RequestPermissionsReturnType>-
sendRawTransaction(args: SendRawTransactionParameters) => Promise\<`0x${string}`>-
sendTransaction\<TRequest, TChainOverride>(args: SendTransactionParameters\<undefined | Chain, undefined | Account, TChainOverride, TRequest>) => Promise\<`0x${string}`>-
signMessage(args: SignMessageParameters\<undefined | Account>) => Promise\<`0x${string}`>-
signTransaction\<TChainOverride>(args: SignTransactionParameters\<undefined | Chain, undefined | Account, TChainOverride>) => Promise\<`0x02${string}` | `0x01${string}` | `0x03${string}` | TransactionSerializedLegacy>-
signTypedData\<TTypedData, TPrimaryType>(args: SignTypedDataParameters\<TTypedData, TPrimaryType, undefined | Account>) => Promise\<`0x${string}`>-
switchChain(args: SwitchChainParameters) => Promise\<void>-
transportTransportConfig\<string, EIP1193RequestFn> & Record\<string, any>The RPC transport
typestringThe type of client.
uidstringA unique ID for the client.
watchAsset(args: WatchAssetParams) => Promise\<boolean>-
writeContract\<abi, functionName, args, TChainOverride>(args: WriteContractParameters\<abi, functionName, args, undefined | Chain, undefined | Account, TChainOverride>) => Promise\<`0x${string}`>-

Inherited from

ContractBase.walletClient

Defined in

src/Instantiable.abstract.ts:105

Methods

actedOnBehalf

actedOnBehalf(provId, did, delegateAgentId, responsibleAgentId, activityId, signatureDelegate, attributes, owner, params?): Promise\<any>

Parameters

NameType
provIdstring
didstring
delegateAgentIdstring
responsibleAgentIdstring
activityIdstring
signatureDelegatestring
attributesstring
ownerNvmAccount
params?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:552


addDidProvenanceDelegate

addDidProvenanceDelegate(did, delegateAddress, owner, params?): Promise\<any>

Parameters

NameType
didstring
delegateAddressstring
ownerNvmAccount
params?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:579


addProvider

addProvider(did, provider, from, params?): Promise\<any>

Parameters

NameType
didstring
providerstring
fromNvmAccount
params?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:623


burn

burn(did, amount, from, params?): Promise\<any>

Parameters

NameType
didstring
amountbigint
fromNvmAccount
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

NameType
functionNamestring
argsany[]
from?string

Returns

Promise\<T>

Inherited from

ContractBase.call

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

NameTypeDescription
didstringThe unique identifier of the asset
capnumberMax number of editions
royaltiesnumberAsset royalties in the secondary market
preMintbooleanIf true pre-mints the editions of NFT
ownerNvmAccountAccount of the user registering the DID
nftMetadatastringURL to the metadata describing the NFT
txParams?TxParametersTransaction 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

NameTypeDescription
didstringThe unique identifier of the asset
royaltiesnumberAsset royalties in the secondary market
preMintbooleanIf true pre-mints the editions of NFT
ownerNvmAccountAccount of the user registering the DID
nftMetadatastringURL to the metadata describing the NFT
txParams?TxParametersTransaction 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

NameType
didstring

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

NameType
ownerstring

Returns

Promise\<string[]>

Defined in

src/keeper/contracts/DIDRegistry.ts:275


getBlockNumberUpdated

getBlockNumberUpdated(did): Promise\<number>

Parameters

NameType
didstring

Returns

Promise\<number>

Defined in

src/keeper/contracts/DIDRegistry.ts:266


getDIDOwner

getDIDOwner(did): Promise\<string>

Parameters

NameType
didstring

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

NameType
didstring

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

NameType
Textends ProvenanceMethod

Parameters

NameType
didstring
methodT

Returns

Promise\<ProvenanceEvent\<T>[]>

Defined in

src/keeper/contracts/DIDRegistry.ts:416


getDIDRegister

getDIDRegister(did): Promise\<unknown>

Parameters

NameType
didstring

Returns

Promise\<unknown>

Defined in

src/keeper/contracts/DIDRegistry.ts:636


getDIDRoyalties

getDIDRoyalties(did): Promise\<unknown>

Parameters

NameType
didstring

Returns

Promise\<unknown>

Defined in

src/keeper/contracts/DIDRegistry.ts:353


getFromAddress

getFromAddress(from?): Promise\<string>

Parameters

NameType
from?string

Returns

Promise\<string>

Inherited from

ContractBase.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:68


getNFTInfo

getNFTInfo(did): Promise\<unknown>

Parameters

NameType
didstring

Returns

Promise\<unknown>

Defined in

src/keeper/contracts/DIDRegistry.ts:640


getPermission

getPermission(did, grantee): Promise\<boolean>

Parameters

NameType
didstring
granteestring

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

NameType
provIdstring

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

NameType
didstring

Returns

Promise\<unknown>

Defined in

src/keeper/contracts/DIDRegistry.ts:611


getProviders

getProviders(did): Promise\<any>

Parameters

NameType
didstring

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:631


getTransactionLogs

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

Parameters

NameType
txReceiptTransactionReceipt
eventNamestring

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

NameType
didstring
granteestring
ownerNvmAccount
txParams?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:326


grantRegistryOperatorRole

grantRegistryOperatorRole(manager, from, params?): Promise\<any>

Parameters

NameType
managerstring
fromNvmAccount
params?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:648


hashDID

hashDID(didSeed, creator): Promise\<string>

Parameters

NameType
didSeedstring
creatorstring

Returns

Promise\<string>

Defined in

src/keeper/contracts/DIDRegistry.ts:644


init

init(config, optional?, contractAddress?): Promise\<void>

Parameters

NameTypeDefault value
configInstantiableConfigundefined
optionalbooleanfalse
contractAddress?stringundefined

Returns

Promise\<void>

Inherited from

ContractBase.init

Defined in

src/keeper/contracts/ContractBase.ts:29


isDIDProvider

isDIDProvider(did, provider): Promise\<string>

Parameters

NameType
didstring
providerstring

Returns

Promise\<string>

Defined in

src/keeper/contracts/DIDRegistry.ts:271


isProvenanceDelegate

isProvenanceDelegate(did, delegateAddress): Promise\<unknown>

Parameters

NameType
didstring
delegateAddressstring

Returns

Promise\<unknown>

Defined in

src/keeper/contracts/DIDRegistry.ts:607


mint

mint(did, amount, from, params?): Promise\<any>

Parameters

NameType
didstring
amountbigint
fromNvmAccount
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

NameTypeDescription
didstringThe unique identifier of the asset
checksumstringChecksum resulted of hash the asset metadata
providersstring[]List of addresses in charge of interact with the asset
urlstringURL to the metadata in the Metadata/Marketplace API
ownerNvmAccountAccount of the user registering the DID
txParams?TxParametersTransaction 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

NameTypeDefault valueDescription
didstringundefinedThe unique identifier of the asset
checksumstringundefinedChecksum resulted of hash the asset metadata
providersstring[]undefinedList of addresses in charge of interact with the asset
ownerNvmAccountundefinedAccount of the user registering the DID
urlstringundefinedURL to the metadata in the Metadata/Marketplace API
immutableUrlstring''Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc
activityIdstringundefinedProvenance identifier about the asset registration action
txParams?TxParametersundefinedTransaction 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

NameTypeDefault valueDescription
didstringundefinedThe unique identifier of the asset
nftContractAddressstringundefined-
checksumstringundefinedChecksum resulted of hash the asset metadata
providersstring[]undefinedList of addresses in charge of interact with the asset
ownerNvmAccountundefinedAddress of the user registering the DID
nftAttributesNFTAttributesundefinedAttributes of the NFT associated to the NFT
urlstringundefinedURL to the metadata in the Metadata/Marketplace API
immutableUrlstring''Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc
activityIdstringundefinedProvenance identifier about the asset registration action
txParams?TxParametersundefinedTransaction 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

NameTypeDefault valueDescription
didstringundefinedThe unique identifier of the asset
nftContractAddressstringundefined-
checksumstringundefinedChecksum resulted of hash the asset metadata
providersstring[]undefinedList of addresses in charge of interact with the asset
ownerNvmAccountundefinedAccount of the user registering the DID
nftAttributesNFTAttributesundefinedAttributes of the NFT associated to the NFT
urlstringundefinedURL to the metadata in the Metadata/Marketplace API
immutableUrlstring''Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc
activityIdstringundefinedProvenance identifier about the asset registration action
txParams?TxParametersundefinedTransaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/DIDRegistry.ts:145


removeDidProvenanceDelegate

removeDidProvenanceDelegate(did, delegateAddress, owner, params?): Promise\<any>

Parameters

NameType
didstring
delegateAddressstring
ownerNvmAccount
params?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:593


removeProvider

removeProvider(did, provider, from, params?): Promise\<any>

Parameters

NameType
didstring
providerstring
fromNvmAccount
params?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:627


revokePermission

revokePermission(did, grantee, owner, txParams?): Promise\<any>

Parameters

NameType
didstring
granteestring
ownerNvmAccount
txParams?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:335


send

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

Parameters

NameType
functionNamestring
fromNvmAccount
argsany[]
paramsTxParameters

Returns

Promise\<any>

Inherited from

ContractBase.send

Defined in

src/keeper/contracts/ContractBase.ts:128


sendFrom

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

Parameters

NameType
functionNamestring
argsany[]
fromNvmAccount
value?TxParameters

Returns

Promise\<any>

Inherited from

ContractBase.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:109


setDIDRoyalties

setDIDRoyalties(did, scheme, owner, txParams?): Promise\<any>

Parameters

NameType
didstring
schemestring
ownerNvmAccount
txParams?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:344


setInstanceConfig

setInstanceConfig(config): void

Parameters

NameType
configInstantiableConfig

Returns

void

Inherited from

ContractBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:163


someLog

someLog(logs): undefined

Parameters

NameType
logsany[]

Returns

undefined

Inherited from

ContractBase.someLog

Defined in

src/keeper/contracts/ContractBase.ts:85


transferDIDOwnership

transferDIDOwnership(did, newOwnerAddress, owner, params?): Promise\<any>

Parameters

NameType
didstring
newOwnerAddressstring
ownerNvmAccount
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

NameTypeDefault valueDescription
didstringundefinedThe unique identifier of the asset
checksumstringundefinedChecksum resulted of hash the asset metadata
ownerNvmAccountundefinedAccount of the user registering the DID
urlstringundefinedURL to the metadata in the Metadata/Marketplace API
immutableUrlstring''Hash or URL to the metadata stored in a immutable data store like IPFS, Filecoin, etc
txParams?TxParametersundefinedTransaction 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

NameType
provIdstring
didstring
agentIdstring
activityIdstring
signatureUsingstring
attributesstring
ownerNvmAccount
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

NameType
provIdstring
didstring
agentIdstring
activityIdstring
attributesstring
ownerNvmAccount
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

NameType
provIdstring
newEntityDidstring
usedEntityDidstring
agentIdstring
activityIdstring
attributesstring
ownerNvmAccount
params?TxParameters

Returns

Promise\<any>

Defined in

src/keeper/contracts/DIDRegistry.ts:510


getInstance

getInstance(config): Promise\<DIDRegistry>

Parameters

NameType
configInstantiableConfig

Returns

Promise\<DIDRegistry>

Overrides

ContractBase.getInstance

Defined in

src/keeper/contracts/DIDRegistry.ts:21


setInstanceConfig

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

Type parameters

NameType
Textends Instantiable

Parameters

NameType
instanceT
instantiableConfigInstantiableConfig

Returns

void

Inherited from

ContractBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:154