mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-08 04:17:23 +00:00
Runtime Upgrade ref docs and Single Block Migration example pallet (#1554)
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:
@@ -555,6 +555,42 @@ pub fn __create_tt_macro(input: TokenStream) -> TokenStream {
|
||||
tt_macro::create_tt_return_macro(input)
|
||||
}
|
||||
|
||||
/// Allows accessing on-chain pallet storage that is no longer accessible via the pallet.
|
||||
///
|
||||
/// This is especially useful when writing storage migrations, when types of storage items are
|
||||
/// modified or outright removed, but the previous definition is required to perform the migration.
|
||||
///
|
||||
/// ## Example
|
||||
///
|
||||
/// Imagine a pallet with the following storage definition:
|
||||
/// ```ignore
|
||||
/// #[pallet::storage]
|
||||
/// pub type Value<T: Config> = StorageValue<_, u32>;
|
||||
/// ```
|
||||
/// `Value` can be accessed by calling `Value::<T>::get()`.
|
||||
///
|
||||
/// Now imagine the definition of `Value` is updated to a `(u32, u32)`:
|
||||
/// ```ignore
|
||||
/// #[pallet::storage]
|
||||
/// pub type Value<T: Config> = StorageValue<_, (u32, u32)>;
|
||||
/// ```
|
||||
/// The on-chain value of `Value` is `u32`, but `Value::<T>::get()` expects it to be `(u32, u32)`.
|
||||
///
|
||||
/// In this instance the developer must write a storage migration to reading the old value of
|
||||
/// `Value` and writing it back to storage in the new format, so that the on-chain storage layout is
|
||||
/// consistent with what is defined in the pallet.
|
||||
///
|
||||
/// We can read the old v0 value of `Value` in the migration by creating a `storage_alias`:
|
||||
/// ```ignore
|
||||
/// pub(crate) mod v0 {
|
||||
/// use super::*;
|
||||
///
|
||||
/// #[storage_alias]
|
||||
/// pub type Value<T: crate::Config> = StorageValue<crate::Pallet<T>, u32>;
|
||||
/// }
|
||||
/// ```
|
||||
///
|
||||
/// The developer can now access the old value of `Value` by calling `v0::Value::<T>::get()`.
|
||||
#[proc_macro_attribute]
|
||||
pub fn storage_alias(attributes: TokenStream, input: TokenStream) -> TokenStream {
|
||||
storage_alias::storage_alias(attributes.into(), input.into())
|
||||
@@ -1058,7 +1094,7 @@ pub fn generate_store(_: TokenStream, _: TokenStream) -> TokenStream {
|
||||
/// pub struct Pallet<T>(_);
|
||||
/// ```
|
||||
///
|
||||
/// If not present, the current storage version is set to the default value.
|
||||
/// If not present, the in-code storage version is set to the default value.
|
||||
#[proc_macro_attribute]
|
||||
pub fn storage_version(_: TokenStream, _: TokenStream) -> TokenStream {
|
||||
pallet_macro_stub()
|
||||
|
||||
Reference in New Issue
Block a user