Asset Conversion pallet (#12984)

* Add pallet dex

* Fmt

* Add RPC endpoint

* Fix RPC

* Fix the build

* Some more fixes

* Add a method to topup pallet's account

* Add support for multi-currency into Uniques

* Fix the build

* Add [transactional] + setup() + fix balances

* Improve tests

* Fix price quotation

* Code clean up

* Validate swaps

* Fmt

* Update README

* add test

* mint LP assets in a different instance

* remove transactional as now the default

AssetsLocal renamed to Assets

* merge master

* Revert "Merge master"

* fix tests post merge.

* attempt to set create origin

* Internally allocate lp asset id.

* Simplify

* Bump to be in line

* additional bumps to make compile

* fix compile

* less bounds

* use fungible crates

* multiasset enum

* only allow native currency pairs

* added slippage tests

* transfer into separate method

(Also fee not set in 2 places now.)

Added test where lp and user are different users.

* Add benchmarks + weights

* Typos

* Clean up

* More tests,

split error into two because it wasn't clear which parameter.

renamed liquidity to lp_tokens_minted or lp_tokens_burned in events.

* tighten up naming

* Default, zero, square root traits not needed

Also let's not force people to be compact

* add keep-alive param

* add insufficient liquidity test

* Fix quote() to support u64

* Avoid recording balances twice

* cargo fmt

* Didn't mean to change error type

* temp

* Less

* Rework get_amount_in/get_amount_out

* Convert other places

* Rework the last piece

* Typo

* Fix benchmarks

* use hash trait

* Extract a native asset check into the runtime setting

* Don't set the metadata

* Remove spec file

* Enable multi-assets swaps by default

* Refactor conversion into u128

* Add path param to swap_token_for_exact_tokens

* Fix typo + a bit of refactoring

* Implement path param for swap_exact_tokens_for_tokens()

* Deref

* Minor fixes

* Add test with sensible scale values

* Use .windows()

* Fix benchmarks

* update docs

* Fix everything :)

* Chore

* Revert

* Chore

* prev way of creating sub accounts lead to collisions

* Update frame/dex/src/lib.rs

Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>

* Update frame/dex/src/lib.rs

Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>

* Chore

* Fmt fix on Uniques

* add call_index

bring code up to date with latest master

* revert readme changes

* add cr

* revert uniques changes

* reducing noise

