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>
parent
7ec0b874
Showing
- Cargo.lock 26 additions, 0 deletionsCargo.lock
- Cargo.toml 1 addition, 0 deletionsCargo.toml
- cumulus/pallets/collator-selection/src/lib.rs 1 addition, 1 deletioncumulus/pallets/collator-selection/src/lib.rs
- cumulus/pallets/collator-selection/src/migration.rs 5 additions, 5 deletionscumulus/pallets/collator-selection/src/migration.rs
- cumulus/pallets/parachain-system/src/migration.rs 1 addition, 1 deletioncumulus/pallets/parachain-system/src/migration.rs
- cumulus/pallets/xcmp-queue/src/migration.rs 1 addition, 1 deletioncumulus/pallets/xcmp-queue/src/migration.rs
- cumulus/parachains/pallets/collective-content/src/lib.rs 1 addition, 1 deletioncumulus/parachains/pallets/collective-content/src/lib.rs
- cumulus/parachains/runtimes/assets/asset-hub-rococo/src/lib.rs 7 additions, 7 deletions...us/parachains/runtimes/assets/asset-hub-rococo/src/lib.rs
- cumulus/parachains/runtimes/assets/asset-hub-westend/src/lib.rs 3 additions, 3 deletions...s/parachains/runtimes/assets/asset-hub-westend/src/lib.rs
- cumulus/parachains/runtimes/bridge-hubs/bridge-hub-rococo/src/lib.rs 2 additions, 2 deletions...achains/runtimes/bridge-hubs/bridge-hub-rococo/src/lib.rs
- cumulus/parachains/runtimes/bridge-hubs/bridge-hub-westend/src/lib.rs 2 additions, 2 deletions...chains/runtimes/bridge-hubs/bridge-hub-westend/src/lib.rs
- docs/sdk/Cargo.toml 6 additions, 1 deletiondocs/sdk/Cargo.toml
- docs/sdk/src/reference_docs/frame_runtime_migration.rs 0 additions, 9 deletionsdocs/sdk/src/reference_docs/frame_runtime_migration.rs
- docs/sdk/src/reference_docs/frame_runtime_upgrades_and_migrations.rs 138 additions, 0 deletions...c/reference_docs/frame_runtime_upgrades_and_migrations.rs
- docs/sdk/src/reference_docs/mod.rs 2 additions, 3 deletionsdocs/sdk/src/reference_docs/mod.rs
- polkadot/node/service/src/parachains_db/upgrade.rs 1 addition, 1 deletionpolkadot/node/service/src/parachains_db/upgrade.rs
- polkadot/runtime/common/src/assigned_slots/migration.rs 6 additions, 6 deletionspolkadot/runtime/common/src/assigned_slots/migration.rs
- polkadot/runtime/common/src/assigned_slots/mod.rs 1 addition, 1 deletionpolkadot/runtime/common/src/assigned_slots/mod.rs
- polkadot/runtime/common/src/crowdloan/migration.rs 2 additions, 2 deletionspolkadot/runtime/common/src/crowdloan/migration.rs
- polkadot/runtime/common/src/crowdloan/mod.rs 1 addition, 1 deletionpolkadot/runtime/common/src/crowdloan/mod.rs
Please register or sign in to comment