mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-28 17:57:56 +00:00
Kian Paimani
eaf1bc5633
This PR introduces the new crate `developer_hub` into the polkadot-sdk repo. The vision for the developer-hub crate is detailed in [this document](https://docs.google.com/document/d/1XLLkFNE8v8HLvZpI2rzsa8N2IN1FcKntc8q-Sc4xBAk/edit?usp=sharing). <img width="1128" alt="Screenshot 2023-11-02 at 10 45 48" src="https://github.com/paritytech/polkadot-sdk/assets/5588131/1e12b60f-fef5-42c4-8503-a3ba234077c3"> Other than adding the new crate, it also does the following: * Remove the `substrate` crate, as there is now a unique umbrella crate for multiple things in `developer_hub::polkadot_sdk`. * (backport candidate) A minor change to `frame-support` macros that allows `T::RuntimeOrigin` to also be acceptable as the origin type. * (backport candidate) A minor change to `frame-system` that allows us to deposit events at genesis because now the real genesis config is generated via wasm, and we can safely assume `cfg!(feature = "std")` means only testing. related to #62. * (backport candidate) Introduces a small `read_events_for_pallet` to `frame_system` for easier event reading in tests. * From https://github.com/paritytech/polkadot-sdk-docs/issues/31, it takes action on improving the `pallet::call` docs. * From https://github.com/paritytech/polkadot-sdk-docs/issues/31, it takes action on improving the `UncheckedExtrinsic` docs. ## Way Forward First, a version of this is deployed temporarily [here](https://blog.kianenigma.nl/polkadot-sdk/developer_hub/index.html). I will keep it up to date on a daily basis. ### This Pull Request I see two ways forward: 1. We acknowledge that everything in `developer-hub` is going to be WIP, and merge this asap. We should not yet use links to this crate anywhere. 2. We make this be the feature branch, make PRs against this, and either gradually backport it, or only merge to master once it is done. I am personally in favor of option 1. If we stick to option 2, we need a better way to deploy a staging version of this to gh-pages. ### Issue Tracking The main issues related to the future of `developer_hub` are: - https://github.com/paritytech/polkadot-sdk-docs/issues/31 - https://github.com/paritytech/polkadot-sdk-docs/issues/4 - https://github.com/paritytech/polkadot-sdk-docs/issues/26 - https://github.com/paritytech/polkadot-sdk-docs/issues/32 - https://github.com/paritytech/polkadot-sdk-docs/issues/36 ### After This Pull Request - [ ] create a redirect for https://paritytech.github.io/polkadot-sdk/master/substrate/ - [x] analytics - [ ] link checker - [ ] the matter of publishing, and how all of these relative links for when we do, that is still an open question. There is section on this in the landing page. - [ ] updated https://paritytech.github.io/ --------- Co-authored-by: Liam Aharon <liam.aharon@hotmail.com> Co-authored-by: Juan Girini <juangirini@gmail.com> Co-authored-by: bader y <ibnbassem@gmail.com> Co-authored-by: Sebastian Kunert <skunert49@gmail.com> Co-authored-by: James Wilson <james@jsdw.me> Co-authored-by: Michal Kucharczyk <1728078+michalkucharczyk@users.noreply.github.com>
100 lines
4.3 KiB
Rust
100 lines
4.3 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 *"Origin"* A topic in FRAME that enables complex account abstractions to be built.
|
|
// TODO: @shawntabrizi https://github.com/paritytech/polkadot-sdk-docs/issues/43
|
|
pub mod frame_origin;
|
|
|
|
/// Learn about how to write safe and defensive code in your FRAME runtime.
|
|
// TODO: @CrackTheCode016 https://github.com/paritytech/polkadot-sdk-docs/issues/44
|
|
pub mod safe_defensive_programming;
|
|
|
|
/// Learn about composite enums in FRAME-based runtimes, such as "RuntimeEvent" and "RuntimeCall".
|
|
pub mod frame_composite_enums;
|
|
|
|
/// 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;
|
|
|
|
/// Learn about the currency-related abstractions provided in FRAME.
|
|
pub mod frame_currency;
|
|
|
|
/// Learn about benchmarking and weight.
|
|
// TODO: @shawntabrizi @ggwpez https://github.com/paritytech/polkadot-sdk-docs/issues/50
|
|
pub mod frame_benchmarking_weight;
|
|
|
|
/// 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 all the advance ways to test your coordinate a rutnime upgrade and data migration.
|
|
// TODO: @liamaharon https://github.com/paritytech/polkadot-sdk-docs/issues/55
|
|
pub mod frame_runtime_migration;
|
|
|
|
/// 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;
|