Struct liquidity_proxy::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn swap( origin: OriginFor<T>, dex_id: T::DEXId, input_asset_id: T::AssetId, output_asset_id: T::AssetId, swap_amount: SwapAmount<Balance>, selected_source_types: Vec<LiquiditySourceType>, filter_mode: FilterMode ) -> DispatchResultWithPostInfo

Perform swap of tokens (input/output defined via SwapAmount direction).

• origin: the account on whose behalf the transaction is being executed,
• dex_id: DEX ID for which liquidity sources aggregation is being done,
• input_asset_id: ID of the asset being sold,
• output_asset_id: ID of the asset being bought,
• swap_amount: the exact amount to be sold (either in input_asset_id or output_asset_id units with corresponding slippage tolerance absolute bound),
• selected_source_types: list of selected LiquiditySource types, selection effect is determined by filter_mode,
• filter_mode: indicate either to allow or forbid selected types only, or disable filtering.

pub fn swap_transfer( origin: OriginFor<T>, receiver: T::AccountId, dex_id: T::DEXId, input_asset_id: T::AssetId, output_asset_id: T::AssetId, swap_amount: SwapAmount<Balance>, selected_source_types: Vec<LiquiditySourceType>, filter_mode: FilterMode ) -> DispatchResultWithPostInfo

Perform swap of tokens (input/output defined via SwapAmount direction).

• origin: the account on whose behalf the transaction is being executed,
• receiver: the account that receives the output,
• dex_id: DEX ID for which liquidity sources aggregation is being done,
• input_asset_id: ID of the asset being sold,
• output_asset_id: ID of the asset being bought,
• swap_amount: the exact amount to be sold (either in input_asset_id or output_asset_id units with corresponding slippage tolerance absolute bound),
• selected_source_types: list of selected LiquiditySource types, selection effect is determined by filter_mode,
• filter_mode: indicate either to allow or forbid selected types only, or disable filtering.

pub fn swap_transfer_batch( origin: OriginFor<T>, swap_batches: Vec<SwapBatchInfo<T::AssetId, T::DEXId, T::AccountId>>, input_asset_id: T::AssetId, max_input_amount: Balance, selected_source_types: Vec<LiquiditySourceType>, filter_mode: FilterMode ) -> DispatchResultWithPostInfo

Dispatches multiple swap & transfer operations. swap_batches contains vector of SwapBatchInfo structs, where each batch specifies which asset ID and DEX ID should be used for swapping, receiver accounts and their desired outcome amount in asset, specified for the current batch.

• origin: the account on whose behalf the transaction is being executed,
• swap_batches: the vector containing the SwapBatchInfo structs,
• input_asset_id: ID of the asset being sold,
• max_input_amount: the maximum amount to be sold in input_asset_id,
• selected_source_types: list of selected LiquiditySource types, selection effect is determined by filter_mode,
• filter_mode: indicate either to allow or forbid selected types only, or disable filtering.

pub fn enable_liquidity_source( origin: OriginFor<T>, liquidity_source: LiquiditySourceType ) -> DispatchResultWithPostInfo

Enables XST or TBC liquidity source.

• liquidity_source: the liquidity source to be enabled.

pub fn disable_liquidity_source( origin: OriginFor<T>, liquidity_source: LiquiditySourceType ) -> DispatchResultWithPostInfo

Disables XST or TBC liquidity source. The liquidity source becomes unavailable for swap.

• liquidity_source: the liquidity source to be disabled.

pub fn set_adar_commission_ratio( origin: OriginFor<T>, commission_ratio: Balance ) -> DispatchResultWithPostInfo

impl<T: Config> Pallet<T>

pub fn adar_commission_ratio() -> Balance

ADAR commission ratio

impl<T: Config> Pallet<T>

pub fn is_forbidden_filter( input_asset_id: &T::AssetId, output_asset_id: &T::AssetId, selected_source_types: &Vec<LiquiditySourceType>, filter_mode: &FilterMode ) -> bool

Temporary workaround to prevent tbc oracle exploit with xyk-only filter.

pub fn check_indivisible_assets( input_asset_id: &T::AssetId, output_asset_id: &T::AssetId ) -> Result<(), DispatchError>

pub fn inner_swap( sender: T::AccountId, receiver: T::AccountId, dex_id: T::DEXId, input_asset_id: T::AssetId, output_asset_id: T::AssetId, swap_amount: SwapAmount<Balance>, selected_source_types: Vec<LiquiditySourceType>, filter_mode: FilterMode ) -> Result<Weight, DispatchError>

pub fn inner_exchange( dex_id: T::DEXId, sender: &T::AccountId, receiver: &T::AccountId, input_asset_id: &T::AssetId, output_asset_id: &T::AssetId, amount: SwapAmount<Balance>, filter: LiquiditySourceFilter<T::DEXId, LiquiditySourceType> ) -> Result<(SwapOutcome<Balance>, Vec<LiquiditySourceId<<T as Config>::DEXId, LiquiditySourceType>>, Weight), DispatchError>

Applies trivial routing (via Base Asset), resulting in a poly-swap which may contain several individual swaps. Those individual swaps are subject to liquidity aggregation algorithm.

This a wrapper for exchange_single.

