Nft1155Contract

@nevermined-io/sdk - v3.0.44 / Nft1155Contract

Class: Nft1155Contract

NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs

Hierarchy

NFTContractsBase
↳ Nft1155Contract

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

• new Nft1155Contract(contractName): Nft1155Contract

Parameters

Name	Type
`contractName`	`string`

Properties

address

• address: `0x${string}`

Inherited from

NFTContractsBase.address

Defined in

src/keeper/contracts/ContractBase.ts:22

contract

• contract: any

Inherited from

NFTContractsBase.contract

Defined in

src/keeper/contracts/ContractBase.ts:19

contractName

• Readonly contractName: string

Inherited from

NFTContractsBase.contractName

Defined in

src/keeper/contracts/ContractBase.ts:18

events

• events: ContractEvent | SubgraphEvent

Inherited from

NFTContractsBase.events

Defined in

src/keeper/contracts/ContractBase.ts:20

version

• version: string

Inherited from

NFTContractsBase.version

Defined in

src/keeper/contracts/ContractBase.ts:21

Accessors

artifactsFolder

• get artifactsFolder(): undefined | string

Returns

undefined | string

Inherited from

NFTContractsBase.artifactsFolder

Defined in

src/Instantiable.abstract.ts:137

circuitsFolder

• get circuitsFolder(): undefined | string

Returns

undefined | string

Inherited from

NFTContractsBase.circuitsFolder

Defined in

src/Instantiable.abstract.ts:141

client

• get client(): Web3Clients

Returns

Web3Clients

Inherited from

NFTContractsBase.client

Defined in

src/Instantiable.abstract.ts:89

config

• get config(): NeverminedOptions

Returns

NeverminedOptions

Inherited from

NFTContractsBase.config

Defined in

src/Instantiable.abstract.ts:120

instanceConfig

• get instanceConfig(): InstantiableConfig

Returns

InstantiableConfig

Inherited from

NFTContractsBase.instanceConfig

Defined in

src/Instantiable.abstract.ts:145

instantiableConfig

• get instantiableConfig(): undefined | InstantiableConfig

Returns

undefined | InstantiableConfig

Inherited from

NFTContractsBase.instantiableConfig

Defined in

src/Instantiable.abstract.ts:113

logger

• get logger(): Logger

Returns

Logger

Inherited from

NFTContractsBase.logger

Defined in

src/Instantiable.abstract.ts:128

nevermined

• get nevermined(): Nevermined

Returns

Nevermined

Inherited from

NFTContractsBase.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

NFTContractsBase.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

NFTContractsBase.walletClient

Defined in

src/Instantiable.abstract.ts:105

Methods

_createClone

▸ _createClone(ercType, name, symbol, uri, cap, operators?, from, txParams?): Promise\<any>

Creates a contract clone of an existing contract instance

Parameters

Name	Type	Default value	Description
`ercType`	`721` \| `1155`	`undefined`	-
`name`	`string`	`undefined`	NFT Contract name
`symbol`	`string`	`undefined`	NFT Contract symbol
`uri`	`string`	`undefined`	NFT Contract metadata uri
`cap`	`undefined` \| `bigint`	`undefined`	NFT cap (just for ERC-721)
`operators`	`string`[]	`[]`	Array of account addresses to be added as NFT operators
`from`	`NvmAccount`	`undefined`	Sender account
`txParams?`	`TxParameters`	`undefined`	-

Returns

Promise\<any>

Contract Receipt

Inherited from

NFTContractsBase._createClone

Defined in

src/keeper/contracts/NFTContractsBase.ts:41

balance

▸ balance(address, did): Promise\<bigint>

Get an address balance for a specific NFT with id did

Parameters

Name	Type	Description
`address`	`string`	Account address to check the balance
`did`	`string`	The NFT id

Returns

Promise\<bigint>

Defined in

src/keeper/contracts/Nft1155Contract.ts:122

burn

▸ burn(from, tokenId, amount, txParams?): Promise\<any>

It burns some editions of a NFT (ERC-1155)

Parameters

Name	Type	Description
`from`	`NvmAccount`	Account burning the NFT editions
`tokenId`	`string`	The NFT id to burn
`amount`	`bigint`	Number of editions to burn
`txParams?`	`TxParameters`	Transaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:178

burnBatchFromHolders

▸ burnBatchFromHolders(holders, tokenIds, amounts, from, txParams?): Promise\<any>

It burns some editions of a NFT (ERC-1155)

Parameters

Name	Type	Description
`holders`	`string`[]	Array of addresses of the accounts holding the NFT editions that are going to be burned
`tokenIds`	`string`[]	Array of the NFT ids to burn
`amounts`	`bigint`[]	Array of number of editions to burn
`from`	`NvmAccount`	Account burning the NFT editions
`txParams?`	`TxParameters`	Transaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:217

burnFromHolder

▸ burnFromHolder(holder, tokenId, amount, from, txParams?): Promise\<any>

It burns some editions of a NFT (ERC-1155)

Parameters

