BurnByPartitionFacet

Asset Tokenization Studio Team

BurnByPartitionFacet

Diamond facet exposing the ERC-1410 redeemByPartition operation, registered under RESOLVER_KEY_BURN_BY_PARTITION.

Inherits the redemption logic from BurnByPartition and satisfies the IStaticFunctionSelectors contract required by the Diamond proxy for static selector registration. Exposes one selector: redeemByPartition. No library links are required for deployment beyond TokenCoreOps.

Methods

getStaticFunctionSelectors

function getStaticFunctionSelectors() external pure returns (bytes4[])

Gets all function selectors of a facet

Returns

Name	Type	Description
_0	bytes4[]	Face functions selectors

getStaticInterfaceIds

function getStaticInterfaceIds() external pure returns (bytes4[])

Gets all interfaces ids of a facet.

Returns

Name	Type	Description
_0	bytes4[]	Face interface ids

getStaticResolverKey

function getStaticResolverKey() external pure returns (bytes32 staticResolverKey_)

Gets the static resolver key

Returns

Name	Type	Description
staticResolverKey_	bytes32	Static resolver key

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.

Errors

AccountHasNoRole

error AccountHasNoRole(address account, bytes32 role)

Thrown when an account does not hold a required role.

Parameters

Name	Type	Description
account	address	The account that lacks the role.
role	bytes32	The role that is not held.

AssetNotOperational

error AssetNotOperational(bytes32 configId, uint256 versionId)

Raised by InitializerStorageWrapper.checkOperational (and the related isConfigVersionOperational helper) when an operation is attempted on a configuration version that has not yet been marked operational.

Parameters

Name	Type	Description
configId	bytes32	Resolver-proxy configuration whose operational status was checked.
versionId	uint256	Configuration version whose operational status was checked.

Deactivated

error Deactivated()

Thrown when an operation guarded by onlyActivated is attempted on a token whose deactivation flag has already been set.

FacetAlreadyRegistered

error FacetAlreadyRegistered(bytes32 facetId, uint256 lastVersion)

Raised when an initialiser tries to register a facet that already has a non-zero last registered version (i.e. the facet is being re-initialised on a fresh install).

Parameters

Name	Type	Description
facetId	bytes32	Identifier of the offending facet.
lastVersion	uint256	Last version recorded for that facet at the time of the check.

PartitionNotAllowedInSinglePartitionMode

error PartitionNotAllowedInSinglePartitionMode(bytes32 partition)

Thrown when a multi-partition operation specifies a partition not permitted in single-partition mode.

Parameters

Name	Type	Description
partition	bytes32	The disallowed partition supplied by the caller.

PartitionsAreProtectedAndNoRole

error PartitionsAreProtectedAndNoRole(address account, bytes32 role)

Reverts when a transfer is attempted while partitions are protected and the caller does not hold the required partition role.

Parameters

Name	Type	Description
account	address	The caller lacking the required role.
role	bytes32	The role that would have been needed to proceed.

UnrecognizedResolverProxyVersion

error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)

Thrown when the provided proxy version does not match any BLR compatible standard.

Parameters

Name	Type	Description
_resolverProxyVersion	bytes8	proxy version that is not compatible with the BLR.

WalletRecovered

error WalletRecovered()

Thrown when attempting to recover a wallet that has already been recovered.