INominalValueAtSnapshot
Asset Tokenization Studio Team
INominalValueAtSnapshot
Interface for querying the token's nominal value and its decimals at the time of a previously taken snapshot.
Reads are delegated to SnapshotsStorageWrapper, which resolves the snapshot index recorded by takeSnapshot. When no snapshot value is stored for the requested id, the current nominal value from NominalValueStorageWrapper is returned. Reverts with SnapshotIdNull when _snapshotID == 0 and with SnapshotIdDoesNotExists for unknown identifiers.
Methods
initializeNominalValueAtSnapshot
function initializeNominalValueAtSnapshot() external nonpayable
Initialises the nominal-value-at-snapshot capability on the token.
Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.
nominalValueAtSnapshot
function nominalValueAtSnapshot(uint256 _snapshotID) external view returns (uint256 nominalValue_)
Returns the nominal value of the token at the time of a given snapshot.
Resolved against the nominalValueSnapshots series; falls back to the live nominal value when the snapshot id predates any recorded change.
Parameters
| Name | Type | Description |
|---|---|---|
| _snapshotID | uint256 | The snapshot identifier returned by a prior takeSnapshot call. |
Returns
| Name | Type | Description |
|---|---|---|
| nominalValue_ | uint256 | The nominal value recorded at _snapshotID. |
nominalValueDecimalsAtSnapshot
function nominalValueDecimalsAtSnapshot(uint256 _snapshotID) external view returns (uint256 nominalValueDecimals_)
Returns the decimals applied to the nominal value at the time of a given snapshot.
Resolved against the nominalValueDecimalsSnapshots series; falls back to the live decimals value when the snapshot id predates any recorded change.
Parameters
| Name | Type | Description |
|---|---|---|
| _snapshotID | uint256 | The snapshot identifier returned by a prior takeSnapshot call. |
Returns
| Name | Type | Description |
|---|---|---|
| nominalValueDecimals_ | uint256 | The nominal value decimals recorded at _snapshotID. |
Events
NominalValueAtSnapshotInitialized
event NominalValueAtSnapshotInitialized()
Emitted once when the nominal-value-at-snapshot capability is initialised on a token.
Fires exclusively from initializeNominalValueAtSnapshot.