Remove Offence delay (#8414)

* Removed can_report api from OnOffenceHandler * Removed DeferredOffences and create a storage migration * Removed missing comments * Mock set_deferred_offences and deferred_offences methods * OnOffenceHandler::on_offence always succeed * Fix benchmark tests * Fix runtime-benchmark cfg methods * Removed 'applied' attribute from Offence event * refactor deprecated deferred offences getter * Validate if offences are submited after on_runtime_upgrade * update changelog * Remove empty lines * Fix remove_deferred_storage weights * Remove Offence::on_runtime_upgrade benchmark * Revert CHANGELOG.md update * Deprecate DeferredOffenceOf type * Update copyright Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Add migration logs Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> * Fix migration log * Remove unused import * Add migration tests * rustfmt * use generate_storage_alias! macro * Refactor should_resubmit_deferred_offences test * Replace spaces by tabs * Refactor should_resubmit_deferred_offences test * Removed WeightSoftLimit * Removed WeightSoftLimit from tests and mocks * Remove unused imports * Apply suggestions from code review Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
2026-04-29 04:27:57 +00:00 · 2021-05-03 04:53:09 -03:00
parent c786fb21a0
commit ffca28ba59
13 changed files with 132 additions and 314 deletions
@@ -0,0 +1,99 @@
+// This file is part of Substrate.
+
+// Copyright (C) 2021 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.
+
+use super::{Config, OffenceDetails, Perbill, SessionIndex};
+use frame_support::{traits::Get, weights::Weight, generate_storage_alias};
+use sp_staking::offence::OnOffenceHandler;
+use sp_std::vec::Vec;
+
+/// Type of data stored as a deferred offence
+type DeferredOffenceOf<T> = (
+	Vec<
+		OffenceDetails<
+			<T as frame_system::Config>::AccountId,
+			<T as Config>::IdentificationTuple,
+		>,
+	>,
+	Vec<Perbill>,
+	SessionIndex,
+);
+
+// Deferred reports that have been rejected by the offence handler and need to be submitted
+// at a later time.
+generate_storage_alias!(
+	Offences,
+	DeferredOffences<T: Config> => Value<Vec<DeferredOffenceOf<T>>>
+);
+
+pub fn remove_deferred_storage<T: Config>() -> Weight {
+	let mut weight = T::DbWeight::get().reads_writes(1, 1);
+	let deferred = <DeferredOffences<T>>::take();
+	log::info!(target: "runtime::offences", "have {} deferred offences, applying.", deferred.len());
+	for (offences, perbill, session) in deferred.iter() {
+		let consumed = T::OnOffenceHandler::on_offence(&offences, &perbill, *session);
+		weight = weight.saturating_add(consumed);
+	}
+
+	weight
+}
+
+#[cfg(test)]
+mod test {
+	use super::*;
+	use crate::mock::{new_test_ext, with_on_offence_fractions, Offences, Runtime as T};
+	use frame_support::traits::OnRuntimeUpgrade;
+	use sp_runtime::Perbill;
+	use sp_staking::offence::OffenceDetails;
+
+	#[test]
+	fn should_resubmit_deferred_offences() {
+		new_test_ext().execute_with(|| {
+			// given
+			assert_eq!(<DeferredOffences<T>>::get().len(), 0);
+			with_on_offence_fractions(|f| {
+				assert_eq!(f.clone(), vec![]);
+			});
+
+			let offence_details = OffenceDetails::<
+				<T as frame_system::Config>::AccountId,
+				<T as Config>::IdentificationTuple,
+			> {
+				offender: 5,
+				reporters: vec![],
+			};
+
+			// push deferred offence
+			<DeferredOffences<T>>::append((
+				vec![offence_details],
+				vec![Perbill::from_percent(5 + 1 * 100 / 5)],
+				1,
+			));
+
+			// when
+			assert_eq!(
+				Offences::on_runtime_upgrade(),
+				<T as frame_system::Config>::DbWeight::get().reads_writes(1, 2),
+			);
+
+			// then
+			assert!(!<DeferredOffences<T>>::exists());
+			with_on_offence_fractions(|f| {
+				assert_eq!(f.clone(), vec![Perbill::from_percent(5 + 1 * 100 / 5)]);
+			});
+		})
+	}
+}