FRAME: Revamp Preimage pallet to use Consideration (#1363)

Make Preimage pallet use Consideration instead of handling deposits directly. Other half of paritytech/substrate#13666. Depends/based on #1361. Script for the lazy migration that should be run manually once: [migrate-preimage-lazy.py](https://github.com/ggwpez/substrate-scripts/blob/master/migrate-preimage-lazy.py). ## TODO - [x] Migration code. --------- Signed-off-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io> Co-authored-by: command-bot <> Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
2026-04-30 02:37:58 +00:00 · 2023-09-17 12:19:18 +01:00
parent 11d1a3955e
commit d787269cdf
25 changed files with 789 additions and 348 deletions
@@ -24,12 +24,11 @@ use crate::mock::*;

 use frame_support::{
 	assert_err, assert_noop, assert_ok, assert_storage_noop,
-	traits::{Bounded, BoundedInline, Hash as PreimageHash},
+	traits::{fungible::InspectHold, Bounded, BoundedInline, Hash as PreimageHash},
 	StorageNoopGuard,
 };
-use pallet_balances::Error as BalancesError;
 use sp_core::{blake2_256, H256};
-use sp_runtime::bounded_vec;
+use sp_runtime::{bounded_vec, TokenError};

 /// Returns one `Inline`, `Lookup` and `Legacy` item each with different data and hash.
 pub fn make_bounded_values() -> (Bounded<Vec<u8>>, Bounded<Vec<u8>>, Bounded<Vec<u8>>) {
@@ -52,7 +51,7 @@ pub fn make_bounded_values() -> (Bounded<Vec<u8>>, Bounded<Vec<u8>>, Bounded<Vec
 fn user_note_preimage_works() {
 	new_test_ext().execute_with(|| {
 		assert_ok!(Preimage::note_preimage(RuntimeOrigin::signed(2), vec![1]));
-		assert_eq!(Balances::reserved_balance(2), 3);
+		assert_eq!(Balances::balance_on_hold(&(), &2), 3);
 		assert_eq!(Balances::free_balance(2), 97);

 		let h = hashed([1]);
@@ -61,11 +60,11 @@ fn user_note_preimage_works() {

 		assert_noop!(
 			Preimage::note_preimage(RuntimeOrigin::signed(2), vec![1]),
-			Error::<Test>::AlreadyNoted
+			Error::<Test>::AlreadyNoted,
 		);
 		assert_noop!(
 			Preimage::note_preimage(RuntimeOrigin::signed(0), vec![2]),
-			BalancesError::<Test>::InsufficientBalance
+			TokenError::FundsUnavailable,
 		);
 	});
 }
@@ -171,7 +170,7 @@ fn request_note_order_makes_no_difference() {
 		assert_ok!(Preimage::request_preimage(RuntimeOrigin::signed(1), hashed([1])));
 		assert_ok!(Preimage::note_preimage(RuntimeOrigin::signed(2), vec![1]));
 		(
-			StatusFor::<Test>::iter().collect::<Vec<_>>(),
+			RequestStatusFor::<Test>::iter().collect::<Vec<_>>(),
 			PreimageFor::<Test>::iter().collect::<Vec<_>>(),
 		)
 	});
@@ -180,7 +179,7 @@ fn request_note_order_makes_no_difference() {
 		assert_ok!(Preimage::request_preimage(RuntimeOrigin::signed(1), hashed([1])));
 		assert_ok!(Preimage::unnote_preimage(RuntimeOrigin::signed(2), hashed([1])));
 		let other_way = (
-			StatusFor::<Test>::iter().collect::<Vec<_>>(),
+			RequestStatusFor::<Test>::iter().collect::<Vec<_>>(),
 			PreimageFor::<Test>::iter().collect::<Vec<_>>(),
 		);
 		assert_eq!(one_way, other_way);
@@ -207,7 +206,7 @@ fn request_user_note_order_makes_no_difference() {
 		assert_ok!(Preimage::request_preimage(RuntimeOrigin::signed(1), hashed([1])));
 		assert_ok!(Preimage::note_preimage(RuntimeOrigin::signed(2), vec![1]));
 		(
-			StatusFor::<Test>::iter().collect::<Vec<_>>(),
+			RequestStatusFor::<Test>::iter().collect::<Vec<_>>(),
 			PreimageFor::<Test>::iter().collect::<Vec<_>>(),
 		)
 	});
@@ -216,7 +215,7 @@ fn request_user_note_order_makes_no_difference() {
 		assert_ok!(Preimage::request_preimage(RuntimeOrigin::signed(1), hashed([1])));
 		assert_ok!(Preimage::unnote_preimage(RuntimeOrigin::signed(2), hashed([1])));
 		let other_way = (
-			StatusFor::<Test>::iter().collect::<Vec<_>>(),
+			RequestStatusFor::<Test>::iter().collect::<Vec<_>>(),
 			PreimageFor::<Test>::iter().collect::<Vec<_>>(),
 		);
 		assert_eq!(one_way, other_way);
@@ -249,13 +248,14 @@ fn unrequest_preimage_works() {
 fn user_noted_then_requested_preimage_is_refunded_once_only() {
 	new_test_ext().execute_with(|| {
 		assert_ok!(Preimage::note_preimage(RuntimeOrigin::signed(2), vec![1; 3]));
+		assert_eq!(Balances::balance_on_hold(&(), &2), 5);
 		assert_ok!(Preimage::note_preimage(RuntimeOrigin::signed(2), vec![1]));
+		assert_eq!(Balances::balance_on_hold(&(), &2), 8);
 		assert_ok!(Preimage::request_preimage(RuntimeOrigin::signed(1), hashed([1])));
 		assert_ok!(Preimage::unrequest_preimage(RuntimeOrigin::signed(1), hashed([1])));
 		assert_ok!(Preimage::unnote_preimage(RuntimeOrigin::signed(2), hashed([1])));
-		// Still have reserve from `vec[1; 3]`.
-		assert_eq!(Balances::reserved_balance(2), 5);
-		assert_eq!(Balances::free_balance(2), 95);
+		// Still have hold from `vec[1; 3]`.
+		assert_eq!(Balances::balance_on_hold(&(), &2), 5);
 	});
 }

@@ -270,7 +270,7 @@ fn noted_preimage_use_correct_map() {
 		assert_eq!(PreimageFor::<Test>::iter().count(), 8);

 		// All are present
-		assert_eq!(StatusFor::<Test>::iter().count(), 8);
+		assert_eq!(RequestStatusFor::<Test>::iter().count(), 8);

 		// Now start removing them again...
 		for i in 0..7 {
@@ -287,7 +287,7 @@ fn noted_preimage_use_correct_map() {
 		assert_eq!(PreimageFor::<Test>::iter().count(), 0);

 		// All are gone
-		assert_eq!(StatusFor::<Test>::iter().count(), 0);
+		assert_eq!(RequestStatusFor::<Test>::iter().count(), 0);
 	});
 }

@@ -327,20 +327,20 @@ fn query_and_store_preimage_workflow() {
 		Preimage::request(&hash);
 		// It is requested thrice.
 		assert!(matches!(
-			StatusFor::<Test>::get(&hash).unwrap(),
+			RequestStatusFor::<Test>::get(&hash).unwrap(),
 			RequestStatus::Requested { count: 3, .. }
 		));

 		// It can be realized and decoded correctly.
 		assert_eq!(Preimage::realize::<Vec<u8>>(&bound).unwrap(), (data.clone(), Some(len)));
 		assert!(matches!(
-			StatusFor::<Test>::get(&hash).unwrap(),
+			RequestStatusFor::<Test>::get(&hash).unwrap(),
 			RequestStatus::Requested { count: 2, .. }
 		));
 		// Dropping should unrequest.
 		Preimage::drop(&bound);
 		assert!(matches!(
-			StatusFor::<Test>::get(&hash).unwrap(),
+			RequestStatusFor::<Test>::get(&hash).unwrap(),
 			RequestStatus::Requested { count: 1, .. }
 		));

@@ -381,7 +381,7 @@ fn query_preimage_request_works() {
 		assert!(<Preimage as QueryPreimage>::len(&hash).is_none());
 		assert_noop!(<Preimage as QueryPreimage>::fetch(&hash, None), DispatchError::Unavailable);
 		// But there is only one entry in the map.
-		assert_eq!(StatusFor::<Test>::iter().count(), 1);
+		assert_eq!(RequestStatusFor::<Test>::iter().count(), 1);

 		// Un-request the preimage.
 		<Preimage as QueryPreimage>::unrequest(&hash);
@@ -392,7 +392,7 @@ fn query_preimage_request_works() {
 		// It is not requested anymore.
 		assert!(!<Preimage as QueryPreimage>::is_requested(&hash));
 		// And there is no entry in the map.
-		assert_eq!(StatusFor::<Test>::iter().count(), 0);
+		assert_eq!(RequestStatusFor::<Test>::iter().count(), 0);
 	});
 }

@@ -413,7 +413,7 @@ fn query_preimage_hold_and_drop_work() {
 		assert!(<Preimage as QueryPreimage>::is_requested(&legacy.hash()));

 		// There are two values requested in total.
-		assert_eq!(StatusFor::<Test>::iter().count(), 2);
+		assert_eq!(RequestStatusFor::<Test>::iter().count(), 2);

 		// Cleanup by dropping both.
 		<Preimage as QueryPreimage>::drop(&lookup);
@@ -422,7 +422,7 @@ fn query_preimage_hold_and_drop_work() {
 		assert!(!<Preimage as QueryPreimage>::is_requested(&legacy.hash()));

 		// There are no values requested anymore.
-		assert_eq!(StatusFor::<Test>::iter().count(), 0);
+		assert_eq!(RequestStatusFor::<Test>::iter().count(), 0);
 	});
 }

@@ -489,3 +489,27 @@ fn store_preimage_bound_too_large_errors() {
 		assert_ok!(<Preimage as StorePreimage>::bound(data.clone()));
 	});
 }
+
+#[test]
+fn ensure_updated_works() {
+	#![allow(deprecated)]
+	new_test_ext().execute_with(|| {
+		let alice = 2;
+
+		for i in 0..100 {
+			let hashes =
+				(0..100).map(|j| insert_old_unrequested::<Test>(j, alice)).collect::<Vec<_>>();
+			let old = hashes.iter().take(i).cloned().collect::<Vec<_>>();
+			let bad = vec![hashed([0; 32]); 100 - i];
+
+			let hashes = [old.as_slice(), bad.as_slice()].concat();
+			let res = Preimage::ensure_updated(RuntimeOrigin::signed(alice), hashes).unwrap();
+
+			// Alice pays a fee when less than 90% of the hashes are new.
+			assert_eq!(res.pays_fee, (i < 90).into());
+
+			assert_eq!(RequestStatusFor::<Test>::iter().count(), i);
+			assert_eq!(StatusFor::<Test>::iter().count(), 100 - i);
+		}
+	});
+}