Skip to content

Commit

Permalink
Remove getter macro from pallet-insecure-randomness-collective-flip (p…
Browse files Browse the repository at this point in the history
…aritytech#4839)

As per paritytech#3326, removes pallet::getter macro usage from the
pallet-insecure-randomness-collective-flip. The syntax `StorageItem::<T,
I>::get()` should be used instead.

Explicitly implements the getters that were removed as well, following
paritytech#223

Also makes the storage values public and converts some syntax to turbo

cc @muraca

---------

Co-authored-by: Bastian Köcher <[email protected]>
Co-authored-by: Oliver Tale-Yazdi <[email protected]>
  • Loading branch information
3 people authored and TarekkMA committed Aug 2, 2024
1 parent f599adb commit 084efd7
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 12 deletions.
14 changes: 14 additions & 0 deletions prdoc/pr_4839.prdoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Schema: Polkadot SDK PRDoc Schema (prdoc) v1.0.0
# See doc at https://raw.githubusercontent.com/paritytech/polkadot-sdk/master/prdoc/schema_user.json

title: Removed `pallet::getter` usage from pallet-insecure-randomness-collective-flip

doc:
- audience: Runtime Dev
description: |
This PR removed the `pallet::getter`s from `pallet-insecure-randomness-collective-flip`.
The syntax `StorageItem::<T, I>::get()` should be used instead.

crates:
- name: pallet-insecure-randomness-collective-flip
bump: patch
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ pub mod pallet {
impl<T: Config> Pallet<T> {
#[pallet::weight(0)]
pub fn random_module_example(origin: OriginFor<T>) -> DispatchResult {
let _random_value = <pallet_insecure_randomness_collective_flip::Pallet<T>>::random(&b"my context"[..]);
let _random_value = pallet_insecure_randomness_collective_flip::Pallet::<T>::random(&b"my context"[..]);
Ok(())
}
}
Expand Down
28 changes: 17 additions & 11 deletions substrate/frame/insecure-randomness-collective-flip/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
//! impl<T: Config> Pallet<T> {
//! #[pallet::weight(0)]
//! pub fn random_module_example(origin: OriginFor<T>) -> DispatchResult {
//! let _random_value = <pallet_insecure_randomness_collective_flip::Pallet<T>>::random(&b"my context"[..]);
//! let _random_value = pallet_insecure_randomness_collective_flip::Pallet::<T>::random(&b"my context"[..]);
//! Ok(())
//! }
//! }
Expand Down Expand Up @@ -101,9 +101,9 @@ pub mod pallet {
#[pallet::hooks]
impl<T: Config> Hooks<BlockNumberFor<T>> for Pallet<T> {
fn on_initialize(block_number: BlockNumberFor<T>) -> Weight {
let parent_hash = <frame_system::Pallet<T>>::parent_hash();
let parent_hash = frame_system::Pallet::<T>::parent_hash();

<RandomMaterial<T>>::mutate(|ref mut values| {
RandomMaterial::<T>::mutate(|ref mut values| {
if values.try_push(parent_hash).is_err() {
let index = block_number_to_index::<T>(block_number);
values[index] = parent_hash;
Expand All @@ -118,9 +118,15 @@ pub mod pallet {
/// is arranged as a ring buffer with `block_number % 81` being the index into the `Vec` of
/// the oldest hash.
#[pallet::storage]
#[pallet::getter(fn random_material)]
pub(super) type RandomMaterial<T: Config> =
pub type RandomMaterial<T: Config> =
StorageValue<_, BoundedVec<T::Hash, ConstU32<RANDOM_MATERIAL_LEN>>, ValueQuery>;

impl<T: Config> Pallet<T> {
/// Gets the random material storage value
pub fn random_material() -> BoundedVec<T::Hash, ConstU32<RANDOM_MATERIAL_LEN>> {
RandomMaterial::<T>::get()
}
}
}

impl<T: Config> Randomness<T::Hash, BlockNumberFor<T>> for Pallet<T> {
Expand All @@ -135,10 +141,10 @@ impl<T: Config> Randomness<T::Hash, BlockNumberFor<T>> for Pallet<T> {
/// and mean that all bits of the resulting value are entirely manipulatable by the author of
/// the parent block, who can determine the value of `parent_hash`.
fn random(subject: &[u8]) -> (T::Hash, BlockNumberFor<T>) {
let block_number = <frame_system::Pallet<T>>::block_number();
let block_number = frame_system::Pallet::<T>::block_number();
let index = block_number_to_index::<T>(block_number);

let hash_series = <RandomMaterial<T>>::get();
let hash_series = RandomMaterial::<T>::get();
let seed = if !hash_series.is_empty() {
// Always the case after block 1 is initialized.
hash_series
Expand Down Expand Up @@ -226,7 +232,7 @@ mod tests {

setup_blocks(38);

let random_material = CollectiveFlip::random_material();
let random_material = RandomMaterial::<Test>::get();

assert_eq!(random_material.len(), 38);
assert_eq!(random_material[0], genesis_hash);
Expand All @@ -240,7 +246,7 @@ mod tests {

setup_blocks(81);

let random_material = CollectiveFlip::random_material();
let random_material = RandomMaterial::<Test>::get();

assert_eq!(random_material.len(), 81);
assert_ne!(random_material[0], random_material[1]);
Expand All @@ -255,7 +261,7 @@ mod tests {

setup_blocks(162);

let random_material = CollectiveFlip::random_material();
let random_material = RandomMaterial::<Test>::get();

assert_eq!(random_material.len(), 81);
assert_ne!(random_material[0], random_material[1]);
Expand All @@ -276,7 +282,7 @@ mod tests {

assert_eq!(known_since, 162 - RANDOM_MATERIAL_LEN as u64);
assert_ne!(random, H256::zero());
assert!(!CollectiveFlip::random_material().contains(&random));
assert!(!RandomMaterial::<Test>::get().contains(&random));
});
}
}

0 comments on commit 084efd7

Please sign in to comment.