Struct pallet_asset_conversion::pallet::Pallet
source · pub struct Pallet<T>(/* private fields */);
Expand description
The Pallet
struct, the main type that implements traits and standalone
functions within the pallet.
Implementations§
source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
Pallet’s callable functions.
sourcepub fn create_pool(
origin: OriginFor<T>,
asset1: Box<T::AssetKind>,
asset2: Box<T::AssetKind>
) -> DispatchResult
pub fn create_pool( origin: OriginFor<T>, asset1: Box<T::AssetKind>, asset2: Box<T::AssetKind> ) -> DispatchResult
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.
sourcepub fn add_liquidity(
origin: OriginFor<T>,
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
) -> DispatchResult
pub fn add_liquidity( origin: OriginFor<T>, 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 ) -> DispatchResult
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
successfully.
sourcepub fn remove_liquidity(
origin: OriginFor<T>,
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
) -> DispatchResult
pub fn remove_liquidity( origin: OriginFor<T>, 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 ) -> DispatchResult
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.
sourcepub fn swap_exact_tokens_for_tokens(
origin: OriginFor<T>,
path: Vec<Box<T::AssetKind>>,
amount_in: T::Balance,
amount_out_min: T::Balance,
send_to: T::AccountId,
keep_alive: bool
) -> DispatchResult
pub fn swap_exact_tokens_for_tokens( origin: OriginFor<T>, path: Vec<Box<T::AssetKind>>, amount_in: T::Balance, amount_out_min: T::Balance, send_to: T::AccountId, keep_alive: bool ) -> DispatchResult
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.
sourcepub fn swap_tokens_for_exact_tokens(
origin: OriginFor<T>,
path: Vec<Box<T::AssetKind>>,
amount_out: T::Balance,
amount_in_max: T::Balance,
send_to: T::AccountId,
keep_alive: bool
) -> DispatchResult
pub fn swap_tokens_for_exact_tokens( origin: OriginFor<T>, path: Vec<Box<T::AssetKind>>, amount_out: T::Balance, amount_in_max: T::Balance, send_to: T::AccountId, keep_alive: bool ) -> DispatchResult
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.
sourcepub fn touch(
origin: OriginFor<T>,
asset1: Box<T::AssetKind>,
asset2: Box<T::AssetKind>
) -> DispatchResultWithPostInfo
pub fn touch( origin: OriginFor<T>, asset1: Box<T::AssetKind>, asset2: Box<T::AssetKind> ) -> DispatchResultWithPostInfo
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.
source§impl<T: Config> Pallet<T>
impl<T: Config> Pallet<T>
sourcepub fn get_reserves(
asset1: T::AssetKind,
asset2: T::AssetKind
) -> Result<(T::Balance, T::Balance), Error<T>>
pub fn get_reserves( asset1: T::AssetKind, asset2: T::AssetKind ) -> Result<(T::Balance, T::Balance), Error<T>>
Returns the balance of each asset in the pool. The tuple result is in the order requested (not necessarily the same as pool order).
sourcepub fn quote_price_exact_tokens_for_tokens(
asset1: T::AssetKind,
asset2: T::AssetKind,
amount: T::Balance,
include_fee: bool
) -> Option<T::Balance>
pub fn quote_price_exact_tokens_for_tokens( asset1: T::AssetKind, asset2: T::AssetKind, amount: T::Balance, include_fee: bool ) -> Option<T::Balance>
Used by the RPC service to provide current prices.
sourcepub fn quote_price_tokens_for_exact_tokens(
asset1: T::AssetKind,
asset2: T::AssetKind,
amount: T::Balance,
include_fee: bool
) -> Option<T::Balance>
pub fn quote_price_tokens_for_exact_tokens( asset1: T::AssetKind, asset2: T::AssetKind, amount: T::Balance, include_fee: bool ) -> Option<T::Balance>
Used by the RPC service to provide current prices.
sourcepub fn quote(
amount: &T::Balance,
reserve1: &T::Balance,
reserve2: &T::Balance
) -> Result<T::Balance, Error<T>>
pub fn quote( amount: &T::Balance, reserve1: &T::Balance, reserve2: &T::Balance ) -> Result<T::Balance, Error<T>>
Calculates the optimal amount from the reserves.
Trait Implementations§
source§impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>
impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>
source§fn before_all_runtime_migrations() -> Weight
fn before_all_runtime_migrations() -> Weight
source§impl<T: Config> GetStorageVersion for Pallet<T>
impl<T: Config> GetStorageVersion for Pallet<T>
source§fn in_code_storage_version() -> Self::InCodeStorageVersion
fn in_code_storage_version() -> Self::InCodeStorageVersion
storage_version
attribute, or
NoStorageVersionSet
if the attribute is missing.source§fn on_chain_storage_version() -> StorageVersion
fn on_chain_storage_version() -> StorageVersion
source§fn current_storage_version() -> Self::InCodeStorageVersion
fn current_storage_version() -> Self::InCodeStorageVersion
in_code_storage_version
and will be removed after March 2024.Self::current_storage_version
instead. Read moresource§impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn integrity_test()
fn integrity_test()
source§fn on_initialize(_n: BlockNumber) -> Weight
fn on_initialize(_n: BlockNumber) -> Weight
source§fn on_finalize(_n: BlockNumber)
fn on_finalize(_n: BlockNumber)
source§fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight
Hooks::on_finalize
). Read moresource§fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)
fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)
source§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
Executive
pallet. Read moresource§fn offchain_worker(_n: BlockNumber)
fn offchain_worker(_n: BlockNumber)
source§impl<T: Config> IntegrityTest for Pallet<T>
impl<T: Config> IntegrityTest for Pallet<T>
source§impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn offchain_worker(n: BlockNumberFor<T>)
fn offchain_worker(n: BlockNumberFor<T>)
source§impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn on_finalize(n: BlockNumberFor<T>)
fn on_finalize(n: BlockNumberFor<T>)
Hooks::on_finalize
.source§impl<T: Config> OnGenesis for Pallet<T>
impl<T: Config> OnGenesis for Pallet<T>
source§fn on_genesis()
fn on_genesis()
source§impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight
fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight
Hooks::on_idle
.source§impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn on_initialize(n: BlockNumberFor<T>) -> Weight
fn on_initialize(n: BlockNumberFor<T>) -> Weight
Hooks::on_initialize
.source§impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>
source§fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)
fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)
source§impl<T: Config> OnRuntimeUpgrade for Pallet<T>
impl<T: Config> OnRuntimeUpgrade for Pallet<T>
source§fn on_runtime_upgrade() -> Weight
fn on_runtime_upgrade() -> Weight
source§impl<T: Config> PalletInfoAccess for Pallet<T>
impl<T: Config> PalletInfoAccess for Pallet<T>
source§fn module_name() -> &'static str
fn module_name() -> &'static str
source§fn crate_version() -> CrateVersion
fn crate_version() -> CrateVersion
source§impl<T: Config> PalletsInfoAccess for Pallet<T>
impl<T: Config> PalletsInfoAccess for Pallet<T>
source§impl<T> PartialEq for Pallet<T>
impl<T> PartialEq for Pallet<T>
source§impl<T: Config> StorageInfoTrait for Pallet<T>
impl<T: Config> StorageInfoTrait for Pallet<T>
fn storage_info() -> Vec<StorageInfo>
source§impl<T: Config> Swap<<T as Config>::AccountId> for Pallet<T>
impl<T: Config> Swap<<T as Config>::AccountId> for Pallet<T>
source§fn max_path_len() -> u32
fn max_path_len() -> u32
source§fn swap_exact_tokens_for_tokens(
sender: T::AccountId,
path: Vec<Self::AssetKind>,
amount_in: Self::Balance,
amount_out_min: Option<Self::Balance>,
send_to: T::AccountId,
keep_alive: bool
) -> Result<Self::Balance, DispatchError>
fn swap_exact_tokens_for_tokens( sender: T::AccountId, path: Vec<Self::AssetKind>, amount_in: Self::Balance, amount_out_min: Option<Self::Balance>, send_to: T::AccountId, keep_alive: bool ) -> Result<Self::Balance, DispatchError>
amount_in
of asset path[0]
for asset path[last]
.
If an amount_out_min
is specified, it will return an error if it is unable to acquire
the amount desired. Read moresource§fn swap_tokens_for_exact_tokens(
sender: T::AccountId,
path: Vec<Self::AssetKind>,
amount_out: Self::Balance,
amount_in_max: Option<Self::Balance>,
send_to: T::AccountId,
keep_alive: bool
) -> Result<Self::Balance, DispatchError>
fn swap_tokens_for_exact_tokens( sender: T::AccountId, path: Vec<Self::AssetKind>, amount_out: Self::Balance, amount_in_max: Option<Self::Balance>, send_to: T::AccountId, keep_alive: bool ) -> Result<Self::Balance, DispatchError>
path[0]
asset and swap some amount for amount_out
of the path[last]
. If an
amount_in_max
is specified, it will return an error if acquiring amount_out
would be
too costly. Read moresource§impl<T: Config> SwapCredit<<T as Config>::AccountId> for Pallet<T>
impl<T: Config> SwapCredit<<T as Config>::AccountId> for Pallet<T>
§type Credit = Imbalance<<<T as Config>::Assets as Inspect<<T as Config>::AccountId>>::AssetId, <<T as Config>::Assets as Inspect<<T as Config>::AccountId>>::Balance, <<T as Config>::Assets as Balanced<<T as Config>::AccountId>>::OnDropCredit, <<T as Config>::Assets as Balanced<<T as Config>::AccountId>>::OnDropDebt>
type Credit = Imbalance<<<T as Config>::Assets as Inspect<<T as Config>::AccountId>>::AssetId, <<T as Config>::Assets as Inspect<<T as Config>::AccountId>>::Balance, <<T as Config>::Assets as Balanced<<T as Config>::AccountId>>::OnDropCredit, <<T as Config>::Assets as Balanced<<T as Config>::AccountId>>::OnDropDebt>
source§fn max_path_len() -> u32
fn max_path_len() -> u32
source§fn swap_exact_tokens_for_tokens(
path: Vec<Self::AssetKind>,
credit_in: Self::Credit,
amount_out_min: Option<Self::Balance>
) -> Result<Self::Credit, (Self::Credit, DispatchError)>
fn swap_exact_tokens_for_tokens( path: Vec<Self::AssetKind>, credit_in: Self::Credit, amount_out_min: Option<Self::Balance> ) -> Result<Self::Credit, (Self::Credit, DispatchError)>
credit_in
of asset path[0]
for asset path[last]
. If amount_out_min
is
provided and the swap can’t achieve at least this amount, an error is returned. Read moresource§fn swap_tokens_for_exact_tokens(
path: Vec<Self::AssetKind>,
credit_in: Self::Credit,
amount_out: Self::Balance
) -> Result<(Self::Credit, Self::Credit), (Self::Credit, DispatchError)>
fn swap_tokens_for_exact_tokens( path: Vec<Self::AssetKind>, credit_in: Self::Credit, amount_out: Self::Balance ) -> Result<(Self::Credit, Self::Credit), (Self::Credit, DispatchError)>
credit_in
of path[0]
asset to obtain the desired amount_out
of
the path[last]
asset. The provided credit_in
must be adequate to achieve the target
amount_out
, or an error will occur. Read moresource§impl<T: Config> WhitelistedStorageKeys for Pallet<T>
impl<T: Config> WhitelistedStorageKeys for Pallet<T>
source§fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>
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>
Auto Trait Implementations§
impl<T> Freeze for Pallet<T>
impl<T> RefUnwindSafe for Pallet<T>where
T: RefUnwindSafe,
impl<T> Send for Pallet<T>where
T: Send,
impl<T> Sync for Pallet<T>where
T: Sync,
impl<T> Unpin for Pallet<T>where
T: Unpin,
impl<T> UnwindSafe for Pallet<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> CheckedConversion for T
impl<T> CheckedConversion for T
source§impl<Q, K> Equivalent<K> for Q
impl<Q, K> Equivalent<K> for Q
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§impl<T, Outer> IsWrappedBy<Outer> for T
impl<T, Outer> IsWrappedBy<Outer> for T
source§impl<T> SaturatedConversion for T
impl<T> SaturatedConversion for T
source§fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
fn saturated_from<T>(t: T) -> Selfwhere
Self: UniqueSaturatedFrom<T>,
source§fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
fn saturated_into<T>(self) -> Twhere
Self: UniqueSaturatedInto<T>,
T
. Read moresource§impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
impl<T, U> TryIntoKey<U> for Twhere
U: TryFromKey<T>,
type Error = <U as TryFromKey<T>>::Error
fn try_into_key(self) -> Result<U, <U as TryFromKey<T>>::Error>
source§impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
impl<S, T> UncheckedInto<T> for Swhere
T: UncheckedFrom<S>,
source§fn unchecked_into(self) -> T
fn unchecked_into(self) -> T
unchecked_from
.source§impl<T, S> UniqueSaturatedInto<T> for S
impl<T, S> UniqueSaturatedInto<T> for S
source§fn unique_saturated_into(self) -> T
fn unique_saturated_into(self) -> T
T
.