IOpenEndFundClass

Git Source

Inherits: IIssuedAsset

Interface for OpenEndFundClass, extending Token functionalities.

Functions

navNumerator

function navNumerator() external view returns (uint96);

Returns

Name	Type	Description
<none>	uint96	The current numerator of the NAV ratio.

navDenominator

function navDenominator() external view returns (uint96);

Returns

Name	Type	Description
<none>	uint96	The current denominator of the NAV ratio.

updateNAV

Updates the global NAV ratio.

function updateNAV(uint96 num, uint96 den) external;

Parameters

Name	Type	Description
num	uint96	The new numerator for the NAV ratio.
den	uint96	The new denominator for the NAV ratio.

getRealQuantity

Calculates the "real" quantity for a given lot based on the NAV ratio.

function getRealQuantity(bytes32 tokenId) external view returns (uint96);

Parameters

Name	Type	Description
tokenId	bytes32	The identifier of the lot.

Returns

Name	Type	Description
<none>	uint96	The real quantity after applying the NAV ratio.

redeemFundInterest

Allows an owner to redeem a specified real amount from their lot.

function redeemFundInterest(bytes32 tokenId, uint96 realAmount) external;

Parameters

Name	Type	Description
tokenId	bytes32	The identifier of the lot.
realAmount	uint96	The real amount to redeem.

Events

NAVUpdated

Emitted when the NAV ratio is updated.

event NAVUpdated(uint96 indexed newNumerator, uint96 indexed newDenominator);

Parameters

Name	Type	Description
newNumerator	uint96	The new numerator of the NAV ratio.
newDenominator	uint96	The new denominator of the NAV ratio.