BalanceTracker
Asset Tokenization Studio Team
BalanceTracker
Abstract implementation of IBalanceTracker that consolidates token balance and total supply queries into a single, time-aware read layer.
Delegates all storage reads to ERC1410StorageWrapper and TokenCoreOps, passing the resolved timestamp from TimeTravelStorageWrapper to support non-triggered adjustment simulation. Intended to be inherited by BalanceTrackerFacet.
Methods
balanceOf
function balanceOf(address _tokenHolder) external view returns (uint256)
Returns the total token balance of a token holder across all partitions, simulating non-triggered balance adjustments up to the current timestamp.
Delegates to ERC1410StorageWrapper.balanceOfAdjustedAt. No state is mutated.
Parameters
| Name | Type | Description |
|---|---|---|
| _tokenHolder | address | The address of the token holder. |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | The adjusted total balance of the token holder at the current timestamp. |
getTotalBalanceFor
function getTotalBalanceFor(address _account) external view returns (uint256)
Returns the total balance held by an account across all partitions, including locked tokens, held tokens, and clearing amounts, simulating non-triggered adjustments up to the current timestamp.
Delegates to TokenCoreOps.getTotalBalanceForAdjustedAt. No state is mutated.
Parameters
| Name | Type | Description |
|---|---|---|
| _account | address | The address of the account. |
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | The adjusted total balance for the account at the current timestamp. |
initializeBalanceTracker
function initializeBalanceTracker() external nonpayable
Initialises the balance tracker capability on the token.
Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.
totalSupply
function totalSupply() external view returns (uint256)
Returns the total token supply across all partitions, simulating non-triggered supply adjustments up to the current timestamp.
Delegates to ERC1410StorageWrapper.totalSupplyAdjustedAt. No state is mutated.
Returns
| Name | Type | Description |
|---|---|---|
| _0 | uint256 | The adjusted total supply at the current timestamp. |
Events
BalanceTrackerInitialized
event BalanceTrackerInitialized()
Emitted once when the balance tracker capability is initialised on a token.
Fires exclusively from initializeBalanceTracker after the storage write succeeds.
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. |
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.