Skip to main content

NominalValueAtSnapshot

Asset Tokenization Studio Team

NominalValueAtSnapshot

Abstract implementation of INominalValueAtSnapshot.

Delegates all storage reads to SnapshotsStorageWrapper and NominalValueStorageWrapper. Intended to be inherited solely by NominalValueAtSnapshotFacet.

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​

NameTypeDescription
_snapshotIDuint256The snapshot identifier returned by a prior takeSnapshot call.

Returns​

NameTypeDescription
nominalValue_uint256The 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​

NameTypeDescription
_snapshotIDuint256The snapshot identifier returned by a prior takeSnapshot call.

Returns​

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

Errors​

AccountHasNoRole​

error AccountHasNoRole(address account, bytes32 role)

Thrown when an account does not hold a required role.

Parameters​

NameTypeDescription
accountaddressThe account that lacks the role.
rolebytes32The 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​

NameTypeDescription
facetIdbytes32Identifier of the offending facet.
lastVersionuint256Last 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​

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.

UnrecognizedResolverProxyVersion​

error UnrecognizedResolverProxyVersion(bytes8 _resolverProxyVersion)

Thrown when the provided proxy version does not match any BLR compatible standard.

Parameters​

NameTypeDescription
_resolverProxyVersionbytes8proxy version that is not compatible with the BLR.

WalletRecovered​

error WalletRecovered()

Thrown when attempting to recover a wallet that has already been recovered.