From 249b8136ad19addd97e73e01f426e990d543718a Mon Sep 17 00:00:00 2001 From: Michal Kucharczyk <1728078+michalkucharczyk@users.noreply.github.com> Date: Thu, 14 Dec 2023 17:22:34 +0100 Subject: [PATCH] sp-genesis-builder: some doc added --- substrate/primitives/genesis-builder/src/lib.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/substrate/primitives/genesis-builder/src/lib.rs b/substrate/primitives/genesis-builder/src/lib.rs index ce77786d752a..85ad81458e55 100644 --- a/substrate/primitives/genesis-builder/src/lib.rs +++ b/substrate/primitives/genesis-builder/src/lib.rs @@ -19,6 +19,11 @@ //! Substrate genesis config builder //! +//! The runtime may provide a number of partial `GenesisConfig` configurations in form of patches +//! which shall be applied on top of the default GenesisConfig. This presets are sometimes refered +//! to as patches. This allows the runtime to provide a number of predefined configuration (e.g. for +//! different testnets) without leaking the runtime types outside the runtime. +//! //! This Runtime API allows to construct `GenesisConfig`, in particular: //! - serialize the runtime default `GenesisConfig` struct into json format, //! - put the GenesisConfig struct into the storage. Internally this operation calls