TokenERC721
Methods
DEFAULT_ADMIN_ROLE
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)Returns
_0
bytes32
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
burn
function burn(uint256 tokenId) external nonpayableBurns tokenId. See {ERC721-_burn}.
Parameters
tokenId
uint256
undefined
contractType
function contractType() external pure returns (bytes32)Returns the module type of the contract.
Returns
_0
bytes32
undefined
contractURI
function contractURI() external view returns (string)Contract level metadata.
Returns
_0
string
undefined
contractVersion
function contractVersion() external pure returns (uint8)Returns the version of the contract.
Returns
_0
uint8
undefined
getApproved
function getApproved(uint256 tokenId) external view returns (address)See {IERC721-getApproved}.
Parameters
tokenId
uint256
undefined
Returns
_0
address
undefined
getDefaultRoyaltyInfo
function getDefaultRoyaltyInfo() external view returns (address, uint16)Returns the platform fee bps and recipient.
Returns
_0
address
undefined
_1
uint16
undefined
getPlatformFeeInfo
function getPlatformFeeInfo() external view returns (address, uint16)Returns the platform fee bps and recipient.
Returns
_0
address
undefined
_1
uint16
undefined
getRoleAdmin
function getRoleAdmin(bytes32 role) external view returns (bytes32)Returns the admin role that controls role. See {grantRole} and {revokeRole}. To change a role's admin, use {_setRoleAdmin}.
Parameters
role
bytes32
undefined
Returns
_0
bytes32
undefined
getRoleMember
function getRoleMember(bytes32 role, uint256 index) external view returns (address)Returns one of the accounts that have role. index must be a value between 0 and {getRoleMemberCount}, non-inclusive. Role bearers are not sorted in any particular way, and their ordering may change at any point. WARNING: When using {getRoleMember} and {getRoleMemberCount}, make sure you perform all queries on the same block. See the following https://forum.openzeppelin.com/t/iterating-over-elements-on-enumerableset-in-openzeppelin-contracts/2296[forum post] for more information.
Parameters
role
bytes32
undefined
index
uint256
undefined
Returns
_0
address
undefined
getRoleMemberCount
function getRoleMemberCount(bytes32 role) external view returns (uint256)Returns the number of accounts that have role. Can be used together with {getRoleMember} to enumerate all bearers of a role.
Parameters
role
bytes32
undefined
Returns
_0
uint256
undefined
getRoyaltyInfoForToken
function getRoyaltyInfoForToken(uint256 _tokenId) external view returns (address, uint16)Returns the royalty recipient for a particular token Id.
Parameters
_tokenId
uint256
undefined
Returns
_0
address
undefined
_1
uint16
undefined
grantRole
function grantRole(bytes32 role, address account) external nonpayableGrants role to account. If account had not been already granted role, emits a {RoleGranted} event. Requirements: - the caller must have role's admin role. May emit a {RoleGranted} event.
Parameters
role
bytes32
undefined
account
address
undefined
hasRole
function hasRole(bytes32 role, address account) external view returns (bool)Returns true if account has been granted role.
Parameters
role
bytes32
undefined
account
address
undefined
Returns
_0
bool
undefined
initialize
function initialize(address _defaultAdmin, string _name, string _symbol, string _contractURI, address[] _trustedForwarders, address _saleRecipient, address _royaltyRecipient, uint128 _royaltyBps, uint128 _platformFeeBps, address _platformFeeRecipient) external nonpayableInitiliazes the contract, like a constructor.
Parameters
_defaultAdmin
address
undefined
_name
string
undefined
_symbol
string
undefined
_contractURI
string
undefined
_trustedForwarders
address[]
undefined
_saleRecipient
address
undefined
_royaltyRecipient
address
undefined
_royaltyBps
uint128
undefined
_platformFeeBps
uint128
undefined
_platformFeeRecipient
address
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
isTrustedForwarder
function isTrustedForwarder(address forwarder) external view returns (bool)Parameters
forwarder
address
undefined
Returns
_0
bool
undefined
mintTo
function mintTo(address _to, string _uri) external nonpayable returns (uint256)Lets an account with MINTER_ROLE mint an NFT.
Parameters
_to
address
undefined
_uri
string
undefined
Returns
_0
uint256
undefined
mintWithSignature
function mintWithSignature(ITokenERC721.MintRequest _req, bytes _signature) external payable returns (uint256 tokenIdMinted)Parameters
_req
ITokenERC721.MintRequest
undefined
_signature
bytes
undefined
Returns
tokenIdMinted
uint256
undefined
multicall
function multicall(bytes[] data) external nonpayable returns (bytes[] results)Receives and executes a batch of function calls on this contract.
Parameters
data
bytes[]
undefined
Returns
results
bytes[]
undefined
name
function name() external view returns (string)See {IERC721Metadata-name}.
Returns
_0
string
undefined
nextTokenIdToMint
function nextTokenIdToMint() external view returns (uint256)The token ID of the next token to mint.
Returns
_0
uint256
undefined
operatorRestriction
function operatorRestriction() external view returns (bool)Returns
_0
bool
undefined
owner
function owner() external view returns (address)Returns the address of the current owner.
Returns
_0
address
undefined
ownerOf
function ownerOf(uint256 tokenId) external view returns (address)See {IERC721-ownerOf}.
Parameters
tokenId
uint256
undefined
Returns
_0
address
undefined
platformFeeRecipient
function platformFeeRecipient() external view returns (address)The adress that receives all primary sales value.
Returns
_0
address
undefined
primarySaleRecipient
function primarySaleRecipient() external view returns (address)The adress that receives all primary sales value.
Returns
_0
address
undefined
renounceRole
function renounceRole(bytes32 role, address account) external nonpayableRevokes role from the calling account. Roles are often managed via {grantRole} and {revokeRole}: this function's purpose is to provide a mechanism for accounts to lose their privileges if they are compromised (such as when a trusted device is misplaced). If the calling account had been revoked role, emits a {RoleRevoked} event. Requirements: - the caller must be account. May emit a {RoleRevoked} event.
Parameters
role
bytes32
undefined
account
address
undefined
revokeRole
function revokeRole(bytes32 role, address account) external nonpayableRevokes role from account. If account had been granted role, emits a {RoleRevoked} event. Requirements: - the caller must have role's admin role. May emit a {RoleRevoked} event.
Parameters
role
bytes32
undefined
account
address
undefined
royaltyInfo
function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount)See EIP-2981
Parameters
tokenId
uint256
undefined
salePrice
uint256
undefined
Returns
receiver
address
undefined
royaltyAmount
uint256
undefined
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 module admin set the URI for contract-level metadata.
Parameters
_uri
string
undefined
setDefaultRoyaltyInfo
function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external nonpayableLets a module admin update the royalty bps and recipient.
Parameters
_royaltyRecipient
address
undefined
_royaltyBps
uint256
undefined
setOperatorRestriction
function setOperatorRestriction(bool _restriction) external nonpayableParameters
_restriction
bool
undefined
setOwner
function setOwner(address _newOwner) external nonpayableLets a module admin set a new owner for the contract. The new owner must be a module admin.
Parameters
_newOwner
address
undefined
setPlatformFeeInfo
function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayableLets a module admin update the fees on primary sales.
Parameters
_platformFeeRecipient
address
undefined
_platformFeeBps
uint256
undefined
setPrimarySaleRecipient
function setPrimarySaleRecipient(address _saleRecipient) external nonpayableLets a module admin set the default recipient of all primary sales.
Parameters
_saleRecipient
address
undefined
setRoyaltyInfoForToken
function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint256 _bps) external nonpayableLets a module admin set the royalty recipient for a particular token Id.
Parameters
_tokenId
uint256
undefined
_recipient
address
undefined
_bps
uint256
undefined
supportsInterface
function supportsInterface(bytes4 interfaceId) external view returns (bool)Parameters
interfaceId
bytes4
undefined
Returns
_0
bool
undefined
symbol
function symbol() external view returns (string)See {IERC721Metadata-symbol}.
Returns
_0
string
undefined
tokenByIndex
function tokenByIndex(uint256 index) external view returns (uint256)See {IERC721Enumerable-tokenByIndex}.
Parameters
index
uint256
undefined
Returns
_0
uint256
undefined
tokenOfOwnerByIndex
function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256)See {IERC721Enumerable-tokenOfOwnerByIndex}.
Parameters
owner
address
undefined
index
uint256
undefined
Returns
_0
uint256
undefined
tokenURI
function tokenURI(uint256 _tokenId) external view returns (string)Returns the URI for a tokenId
Parameters
_tokenId
uint256
undefined
Returns
_0
string
undefined
totalSupply
function totalSupply() external view returns (uint256)See {IERC721Enumerable-totalSupply}.
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
verify
function verify(ITokenERC721.MintRequest _req, bytes _signature) external view returns (bool, address)Parameters
_req
ITokenERC721.MintRequest
undefined
_signature
bytes
undefined
Returns
_0
bool
undefined
_1
address
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
DefaultRoyalty
event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)Parameters
newRoyaltyRecipient indexed
address
undefined
newRoyaltyBps
uint256
undefined
Initialized
event Initialized(uint8 version)Parameters
version
uint8
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
PlatformFeeInfoUpdated
event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps)Parameters
platformFeeRecipient indexed
address
undefined
platformFeeBps
uint256
undefined
PrimarySaleRecipientUpdated
event PrimarySaleRecipientUpdated(address indexed recipient)Parameters
recipient indexed
address
undefined
RoleAdminChanged
event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)Parameters
role indexed
bytes32
undefined
previousAdminRole indexed
bytes32
undefined
newAdminRole indexed
bytes32
undefined
RoleGranted
event RoleGranted(bytes32 indexed role, address indexed account, address indexed sender)Parameters
role indexed
bytes32
undefined
account indexed
address
undefined
sender indexed
address
undefined
RoleRevoked
event RoleRevoked(bytes32 indexed role, address indexed account, address indexed sender)Parameters
role indexed
bytes32
undefined
account indexed
address
undefined
sender 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
TokensMinted
event TokensMinted(address indexed mintedTo, uint256 indexed tokenIdMinted, string uri)Parameters
mintedTo indexed
address
undefined
tokenIdMinted indexed
uint256
undefined
uri
string
undefined
TokensMintedWithSignature
event TokensMintedWithSignature(address indexed signer, address indexed mintedTo, uint256 indexed tokenIdMinted, ITokenERC721.MintRequest mintRequest)Parameters
signer indexed
address
undefined
mintedTo indexed
address
undefined
tokenIdMinted indexed
uint256
undefined
mintRequest
ITokenERC721.MintRequest
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
OperatorNotAllowed
error OperatorNotAllowed(address operator)Parameters
operator
address
undefined
Last updated