pezkuwichain/pezkuwi-subxt
1
0
Fork 0
mirror of https://github.com/pezkuwichain/pezkuwi-subxt.git synced 2026-06-16 23:41:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Runtime Upgrade ref docs and Single Block Migration example pallet (#1554)

Browse Source 
Closes https://github.com/paritytech/polkadot-sdk-docs/issues/55

- Changes 'current storage version' terminology to less ambiguous
'in-code storage version' (suggestion by @ggwpez)
- Adds a new example pallet `pallet-example-single-block-migrations`
- Adds a new reference doc to replace
https://docs.substrate.io/maintain/runtime-upgrades/ (temporarily living
in the pallet while we wait for developer hub PR to merge)
- Adds documentation for the `storage_alias` macro
- Improves `trait Hooks` docs 
- Improves `trait GetStorageVersion` docs
- Update the suggested patterns for using `VersionedMigration`, so that
version unchecked migrations are never exported
- Prevents accidental usage of version unchecked migrations in runtimes

https://github.com/paritytech/substrate/pull/14421#discussion_r1255467895
- Unversioned migration code is kept inside `mod version_unchecked`,
versioned code is kept in `pub mod versioned`
- It is necessary to use modules to limit visibility because the inner
migration must be `pub`. See
https://github.com/rust-lang/rust/issues/30905 and

https://internals.rust-lang.org/t/lang-team-minutes-private-in-public-rules/4504/40
for more.

### todo