pub fn inner_quote( dex_id: T::DEXId, input_asset_id: &T::AssetId, output_asset_id: &T::AssetId, amount: QuoteAmount<Balance>, filter: LiquiditySourceFilter<T::DEXId, LiquiditySourceType>, skip_info: bool, deduce_fee: bool ) -> Result<(QuoteInfo<T::AssetId, LiquiditySourceId<<T as Config>::DEXId, LiquiditySourceType>>, Weight), DispatchError>

Applies trivial routing (via Base Asset), resulting in a poly-swap which may contain several individual swaps. Those individual swaps are subject to liquidity aggregation algorithm.

This a wrapper for quote_single.

pub fn is_path_available( dex_id: T::DEXId, input_asset_id: T::AssetId, output_asset_id: T::AssetId ) -> Result<bool, DispatchError>

Check if given two arbitrary tokens can be used to perform an exchange via any available sources.

pub fn check_asset_path( dex_id: &T::DEXId, dex_info: &DEXInfo<T::AssetId>, path: &[T::AssetId] ) -> bool

Checks if the path, consisting of sequential swaps of assets in path, is available and if it is, then returns Ok(true)

pub fn get_asset_path_sources( dex_id: &T::DEXId, dex_info: &DEXInfo<T::AssetId>, path: &[T::AssetId] ) -> Result<BTreeSet<LiquiditySourceType>, DispatchError>

Returns a BTreeSet with all LiquiditySourceTypes, which will be used for swap

pub fn inner_exchange_weight( dex_id: &T::DEXId, input: &T::AssetId, output: &T::AssetId, swap_variant: SwapVariant ) -> Weight

Calculates the max potential weight of inner_exchange

This function should cover the current code map and all possible calls of some functions that can take a weight. The current code map:

inner_exchange() new_trivial() exchange_sequence() select_best_path() quote_pairs_with_flexible_amount() - call M times, where M is a count of paths quote_single() list_liquidity_sources() quote() smart_split() quote() quote() check_rewards() quote() check_rewards() calculate_input_amount() - call only for SwapAmount::WithDesiredOutput quote_single() list_liquidity_sources() quote() smart_split() quote() quote() check_rewards() quote() check_rewards() exchange_sequence_with_input_amount() exchange_single() quote_single() list_liquidity_sources() quote() smart_split() quote() quote() check_rewards() quote() check_rewards() exchange() - call N times, where N is a count of assets in the path

Dev NOTE: if you change the logic of liquidity proxy, please sustain inner_exchange_weight() and code map above.

pub fn swap_weight( dex_id: &T::DEXId, input: &T::AssetId, output: &T::AssetId, swap_variant: SwapVariant ) -> Weight

Calculates the max potential weight of swap

This function should cover the current code map and all possible calls of some functions that can take a weight. The current code map:

swap() inner_swap() check_indivisible_assets() is_forbidden_filter() inner_exchange()

Dev NOTE: if you change the logic of liquidity proxy, please sustain swap_weight() and code map above.

pub fn swap_transfer_batch_weight( swap_batches: &Vec<SwapBatchInfo<T::AssetId, T::DEXId, T::AccountId>>, input: &T::AssetId ) -> Weight

Calculates the max potential weight of swap_transfer_batch

This function should cover the current code map and all possible calls of some functions that can take a weight. The current code map:

swap_transfer_batch inner_swap_batch_transfer loop - call swap_batches.len() times exchange_batch_tokens check_indivisible_assets is_forbidden_filter inner_exchange transfer_batch_tokens_unchecked loop - call swap_batch_info.receivers.len() times transfer_from transfer_from

Dev NOTE: if you change the logic of liquidity proxy, please sustain swap_transfer_batch_weight() and code map above.

pub fn list_enabled_sources_for_path( dex_id: T::DEXId, input_asset_id: T::AssetId, output_asset_id: T::AssetId ) -> Result<Vec<LiquiditySourceType>, DispatchError>

Given two arbitrary tokens return sources that can be used to cover full path. If there are two possible swap paths, then returns a union of used liquidity sources

pub fn list_enabled_sources_for_path_with_xyk_forbidden( dex_id: T::DEXId, input_asset_id: T::AssetId, output_asset_id: T::AssetId ) -> Result<Vec<LiquiditySourceType>, DispatchError>

Trait Implementations

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

type RuntimeCall = 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 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> LiquidityProxyTrait<<T as Config>::DEXId, <T as Config>::AccountId, <T as Config>::AssetId> for Pallet<T>

fn quote( dex_id: T::DEXId, input_asset_id: &T::AssetId, output_asset_id: &T::AssetId, amount: QuoteAmount<Balance>, filter: LiquiditySourceFilter<T::DEXId, LiquiditySourceType>, deduce_fee: bool ) -> Result<SwapOutcome<Balance>, DispatchError>

Applies trivial routing (via Base Asset), resulting in a poly-swap which may contain several individual swaps. Those individual swaps are subject to liquidity aggregation algorithm.

This is a wrapper for quote_single.

fn exchange( dex_id: T::DEXId, sender: &T::AccountId, receiver: &T::AccountId, input_asset_id: &T::AssetId, output_asset_id: &T::AssetId, amount: SwapAmount<Balance>, filter: LiquiditySourceFilter<T::DEXId, LiquiditySourceType> ) -> Result<SwapOutcome<Balance>, DispatchError>

Applies trivial routing (via Base Asset), resulting in a poly-swap which may contain several individual swaps. Those individual swaps are subject to liquidity aggregation algorithm.

This is a wrapper for exchange_single.

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.

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

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>