From 4249a3d6cbca1da2ee15237c05691005973502e9 Mon Sep 17 00:00:00 2001
From: s0me0ne-unkn0wn <48632512+s0me0ne-unkn0wn@users.noreply.github.com>
Date: Mon, 11 Mar 2024 15:38:44 +0100
Subject: [PATCH] Remove getters from `im-online` pallet (#3589)
As I've been dancing around this pallet for quite some time anyway, I
decided to remove getters at once. There were only a few leftovers in
tests.
Related: #3326
CC @muraca
---
prdoc/pr_3589.prdoc | 10 ++++++++++
substrate/frame/im-online/src/lib.rs | 12 ++++--------
substrate/frame/im-online/src/tests.rs | 9 +++------
3 files changed, 17 insertions(+), 14 deletions(-)
create mode 100644 prdoc/pr_3589.prdoc
diff --git a/prdoc/pr_3589.prdoc b/prdoc/pr_3589.prdoc
new file mode 100644
index 00000000000..98b9b1039ab
--- /dev/null
+++ b/prdoc/pr_3589.prdoc
@@ -0,0 +1,10 @@
+title: Removed `pallet::getter` usage from `pallet-im-online`
+
+doc:
+ - audience: Runtime Dev
+ description: |
+ This PR removes `pallet::getter` usage from `pallet-im-online`, and updates dependant code accordingly.
+ The syntax `StorageItem::<T, I>::get()` should be used instead.
+
+crates:
+ - name: pallet-im-online
diff --git a/substrate/frame/im-online/src/lib.rs b/substrate/frame/im-online/src/lib.rs
index f14093aa09a..239b47834d1 100644
--- a/substrate/frame/im-online/src/lib.rs
+++ b/substrate/frame/im-online/src/lib.rs
@@ -338,26 +338,22 @@ pub mod pallet {
/// progress estimate from `NextSessionRotation`, as those estimates should be
/// more accurate then the value we calculate for `HeartbeatAfter`.
#[pallet::storage]
- #[pallet::getter(fn heartbeat_after)]
- pub(super) type HeartbeatAfter<T: Config> = StorageValue<_, BlockNumberFor<T>, ValueQuery>;
+ pub type HeartbeatAfter<T: Config> = StorageValue<_, BlockNumberFor<T>, ValueQuery>;
/// The current set of keys that may issue a heartbeat.
#[pallet::storage]
- #[pallet::getter(fn keys)]
- pub(super) type Keys<T: Config> =
+ pub type Keys<T: Config> =
StorageValue<_, WeakBoundedVec<T::AuthorityId, T::MaxKeys>, ValueQuery>;
/// For each session index, we keep a mapping of `SessionIndex` and `AuthIndex`.
#[pallet::storage]
- #[pallet::getter(fn received_heartbeats)]
- pub(super) type ReceivedHeartbeats<T: Config> =
+ pub type ReceivedHeartbeats<T: Config> =
StorageDoubleMap<_, Twox64Concat, SessionIndex, Twox64Concat, AuthIndex, bool>;
/// For each session index, we keep a mapping of `ValidatorId<T>` to the
/// number of blocks authored by the given authority.
#[pallet::storage]
- #[pallet::getter(fn authored_blocks)]
- pub(super) type AuthoredBlocks<T: Config> = StorageDoubleMap<
+ pub type AuthoredBlocks<T: Config> = StorageDoubleMap<
_,
Twox64Concat,
SessionIndex,
diff --git a/substrate/frame/im-online/src/tests.rs b/substrate/frame/im-online/src/tests.rs
index 7efca926eb0..6f5a14d7e7f 100644
--- a/substrate/frame/im-online/src/tests.rs
+++ b/substrate/frame/im-online/src/tests.rs
@@ -26,10 +26,7 @@ use sp_core::offchain::{
testing::{TestOffchainExt, TestTransactionPoolExt},
OffchainDbExt, OffchainWorkerExt, TransactionPoolExt,
};
-use sp_runtime::{
- testing::UintAuthorityId,
- transaction_validity::{InvalidTransaction, TransactionValidityError},
-};
+use sp_runtime::testing::UintAuthorityId;
#[test]
fn test_unresponsiveness_slash_fraction() {
@@ -267,14 +264,14 @@ fn should_cleanup_received_heartbeats_on_session_end() {
let _ = heartbeat(1, 2, 0, 1.into(), Session::validators()).unwrap();
// the heartbeat is stored
- assert!(!ImOnline::received_heartbeats(&2, &0).is_none());
+ assert!(!super::pallet::ReceivedHeartbeats::<Runtime>::get(2, 0).is_none());
advance_session();
// after the session has ended we have already processed the heartbeat
// message, so any messages received on the previous session should have
// been pruned.
- assert!(ImOnline::received_heartbeats(&2, &0).is_none());
+ assert!(super::pallet::ReceivedHeartbeats::<Runtime>::get(2, 0).is_none());
});
}
--
GitLab