Struct PoolInfo

pub struct PoolInfo<T: Config<I>, I: 'static = ()> {
    balance_of: LazyBalanceOf<T, I>,
    capital: T::Shares,
    commission: T::Commission,
    slots: Slots<T, I>,
}

Represents a managed pool derived from an index.

PoolInfo aggregates capital, commission, and the collection of slots, each of which represents a portion of the pool linked to underlying entries. Unlike indexes, pools are mutable and can have their slot balances adjusted dynamically.

Pools are created from an IndexInfo (or Entries), allowing the shares of each entry to be translated into slots within the pool.

Pool’s slot shares/variants can then be adjusted over time, while the pool’s commission and structure remain consistent.

Fields

balance_of: LazyBalanceOf<T, I>

Real-time balance of the pool.

Stored as LazyBalanceOf which allows efficient updates and tracking proprietor depositted balances internally within itself at higher level.

capital: T::Shares

Total capital of the pool.

Computed as the sum of all shares in the pool’s slots. Represents the total weight or stake across all slots.

commission: T::Commission

Commission rate charged by the pool manager.

The manager earns this percentage of rewards or profits generated by the pool.

slots: Slots<T, I>

Collection of slots representing the underlying assets or commitments.

Each slot corresponds to an entry from the index that formed this pool. Slots track individual shares, its deposit receipt, and disposition Disposition.

Implementations

impl<T: Config<I>, I: 'static> PoolInfo<T, I>

pub(crate) fn new( index_entries: Entries<T, I>, commission: T::Commission, ) -> Result<Self, DispatchError>

Creates a new pool from a list of index entries and a commission rate.

• Converts the Entries into Slots.
• Calculates the total capital by summing all entry shares.
• Initializes the pool balance to zero.

Returns

• Ok(PoolInfo) if successful.
• Err(DispatchError) otherwise.

pub fn balance(&self) -> LazyBalanceOf<T, I>

Returns the pool’s lazy balance.

pub(crate) fn set_balance(&mut self, balance: LazyBalanceOf<T, I>)

Set the pool balance usually only after release.

pub fn capital(&self) -> T::Shares

Returns the pool’s total capital i.e., total shares of all slots.

pub fn commission(&self) -> T::Commission

Returns the pool’s commission i.e., manager’s share while resolving the pool’s commit.

pub fn slots(&self) -> Vec<SlotInfo<T, I>>

Returns the pools’s individual slots as a vector.

pub(crate) fn balance_reset(&mut self)

Resets the pools’s top-level lazy balance.

This lazy balance acts like a pseudo-direct-digest for proprietors structurally for pool-commitments.

pub(crate) fn set_slot_commit( &mut self, digest: &SlotDigest<T>, commit: CommitInstance<T, I>, ) -> Result<(), DispatchError>

Replaces the commit instance of the slot identified by digest by delegating to the underlying slots.

pub(crate) fn add_slot(&mut self, entry: EntryInfo<T, I>) -> DispatchResult

Adds a new EntryInfo to the list of pool’s slots, as slots SlotInfo can only be derived from an entry.

Unlike indexes which are immutable, pools are mutable hence requires slot management via higher-structures.

Returns DispatchError otherwise.

pub(crate) fn remove_slot(&mut self, slot: &SlotDigest<T>) -> DispatchResult

Removes an existing slot from the pool.

Unlike indexes which are immutable, pools are mutable hence requires slot management via higher-structures.

Returns DispatchError otherwise.

pub fn slot_exists(&self, slot: &SlotDigest<T>) -> DispatchResult

Checks if a slot of digest exists in the pool.

Trait Implementations

impl<T: Config<I>, I: 'static> Clone for PoolInfo<T, I>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Config<I>, I: 'static> Debug for PoolInfo<T, I>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> Decode for PoolInfo<T, I>

where LazyBalanceOf<T, I>: Decode, T::Shares: Decode, T::Commission: Decode, Slots<T, I>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config<I>, I: 'static> Encode for PoolInfo<T, I>

where LazyBalanceOf<T, I>: Encode, T::Shares: Encode, T::Commission: Encode, Slots<T, I>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config<I>, I: 'static> MaxEncodedLen for PoolInfo<T, I>

where LazyBalanceOf<T, I>: MaxEncodedLen, T::Shares: MaxEncodedLen, T::Commission: MaxEncodedLen, Slots<T, I>: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T: Config<I>, I: 'static> PartialEq for PoolInfo<T, I>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, I> TypeInfo for PoolInfo<T, I>

where LazyBalanceOf<T, I>: TypeInfo + 'static, T::Shares: TypeInfo + 'static, T::Commission: TypeInfo + 'static, Slots<T, I>: TypeInfo + 'static, T: Config<I> + 'static, I: 'static,

type Identity = PoolInfo<T, I>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config<I>, I: 'static> DecodeWithMemTracking for PoolInfo<T, I>

where LazyBalanceOf<T, I>: DecodeWithMemTracking, T::Shares: DecodeWithMemTracking, T::Commission: DecodeWithMemTracking, Slots<T, I>: DecodeWithMemTracking,

impl<T: Config<I>, I: 'static> EncodeLike for PoolInfo<T, I>

where LazyBalanceOf<T, I>: Encode, T::Shares: Encode, T::Commission: Encode, Slots<T, I>: Encode,

impl<T: Config<I>, I: 'static> Eq for PoolInfo<T, I>