Class ERC1155

Basic representation of an ERC1155 compatible contract. If additional functionality is required, this contract can be extended via inheritance

Hierarchy

BaseContract
- ERC1155

Constructors

constructor

new ERC1155(_contract, IPFSGateway?, maximumId?): ERC1155
Constructs a new instance of the contract
Parameters
- _contract: IContract
- IPFSGateway: string = 'https://cloudflare-ipfs.com/ipfs/'
- Optional maximumId: BigNumberish
Returns ERC1155

Overrides BaseContract.constructor

Accessors

IPFSGateway

get IPFSGateway(): string
Returns string

address

get address(): string
Returns the contract address

Returns string

Inherited from BaseContract.address

contract

get contract(): Contract
Returns the underlying contract interface

Returns Contract

Inherited from BaseContract.contract

Methods

balanceOf

balanceOf(owner, id): Promise<BigNumber>
Get the balance of an account's tokens.
Parameters
- owner: string
- id: BigNumberish
Returns Promise<BigNumber>

balanceOfBatch

balanceOfBatch(owners, ids): Promise<BigNumberish[]>
Get the balance of multiple account/token pairs
Parameters
- owners: string[]
- ids: BigNumberish[]
Returns Promise<BigNumberish[]>

balanceOfOwner

balanceOfOwner(owner): Promise<BigNumber>
Attempts to determine the balance of the owner across all IDs
Parameters
- owner: string
Returns Promise<BigNumber>

call

call(name, ...params): ContractCall
Returns an interface allowing for us with the multicall method of a provider
Parameters
- name: string
- Rest ...params: any[]
Returns ContractCall

Inherited from BaseContract.call

connect

connect(signerOrProvider): ERC1155
Connects the existing instance of the contract to a new signer or provider
Parameters
- signerOrProvider: Provider | Signer | MulticallProvider
Returns ERC1155

Inherited from BaseContract.connect

discoverMaximumId

discoverMaximumId(): Promise<BigNumber>
Attempt to discover the maximum ID through brute forcing.

Note: This method is very slow upon first run if maximumID() is not supported and the results are cached internally to make subsequent calls faster; however, subsequent calls will check to see if the maximum id has increased.

Note: We loop in here until we get a revert... thus we cannot reasonably account for any burn mechanics if the URI for a burned ID is destroyed by the contract

Returns Promise<BigNumber>

exists

exists(id): Promise<boolean>
Indicates whether any token exist with a given id, or not.
Parameters
- id: BigNumberish
Returns Promise<boolean>

isApprovedForAll

isApprovedForAll(owner, operator): Promise<boolean>
Queries the approval status of an operator for a given owner.
Parameters
- owner: string
- operator: string
Returns Promise<boolean>

maximumID

maximumID(): Promise<BigNumber>
Retrieves the maximum ID if the contract supports this call

Returns Promise<BigNumber>

metadata

metadata(id): Promise<ERC1155FetchedMetadata>
Fetches the metadata for the specified token ID
Parameters
- id: BigNumberish
Returns Promise<ERC1155FetchedMetadata>

`Protected` metadataBulk

metadataBulk(tokens): Promise<ERC1155FetchedMetadata[]>
Protected
Retrieves bulk metadata
Parameters
- tokens: {
  id: BigNumberish;
  uri: string;
  }[]
Returns Promise<ERC1155FetchedMetadata[]>

name

name(): Promise<string>
A descriptive name for a collection of NFTs in this contract

Returns Promise<string>

ownedMetadata

ownedMetadata(owner): Promise<ERC1155Metadata[]>
Returns the metadata for all NFTs owned by the specified account by scanning through the range of IDs provided
Parameters
- owner: string
Returns Promise<ERC1155Metadata[]>

ownedTokenIds

ownedTokenIds(owner): Promise<BigNumber[]>
Returns an array of token IDs owned by the specified account by scanning through the range of IDs provided
Parameters
- owner: string
Returns Promise<BigNumber[]>

`Protected` retryCall

retryCall<T>(func, ...params): Promise<T>
Protected
Automatically keeps trying the call unless we get a revert exception
Type Parameters
- T
Parameters
- func: ((...args) => Promise<T>)
  - - (...args): Promise<T>
    - Parameters
      
      Rest ...args: any[]
      
      Returns Promise<T>
