Struct pallet_liquidity_mining::DepositData

pub struct DepositData<T: Config<I>, I: 'static = ()> { /* private fields */ }

Deposit represents a group of locked LP shares in the liquidity mining program(“Position”). LP shares in the deposit can be locked in one or more yield farms based on pallet’s configuration(MaxEntriesPerDeposit). The LP token’s lock in the deposit is called “farm entry”. Farm entry entitles deposit owner to accumulate rewards from the yield farm. Every deposit should have at least one farm entry and deposit without farm entries should be removed from storage and LP shares should be unlocked. redeposit_lp_shares() is used to add a new farm entry into the deposit(“re-lock” LP shares“).

Implementations

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

pub fn new(shares: Balance, amm_pool_id: T::AmmPoolId) -> Self

pub fn add_yield_farm_entry(
    &mut self,
    entry: YieldFarmEntry<T, I>
) -> Result<(), DispatchError>

This function add new yield farm entry into the deposit. This function returns error if deposit reached max entries in the deposit or entry.yield_farm_id is not unique.

pub fn remove_yield_farm_entry(
    &mut self,
    yield_farm_id: YieldFarmId
) -> Result<YieldFarmEntry<T, I>, Error<T, I>>

This function remove yield farm entry from the deposit. This function returns error if yield farm entry in not found in the deposit.

pub fn get_yield_farm_entry(
    &mut self,
    yield_farm_id: YieldFarmId
) -> Option<&mut YieldFarmEntry<T, I>>

This function return yield farm entry from deposit of None if yield farm entry is not found.

pub fn search_yield_farm_entry(
    &self,
    yield_farm_id: YieldFarmId
) -> Option<usize>

This function returns its index if deposit contains yield farm entry with given yield farm id.

pub fn can_be_removed(&self) -> bool

This function returns true if deposit can be removed from storage.

Trait Implementations

impl<T: Clone + Config<I>, I: Clone + 'static> Clone for DepositData<T, I>where
    T::AmmPoolId: Clone,
    T::MaxFarmEntriesPerDeposit: Clone,

fn clone(&self) -> DepositData<T, I>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, I> Debug for DepositData<T, I>where
    T: Debug + Config<I>,
    I: Debug + 'static,

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> Decode for DepositData<T, I>where
    T::AmmPoolId: Decode,
    BoundedVec<YieldFarmEntry<T, I>, T::MaxFarmEntriesPerDeposit>: Decode,

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

Attempt to deserialise the value from input.

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 DepositData<T, I>where
    T::AmmPoolId: Encode,
    BoundedVec<YieldFarmEntry<T, I>, T::MaxFarmEntriesPerDeposit>: Encode,

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

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    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 DepositData<T, I>

fn max_encoded_len() -> usize

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

impl<T: PartialEq + Config<I>, I: PartialEq + 'static> PartialEq<DepositData<T, I>> for DepositData<T, I>where
    T::AmmPoolId: PartialEq,
    T::MaxFarmEntriesPerDeposit: PartialEq,

fn eq(&self, other: &DepositData<T, I>) -> 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<T, I> TypeInfo for DepositData<T, I>where
    T::AmmPoolId: TypeInfo + 'static,
    BoundedVec<YieldFarmEntry<T, I>, T::MaxFarmEntriesPerDeposit>: TypeInfo + 'static,
    T: Config<I> + 'static,
    I: 'static,

type Identity = DepositData<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> EncodeLike<DepositData<T, I>> for DepositData<T, I>where
    T::AmmPoolId: Encode,
    BoundedVec<YieldFarmEntry<T, I>, T::MaxFarmEntriesPerDeposit>: Encode,

impl<T: Eq + Config<I>, I: Eq + 'static> Eq for DepositData<T, I>where
    T::AmmPoolId: Eq,
    T::MaxFarmEntriesPerDeposit: Eq,

impl<T: Config<I>, I: 'static> StructuralEq for DepositData<T, I>

impl<T: Config<I>, I: 'static> StructuralPartialEq for DepositData<T, I>