Name	Type	Description
`holder`	`string`	Address of the account holding the NFT editions that are going to be burned
`tokenId`	`string`	The NFT id to burn
`amount`	`bigint`	Number of editions to burn
`from`	`NvmAccount`	Account burning the NFT editions
`txParams?`	`TxParameters`	Transaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:197

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

NFTContractsBase.call

Defined in

src/keeper/contracts/ContractBase.ts:92

createClone

▸ createClone(name, symbol, uri, operators?, from, txParams?): Promise\<any>

Creates a contract clone of an existing contract instance

Parameters

Name	Type	Default value	Description
`name`	`string`	`undefined`	NFT Contract name
`symbol`	`string`	`undefined`	NFT Contract symbol
`uri`	`string`	`undefined`	NFT Contract metadata uri
`operators`	`string`[]	`[]`	Array of account addresses to be added as NFT operators
`from`	`NvmAccount`	`undefined`	Sender account
`txParams?`	`TxParameters`	`undefined`	-

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:75

getFromAddress

▸ getFromAddress(from?): Promise\<string>

Parameters

Name	Type
`from?`	`string`

Returns

Promise\<string>

Inherited from

NFTContractsBase.getFromAddress

Defined in

src/keeper/contracts/ContractBase.ts:68

getMintedEntries

▸ getMintedEntries(owner, did?): Promise\<NFT1155MintedEntry[]>

It gets all the NFT1155MintedEntry events from the NFT Contract

Parameters

Name	Type	Description
`owner`	`string`	the user owning the NFT
`did?`	`string`	the tokenId of the NFT

Returns

Promise\<NFT1155MintedEntry[]>

An array of NFT1155MintedEntry objects

Defined in

src/keeper/contracts/Nft1155Contract.ts:245

getNFTAttributes

▸ getNFTAttributes(did): Promise\<{ mintCap: bigint ; nftInitialized: boolean ; nftSupply: bigint ; nftURI: string }>

Parameters

Name	Type
`did`	`string`

Returns

Promise\<{ mintCap: bigint ; nftInitialized: boolean ; nftSupply: bigint ; nftURI: string }>

Inherited from

NFTContractsBase.getNFTAttributes

Defined in

src/keeper/contracts/NFTContractsBase.ts:97

getTransactionLogs

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

Parameters

Name	Type
`txReceipt`	`TransactionReceipt`
`eventName`	`string`

Returns

ParseEventLogsReturnType\<any, string, false, string>

Inherited from

NFTContractsBase.getTransactionLogs

Defined in

src/keeper/contracts/ContractBase.ts:76

grantOperatorRole

▸ grantOperatorRole(operatorAddress, from, txParams?): Promise\<any>

Add an address as operator in the NFT Contract

Parameters

Name	Type	Description
`operatorAddress`	`string`	New minter address
`from`	`NvmAccount`	Sender account
`txParams?`	`TxParameters`	-

Returns

Promise\<any>

Contract Receipt

Inherited from

NFTContractsBase.grantOperatorRole

Defined in

src/keeper/contracts/NFTContractsBase.ts:84

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

NFTContractsBase.init

Defined in

src/keeper/contracts/ContractBase.ts:29

isApprovedForAll

▸ isApprovedForAll(accountAddress, operatorAddress): Promise\<unknown>

Checks if the operator is approved for an account address

Parameters

Name	Type	Description
`accountAddress`	`string`	Account address
`operatorAddress`	`string`	Operator address

Returns

Promise\<unknown>

Boolean

Defined in

src/keeper/contracts/Nft1155Contract.ts:93

isOperator

▸ isOperator(address): Promise\<boolean>

Checks if an account is an operator in the NFT contract

Parameters

Name	Type	Description
`address`	`string`	Account address to check if is an operator

Returns

Promise\<boolean>

true if is an operator

Inherited from

NFTContractsBase.isOperator

Defined in

src/keeper/contracts/NFTContractsBase.ts:93

mint

▸ mint(to, did, amount, from, data?, txParams?): Promise\<any>

It mints some editions of a NFT (ERC-1155)

Parameters

Name	Type	Description
`to`	`string`	Account address of the NFT receiver
`did`	`string`	The NFT id to mint
`amount`	`bigint`	Number of editions to mint
`from`	`NvmAccount`	Account minting the NFT
`data?`	`string`	Data
`txParams?`	`TxParameters`	Transaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:157

owner

▸ owner(): Promise\<string>

Gets the contract owner

Returns

Promise\<string>

Address of the contract owner

Inherited from

NFTContractsBase.owner

Defined in

src/keeper/contracts/NFTContractsBase.ts:26

revokeOperatorRole

▸ revokeOperatorRole(operatorAddress, from, txParams?): Promise\<any>

Revoke an address as operator in the NFT Contract

Parameters

Name	Type	Description
`operatorAddress`	`string`	Minter address to revoke
`from`	`NvmAccount`	Sender account
`txParams?`	`TxParameters`	-

Returns

Promise\<any>

Contract Receipt

Inherited from

NFTContractsBase.revokeOperatorRole

Defined in

src/keeper/contracts/NFTContractsBase.ts:130

