ERC-1155 Burn Facet

Burn ERC-1155 tokens within a diamond

Key Features

• Provides external functions for burning single and batch ERC-1155 tokens.
• Leverages diamond storage for token balances and operator approvals.
• Emits TransferSingle and TransferBatch events upon successful burns.
• Includes exportSelectors for facet discovery within a diamond.

Overview

This facet provides external functions for burning ERC-1155 tokens within a Compose diamond. It routes calls through the diamond proxy, accesses shared storage via getStorage, and emits standard ERC-1155 transfer events. Developers add this facet to enable token burning functionality while maintaining diamond upgradeability.

Storage

ERC1155Storage

Definition

struct ERC1155Storage {
  mapping(uint256 id => mapping(address account => uint256 balance)) balanceOf;
  mapping(address account => mapping(address operator => bool)) isApprovedForAll;
}

State Variables

Property	Type	Description
STORAGE_POSITION	bytes32	Diamond storage slot position for this module (Value: keccak256("erc1155"))

Functions

burn

Burns a single token type from an address. Emits a TransferSingle event. Caller must be the owner or an approved operator.

function burn(address _from, uint256 _id, uint256 _value) external;

Parameters:

Property	Type	Description
_from	address	The address whose tokens will be burned.
_id	uint256	The token type to burn.
_value	uint256	The amount of tokens to burn.

---

burnBatch

Burns multiple token types from an address in a single transaction. Emits a TransferBatch event. Caller must be the owner or an approved operator.

function burnBatch(address _from, uint256[] calldata _ids, uint256[] calldata _values) external;

Parameters:

Property	Type	Description
_from	address	The address whose tokens will be burned.
_ids	uint256[]	The token types to burn.
_values	uint256[]	The amounts of tokens to burn for each type.

---

exportSelectors

Exports the function selectors of the ERC1155BurnFacet This function is use as a selector discovery mechanism for diamonds

function exportSelectors() external pure returns (bytes memory);

Returns:

Property	Type	Description
-	bytes	selectors The exported function selectors of the ERC1155BurnFacet

Events

Emitted when value amount of tokens of type id are transferred from from to to by operator.

Signature:

event TransferSingle(
  address indexed _operator, address indexed _from, address indexed _to, uint256 _id, uint256 _value
);

Parameters:

Property	Type	Description
_operator	address	The address which initiated the transfer.
_from	address	The address which previously owned the token.
_to	address	The address which now owns the token.
_id	uint256	The token type being transferred.
_value	uint256	The amount of tokens transferred.

Equivalent to multiple TransferSingle events, where operator, from and to are the same for all transfers.

Signature:

event TransferBatch(
  address indexed _operator, address indexed _from, address indexed _to, uint256[] _ids, uint256[] _values
);

Parameters:

Property	Type	Description
_operator	address	The address which initiated the batch transfer.
_from	address	The address which previously owned the tokens.
_to	address	The address which now owns the tokens.
_ids	uint256[]	The token types being transferred.
_values	uint256[]	The amounts of tokens transferred.

Errors

Error indicating insufficient balance for a burn operation.

Signature:

error ERC1155InsufficientBalance(address _sender, uint256 _balance, uint256 _needed, uint256 _tokenId);

Error indicating the sender address is invalid.

Signature:

error ERC1155InvalidSender(address _sender);

Error indicating array length mismatch in batch operations.

Signature:

error ERC1155InvalidArrayLength(uint256 _idsLength, uint256 _valuesLength);

Error indicating missing approval for an operator.

Signature:

error ERC1155MissingApprovalForAll(address _operator, address _owner);

Best Practices

Best Practice

• Ensure the ERC1155BurnFacet is properly initialized with correct storage slot.
• Caller must possess the token or be an approved operator before calling burn functions.
• Verify that _ids and _values arrays have matching lengths before calling burnBatch.

Security Considerations

Security

The burn and burnBatch functions require the caller to be the owner of the tokens or an approved operator. Insufficient balance will revert with ERC1155InsufficientBalance. Mismatched array lengths in burnBatch will revert with ERC1155InvalidArrayLength. Ensure that the diamond's access control mechanism correctly routes calls and that token ownership logic is consistent across all relevant facets.

Was this helpful?

Last updated:March 13, 2026