Enum pallet_pool_system::EpochSolution

pub enum EpochSolution<Balance, MaxTranches>
where
    MaxTranches: Get<u32>,
{
    Healthy(HealthySolution<Balance, MaxTranches>),
    Unhealthy(UnhealthySolution<Balance, MaxTranches>),
}

The solutions struct for epoch solution

Variants

Healthy(HealthySolution<Balance, MaxTranches>)

Unhealthy(UnhealthySolution<Balance, MaxTranches>)

Implementations

impl<Balance, MaxTranches> EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32>,

pub fn calculate_score<BalanceRatio, Weight, TrancheCurrency, MaxExecutionTranches>( solution: &[TrancheSolution], tranches: &EpochExecutionTranches<Balance, BalanceRatio, Weight, TrancheCurrency, MaxExecutionTranches> ) -> Result<Balance, DispatchError>

where Balance: Copy + BaseArithmetic + Unsigned + From<u64>, Weight: Copy + From<u128> + Convert<Weight, Balance>, BalanceRatio: Copy, MaxExecutionTranches: Get<u32>,

Calculates the score for a given solution. Should only be called inside the fn score_solution() from the runtime, as there are no checks if solution length matches tranche length.

Scores are calculated with the following function

Notation:

• X(a) -> A vector of a’s, where each element is associated with a tranche
• ||X(a)||1 -> 1-Norm of a vector, i.e. the absolute sum over all elements

X = X(%-invest-fulfillments) * X(investments) * X(invest_tranche_weights) + X(%-redeem-fulfillments) * X(redemptions) * X(redeem_tranche_weights)

score = ||X||1

Returns error upon overflow of Balances.

pub fn score_solution_healthy<BalanceRatio, Weight, TrancheCurrency, MaxExecutionTranches>( solution: &[TrancheSolution], tranches: &EpochExecutionTranches<Balance, BalanceRatio, Weight, TrancheCurrency, MaxExecutionTranches> ) -> Result<EpochSolution<Balance, MaxTranches>, DispatchError>

where Balance: Zero + Copy + BaseArithmetic + Unsigned + From<u64>, Weight: Copy + From<u128> + Convert<Weight, Balance>, BalanceRatio: Copy, MaxExecutionTranches: Get<u32>,

Scores a solution and returns a healthy solution as a result.

pub fn score_solution_unhealthy<BalanceRatio, Weight, TrancheCurrency, MaxExecutionTranches>( solution: &[TrancheSolution], tranches: &EpochExecutionTranches<Balance, BalanceRatio, Weight, TrancheCurrency, MaxExecutionTranches>, reserve: Balance, max_reserve: Balance, state: &[UnhealthyState] ) -> Result<EpochSolution<Balance, MaxTranches>, DispatchError>

where Weight: Copy + From<u128>, BalanceRatio: Copy + FixedPointNumber, Balance: Copy + BaseArithmetic + FixedPointOperand + Unsigned + From<u64> + MultiplyRational, MaxExecutionTranches: Get<u32>,

Scores an solution, that would bring a pool into an unhealthy state.

impl<Balance, MaxTranches> EpochSolution<Balance, MaxTranches>

where Balance: Copy, MaxTranches: Get<u32>,

pub fn healthy(&self) -> bool

pub fn solution(&self) -> &[TrancheSolution]

Trait Implementations

impl<Balance: Clone, MaxTranches> Clone for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32> + Clone,

fn clone(&self) -> EpochSolution<Balance, MaxTranches>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Balance, MaxTranches> Debug for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32> + Debug, Balance: Debug,

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

Formats the value using the given formatter.

impl<Balance, MaxTranches> Decode for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32>, HealthySolution<Balance, MaxTranches>: Decode, UnhealthySolution<Balance, MaxTranches>: 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<'de, Balance, MaxTranches> Deserialize<'de> for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32> + Deserialize<'de>, Balance: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<Balance, MaxTranches> Encode for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32>, HealthySolution<Balance, MaxTranches>: Encode, UnhealthySolution<Balance, MaxTranches>: 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<Balance, MaxTranches> MaxEncodedLen for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32>, HealthySolution<Balance, MaxTranches>: MaxEncodedLen, UnhealthySolution<Balance, MaxTranches>: MaxEncodedLen,

fn max_encoded_len() -> usize

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

impl<Balance: PartialEq, MaxTranches> PartialEq for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32> + PartialEq,

fn eq(&self, other: &EpochSolution<Balance, 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<Balance, MaxTranches> PartialOrd for EpochSolution<Balance, MaxTranches>

where Balance: PartialOrd, MaxTranches: Get<u32> + PartialOrd,

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<Balance, MaxTranches> Serialize for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32> + Serialize, Balance: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<Balance, MaxTranches> TypeInfo for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32> + TypeInfo + 'static, HealthySolution<Balance, MaxTranches>: TypeInfo + 'static, UnhealthySolution<Balance, MaxTranches>: TypeInfo + 'static, Balance: TypeInfo + 'static,

type Identity = EpochSolution<Balance, MaxTranches>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<Balance, MaxTranches> EncodeLike for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32>, HealthySolution<Balance, MaxTranches>: Encode, UnhealthySolution<Balance, MaxTranches>: Encode,

impl<Balance: Eq, MaxTranches> Eq for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32> + Eq,

impl<Balance, MaxTranches> StructuralPartialEq for EpochSolution<Balance, MaxTranches>

where MaxTranches: Get<u32>,