TokenERC1155

Methods

DEFAULT_ADMIN_ROLE

function DEFAULT_ADMIN_ROLE() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	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

burn

function burn(address account, uint256 id, uint256 value) external nonpayable

Lets a token owner burn the tokens they own (i.e. destroy for good)

Parameters

Name	Type	Description
account	address	undefined
id	uint256	undefined
value	uint256	undefined

burnBatch

function burnBatch(address account, uint256[] ids, uint256[] values) external nonpayable

Lets a token owner burn multiple tokens they own at once (i.e. destroy for good)

Parameters

Name	Type	Description
account	address	undefined
ids	uint256[]	undefined
values	uint256[]	undefined

contractType

function contractType() external pure returns (bytes32)

Returns the module type of the contract.

Returns

Name	Type	Description
_0	bytes32	undefined

contractURI

function contractURI() external view returns (string)

Contract level metadata.

Returns

Name	Type	Description
_0	string	undefined

contractVersion

function contractVersion() external pure returns (uint8)

Returns the version of the contract.

Returns

Name	Type	Description
_0	uint8	undefined

getDefaultRoyaltyInfo

function getDefaultRoyaltyInfo() external view returns (address, uint16)

Returns default royalty info.

Returns

Name	Type	Description
_0	address	undefined
_1	uint16	undefined

getFlatPlatformFeeInfo

function getFlatPlatformFeeInfo() external view returns (address, uint256)

Returns the flat platform fee and recipient.

Returns

Name	Type	Description
_0	address	undefined
_1	uint256	undefined

getPlatformFeeInfo

function getPlatformFeeInfo() external view returns (address, uint16)

Returns the platform fee bps and recipient.

Returns

Name	Type	Description
_0	address	undefined
_1	uint16	undefined

getPlatformFeeType

function getPlatformFeeType() external view returns (enum TokenERC1155.PlatformFeeType)

Returns the platform fee type.

Returns

Name	Type	Description
_0	enum TokenERC1155.PlatformFeeType	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

getRoyaltyInfoForToken

function getRoyaltyInfoForToken(uint256 _tokenId) external view returns (address, uint16)

Returns the royalty recipient for a particular token Id.

Parameters

Name	Type	Description
_tokenId	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined
_1	uint16	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)

Returns true if account has been granted role.

Parameters

Name	Type	Description
role	bytes32	undefined
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

initialize

function initialize(address _defaultAdmin, string _name, string _symbol, string _contractURI, address[] _trustedForwarders, address _primarySaleRecipient, address _royaltyRecipient, uint128 _royaltyBps, uint128 _platformFeeBps, address _platformFeeRecipient) external nonpayable

Initiliazes the contract, like a constructor.

Parameters

Name	Type	Description
_defaultAdmin	address	undefined
_name	string	undefined
_symbol	string	undefined
_contractURI	string	undefined
_trustedForwarders	address[]	undefined
_primarySaleRecipient	address	undefined
_royaltyRecipient	address	undefined
_royaltyBps	uint128	undefined
_platformFeeBps	uint128	undefined
_platformFeeRecipient	address	undefined

isApprovedForAll

function isApprovedForAll(address account, address operator) external view returns (bool)

See {IERC1155-isApprovedForAll}.

Parameters

Name	Type	Description
account	address	undefined
operator	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

isTrustedForwarder

function isTrustedForwarder(address forwarder) external view returns (bool)

Parameters

Name	Type	Description
forwarder	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

mintTo

function mintTo(address _to, uint256 _tokenId, string _uri, uint256 _amount) external nonpayable

Lets an account with MINTER_ROLE mint an NFT.

Parameters

Name	Type	Description
_to	address	undefined
_tokenId	uint256	undefined
_uri	string	undefined
_amount	uint256	undefined

mintWithSignature

function mintWithSignature(ITokenERC1155.MintRequest _req, bytes _signature) external payable

Parameters

Name	Type	Description
_req	ITokenERC1155.MintRequest	undefined
_signature	bytes	undefined

multicall

function multicall(bytes[] data) external nonpayable returns (bytes[] results)

Receives and executes a batch of function calls on this contract.

Parameters

Name	Type	Description
data	bytes[]	undefined

Returns

Name	Type	Description
results	bytes[]	undefined

name

function name() external view returns (string)

Returns

Name	Type	Description
_0	string	undefined

nextTokenIdToMint

function nextTokenIdToMint() external view returns (uint256)

The next token ID of the NFT to mint.

Returns

Name	Type	Description
_0	uint256	undefined

operatorRestriction

function operatorRestriction() external view returns (bool)

Returns

Name	Type	Description
_0	bool	undefined

owner

function owner() external view returns (address)

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

platformFeeRecipient

function platformFeeRecipient() external view returns (address)

The adress that receives all primary sales value.

Returns

Name	Type	Description
_0	address	undefined

primarySaleRecipient

function primarySaleRecipient() external view returns (address)

The adress that receives all primary sales value.

Returns

Name	Type	Description
_0	address	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

royaltyInfo

function royaltyInfo(uint256 tokenId, uint256 salePrice) external view returns (address receiver, uint256 royaltyAmount)

See EIP-2981

Parameters

Name	Type	Description
tokenId	uint256	undefined
salePrice	uint256	undefined

Returns

Name	Type	Description
receiver	address	undefined
royaltyAmount	uint256	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

saleRecipientForToken

function saleRecipientForToken(uint256) external view returns (address)

Token ID => the address of the recipient of primary sales.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	address	undefined

setApprovalForAll

function setApprovalForAll(address operator, bool approved) external nonpayable

See {ERC1155-setApprovalForAll}

Parameters

Name	Type	Description
operator	address	undefined
approved	bool	undefined

setContractURI

function setContractURI(string _uri) external nonpayable

Lets a module admin set the URI for contract-level metadata.

Parameters

Name	Type	Description
_uri	string	undefined

setDefaultRoyaltyInfo

function setDefaultRoyaltyInfo(address _royaltyRecipient, uint256 _royaltyBps) external nonpayable

Lets a module admin update the royalty bps and recipient.

Parameters

Name	Type	Description
_royaltyRecipient	address	undefined
_royaltyBps	uint256	undefined

setFlatPlatformFeeInfo

function setFlatPlatformFeeInfo(address _platformFeeRecipient, uint256 _flatFee) external nonpayable

Lets a module admin set a flat fee on primary sales.

Parameters

Name	Type	Description
_platformFeeRecipient	address	undefined
_flatFee	uint256	undefined

setOperatorRestriction

function setOperatorRestriction(bool _restriction) external nonpayable

Parameters

Name	Type	Description
_restriction	bool	undefined

setOwner

function setOwner(address _newOwner) external nonpayable

Lets a module admin set a new owner for the contract. The new owner must be a module admin.

Parameters

Name	Type	Description
_newOwner	address	undefined

setPlatformFeeInfo

function setPlatformFeeInfo(address _platformFeeRecipient, uint256 _platformFeeBps) external nonpayable

Lets a module admin update the fees on primary sales.

Parameters

Name	Type	Description
_platformFeeRecipient	address	undefined
_platformFeeBps	uint256	undefined

setPlatformFeeType

function setPlatformFeeType(enum TokenERC1155.PlatformFeeType _feeType) external nonpayable

Lets a module admin set a flat fee on primary sales.

Parameters

Name	Type	Description
_feeType	enum TokenERC1155.PlatformFeeType	undefined

setPrimarySaleRecipient

function setPrimarySaleRecipient(address _saleRecipient) external nonpayable

Lets a module admin set the default recipient of all primary sales.

Parameters

Name	Type	Description
_saleRecipient	address	undefined

setRoyaltyInfoForToken

function setRoyaltyInfoForToken(uint256 _tokenId, address _recipient, uint256 _bps) external nonpayable

Lets a module admin set the royalty recipient for a particular token Id.

Parameters

Name	Type	Description
_tokenId	uint256	undefined
_recipient	address	undefined
_bps	uint256	undefined

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

symbol

function symbol() external view returns (string)

Returns

Name	Type	Description
_0	string	undefined

totalSupply

function totalSupply(uint256) external view returns (uint256)

Token ID => total circulating supply of tokens with that ID.

Parameters

Name	Type	Description
_0	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

uri

function uri(uint256 _tokenId) external view returns (string)

Returns the URI for a tokenId

Parameters

Name	Type	Description
_tokenId	uint256	undefined

Returns

Name	Type	Description
_0	string	undefined

verify

function verify(ITokenERC1155.MintRequest _req, bytes _signature) external view returns (bool, address)

Parameters

Name	Type	Description
_req	ITokenERC1155.MintRequest	undefined
_signature	bytes	undefined

Returns

Name	Type	Description
_0	bool	undefined
_1	address	undefined

Events

ApprovalForAll

event ApprovalForAll(address indexed account, address indexed operator, bool approved)

Parameters

Name	Type	Description
account indexed	address	undefined
operator indexed	address	undefined
approved	bool	undefined

DefaultRoyalty

event DefaultRoyalty(address indexed newRoyaltyRecipient, uint256 newRoyaltyBps)

Parameters

Name	Type	Description
newRoyaltyRecipient indexed	address	undefined
newRoyaltyBps	uint256	undefined

FlatPlatformFeeUpdated

event FlatPlatformFeeUpdated(address platformFeeRecipient, uint256 flatFee)

Emitted when flat fee on primary sales is updated.

Parameters

Name	Type	Description
platformFeeRecipient	address	undefined
flatFee	uint256	undefined

Initialized

event Initialized(uint8 version)

Parameters

Name	Type	Description
version	uint8	undefined

OperatorRestriction

event OperatorRestriction(bool restriction)

Parameters

Name	Type	Description
restriction	bool	undefined

OwnerUpdated

event OwnerUpdated(address indexed prevOwner, address indexed newOwner)

Parameters

Name	Type	Description
prevOwner indexed	address	undefined
newOwner indexed	address	undefined

PlatformFeeInfoUpdated

event PlatformFeeInfoUpdated(address indexed platformFeeRecipient, uint256 platformFeeBps)

Parameters

Name	Type	Description
platformFeeRecipient indexed	address	undefined
platformFeeBps	uint256	undefined

PlatformFeeTypeUpdated

event PlatformFeeTypeUpdated(enum TokenERC1155.PlatformFeeType feeType)

Emitted when platform fee type is updated.

Parameters

Name	Type	Description
feeType	enum TokenERC1155.PlatformFeeType	undefined

PrimarySaleRecipientUpdated

event PrimarySaleRecipientUpdated(address indexed recipient)

Parameters

Name	Type	Description
recipient indexed	address	undefined

RoleAdminChanged

event RoleAdminChanged(bytes32 indexed role, bytes32 indexed previousAdminRole, bytes32 indexed newAdminRole)

Parameters

Name	Type	Description
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

Name	Type	Description
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

Name	Type	Description
role indexed	bytes32	undefined
account indexed	address	undefined
sender indexed	address	undefined

RoyaltyForToken

event RoyaltyForToken(uint256 indexed tokenId, address indexed royaltyRecipient, uint256 royaltyBps)

Parameters

Name	Type	Description
tokenId indexed	uint256	undefined
royaltyRecipient indexed	address	undefined
royaltyBps	uint256	undefined

TokensMinted

event TokensMinted(address indexed mintedTo, uint256 indexed tokenIdMinted, string uri, uint256 quantityMinted)

Parameters

Name	Type	Description
mintedTo indexed	address	undefined
tokenIdMinted indexed	uint256	undefined
uri	string	undefined
quantityMinted	uint256	undefined

TokensMintedWithSignature

event TokensMintedWithSignature(address indexed signer, address indexed mintedTo, uint256 indexed tokenIdMinted, ITokenERC1155.MintRequest mintRequest)

Parameters

Name	Type	Description
signer indexed	address	undefined
mintedTo indexed	address	undefined
tokenIdMinted indexed	uint256	undefined
mintRequest	ITokenERC1155.MintRequest	undefined

TransferBatch

event TransferBatch(address indexed operator, address indexed from, address indexed to, uint256[] ids, uint256[] values)

Parameters

Name	Type	Description
operator indexed	address	undefined
from indexed	address	undefined
to indexed	address	undefined
ids	uint256[]	undefined
values	uint256[]	undefined

TransferSingle

event TransferSingle(address indexed operator, address indexed from, address indexed to, uint256 id, uint256 value)

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)

Parameters

Name	Type	Description
value	string	undefined
id indexed	uint256	undefined

Errors

OperatorNotAllowed

error OperatorNotAllowed(address operator)

Parameters

Name	Type	Description
operator	address	undefined