Francisco Giordano 99a4cfca17 Replace error strings with custom errors (#4261) 2 years ago
..
extensions 99a4cfca17 Replace error strings with custom errors (#4261) 2 years ago
utils 7bb5592ad5 Bump minimum pragma version to `0.8.19` (#4288) 2 years ago
ERC1155.sol 99a4cfca17 Replace error strings with custom errors (#4261) 2 years ago
IERC1155.sol 7bb5592ad5 Bump minimum pragma version to `0.8.19` (#4288) 2 years ago
IERC1155Receiver.sol 7bb5592ad5 Bump minimum pragma version to `0.8.19` (#4288) 2 years ago
README.adoc 4a9db80cb9 Remove presets (#3637) 2 years ago

README.adoc

= ERC 1155

[.readme-notice]
NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/token/erc1155

This set of interfaces and contracts are all related to the https://eips.ethereum.org/EIPS/eip-1155[ERC1155 Multi Token Standard].

The EIP consists of three interfaces which fulfill different roles, found here as {IERC1155}, {IERC1155MetadataURI} and {IERC1155Receiver}.

{ERC1155} implements the mandatory {IERC1155} interface, as well as the optional extension {IERC1155MetadataURI}, by relying on the substitution mechanism to use the same URI for all token types, dramatically reducing gas costs.

Additionally there are multiple custom extensions, including:

* designation of addresses that can pause token transfers for all users ({ERC1155Pausable}).
* destruction of own tokens ({ERC1155Burnable}).

NOTE: This core set of contracts is designed to be unopinionated, allowing developers to access the internal functions in ERC1155 (such as <>) and expose them as external functions in the way they prefer.

== Core

{{IERC1155}}

{{IERC1155MetadataURI}}

{{ERC1155}}

{{IERC1155Receiver}}

{{ERC1155Receiver}}

== Extensions

{{ERC1155Pausable}}

{{ERC1155Burnable}}

{{ERC1155Supply}}

{{ERC1155URIStorage}}

== Utilities

{{ERC1155Holder}}