Enum pallet_lbp::pallet::Call

pub enum Call<T: Config> {
    create_pool {
        pool_owner: T::AccountId,
        asset_a: AssetId,
        asset_a_amount: Balance,
        asset_b: AssetId,
        asset_b_amount: Balance,
        initial_weight: LBPWeight,
        final_weight: LBPWeight,
        weight_curve: WeightCurveType,
        fee: (u32, u32),
        fee_collector: T::AccountId,
        repay_target: Balance,
    },
    update_pool_data {
        pool_id: <T as Config>::AccountId,
        pool_owner: Option<T::AccountId>,
        start: Option<T::BlockNumber>,
        end: Option<T::BlockNumber>,
        initial_weight: Option<LBPWeight>,
        final_weight: Option<LBPWeight>,
        fee: Option<(u32, u32)>,
        fee_collector: Option<T::AccountId>,
        repay_target: Option<Balance>,
    },
    add_liquidity {
        amount_a: (AssetId, <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance),
        amount_b: (AssetId, <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance),
    },
    remove_liquidity {
        pool_id: <T as Config>::AccountId,
    },
    sell {
        asset_in: AssetId,
        asset_out: AssetId,
        amount: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance,
        max_limit: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance,
    },
    buy {
        asset_out: AssetId,
        asset_in: AssetId,
        amount: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance,
        max_limit: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance,
    },
    // some variants omitted
}

Contains one variant per dispatchable that can be called by an extrinsic.

Variants

create_pool

Fields

pool_owner: T::AccountId

asset_a: AssetId

asset_a_amount: Balance

asset_b: AssetId

asset_b_amount: Balance

initial_weight: LBPWeight

final_weight: LBPWeight

weight_curve: WeightCurveType

fee: (u32, u32)

fee_collector: T::AccountId

repay_target: Balance

Create a new liquidity bootstrapping pool for given asset pair.

For any asset pair, only one pool can exist at a time.

The dispatch origin for this call must be T::CreatePoolOrigin. The pool is created with initial liquidity provided by the pool_owner who must have sufficient funds free.

The pool starts uninitialized and update_pool call should be called once created to set the start block.

This function should be dispatched from governing entity T::CreatePoolOrigin

Parameters:

• pool_owner: the future owner of the new pool.
• asset_a: { asset_id, amount } Asset ID and initial liquidity amount.
• asset_b: { asset_id, amount } Asset ID and initial liquidity amount.
• initial_weight: Initial weight of the asset_a. 1_000_000 corresponding to 1% and 100_000_000 to 100% this should be higher than final weight
• final_weight: Final weight of the asset_a. 1_000_000 corresponding to 1% and 100_000_000 to 100% this should be lower than initial weight
• weight_curve: The weight function used to update the LBP weights. Currently, there is only one weight function implemented, the linear function.
• fee: The trading fee charged on every trade distributed to fee_collector.
• fee_collector: The account to which trading fees will be transferred.
• repay_target: The amount of tokens to repay to separate fee_collector account. Until this amount is reached, fee will be increased to 20% and taken from the pool

Emits PoolCreated event when successful.

BEWARE: We are taking the fee from the accumulated asset. If the accumulated asset is sold to the pool, the fee cost is transferred to the pool. If its bought from the pool the buyer bears the cost. This increases the price of the sold asset on every trade. Make sure to only run this with previously illiquid assets.

update_pool_data

Fields

pool_id: <T as Config>::AccountId

pool_owner: Option<T::AccountId>

start: Option<T::BlockNumber>

end: Option<T::BlockNumber>

initial_weight: Option<LBPWeight>

final_weight: Option<LBPWeight>

fee: Option<(u32, u32)>

fee_collector: Option<T::AccountId>

repay_target: Option<Balance>

Update pool data of a pool.

The dispatch origin for this call must be signed by the pool owner.

The pool can be updated only if the sale has not already started.

At least one of the following optional parameters has to be specified.

Parameters:

• pool_id: The identifier of the pool to be updated.
• start: The new starting time of the sale. This parameter is optional.
• end: The new ending time of the sale. This parameter is optional.
• initial_weight: The new initial weight. This parameter is optional.
• final_weight: The new final weight. This parameter is optional.
• fee: The new trading fee charged on every trade. This parameter is optional.
• fee_collector: The new receiver of trading fees. This parameter is optional.

Emits PoolUpdated event when successful.

add_liquidity

Fields

amount_a: (AssetId, <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance)

