ERC721Base
The ERC721Base smart contract implements the ERC721 NFT standard, along with the ERC721A optimization to the standard. It includes the following additions to standard ERC721 logic: - Ability to mint NFTs via the provided mint function. - Contract metadata for royalty support on platforms such as OpenSea that use off-chain information to distribute roaylties. - Ownership of the contract, with the ability to restrict certain functions to only be called by the contract's owner. - Multicall capability to perform multiple actions atomically - EIP 2981 compliance for royalty support on NFT marketplaces.
Methods
OPERATOR_FILTER_REGISTRY
function OPERATOR_FILTER_REGISTRY() external view returns (contract IOperatorFilterRegistry)Returns
_0
contract IOperatorFilterRegistry
undefined
approve
function approve(address operator, uint256 tokenId) external nonpayableSee {ERC721-approve}.
Parameters
operator
address
undefined
tokenId
uint256
undefined
balanceOf
function balanceOf(address owner) external view returns (uint256)See {IERC721-balanceOf}.
Parameters
owner
address
undefined
Returns
_0
uint256
undefined
batchMintTo
function batchMintTo(address _to, uint256 _quantity, string _baseURI, bytes _data) external nonpayableLets an authorized address mint multiple NFTs at once to a recipient.
The logic in the _canMint function determines whether the caller is authorized to mint NFTs.
Parameters
_to
address
The recipient of the NFT to mint.
_quantity
uint256
The number of NFTs to mint.
_baseURI
string
The baseURI for the n number of NFTs minted. The metadata for each NFT is baseURI/tokenId
_data
bytes
Additional data to pass along during the minting of the NFT.
burn
function burn(uint256 _tokenId) external nonpayableLets an owner or approved operator burn the NFT of the given tokenId.
ERC721A's _burn(uint256,bool) internally checks for token approvals.
Parameters
_tokenId
uint256
The tokenId of the NFT to burn.
contractURI
function contractURI() external view returns (string)Returns the contract metadata URI.
Returns
_0
string
undefined
getApproved
function getApproved(uint256 tokenId) external view returns (address)See {IERC721-getApproved}.
Parameters
tokenId
uint256
undefined
Returns
_0
address
undefined
getBaseURICount
function getBaseURICount() external view returns (uint256)Returns the count of batches of NFTs.
Each batch of tokens has an in ID and an associated baseURI. See {batchIds}.
Returns
_0
uint256
undefined
getBatchIdAtIndex
function getBatchIdAtIndex(uint256 _index) external view returns (uint256)Returns the ID for the batch of tokens the given tokenId belongs to.
See {getBaseURICount}.
Parameters
_index
uint256
ID of a token.
Returns
_0
uint256
undefined
getDefaultRoyaltyInfo
function getDefaultRoyaltyInfo() external view returns (address, uint16)Returns the defualt royalty recipient and BPS for this contract's NFTs.
Returns
_0
address
undefined
_1
uint16
undefined
getRoyaltyInfoForToken
function getRoyaltyInfoForToken(uint256 _tokenId) external view returns (address, uint16)View royalty info for a given token.
Returns royalty recipient and bps for _tokenId.
Parameters
_tokenId
uint256
The tokenID of the NFT for which to query royalty info.
Returns
_0
address
undefined
_1
uint16
undefined
isApprovedForAll
function isApprovedForAll(address owner, address operator) external view returns (bool)See {IERC721-isApprovedForAll}.
Parameters
owner
address
undefined
operator
address
undefined
Returns
_0
bool
undefined
isApprovedOrOwner
function isApprovedOrOwner(address _operator, uint256 _tokenId) external view returns (bool isApprovedOrOwnerOf)Returns whether a given address is the owner, or approved to transfer an NFT.
Parameters
_operator
address
undefined
_tokenId
uint256
undefined
Returns
isApprovedOrOwnerOf
bool
undefined
mintTo
function mintTo(address _to, string _tokenURI) external nonpayableLets an authorized address mint an NFT to a recipient.
The logic in the _canMint function determines whether the caller is authorized to mint NFTs.
Parameters
_to
address
The recipient of the NFT to mint.
_tokenURI
string
The full metadata URI for the NFT minted.
multicall
function multicall(bytes[] data) external nonpayable returns (bytes[] results)Receives and executes a batch of function calls on this contract.
Receives and executes a batch of function calls on this contract.
Parameters
data
bytes[]
The bytes data that makes up the batch of function calls to execute.
Returns
results
bytes[]
The bytes data that makes up the result of the batch of function calls executed.
name
function name() external view returns (string)See {IERC721Metadata-name}.
Returns
_0
string
undefined
nextTokenIdToMint
function nextTokenIdToMint() external view returns (uint256)The tokenId assigned to the next new NFT to be minted.
Returns
_0
uint256
undefined
operatorRestriction
function operatorRestriction() external view returns (bool)Returns
_0
bool
undefined
owner
function owner() external view returns (address)Returns the owner of the contract.
Returns
_0
address
undefined
ownerOf
function ownerOf(uint256 tokenId) external view returns (address)See {IERC721-ownerOf}.
Parameters
tokenId
uint256
undefined
Returns
_0
address
undefined
royaltyInfo
function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount)View royalty info for a given token and sale price.
Returns royalty amount and recipient for tokenId and salePrice.
Parameters
tokenId
uint256
The tokenID of the NFT for which to query royalty info.
salePrice
uint256
Sale price of the token.
Returns
receiver
address
Address of royalty recipient account.
royaltyAmount
uint256
Royalty amount calculated at current royaltyBps value.
safeTransferFrom
function safeTransferFrom(address from, address to, uint256 tokenId) external nonpayableSee {ERC721-_safeTransferFrom}.
Parameters
from
address
undefined
to
address
undefined
tokenId
uint256
undefined
safeTransferFrom
function safeTransferFrom(address from, address to, uint256 tokenId, bytes data) external nonpayableSee {ERC721-_safeTransferFrom}.
Parameters
from
address
undefined
to
address
undefined
tokenId
uint256
undefined
data
bytes
undefined
setApprovalForAll
function setApprovalForAll(address operator, bool approved) external nonpayableSee {ERC721-setApprovalForAll}.
Parameters
operator
address
undefined
approved
bool
undefined
setContractURI
function setContractURI(string _uri) external nonpayableLets a contract admin set the URI for contract-level metadata.
Caller should be authorized to setup contractURI, e.g. contract admin. See {_canSetContractURI}. Emits {ContractURIUpdated Event}.
Parameters
_uri
string
keccak256 hash of the role. e.g. keccak256("TRANSFER_ROLE")
setDefaultRoyaltyInfo
function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external nonpayableUpdates default royalty recipient and bps.
Caller should be authorized to set royalty info. See {_canSetRoyaltyInfo}. Emits {DefaultRoyalty Event}; See {_setupDefaultRoyaltyInfo}.
Parameters
_royaltyRecipient
address
Address to be set as default royalty recipient.
_royaltyBps
uint256
Updated royalty bps.
setOperatorRestriction
function setOperatorRestriction(bool _restriction) external nonpayableParameters
_restriction
bool
undefined
setOwner
function setOwner(address _newOwner) external nonpayableLets an authorized wallet set a new owner for the contract.
Parameters
_newOwner
address
The address to set as the new owner of the contract.
setRoyaltyInfoForToken
function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint256 _bps) external nonpayableUpdates default royalty recipient and bps for a particular token.
Sets royalty info for _tokenId. Caller should be authorized to set royalty info. See {_canSetRoyaltyInfo}. Emits {RoyaltyForToken Event}; See {_setupRoyaltyInfoForToken}.
Parameters
_tokenId
uint256
undefined
_recipient
address
Address to be set as royalty recipient for given token Id.
_bps
uint256
Updated royalty bps for the token Id.
supportsInterface
function supportsInterface(bytes4 interfaceId) external view returns (bool)See ERC165: https://eips.ethereum.org/EIPS/eip-165
Parameters
interfaceId
bytes4
undefined
Returns
_0
bool
undefined
symbol
function symbol() external view returns (string)See {IERC721Metadata-symbol}.
Returns
_0
string
undefined
tokenURI
function tokenURI(uint256 _tokenId) external view returns (string)Returns the metadata URI for an NFT.
See BatchMintMetadata for handling of metadata in this contract.
Parameters
_tokenId
uint256
The tokenId of an NFT.
Returns
_0
string
undefined
totalSupply
function totalSupply() external view returns (uint256)Burned tokens are calculated here, use _totalMinted() if you want to count just minted tokens.
Returns
_0
uint256
undefined
transferFrom
function transferFrom(address from, address to, uint256 tokenId) external nonpayableSee {ERC721-_transferFrom}.
Parameters
from
address
undefined
to
address
undefined
tokenId
uint256
undefined
Events
Approval
event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId)Parameters
owner indexed
address
undefined
approved indexed
address
undefined
tokenId indexed
uint256
undefined
ApprovalForAll
event ApprovalForAll(address indexed owner, address indexed operator, bool approved)Parameters
owner indexed
address
undefined
operator indexed
address
undefined
approved
bool
undefined
ContractURIUpdated
event ContractURIUpdated(string prevURI, string newURI)Parameters
prevURI
string
undefined
newURI
string
undefined
DefaultRoyalty
event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)Parameters
newRoyaltyRecipient indexed
address
undefined
newRoyaltyBps
uint256
undefined
OperatorRestriction
event OperatorRestriction(bool restriction)Parameters
restriction
bool
undefined
OwnerUpdated
event OwnerUpdated(address indexed prevOwner, address indexed newOwner)Parameters
prevOwner indexed
address
undefined
newOwner indexed
address
undefined
RoyaltyForToken
event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient, uint256 royaltyBps)Parameters
tokenId indexed
uint256
undefined
royaltyRecipient indexed
address
undefined
royaltyBps
uint256
undefined
Transfer
event Transfer(address indexed from, address indexed to, uint256 indexed tokenId)Parameters
from indexed
address
undefined
to indexed
address
undefined
tokenId indexed
uint256
undefined
Errors
ApprovalCallerNotOwnerNorApproved
error ApprovalCallerNotOwnerNorApproved()The caller must own the token or be an approved operator.
ApprovalQueryForNonexistentToken
error ApprovalQueryForNonexistentToken()The token does not exist.
ApprovalToCurrentOwner
error ApprovalToCurrentOwner()The caller cannot approve to the current owner.
ApproveToCaller
error ApproveToCaller()The caller cannot approve to their own address.
BalanceQueryForZeroAddress
error BalanceQueryForZeroAddress()Cannot query the balance for the zero address.
MintToZeroAddress
error MintToZeroAddress()Cannot mint to the zero address.
MintZeroQuantity
error MintZeroQuantity()The quantity of tokens minted must be more than zero.
OperatorNotAllowed
error OperatorNotAllowed(address operator)Parameters
operator
address
undefined
OwnerQueryForNonexistentToken
error OwnerQueryForNonexistentToken()The token does not exist.
TransferCallerNotOwnerNorApproved
error TransferCallerNotOwnerNorApproved()The caller must own the token or be an approved operator.
TransferFromIncorrectOwner
error TransferFromIncorrectOwner()The token must be owned by from.
TransferToNonERC721ReceiverImplementer
error TransferToNonERC721ReceiverImplementer()Cannot safely transfer to a contract that does not implement the ERC721Receiver interface.
TransferToZeroAddress
error TransferToZeroAddress()Cannot transfer to the zero address.
URIQueryForNonexistentToken
error URIQueryForNonexistentToken()The token does not exist.
Last updated