Adding try_state hook(tips & vesting)

frame/tips/src/lib.rs

@@ -452,6 +452,14 @@ pub mod pallet {
 			Ok(())
 		}
 	}
+
+	#[pallet::hooks]
+	impl<T: Config<I>, I: 'static> Hooks<BlockNumberFor<T>> for Pallet<T, I> {
+		#[cfg(feature = "try-runtime")]
+		fn try_state(_n: BlockNumberFor<T>) -> Result<(), &'static str> {
+			Self::do_try_state()
+		}
+	}
 }
 
 impl<T: Config<I>, I: 'static> Pallet<T, I> {
@@ -598,4 +606,19 @@ impl<T: Config<I>, I: 'static> Pallet<T, I> {
 			Tips::<T, I>::insert(hash, new_tip)
 		}
 	}
+
+	/// Ensure the correctness of the state of this pallet.
+	///
+	/// This should be valid before or after each state transition of this pallet.
+	///
+	/// ## Invariants:
+	///
+	/// * `Reasons` and `Tips` must have the same length of keys
+	#[cfg(any(feature = "try-runtime", test))]
+	pub fn do_try_state() -> Result<(), &'static str> {
+		let reasons = Reasons::<T, I>::iter_keys().collect::<Vec<_>>();
+		let tips = Tips::<T, I>::iter_keys().collect::<Vec<_>>();
+		assert_eq!(reasons.len(), tips.len());
+		Ok(())
+	}
 }

frame/tips/src/tests.rs

@@ -239,6 +239,7 @@ fn tip_new_cannot_be_used_twice() {
 			Tips::tip_new(RuntimeOrigin::signed(11), b"awesome.dot".to_vec(), 3, 10),
 			Error::<Test>::AlreadyKnown
 		);
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -266,6 +267,7 @@ fn report_awesome_and_tip_works() {
 		assert_eq!(Balances::reserved_balance(0), 0);
 		assert_eq!(Balances::free_balance(0), 102);
 		assert_eq!(Balances::free_balance(3), 8);
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -284,6 +286,7 @@ fn report_awesome_from_beneficiary_and_tip_works() {
 		assert_ok!(Tips::close_tip(RuntimeOrigin::signed(100), h.into()));
 		assert_eq!(Balances::reserved_balance(0), 0);
 		assert_eq!(Balances::free_balance(0), 110);
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -322,6 +325,8 @@ fn close_tip_works() {
 			Tips::close_tip(RuntimeOrigin::signed(100), h.into()),
 			Error::<Test>::UnknownTip
 		);
+
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -353,6 +358,8 @@ fn slash_tip_works() {
 		// tipper slashed
 		assert_eq!(Balances::reserved_balance(0), 0);
 		assert_eq!(Balances::free_balance(0), 88);
+
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -387,6 +394,8 @@ fn retract_tip_works() {
 			Tips::close_tip(RuntimeOrigin::signed(10), h.into()),
 			Error::<Test>::UnknownTip
 		);
+
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -401,6 +410,7 @@ fn tip_median_calculation_works() {
 		System::set_block_number(2);
 		assert_ok!(Tips::close_tip(RuntimeOrigin::signed(0), h.into()));
 		assert_eq!(Balances::free_balance(3), 10);
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -420,6 +430,7 @@ fn tip_changing_works() {
 		System::set_block_number(2);
 		assert_ok!(Tips::close_tip(RuntimeOrigin::signed(0), h.into()));
 		assert_eq!(Balances::free_balance(3), 10);
+		Tips::do_try_state().unwrap();
 	});
 }
 
@@ -617,5 +628,7 @@ fn report_awesome_and_tip_works_second_instance() {
 		assert_eq!(Balances::free_balance(&Treasury::account_id()), 101);
 		// Treasury 2 gave the funds
 		assert_eq!(Balances::free_balance(&Treasury1::account_id()), 191);
+
+		Tips::do_try_state().unwrap();
 	});
 }

frame/vesting/src/lib.rs

@@ -192,6 +192,11 @@ pub mod pallet {
 		fn integrity_test() {
 			assert!(T::MAX_VESTING_SCHEDULES > 0, "`MaxVestingSchedules` must ge greater than 0");
 		}
+
+		#[cfg(feature = "try-runtime")]
+		fn try_state(_n: BlockNumberFor<T>) -> Result<(), &'static str> {
+			Self::do_try_state()
+		}
 	}
 
 	/// Information regarding the vesting of a given account.
@@ -648,6 +653,34 @@ impl<T: Config> Pallet<T> {
 
 		Ok((schedules, locked_now))
 	}
+
+	/// Ensure the correctness of the state of this pallet.
+	///
+	/// This should be valid before or after each state transition of this pallet.
+	///
+	/// ## Invariants:
+	///
+	/// * The `per_block` payments left of every account currently vesting
+	/// * is equal to the total balance currently locked.
+	#[cfg(any(feature = "try-runtime", test))]
+	pub fn do_try_state() -> Result<(), &'static str> {
+		Vesting::<T>::iter().for_each(|(_, d)| {
+			let vesting = d.to_vec();
+			let mut total_per_block: BalanceOf<T> = Zero::zero();
+			let mut total_locked_now: BalanceOf<T> = Zero::zero();
+			for info in vesting.iter() {
+				// get the number of remaining vesting blocks<>balance
+				let payments_left: BalanceOf<T> =
+					info.ending_block_as_balance::<T::BlockNumberToBalance>();
+				total_per_block += info.per_block().saturating_mul(payments_left);
+				total_locked_now += info
+					.locked_at::<T::BlockNumberToBalance>(<frame_system::Pallet<T>>::block_number());
+			}
+			let one_extra = total_per_block.saturating_sub(total_locked_now);
+			assert_eq!(total_per_block, total_locked_now.saturating_add(one_extra));
+		});
+		Ok(())
+	}
 }
 
 impl<T: Config> VestingSchedule<T::AccountId> for Pallet<T>

frame/vesting/src/mock.rs

@@ -153,7 +153,10 @@ impl ExtBuilder {
 			.assimilate_storage(&mut t)
 			.unwrap();
 		let mut ext = sp_io::TestExternalities::new(t);
-		ext.execute_with(|| System::set_block_number(1));
+		ext.execute_with(|| {
+			System::set_block_number(1);
+			Vesting::do_try_state().unwrap();
+		});
 		ext
 	}
 }