ERC-1155 Burn Module

Internal ERC-1155 token burning functionality

Key Features

• All functions are internal for use within custom facets.
• Utilizes the diamond storage pattern for shared state management.
• Emits TransferSingle and TransferBatch events upon successful burns.
• Reverts with custom errors for insufficient balance or invalid array lengths.

Module Usage

This module provides internal functions for use in your custom facets. Import it to access shared logic and storage.

Overview

This module exposes internal functions for burning ERC-1155 tokens. Facets can import this module to decrease token balances using shared diamond storage. Changes made through this module are immediately visible to all facets using the same storage pattern.

Storage

ERC1155Storage

ERC-8042 compliant storage struct for ERC-1155 token data. storage-location: erc8042:erc1155

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. Decreases the balance and emits a TransferSingle event. Reverts if the account has insufficient balance. This module does not perform approval checks. Ensure proper ownership or approval validation before calling this function.

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

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. Decreases balances for each token type and emits a TransferBatch event. Reverts if the account has insufficient balance for any token type. This module does not perform approval checks. Ensure proper ownership or approval validation before calling this function.

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

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.

---

getStorage

Returns the ERC-1155 storage struct from the predefined diamond storage slot. Uses inline assembly to set the storage slot reference.

function getStorage() pure returns (ERC1155Storage storage s);

Returns:

Property	Type	Description
s	ERC1155Storage	The ERC-1155 storage struct reference.

Events

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.

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.

Errors

Title: ERC-1155 Burn Module Provides internal burn functionality for ERC-1155 tokens. Error indicating insufficient balance for a burn operation.

Signature:

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

Error indicating array length mismatch in batch operations.

Signature:

error ERC1155InvalidArrayLength(uint256 _idsLength, uint256 _valuesLength);

Error indicating the sender address is invalid.

Signature:

error ERC1155InvalidSender(address _sender);

Best Practices

Best Practice

• Ensure caller has necessary permissions (e.g., ownership, operator approval) before calling burn functions.
• Verify that _ids and _values arrays have matching lengths when calling burnBatch.
• Handle the ERC1155InsufficientBalance error that may be returned if the sender does not possess enough tokens.

Integration Notes

Shared Storage

This module interacts with diamond storage at the position identified by keccak256("erc1155"). The ERC1155Storage struct, though empty in its definition, resides at this slot. All state modifications (balance reductions) are performed directly on this shared storage, making them immediately visible to any other facet accessing the same storage slot. The getStorage function can be used to retrieve a reference to this storage struct.

Was this helpful?

Last updated:March 13, 2026