LockAtSnapshot
Asset Tokenization Studio Team
LockAtSnapshot
Abstract implementation of ILockAtSnapshot.
Delegates all storage reads to SnapshotsStorageWrapper. Intended to be inherited solely by LockAtSnapshotFacet.
Methods
initializeLockAtSnapshot
function initializeLockAtSnapshot() external nonpayable
Initialises the lock-at-snapshot capability on the token.
Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.
lockedBalanceOfAtSnapshot
function lockedBalanceOfAtSnapshot(uint256 _snapshotID, address _tokenHolder) external view returns (uint256 balance_)
Returns the locked balance of a token holder at the time of a given snapshot.
Queries the adjusted locked-balance snapshot recorded by LockStorageWrapper at _snapshotID. The value reflects the lock escrow amount as it stood at the snapshot block, adjusted for any scheduled balance-adjustment factor.
Parameters
| Name | Type | Description |
|---|---|---|
| _snapshotID | uint256 | The snapshot identifier returned by a prior takeSnapshot call. |
| _tokenHolder | address | The address of the token holder. |
Returns
| Name | Type | Description |
|---|---|---|
| balance_ | uint256 | The locked balance of _tokenHolder recorded at _snapshotID. |
Events
LockAtSnapshotInitialized
event LockAtSnapshotInitialized()
Emitted once when the lock-at-snapshot capability is initialised on a token.
Fires exclusively from initializeLockAtSnapshot.
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.