Skip to main content

Nft1155Contract

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

Class: Nft1155Contract

NFTs contracts DTO allowing to manage Nevermined ERC-1155 NFTs

Hierarchy

Table of contents

Constructors

Properties

Accessors

Methods

Constructors

constructor

new Nft1155Contract(contractName): Nft1155Contract

Parameters

NameType
contractNamestring

Returns

Nft1155Contract

Inherited from

NFTContractsBase.constructor

Defined in

src/keeper/contracts/ContractBase.ts:24

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

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

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

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

NameTypeDefault valueDescription
ercType721 | 1155undefined-
namestringundefinedNFT Contract name
symbolstringundefinedNFT Contract symbol
uristringundefinedNFT Contract metadata uri
capundefined | bigintundefinedNFT cap (just for ERC-721)
operatorsstring[][]Array of account addresses to be added as NFT operators
fromNvmAccountundefinedSender account
txParams?TxParametersundefined-

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

NameTypeDescription
addressstringAccount address to check the balance
didstringThe 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

NameTypeDescription
fromNvmAccountAccount burning the NFT editions
tokenIdstringThe NFT id to burn
amountbigintNumber of editions to burn
txParams?TxParametersTransaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:178


burnFromHolder

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

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

Parameters

NameTypeDescription
holderstringAddress of the account holding the NFT editions that are going to be burned
tokenIdstringThe NFT id to burn
amountbigintNumber of editions to burn
fromNvmAccountAccount burning the NFT editions
txParams?TxParametersTransaction 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

NameType
functionNamestring
argsany[]
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

NameTypeDefault valueDescription
namestringundefinedNFT Contract name
symbolstringundefinedNFT Contract symbol
uristringundefinedNFT Contract metadata uri
operatorsstring[][]Array of account addresses to be added as NFT operators
fromNvmAccountundefinedSender account
txParams?TxParametersundefined-

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:75


getFromAddress

getFromAddress(from?): Promise\<string>

Parameters

NameType
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

NameTypeDescription
ownerstringthe user owning the NFT
did?stringthe tokenId of the NFT

Returns

Promise\<NFT1155MintedEntry[]>

An array of NFT1155MintedEntry objects

Defined in

src/keeper/contracts/Nft1155Contract.ts:223


getNFTAttributes

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

Parameters

NameType
didstring

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

NameType
txReceiptTransactionReceipt
eventNamestring

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

NameTypeDescription
operatorAddressstringNew minter address
fromNvmAccountSender 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

NameTypeDefault value
configInstantiableConfigundefined
optionalbooleanfalse
contractAddress?stringundefined

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

NameTypeDescription
accountAddressstringAccount address
operatorAddressstringOperator 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

NameTypeDescription
addressstringAccount 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

NameTypeDescription
tostringAccount address of the NFT receiver
didstringThe NFT id to mint
amountbigintNumber of editions to mint
fromNvmAccountAccount minting the NFT
data?stringData
txParams?TxParametersTransaction 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

NameTypeDescription
operatorAddressstringMinter address to revoke
fromNvmAccountSender 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

NameType
functionNamestring
fromNvmAccount
argsany[]
paramsTxParameters

Returns

Promise\<any>

Inherited from

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

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

NameTypeDescription
operatorAddressstringOperator address
approvedbooleanIs approved
fromNvmAccountSender account
txParams?TxParametersTransaction additional parameters

Returns

Promise\<any>

Contract Receipt

Defined in

src/keeper/contracts/Nft1155Contract.ts:106


setInstanceConfig

setInstanceConfig(config): void

Parameters

NameType
configInstantiableConfig

Returns

void

Inherited from

NFTContractsBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:163


someLog

someLog(logs): undefined

Parameters

NameType
logsany[]

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

NameTypeDescription
didstringThe NFT id
tostringAccount address of the NFT receiver
amountbigintNumber of editions to transfer. Typically just 1
fromNvmAccountAccount transferring the NFT
txParams?TxParametersTransaction 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

NameTypeDescription
didstringThe NFT id

Returns

Promise\<string>

The NFT metadata url

Defined in

src/keeper/contracts/Nft1155Contract.ts:213


getInstance

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

Parameters

NameTypeDefault value
configInstantiableConfigundefined
address?stringundefined
contractNamestring'NFT1155Upgradeable'
artifactsFolderundefined | stringconfig.artifactsFolder

Returns

Promise\<Nft1155Contract>

Overrides

NFTContractsBase.getInstance

Defined in

src/keeper/contracts/Nft1155Contract.ts:15


getInstanceUsingABI

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

Parameters

NameType
configInstantiableConfig
addressstring
solidityABIany

Returns

Promise\<Nft1155Contract>

Defined in

src/keeper/contracts/Nft1155Contract.ts:46


setInstanceConfig

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

Type parameters

NameType
Textends Instantiable

Parameters

NameType
instanceT
instantiableConfigInstantiableConfig

Returns

void

Inherited from

NFTContractsBase.setInstanceConfig

Defined in

src/Instantiable.abstract.ts:154