IBurnByPartition

Asset Tokenization Studio Team

IBurnByPartition

Interface for the partition-aware token redemption entry point of the ATS Diamond.

Exposes redeemByPartition which follows the ERC-1410 standard for redeeming (burning) tokens from a specific partition. The operation decreases the total supply and the partition supply and emits the RedeemedByPartition event.

Methods

initializeBurnByPartition

function initializeBurnByPartition() external nonpayable

Initialises the burn by partition capability on the token.

Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.

redeemByPartition

function redeemByPartition(bytes32 _partition, uint256 _value, bytes _data) external nonpayable

Decreases totalSupply and the corresponding amount of the specified partition of msg.sender

Only callable when not paused. In single-partition mode only the default partition is accepted. The caller must pass redemption authorization checks for the given partition and amount.

Parameters

Name	Type	Description
_partition	bytes32	The partition from which to redeem tokens
_value	uint256	The amount of tokens to redeem
_data	bytes	Additional data attached to the redemption

Events

BurnByPartitionInitialized

event BurnByPartitionInitialized()

Emitted once when the burn by partition capability is initialised on a token.

Fires exclusively from initializeBurnByPartition.