XYKWarehouseLM¶

Events¶

AllRewardsDistributed¶

Global farm has no more rewards to distribute in the moment.

Attributes¶

Name	Type	Composition
global_farm_id	`GlobalFarmId`	`u32`

GlobalFarmAccRPZUpdated¶

Global farm accumulated reward per share was updated.

Attributes¶

Name	Type	Composition
global_farm_id	`GlobalFarmId`	`u32`
accumulated_rpz	`FixedU128`	`u128`
total_shares_z	`Balance`	`u128`

YieldFarmAccRPVSUpdated¶

Yield farm accumulated reward per valued share was updated.

Attributes¶

Name	Type	Composition
global_farm_id	`GlobalFarmId`	`u32`
yield_farm_id	`YieldFarmId`	`u32`
accumulated_rpvs	`FixedU128`	`u128`
total_valued_shares	`Balance`	`u128`

Storage functions¶

ActiveYieldFarm¶

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

Python¶

result = substrate.query(
    'XYKWarehouseLM', 'ActiveYieldFarm', ['AccountId', 'u32']
)

Return value¶

'u32'

Deposit¶

Deposit details.

Python¶

result = substrate.query(
    'XYKWarehouseLM', 'Deposit', ['u128']
)

Return value¶

{
    'amm_pool_id': 'AccountId',
    'shares': 'u128',
    'yield_farm_entries': [
        {
            'accumulated_claimed_rewards': 'u128',
            'accumulated_rpvs': 'u128',
            'entered_at': 'u32',
            'global_farm_id': 'u32',
            'stopped_at_creation': 'u32',
            'updated_at': 'u32',
            'valued_shares': 'u128',
            'yield_farm_id': 'u32',
        },
    ],
}

DepositSequencer¶

Python¶

result = substrate.query(
    'XYKWarehouseLM', 'DepositSequencer', []
)

Return value¶

'u128'

FarmSequencer¶

Id sequencer for GlobalFarm and YieldFarm.

Python¶

result = substrate.query(
    'XYKWarehouseLM', 'FarmSequencer', []
)

Return value¶

'u32'

GlobalFarm¶

Python¶

result = substrate.query(
    'XYKWarehouseLM', 'GlobalFarm', ['u32']
)

Return value¶

{
    'accumulated_paid_rewards': 'u128',
    'accumulated_rpz': 'u128',
    'blocks_per_period': 'u32',
    'id': 'u32',
    'incentivized_asset': 'u32',
    'live_yield_farms_count': 'u32',
    'max_reward_per_period': 'u128',
    'min_deposit': 'u128',
    'owner': 'AccountId',
    'pending_rewards': 'u128',
    'planned_yielding_periods': 'u32',
    'price_adjustment': 'u128',
    'reward_currency': 'u32',
    'state': ('Active', 'Stopped', 'Terminated'),
    'total_shares_z': 'u128',
    'total_yield_farms_count': 'u32',
    'updated_at': 'u32',
    'yield_per_period': 'u64',
}

YieldFarm¶

Yield farm details.

Python¶

result = substrate.query(
    'XYKWarehouseLM', 'YieldFarm', ['AccountId', 'u32', 'u32']
)

Return value¶

{
    'accumulated_rpvs': 'u128',
    'accumulated_rpz': 'u128',
    'entries_count': 'u64',
    'id': 'u32',
    'left_to_distribute': 'u128',
    'loyalty_curve': (
        None,
        {'initial_reward_percentage': 'u128', 'scale_coef': 'u32'},
    ),
    'multiplier': 'u128',
    'state': ('Active', 'Stopped', 'Terminated'),
    'total_shares': 'u128',
    'total_stopped': 'u32',
    'total_valued_shares': 'u128',
    'updated_at': 'u32',
}

Constants¶

MaxFarmEntriesPerDeposit¶

Maximum number of yield farms same LP shares can be re/deposited into. This value always MUST BE >= 1.

Value¶

Python¶

constant = substrate.get_constant('XYKWarehouseLM', 'MaxFarmEntriesPerDeposit')

MaxYieldFarmsPerGlobalFarm¶

Max number of yield farms can exist in global farm. This includes all farms in the storage(active, stopped, terminated).

Value¶

Python¶

constant = substrate.get_constant('XYKWarehouseLM', 'MaxYieldFarmsPerGlobalFarm')

MinPlannedYieldingPeriods¶

Minimum number of periods to run liquidity mining program.

Value¶

Python¶

constant = substrate.get_constant('XYKWarehouseLM', 'MinPlannedYieldingPeriods')

MinTotalFarmRewards¶

Minimum total rewards to distribute from global farm during liquidity mining.

Value¶

100000000000000

Python¶

constant = substrate.get_constant('XYKWarehouseLM', 'MinTotalFarmRewards')

PalletId¶

Pallet id.

Value¶

'0x57686f7573654c6d'

Python¶

constant = substrate.get_constant('XYKWarehouseLM', 'PalletId')

Errors¶

DoubleClaimInPeriod¶

Multiple claims in the same period is not allowed.

DoubleLock¶

Trying to lock LP shares into already locked yield farm.

ErrorGetAccountId¶

Account creation from id failed.

Forbidden¶

Account is not allowed to perform action.

GlobalFarmIsFull¶

Max number of yield farms in global farm was reached. Global farm can't accept new yield farms until some yield farm is not removed from storage.

GlobalFarmIsNotEmpty¶

One or more yield farms exist in global farm.

GlobalFarmNotFound¶

Global farm does not exist.

IncentivizedAssetNotRegistered¶

incentivized_asset is not registered in asset registry.

InconsistentState¶

Action cannot be completed because unexpected error has occurred. This should be reported to protocol maintainers.

IncorrectValuedShares¶

Value of deposited shares amount in reward currency is bellow min. limit.

InsufficientRewardCurrencyBalance¶

Reward currency balance is not sufficient.

InvalidBlocksPerPeriod¶

Blocks per period can't be 0.

InvalidDepositAmount¶

LP shares amount is not valid.

InvalidInitialRewardPercentage¶

Loyalty curve's initial reward percentage is not valid. Valid range is: [0, 1).

InvalidMinDeposit¶

Invalid min. deposit was set for global farm.

InvalidMultiplier¶

Yield farm multiplier can't be 0.

InvalidPlannedYieldingPeriods¶

Planned yielding periods is less than MinPlannedYieldingPeriods.

InvalidPriceAdjustment¶

Price adjustment multiplier can't be 0.

InvalidTotalRewards¶

Total rewards is less than MinTotalFarmRewards.

InvalidYieldPerPeriod¶

Yield per period can't be 0.

LiquidityMiningCanceled¶

Liquidity mining is canceled.

LiquidityMiningIsActive¶

Liquidity mining is not canceled.

LiquidityMiningIsNotStopped¶

Liquidity mining is in active or terminated state and action cannot be completed.

MaxEntriesPerDeposit¶

Maximum number of locks reached for deposit.

MissingIncentivizedAsset¶

Farm's incentivized_asset is missing in provided asset pair.

RewardCurrencyNotRegistered¶

reward_currency is not registered in asset registry.

YieldFarmAlreadyExists¶

Yield farm with given amm_pool_id already exists in global farm.

YieldFarmEntryNotFound¶

Yield farm entry doesn't exist for given deposit.

YieldFarmNotFound¶

Yield farm does not exist.