Struct pallet_lbp::pallet::Pallet

source ·
pub struct Pallet<T>(PhantomData<T>);
Expand description

The pallet implementing the on-chain logic.

Tuple Fields§

§0: PhantomData<T>

Implementations§

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

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.

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.

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.

Details of a pool.

return true if now is in interval <pool.start, pool.end>

return true if now is > pool.start and pool has been initialized

returns fees collected and locked in the fee collector account note: after LBP finishes and liquidity is removed this will be 0

repay fee is applied until repay target amount is reached

determines fee rate and applies it to the amount

Trait Implementations§

Calculate spot price for given assets and amount. This method does not modify the storage.

Provided assets must exist in the pool. Panic if an asset does not exist in the pool.

Return 0 if calculation overflows or weights calculation overflows.

Check if both assets exist in a pool.
Return pair account.
Return share token for assets.
Return list of active assets in a given pool.
Sell trade validation Perform all necessary checks to validate an intended sale. Read more
Execute buy for given validated transfer.
Buy trade validation Perform all necessary checks to validate an intended buy. Read more
Execute buy for given validated transfer.
Perform asset swap. Call execute following the validation. Read more
Perform asset swap.
Get the benchmarks available for this pallet. Generally there is one benchmark per extrinsic, so these are sometimes just called “extrinsics”. Read more
Run the benchmarks for this pallet.
Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
Returns the current storage version as supported by the pallet.
Returns the on-chain storage version of the pallet as stored in the storage.
The block is being finalized. Implement to have something happen.
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. Read more
The block is being initialized. Implement to have something happen. Read more
Perform a module upgrade. Read more
Execute the sanity checks of this pallet, per block. Read more
Execute some pre-checks prior to a runtime upgrade. Read more
Execute some post-checks after a runtime upgrade. Read more
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. Read more
Run integrity test. Read more
Run integrity test. Read more
This function is being called after every block import (when fully synced). Read more
The block is being finalized. Implement to have something happen. Read more
Something that should happen at genesis.
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. Read more
The block is being initialized. Implement to have something happen. Read more
Perform a module upgrade. Read more
Execute some pre-checks prior to a runtime upgrade. Read more
Execute some post-checks after a runtime upgrade. Read more
Index of the pallet as configured in the runtime.
Name of the pallet as configured in the runtime.
Name of the Rust module containing the pallet.
Version of the crate containing the pallet.
The number of pallets’ information that this type represents. Read more
All of the pallets’ information that this type represents.
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more
Execute the state checks.

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Casts the value.
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more
Casts the value.
Casts the value.
Casts the value.
Convert from a value of T into an equivalent instance of Option<Self>. Read more
Consume self to return Some equivalent value of Option<T>. Read more
Converts self into T using Into<T>. Read more
Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more
Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more
Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more
Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more
Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more
Compare self to key and return true if they are equal.
Causes self to use its Binary implementation when Debug-formatted. Read more
Causes self to use its Display implementation when Debug-formatted. Read more
Causes self to use its LowerExp implementation when Debug-formatted. Read more
Causes self to use its LowerHex implementation when Debug-formatted. Read more
Causes self to use its Octal implementation when Debug-formatted. Read more
Causes self to use its Pointer implementation when Debug-formatted. Read more
Causes self to use its UpperExp implementation when Debug-formatted. Read more
Causes self to use its UpperHex implementation when Debug-formatted. Read more
Formats each item in a sequence. Read more

Returns the argument unchanged.

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Instruments this type with the current Span, returning an Instrumented wrapper. Read more

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Cast reference.
Cast reference.
Cast mutable reference.
Cast mutable reference.

Get a reference to the inner from the outer.

Get a mutable reference to the inner from the outer.

Performs the conversion.
Performs the conversion.
Generate a storage key unique to this runtime upgrade. Read more
Get temporary storage data written by Self::set_temp_storage. Read more
Write some temporary data to a specific storage that can be read (potentially in post-upgrade hook) via Self::get_temp_storage. Read more
Casts the value.
Casts the value.
Pipes by value. This is generally the method you want to use. Read more
Borrows self and passes that borrow into the pipe function. Read more
Mutably borrows self and passes that borrow into the pipe function. Read more
Borrows self, then passes self.borrow() into the pipe function. Read more
Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
Borrows self, then passes self.as_ref() into the pipe function.
Mutably borrows self, then passes self.as_mut() into the pipe function. Read more
Borrows self, then passes self.deref() into the pipe function.
Mutably borrows self, then passes self.deref_mut() into the pipe function. Read more
The alignment of pointer.
The type for initializers.
Initializes a with the given initializer. Read more
Dereferences the given pointer. Read more
Mutably dereferences the given pointer. Read more
Drops the object pointed to by the given pointer. Read more
Should always be Self
Convert from a value of T into an equivalent instance of Self. Read more
Consume self to return an equivalent value of T. Read more
Casts the value.
Casts the value.
The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Checks if self is actually part of its subset T (and can be converted to it).
Use with care! Same as self.to_subset but without any property checks. Always succeeds.
The inclusion map: converts self to the equivalent element of its superset.
Immutable access to a value. Read more
Mutable access to a value. Read more
Immutable access to the Borrow<B> of a value. Read more
Mutable access to the BorrowMut<B> of a value. Read more
Immutable access to the AsRef<R> view of a value. Read more
Mutable access to the AsMut<R> view of a value. Read more
Immutable access to the Deref::Target of a value. Read more
Mutable access to the Deref::Target of a value. Read more
Calls .tap() only in debug builds, and is erased in release builds.
Calls .tap_mut() only in debug builds, and is erased in release builds. Read more
Calls .tap_borrow() only in debug builds, and is erased in release builds. Read more
Calls .tap_borrow_mut() only in debug builds, and is erased in release builds. Read more
Calls .tap_ref() only in debug builds, and is erased in release builds. Read more
Calls .tap_ref_mut() only in debug builds, and is erased in release builds. Read more
Calls .tap_deref() only in debug builds, and is erased in release builds. Read more
Calls .tap_deref_mut() only in debug builds, and is erased in release builds. Read more
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
Attempts to convert self into T using TryInto<T>. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.
The counterpart to unchecked_from.
Consume self to return an equivalent value of T.
Casts the value.
Casts the value.
Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Casts the value.
Casts the value.