From e30c18d61dd0922c4ca7f838b7ceff9283542cd3 Mon Sep 17 00:00:00 2001
From: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Date: Fri, 6 May 2022 14:25:07 +0100
Subject: [PATCH] allow defensive operations to take a proof (#11353)
* allow defensive operations to take a proof
* Update frame/support/src/traits/misc.rs
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
* Update frame/bags-list/src/list/mod.rs
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* Update frame/support/src/traits/misc.rs
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* Update frame/support/src/traits/misc.rs
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
* Fix build
* fix build again
* fmt
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: Keith Yeung <kungfukeith11@gmail.com>
---
substrate/frame/bags-list/src/list/mod.rs | 4 +--
substrate/frame/staking/src/slashing.rs | 6 ++---
substrate/frame/support/src/traits/misc.rs | 31 ++++++++++++++++++++++
3 files changed, 36 insertions(+), 5 deletions(-)
diff --git a/substrate/frame/bags-list/src/list/mod.rs b/substrate/frame/bags-list/src/list/mod.rs
index f93bfca1081..2e65c3be25b 100644
--- a/substrate/frame/bags-list/src/list/mod.rs
+++ b/substrate/frame/bags-list/src/list/mod.rs
@@ -443,8 +443,8 @@ impl<T: Config<I>, I: 'static> List<T, I> {
// remove the heavier node from this list. Note that this removes the node from storage and
// decrements the node counter.
- // defensive: both nodes have been checked to exist.
- let _ = Self::remove(&heavier_id).defensive();
+ let _ =
+ Self::remove(&heavier_id).defensive_proof("both nodes have been checked to exist; qed");
// re-fetch `lighter_node` from storage since it may have been updated when `heavier_node`
// was removed.
diff --git a/substrate/frame/staking/src/slashing.rs b/substrate/frame/staking/src/slashing.rs
index 0d55eb7fe0d..25954a3699b 100644
--- a/substrate/frame/staking/src/slashing.rs
+++ b/substrate/frame/staking/src/slashing.rs
@@ -56,7 +56,7 @@ use crate::{
use codec::{Decode, Encode};
use frame_support::{
ensure,
- traits::{Currency, Get, Imbalance, OnUnbalanced},
+ traits::{Currency, Defensive, Get, Imbalance, OnUnbalanced},
};
use scale_info::TypeInfo;
use sp_runtime::{
@@ -600,8 +600,8 @@ pub fn do_slash<T: Config>(
slashed_imbalance: &mut NegativeImbalanceOf<T>,
slash_era: EraIndex,
) {
- let controller = match <Pallet<T>>::bonded(stash) {
- None => return, // defensive: should always exist.
+ let controller = match <Pallet<T>>::bonded(stash).defensive() {
+ None => return,
Some(c) => c,
};
diff --git a/substrate/frame/support/src/traits/misc.rs b/substrate/frame/support/src/traits/misc.rs
index b67eac2fbe7..03420f64dd5 100644
--- a/substrate/frame/support/src/traits/misc.rs
+++ b/substrate/frame/support/src/traits/misc.rs
@@ -50,6 +50,16 @@ macro_rules! defensive {
$error
);
debug_assert!(false, "{}: {:?}", $crate::traits::DEFENSIVE_OP_INTERNAL_ERROR, $error);
+ };
+ ($error:tt, $proof:tt) => {
+ frame_support::log::error!(
+ target: "runtime",
+ "{}: {:?}: {:?}",
+ $crate::traits::DEFENSIVE_OP_PUBLIC_ERROR,
+ $error,
+ $proof,
+ );
+ debug_assert!(false, "{}: {:?}: {:?}", $crate::traits::DEFENSIVE_OP_INTERNAL_ERROR, $error, $proof);
}
}
@@ -102,6 +112,10 @@ pub trait Defensive<T> {
/// }
/// ```
fn defensive(self) -> Self;
+
+ /// Same as [`Defensive::defensive`], but it takes a proof as input, and displays it if the
+ /// defensive operation has been triggered.
+ fn defensive_proof(self, proof: &'static str) -> Self;
}
/// Subset of methods similar to [`Defensive`] that can only work for a `Result`.
@@ -184,6 +198,13 @@ impl<T> Defensive<T> for Option<T> {
},
}
}
+
+ fn defensive_proof(self, proof: &'static str) -> Self {
+ if self.is_none() {
+ defensive!(proof);
+ }
+ self
+ }
}
impl<T, E: sp_std::fmt::Debug> Defensive<T> for Result<T, E> {
@@ -229,6 +250,16 @@ impl<T, E: sp_std::fmt::Debug> Defensive<T> for Result<T, E> {
},
}
}
+
+ fn defensive_proof(self, proof: &'static str) -> Self {
+ match self {
+ Ok(inner) => Ok(inner),
+ Err(e) => {
+ defensive!(e, proof);
+ Err(e)
+ },
+ }
+ }
}
impl<T, E: sp_std::fmt::Debug> DefensiveResult<T, E> for Result<T, E> {
--
GitLab