- Rest ...params: any[]
Returns Promise<T>

Inherited from BaseContract.retryCall

royaltyInfo

royaltyInfo(tokenId, salePrice): Promise<{
receiver: string;
royaltyAmount: BigNumber;
}>
Returns how much royalty is owed and to whom, based on a sale price that may be denominated in any unit of exchange. The royalty amount is denominated and should be payed in that same unit of exchange.
Parameters
- tokenId: BigNumberish
- salePrice: BigNumberish
Returns Promise<{
receiver: string;
royaltyAmount: BigNumber;
}>

safeBatchTransferFrom

safeBatchTransferFrom(from, to, ids, values, data, overrides?): Promise<ContractTransaction>
Transfers values amount(s) of ids from the from address to the to address specified (with safety call).
Parameters
- from: string
- to: string
- ids: BigNumberish[]
- values: BigNumberish[]
- data: string
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>

safeTransferFrom

safeTransferFrom(from, to, id, value, data, overrides?): Promise<ContractTransaction>
Transfers value amount of an id from the from address to the to address specified (with safety call).
Parameters
- from: string
- to: string
- id: BigNumberish
- value: BigNumberish
- data: string
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>

setApprovalForAll

setApprovalForAll(operator, approved?, overrides?): Promise<ContractTransaction>
Enable or disable approval for a third party ("operator") to manage all of the caller's tokens.
Parameters
- operator: string
- approved: boolean = true
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>

supportsInterface

supportsInterface(interfaceId): Promise<boolean>
Returns whether the specified interface is supported by the contract
Parameters
- interfaceId: string
Returns Promise<boolean>

Inherited from BaseContract.supportsInterface

tokenURI

tokenURI(tokenId): Promise<string>
A distinct Uniform Resource Identifier (URI) for a given asset.
Parameters
- tokenId: BigNumberish
Returns Promise<string>

Alias
uri

totalSupply

totalSupply(id): Promise<BigNumber>
Returns the total amount of tokens stored by the contract.
Parameters
- id: BigNumberish
Returns Promise<BigNumber>

uri

uri(id): Promise<string>
A distinct Uniform Resource Identifier (URI) for a given token.
Parameters
- id: BigNumberish
Returns Promise<string>

Class ERC1155

Hierarchy

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

_contract: IContract

IPFSGateway: string = 'https://cloudflare-ipfs.com/ipfs/'

Optional maximumId: BigNumberish

Returns ERC1155

Accessors

IPFSGateway

Returns string

address

Returns string

contract

Returns Contract

Methods

balanceOf

Parameters

owner: string

id: BigNumberish

Returns Promise<BigNumber>

balanceOfBatch

Parameters

owners: string[]

ids: BigNumberish[]

Returns Promise<BigNumberish[]>

balanceOfOwner

Parameters

owner: string

Returns Promise<BigNumber>

call

Parameters

name: string

Rest ...params: any[]

Returns ContractCall

connect

Parameters

signerOrProvider: Provider | Signer | MulticallProvider

Returns ERC1155

discoverMaximumId

Returns Promise<BigNumber>

exists

Parameters

id: BigNumberish

Returns Promise<boolean>

isApprovedForAll

Parameters

owner: string

operator: string

Returns Promise<boolean>

maximumID

Returns Promise<BigNumber>

metadata

Parameters

id: BigNumberish

Returns Promise<ERC1155FetchedMetadata>

Protected metadataBulk

Parameters

tokens: { id: BigNumberish; uri: string; }[]

Returns Promise<ERC1155FetchedMetadata[]>

name

Returns Promise<string>

ownedMetadata

Parameters

owner: string

Returns Promise<ERC1155Metadata[]>

ownedTokenIds

Parameters

owner: string

Returns Promise<BigNumber[]>

Protected retryCall

Type Parameters

T

Parameters

func: ((...args) => Promise<T>)

`Optional` maximumId: BigNumberish

`Rest` ...params: any[]

`Protected` metadataBulk

tokens: {
id: BigNumberish;
uri: string;
}[]

`Protected` retryCall

`Rest` ...args: any[]

`Rest` ...params: any[]

Returns Promise<{
receiver: string;
royaltyAmount: BigNumber;
}>