Struct pallet_xyk::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_pool(
    origin: OriginFor<T>,
    asset_a: AssetId,
    amount_a: Balance,
    asset_b: AssetId,
    amount_b: Balance
) -> DispatchResult

Create new pool for given asset pair.

Registers new pool for given asset pair (asset a and asset b) in asset registry. Asset registry creates new id or returns previously created one if such pool existed before.

Pool is created with initial liquidity provided by origin. Shares are issued with specified initial price and represents proportion of asset in the pool.

Emits PoolCreated event when successful.

pub fn add_liquidity(
    origin: OriginFor<T>,
    asset_a: AssetId,
    asset_b: AssetId,
    amount_a: Balance,
    amount_b_max_limit: Balance
) -> DispatchResult

Add liquidity to previously created asset pair pool.

Shares are issued with current price.

Emits LiquidityAdded event when successful.

pub fn remove_liquidity(
    origin: OriginFor<T>,
    asset_a: AssetId,
    asset_b: AssetId,
    liquidity_amount: Balance
) -> DispatchResult

Remove liquidity from specific liquidity pool in the form of burning shares.

If liquidity in the pool reaches 0, it is destroyed.

Emits ‘LiquidityRemoved’ when successful. Emits ‘PoolDestroyed’ when pool is destroyed.

pub fn sell(
    origin: OriginFor<T>,
    asset_in: AssetId,
    asset_out: AssetId,
    amount: Balance,
    max_limit: Balance,
    discount: bool
) -> DispatchResult

Trade asset in for asset out.

Executes a swap of asset_in for asset_out. Price is determined by the liquidity pool.

max_limit - minimum amount of asset_out / amount of asset_out to be obtained from the pool in exchange for asset_in.

Emits SellExecuted when successful.

pub fn buy(
    origin: OriginFor<T>,
    asset_out: AssetId,
    asset_in: AssetId,
    amount: Balance,
    max_limit: Balance,
    discount: bool
) -> DispatchResult

Trade asset in for asset out.

Executes a swap of asset_in for asset_out. Price is determined by the liquidity pool.

max_limit - maximum amount of asset_in to be sold in exchange for asset_out.

Emits BuyExecuted when successful.

impl<T: Config> Pallet<T>

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

impl<T: Config> Pallet<T>

pub fn share_token<KArg>(k: KArg) -> AssetIdwhere
    KArg: EncodeLike<T::AccountId>,

Asset id storage for shared pool tokens

impl<T: Config> Pallet<T>

pub fn total_liquidity<KArg>(k: KArg) -> Balancewhere
    KArg: EncodeLike<T::AccountId>,

Total liquidity in a pool.

impl<T: Config> Pallet<T>

pub fn pool_assets<KArg>(k: KArg) -> Option<(AssetId, AssetId)>where
    KArg: EncodeLike<T::AccountId>,

Asset pair in a pool.

impl<T: Config> Pallet<T>

pub fn get_pool_balances(
    pool_address: T::AccountId
) -> Option<Vec<(AssetId, Balance)>>

Return balance of each asset in selected liquidity pool.

pub(crate) fn calculate_discounted_fee(
    amount: Balance
) -> Result<Balance, DispatchError>

Calculate discounted trade fee

pub(crate) fn calculate_fee(amount: Balance) -> Result<Balance, DispatchError>

Calculate trade fee

pub fn pair_account_from_assets(
    asset_a: AssetId,
    asset_b: AssetId
) -> T::AccountId

Trait Implementations

impl<T: Config> AMM<<T as Config>::AccountId, u32, AssetPair, u128> for Pallet<T>

fn validate_sell(
    who: &T::AccountId,
    assets: AssetPair,
    amount: Balance,
    min_bought: Balance,
    discount: bool
) -> Result<AMMTransfer<T::AccountId, AssetId, AssetPair, Balance>, DispatchError>

Validate a sell. Perform all necessary checks and calculations. No storage changes are performed yet.

Return AMMTransfer with all info needed to execute the transaction.

fn execute_sell(
    transfer: &AMMTransfer<T::AccountId, AssetId, AssetPair, Balance>
) -> DispatchResult

