This ERC defines standard functions for granular approval of ERC-1155 tokens by both id and amount. This ERC extends ERC-1155.
ERC-1155's popularity means that multi-token management transactions occur on a daily basis. Although it can be used as a more comprehensive alternative to ERC-721, ERC-1155 is most commonly used as intended: creating multiple ids, each with multiple tokens. While many projects interface with these semi-fungible tokens, by far the most common interactions are with NFT marketplaces.
Due to the nature of the blockchain, programming errors or malicious operators can cause permanent loss of funds. It is therefore essential that transactions are as trustless as possible. ERC-1155 uses the setApprovalForAll function, which approves ALL tokens with a specific id. This system has obvious minimum required trust flaws. This ERC combines ideas from ERC-20 and ERC-721 in order to create a trust mechanism where an owner can allow a third party, such as a marketplace, to approve a limited (instead of unlimited) number of tokens of one id.
The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.
Contracts using this ERC MUST implement the IERC5216 interface.
The approve(address operator, uint256 id, uint256 amount) function MUST be either public or external.
The allowance(address account, address operator, uint256 id) function MUST be either public or external and MUST be view.
The safeTrasferFrom function (as defined by ERC-1155) MUST:
msg.sender with a sufficient amountmsg.sender is not approved with setApprovalForAllIn addition, the safeBatchTransferFrom MUST:
allowance of all ids have the approved amounts (See _checkApprovalForBatch function reference implementation)The Approval event MUST be emitted when a certain number of tokens are approved.
The supportsInterface method MUST return true when called with 0x1be07d74.
The name "ERC-1155 Allowance Extension" was chosen because it is a succinct description of this ERC. Users can approve their tokens by id and amount to operators.
By having a way to approve and revoke in a manner similar to ERC-20, the trust level can be more directly managed by users:
approve function, users can approve an operator to spend an amount of tokens for each id.allowance function, users can see the approval that an operator has for each id.The ERC-20 name patterns were used due to similarities with ERC-20 approvals.
This standard is compatible with ERC-1155.
The reference implementation can be found here.
Users of this ERC must thoroughly consider the amount of tokens they give permission to operators, and should revoke unused authorizations.
Copyright and related rights waived via CC0.