Struct pallet_xyk_liquidity_mining::pallet::Pallet

pub struct Pallet<T>(PhantomData<T>);

The pallet implementing the on-chain logic.

Tuple Fields

0: PhantomData<T>

Implementations

impl<T: Config> Pallet<T>

pub fn create_global_farm(
    origin: OriginFor<T>,
    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
) -> DispatchResult

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.

pub fn update_global_farm(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    price_adjustment: FixedU128
) -> DispatchResult

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.

pub fn terminate_global_farm(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId
) -> DispatchResult

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.

pub fn create_yield_farm(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    asset_pair: AssetPair,
    multiplier: FarmMultiplier,
    loyalty_curve: Option<LoyaltyCurve>
) -> DispatchResult

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.

pub fn update_yield_farm(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    asset_pair: AssetPair,
    multiplier: FarmMultiplier
) -> DispatchResult

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.

pub fn stop_yield_farm(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    asset_pair: AssetPair
) -> DispatchResult

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.

pub fn resume_yield_farm(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair,
    multiplier: FarmMultiplier
) -> DispatchResult

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.

pub fn terminate_yield_farm(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair
) -> DispatchResult

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.

pub fn deposit_shares(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair,
    shares_amount: Balance
) -> DispatchResult

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.

pub fn redeposit_shares(
    origin: OriginFor<T>,
    global_farm_id: GlobalFarmId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair,
    deposit_id: DepositId
) -> DispatchResult

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.

pub fn claim_rewards(
    origin: OriginFor<T>,
    deposit_id: DepositId,
    yield_farm_id: YieldFarmId
) -> DispatchResult

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.

pub fn withdraw_shares(
    origin: OriginFor<T>,
    deposit_id: DepositId,
    yield_farm_id: YieldFarmId,
    asset_pair: AssetPair
) -> DispatchResult

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

impl<T: Config> Pallet<T>

pub(crate) fn deposit_event(event: Event<T>)

impl<T: Config> Pallet<T>

pub(crate) fn account_id() -> T::AccountId

Account ID of the pot holding locked LP shares. This account is also owner of NFT class for all the NFTs minted by this pallet.

pub(crate) fn get_lp_token(
    amm_pool_id: &T::AccountId
) -> Result<AssetId, Error<T>>

pub(crate) fn lock_lp_tokens(
    lp_token: AssetId,
    who: &T::AccountId,
    amount: Balance
) -> Result<(), DispatchError>

pub(crate) fn unlock_lp_tokens(
    lp_token: AssetId,
    who: &T::AccountId,
    amount: Balance
) -> Result<(), DispatchError>

pub(crate) fn get_token_value_of_lp_shares(
    asset: AssetId,
    amm_pool_id: T::AccountId,
    lp_shares_amount: Balance
) -> Result<Balance, DispatchError>

This function retuns value of lp tokens in the asset currency.

pub(crate) fn ensure_xyk(
    asset_pair: AssetPair
) -> Result<T::AccountId, Error<T>>

pub(crate) fn ensure_nft_owner(
    origin: OriginFor<T>,
    deposit_id: DepositId
) -> Result<T::AccountId, DispatchError>

Trait Implementations

impl<T: Config> Callable<T> for Pallet<T>

type Call = Call<T>

impl<T> Clone for Pallet<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> Debug for Pallet<T>

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

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

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> Hooks<<T as Config>::BlockNumber> for Pallet<T>

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> IntegrityTest for Pallet<T>

fn integrity_test()

Run integrity test.

impl<T: Config> OffchainWorker<<T as Config>::BlockNumber> for Pallet<T>

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

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

impl<T: Config> OnFinalize<<T as Config>::BlockNumber> for Pallet<T>

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

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

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<T as Config>::BlockNumber> for Pallet<T>

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> OnInitialize<<T as Config>::BlockNumber> for Pallet<T>

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

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

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

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> PalletInfoAccess for Pallet<T>

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> PalletsInfoAccess for Pallet<T>

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> PartialEq<Pallet<T>> for Pallet<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: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> TryState<<T as Config>::BlockNumber> for Pallet<T>

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

Execute the state checks.

impl<T> Eq for Pallet<T>