IPrincipal

Asset Tokenization Studio Team

IPrincipal

Interface exposing principal queries for security tokens, providing the numerator and denominator required to compute a token holder's principal value.

Read-only interface whose single function delegates to TokenCoreOps.

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.