Class ERC721

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

Hierarchy

BaseContract
- ERC721

Constructors

constructor

new ERC721(_contract, IPFSGateway?): ERC721
Creates a new instance of the object
Parameters
- _contract: IContract
- IPFSGateway: string = 'https://cloudflare-ipfs.com/ipfs/'
Returns ERC721

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

approve

approve(approved, tokenId, overrides?): Promise<ContractTransaction>
Change or reaffirm the approved address for an NFT
Parameters
- approved: string
- tokenId: BigNumberish
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>

balanceOf

balanceOf(owner): Promise<BigNumber>
Count all NFTs assigned to an owner
Parameters
- owner: string
Returns Promise<BigNumber>

balanceOfBatch

balanceOfBatch(owners): Promise<{
balance: BigNumber;
owner: string;
}[]>
Returns the balances for each of the provided accounts
Parameters
- owners: string[]
Returns Promise<{
balance: BigNumber;
owner: string;
}[]>

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): ERC721
Connects the existing instance of the contract to a new signer or provider
Parameters
- signerOrProvider: Provider | Signer | MulticallProvider
Returns ERC721

Inherited from BaseContract.connect

getApproved

getApproved(tokenId): Promise<string>
Get the approved address for a single NFT
Parameters
- tokenId: BigNumberish
Returns Promise<string>

holders

holders(): Promise<Map<string, BigNumber[]>>
Retrieves all holders and their held tokenIds

Returns Promise<Map<string, BigNumber[]>>

isApprovedForAll

isApprovedForAll(owner, operator): Promise<boolean>
Query if an address is an authorized operator for another address
Parameters
- owner: string
- operator: string
Returns Promise<boolean>

metadata

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

`Protected` metadataBulk

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

name

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

Returns Promise<string>

ownedMetadata

ownedMetadata(owner): Promise<ERC721FetchedMetadata[]>
Returns the metadata for all NFTs owned by the specified account
Parameters
- owner: string
Returns Promise<ERC721FetchedMetadata[]>

ownedTokenIds

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

ownerOf

ownerOf(tokenId): Promise<string>
Find the owner of an NFT
Parameters
- tokenId: BigNumberish
Returns Promise<string>

`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;
}>

safeTransferFrom

safeTransferFrom(from, to, tokenId, data?, overrides?): Promise<ContractTransaction>
Transfers the ownership of an NFT from one address to another address
Parameters
- from: string
- to: string
- tokenId: BigNumberish
- Optional 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 msg.sender's assets
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

symbol

symbol(): Promise<string>
An abbreviated name for NFTs in this contract

Returns Promise<string>

tokenByIndex

tokenByIndex(index): Promise<BigNumber>
Returns a token ID at a given index of all the tokens stored by the contract. Use along with totalSupply to enumerate all tokens.
Parameters
- index: BigNumberish
Returns Promise<BigNumber>

tokenIds

tokenIds(): Promise<BigNumber[]>
Retrieves all existing token IDs

Returns Promise<BigNumber[]>

tokenMetadata

tokenMetadata(): Promise<{
    address: string;
    name: string;
    symbol: string;
    totalSupply: BigNumber;
}>
Return the metadata of the token

Returns Promise<{
    address: string;
    name: string;
    symbol: string;
    totalSupply: BigNumber;
}>

tokenOfOwnerByIndex

tokenOfOwnerByIndex(owner, index): Promise<BigNumber>
Returns a token ID owned by owner at a given index of its token list. Use along with balanceOf to enumerate all of owner's tokens.
Parameters
- owner: string
- index: BigNumberish
Returns Promise<BigNumber>

tokenURI

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

totalSupply

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

Returns Promise<BigNumber>

transferFrom

transferFrom(from, to, tokenId, overrides?): Promise<ContractTransaction>
Transfer ownership of an NFT -- THE CALLER IS RESPONSIBLE TO CONFIRM THAT _to IS CAPABLE OF RECEIVING NFTS OR ELSE THEY MAY BE PERMANENTLY LOST
Parameters
- from: string
- to: string
- tokenId: BigNumberish
- overrides: CallOverrides = {}
Returns Promise<ContractTransaction>