Enum pallet_asset_conversion::pallet::Call

pub enum Call<T: Config> {
    create_pool {
        asset1: Box<T::AssetKind>,
        asset2: Box<T::AssetKind>,
    },
    add_liquidity {
        asset1: Box<T::AssetKind>,
        asset2: Box<T::AssetKind>,
        amount1_desired: T::Balance,
        amount2_desired: T::Balance,
        amount1_min: T::Balance,
        amount2_min: T::Balance,
        mint_to: T::AccountId,
    },
    remove_liquidity {
        asset1: Box<T::AssetKind>,
        asset2: Box<T::AssetKind>,
        lp_token_burn: T::Balance,
        amount1_min_receive: T::Balance,
        amount2_min_receive: T::Balance,
        withdraw_to: T::AccountId,
    },
    swap_exact_tokens_for_tokens {
        path: Vec<Box<T::AssetKind>>,
        amount_in: T::Balance,
        amount_out_min: T::Balance,
        send_to: T::AccountId,
        keep_alive: bool,
    },
    swap_tokens_for_exact_tokens {
        path: Vec<Box<T::AssetKind>>,
        amount_out: T::Balance,
        amount_in_max: T::Balance,
        send_to: T::AccountId,
        keep_alive: bool,
    },
    touch {
        asset1: Box<T::AssetKind>,
        asset2: Box<T::AssetKind>,
    },
    // some variants omitted
}

Pallet’s callable functions.

Variants

create_pool

Creates an empty liquidity pool and an associated new lp_token asset (the id of which is returned in the Event::PoolCreated event).

Once a pool is created, someone may Pallet::add_liquidity to it.

Fields

asset1: Box<T::AssetKind>

asset2: Box<T::AssetKind>

add_liquidity

Provide liquidity into the pool of asset1 and asset2. NOTE: an optimal amount of asset1 and asset2 will be calculated and might be different than the provided amount1_desired/amount2_desired thus you should provide the min amount you’re happy to provide. Params amount1_min/amount2_min represent that. mint_to will be sent the liquidity tokens that represent this share of the pool.

NOTE: when encountering an incorrect exchange rate and non-withdrawable pool liquidity, batch an atomic call with Pallet::add_liquidity and Pallet::swap_exact_tokens_for_tokens or Pallet::swap_tokens_for_exact_tokens calls to render the liquidity withdrawable and rectify the exchange rate.

Once liquidity is added, someone may successfully call Pallet::swap_exact_tokens_for_tokens.

Fields

asset1: Box<T::AssetKind>

asset2: Box<T::AssetKind>

amount1_desired: T::Balance

amount2_desired: T::Balance

amount1_min: T::Balance

amount2_min: T::Balance

mint_to: T::AccountId

remove_liquidity

Allows you to remove liquidity by providing the lp_token_burn tokens that will be burned in the process. With the usage of amount1_min_receive/amount2_min_receive it’s possible to control the min amount of returned tokens you’re happy with.

Fields

asset1: Box<T::AssetKind>

asset2: Box<T::AssetKind>

lp_token_burn: T::Balance

amount1_min_receive: T::Balance

amount2_min_receive: T::Balance

withdraw_to: T::AccountId

swap_exact_tokens_for_tokens

Swap the exact amount of asset1 into asset2. amount_out_min param allows you to specify the min amount of the asset2 you’re happy to receive.

AssetConversionApi::quote_price_exact_tokens_for_tokens runtime call can be called for a quote.

Fields

path: Vec<Box<T::AssetKind>>

amount_in: T::Balance

amount_out_min: T::Balance

send_to: T::AccountId

keep_alive: bool

swap_tokens_for_exact_tokens

Swap any amount of asset1 to get the exact amount of asset2. amount_in_max param allows to specify the max amount of the asset1 you’re happy to provide.

AssetConversionApi::quote_price_tokens_for_exact_tokens runtime call can be called for a quote.

Fields

path: Vec<Box<T::AssetKind>>

amount_out: T::Balance

amount_in_max: T::Balance

send_to: T::AccountId

keep_alive: bool

touch