* no need for deadline (#12990)

(there's generic transaction deadline functionality already)

* fix kitchen sink (#12991)

* fix kitchen sink

* Only the dex can mint lp_tokens

* add BenchmarkHelper for second instance (#12998)

* update mock to latest master

* less indirections (#13012)

* remove dex PR's custom RPC (#13050)

* As we have state_call we don't need a custom RPC

* fix docs

* no longer a need to upgrade rpc version (#13053)

* add CallbackHadle

* quote bugfix (#13191)

quote was giving same price in both directions as we were inverting needlessly.

* merging in dex specific changes due to pay by dex

* update lock file

* merging in kitchen sink changes

* Add get_reserves() api method

* Partial updating of the benchmarks

* Fix tests

* clippy

* Temp fix weights

* Fix benchmarks

* Add pool setup fee

* Money upfront

* Address some comments

* Use u128 in mock

* Fix benchmarks

* Change error message

* Update comments

* Change error names

* Implement PartialOrd for NativeOrAssetId

* add note

* Update errors

* More tests for assets sorting

* ".git/.scripts/commands/bench/bench.sh" pallet dev pallet_dex

* Change the way we generate pool accounts

* Improve the liquidity removal method

* Extract MintMinLiquidity to config, rework all tests

* Add comments

* Validate provided amount

* Rename to asset-conversion

* Validate ED

* Improve handling the ED related errors

* typos

* Try to fix benchmarks

* Another try

* Another day, another try

* Fix benchmarks

* Expose fee related params

* Validate token's minimal amount the same way as ED

* fix typo

* Use longer path for swaps in benchmarks

* need to ref sp_std's vec.

* Remove From<u32> requirement when benchmarking

* impl BenchmarkHelper for ()

* only for runtime benchmarks

* MultiLocation: !MaybeDisplay

Looks like we might not need this bound from initial testing.

* Update frame/asset-conversion/src/lib.rs

Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>

* Update frame/asset-conversion/src/lib.rs

Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>

* Add documentation links

* add collision test

* Revert "[Enhancement] Throw an error when there are too many pallets (#13763)"

This reverts commit cc3152bc2f.

* [Enhancement] Throw an error when there are too many pallets (#13763)

* [Enhancement] Throw an error when there are too many pallets

* fix ui test

* fix PR comments

* Update frame/support/procedural/src/construct_runtime/mod.rs

Co-authored-by: Bastian Köcher <git@kchr.de>

* Update frame/support/procedural/src/construct_runtime/mod.rs

Co-authored-by: Bastian Köcher <git@kchr.de>

* ".git/.scripts/commands/fmt/fmt.sh"

---------

Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: command-bot <>

* add benchmark helper

+ doc fix

* cargo fmt

* Fix adding liquidity to non-empty pool

* Fix compilation error

* Fix params ordering issue

* additional docs

* The swap path elements should be unique

* Fix account collision

* Validate all the pool in a swap path are unique

* Change the way we add liquidity to empty pools

* Improve docs

* remove unnessisary Display impl

* cargo fmt

* remove unused imports

* Make api consistent

* Chore

* Touch the pool account so it could hold the pair tokens

* Check the balance before touching the pool's account

* Introduce liquidity provision fee

* Touch the pool acc one more time

* Apply suggestions from code review

Co-authored-by: Sam Johnson <sam@durosoft.com>

* Update frame/asset-conversion/README.md

Co-authored-by: Sam Johnson <sam@durosoft.com>

* Use ContainsPair instead of the balance checker

* Remove old Currency trait

* Add liquidity withdrawal fee

* Update docs

* Use 0 withdrawal fee in mock

* Rename vars

* asset id not clone

* fix: shadow var was being used

* correct tests

* fix benches

* merge master

* neater

---------

Co-authored-by: Jegor Sidorenko <jegor@parity.io>
Co-authored-by: Jegor Sidorenko <5252494+jsidorenko@users.noreply.github.com>
Co-authored-by: parity-processbot <>
Co-authored-by: Roman Useinov <roman.useinov@gmail.com>
Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: Sam Johnson <sam@durosoft.com>

substrate/frame/asset-conversion/src/benchmarking.rs

@@ -0,0 +1,287 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2020-2022 Parity Technologies (UK) Ltd.
+// SPDX-License-Identifier: Apache-2.0
+
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+// 	http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+//! Asset Conversion pallet benchmarking.
+
+#![cfg(feature = "runtime-benchmarks")]
+
+use super::*;
+use frame_benchmarking::{benchmarks, whitelisted_caller};
+use frame_support::{
+	assert_ok,
+	storage::bounded_vec::BoundedVec,
+	traits::{
+		fungible::{Inspect as InspectFungible, Unbalanced},
+		fungibles::{Create, Inspect, Mutate},
+	},
+};
+use frame_system::RawOrigin as SystemOrigin;
+use sp_runtime::traits::{Bounded, StaticLookup};
+use sp_std::prelude::*;
+
+use crate::Pallet as AssetConversion;
+
+const INITIAL_ASSET_BALANCE: u128 = 1_000_000_000_000;
+type AccountIdLookupOf<T> = <<T as frame_system::Config>::Lookup as StaticLookup>::Source;
+type BalanceOf<T> =
+	<<T as Config>::Currency as InspectFungible<<T as frame_system::Config>::AccountId>>::Balance;
+
+fn get_lp_token_id<T: Config>() -> T::PoolAssetId
+where
+	T::PoolAssetId: Into<u32>,
+{
+	let next_id: u32 = AssetConversion::<T>::get_next_pool_asset_id().into();
+	(next_id - 1).into()
+}
+
+fn create_asset<T: Config>(asset: &T::MultiAssetId) -> (T::AccountId, AccountIdLookupOf<T>)
+where
+	T::AssetBalance: From<u128>,
+	T::Currency: Unbalanced<T::AccountId>,
+	T::Assets: Create<T::AccountId> + Mutate<T::AccountId>,
+{
+	let caller: T::AccountId = whitelisted_caller();
+	let caller_lookup = T::Lookup::unlookup(caller.clone());
+	if let Ok(asset_id) = T::MultiAssetIdConverter::try_convert(asset) {
+		assert_ok!(T::Currency::write_balance(&caller, BalanceOf::<T>::max_value()));
+		assert_ok!(T::Assets::create(asset_id.clone(), caller.clone(), true, 1.into()));
+		assert_ok!(T::Assets::mint_into(asset_id, &caller, INITIAL_ASSET_BALANCE.into()));
+	}
+	(caller, caller_lookup)
+}
+
+fn create_asset_and_pool<T: Config>(
+	asset1: &T::MultiAssetId,
+	asset2: &T::MultiAssetId,
+) -> (T::PoolAssetId, T::AccountId, AccountIdLookupOf<T>)
+where
+	T::AssetBalance: From<u128>,
+	T::Currency: Unbalanced<T::AccountId>,
+	T::Assets: Create<T::AccountId> + Mutate<T::AccountId>,
+	T::PoolAssetId: Into<u32>,
+{
+	let (_, _) = create_asset::<T>(asset1);
+	let (caller, caller_lookup) = create_asset::<T>(asset2);
+
+	assert_ok!(AssetConversion::<T>::create_pool(
+		SystemOrigin::Signed(caller.clone()).into(),
+		asset1.clone(),
+		asset2.clone()
+	));
+	let lp_token = get_lp_token_id::<T>();
+
+	(lp_token, caller, caller_lookup)
+}
+
+fn assert_last_event<T: Config>(generic_event: <T as Config>::RuntimeEvent) {
+	let events = frame_system::Pallet::<T>::events();
+	let system_event: <T as frame_system::Config>::RuntimeEvent = generic_event.into();
+	// compare to the last event record
+	let frame_system::EventRecord { event, .. } = &events[events.len() - 1];
+	assert_eq!(event, &system_event);
+}
+
+benchmarks! {
+	where_clause {
+		where
+			T::AssetBalance: From<u128> + Into<u128>,
+			T::Currency: Unbalanced<T::AccountId>,
+			T::Balance: From<u128> + Into<u128>,
+			T::Assets: Create<T::AccountId> + Mutate<T::AccountId>,
+			T::PoolAssetId: Into<u32>,
+	}
+
+	create_pool {
+		let asset1 = T::MultiAssetIdConverter::get_native();
+		let asset2 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(0_u32));
+		let (caller, _) = create_asset::<T>(&asset2);
+	}: _(SystemOrigin::Signed(caller.clone()), asset1.clone(), asset2.clone())
+	verify {
+		let lp_token = get_lp_token_id::<T>();
+		let pool_id = (asset1.clone(), asset2.clone());
+		assert_last_event::<T>(Event::PoolCreated { creator: caller.clone(), pool_id, lp_token }.into());
+	}
+
+	add_liquidity {
+		let asset1 = T::MultiAssetIdConverter::get_native();
+		let asset2 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(0));
+		let (lp_token, caller, _) = create_asset_and_pool::<T>(&asset1, &asset2);
+		let ed: u128 = T::Currency::minimum_balance().into();
+		let add_amount = 1000 + ed;
+	}: _(SystemOrigin::Signed(caller.clone()), asset1.clone(), asset2.clone(), add_amount.into(), 1000.into(), 0.into(), 0.into(), caller.clone())
+	verify {
+		let pool_id = (asset1.clone(), asset2.clone());
+		let lp_minted = AssetConversion::<T>::calc_lp_amount_for_zero_supply(&add_amount.into(), &1000.into()).unwrap().into();
+		assert_eq!(
+			T::PoolAssets::balance(lp_token, &caller),
+			lp_minted.into()
+		);
+		assert_eq!(
+			T::Currency::balance(&AssetConversion::<T>::get_pool_account(&pool_id)),
+			add_amount.into()
+		);
+		assert_eq!(
+			T::Assets::balance(T::BenchmarkHelper::asset_id(0), &AssetConversion::<T>::get_pool_account(&pool_id)),
+			1000.into()
+		);
+	}
+
+	remove_liquidity {
+		let asset1 = T::MultiAssetIdConverter::get_native();
+		let asset2 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(0));
+		let (lp_token, caller, _) = create_asset_and_pool::<T>(&asset1, &asset2);
+		let ed: u128 = T::Currency::minimum_balance().into();
+		let add_amount = 100 * ed;
+		let lp_minted = AssetConversion::<T>::calc_lp_amount_for_zero_supply(&add_amount.into(), &1000.into()).unwrap().into();
+		let remove_lp_amount = lp_minted.checked_div(10).unwrap();
+
+		AssetConversion::<T>::add_liquidity(
+			SystemOrigin::Signed(caller.clone()).into(),
+			asset1.clone(),
+			asset2.clone(),
+			add_amount.into(),
+			1000.into(),
+			0.into(),
+			0.into(),
+			caller.clone(),
+		)?;
+		let total_supply = <T::PoolAssets as Inspect<T::AccountId>>::total_issuance(lp_token.clone());
+	}: _(SystemOrigin::Signed(caller.clone()), asset1, asset2, remove_lp_amount.into(), 0.into(), 0.into(), caller.clone())
+	verify {
+		let new_total_supply = <T::PoolAssets as Inspect<T::AccountId>>::total_issuance(lp_token.clone());
+		assert_eq!(
+			new_total_supply,
+			total_supply - remove_lp_amount.into()
+		);
+	}
+
+	swap_exact_tokens_for_tokens {
+		let asset1 = T::MultiAssetIdConverter::get_native();
+		let asset2 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(0));
+		let asset3 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(1));
+		let asset4 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(2));
+
+		let (_, caller, _) = create_asset_and_pool::<T>(&asset1, &asset2);
+		let (_, _) = create_asset::<T>(&asset3);
+		AssetConversion::<T>::create_pool(SystemOrigin::Signed(caller.clone()).into(), asset2.clone(), asset3.clone())?;
+		let (_, _) = create_asset::<T>(&asset4);
+		AssetConversion::<T>::create_pool(SystemOrigin::Signed(caller.clone()).into(), asset3.clone(), asset4.clone())?;
+
+		let path: BoundedVec<_, T::MaxSwapPathLength> =
+			BoundedVec::try_from(vec![asset1.clone(), asset2.clone(), asset3.clone(), asset4.clone()]).unwrap();
+		let ed: u128 = T::Currency::minimum_balance().into();
+		let add_amount1 = 100 * ed;
+
+		AssetConversion::<T>::add_liquidity(
+			SystemOrigin::Signed(caller.clone()).into(),
+			asset1.clone(),
+			asset2.clone(),
+			add_amount1.into(),
+			200.into(),
+			0.into(),
+			0.into(),
+			caller.clone(),
+		)?;
+		AssetConversion::<T>::add_liquidity(
+			SystemOrigin::Signed(caller.clone()).into(),
+			asset2.clone(),
+			asset3.clone(),
+			200.into(),
+			2000.into(),
+			0.into(),
+			0.into(),
+			caller.clone(),
+		)?;
+		AssetConversion::<T>::add_liquidity(
+			SystemOrigin::Signed(caller.clone()).into(),
+			asset3.clone(),
+			asset4.clone(),
+			2000.into(),
+			2000.into(),
+			0.into(),
+			0.into(),
+			caller.clone(),
+		)?;
+		let asset1_balance = T::Currency::balance(&caller);
+	}: _(SystemOrigin::Signed(caller.clone()), path.clone(), ed.into(), 1.into(), caller.clone(), false)
+	verify {
+		let new_asset1_balance = T::Currency::balance(&caller);
+		assert_eq!(
+			new_asset1_balance,
+			asset1_balance - ed.into()
+		);
+	}
+
+	swap_tokens_for_exact_tokens {
+		let asset1 = T::MultiAssetIdConverter::get_native();
+		let asset2 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(0));
+		let asset3 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(1));
+		let asset4 = T::MultiAssetIdConverter::into_multiasset_id(&T::BenchmarkHelper::asset_id(2));
+
+		let (_, caller, _) = create_asset_and_pool::<T>(&asset1, &asset2);
+		let (_, _) = create_asset::<T>(&asset3);
+		AssetConversion::<T>::create_pool(SystemOrigin::Signed(caller.clone()).into(), asset2.clone(), asset3.clone())?;
+		let (_, _) = create_asset::<T>(&asset4);
+		AssetConversion::<T>::create_pool(SystemOrigin::Signed(caller.clone()).into(), asset3.clone(), asset4.clone())?;
+
+		let path: BoundedVec<_, T::MaxSwapPathLength> =
+			BoundedVec::try_from(vec![asset1.clone(), asset2.clone(), asset3.clone(), asset4.clone()]).unwrap();
+		let ed: u128 = T::Currency::minimum_balance().into();
+		let add_amount1 = 1000 + ed;
+
+		AssetConversion::<T>::add_liquidity(
+			SystemOrigin::Signed(caller.clone()).into(),
+			asset1.clone(),
+			asset2.clone(),
+			add_amount1.into(),
+			200.into(),
+			0.into(),
+			0.into(),
+			caller.clone(),
+		)?;
+		AssetConversion::<T>::add_liquidity(
+			SystemOrigin::Signed(caller.clone()).into(),
+			asset2.clone(),
+			asset3.clone(),
+			200.into(),
+			2000.into(),
+			0.into(),
+			0.into(),
+			caller.clone(),
+		)?;
+		AssetConversion::<T>::add_liquidity(
+			SystemOrigin::Signed(caller.clone()).into(),
+			asset3.clone(),
+			asset4.clone(),
+			2000.into(),
+			2000.into(),
+			0.into(),
+			0.into(),
+			caller.clone(),
+		)?;
+		let asset4_balance = T::Assets::balance(T::BenchmarkHelper::asset_id(2), &caller);
+	}: _(SystemOrigin::Signed(caller.clone()), path.clone(), 100.into(), add_amount1.into(), caller.clone(), false)
+	verify {
+		let new_asset4_balance = T::Assets::balance(T::BenchmarkHelper::asset_id(2), &caller);
+		assert_eq!(
+			new_asset4_balance,
+			asset4_balance + 100.into()
+		);
+	}
+
+	impl_benchmark_test_suite!(AssetConversion, crate::mock::new_test_ext(), crate::mock::Test);
+}