function BURNER_ROLE() external view returns (bytes32)
Returns
Name
Type
Description
_0
bytes32
undefined
DEFAULT_ADMIN_ROLE
function DEFAULT_ADMIN_ROLE() external view returns (bytes32)
Returns
Name
Type
Description
_0
bytes32
undefined
MINTER_ROLE
function MINTER_ROLE() external view returns (bytes32)
Returns
Name
Type
Description
_0
bytes32
undefined
OPENSEA_POLYGON_ERC1155_PROXY
function OPENSEA_POLYGON_ERC1155_PROXY() external view returns (address)
Returns
Name
Type
Description
_0
address
undefined
balanceOf
function balanceOf(address account, uint256 id) external view returns (uint256)
See {IERC1155-balanceOf}. Requirements: - account cannot be the zero address.
Parameters
Name
Type
Description
account
address
undefined
id
uint256
undefined
Returns
Name
Type
Description
_0
uint256
undefined
balanceOfBatch
function balanceOfBatch(address[] accounts, uint256[] ids) external view returns (uint256[])
See {IERC1155-balanceOfBatch}. Requirements: - accounts and ids must have the same length.
Parameters
Name
Type
Description
accounts
address[]
undefined
ids
uint256[]
undefined
Returns
Name
Type
Description
_0
uint256[]
undefined
baseURI
function baseURI() external view returns (string)
Returns the base URI set via {_setBaseURI}.
Returns
Name
Type
Description
_0
string
undefined
burn
function burn(address from, uint256 id, uint256 amount) external nonpayable
Destroys amount tokens of token type id from from and reduces the balance of to by amount.See {ERC1155Upgradeable-burn}.
Parameters
Name
Type
Description
from
address
The address to burn tokens from.
id
uint256
The token id to burn.
amount
uint256
The amount of tokens to burn. Emits a {TransferSingle} event. Requirements: - from cannot be the zero address. - from must have at least amount tokens of token type id. - the caller must have the BURNER_ROLE.
burnBatch
function burnBatch(address from, uint256[] ids, uint256[] amounts) external nonpayable
Batched version of {_burn}.See {ERC1155Upgradeable-burnBatch}.
Parameters
Name
Type
Description
from
address
The address to burn tokens from.
ids
uint256[]
The token ids to burn.
amounts
uint256[]
The amounts of tokens to burn. Emits a {TransferBatch} event. Requirements: - ids and amounts must have the same length. - the caller must have the BURNER_ROLE.
contractURI
function contractURI() external view returns (string)
returns contract-level-metadata, See https://docs.opensea.io/docs/contract-level-metadata
Returns
Name
Type
Description
_0
string
undefined
exists
function exists(uint256 id) external view returns (bool)
Indicates whether any token exist with a given id, or not.
Parameters
Name
Type
Description
id
uint256
undefined
Returns
Name
Type
Description
_0
bool
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
Name
Type
Description
role
bytes32
undefined
Returns
Name
Type
Description
_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
Name
Type
Description
role
bytes32
undefined
index
uint256
undefined
Returns
Name
Type
Description
_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
Name
Type
Description
role
bytes32
undefined
Returns
Name
Type
Description
_0
uint256
undefined
grantRole
function grantRole(bytes32 role, address account) external nonpayable
Grants 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
Name
Type
Description
role
bytes32
undefined
account
address
undefined
hasRole
function hasRole(bytes32 role, address account) external view returns (bool)
Citing from OpenZeppelin docs: The initialization functions use a version number. Once a version number is used, it is consumed and cannot be reused. This mechanism prevents re-execution of each "step" but allows the creation of new initialization steps in case an upgrade adds a module that needs to be initialized. For example: contract MyToken is ERC20Upgradeable { function initialize() initializer public { __ERC20_init("MyToken", "MTK"); } } contract MyTokenV2 is MyToken, ERC20PermitUpgradeable { function initializeV2() reinitializer(2) public { __ERC20Permit_init("MyToken"); } } TIP: To avoid leaving the proxy in an uninitialized state, the initializer function should be called as early as possible by providing the encoded function call as the _data argument to {ERC1967Proxy-constructor}. CAUTION: When used with inheritance, manual care must be taken to not invoke a parent initializer twice, or to ensure that all initializers are idempotent. This is not verified automatically as constructors are by Solidity. [CAUTION] ==== Avoid leaving a contract uninitialized. An uninitialized contract can be taken over by an attacker. This applies to both a proxy and its implementation contract, which may impact the proxy. To prevent the implementation contract from being used, you should invoke the {_disableInitializers} function in the constructor to automatically lock it when it is deployed: constructor() { _disableInitializers(); } ====
Initializer function. Grants DEFAULT_ADMIN_ROLE to the account that initializes the contract.
Parameters
Name
Type
Description
baseURI_
string
Base URI for all tokens
contractURI_
string
undefined
maxMintedTokens_
uint256
Maximum number of tokens to be minted
maxCopiesPerToken_
uint256
Maximum number of copies per token
isApprovedForAll
function isApprovedForAll(address account, address operator) external view returns (bool)
See {ERC1155Upgradeable-isApprovedForAll}.This function is overridden to add support for OpenSea's Polygon proxy accounts.See https://docs.opensea.io/docs/polygon-basic-integration
Parameters
Name
Type
Description
account
address
Address to check if it has the operator approval
operator
address
Address of the operator to check
Returns
Name
Type
Description
_0
bool
undefined
maxCopiesPerToken
function maxCopiesPerToken() external view returns (uint256)
Returns
Name
Type
Description
_0
uint256
undefined
maxMintedTokens
function maxMintedTokens() external view returns (uint256)
Returns
Name
Type
Description
_0
uint256
undefined
mint
function mint(address to, uint256 id, uint256 amount, bytes data) external nonpayable
Creates amount tokens of token type id, and assigns them to to. Also sets the token URI if uri is not empty.See {ERC1155Upgradeable-mint}.
Parameters
Name
Type
Description
to
address
The address to mint tokens to.
id
uint256
The token id to mint.
amount
uint256
The amount of tokens to mint.
data
bytes
additional data with no specified format. Emits a {TransferSingle} event. Requirements: - to cannot be the zero address. - If to refers to a smart contract, it must implement {IERC1155Receiver-onERC1155Received} and return the acceptance magic value. - the caller must have the MINTER_ROLE.
mintBatch
function mintBatch(address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayable
Batched version of {_mint}.See {ERC1155Upgradeable-mintBatch}.
Parameters
Name
Type
Description
to
address
The address to mint tokens to.
ids
uint256[]
The token ids to mint.
amounts
uint256[]
The amounts of tokens to mint. Emits a {TransferBatch} event. Requirements: - ids and amounts must have the same length. - If to refers to a smart contract, it must implement {IERC1155Receiver-onERC1155BatchReceived} and return the acceptance magic value. - the caller must have the MINTER_ROLE.
data
bytes
undefined
proxiableUUID
function proxiableUUID() external view returns (bytes32)
Implementation of the ERC1822 {proxiableUUID} function. This returns the storage slot used by the implementation. It is used to validate the implementation's compatibility when performing an upgrade. IMPORTANT: A proxy pointing at a proxiable contract should not be considered proxiable itself, because this risks bricking a proxy that upgrades to it, by delegating to itself until out of gas. Thus it is critical that this function revert if invoked through a proxy. This is guaranteed by the notDelegated modifier.
Returns
Name
Type
Description
_0
bytes32
undefined
renounceRole
function renounceRole(bytes32 role, address account) external nonpayable
Revokes 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
Name
Type
Description
role
bytes32
undefined
account
address
undefined
revokeRole
function revokeRole(bytes32 role, address account) external nonpayable
Revokes 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
Name
Type
Description
role
bytes32
undefined
account
address
undefined
safeBatchTransferFrom
function safeBatchTransferFrom(address from, address to, uint256[] ids, uint256[] amounts, bytes data) external nonpayable
See {IERC1155-safeBatchTransferFrom}.
Parameters
Name
Type
Description
from
address
undefined
to
address
undefined
ids
uint256[]
undefined
amounts
uint256[]
undefined
data
bytes
undefined
safeTransferFrom
function safeTransferFrom(address from, address to, uint256 id, uint256 amount, bytes data) external nonpayable
See {IERC1155-safeTransferFrom}.
Parameters
Name
Type
Description
from
address
undefined
to
address
undefined
id
uint256
undefined
amount
uint256
undefined
data
bytes
undefined
setApprovalForAll
function setApprovalForAll(address operator, bool approved) external nonpayable
See {IERC1155-setApprovalForAll}.
Parameters
Name
Type
Description
operator
address
undefined
approved
bool
undefined
setBaseURI
function setBaseURI(string baseURI) external nonpayable
See {ERC1155URIStorage-setBaseURI}
Parameters
Name
Type
Description
baseURI
string
The base URI to set. Requirements: - the caller must have the DEFAULT_ADMIN_ROLE.
setURI
function setURI(uint256 tokenId, string tokenURI) external nonpayable
See {ERC1155URIStorage-setURI}
Parameters
Name
Type
Description
tokenId
uint256
The token id to set the URI for.
tokenURI
string
The URI to set. Requirements: - the caller must have the DEFAULT_ADMIN_ROLE.
supportsInterface
function supportsInterface(bytes4 interfaceId) external view returns (bool)
See {IERC165-supportsInterface}.
Parameters
Name
Type
Description
interfaceId
bytes4
The interface identifier, as specified in ERC-165.
Returns
Name
Type
Description
_0
bool
undefined
totalSupply
function totalSupply(uint256 id) external view returns (uint256)
Total amount of tokens in with a given id.
Parameters
Name
Type
Description
id
uint256
undefined
Returns
Name
Type
Description
_0
uint256
undefined
totalSupplyBatch
function totalSupplyBatch(uint256[] ids) external view returns (uint256[])
Batched version of ERC1155SupplyUpgradeable-totalSupply.
Parameters
Name
Type
Description
ids
uint256[]
undefined
Returns
Name
Type
Description
_0
uint256[]
undefined
upgradeTo
function upgradeTo(address newImplementation) external nonpayable
Upgrade the implementation of the proxy to newImplementation. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.
Parameters
Name
Type
Description
newImplementation
address
undefined
upgradeToAndCall
function upgradeToAndCall(address newImplementation, bytes data) external payable
Upgrade the implementation of the proxy to newImplementation, and subsequently execute the function call encoded in data. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.
Parameters
Name
Type
Description
newImplementation
address
undefined
data
bytes
undefined
uri
function uri(uint256 id) external view returns (string)
Emitted when newAdminRole is set as role's admin role, replacing previousAdminRoleDEFAULT_ADMIN_ROLE is the starting admin for all roles, despite {RoleAdminChanged} not being emitted signaling this. _Available since v3.1._
Emitted when account is granted role. sender is the account that originated the contract call, an admin role bearer except when using {AccessControl-_setupRole}.
Emitted when account is revoked role. sender is the account that originated the contract call: - if using revokeRole, it is the admin role bearer - if using renounceRole, it is the role bearer (i.e. account)
Emitted when value tokens of token type id are transferred from from to to by operator.
Parameters
Name
Type
Description
operator indexed
address
undefined
from indexed
address
undefined
to indexed
address
undefined
id
uint256
undefined
value
uint256
undefined
URI
event URI(string value, uint256 indexed id)
Emitted when the URI for token type id changes to value, if it is a non-programmatic URI. If an {URI} event was emitted for id, the standard https://eips.ethereum.org/EIPS/eip-1155#metadata-extensions[guarantees] that value will equal the value returned by {IERC1155MetadataURI-uri}.