Module share_balance

Source
Expand description

Share-based lazy balance model implementation.

Provides ShareBalanceFamily and ShareBalanceContext for a proportional ownership (shares) based LazyBalance model.

Use:

This model tracks ownership via shares and resolves value lazily at withdrawal time.

Modules§

balance 🔒
Balance-level accessors and initialization utilities.
receipt 🔒
Receipt-level accessors and utilities.
snapshot 🔒
LazyBalance::SnapShot virtual field layout.

Structs§

ModelCanDeposit
CanDeposit plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelCanMint
CanMint plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelCanReap
CanReap plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelCanWithdraw
CanWithdraw plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelDeposit
Deposit plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelDepositLimits
DepositLimits plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelDrain
Drain plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelHasDeposits
HasDeposits plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelMint
Mint plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelMintLimits
MintLimits plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelReap
Reap plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelReapLimits
ReapLimits plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelReceiptActiveValue
ReceiptActiveValue plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelReceiptDepositValue
ReceiptDepositValue plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelTotalValue
TotalValue plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ModelWithdraw
Withdraw plugin family’s child model over the LazyBalance’s compile-time marker via ShareBalanceContext.
ShareBalanceContext
Plugin execution context for ShareBalanceFamily.
ShareBalanceFamily
Plugin family implementing a share-based lazy balance model.

Enums§

ShareBalanceError
Errors that can occur during ShareBalanceFamily plugin operations.

Functions§

balance_checkpoint 🔒
Advances the checkpoint on balance updates (mint/reap).