mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-07 15:28:02 +00:00
Liam Aharon
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>
52 lines
2.1 KiB
Rust
52 lines
2.1 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.
|
|
|
|
//! # FRAME Pallet Examples
|
|
//!
|
|
//! This crate contains a collection of simple examples of FRAME pallets, demonstrating useful
|
|
//! features in action. It is not intended to be used in production.
|
|
//!
|
|
//! ## Pallets
|
|
//!
|
|
//! - [`pallet_example_basic`]: This pallet demonstrates concepts, APIs and structures common to
|
|
//! most FRAME runtimes.
|
|
//!
|
|
//! - [`pallet_example_offchain_worker`]: This pallet demonstrates concepts, APIs and structures
|
|
//! common to most offchain workers.
|
|
//!
|
|
//! - [`pallet_default_config_example`]: This pallet demonstrates different ways to implement the
|
|
//! `Config` trait of pallets.
|
|
//!
|
|
//! - [`pallet_dev_mode`]: This pallet demonstrates the ease of requirements for a pallet in "dev
|
|
//! mode".
|
|
//!
|
|
//! - [`pallet_example_kitchensink`]: This pallet demonstrates a catalog of all FRAME macros in use
|
|
//! and their various syntax options.
|
|
//!
|
|
//! - [`pallet_example_split`]: A simple example of a FRAME pallet demonstrating the ability to
|
|
//! split sections across multiple files.
|
|
//!
|
|
//! - [`pallet_example_frame_crate`]: Example pallet showcasing how one can be
|
|
//! built using only the `frame` umbrella crate.
|
|
//!
|
|
//! - [`pallet_example_single_block_migrations`]: An example pallet demonstrating best-practices for
|
|
//! writing storage migrations.
|
|
//!
|
|
//! - [`pallet_example_tasks`]: This pallet demonstrates the use of `Tasks` to execute service work.
|
|
//!
|
|
//! **Tip**: Use `cargo doc --package <pallet-name> --open` to view each pallet's documentation.
|