Skip to content
Snippets Groups Projects
Unverified Commit e5b2adac authored by Liam Aharon's avatar Liam Aharon Committed by GitHub
Browse files

`chain-spec-builder`: Improve output path example (#2693)


Example currently broken. 

It writes something to the given path, but not the full chain spec.

---------

Co-authored-by: default avatarMichal Kucharczyk <1728078+michalkucharczyk@users.noreply.github.com>
parent ffb2125f
Branches
No related merge requests found
Pipeline #426705 passed with stages
in 52 minutes and 34 seconds
...@@ -30,46 +30,52 @@ ...@@ -30,46 +30,52 @@
//! ## Typical use-cases. //! ## Typical use-cases.
//! ##### Get default config from runtime. //! ##### Get default config from runtime.
//! //!
//! Query the default genesis config from the provided `runtime.wasm` and use it in the chain //! Query the default genesis config from the provided `runtime.wasm` and use it in the chain
//! spec. Tool can also store runtime's default genesis config in given file: //! spec. The tool allows specifying where to write the chain spec, and optionally also where the
//! ```text //! write the default genesis state config (which is `/dev/stdout` in the following example):
//! chain-spec-builder create -r runtime.wasm default /dev/stdout //! ```text
//! chain-spec-builder --chain_spec_path ./my_chain_spec.json create -r runtime.wasm default /dev/stdout
//! ``` //! ```
//! //!
//! _Note:_ [`GenesisBuilder::create_default_config`][sp-genesis-builder-create] runtime function is called. //! _Note:_ [`GenesisBuilder::create_default_config`][sp-genesis-builder-create] runtime function is
//! called.
//! //!
//! //!
//! ##### Generate raw storage chain spec using genesis config patch. //! ##### Generate raw storage chain spec using genesis config patch.
//! //!
//! Patch the runtime's default genesis config with provided `patch.json` and generate raw //! Patch the runtime's default genesis config with provided `patch.json` and generate raw
//! storage (`-s`) version of chain spec: //! storage (`-s`) version of chain spec:
//! ```text //!
//! ```bash
//! chain-spec-builder create -s -r runtime.wasm patch patch.json //! chain-spec-builder create -s -r runtime.wasm patch patch.json
//! ``` //! ```
//! //!
//! _Note:_ [`GenesisBuilder::build_config`][sp-genesis-builder-build] runtime function is called. //! _Note:_ [`GenesisBuilder::build_config`][sp-genesis-builder-build] runtime function is called.
//! //!
//! ##### Generate raw storage chain spec using full genesis config. //! ##### Generate raw storage chain spec using full genesis config.
//! //!
//! Build the chain spec using provided full genesis config json file. No defaults will be used: //! Build the chain spec using provided full genesis config json file. No defaults will be used:
//! ```text //!
//! ```bash
//! chain-spec-builder create -s -r runtime.wasm full full-genesis-config.json //! chain-spec-builder create -s -r runtime.wasm full full-genesis-config.json
//! ``` //! ```
//! //!
//! _Note_: [`GenesisBuilder::build_config`][sp-genesis-builder-build] runtime function is called. //! _Note_: [`GenesisBuilder::build_config`][sp-genesis-builder-build] runtime function is called.
//! //!
//! ##### Generate human readable chain spec using provided genesis config patch. //! ##### Generate human readable chain spec using provided genesis config patch.
//! ```text //! ```bash
//! chain-spec-builder create -r runtime.wasm patch patch.json //! chain-spec-builder create -r runtime.wasm patch patch.json
//! ``` //! ```
//! //!
//! ##### Generate human readable chain spec using provided full genesis config. //! ##### Generate human readable chain spec using provided full genesis config.
//! ```text //!
//! ```bash
//! chain-spec-builder create -r runtime.wasm full full-genesis-config.json //! chain-spec-builder create -r runtime.wasm full full-genesis-config.json
//! ``` //! ```
//! //!
//! ##### Extra tools. //! ##### Extra tools.
//! The `chain-spec-builder` provides also some extra utilities: [`VerifyCmd`], [`ConvertToRawCmd`], [`UpdateCodeCmd`]. //! The `chain-spec-builder` provides also some extra utilities: [`VerifyCmd`], [`ConvertToRawCmd`],
//! [`UpdateCodeCmd`].
//! //!
//! [`sc-chain-spec`]: ../sc_chain_spec/index.html //! [`sc-chain-spec`]: ../sc_chain_spec/index.html
//! [`node-cli`]: ../node_cli/index.html //! [`node-cli`]: ../node_cli/index.html
......
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment