> For the complete documentation index, see [llms.txt](https://docs.fringe.fi/smart-contract-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.fringe.fi/smart-contract-documentation/openzeppelin/contracts-upgradeable/token/erc-721/presets/erc721presetminterpauserautoidupgradeable.md). # ERC 721 Preset Minter Pauser Auto Id Upgradeable *{ERC721} token, including: - ability for holders to burn (destroy) their tokens - a minter role that allows for token minting (creation) - a pauser role that allows to stop all token transfers - token ID and URI autogeneration This contract uses {AccessControl} to lock permissioned functions using the different roles - head to its documentation for details. The account that deploys the contract will be granted the minter and pauser roles, as well as the default admin role, which will let it grant both minter and pauser roles to other accounts.* ## Methods ### DEFAULT\_ADMIN\_ROLE ```solidity function DEFAULT_ADMIN_ROLE() external view returns (bytes32) ``` #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | bytes32 | undefined | ### MINTER\_ROLE ```solidity function MINTER_ROLE() external view returns (bytes32) ``` #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | bytes32 | undefined | ### PAUSER\_ROLE ```solidity function PAUSER_ROLE() external view returns (bytes32) ``` #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | bytes32 | undefined | ### approve ```solidity function approve(address to, uint256 tokenId) external nonpayable ``` *See {IERC721-approve}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | to | address | undefined | | tokenId | uint256 | undefined | ### balanceOf ```solidity function balanceOf(address owner) external view returns (uint256) ``` *See {IERC721-balanceOf}.* #### Parameters | Name | Type | Description | | ----- | ------- | ----------- | | owner | address | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### burn ```solidity function burn(uint256 tokenId) external nonpayable ``` *Burns `tokenId`. See {ERC721-\_burn}. Requirements: - The caller must own `tokenId` or be an approved operator.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | tokenId | uint256 | undefined | ### getApproved ```solidity function getApproved(uint256 tokenId) external view returns (address) ``` *See {IERC721-getApproved}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | tokenId | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | address | undefined | ### getRoleAdmin ```solidity 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 ```solidity 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 post] for more information.* #### Parameters | Name | Type | Description | | ----- | ------- | ----------- | | role | bytes32 | undefined | | index | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | address | undefined | ### getRoleMemberCount ```solidity 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 ```solidity function grantRole(bytes32 role, address account) external nonpayable ``` *Overload {grantRole} to track enumerable memberships* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | role | bytes32 | undefined | | account | address | undefined | ### hasRole ```solidity 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 ```solidity function initialize(string name, string symbol, string baseTokenURI) external nonpayable ``` #### Parameters | Name | Type | Description | | ------------ | ------ | ----------- | | name | string | undefined | | symbol | string | undefined | | baseTokenURI | string | undefined | ### isApprovedForAll ```solidity function isApprovedForAll(address owner, address operator) external view returns (bool) ``` *See {IERC721-isApprovedForAll}.* #### Parameters | Name | Type | Description | | -------- | ------- | ----------- | | owner | address | undefined | | operator | address | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### mint ```solidity function mint(address to) external nonpayable ``` *Creates a new token for `to`. Its token ID will be automatically assigned (and available on the emitted {IERC721-Transfer} event), and the token URI autogenerated based on the base URI passed at construction. See {ERC721-\_mint}. Requirements: - the caller must have the `MINTER_ROLE`.* #### Parameters | Name | Type | Description | | ---- | ------- | ----------- | | to | address | undefined | ### name ```solidity function name() external view returns (string) ``` *See {IERC721Metadata-name}.* #### Returns | Name | Type | Description | | ---- | ------ | ----------- | | \_0 | string | undefined | ### ownerOf ```solidity function ownerOf(uint256 tokenId) external view returns (address) ``` *See {IERC721-ownerOf}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | tokenId | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | address | undefined | ### pause ```solidity function pause() external nonpayable ``` *Pauses all token transfers. See {ERC721Pausable} and {Pausable-\_pause}. Requirements: - the caller must have the `PAUSER_ROLE`.* ### paused ```solidity function paused() external view returns (bool) ``` *Returns true if the contract is paused, and false otherwise.* #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### renounceRole ```solidity function renounceRole(bytes32 role, address account) external nonpayable ``` *Overload {renounceRole} to track enumerable memberships* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | role | bytes32 | undefined | | account | address | undefined | ### revokeRole ```solidity function revokeRole(bytes32 role, address account) external nonpayable ``` *Overload {revokeRole} to track enumerable memberships* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | role | bytes32 | undefined | | account | address | undefined | ### safeTransferFrom ```solidity function safeTransferFrom(address from, address to, uint256 tokenId) external nonpayable ``` *See {IERC721-safeTransferFrom}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | from | address | undefined | | to | address | undefined | | tokenId | uint256 | undefined | ### safeTransferFrom ```solidity function safeTransferFrom(address from, address to, uint256 tokenId, bytes _data) external nonpayable ``` *See {IERC721-safeTransferFrom}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | from | address | undefined | | to | address | undefined | | tokenId | uint256 | undefined | | \_data | bytes | undefined | ### setApprovalForAll ```solidity function setApprovalForAll(address operator, bool approved) external nonpayable ``` *See {IERC721-setApprovalForAll}.* #### Parameters | Name | Type | Description | | -------- | ------- | ----------- | | operator | address | undefined | | approved | bool | undefined | ### supportsInterface ```solidity function supportsInterface(bytes4 interfaceId) external view returns (bool) ``` *See {IERC165-supportsInterface}.* #### Parameters | Name | Type | Description | | ----------- | ------ | ----------- | | interfaceId | bytes4 | undefined | #### Returns | Name | Type | Description | | ---- | ---- | ----------- | | \_0 | bool | undefined | ### symbol ```solidity function symbol() external view returns (string) ``` *See {IERC721Metadata-symbol}.* #### Returns | Name | Type | Description | | ---- | ------ | ----------- | | \_0 | string | undefined | ### tokenByIndex ```solidity function tokenByIndex(uint256 index) external view returns (uint256) ``` *See {IERC721Enumerable-tokenByIndex}.* #### Parameters | Name | Type | Description | | ----- | ------- | ----------- | | index | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### tokenOfOwnerByIndex ```solidity function tokenOfOwnerByIndex(address owner, uint256 index) external view returns (uint256) ``` *See {IERC721Enumerable-tokenOfOwnerByIndex}.* #### Parameters | Name | Type | Description | | ----- | ------- | ----------- | | owner | address | undefined | | index | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### tokenURI ```solidity function tokenURI(uint256 tokenId) external view returns (string) ``` *See {IERC721Metadata-tokenURI}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | tokenId | uint256 | undefined | #### Returns | Name | Type | Description | | ---- | ------ | ----------- | | \_0 | string | undefined | ### totalSupply ```solidity function totalSupply() external view returns (uint256) ``` *See {IERC721Enumerable-totalSupply}.* #### Returns | Name | Type | Description | | ---- | ------- | ----------- | | \_0 | uint256 | undefined | ### transferFrom ```solidity function transferFrom(address from, address to, uint256 tokenId) external nonpayable ``` *See {IERC721-transferFrom}.* #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | from | address | undefined | | to | address | undefined | | tokenId | uint256 | undefined | ### unpause ```solidity function unpause() external nonpayable ``` *Unpauses all token transfers. See {ERC721Pausable} and {Pausable-\_unpause}. Requirements: - the caller must have the `PAUSER_ROLE`.* ## Events ### Approval ```solidity event Approval(address indexed owner, address indexed approved, uint256 indexed tokenId) ``` #### Parameters | Name | Type | Description | | ------------------ | ------- | ----------- | | owner `indexed` | address | undefined | | approved `indexed` | address | undefined | | tokenId `indexed` | uint256 | undefined | ### ApprovalForAll ```solidity event ApprovalForAll(address indexed owner, address indexed operator, bool approved) ``` #### Parameters | Name | Type | Description | | ------------------ | ------- | ----------- | | owner `indexed` | address | undefined | | operator `indexed` | address | undefined | | approved | bool | undefined | ### Paused ```solidity event Paused(address account) ``` #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | account | address | undefined | ### RoleAdminChanged ```solidity 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 ```solidity 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 ```solidity 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 | ### Transfer ```solidity event Transfer(address indexed from, address indexed to, uint256 indexed tokenId) ``` #### Parameters | Name | Type | Description | | ----------------- | ------- | ----------- | | from `indexed` | address | undefined | | to `indexed` | address | undefined | | tokenId `indexed` | uint256 | undefined | ### Unpaused ```solidity event Unpaused(address account) ``` #### Parameters | Name | Type | Description | | ------- | ------- | ----------- | | account | address | undefined |