Assets: Remove zombies, introduce approvals (#8220)

* Initial work * Tests for frame system * Self-sufficient account ref-counting * Fixes * Benchmarks building. * Update frame/system/src/lib.rs Co-authored-by: Jaco Greeff <jacogr@gmail.com> * Fixes * Fixes * Fixes * Fixes * Fixes * Fixes * Test approvals * Fixes * Report assets pallet tests * Tests for approvals & force_cancel_approval * Use structs rather than tuples for approval data * Add force_asset_status, force_set_metadata * Add clear_metadata. * approval benchmarks * force_asset_status benchmarks * final benchmarks * cargo run --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs * Update frame/system/src/lib.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Update frame/system/src/lib.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Update frame/system/src/lib.rs Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> * Docs for new approval dispatches. * Docs for pallet. * Remove accidental code. * cargo run --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs * cargo run --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs * Fixes * Update frame/assets/src/lib.rs Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Grumbles. * Transfer zero works, use DispatchResult * fix test * Remove force_destroy * Remove TODO * cargo run --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs * transfer_keep_alive * Fixes * Fixes * Fixes * cargo run --release --features=runtime-benchmarks --manifest-path=bin/node/cli/Cargo.toml -- benchmark --chain=dev --steps=50 --repeat=20 --pallet=pallet_assets --extrinsic=* --execution=wasm --wasm-execution=compiled --heap-pages=4096 --output=./frame/assets/src/weights.rs --template=./.maintain/frame-weight-template.hbs Co-authored-by: Jaco Greeff <jacogr@gmail.com> Co-authored-by: Parity Benchmarking Bot <admin@parity.io> Co-authored-by: Guillaume Thiolliere <gui.thiolliere@gmail.com> Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com>
2026-06-13 09:21:05 +00:00 · 2021-03-09 13:38:33 +01:00
parent b3f8e064f2
commit 643a0ecd38
7 changed files with 1797 additions and 1094 deletions
@@ -17,17 +17,23 @@

 //! Assets pallet benchmarking.

+#![cfg(feature = "runtime-benchmarks")]
+
+use sp_std::prelude::*;
 use super::*;
 use sp_runtime::traits::Bounded;
 use frame_system::RawOrigin as SystemOrigin;
-use frame_benchmarking::{benchmarks, account, whitelisted_caller, impl_benchmark_test_suite};
+use frame_benchmarking::{
+	benchmarks, account, whitelisted_caller, whitelist_account, impl_benchmark_test_suite
+};
 use frame_support::traits::Get;
+use frame_support::{traits::EnsureOrigin, dispatch::UnfilteredDispatchable};

 use crate::Module as Assets;

 const SEED: u32 = 0;

-fn create_default_asset<T: Config>(max_zombies: u32)
+fn create_default_asset<T: Config>(is_sufficient: bool)
 	-> (T::AccountId, <T::Lookup as StaticLookup>::Source)
 {
 	let caller: T::AccountId = whitelisted_caller();
@@ -37,16 +43,19 @@ fn create_default_asset<T: Config>(max_zombies: u32)
 		root,
 		Default::default(),
 		caller_lookup.clone(),
-		max_zombies,
+		is_sufficient,
 		1u32.into(),
 	).is_ok());
 	(caller, caller_lookup)
 }

