mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-26 12:17:58 +00:00
Liam Aharon
41257069b0
Closes https://github.com/paritytech/polkadot-sdk-docs/issues/70 WIP PR for an overview of how to develop tokens in FRAME. - [x] Tokens in Substrate Ref Doc - High-level overview of the token-related logic in FRAME - Improve docs with better explanation of how holds, freezes, ed, free balance, etc, all work - [x] Update `pallet_balances` docs - Clearly mark what is deprecated (currency) - [x] Write fungible trait docs - [x] Evaluate and if required update `pallet_assets`, `pallet_uniques`, `pallet_nfts` docs - [x] Absorb https://github.com/paritytech/polkadot-sdk/pull/2683/ - [x] Audit individual trait method docs, and improve if possible Feel free to suggest additional TODOs for this PR in the comments --------- Co-authored-by: Bill Laboon <laboon@users.noreply.github.com> Co-authored-by: Francisco Aguirre <franciscoaguirreperez@gmail.com> Co-authored-by: Kian Paimani <5588131+kianenigma@users.noreply.github.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com>
109 lines
4.5 KiB
Rust
109 lines
4.5 KiB
Rust
//! # Polkadot SDK Reference Docs.
|
|
//!
|
|
//! This is the entry point for all reference documents that enhance one's learning experience in
|
|
//! the Polkadot SDK.
|
|
//!
|
|
//! Note that this module also contains the [glossary](crate::reference_docs::glossary).
|
|
//!
|
|
//! ## What is a "reference document"?
|
|
//!
|
|
//! First, see [why we use rust-docs for everything](crate#why-rust-docs) and our documentation
|
|
//! [principles](crate#principles). We acknowledge that as much of the crucial information should be
|
|
//! embedded in the low level rust-docs. Then, high level scenarios should be covered in
|
|
//! [`crate::guides`]. Finally, we acknowledge that there is a category of information that is:
|
|
//!
|
|
//! 1. crucial to know.
|
|
//! 2. is too high level to be in the rust-doc of any one `type`, `trait` or `fn`.
|
|
//! 3. is too low level to be encompassed in a [`crate::guides`].
|
|
//!
|
|
//! We call this class of documents "reference documents". Our goal should be to minimize the number
|
|
//! of "reference" docs, as they incur maintenance burden.
|
|
|
|
/// Learn how Substrate and FRAME use traits and associated types to make modules generic in a
|
|
/// type-safe manner.
|
|
pub mod trait_based_programming;
|
|
|
|
/// Learn about the way Substrate and FRAME view their blockchains as state machines.
|
|
pub mod blockchain_state_machines;
|
|
|
|
/// The glossary.
|
|
pub mod glossary;
|
|
|
|
/// Learn about the WASM meta-protocol of all Substrate-based chains.
|
|
pub mod wasm_meta_protocol;
|
|
|
|
/// Learn about the differences between smart contracts and a FRAME-based runtime. They are both
|
|
/// "code stored onchain", but how do they differ?
|
|
pub mod runtime_vs_smart_contract;
|
|
|
|
/// Learn about how extrinsics are encoded to be transmitted to a node and stored in blocks.
|
|
pub mod extrinsic_encoding;
|
|
|
|
/// Learn about the signed extensions that form a part of extrinsics.
|
|
// TODO: @jsdw https://github.com/paritytech/polkadot-sdk-docs/issues/42
|
|
pub mod signed_extensions;
|
|
|
|
/// Learn about *Origins*, a topic in FRAME that enables complex account abstractions to be built.
|
|
pub mod frame_origin;
|
|
|
|
/// Learn about how to write safe and defensive code in your FRAME runtime.
|
|
pub mod defensive_programming;
|
|
|
|
/// Learn about composite enums and other runtime level types, such as "RuntimeEvent" and
|
|
/// "RuntimeCall".
|
|
pub mod frame_runtime_types;
|
|
|
|
/// Learn about how to make a pallet/runtime that is fee-less and instead uses another mechanism to
|
|
/// control usage and sybil attacks.
|
|
pub mod fee_less_runtime;
|
|
|
|
/// Learn about metadata, the main means through which an upgradeable runtime communicates its
|
|
/// properties to the outside world.
|
|
// TODO: @jsdw https://github.com/paritytech/polkadot-sdk-docs/issues/47
|
|
pub mod metadata;
|
|
|
|
/// Learn about how frame-system handles `account-ids`, nonces, consumers and providers.
|
|
pub mod frame_system_accounts;
|
|
|
|
/// Advice for configuring your development environment for Substrate development.
|
|
pub mod development_environment_advice;
|
|
|
|
/// Learn about benchmarking and weight.
|
|
// TODO: @shawntabrizi @ggwpez https://github.com/paritytech/polkadot-sdk-docs/issues/50
|
|
pub mod frame_benchmarking_weight;
|
|
|
|
/// Learn about the token-related logic in FRAME and how to apply it to your use case.
|
|
pub mod frame_tokens;
|
|
|
|
/// Learn about chain specification file and the genesis state of the blockchain.
|
|
// TODO: @michalkucharczyk https://github.com/paritytech/polkadot-sdk-docs/issues/51
|
|
pub mod chain_spec_genesis;
|
|
|
|
/// Learn about all the memory limitations of the WASM runtime when it comes to memory usage.
|
|
// TODO: @kianenigma https://github.com/paritytech/polkadot-sdk-docs/issues/52
|
|
pub mod wasm_memory;
|
|
|
|
/// Learn about Substrate's CLI, and how it can be extended.
|
|
// TODO: @kianenigma https://github.com/paritytech/polkadot-sdk-docs/issues/53
|
|
pub mod cli;
|
|
|
|
/// Learn about Substrate's consensus algorithms, and how you can switch between two.
|
|
// TODO: @JoshOrndorff @kianenigma https://github.com/paritytech/polkadot-sdk-docs/issues/54
|
|
pub mod consensus_swapping;
|
|
|
|
/// Learn about Runtime Upgrades and best practices for writing Migrations.
|
|
pub mod frame_runtime_upgrades_and_migrations;
|
|
|
|
/// Learn about light nodes, how they function, and how Substrate-based chains come
|
|
/// light-node-first out of the box.
|
|
// TODO: @jsdw @josepot https://github.com/paritytech/polkadot-sdk-docs/issues/68
|
|
pub mod light_nodes;
|
|
|
|
/// Learn about the offchain workers, how they function, and how to use them, as provided by the
|
|
/// [`frame`] APIs.
|
|
pub mod frame_offchain_workers;
|
|
|
|
/// Learn about the different ways through which multiple [`frame`] pallets can be combined to work
|
|
/// together.
|
|
pub mod frame_pallet_coupling;
|