send

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

Parameters

Name	Type
`functionName`	`string`
`from`	`NvmAccount`
`args`	`any`[]
`params`	`TxParameters`

Returns

Promise\<any>

Inherited from

NFTContractsBase.send

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

NFTContractsBase.sendFrom

Defined in

src/keeper/contracts/ContractBase.ts:109

setApprovalForAll

▸ setApprovalForAll(operatorAddress, approved, from, txParams?): Promise\<any>

Configure approval for a specific operator address

Parameters

Name	Type	Description
`operatorAddress`	`string`	Operator address
`approved`	`boolean`	Is approved
`from`	`NvmAccount`	Sender account
`txParams?`	`TxParameters`	Transaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:106

setInstanceConfig

▸ setInstanceConfig(config): void

Parameters

Name	Type
`config`	`InstantiableConfig`

Returns

void

Inherited from

NFTContractsBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:163

someLog

▸ someLog(logs): undefined

Parameters

Name	Type
`logs`	`any`[]

Returns

undefined

Inherited from

NFTContractsBase.someLog

Defined in

src/keeper/contracts/ContractBase.ts:85

transferNft

▸ transferNft(did, to, amount, from, txParams?): Promise\<any>

It transfers a NFT

Parameters

Name	Type	Description
`did`	`string`	The NFT id
`to`	`string`	Account address of the NFT receiver
`amount`	`bigint`	Number of editions to transfer. Typically just 1
`from`	`NvmAccount`	Account transferring the NFT
`txParams?`	`TxParameters`	Transaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:136

uri

▸ uri(did): Promise\<string>

It returns the NFT metadata uri

Parameters

Name	Type	Description
`did`	`string`	The NFT id

Returns

Promise\<string>

The NFT metadata url

Defined in

src/keeper/contracts/Nft1155Contract.ts:235

getInstance

▸ getInstance(config, address?, contractName?, artifactsFolder?): Promise\<Nft1155Contract>

Parameters

Name	Type	Default value
`config`	`InstantiableConfig`	`undefined`
`address?`	`string`	`undefined`
`contractName`	`string`	`'NFT1155Upgradeable'`
`artifactsFolder`	`undefined` \| `string`	`config.artifactsFolder`

Returns

Promise\<Nft1155Contract>

Overrides

NFTContractsBase.getInstance

Defined in

src/keeper/contracts/Nft1155Contract.ts:15

getInstanceUsingABI

▸ getInstanceUsingABI(config, address, solidityABI): Promise\<Nft1155Contract>

Parameters

Name	Type
`config`	`InstantiableConfig`
`address`	`string`
`solidityABI`	`any`

Returns

Promise\<Nft1155Contract>

Defined in

src/keeper/contracts/Nft1155Contract.ts:46

setInstanceConfig

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

Type parameters

Name	Type
`T`	extends `Instantiable`

Parameters

Name	Type
`instance`	`T`
`instantiableConfig`	`InstantiableConfig`

Returns

void

Inherited from

NFTContractsBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:154

Class: Nft1155Contract

Hierarchy​

Table of contents​

Constructors​

Properties​

Accessors​

Methods​

Constructors​

constructor​

Parameters​

Returns​

Inherited from​

Defined in​

Properties​

address​

Inherited from​

Defined in​

contract​

Inherited from​

Defined in​

contractName​

Inherited from​

Defined in​

events​

Inherited from​

Defined in​

version​

Inherited from​

Defined in​

Accessors​

artifactsFolder​

Returns​

Inherited from​

Defined in​

circuitsFolder​

Returns​

Inherited from​

Defined in​

client​

Returns​

Inherited from​

Defined in​

config​

Returns​

Inherited from​

Defined in​

instanceConfig​

Returns​

Inherited from​

Defined in​

instantiableConfig​

Returns​

Inherited from​

Defined in​

logger​

Returns​

Inherited from​

Defined in​

nevermined​

Returns​

Inherited from​

Defined in​

publicClient​

Returns​

Inherited from​

Defined in​

walletClient​

Returns​

Inherited from​

Defined in​

Methods​

_createClone​

Parameters​

Returns​

Inherited from​

Defined in​

balance​

Parameters​

Returns​

Defined in​

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns

Inherited from

Defined in

Properties

address

Inherited from

Defined in

contract

Inherited from

Defined in

contractName

Inherited from

Defined in

events

Inherited from

Defined in

version

Inherited from

Defined in

Accessors

artifactsFolder

Returns

Inherited from

Defined in

circuitsFolder

Returns

Inherited from

Defined in

client

Returns

Inherited from

Defined in

config

Returns

Inherited from

Defined in

instanceConfig

Returns

Inherited from

Defined in

instantiableConfig

Returns

Inherited from

Defined in

logger

Returns

Inherited from

Defined in

nevermined

Returns

Inherited from

Defined in

publicClient

Returns

Inherited from

Defined in

walletClient

Returns

Inherited from

Defined in

Methods

_createClone

Parameters

Returns

Inherited from

Defined in

balance

Parameters

Returns

Defined in

burn