|
| 1 | +// SPDX-License-Identifier: Apache-2.0 |
| 2 | +pragma solidity ^0.8.0; |
| 3 | + |
| 4 | +/** |
| 5 | + @title ERC-1155 Multi Token Standard |
| 6 | + @dev See https://github.com/ethereum/EIPs/blob/master/EIPS/eip-1155.md |
| 7 | + Note: The ERC-165 identifier for this interface is 0xd9b67a26. |
| 8 | + */ |
| 9 | +interface ERC1155 { |
| 10 | + /** |
| 11 | + @dev Either `TransferSingle` or `TransferBatch` MUST emit when tokens are transferred, including zero value transfers as well as minting or burning (see "Safe Transfer Rules" section of the standard). |
| 12 | + The `_operator` argument MUST be msg.sender. |
| 13 | + The `_from` argument MUST be the address of the holder whose balance is decreased. |
| 14 | + The `_to` argument MUST be the address of the recipient whose balance is increased. |
| 15 | + The `_id` argument MUST be the token type being transferred. |
| 16 | + The `_value` argument MUST be the number of tokens the holder balance is decreased by and match what the recipient balance is increased by. |
| 17 | + When minting/creating tokens, the `_from` argument MUST be set to `0x0` (i.e. zero address). |
| 18 | + When burning/destroying tokens, the `_to` argument MUST be set to `0x0` (i.e. zero address). |
| 19 | + */ |
| 20 | + event TransferSingle( |
| 21 | + address indexed _operator, |
| 22 | + address indexed _from, |
| 23 | + address indexed _to, |
| 24 | + uint256 _id, |
| 25 | + uint256 _value |
| 26 | + ); |
| 27 | + |
| 28 | + /** |
| 29 | + @dev Either `TransferSingle` or `TransferBatch` MUST emit when tokens are transferred, including zero value transfers as well as minting or burning (see "Safe Transfer Rules" section of the standard). |
| 30 | + The `_operator` argument MUST be msg.sender. |
| 31 | + The `_from` argument MUST be the address of the holder whose balance is decreased. |
| 32 | + The `_to` argument MUST be the address of the recipient whose balance is increased. |
| 33 | + The `_ids` argument MUST be the list of tokens being transferred. |
| 34 | + The `_values` argument MUST be the list of number of tokens (matching the list and order of tokens specified in _ids) the holder balance is decreased by and match what the recipient balance is increased by. |
| 35 | + When minting/creating tokens, the `_from` argument MUST be set to `0x0` (i.e. zero address). |
| 36 | + When burning/destroying tokens, the `_to` argument MUST be set to `0x0` (i.e. zero address). |
| 37 | + */ |
| 38 | + event TransferBatch( |
| 39 | + address indexed _operator, |
| 40 | + address indexed _from, |
| 41 | + address indexed _to, |
| 42 | + uint256[] _ids, |
| 43 | + uint256[] _values |
| 44 | + ); |
| 45 | + |
| 46 | + /** |
| 47 | + @dev MUST emit when approval for a second party/operator address to manage all tokens for an owner address is enabled or disabled (absense of an event assumes disabled). |
| 48 | + */ |
| 49 | + event ApprovalForAll(address indexed _owner, address indexed _operator, bool _approved); |
| 50 | + |
| 51 | + /** |
| 52 | + @dev MUST emit when the URI is updated for a token ID. |
| 53 | + URIs are defined in RFC 3986. |
| 54 | + The URI MUST point a JSON file that conforms to the "ERC-1155 Metadata URI JSON Schema". |
| 55 | + */ |
| 56 | + event URI(string _value, uint256 indexed _id); |
| 57 | + |
| 58 | + /** |
| 59 | + @notice Transfers `_value` amount of an `_id` from the `_from` address to the `_to` address specified (with safety call). |
| 60 | + @dev Caller must be approved to manage the tokens being transferred out of the `_from` account (see "Approval" section of the standard). |
| 61 | + MUST revert if `_to` is the zero address. |
| 62 | + MUST revert if balance of holder for token `_id` is lower than the `_value` sent. |
| 63 | + MUST revert on any other error. |
| 64 | + MUST emit the `TransferSingle` event to reflect the balance change (see "Safe Transfer Rules" section of the standard). |
| 65 | + After the above conditions are met, this function MUST check if `_to` is a smart contract (e.g. code size > 0). If so, it MUST call `onERC1155Received` on `_to` and act appropriately (see "Safe Transfer Rules" section of the standard). |
| 66 | + @param _from Source address |
| 67 | + @param _to Target address |
| 68 | + @param _id ID of the token type |
| 69 | + @param _value Transfer amount |
| 70 | + @param _data Additional data with no specified format, MUST be sent unaltered in call to `onERC1155Received` on `_to` |
| 71 | + */ |
| 72 | + function safeTransferFrom( |
| 73 | + address _from, |
| 74 | + address _to, |
| 75 | + uint256 _id, |
| 76 | + uint256 _value, |
| 77 | + bytes calldata _data |
| 78 | + ) external; |
| 79 | + |
| 80 | + /** |
| 81 | + @notice Transfers `_values` amount(s) of `_ids` from the `_from` address to the `_to` address specified (with safety call). |
| 82 | + @dev Caller must be approved to manage the tokens being transferred out of the `_from` account (see "Approval" section of the standard). |
| 83 | + MUST revert if `_to` is the zero address. |
| 84 | + MUST revert if length of `_ids` is not the same as length of `_values`. |
| 85 | + MUST revert if any of the balance(s) of the holder(s) for token(s) in `_ids` is lower than the respective amount(s) in `_values` sent to the recipient. |
| 86 | + MUST revert on any other error. |
| 87 | + MUST emit `TransferSingle` or `TransferBatch` event(s) such that all the balance changes are reflected (see "Safe Transfer Rules" section of the standard). |
| 88 | + Balance changes and events MUST follow the ordering of the arrays (_ids[0]/_values[0] before _ids[1]/_values[1], etc). |
| 89 | + After the above conditions for the transfer(s) in the batch are met, this function MUST check if `_to` is a smart contract (e.g. code size > 0). If so, it MUST call the relevant `ERC1155TokenReceiver` hook(s) on `_to` and act appropriately (see "Safe Transfer Rules" section of the standard). |
| 90 | + @param _from Source address |
| 91 | + @param _to Target address |
| 92 | + @param _ids IDs of each token type (order and length must match _values array) |
| 93 | + @param _values Transfer amounts per token type (order and length must match _ids array) |
| 94 | + @param _data Additional data with no specified format, MUST be sent unaltered in call to the `ERC1155TokenReceiver` hook(s) on `_to` |
| 95 | + */ |
| 96 | + function safeBatchTransferFrom( |
| 97 | + address _from, |
| 98 | + address _to, |
| 99 | + uint256[] calldata _ids, |
| 100 | + uint256[] calldata _values, |
| 101 | + bytes calldata _data |
| 102 | + ) external; |
| 103 | + |
| 104 | + /** |
| 105 | + @notice Get the balance of an account's Tokens. |
| 106 | + @param _owner The address of the token holder |
| 107 | + @param _id ID of the Token |
| 108 | + @return The _owner's balance of the Token type requested |
| 109 | + */ |
| 110 | + function balanceOf(address _owner, uint256 _id) external view returns (uint256); |
| 111 | + |
| 112 | + /** |
| 113 | + @notice Get the balance of multiple account/token pairs |
| 114 | + @param _owners The addresses of the token holders |
| 115 | + @param _ids ID of the Tokens |
| 116 | + @return The _owner's balance of the Token types requested (i.e. balance for each (owner, id) pair) |
| 117 | + */ |
| 118 | + function balanceOfBatch(address[] calldata _owners, uint256[] calldata _ids) |
| 119 | + external |
| 120 | + view |
| 121 | + returns (uint256[] memory); |
| 122 | + |
| 123 | + /** |
| 124 | + @notice Enable or disable approval for a third party ("operator") to manage all of the caller's tokens. |
| 125 | + @dev MUST emit the ApprovalForAll event on success. |
| 126 | + @param _operator Address to add to the set of authorized operators |
| 127 | + @param _approved True if the operator is approved, false to revoke approval |
| 128 | + */ |
| 129 | + function setApprovalForAll(address _operator, bool _approved) external; |
| 130 | + |
| 131 | + /** |
| 132 | + @notice Queries the approval status of an operator for a given owner. |
| 133 | + @param _owner The owner of the Tokens |
| 134 | + @param _operator Address of authorized operator |
| 135 | + @return True if the operator is approved, false if not |
| 136 | + */ |
| 137 | + function isApprovedForAll(address _owner, address _operator) external view returns (bool); |
| 138 | +} |
0 commit comments