Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chain-spec-builder: info about patch/full files added #6373

Merged
merged 8 commits into from
Nov 5, 2024
Merged

chain-spec-builder: info about patch/full files added #6373

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
cb033f7
chain-spec-builder: info about patch/full files added
michalkucharczyk Nov 5, 2024
80dee6f
Update from michalkucharczyk running command 'prdoc'
actions-user Nov 5, 2024
9b35da3
Update from michalkucharczyk running command 'prdoc --force --bump p…
actions-user Nov 5, 2024
a159922
Update prdoc/pr_6373.prdoc
michalkucharczyk Nov 5, 2024
3d5e932
Apply suggestions from code review
michalkucharczyk Nov 5, 2024
0906373
README.md re-generated
michalkucharczyk Nov 5, 2024
59cd273
make markdownlint happy
michalkucharczyk Nov 5, 2024
c6a17e4
fix: cargo test --doc
michalkucharczyk Nov 5, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions prdoc/pr_6373.prdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
title: '`chain-spec-builder`: info about patch/full files added'
doc:
- audience: Runtime User
description: There was no good example of what is patch and full genesis config
file. Some explanation and example were to the `chain-spec-builder` doc.
michalkucharczyk marked this conversation as resolved.
Show resolved Hide resolved
crates:
- name: staging-chain-spec-builder
bump: patch
44 changes: 44 additions & 0 deletions substrate/bin/utils/chain-spec-builder/README.docify.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,8 @@ storage (`-s`) version of chain spec:

<!-- docify::embed!("tests/test.rs", cmd_create_with_patch_raw)-->

Refer to [*patch file*](#patch-file) for some details on the patch file format.

_Note:_ [`GenesisBuilder::get_preset`](https://docs.rs/sp-genesis-builder/latest/sp_genesis_builder/trait.GenesisBuilder.html#method.get_preset)
and
[`GenesisBuilder::build_state`](https://docs.rs/sp-genesis-builder/latest/sp_genesis_builder/trait.GenesisBuilder.html#method.build_state)
Expand All @@ -84,17 +86,59 @@ Build the chain spec using provided full genesis config json file. No defaults w

<!-- docify::embed!("tests/test.rs", cmd_create_full_raw)-->

Refer to [*full config file*](#full-genesis-config-files) for some details on the full file format.
michalkucharczyk marked this conversation as resolved.
Show resolved Hide resolved

_Note_: [`GenesisBuilder::build_state`](https://docs.rs/sp-genesis-builder/latest/sp_genesis_builder/trait.GenesisBuilder.html#method.build_state)
runtime function is called.

### Generate human readable chain spec using provided genesis config patch

<!-- docify::embed!("tests/test.rs", cmd_create_with_patch_plain)-->

Refer to [*patch file*](#patch-file) for some details on the patch file format.

### Generate human readable chain spec using provided full genesis config

<!-- docify::embed!("tests/test.rs", cmd_create_full_plain)-->

Refer to [*full config file*](#full-genesis-config-file) for some details on the full file format.


## Patch and full genesis config files
This section provides details on the files that cane be used with `create patch` or `create full` subcommands.
michalkucharczyk marked this conversation as resolved.
Show resolved Hide resolved

### Patch file
The patch file for genesis config contains the key-value pairs valid for given runtime, that needs to be customized,
e.g:
```
{
"balances": {
"balances": [
[
"5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty",
1000000000000000
],
[
"5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y",
1000000000000000
],
[
"5CcjiSgG2KLuKAsqkE2Nak1S2FbAcMr5SxRASUuwR3zSNV2b",
5000000000000000
]
]
},
"sudo": {
"key": "5Ff3iXP75ruzroPWRP2FYBHWnmGGBSb63857BgnzCoXNxfPo"
}
}
```
The rest of genesis config keys will be initialized with default values.

### Full genesis config file.
The full genesis config file shall contain values for *all* the keys present in the genesis config for given runtime. The format of the file is
michalkucharczyk marked this conversation as resolved.
Show resolved Hide resolved
similar to patch format. Example is not provided here as it heavily depends on the runtime.

### Extra tools

The `chain-spec-builder` provides also some extra utilities: [`VerifyCmd`](https://docs.rs/staging-chain-spec-builder/latest/staging_chain_spec_builder/struct.VerifyCmd.html),
Expand Down
44 changes: 44 additions & 0 deletions substrate/bin/utils/chain-spec-builder/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,8 @@ bash!(
)
```

Refer to [*patch file*](#patch-file) for some details on the patch file format.

_Note:_ [`GenesisBuilder::get_preset`](https://docs.rs/sp-genesis-builder/latest/sp_genesis_builder/trait.GenesisBuilder.html#method.get_preset)
and
[`GenesisBuilder::build_state`](https://docs.rs/sp-genesis-builder/latest/sp_genesis_builder/trait.GenesisBuilder.html#method.build_state)
Expand All @@ -114,6 +116,8 @@ bash!(
)
```

Refer to [*full config file*](#full-genesis-config-files) for some details on the full file format.

_Note_: [`GenesisBuilder::build_state`](https://docs.rs/sp-genesis-builder/latest/sp_genesis_builder/trait.GenesisBuilder.html#method.build_state)
runtime function is called.

Expand All @@ -125,6 +129,8 @@ bash!(
)
```

Refer to [*patch file*](#patch-file) for some details on the patch file format.

### Generate human readable chain spec using provided full genesis config

```rust,ignore
Expand All @@ -133,6 +139,44 @@ bash!(
)
```

Refer to [*full config file*](#full-genesis-config-file) for some details on the full file format.


## Patch and full genesis config files
This section provides details on the files that cane be used with `create patch` or `create full` subcommands.

### Patch file
The patch file for genesis config contains the key-value pairs valid for given runtime, that needs to be customized,
e.g:
```
{
"balances": {
"balances": [
[
"5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty",
1000000000000000
],
[
"5FLSigC9HGRKVhB9FiEo4Y3koPsNmBmLJbpXg2mp1hXcS59Y",
1000000000000000
],
[
"5CcjiSgG2KLuKAsqkE2Nak1S2FbAcMr5SxRASUuwR3zSNV2b",
5000000000000000
]
]
},
"sudo": {
"key": "5Ff3iXP75ruzroPWRP2FYBHWnmGGBSb63857BgnzCoXNxfPo"
}
}
```
The rest of genesis config keys will be initialized with default values.

### Full genesis config file.
The full genesis config file shall contain values for *all* the keys present in the genesis config for given runtime. The format of the file is
similar to patch format. Example is not provided here as it heavily depends on the runtime.

### Extra tools

The `chain-spec-builder` provides also some extra utilities: [`VerifyCmd`](https://docs.rs/staging-chain-spec-builder/latest/staging_chain_spec_builder/struct.VerifyCmd.html),
Expand Down