FreezeAtSnapshotByPartitionFacet

Asset Tokenization Studio Team

FreezeAtSnapshotByPartitionFacet

Diamond facet exposing partition-aware snapshot frozen balance queries via IFreezeAtSnapshotByPartition, registered under RESOLVER_KEY_FREEZE_AT_SNAPSHOT_BY_PARTITION.

Consolidates frozenBalanceOfAtSnapshotByPartition previously hosted in SnapshotsFacet. Exposes 1 selector: frozenBalanceOfAtSnapshotByPartition.

Methods

frozenBalanceOfAtSnapshotByPartition

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

Returns the frozen balance of an account for a given partition at the time of a given snapshot.

Parameters

Name	Type	Description
_partition	bytes32	The partition the frozen balance is queried in.
_snapshotID	uint256	The identifier of the snapshot to query.
_tokenHolder	address	The address whose frozen balance is being queried.

Returns

Name	Type	Description
balance_	uint256	The frozen balance of _tokenHolder on _partition at snapshot _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

initializeFreezeAtSnapshotByPartition

function initializeFreezeAtSnapshotByPartition() external nonpayable

Initialises the freeze-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

FreezeAtSnapshotByPartitionInitialized

event FreezeAtSnapshotByPartitionInitialized()

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

Fires exclusively from initializeFreezeAtSnapshotByPartition.

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.