- [x] move to reference docs to proper place within sdk-docs (now that
https://github.com/paritytech/polkadot-sdk/pull/2102 is merged)
- [x] prdoc

---------

Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com>
Co-authored-by: Juan <juangirini@gmail.com>
Co-authored-by: Oliver Tale-Yazdi <oliver.tale-yazdi@parity.io>
Co-authored-by: command-bot <>
Co-authored-by: gupnik <nikhilgupta.iitk@gmail.com>
This commit is contained in:
Liam Aharon
2024-02-28 18:32:02 +11:00
committed by GitHub
parent 7ec0b8741b
commit 12ce4f7d04
87 changed files with 1222 additions and 369 deletions
Download Patch File Download Diff File Expand all files Collapse all files
substrate/frame/society/src/migrations.rs
+27 -27
View File
@@ -40,11 +40,11 @@ impl<
{
#[cfg(feature = "try-runtime")]
fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError> {
let current = Pallet::<T, I>::current_storage_version();
let onchain = Pallet::<T, I>::on_chain_storage_version();
ensure!(onchain == 0 && current == 2, "pallet_society: invalid version");
let in_code = Pallet::<T, I>::in_code_storage_version();
let on_chain = Pallet::<T, I>::on_chain_storage_version();
ensure!(on_chain == 0 && in_code == 2, "pallet_society: invalid version");
Ok((old::Candidates::<T, I>::get(), old::Members::<T, I>::get()).encode())
Ok((v0::Candidates::<T, I>::get(), v0::Members::<T, I>::get()).encode())
}
fn on_runtime_upgrade() -> Weight {
@@ -103,7 +103,7 @@ pub type MigrateToV2<T, I, PastPayouts> = frame_support::migrations::VersionedMi
<T as frame_system::Config>::DbWeight,
>;
pub(crate) mod old {
pub(crate) mod v0 {
use super::*;
use frame_support::storage_alias;
@@ -230,37 +230,37 @@ pub fn assert_internal_consistency<T: Config<I>, I: Instance + 'static>() {
}
// We don't use these - make sure they don't exist.
assert_eq!(old::SuspendedCandidates::<T, I>::iter().count(), 0);
assert_eq!(old::Strikes::<T, I>::iter().count(), 0);
assert_eq!(old::Vouching::<T, I>::iter().count(), 0);
assert!(!old::Defender::<T, I>::exists());
assert!(!old::Members::<T, I>::exists());
assert_eq!(v0::SuspendedCandidates::<T, I>::iter().count(), 0);
assert_eq!(v0::Strikes::<T, I>::iter().count(), 0);
assert_eq!(v0::Vouching::<T, I>::iter().count(), 0);
assert!(!v0::Defender::<T, I>::exists());
assert!(!v0::Members::<T, I>::exists());
}
pub fn from_original<T: Config<I>, I: Instance + 'static>(
past_payouts: &mut [(<T as frame_system::Config>::AccountId, BalanceOf<T, I>)],
) -> Result<Weight, &'static str> {
// Migrate Bids from old::Bids (just a trunctation).
Bids::<T, I>::put(BoundedVec::<_, T::MaxBids>::truncate_from(old::Bids::<T, I>::take()));
Bids::<T, I>::put(BoundedVec::<_, T::MaxBids>::truncate_from(v0::Bids::<T, I>::take()));
// Initialise round counter.
RoundCount::<T, I>::put(0);
// Migrate Candidates from old::Candidates
for Bid { who: candidate, kind, value } in old::Candidates::<T, I>::take().into_iter() {
for Bid { who: candidate, kind, value } in v0::Candidates::<T, I>::take().into_iter() {
let mut tally = Tally::default();
// Migrate Votes from old::Votes
// No need to drain, since we're overwriting values.
for (voter, vote) in old::Votes::<T, I>::iter_prefix(&candidate) {
for (voter, vote) in v0::Votes::<T, I>::iter_prefix(&candidate) {
Votes::<T, I>::insert(
&candidate,
&voter,
Vote { approve: vote == old::Vote::Approve, weight: 1 },
Vote { approve: vote == v0::Vote::Approve, weight: 1 },
);
match vote {
old::Vote::Approve => tally.approvals.saturating_inc(),
old::Vote::Reject => tally.rejections.saturating_inc(),
old::Vote::Skeptic => Skeptic::<T, I>::put(&voter),
v0::Vote::Approve => tally.approvals.saturating_inc(),
v0::Vote::Reject => tally.rejections.saturating_inc(),
v0::Vote::Skeptic => Skeptic::<T, I>::put(&voter),
}
}
Candidates::<T, I>::insert(
@@ -271,9 +271,9 @@ pub fn from_original<T: Config<I>, I: Instance + 'static>(
// Migrate Members from old::Members old::Strikes old::Vouching
let mut member_count = 0;
for member in old::Members::<T, I>::take() {
let strikes = old::Strikes::<T, I>::take(&member);
let vouching = old::Vouching::<T, I>::take(&member);
for member in v0::Members::<T, I>::take() {
let strikes = v0::Strikes::<T, I>::take(&member);
let vouching = v0::Vouching::<T, I>::take(&member);
let record = MemberRecord { index: member_count, rank: 0, strikes, vouching };
Members::<T, I>::insert(&member, record);
MemberByIndex::<T, I>::insert(member_count, &member);
@@ -314,7 +314,7 @@ pub fn from_original<T: Config<I>, I: Instance + 'static>(
// Migrate Payouts from: old::Payouts and raw info (needed since we can't query old chain
// state).
past_payouts.sort();
for (who, mut payouts) in old::Payouts::<T, I>::iter() {
for (who, mut payouts) in v0::Payouts::<T, I>::iter() {
payouts.truncate(T::MaxPayouts::get() as usize);
// ^^ Safe since we already truncated.
let paid = past_payouts
@@ -329,19 +329,19 @@ pub fn from_original<T: Config<I>, I: Instance + 'static>(
}
// Migrate SuspendedMembers from old::SuspendedMembers old::Strikes old::Vouching.
for who in old::SuspendedMembers::<T, I>::iter_keys() {
let strikes = old::Strikes::<T, I>::take(&who);
let vouching = old::Vouching::<T, I>::take(&who);
for who in v0::SuspendedMembers::<T, I>::iter_keys() {
let strikes = v0::Strikes::<T, I>::take(&who);
let vouching = v0::Vouching::<T, I>::take(&who);
let record = MemberRecord { index: 0, rank: 0, strikes, vouching };
SuspendedMembers::<T, I>::insert(&who, record);
}
// Any suspended candidates remaining are rejected.
let _ = old::SuspendedCandidates::<T, I>::clear(u32::MAX, None);
let _ = v0::SuspendedCandidates::<T, I>::clear(u32::MAX, None);
// We give the current defender the benefit of the doubt.
old::Defender::<T, I>::kill();
let _ = old::DefenderVotes::<T, I>::clear(u32::MAX, None);
v0::Defender::<T, I>::kill();
let _ = v0::DefenderVotes::<T, I>::clear(u32::MAX, None);
Ok(T::BlockWeights::get().max_block)
}
substrate/frame/society/src/tests.rs
+22 -22
View File
@@ -18,7 +18,7 @@
//! Tests for the module.
use super::*;
use migrations::old;
use migrations::v0;
use mock::*;
use frame_support::{assert_noop, assert_ok};
@@ -32,41 +32,41 @@ use RuntimeOrigin as Origin;
#[test]
fn migration_works() {
EnvBuilder::new().founded(false).execute(|| {
use old::Vote::*;
use v0::Vote::*;
// Initialise the old storage items.
Founder::<Test>::put(10);
Head::<Test>::put(30);
old::Members::<Test, ()>::put(vec![10, 20, 30]);
old::Vouching::<Test, ()>::insert(30, Vouching);
old::Vouching::<Test, ()>::insert(40, Banned);
old::Strikes::<Test, ()>::insert(20, 1);
old::Strikes::<Test, ()>::insert(30, 2);
old::Strikes::<Test, ()>::insert(40, 5);
old::Payouts::<Test, ()>::insert(20, vec![(1, 1)]);
old::Payouts::<Test, ()>::insert(
v0::Members::<Test, ()>::put(vec![10, 20, 30]);
v0::Vouching::<Test, ()>::insert(30, Vouching);
v0::Vouching::<Test, ()>::insert(40, Banned);
v0::Strikes::<Test, ()>::insert(20, 1);
v0::Strikes::<Test, ()>::insert(30, 2);
v0::Strikes::<Test, ()>::insert(40, 5);
v0::Payouts::<Test, ()>::insert(20, vec![(1, 1)]);
v0::Payouts::<Test, ()>::insert(
30,
(0..=<Test as Config>::MaxPayouts::get())
.map(|i| (i as u64, i as u64))
.collect::<Vec<_>>(),
);
old::SuspendedMembers::<Test, ()>::insert(40, true);
v0::SuspendedMembers::<Test, ()>::insert(40, true);
old::Defender::<Test, ()>::put(20);
old::DefenderVotes::<Test, ()>::insert(10, Approve);
old::DefenderVotes::<Test, ()>::insert(20, Approve);
old::DefenderVotes::<Test, ()>::insert(30, Reject);
v0::Defender::<Test, ()>::put(20);
v0::DefenderVotes::<Test, ()>::insert(10, Approve);
v0::DefenderVotes::<Test, ()>::insert(20, Approve);
v0::DefenderVotes::<Test, ()>::insert(30, Reject);
old::SuspendedCandidates::<Test, ()>::insert(50, (10, Deposit(100)));
v0::SuspendedCandidates::<Test, ()>::insert(50, (10, Deposit(100)));
old::Candidates::<Test, ()>::put(vec![
v0::Candidates::<Test, ()>::put(vec![
Bid { who: 60, kind: Deposit(100), value: 200 },
Bid { who: 70, kind: Vouch(30, 30), value: 100 },
]);
old::Votes::<Test, ()>::insert(60, 10, Approve);
old::Votes::<Test, ()>::insert(70, 10, Reject);
old::Votes::<Test, ()>::insert(70, 20, Approve);
old::Votes::<Test, ()>::insert(70, 30, Approve);
v0::Votes::<Test, ()>::insert(60, 10, Approve);
v0::Votes::<Test, ()>::insert(70, 10, Reject);
v0::Votes::<Test, ()>::insert(70, 20, Approve);
v0::Votes::<Test, ()>::insert(70, 30, Approve);
let bids = (0..=<Test as Config>::MaxBids::get())
.map(|i| Bid {
@@ -75,7 +75,7 @@ fn migration_works() {
value: 10u64 + i as u64,
})
.collect::<Vec<_>>();
old::Bids::<Test, ()>::put(bids);
v0::Bids::<Test, ()>::put(bids);
migrations::from_original::<Test, ()>(&mut [][..]).expect("migration failed");
migrations::assert_internal_consistency::<Test, ()>();