VotingSecurityHolders
Asset Tokenization Studio Team
VotingSecurityHolders
Abstract implementation of IVotingSecurityHolders, providing holder-enumeration queries for voting corporate actions.
Stateless wrapper that delegates all storage reads to {VotingStorageWrapper}. Intended to be inherited by VotingSecurityHoldersFacet.
Methods
getTotalVotingHolders
function getTotalVotingHolders(uint256 _voteID) external view returns (uint256 totalHolders_)
Returns the total number of token holders eligible for a voting.
Count is taken from the snapshot at the voting record date when one exists; falls back to the live total if no snapshot has been taken. Returns zero if the record date has not yet been reached.
Parameters
| Name | Type | Description |
|---|---|---|
| _voteID | uint256 | Identifier of the target voting (1-based index). |
Returns
| Name | Type | Description |
|---|---|---|
| totalHolders_ | uint256 | Total number of eligible holders. |
getVotingHolders
function getVotingHolders(uint256 _voteID, uint256 _pageIndex, uint256 _pageLength) external view returns (address[] holders_)
Returns a paginated list of token holders eligible for a voting.
Resolved from the snapshot at the voting record date when one exists; falls back to the live holder list if no snapshot has been taken. Returns an empty array if the record date has not yet been reached.
Parameters
| Name | Type | Description |
|---|---|---|
| _voteID | uint256 | Identifier of the target voting (1-based index). |
| _pageIndex | uint256 | Zero-based page number for pagination. |
| _pageLength | uint256 | Maximum number of addresses to return per page. |
Returns
| Name | Type | Description |
|---|---|---|
| holders_ | address[] | Ordered array of holder addresses for the requested page. |
initializeVotingSecurityHolders
function initializeVotingSecurityHolders() external nonpayable
Initialises the voting-security-holders capability on the token.
Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.
Events
VotingSecurityHoldersInitialized
event VotingSecurityHoldersInitialized()
Emitted once when the voting-security-holders capability is initialised on a token.
Fires exclusively from initializeVotingSecurityHolders.
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.