README.adoc 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839
  1. = ERC 721
  2. [.readme-notice]
  3. NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/token/erc721
  4. This set of interfaces, contracts, and utilities are all related to the https://eips.ethereum.org/EIPS/eip-721[ERC721 Non-Fungible Token Standard].
  5. TIP: For a walkthrough on how to create an ERC721 token read our xref:ROOT:erc721.adoc[ERC721 guide].
  6. The EIP consists of three interfaces, found here as {IERC721}, {IERC721Metadata}, and {IERC721Enumerable}. Only the first one is required in a contract to be ERC721 compliant. However, all three are implemented in {ERC721}.
  7. Additionally, {IERC721Receiver} can be used to prevent tokens from becoming forever locked in contracts. Imagine sending an in-game item to an exchange address that can't send it back!. When using <<IERC721-safeTransferFrom,`safeTransferFrom`>>, the token contract checks to see that the receiver is an {IERC721Receiver}, which implies that it knows how to handle {ERC721} tokens. If you're writing a contract that needs to receive {ERC721} tokens, you'll want to include this interface.
  8. Additionally there are multiple custom extensions, including:
  9. * designation of addresses that can pause token transfers for all users ({ERC721Pausable}).
  10. * destruction of own tokens ({ERC721Burnable}).
  11. == Core
  12. {{IERC721}}
  13. {{IERC721Metadata}}
  14. {{IERC721Enumerable}}
  15. {{ERC721}}
  16. {{IERC721Receiver}}
  17. == Extensions
  18. {{ERC721Pausable}}
  19. {{ERC721Burnable}}
  20. == Convenience
  21. {{ERC721Holder}}