Struct xst::pallet::Pallet

pub struct Pallet<T>(_);

The pallet implementing the on-chain logic.

Implementations

impl<T: Config> Pallet<T>

pub fn set_reference_asset( origin: OriginFor<T>, reference_asset_id: T::AssetId ) -> DispatchResultWithPostInfo

Change reference asset which is used to determine collateral assets value. Intended to be e.g., stablecoin DAI.

• origin: the sudo account on whose behalf the transaction is being executed,
• reference_asset_id: asset id of the new reference asset.

pub fn enable_synthetic_asset( origin: OriginFor<T>, asset_id: T::AssetId, reference_symbol: T::Symbol, fee_ratio: Fixed ) -> DispatchResultWithPostInfo

pub fn register_synthetic_asset( origin: OriginFor<T>, asset_symbol: AssetSymbol, asset_name: AssetName, reference_symbol: T::Symbol, fee_ratio: Fixed ) -> DispatchResultWithPostInfo

Register and enable new synthetic asset with reference_symbol price binding

pub fn disable_synthetic_asset( origin: OriginFor<T>, synthetic_asset: T::AssetId ) -> DispatchResultWithPostInfo

Disable synthetic asset.

Removes synthetic from exchanging and removes XSTPool liquidity source for corresponding trading pair.

• origin: the sudo account on whose behalf the transaction is being executed,
• synthetic_asset: synthetic asset id to disable.

pub fn remove_synthetic_asset( origin: OriginFor<T>, synthetic_asset: T::AssetId ) -> DispatchResultWithPostInfo

Entirely remove synthetic asset (including linked symbol info)

pub fn set_synthetic_asset_fee( origin: OriginFor<T>, synthetic_asset: T::AssetId, fee_ratio: Fixed ) -> DispatchResultWithPostInfo

Set synthetic asset fee.

This fee will be used to determine the amount of synthetic base asset (e.g. XST) to be burned when user buys synthetic asset.

• origin: the sudo account on whose behalf the transaction is being executed,
• synthetic_asset: synthetic asset id to set fee for,
• fee_ratio: fee ratio with precision = 18, so 1000000000000000000 = 1 = 100% fee.

pub fn set_synthetic_base_asset_floor_price( origin: OriginFor<T>, floor_price: Balance ) -> DispatchResultWithPostInfo

Set floor price for the synthetic base asset

• origin: root account
• floor_price: floor price for the synthetic base asset

impl<T: Config> Pallet<T>

pub fn enabled_synthetics<KArg>(k: KArg) -> Option<SyntheticInfo<T::Symbol>>where KArg: EncodeLike<T::AssetId>,

Synthetic assets and their reference symbols.

It’s a programmer responsibility to keep this collection consistent with EnabledSymbols.

impl<T: Config> Pallet<T>

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

Reference symbols and their synthetic assets.

It’s a programmer responsibility to keep this collection consistent with EnabledSynthetics.

impl<T: Config> Pallet<T>

pub fn reference_asset_id() -> T::AssetId

Asset that is used to compare collateral assets by value, e.g., DAI.

impl<T: Config> Pallet<T>

pub fn synthetic_base_asset_floor_price() -> Balance

Floor price for the synthetic base asset.

impl<T: Config> Pallet<T>

pub fn buy_price( main_asset_id: &T::AssetId, synthetic_asset_id: &T::AssetId, quantity: QuoteAmount<Balance> ) -> Result<Fixed, DispatchError>

Calculates and returns the buying amount of synthetic main asset if the selling amount of synthetic asset is provided. In case if buying amount of synthetic main asset is provided, returns selling amount of synthetic asset.

Amount calculation

Main asset price calculation

main_asset_price is calculated by Self::reference_price supplied with Buy variant.

amount_in is the amount of the synthetic asset we want to sell amount_out is calculated and it is the amount of the synthetic main asset we want to buy

desired_amount_in variant

returns amount_out = amount_in * synthetic_asset_price / main_asset_price

desired_amount_out variant

returns amount_in = amount_out * main_asset_price / synthetic_asset_price

pub fn sell_price( main_asset_id: &T::AssetId, synthetic_asset_id: &T::AssetId, quantity: QuoteAmount<Balance> ) -> Result<Fixed, DispatchError>

Calculates and returns the selling amount of synthetic main asset if the buying amount of synthetic asset is provided. In case if selling amount of synthetic main asset is provided, returns buying amount of synthetic asset.

Amount calculation

Main asset price calculation

main_asset_price is calculated by Self::reference_price supplied with Sell variant.

amount_in is the amount of the synthetic asset we want to buy amount_out is calculated and it is the amount of the synthetic main asset we want to sell

desired_amount_in variant

returns amount_out = amount_in * main_asset_price / synthetic_asset_price

desired_amount_out variant

returns amount_in = amount_out * synthetic_asset_price / main_asset_price

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> GetMarketInfo<<T as Config>::AssetId> for Pallet<T>

fn enabled_target_assets() -> BTreeSet<T::AssetId>

target_assets refer to synthetic assets

fn buy_price( synthetic_base_asset: &T::AssetId, synthetic_asset: &T::AssetId ) -> Result<Fixed, DispatchError>

The price in terms of the target_asset at which one can buy a unit of the base_asset on the primary market (e.g. from the bonding curve pool or xst).

fn sell_price( synthetic_base_asset: &T::AssetId, synthetic_asset: &T::AssetId ) -> Result<Fixed, DispatchError>

The price in terms of the target_asset at which one can sell a unit of the base_asset on the primary market (e.g. to the bonding curve pool or xst).

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> LiquiditySource<<T as Config>::DEXId, <T as Config>::AccountId, <T as Config>::AssetId, u128, DispatchError> for Pallet<T>

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

Get spot price of synthetic tokens based on desired amount.

fn can_exchange( dex_id: &T::DEXId, input_asset_id: &T::AssetId, output_asset_id: &T::AssetId ) -> bool

Check if liquidity source provides an exchange from given input asset to output asset.

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

Perform exchange based on desired amount.

fn check_rewards( _dex_id: &T::DEXId, _input_asset_id: &T::AssetId, _output_asset_id: &T::AssetId, _input_amount: Balance, _output_amount: Balance ) -> Result<(Vec<(Balance, T::AssetId, RewardReason)>, Weight), DispatchError>

Get rewards that are given for perfoming given exchange.

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

Get spot price of tokens based on desired amount, ignoring non-linearity of underlying liquidity source.

fn quote_weight() -> Weight

Get weight of quote

fn exchange_weight() -> Weight

Get weight of exchange

fn check_rewards_weight() -> Weight

Get weight of exchange

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> OnSymbolDisabled<<T as Config>::Symbol> for Pallet<T>

fn disable_symbol(symbol: &T::Symbol)

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> SyntheticInfoProvider<<T as Config>::AssetId> for Pallet<T>

fn is_synthetic(asset_id: &T::AssetId) -> bool

fn get_synthetic_assets() -> Vec<T::AssetId>

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>