Touch an existing pool to fulfill prerequisites before providing liquidity, such as ensuring that the pool’s accounts are in place. It is typically useful when a pool creator removes the pool’s accounts and does not provide a liquidity. This action may involve holding assets from the caller as a deposit for creating the pool’s accounts.

The origin must be Signed.

• asset1: The asset ID of an existing pool with a pair (asset1, asset2).
• asset2: The asset ID of an existing pool with a pair (asset1, asset2).

Emits Touched event when successful.

Fields

asset1: Box<T::AssetKind>

asset2: Box<T::AssetKind>

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_create_pool( asset1: Box<T::AssetKind>, asset2: Box<T::AssetKind>, ) -> Self

Create a call with the variant create_pool.

pub fn new_call_variant_add_liquidity( asset1: Box<T::AssetKind>, asset2: Box<T::AssetKind>, amount1_desired: T::Balance, amount2_desired: T::Balance, amount1_min: T::Balance, amount2_min: T::Balance, mint_to: T::AccountId, ) -> Self

Create a call with the variant add_liquidity.

pub fn new_call_variant_remove_liquidity( asset1: Box<T::AssetKind>, asset2: Box<T::AssetKind>, lp_token_burn: T::Balance, amount1_min_receive: T::Balance, amount2_min_receive: T::Balance, withdraw_to: T::AccountId, ) -> Self

Create a call with the variant remove_liquidity.

pub fn new_call_variant_swap_exact_tokens_for_tokens( path: Vec<Box<T::AssetKind>>, amount_in: T::Balance, amount_out_min: T::Balance, send_to: T::AccountId, keep_alive: bool, ) -> Self

Create a call with the variant swap_exact_tokens_for_tokens.

pub fn new_call_variant_swap_tokens_for_exact_tokens( path: Vec<Box<T::AssetKind>>, amount_out: T::Balance, amount_in_max: T::Balance, send_to: T::AccountId, keep_alive: bool, ) -> Self

Create a call with the variant swap_tokens_for_exact_tokens.

pub fn new_call_variant_touch( asset1: Box<T::AssetKind>, asset2: Box<T::AssetKind>, ) -> Self

Create a call with the variant touch.

Trait Implementations

impl<T: Config> CheckIfFeeless for Call<T>

type Origin = <T as Config>::RuntimeOrigin

The Origin type of the runtime.

fn is_feeless(&self, origin: &Self::Origin) -> bool

Checks if the dispatchable satisfies the feeless condition as defined by #[pallet::feeless_if]

impl<T: Config> Clone for Call<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: Config> Debug for Call<T>

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

Formats the value using the given formatter.

impl<T: Config> Decode for Call<T>

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy, ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self>, ) -> Result<DecodeFinished, Error>

where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>

where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T: Config> Encode for Call<T>

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy, )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> R

where F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T: Config> GetCallIndex for Call<T>

fn get_call_index(&self) -> u8

Return the index of this Call.

fn get_call_indices() -> &'static [u8]

Return all call indices in the same order as [GetCallName].

impl<T: Config> GetCallName for Call<T>

fn get_call_name(&self) -> &'static str

Return the function name of the Call.

fn get_call_names() -> &'static [&'static str]

Return all function names in the same order as [GetCallIndex].

impl<T: Config> GetDispatchInfo for Call<T>

fn get_dispatch_info(&self) -> DispatchInfo

Return a DispatchInfo, containing relevant information of this dispatch.

impl<T: Config> PartialEq for Call<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> TypeInfo for Call<T>

where PhantomData<(T,)>: TypeInfo + 'static, Box<T::AssetKind>: TypeInfo + 'static, T::Balance: TypeInfo + 'static, T::AccountId: TypeInfo + 'static, Vec<Box<T::AssetKind>>: TypeInfo + 'static, T: Config + 'static,

type Identity = Call<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T: Config> UnfilteredDispatchable for Call<T>

type RuntimeOrigin = <T as Config>::RuntimeOrigin

The origin type of the runtime, (i.e. frame_system::Config::RuntimeOrigin).

fn dispatch_bypass_filter( self, origin: Self::RuntimeOrigin, ) -> DispatchResultWithPostInfo

Dispatch this call but do not check the filter in origin.

impl<T: Config> EncodeLike for Call<T>

impl<T: Config> Eq for Call<T>