-fn create_default_minted_asset<T: Config>(max_zombies: u32, amount: T::Balance)
+fn create_default_minted_asset<T: Config>(is_sufficient: bool, amount: T::Balance)
 	-> (T::AccountId, <T::Lookup as StaticLookup>::Source)
 {
-	let (caller, caller_lookup)  = create_default_asset::<T>(max_zombies);
+	let (caller, caller_lookup)  = create_default_asset::<T>(is_sufficient);
+	if !is_sufficient {
+		T::Currency::make_free_balance_be(&caller, T::Currency::minimum_balance());
+	}
 	assert!(Assets::<T>::mint(
 		SystemOrigin::Signed(caller.clone()).into(),
 		Default::default(),
@@ -56,13 +65,58 @@ fn create_default_minted_asset<T: Config>(max_zombies: u32, amount: T::Balance)
 	(caller, caller_lookup)
 }

-fn add_zombies<T: Config>(minter: T::AccountId, n: u32) {
+fn swap_is_sufficient<T: Config>(s: &mut bool) {
+	Asset::<T>::mutate(&T::AssetId::default(), |maybe_a|
+		if let Some(ref mut a) = maybe_a { sp_std::mem::swap(s, &mut a.is_sufficient) }
+	);
+}
+
+fn add_consumers<T: Config>(minter: T::AccountId, n: u32) {
 	let origin = SystemOrigin::Signed(minter);
+	let mut s = false;
+	swap_is_sufficient::<T>(&mut s);
 	for i in 0..n {
-		let target = account("zombie", i, SEED);
+		let target = account("consumer", i, SEED);
+		T::Currency::make_free_balance_be(&target, T::Currency::minimum_balance());
 		let target_lookup = T::Lookup::unlookup(target);
 		assert!(Assets::<T>::mint(origin.clone().into(), Default::default(), target_lookup, 100u32.into()).is_ok());
 	}
+	swap_is_sufficient::<T>(&mut s);
+}
+
+fn add_sufficients<T: Config>(minter: T::AccountId, n: u32) {
+	let origin = SystemOrigin::Signed(minter);
+	let mut s = true;
+	swap_is_sufficient::<T>(&mut s);
+	for i in 0..n {
+		let target = account("sufficient", i, SEED);
+		let target_lookup = T::Lookup::unlookup(target);
+		assert!(Assets::<T>::mint(origin.clone().into(), Default::default(), target_lookup, 100u32.into()).is_ok());
+	}
+	swap_is_sufficient::<T>(&mut s);
+}
+
+fn add_approvals<T: Config>(minter: T::AccountId, n: u32) {
+	T::Currency::deposit_creating(&minter, T::ApprovalDeposit::get() * n.into());
+	let minter_lookup = T::Lookup::unlookup(minter.clone());
+	let origin = SystemOrigin::Signed(minter);
+	Assets::<T>::mint(
+		origin.clone().into(),
+		Default::default(),
+		minter_lookup,
+		(100 * (n + 1)).into(),
+	).unwrap();
+	for i in 0..n {
+		let target = account("approval", i, SEED);
+		T::Currency::make_free_balance_be(&target, T::Currency::minimum_balance());
+		let target_lookup = T::Lookup::unlookup(target);
+		Assets::<T>::approve_transfer(
+			origin.clone().into(),
+			Default::default(),
+			target_lookup,
+			100u32.into(),
+		).unwrap();
+	}
 }

 fn assert_last_event<T: Config>(generic_event: <T as Config>::Event) {
@@ -77,8 +131,8 @@ benchmarks! {
 	create {
 		let caller: T::AccountId = whitelisted_caller();
 		let caller_lookup = T::Lookup::unlookup(caller.clone());
-		T::Currency::make_free_balance_be(&caller, BalanceOf::<T>::max_value());
-	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, 1, 1u32.into())
+		T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T>::max_value());
+	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, 1u32.into())
 	verify {
 		assert_last_event::<T>(Event::Created(Default::default(), caller.clone(), caller).into());
 	}
@@ -86,31 +140,27 @@ benchmarks! {
 	force_create {
 		let caller: T::AccountId = whitelisted_caller();
 		let caller_lookup = T::Lookup::unlookup(caller.clone());
-	}: _(SystemOrigin::Root, Default::default(), caller_lookup, 1, 1u32.into())
+	}: _(SystemOrigin::Root, Default::default(), caller_lookup, true, 1u32.into())
 	verify {
 		assert_last_event::<T>(Event::ForceCreated(Default::default(), caller).into());
 	}

 	destroy {
-		let z in 0 .. 10_000;
-		let (caller, _) = create_default_asset::<T>(10_000);
-		add_zombies::<T>(caller.clone(), z);
-	}: _(SystemOrigin::Signed(caller), Default::default(), 10_000)
-	verify {
-		assert_last_event::<T>(Event::Destroyed(Default::default()).into());
-	}
-
-	force_destroy {
-		let z in 0 .. 10_000;
-		let (caller, _) = create_default_asset::<T>(10_000);
-		add_zombies::<T>(caller.clone(), z);
-	}: _(SystemOrigin::Root, Default::default(), 10_000)
+		let c in 0 .. 5_000;
+		let s in 0 .. 5_000;
+		let a in 0 .. 5_00;
+		let (caller, _) = create_default_asset::<T>(true);
+		add_consumers::<T>(caller.clone(), c);
+		add_sufficients::<T>(caller.clone(), s);
+		add_approvals::<T>(caller.clone(), a);
+		let witness = Asset::<T>::get(T::AssetId::default()).unwrap().destroy_witness();
+	}: _(SystemOrigin::Signed(caller), Default::default(), witness)
 	verify {
 		assert_last_event::<T>(Event::Destroyed(Default::default()).into());
 	}

 	mint {
-		let (caller, caller_lookup) = create_default_asset::<T>(10);
+		let (caller, caller_lookup) = create_default_asset::<T>(true);
 		let amount = T::Balance::from(100u32);
 	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, amount)
 	verify {
@@ -119,7 +169,7 @@ benchmarks! {

 	burn {
 		let amount = T::Balance::from(100u32);
-		let (caller, caller_lookup) = create_default_minted_asset::<T>(10, amount);
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, amount);
 	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, amount)
 	verify {
 		assert_last_event::<T>(Event::Burned(Default::default(), caller, amount).into());
@@ -127,7 +177,7 @@ benchmarks! {

 	transfer {
 		let amount = T::Balance::from(100u32);
-		let (caller, caller_lookup) = create_default_minted_asset::<T>(10, amount);
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, amount);
 		let target: T::AccountId = account("target", 0, SEED);
 		let target_lookup = T::Lookup::unlookup(target.clone());
 	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), target_lookup, amount)
@@ -135,27 +185,39 @@ benchmarks! {
 		assert_last_event::<T>(Event::Transferred(Default::default(), caller, target, amount).into());
 	}

+	transfer_keep_alive {
+		let mint_amount = T::Balance::from(200u32);
+		let amount = T::Balance::from(100u32);
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, mint_amount);
+		let target: T::AccountId = account("target", 0, SEED);
+		let target_lookup = T::Lookup::unlookup(target.clone());
+	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), target_lookup, amount)
+	verify {
+		assert!(frame_system::Module::<T>::account_exists(&caller));
+		assert_last_event::<T>(Event::Transferred(Default::default(), caller, target, amount).into());
+	}
+
 	force_transfer {
 		let amount = T::Balance::from(100u32);
-		let (caller, caller_lookup) = create_default_minted_asset::<T>(10, amount);
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, amount);
 		let target: T::AccountId = account("target", 0, SEED);
 		let target_lookup = T::Lookup::unlookup(target.clone());
 	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup, target_lookup, amount)
 	verify {
 		assert_last_event::<T>(
-			Event::ForceTransferred(Default::default(), caller, target, amount).into()
+			Event::Transferred(Default::default(), caller, target, amount).into()
 		);
 	}

 	freeze {
-		let (caller, caller_lookup) = create_default_minted_asset::<T>(10, 100u32.into());
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, 100u32.into());
 	}: _(SystemOrigin::Signed(caller.clone()), Default::default(), caller_lookup)
 	verify {
 		assert_last_event::<T>(Event::Frozen(Default::default(), caller).into());
 	}

 	thaw {
-		let (caller, caller_lookup) = create_default_minted_asset::<T>(10, 100u32.into());
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, 100u32.into());
 		Assets::<T>::freeze(
 			SystemOrigin::Signed(caller.clone()).into(),
 			Default::default(),
@@ -167,14 +229,14 @@ benchmarks! {
 	}

 	freeze_asset {
-		let (caller, caller_lookup) = create_default_minted_asset::<T>(10, 100u32.into());
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, 100u32.into());
 	}: _(SystemOrigin::Signed(caller.clone()), Default::default())
 	verify {
 		assert_last_event::<T>(Event::AssetFrozen(Default::default()).into());
 	}

 	thaw_asset {
-		let (caller, caller_lookup) = create_default_minted_asset::<T>(10, 100u32.into());
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, 100u32.into());
 		Assets::<T>::freeze_asset(
 			SystemOrigin::Signed(caller.clone()).into(),
 			Default::default(),
@@ -185,7 +247,7 @@ benchmarks! {
 	}

 	transfer_ownership {
-		let (caller, _) = create_default_asset::<T>(10);
+		let (caller, _) = create_default_asset::<T>(true);
 		let target: T::AccountId = account("target", 0, SEED);
 		let target_lookup = T::Lookup::unlookup(target.clone());
 	}: _(SystemOrigin::Signed(caller), Default::default(), target_lookup)
@@ -194,7 +256,7 @@ benchmarks! {
 	}

 	set_team {
-		let (caller, _) = create_default_asset::<T>(10);
+		let (caller, _) = create_default_asset::<T>(true);
 		let target0 = T::Lookup::unlookup(account("target", 0, SEED));
 		let target1 = T::Lookup::unlookup(account("target", 1, SEED));
 		let target2 = T::Lookup::unlookup(account("target", 2, SEED));
@@ -208,15 +270,6 @@ benchmarks! {
 		).into());
 	}

