Skip to main content

ISnapshotsByPartition

Asset Tokenization Studio Team

ISnapshotsByPartition

Interface for the SnapshotsByPartition facet, exposing partition-level snapshot reads.

Methods​

initializeSnapshotsByPartition​

function initializeSnapshotsByPartition() external nonpayable

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

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

partitionsOfAtSnapshot​

function partitionsOfAtSnapshot(uint256 _snapshotID, address _tokenHolder) external view returns (bytes32[])

Returns the list of partitions held by an account at the time of a given snapshot.

Reverts with {SnapshotIdNull} when _snapshotID is zero, and with {SnapshotIdDoesNotExists} when the snapshot identifier does not correspond to a previously taken snapshot.

Parameters​

NameTypeDescription
_snapshotIDuint256Identifier of the snapshot to query.
_tokenHolderaddressAddress of the account whose partition list is being queried.

Returns​

NameTypeDescription
_0bytes32[]Ordered list of partition identifiers held by _tokenHolder at snapshot time.

Events​

SnapshotsByPartitionInitialized​

event SnapshotsByPartitionInitialized()

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

Fires exclusively from initializeSnapshotsByPartition.

Errors​

SnapshotIdDoesNotExists​

error SnapshotIdDoesNotExists(uint256 snapshotId)

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

Parameters​

NameTypeDescription
snapshotIduint256The 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.