mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 13:27:57 +00:00
12ce4f7d04
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>
91 lines
2.6 KiB
Rust
91 lines
2.6 KiB
Rust
// This file is part of Substrate.
|
|
|
|
// Copyright (C) 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.
|
|
|
|
pub mod v1 {
|
|
use crate::{types::BalanceOf, *};
|
|
use frame_support::{
|
|
storage::unhashed,
|
|
traits::{Defensive, Get, GetStorageVersion, OnRuntimeUpgrade},
|
|
weights::Weight,
|
|
};
|
|
use sp_staking::EraIndex;
|
|
use sp_std::prelude::*;
|
|
|
|
#[cfg(feature = "try-runtime")]
|
|
use frame_support::ensure;
|
|
#[cfg(feature = "try-runtime")]
|
|
use sp_runtime::TryRuntimeError;
|
|
|
|
pub struct MigrateToV1<T>(sp_std::marker::PhantomData<T>);
|
|
impl<T: Config> OnRuntimeUpgrade for MigrateToV1<T> {
|
|
fn on_runtime_upgrade() -> Weight {
|
|
let current = Pallet::<T>::in_code_storage_version();
|
|
let onchain = Pallet::<T>::on_chain_storage_version();
|
|
|
|
log!(
|
|
info,
|
|
"Running migration with in-code storage version {:?} / onchain {:?}",
|
|
current,
|
|
onchain
|
|
);
|
|
|
|
if current == 1 && onchain == 0 {
|
|
// update the version nonetheless.
|
|
current.put::<Pallet<T>>();
|
|
|
|
// if a head exists, then we put them back into the queue.
|
|
if Head::<T>::exists() {
|
|
if let Some((stash, _, deposit)) =
|
|
unhashed::take::<(T::AccountId, Vec<EraIndex>, BalanceOf<T>)>(
|
|
&Head::<T>::hashed_key(),
|
|
)
|
|
.defensive()
|
|
{
|
|
Queue::<T>::insert(stash, deposit);
|
|
} else {
|
|
// not much we can do here -- head is already deleted.
|
|
}
|
|
T::DbWeight::get().reads_writes(2, 3)
|
|
} else {
|
|
T::DbWeight::get().reads(2)
|
|
}
|
|
} else {
|
|
log!(info, "Migration did not execute. This probably should be removed");
|
|
T::DbWeight::get().reads(1)
|
|
}
|
|
}
|
|
|
|
#[cfg(feature = "try-runtime")]
|
|
fn pre_upgrade() -> Result<Vec<u8>, TryRuntimeError> {
|
|
ensure!(
|
|
Pallet::<T>::on_chain_storage_version() == 0,
|
|
"The onchain storage version must be zero for the migration to execute."
|
|
);
|
|
Ok(Default::default())
|
|
}
|
|
|
|
#[cfg(feature = "try-runtime")]
|
|
fn post_upgrade(_: Vec<u8>) -> Result<(), TryRuntimeError> {
|
|
ensure!(
|
|
Pallet::<T>::on_chain_storage_version() == 1,
|
|
"The onchain version must be updated after the migration."
|
|
);
|
|
Ok(())
|
|
}
|
|
}
|
|
}
|