-	set_max_zombies {
-		let (caller, _) = create_default_asset::<T>(10);
-		let max_zombies: u32 = 100;
-		T::Currency::make_free_balance_be(&caller, BalanceOf::<T>::max_value());
-	}: _(SystemOrigin::Signed(caller), Default::default(), max_zombies)
-	verify {
-		assert_last_event::<T>(Event::MaxZombiesChanged(Default::default(), max_zombies).into());
-	}
-
 	set_metadata {
 		let n in 0 .. T::StringLimit::get();
 		let s in 0 .. T::StringLimit::get();
@@ -225,12 +278,143 @@ benchmarks! {
 		let symbol = vec![0u8; s as usize];
 		let decimals = 12;

-		let (caller, _) = create_default_asset::<T>(10);
-		T::Currency::make_free_balance_be(&caller, BalanceOf::<T>::max_value());
+		let (caller, _) = create_default_asset::<T>(true);
+		T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T>::max_value());
 	}: _(SystemOrigin::Signed(caller), Default::default(), name.clone(), symbol.clone(), decimals)
 	verify {
-		assert_last_event::<T>(Event::MetadataSet(Default::default(), name, symbol, decimals).into());
+		let id = Default::default();
+		assert_last_event::<T>(Event::MetadataSet(id, name, symbol, decimals, false).into());
+	}
+
+	clear_metadata {
+		let (caller, _) = create_default_asset::<T>(true);
+		T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T>::max_value());
+		let dummy = vec![0u8; T::StringLimit::get() as usize];
+		let origin = SystemOrigin::Signed(caller.clone()).into();
+		Assets::<T>::set_metadata(origin, Default::default(), dummy.clone(), dummy, 12)?;
+	}: _(SystemOrigin::Signed(caller), Default::default())
+	verify {
+		assert_last_event::<T>(Event::MetadataCleared(Default::default()).into());
+	}
+
+	force_set_metadata {
+		let n in 0 .. T::StringLimit::get();
+		let s in 0 .. T::StringLimit::get();
+
+		let name = vec![0u8; n as usize];
+		let symbol = vec![0u8; s as usize];
+		let decimals = 12;
+
+		create_default_asset::<T>(true);
+
+		let origin = T::ForceOrigin::successful_origin();
+		let call = Call::<T>::force_set_metadata(
+			Default::default(),
+			name.clone(),
+			symbol.clone(),
+			decimals,
+			false,
+		);
+	}: { call.dispatch_bypass_filter(origin)? }
+	verify {
+		let id = Default::default();
+		assert_last_event::<T>(Event::MetadataSet(id, name, symbol, decimals, false).into());
+	}
+
+	force_clear_metadata {
+		let (caller, _) = create_default_asset::<T>(true);
+		T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T>::max_value());
+		let dummy = vec![0u8; T::StringLimit::get() as usize];
+		let origin = SystemOrigin::Signed(caller.clone()).into();
+		Assets::<T>::set_metadata(origin, Default::default(), dummy.clone(), dummy, 12)?;
+
+		let origin = T::ForceOrigin::successful_origin();
+		let call = Call::<T>::force_clear_metadata(Default::default());
+	}: { call.dispatch_bypass_filter(origin)? }
+	verify {
+		assert_last_event::<T>(Event::MetadataCleared(Default::default()).into());
+	}
+
+	force_asset_status {
+		let (caller, caller_lookup) = create_default_asset::<T>(true);
+
+		let origin = T::ForceOrigin::successful_origin();
+		let call = Call::<T>::force_asset_status(
+			Default::default(),
+			caller_lookup.clone(),
+			caller_lookup.clone(),
+			caller_lookup.clone(),
+			caller_lookup.clone(),
+			100u32.into(),
+			true,
+			false,
+		);
+	}: { call.dispatch_bypass_filter(origin)? }
+	verify {
+		assert_last_event::<T>(Event::AssetStatusChanged(Default::default()).into());
+	}
+
+	approve_transfer {
+		let (caller, _) = create_default_minted_asset::<T>(true, 100u32.into());
+		T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T>::max_value());
+
+		let id = Default::default();
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let amount = 100u32.into();
+	}: _(SystemOrigin::Signed(caller.clone()), id, delegate_lookup, amount)
+	verify {
+		assert_last_event::<T>(Event::ApprovedTransfer(id, caller, delegate, amount).into());
+	}
+
+	transfer_approved {
+		let (owner, owner_lookup) = create_default_minted_asset::<T>(true, 100u32.into());
+		T::Currency::make_free_balance_be(&owner, DepositBalanceOf::<T>::max_value());
+
+		let id = Default::default();
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		whitelist_account!(delegate);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let amount = 100u32.into();
+		let origin = SystemOrigin::Signed(owner.clone()).into();
+		Assets::<T>::approve_transfer(origin, id, delegate_lookup.clone(), amount)?;
+
+		let dest: T::AccountId = account("dest", 0, SEED);
+		let dest_lookup = T::Lookup::unlookup(dest.clone());
+	}: _(SystemOrigin::Signed(delegate.clone()), id, owner_lookup, dest_lookup, amount)
+	verify {
+		assert_last_event::<T>(Event::TransferredApproved(id, owner, delegate, dest, amount).into());
+	}
+
+	cancel_approval {
+		let (caller, _) = create_default_minted_asset::<T>(true, 100u32.into());
+		T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T>::max_value());
+
+		let id = Default::default();
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let amount = 100u32.into();
+		let origin = SystemOrigin::Signed(caller.clone()).into();
+		Assets::<T>::approve_transfer(origin, id, delegate_lookup.clone(), amount)?;
+	}: _(SystemOrigin::Signed(caller.clone()), id, delegate_lookup)
+	verify {
+		assert_last_event::<T>(Event::ApprovalCancelled(id, caller, delegate).into());
+	}
+
+	force_cancel_approval {
+		let (caller, caller_lookup) = create_default_minted_asset::<T>(true, 100u32.into());
+		T::Currency::make_free_balance_be(&caller, DepositBalanceOf::<T>::max_value());
+
+		let id = Default::default();
+		let delegate: T::AccountId = account("delegate", 0, SEED);
+		let delegate_lookup = T::Lookup::unlookup(delegate.clone());
+		let amount = 100u32.into();
+		let origin = SystemOrigin::Signed(caller.clone()).into();
+		Assets::<T>::approve_transfer(origin, id, delegate_lookup.clone(), amount)?;
+	}: _(SystemOrigin::Signed(caller.clone()), id, caller_lookup, delegate_lookup)
+	verify {
+		assert_last_event::<T>(Event::ApprovalCancelled(id, caller, delegate).into());
 	}
 }

-impl_benchmark_test_suite!(Assets, crate::tests::new_test_ext(), crate::tests::Test);
+impl_benchmark_test_suite!(Assets, crate::mock::new_test_ext(), crate::mock::Test);