Struct pallet_pool_system::pool_types::PoolDetails

pub struct PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>
where
    Rate: FixedPointNumber<Inner = Balance>,
    Balance: FixedPointOperand + MultiplyRational,
    MaxTranches: Get<u32>,
    TrancheCurrency: Into<CurrencyId>,
{
    pub currency: CurrencyId,
    pub tranches: Tranches<Balance, Rate, Weight, TrancheCurrency, TrancheId, PoolId, MaxTranches>,
    pub parameters: PoolParameters,
    pub status: PoolStatus,
    pub epoch: EpochState<EpochId>,
    pub reserve: ReserveDetails<Balance>,
}

Fields

currency: CurrencyId

Currency that the pool is denominated in (immutable).

tranches: Tranches<Balance, Rate, Weight, TrancheCurrency, TrancheId, PoolId, MaxTranches>

List of tranches, ordered junior to senior.

parameters: PoolParameters

Details about the parameters of the pool.

status: PoolStatus

The status the pool is currently in.

epoch: EpochState<EpochId>

Details about the epochs of the pool.

reserve: ReserveDetails<Balance>

Details about the reserve (unused capital) in the pool.

Implementations

impl<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Balance: FixedPointOperand + BaseArithmetic + Unsigned + From<u64> + MultiplyRational, CurrencyId: Copy, TrancheCurrency: Into<CurrencyId> + Copy + TrancheCurrency<PoolId, TrancheId>, EpochId: BaseArithmetic + Copy, PoolId: Copy + Encode, Rate: FixedPointNumber<Inner = Balance>, TrancheId: Clone + From<[u8; 16]> + PartialEq, Weight: Copy + From<u128>, MaxTranches: Get<u32>,

pub fn start_next_epoch(&mut self, now: Seconds) -> DispatchResult

pub fn execute_previous_epoch(&mut self) -> DispatchResult

pub fn essence_from_registry<AssetRegistry, AssetId, StringLimit>( &self ) -> Result<PoolEssence<CurrencyId, Balance, TrancheCurrency, Rate, StringLimit>, DispatchError>

where AssetRegistry: Inspect<StringLimit = StringLimit, AssetId = CurrencyId>, StringLimit: Get<u32>,

Constructs the pool essence from tranche metadata stored in the asset registry.

Must not be used for the creation of a new pool as each tranche token is required to be registered in the registry which happens after the pool creation for Subquery convenience.

NOTE: Uses essence_from_tranche_input under the hood.

pub fn essence_from_tranche_input<StringLimit>( &self, ids: Vec<TrancheCurrency>, tranche_input: Vec<TrancheInput<Rate, StringLimit>> ) -> Result<PoolEssence<CurrencyId, Balance, TrancheCurrency, Rate, StringLimit>, DispatchError>

where StringLimit: Get<u32>, TrancheCurrency: Into<CurrencyId>,

Constructs the pool essence from the input tranche metadata such that.

Does not require each tranche token to be registered in some storage such that this function can be called when a new pool is created.

Trait Implementations

impl<CurrencyId: Clone, TrancheCurrency, EpochId: Clone, Balance, Rate, Weight: Clone, TrancheId: Clone, PoolId: Clone, MaxTranches> Clone for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance> + Clone, Balance: FixedPointOperand + MultiplyRational + Clone, MaxTranches: Get<u32> + Clone, TrancheCurrency: Into<CurrencyId> + Clone,

fn clone( &self ) -> PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> Debug for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance> + Debug, Balance: FixedPointOperand + MultiplyRational + Debug, MaxTranches: Get<u32> + Debug, TrancheCurrency: Into<CurrencyId> + Debug, CurrencyId: Debug, EpochId: Debug, Weight: Debug, TrancheId: Debug, PoolId: Debug,

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

Formats the value using the given formatter.

impl<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> Decode for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance>, Balance: FixedPointOperand + MultiplyRational, MaxTranches: Get<u32>, TrancheCurrency: Into<CurrencyId>, CurrencyId: Decode, Tranches<Balance, Rate, Weight, TrancheCurrency, TrancheId, PoolId, MaxTranches>: Decode, EpochState<EpochId>: Decode, ReserveDetails<Balance>: 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<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> Encode for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance>, Balance: FixedPointOperand + MultiplyRational, MaxTranches: Get<u32>, TrancheCurrency: Into<CurrencyId>, CurrencyId: Encode, Tranches<Balance, Rate, Weight, TrancheCurrency, TrancheId, PoolId, MaxTranches>: Encode, EpochState<EpochId>: Encode, ReserveDetails<Balance>: 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<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> MaxEncodedLen for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance>, Balance: FixedPointOperand + MultiplyRational, MaxTranches: Get<u32>, TrancheCurrency: Into<CurrencyId>, CurrencyId: MaxEncodedLen, Tranches<Balance, Rate, Weight, TrancheCurrency, TrancheId, PoolId, MaxTranches>: MaxEncodedLen, EpochState<EpochId>: MaxEncodedLen, ReserveDetails<Balance>: MaxEncodedLen,

fn max_encoded_len() -> usize

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

impl<CurrencyId: PartialEq, TrancheCurrency, EpochId: PartialEq, Balance, Rate, Weight: PartialEq, TrancheId: PartialEq, PoolId: PartialEq, MaxTranches> PartialEq for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance> + PartialEq, Balance: FixedPointOperand + MultiplyRational + PartialEq, MaxTranches: Get<u32> + PartialEq, TrancheCurrency: Into<CurrencyId> + PartialEq,

fn eq( &self, other: &PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> ) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> TypeInfo for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance> + TypeInfo + 'static, Balance: FixedPointOperand + MultiplyRational + TypeInfo + 'static, MaxTranches: Get<u32> + TypeInfo + 'static, TrancheCurrency: Into<CurrencyId> + TypeInfo + 'static, CurrencyId: TypeInfo + 'static, Tranches<Balance, Rate, Weight, TrancheCurrency, TrancheId, PoolId, MaxTranches>: TypeInfo + 'static, EpochState<EpochId>: TypeInfo + 'static, ReserveDetails<Balance>: TypeInfo + 'static, EpochId: TypeInfo + 'static, Weight: TypeInfo + 'static, TrancheId: TypeInfo + 'static, PoolId: TypeInfo + 'static,

type Identity = PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> EncodeLike for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance>, Balance: FixedPointOperand + MultiplyRational, MaxTranches: Get<u32>, TrancheCurrency: Into<CurrencyId>, CurrencyId: Encode, Tranches<Balance, Rate, Weight, TrancheCurrency, TrancheId, PoolId, MaxTranches>: Encode, EpochState<EpochId>: Encode, ReserveDetails<Balance>: Encode,

impl<CurrencyId: Eq, TrancheCurrency, EpochId: Eq, Balance, Rate, Weight: Eq, TrancheId: Eq, PoolId: Eq, MaxTranches> Eq for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance> + Eq, Balance: FixedPointOperand + MultiplyRational + Eq, MaxTranches: Get<u32> + Eq, TrancheCurrency: Into<CurrencyId> + Eq,

impl<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches> StructuralPartialEq for PoolDetails<CurrencyId, TrancheCurrency, EpochId, Balance, Rate, Weight, TrancheId, PoolId, MaxTranches>

where Rate: FixedPointNumber<Inner = Balance>, Balance: FixedPointOperand + MultiplyRational, MaxTranches: Get<u32>, TrancheCurrency: Into<CurrencyId>,