Skip to main content

MaturityByPartition

Asset Tokenization Studio Team

MaturityByPartition

Abstract implementation of IMaturityByPartition providing single-partition maturity redemption with full modifier chain enforcement.

Methods​

initializeMaturityByPartition​

function initializeMaturityByPartition() external nonpayable

Initialises the maturity-by-partition capability on the token.

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

redeemAtMaturityByPartition​

function redeemAtMaturityByPartition(address _tokenHolder, bytes32 _partition, uint256 _amount) external nonpayable

Redeems a specified amount of tokens from a single partition at maturity.

Emits a Transfer event on successful redemption via ERC1410StorageWrapper.redeemByPartition.

Parameters​

NameTypeDescription
_tokenHolderaddressAddress of the token holder to redeem.
_partitionbytes32Partition identifier to redeem from.
_amountuint256Amount of tokens to redeem.

Events​

MaturityByPartitionInitialized​

event MaturityByPartitionInitialized()

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

Fires exclusively from initializeMaturityByPartition.

Errors​

AccountHasNoRole​

error AccountHasNoRole(address account, bytes32 role)

Thrown when an account does not hold a required role.

Parameters​

NameTypeDescription
accountaddressThe account that lacks the role.
rolebytes32The role that is not held.

AccountIsBlocked​

error AccountIsBlocked(address account)

Reverts when an operation targets or is requested by a blocked account.

The blocking policy is enforced by the domain that performs the check.

Parameters​

NameTypeDescription
accountaddressAccount rejected by the blocking validation.

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​

NameTypeDescription
configIdbytes32Resolver-proxy configuration whose operational status was checked.
versionIduint256Configuration version whose operational status was checked.

ClearingIsActivated​

error ClearingIsActivated()

Thrown when an administration action requires clearing to be inactive but it is currently enabled.

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​

NameTypeDescription
facetIdbytes32Identifier of the offending facet.
lastVersionuint256Last version recorded for that facet at the time of the check.

InvalidKycStatus​

error InvalidKycStatus()

IsPaused​

error IsPaused()

Thrown when an operation that requires the token to be unpaused is attempted while the token is paused (own flag or any external pause contract).

MaturityDateInvalid​

error MaturityDateInvalid()

Thrown when a maturity date fails validation.

Reverts when a proposed maturity date is not strictly in the future at the time it is set, or when a maturity-gated action is attempted before the stored maturity date has been reached.

PartitionNotAllowedInSinglePartitionMode​

error PartitionNotAllowedInSinglePartitionMode(bytes32 partition)

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

Parameters​

NameTypeDescription
partitionbytes32The disallowed partition supplied by the caller.

UnrecognizedResolverProxyVersion​

error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)

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

Parameters​

NameTypeDescription
_resolverProxyVersionbytes8proxy version that is not compatible with the BLR.

WalletRecovered​

error WalletRecovered()

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

ZeroAddressNotAllowed​

error ZeroAddressNotAllowed()

Reverts when the zero address is supplied where it is not permitted.

Prevents invalid account, contract, or recipient references.