Execute sell. validate_sell must be called first. Perform necessary storage/state changes. Note : the execution should not return error as everything was previously verified and validated.

fn validate_buy(
    who: &T::AccountId,
    assets: AssetPair,
    amount: Balance,
    max_limit: Balance,
    discount: bool
) -> Result<AMMTransfer<T::AccountId, AssetId, AssetPair, Balance>, DispatchError>

Validate a buy. Perform all necessary checks and calculations. No storage changes are performed yet.

Return AMMTransfer with all info needed to execute the transaction.

fn execute_buy(
    transfer: &AMMTransfer<T::AccountId, AssetId, AssetPair, Balance>
) -> DispatchResult

Execute buy. validate_buy must be called first. Perform necessary storage/state changes. Note : the execution should not return error as everything was previously verified and validated.

fn exists(assets: AssetPair) -> bool

Check if both assets exist in a pool.

fn get_pair_id(assets: AssetPair) -> T::AccountId

Return pair account.

fn get_share_token(assets: AssetPair) -> AssetId

Return share token for assets.

fn get_pool_assets(pool_account_id: &T::AccountId) -> Option<Vec<AssetId>>

Return list of active assets in a given pool.

fn get_spot_price_unchecked(
    asset_a: AssetId,
    asset_b: AssetId,
    amount: Balance
) -> Balance

Calculate spot price for asset a and b.

fn get_min_trading_limit() -> Balance

fn get_min_pool_liquidity() -> Balance

fn get_max_in_ratio() -> u128

fn get_max_out_ratio() -> u128

fn get_fee(_pool_account_id: &T::AccountId) -> (u32, u32)

fn sell(
    origin: &AccountId,
    assets: AssetPair,
    amount: Amount,
    min_bought: Amount,
    discount: bool
) -> Result<(), DispatchError>

Perform asset swap. Call execute following the validation.

fn buy(
    origin: &AccountId,
    assets: AssetPair,
    amount: Amount,
    max_limit: Amount,
    discount: bool
) -> Result<(), DispatchError>

Perform asset swap.

impl<T: Config> AMMPosition<u32, u128> for Pallet<T>

type Error = DispatchError

fn get_liquidity_behind_shares(
    asset_a: AssetId,
    asset_b: AssetId,
    shares_amount: Balance
) -> Result<(Balance, Balance), Self::Error>

This function calculates amount of assets behind the share_tokens.

impl<T> Benchmarking for Pallet<T>where
    T: Config + Config,

fn benchmarks(extra: bool) -> Vec<BenchmarkMetadata>

Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”.

fn run_benchmark(
    extrinsic: &[u8],
    c: &[(BenchmarkParameter, u32)],
    whitelist: &[TrackedStorageKey],
    verify: bool,
    internal_repeats: u32
) -> Result<Vec<BenchmarkResult>, BenchmarkError>

Run the benchmarks for this pallet.

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 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.

fn integrity_test()

Run integrity test.

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> TradeExecution<<T as Config>::Origin, <T as Config>::AccountId, u32, u128> for Pallet<T>

type Error = DispatchError

fn calculate_sell(
    pool_type: PoolType<AssetId>,
    asset_in: AssetId,
    asset_out: AssetId,
    amount_in: Balance
) -> Result<Balance, ExecutorError<Self::Error>>

fn calculate_buy(
    pool_type: PoolType<AssetId>,
    asset_in: AssetId,
    asset_out: AssetId,
    amount_out: Balance
) -> Result<Balance, ExecutorError<Self::Error>>

fn execute_sell(
    who: T::Origin,
    pool_type: PoolType<AssetId>,
    asset_in: AssetId,
    asset_out: AssetId,
    amount_in: Balance,
    min_limit: Balance
) -> Result<(), ExecutorError<Self::Error>>

fn execute_buy(
    who: T::Origin,
    pool_type: PoolType<AssetId>,
    asset_in: AssetId,
    asset_out: AssetId,
    amount_out: Balance,
    max_limit: Balance
) -> Result<(), ExecutorError<Self::Error>>

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>