DividendSecurityHolders

Asset Tokenization Studio Team

DividendSecurityHolders

Abstract base providing the read-only holder lookups exposed by DividendSecurityHoldersFacet.

Thin forwarder over DividendStorageWrapper; holds no storage of its own. Each external onlyOperational method is gated by onlyMatchingActionType(CORPORATE_ACTION_TYPE_DIVIDEND, dividendId - 1), ensuring the caller's dividendId actually resolves to a dividend corporate action before any storage read. The library handles snapshot vs. live-registry sourcing internally.

Methods

getDividendHolders

function getDividendHolders(uint256 dividendId, uint256 pageIndex, uint256 pageLength) external view returns (address[] holders_)

Returns the page of holder addresses eligible for a given dividend.

Reverts through onlyMatchingActionType if dividendId does not match the dividend corporate action type at index dividendId - 1.

Parameters

Name	Type	Description
dividendId	uint256	undefined
pageIndex	uint256	undefined
pageLength	uint256	undefined

Returns

Name	Type	Description
holders_	address[]	Holder addresses on the requested page, in storage order.

getTotalDividendHolders

function getTotalDividendHolders(uint256 dividendId) external view returns (uint256)

Returns the total number of holders eligible for a given dividend.

Reverts through onlyMatchingActionType if dividendId does not match the dividend corporate action type at index dividendId - 1.

Parameters

Name	Type	Description
dividendId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	Total number of eligible holders.

initializeDividendSecurityHolders

function initializeDividendSecurityHolders() external nonpayable

Initialises the dividend security holders capability on the token.

Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.

Events

DividendSecurityHoldersInitialized

event DividendSecurityHoldersInitialized()

Emitted once when the dividend security holders capability is initialised on a token.

Fires exclusively from initializeDividendSecurityHolders.

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.

WrongIndexForAction

error WrongIndexForAction(uint256 index, bytes32 actionType)

Thrown when a type-scoped index does not correspond to an existing action.

Parameters

Name	Type	Description
index	uint256	The out-of-range index that was provided.
actionType	bytes32	The action type against which the index was validated.