Skip to main content

IFreezeAtSnapshot

Asset Tokenization Studio Team

IFreezeAtSnapshot

Interface exposing historical frozen-balance queries against captured snapshots.

Read-only counterpart to the freeze surface for snapshot-aware reporting. Returns the frozen amount as it was at the time the snapshot was taken, including time-based adjustments scheduled before that block.

Methods​

frozenBalanceOfAtSnapshot​

function frozenBalanceOfAtSnapshot(uint256 _snapshotID, address _tokenHolder) external view returns (uint256 balance_)

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

Parameters​

NameTypeDescription
_snapshotIDuint256The identifier of the snapshot to query.
_tokenHolderaddressThe address whose frozen balance is being queried.

Returns​

NameTypeDescription
balance_uint256The frozen balance of _tokenHolder at snapshot _snapshotID.

initializeFreezeAtSnapshot​

function initializeFreezeAtSnapshot() external nonpayable

Initialises the freeze-at-snapshot capability on the token.

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

Events​

FreezeAtSnapshotInitialized​

event FreezeAtSnapshotInitialized()

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

Fires exclusively from initializeFreezeAtSnapshot.