amount_b: (AssetId, <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance)

Add liquidity to a pool.

Assets to add has to match the pool assets. At least one amount has to be non-zero.

The dispatch origin for this call must be signed by the pool owner.

Parameters:

• pool_id: The identifier of the pool
• amount_a: The identifier of the asset and the amount to add.
• amount_b: The identifier of the second asset and the amount to add.

Emits LiquidityAdded event when successful.

remove_liquidity

Fields

pool_id: <T as Config>::AccountId

Transfer all the liquidity from a pool back to the pool owner and destroy the pool. The pool data are also removed from the storage.

The pool can’t be destroyed during the sale.

The dispatch origin for this call must be signed by the pool owner.

Parameters:

• amount_a: The identifier of the asset and the amount to add.

Emits ‘LiquidityRemoved’ when successful.

sell

Fields

asset_in: AssetId

asset_out: AssetId

amount: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance

max_limit: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance

Trade asset_in for asset_out.

Executes a swap of asset_in for asset_out. Price is determined by the pool and is affected by the amount and proportion of the pool assets and the weights.

Trading fee is distributed to the fee_collector.

Parameters:

• asset_in: The identifier of the asset being transferred from the account to the pool.
• asset_out: The identifier of the asset being transferred from the pool to the account.
• amount: The amount of asset_in
• 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.

buy

Fields

asset_out: AssetId

asset_in: AssetId

amount: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance

max_limit: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance

Trade asset_in for asset_out.

Executes a swap of asset_in for asset_out. Price is determined by the pool and is affected by the amount and the proportion of the pool assets and the weights.

Trading fee is distributed to the fee_collector.

Parameters:

• asset_in: The identifier of the asset being transferred from the account to the pool.
• asset_out: The identifier of the asset being transferred from the pool to the account.
• amount: The amount of asset_out.
• max_limit: maximum amount of asset_in to be sold in exchange for asset_out.

Emits BuyExecuted when successful.

Implementations

impl<T: Config> Call<T>

pub fn new_call_variant_create_pool(
    pool_owner: T::AccountId,
    asset_a: AssetId,
    asset_a_amount: Balance,
    asset_b: AssetId,
    asset_b_amount: Balance,
    initial_weight: LBPWeight,
    final_weight: LBPWeight,
    weight_curve: WeightCurveType,
    fee: (u32, u32),
    fee_collector: T::AccountId,
    repay_target: Balance
) -> Self

Create a call with the variant create_pool.

pub fn new_call_variant_update_pool_data(
    pool_id: <T as Config>::AccountId,
    pool_owner: Option<T::AccountId>,
    start: Option<T::BlockNumber>,
    end: Option<T::BlockNumber>,
    initial_weight: Option<LBPWeight>,
    final_weight: Option<LBPWeight>,
    fee: Option<(u32, u32)>,
    fee_collector: Option<T::AccountId>,
    repay_target: Option<Balance>
) -> Self

Create a call with the variant update_pool_data.

pub fn new_call_variant_add_liquidity(
    amount_a: (AssetId, <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance),
    amount_b: (AssetId, <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance)
) -> Self

Create a call with the variant add_liquidity.

pub fn new_call_variant_remove_liquidity(
    pool_id: <T as Config>::AccountId
) -> Self

Create a call with the variant remove_liquidity.

pub fn new_call_variant_sell(
    asset_in: AssetId,
    asset_out: AssetId,
    amount: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance,
    max_limit: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance
) -> Self

Create a call with the variant sell.

pub fn new_call_variant_buy(
    asset_out: AssetId,
    asset_in: AssetId,
    amount: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance,
    max_limit: <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance
) -> Self

Create a call with the variant buy.

Trait Implementations

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 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 encode_to<__CodecOutputEdqy: Output + ?Sized>(
    &self,
    __codec_dest_edqy: &mut __CodecOutputEdqy
)

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

fn size_hint(&self) -> usize

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

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

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere
    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> 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.

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<Call<T>> 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,
    T::AccountId: TypeInfo + 'static,
    <T as Config>::AccountId: TypeInfo + 'static,
    Option<T::AccountId>: TypeInfo + 'static,
    Option<T::BlockNumber>: TypeInfo + 'static,
    (AssetId, <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance): TypeInfo + 'static,
    <<T as Config>::MultiCurrency as MultiCurrency<<T as Config>::AccountId>>::Balance: 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 Origin = <T as Config>::Origin

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

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

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

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

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