Struct pallet_liquidity_mining::pallet::Pallet

pub struct Pallet<T, I = ()>(_);

The pallet implementing the on-chain logic.

Implementations

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

pub fn last_farm_id() -> FarmId

Id sequencer for GlobalFarm and YieldFarm.

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

pub fn deposit_id() -> DepositId

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

pub fn global_farm<KArg>(k: KArg) -> Option<GlobalFarmData<T, I>>where
    KArg: EncodeLike<GlobalFarmId>,

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

pub fn yield_farm<KArg>(key: KArg) -> Option<YieldFarmData<T, I>>where
    KArg: EncodeLikeTuple<<(NMapKey<Blake2_128Concat, T::AmmPoolId>, NMapKey<Blake2_128Concat, GlobalFarmId>, NMapKey<Blake2_128Concat, YieldFarmId>) as KeyGenerator>::KArg> + TupleToEncodedIter,

Yield farm details.

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

pub fn deposit<KArg>(k: KArg) -> Option<DepositData<T, I>>where
    KArg: EncodeLike<DepositId>,

Deposit details.

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

pub fn active_yield_farm<KArg1, KArg2>(
    k1: KArg1,
    k2: KArg2
) -> Option<YieldFarmId>where
    KArg1: EncodeLike<T::AmmPoolId>,
    KArg2: EncodeLike<GlobalFarmId>,

Active(farms able to receive LP shares deposits) yield farms.

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

pub fn pot_account_id() -> Option<T::AccountId>

Account id holding rewards allocated from all global farms for all yield farms.

pub fn farm_account_id(farm_id: FarmId) -> Result<T::AccountId, Error<T, I>>

This function returns account from FarmId or error.

WARN: farm_id = 0 is same as T::PalletId::get().into_account(). 0 is not valid value.

Trait Implementations

impl<T: Config<I>, I: 'static> Callable<T> for Pallet<T, I>

type Call = Call<T, I>

impl<T, I> Clone for Pallet<T, I>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, I> Debug for Pallet<T, I>

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

Formats the value using the given formatter.

impl<T: Config<I>, I: 'static> GetStorageVersion for Pallet<T, I>

fn current_storage_version() -> StorageVersion

Returns the current storage version as supported by the pallet.

fn on_chain_storage_version() -> StorageVersion

Returns the on-chain storage version of the pallet as stored in the storage.

impl<T: Config<I>, I: 'static> Hooks<<T as Config>::BlockNumber> for Pallet<T, I>

fn integrity_test()

Run integrity test.

fn on_finalize(_n: BlockNumber)

The block is being finalized. Implement to have something happen.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

This will be run when the block is being finalized (before on_finalize). Implement to have something happen using the remaining weight. Will not fire if the remaining weight is 0. Return the weight used, the hook will subtract it from current weight used and pass the result to the next on_idle hook if it exists.

