Principal
Asset Tokenization Studio Team
Principal
Abstract implementation of IPrincipal, providing principal queries for security tokens.
Stateless wrapper that delegates the actual computation to {TokenCoreOps}. Intended to be inherited by PrincipalFacet.
Methods
getPrincipalFor
function getPrincipalFor(address _account) external view returns (struct IPrincipal.PrincipalFor principalFor_)
Returns the principal numerator and denominator for a given account.
Parameters
| Name | Type | Description |
|---|---|---|
| _account | address | The address of the token holder. |
Returns
| Name | Type | Description |
|---|---|---|
| principalFor_ | IPrincipal.PrincipalFor | Struct containing the numerator and denominator of the principal. |
initializePrincipal
function initializePrincipal() external nonpayable
Initialises the principal capability on the token.
Callable once; subsequent calls revert with FacetAlreadyRegistered. Requires DEFAULT_ADMIN_ROLE. Called by the factory during deployment.
Events
PrincipalInitialized
event PrincipalInitialized()
Emitted once when the principal capability is initialised on a token.
Fires exclusively from initializePrincipal.
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.