Enum pallet_xyk_liquidity_mining::pallet::Call

pub enum Call<T: Config> {
    create_global_farm {
        total_rewards: Balance,
        planned_yielding_periods: <T as Config>::BlockNumber,
        blocks_per_period: BlockNumberFor<T>,
        incentivized_asset: AssetId,
        reward_currency: AssetId,
        owner: T::AccountId,
        yield_per_period: Perquintill,
        min_deposit: Balance,
        price_adjustment: FixedU128,
    },
    update_global_farm {
        global_farm_id: GlobalFarmId,
        price_adjustment: FixedU128,
    },
    terminate_global_farm {
        global_farm_id: GlobalFarmId,
    },
    create_yield_farm {
        global_farm_id: GlobalFarmId,
        asset_pair: AssetPair,
        multiplier: FarmMultiplier,
        loyalty_curve: Option<LoyaltyCurve>,
    },
    update_yield_farm {
        global_farm_id: GlobalFarmId,
        asset_pair: AssetPair,
        multiplier: FarmMultiplier,
    },
    stop_yield_farm {
        global_farm_id: GlobalFarmId,
        asset_pair: AssetPair,
    },
    resume_yield_farm {
        global_farm_id: GlobalFarmId,
        yield_farm_id: YieldFarmId,
        asset_pair: AssetPair,
        multiplier: FarmMultiplier,
    },
    terminate_yield_farm {
        global_farm_id: GlobalFarmId,
        yield_farm_id: YieldFarmId,
        asset_pair: AssetPair,
    },
    deposit_shares {
        global_farm_id: GlobalFarmId,
        yield_farm_id: YieldFarmId,
        asset_pair: AssetPair,
        shares_amount: Balance,
    },
    redeposit_shares {
        global_farm_id: GlobalFarmId,
        yield_farm_id: YieldFarmId,
        asset_pair: AssetPair,
        deposit_id: DepositId,
    },
    claim_rewards {
        deposit_id: DepositId,
        yield_farm_id: YieldFarmId,
    },
    withdraw_shares {
        deposit_id: DepositId,
        yield_farm_id: YieldFarmId,
        asset_pair: AssetPair,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

create_global_farm

Fields

total_rewards: Balance

planned_yielding_periods: <T as Config>::BlockNumber

blocks_per_period: BlockNumberFor<T>

incentivized_asset: AssetId

reward_currency: AssetId

owner: T::AccountId

yield_per_period: Perquintill

min_deposit: Balance

price_adjustment: FixedU128

Create new liquidity mining program with provided parameters.

owner account has to have at least total_rewards balance. This fund will be transferred from owner to farm account.

The dispatch origin for this call must be T::CreateOrigin. !!!WARN: T::CreateOrigin has power over funds of owner’s account and it should be configured to trusted origin e.g Sudo or Governance.

Parameters:

• origin: global farm’s owner.
• total_rewards: total rewards planned to distribute. This rewards will be distributed between all yield farms in the global farm.
• planned_yielding_periods: planned number of periods to distribute total_rewards. WARN: THIS IS NOT HARD DEADLINE. Not all rewards have to be distributed in planned_yielding_periods. Rewards are distributed based on the situation in the yield farms and can be distributed in a longer time frame but never in the shorter time frame.
• blocks_per_period: number of blocks in a single period. Min. number of blocks per period is 1.
• incentivized_asset: asset to be incentivized in XYK pools. All yield farms added into liq. mining program have to have incentivized_asset in their pair.
• reward_currency: payoff currency of rewards.
• owner: liq. mining program owner.
• yield_per_period: percentage return on reward_currency of all farms p.a.
• min_deposit: minimum amount which can be deposited to the farm
• price_adjustment: Emits GlobalFarmCreated event when successful.

update_global_farm

Fields

global_farm_id: GlobalFarmId

price_adjustment: FixedU128

Update global farm’s prices adjustment.

Only farm’s owner can perform this action.

Parameters:

• origin: global farm’s owner.
• global_farm_id: id of the global farm to update
• price_adjustment: new value for price adjustment

Emits GlobalFarmUpdated event when successful.

terminate_global_farm

Fields

global_farm_id: GlobalFarmId

Terminate existing liq. mining program.

Only farm owner can perform this action.

WARN: To successfully terminate a farm, farm have to be empty(all yield farms in he global farm must be terminated).

Parameters:

• origin: global farm’s owner.
• global_farm_id: id of global farm to be terminated.

Emits GlobalFarmTerminated event when successful.

create_yield_farm

Fields

global_farm_id: GlobalFarmId

asset_pair: AssetPair

multiplier: FarmMultiplier

loyalty_curve: Option<LoyaltyCurve>

Add yield farm for given asset_pair XYK pool.

Only farm owner can perform this action.

Only XYKs with asset_pair with incentivized_asset can be added into the farm. XYK pool for asset_pair has to exist to successfully create yield farm. Yield farm for same asset_pair can exist only once in the global farm.

Parameters:

• origin: global farm’s owner.
• farm_id: global farm id to which a yield farm will be added.
• asset_pair: asset pair identifying yield farm. Liq. mining will be allowed for this asset_pair and one of the assets in the pair must be incentivized_asset.
• multiplier: yield farm multiplier.
• loyalty_curve: curve to calculate loyalty multiplier to distribute rewards to users with time incentive. None means no loyalty multiplier.

Emits YieldFarmCreated event when successful.

update_yield_farm

Fields

global_farm_id: GlobalFarmId

asset_pair: AssetPair

multiplier: FarmMultiplier

Update yield farm multiplier.

Only farm owner can perform this action.

Parameters:

• origin: global farm’s owner.
• global_farm_id: global farm id in which yield farm will be updated.
• asset_pair: asset pair identifying yield farm in global farm.
• multiplier: new yield farm multiplier.

Emits YieldFarmUpdated event when successful.

stop_yield_farm

Fields

global_farm_id: GlobalFarmId

asset_pair: AssetPair

Stop liq. miming for specific yield farm.

This function claims rewards from GlobalFarm last time and stops yield farm incentivization from a GlobalFarm. Users will be able to only withdraw shares(with claiming) after calling this function. deposit_shares() and claim_rewards() are not allowed on canceled yield farm.

Only farm owner can perform this action.

Parameters:

• origin: global farm’s owner.
• global_farm_id: farm id in which yield farm will be canceled.
• asset_pair: asset pair identifying yield farm in the farm.

Emits YieldFarmStopped event when successful.

resume_yield_farm

Fields

global_farm_id: GlobalFarmId

yield_farm_id: YieldFarmId

asset_pair: AssetPair

multiplier: FarmMultiplier

Resume yield farm for stopped yield farm.

This function resume incentivization from GlobalFarm and restore full functionality for yield farm. Users will be able to deposit, claim and withdraw again.

WARN: Yield farm is NOT rewarded for time it was stopped.

Only farm owner can perform this action.

Parameters:

• origin: global farm’s owner.
• global_farm_id: global farm id in which yield farm will be resumed.
• yield_farm_id: id of yield farm to be resumed.
• asset_pair: asset pair identifying yield farm in global farm.
• multiplier: yield farm multiplier in the farm.

Emits YieldFarmResumed event when successful.

terminate_yield_farm

Fields

global_farm_id: GlobalFarmId

yield_farm_id: YieldFarmId

asset_pair: AssetPair

Remove yield farm

This function marks a yield farm as ready to be removed from storage when it’s empty. Users will be able to only withdraw shares(without claiming rewards from yield farm). Unpaid rewards will be transferred back to global farm and will be used to distribute to other yield farms.

Yield farm must be stopped before calling this function.

Only global farm’s owner can perform this action. Yield farm stays in the storage until it’s empty(all farm entries are withdrawn). Last withdrawn from yield farm trigger removing from the storage.

Parameters:

• origin: global farm’s owner.
• global_farm_id: farm id from which yield farm should be terminated.
• yield_farm_id: id of yield farm to be terminated.
• asset_pair: asset pair identifying yield farm in the global farm.

Emits YieldFarmTerminated event when successful.

deposit_shares

Fields

global_farm_id: GlobalFarmId

yield_farm_id: YieldFarmId

asset_pair: AssetPair

shares_amount: Balance

Deposit LP shares to a liq. mining.

This function transfers LP shares from origin to pallet’s account and mint nft for origin account. Minted nft represents deposit in the liq. mining.

Parameters:

• origin: account depositing LP shares. This account has to have at least shares_amount of LP shares.
• global_farm_id: id of global farm to which user wants to deposit LP shares.
• yield_farm_id: id of yield farm to deposit to.
• asset_pair: asset pair identifying LP shares user wants to deposit.
• shares_amount: amount of LP shares user wants to deposit.

Emits SharesDeposited event when successful.

redeposit_shares

Fields

global_farm_id: GlobalFarmId

yield_farm_id: YieldFarmId

asset_pair: AssetPair

deposit_id: DepositId

Redeposit already locked LP shares to another yield farm.

This function create yield farm entry for existing deposit. LP shares are not transferred and amount of LP shares is based on existing deposit.

This function DOESN’T create new deposit.

Parameters:

• origin: account depositing LP shares. This account have to have at least
• global_farm_id: global farm identifier.
• yield_farm_id: yield farm identifier redepositing to.
• asset_pair: asset pair identifying LP shares user want to deposit.
• deposit_id: identifier of the deposit.

Emits SharesRedeposited event when successful.

claim_rewards

Fields

deposit_id: DepositId

yield_farm_id: YieldFarmId

Claim rewards from liq. mining for deposit represented by nft_id.

This function calculate user rewards from liq. mining and transfer rewards to origin account. Claiming in the same period is allowed only once.

Parameters:

• origin: account owner of deposit(nft).
• deposit_id: nft id representing deposit in the yield farm.
• yield_farm_id: yield farm identifier to claim rewards from.

Emits RewardClaimed event when successful.

withdraw_shares

Fields

deposit_id: DepositId

yield_farm_id: YieldFarmId

asset_pair: AssetPair

Withdraw LP shares from liq. mining with reward claiming if possible.

List of possible cases of transfers of LP shares and claimed rewards:

• yield farm is active(yield farm is not stopped) - claim and transfer rewards(if it wasn’t claimed in this period) and transfer LP shares.
• liq. mining is stopped - claim and transfer rewards(if it wasn’t claimed in this period) and transfer LP shares.
• yield farm was terminated - only LP shares will be transferred.
• farm was terminated - only LP shares will be transferred.

User’s unclaimable rewards will be transferred back to global farm’s account.

Parameters:

• origin: account owner of deposit(nft).
• deposit_id: nft id representing deposit in the yield farm.
• yield_farm_id: yield farm identifier to dithdraw shares from.
• asset_pair: asset pair identifying yield farm in global farm.

Emits:

• RewardClaimed if claim happen
• SharesWithdrawn event when successful

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_create_global_farm(
    total_rewards: Balance,
    planned_yielding_periods: <T as Config>::BlockNumber,
    blocks_per_period: BlockNumberFor<T>,
    incentivized_asset: AssetId,
    reward_currency: AssetId,
    owner: T::AccountId,
    yield_per_period: Perquintill,
    min_deposit: Balance,
    price_adjustment: FixedU128
) -> Self

Create a call with the variant create_global_farm.

pub fn new_call_variant_update_global_farm(
    global_farm_id: GlobalFarmId,
    price_adjustment: FixedU128
) -> Self

Create a call with the variant update_global_farm.

pub fn new_call_variant_terminate_global_farm(
    global_farm_id: GlobalFarmId
) -> Self

Create a call with the variant terminate_global_farm.

pub fn new_call_variant_create_yield_farm(
    global_farm_id: GlobalFarmId,
    asset_pair: AssetPair,
    multiplier: FarmMultiplier,
    loyalty_curve: Option<LoyaltyCurve>
) -> Self

Create a call with the variant create_yield_farm.

pub fn new_call_variant_update_yield_farm(
    global_farm_id: GlobalFarmId,
    asset_pair: AssetPair,
    multiplier: FarmMultiplier
) -> Self

Create a call with the variant update_yield_farm.

pub fn new_call_variant_stop_yield_farm(
    global_farm_id: GlobalFarmId,
    asset_pair: AssetPair
) -> Self

Create a call with the variant stop_yield_farm.

pub fn new_call_variant_resume_yield_farm(
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair,
    multiplier: FarmMultiplier
) -> Self

Create a call with the variant resume_yield_farm.

pub fn new_call_variant_terminate_yield_farm(
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair
) -> Self

Create a call with the variant terminate_yield_farm.

pub fn new_call_variant_deposit_shares(
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair,
    shares_amount: Balance
) -> Self

Create a call with the variant deposit_shares.

pub fn new_call_variant_redeposit_shares(
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair,
    deposit_id: DepositId
) -> Self

Create a call with the variant redeposit_shares.

pub fn new_call_variant_claim_rewards(
    deposit_id: DepositId,
    yield_farm_id: YieldFarmId
) -> Self

Create a call with the variant claim_rewards.

pub fn new_call_variant_withdraw_shares(
    deposit_id: DepositId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair
) -> Self

Create a call with the variant withdraw_shares.

Trait Implementations

impl<T: Config> Clone for Call<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Config> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

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> Encode for Call<T>

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> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names.

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq<Call<T>> for Call<T>

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> TypeInfo for Call<T>where
    PhantomData<(T,)>: TypeInfo + 'static,
    <T as Config>::BlockNumber: TypeInfo + 'static,
    BlockNumberFor<T>: TypeInfo + 'static,
    T::AccountId: TypeInfo + 'static,
    T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type Origin = <T as Config>::Origin

The origin type of the runtime, (i.e. frame_system::Config::Origin).

fn dispatch_bypass_filter(
    self,
    origin: Self::Origin
) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike<Call<T>> for Call<T>

impl<T: Config> Eq for Call<T>