fn on_initialize(_n: BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn try_state(_n: BlockNumber) -> Result<(), &'static str>

Execute the sanity checks of this pallet, per block.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a module allows you to perform long-running tasks that make (by default) validators generate transactions that feed results of those long-running computations back on chain.

impl<T: Config<I>, I: 'static> IntegrityTest for Pallet<T, I>

fn integrity_test()

Run integrity test.

impl<T: Config<I>, I: 'static> Mutate<<T as Config>::AccountId, <T as Config<I>>::AssetId, <T as Config>::BlockNumber> for Pallet<T, I>

fn create_global_farm_without_price_adjustment(
    total_rewards: Self::Balance,
    planned_yielding_periods: Self::Period,
    blocks_per_period: BlockNumberFor<T>,
    incentivized_asset: T::AssetId,
    reward_currency: T::AssetId,
    owner: T::AccountId,
    yield_per_period: Perquintill,
    min_deposit: Self::Balance
) -> Result<(GlobalFarmId, Self::Balance), Self::Error>

This function should be used when external source(e.g. oracle) is used for price_adjustment or if incentivized_asset and reward_currency can’t be different.

type Error = DispatchError

type AmmPoolId = <T as Config<I>>::AmmPoolId

type Balance = u128

type Period = <T as Config>::BlockNumber

type LoyaltyCurve = LoyaltyCurve

fn create_global_farm(
    total_rewards: Self::Balance,
    planned_yielding_periods: Self::Period,
    blocks_per_period: BlockNumberFor<T>,
    incentivized_asset: T::AssetId,
    reward_currency: T::AssetId,
    owner: T::AccountId,
    yield_per_period: Perquintill,
    min_deposit: Self::Balance,
    price_adjustment: FixedU128
) -> Result<(GlobalFarmId, Self::Balance), Self::Error>

Create new global farm.

fn update_global_farm_price_adjustment(
    who: T::AccountId,
    global_farm_id: GlobalFarmId,
    price_adjustment: FixedU128
) -> Result<(), Self::Error>

Update price adjustment of the existing global farm.

fn terminate_global_farm(
    who: T::AccountId,
    global_farm_id: u32
) -> Result<(T::AssetId, Self::Balance, T::AccountId), Self::Error>

Terminate existing global farm.

fn create_yield_farm(
    who: T::AccountId,
    global_farm_id: GlobalFarmId,
    multiplier: FixedU128,
    loyalty_curve: Option<Self::LoyaltyCurve>,
    amm_pool_id: Self::AmmPoolId,
    assets: Vec<T::AssetId>
) -> Result<YieldFarmId, Self::Error>

Crate new yield farm in the global farm.

fn update_yield_farm_multiplier(
    who: T::AccountId,
    global_farm_id: GlobalFarmId,
    amm_pool_id: Self::AmmPoolId,
    multiplier: FixedU128
) -> Result<YieldFarmId, Self::Error>

Update multiplier of the existing yield farm.

fn stop_yield_farm(
    who: T::AccountId,
    global_farm_id: GlobalFarmId,
    amm_pool_id: Self::AmmPoolId
) -> Result<u32, Self::Error>

Stop yield farming for amm pool in the global farm.

fn resume_yield_farm(
    who: T::AccountId,
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    amm_pool_id: Self::AmmPoolId,
    multiplier: FixedU128
) -> Result<(), Self::Error>

Resume yield farming for amm pool in the global farm.

fn terminate_yield_farm(
    who: T::AccountId,
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    amm_pool_id: Self::AmmPoolId
) -> Result<(), Self::Error>

Terminate existing yield farm.

fn deposit_lp_shares<F: Fn(T::AssetId, Self::AmmPoolId, Self::Balance) -> Result<Self::Balance, Self::Error>>(
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    amm_pool_id: Self::AmmPoolId,
    shares_amount: Self::Balance,
    get_token_value_of_lp_shares: F
) -> Result<DepositId, Self::Error>

Deposit new LP shares.

fn redeposit_lp_shares<F: Fn(T::AssetId, Self::AmmPoolId, Self::Balance) -> Result<Self::Balance, Self::Error>>(
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    deposit_id: DepositId,
    get_token_value_of_lp_shares: F
) -> Result<(Self::Balance, Self::AmmPoolId), Self::Error>

Redeposit already locked LP shares to another yield farm.

fn claim_rewards(
    who: T::AccountId,
    deposit_id: DepositId,
    yield_farm_id: YieldFarmId
) -> Result<(GlobalFarmId, T::AssetId, Self::Balance, Self::Balance), Self::Error>

Claim rewards for given deposit.

fn withdraw_lp_shares(
    who: T::AccountId,
    deposit_id: DepositId,
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    amm_pool_id: Self::AmmPoolId
) -> Result<(Self::Balance, Option<(T::AssetId, Self::Balance, Self::Balance)>, bool), Self::Error>

Withdraw LP shares from yield farm. Function attempts to claim rewards for who if farm is claimable.

fn is_yield_farm_claimable(
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    amm_pool_id: Self::AmmPoolId
) -> bool

Returns true if rewards claiming from yield farm is possible.

fn get_global_farm_id(
    deposit_id: DepositId,
    yield_farm_id: YieldFarmId
) -> Option<u32>

Returns Some(global_farm_id) for given deposit_id and yield_farm_id or None.

impl<T: Config<I>, I: 'static> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T, I>

fn offchain_worker(n: <T as Config>::BlockNumber)

This function is being called after every block import (when fully synced).

impl<T: Config<I>, I: 'static> OnFinalize<<T as Config>::BlockNumber> for Pallet<T, I>

fn on_finalize(n: <T as Config>::BlockNumber)

The block is being finalized. Implement to have something happen.

impl<T: Config<I>, I: 'static> OnGenesis for Pallet<T, I>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config<I>, I: 'static> OnIdle<<T as Config>::BlockNumber> for Pallet<T, I>

fn on_idle(n: <T as Config>::BlockNumber, remaining_weight: Weight) -> Weight

The block is being finalized. Implement to have something happen in case there is leftover weight. Check the passed remaining_weight to make sure it is high enough to allow for your pallet’s extra computation.

impl<T: Config<I>, I: 'static> OnInitialize<<T as Config>::BlockNumber> for Pallet<T, I>

fn on_initialize(n: <T as Config>::BlockNumber) -> Weight

The block is being initialized. Implement to have something happen.

impl<T: Config<I>, I: 'static> OnRuntimeUpgrade for Pallet<T, I>

fn on_runtime_upgrade() -> Weight

Perform a module upgrade.

fn pre_upgrade() -> Result<(), &'static str>

Execute some pre-checks prior to a runtime upgrade.

fn post_upgrade() -> Result<(), &'static str>

Execute some post-checks after a runtime upgrade.

impl<T: Config<I>, I: 'static> PalletInfoAccess for Pallet<T, I>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config<I>, I: 'static> PalletsInfoAccess for Pallet<T, I>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T, I> PartialEq<Pallet<T, I>> for Pallet<T, I>

fn eq(&self, other: &Self) -> 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: Config<I>, I: 'static> StorageInfoTrait for Pallet<T, I>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config<I>, I: 'static> TryState<<T as Config>::BlockNumber> for Pallet<T, I>

fn try_state(
    n: <T as Config>::BlockNumber,
    _s: TryStateSelect
) -> Result<(), &'static str>

Execute the state checks.

impl<T, I> Eq for Pallet<T, I>