ClearingAtSnapshotByPartitionFacet

Asset Tokenization Studio Team

ClearingAtSnapshotByPartitionFacet

Diamond facet that exposes the snapshotted partition-scoped cleared-balance query through the IClearingAtSnapshotByPartition interface, registered under RESOLVER_KEY_CLEARING_AT_SNAPSHOT_BY_PARTITION.

Inherits read logic from ClearingAtSnapshotByPartition and satisfies IStaticFunctionSelectors for Diamond proxy selector registration. Exposes one selector: clearedBalanceOfAtSnapshotByPartition.

Methods

clearedBalanceOfAtSnapshotByPartition

function clearedBalanceOfAtSnapshotByPartition(bytes32 _partition, uint256 _snapshotID, address _tokenHolder) external view returns (uint256 balance_)

Returns the cleared balance of a token holder for a given partition at the time of a given snapshot.

Parameters

Name	Type	Description
_partition	bytes32	The partition identifier.
_snapshotID	uint256	The snapshot identifier returned by a prior takeSnapshot call.
_tokenHolder	address	The address of the token holder.

Returns

Name	Type	Description
balance_	uint256	The cleared balance of _tokenHolder in _partition recorded at _snapshotID.

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

initializeClearingAtSnapshotByPartition

function initializeClearingAtSnapshotByPartition() external nonpayable

Initialises the clearing-at-snapshot-by-partition capability on the token.

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

Events

ClearingAtSnapshotByPartitionInitialized

event ClearingAtSnapshotByPartitionInitialized()

Emitted once when the clearing-at-snapshot-by-partition capability is initialised on a token.

Fires exclusively from initializeClearingAtSnapshotByPartition.

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.

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.

SnapshotIdDoesNotExists

error SnapshotIdDoesNotExists(uint256 snapshotId)

Thrown when the requested snapshot identifier has never been taken on this token.

Parameters

Name	Type	Description
snapshotId	uint256	The unrecognised snapshot identifier that was supplied.

SnapshotIdNull

error SnapshotIdNull()

Thrown when a snapshot identifier of zero is supplied; zero is reserved and never assigned to a valid snapshot.

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.