Polkadot OmniNode Docs #6094

kianenigma · 2024-10-16T14:03:06Z

provides low-level documentation on how the omni-node is meant to work. This is meant to act as reusable material for other teams (e.g. Papermoon and W3F) to use and integrate into the high level Polkadot documentation.

Broadly speaking, for omni-node to have great rust-docs, we need to focus on the following crates, all of which got a bit of love in this PR:

sp-genesis-builder
polkadot-omni-node
polkadot-omni-node-lib
frame-omni-bencher

On top of this, we have now:

polkadot_sdk_docs::guides contains two new steps demonstrating the most basic version of composing your pallet, putting it into a runtime, and putting that runtime into omni-node
polkadot_sdk_docs::reference_docs::omni_node to explain in more detail how omni-node differs from the old-school node.
polkadot_sdk_docs::reference_docs::frame_weight_benchmarking to finally have a minimal reference about weights and benchmarking.
It provides tests for some of the steps in polkadot-omni-node Meta: Tutorials and reference docs. #5568

closes #5568
closes #4781

Next steps

Ensure the README of the parachain template is up-to-date. @iulianbarbu
Readme for polkadot-omni-node and similar is updated. For now, use cargo-readme and copy over the rust-docs.

To build the branch locally and run this: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/meta_contributing/index.html#how-to-develop-locally

cumulus/polkadot-omni-node/lib/src/nodes/manual_seal.rs

docs/sdk/src/reference_docs/omni_node.rs

docs/sdk/src/reference_docs/umbrella_crate.rs

substrate/primitives/genesis-builder/src/lib.rs

serban300 · 2024-10-18T14:57:45Z

templates/parachain/runtime/src/genesis_config_presets.rs

@@ -76,6 +76,8 @@ fn local_testnet_genesis() -> Value {
 		],
 		Sr25519Keyring::well_known().map(|k| k.to_account_id()).collect(),
 		Sr25519Keyring::Alice.to_account_id(),
+    // TODO: this is super opaque, how should one know they should configure this? add to


Should we mention it in an issue to avoid forgetting about it ?

Yeah, @iulianbarbu I believe this is something that should be covered in the parachain template docs/README, can you note it please?

michalkucharczyk

Left some nits. Will do one more round.

cumulus/polkadot-omni-node/lib/src/lib.rs

substrate/primitives/genesis-builder/src/lib.rs

docs/sdk/src/reference_docs/omni_node.rs

iulianbarbu · 2024-10-21T20:27:12Z

templates/parachain/runtime/src/genesis_config_presets.rs

@@ -76,6 +76,8 @@ fn local_testnet_genesis() -> Value {
 		],
 		Sr25519Keyring::well_known().map(|k| k.to_account_id()).collect(),
 		Sr25519Keyring::Alice.to_account_id(),
+    // TODO: this is super opaque, how should one know they should configure this? add to


docs/sdk/src/guides/your_first_node.rs

iulianbarbu · 2024-10-22T10:30:32Z

docs/sdk/src/guides/your_first_node.rs

+//! 	--para-id 42 \
+//! 	--relay-chain dontcare \


Haven't seen these flags in the latest chain-spec-builer version (e.g. chain-spec-builder create help). I think it would be great to add these flags in a follow-up (so creating an issue to track it would be great). By then, my approach in the templates docs was to add the flags "manually" post chain_spec.json generation with (not the greatest UX for now but we can iterate later):

jq '. + {"relay_chain": "rococo-local", "para_id": 1000 }' <path/to/chain_spec.json> > tmp.json && mv tmp.json <path/to/chain_spec.json>

Are you using the latest version of the chain-spec-builer

Quite possibly, it is because the PR with the change that added this flag is not released yet.

In general, we can either merge this PR speculatively, or freeze it until the first RC is out.

@ggwpez @EgorPopelyaev at which stage in the new release process do we publish the binaries to crates.io?

Quite possibly, it is because the PR with the change that added this flag is not released yet.

Indeed. Leaving this unresolved to clarify how the publishing of the binaries happen.

docs/sdk/src/guides/your_first_node.rs

docs/sdk/src/guides/your_first_runtime.rs

docs/sdk/src/reference_docs/omni_node.rs

templates/parachain/runtime/src/genesis_config_presets.rs

Co-authored-by: Iulian Barbu <[email protected]>

docs/sdk/src/guides/your_first_node.rs

…dk into kiz-omni-node-docs

Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

docs/sdk/src/reference_docs/omni_node.rs

substrate/bin/node/cli/src/service.rs

Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

…dk into kiz-omni-node-docs

kianenigma · 2024-10-23T13:03:30Z

@kianenigma: random thoughts: we have this substrate binary section out there, I have a feeling that it would be good to put the link to omni-node there. Techincally it is not a substrate product - but IMO still worth linking there. And we could also put a link in cumulus overview. wdyt?

This is a great suggestion! I will actually reword this at the top level now, under polkadot-sdk

Co-authored-by: Sebastian Kunert <[email protected]>

…dk into kiz-omni-node-docs

…omni-node-docs

@iulianbarbu

provides low-level documentation on how the omni-node is meant to work. This is meant to act as reusable material for other teams (e.g. Papermoon and W3F) to use and integrate into the high level Polkadot documentation. Broadly speaking, for omni-node to have great rust-docs, we need to focus on the following crates, all of which got a bit of love in this PR: 1. `sp-genesis-builder` 2. `polkadot-omni-node` 3. `polkadot-omni-node-lib` 4. `frame-omni-bencher` On top of this, we have now: * `polkadot_sdk_docs::guides` contains two new steps demonstrating the most basic version of composing your pallet, putting it into a runtime, and putting that runtime into omni-node * `polkadot_sdk_docs::reference_docs::omni_node` to explain in more detail how omni-node differs from the old-school node. * `polkadot_sdk_docs::reference_docs::frame_weight_benchmarking` to finally have a minimal reference about weights and benchmarking. * It provides tests for some of the steps in paritytech#5568 closes paritytech#5568 closes paritytech#4781 Next steps - [x] Ensure the README of the parachain template is up-to-date. @iulianbarbu - [ ] Readme for `polkadot-omni-node` and similar is updated. For now, use `cargo-readme` and copy over the rust-docs. To build the branch locally and run this: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/meta_contributing/index.html#how-to-develop-locally --------- Co-authored-by: Iulian Barbu <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

@iulianbarbu

provides low-level documentation on how the omni-node is meant to work. This is meant to act as reusable material for other teams (e.g. Papermoon and W3F) to use and integrate into the high level Polkadot documentation. Broadly speaking, for omni-node to have great rust-docs, we need to focus on the following crates, all of which got a bit of love in this PR: 1. `sp-genesis-builder` 2. `polkadot-omni-node` 3. `polkadot-omni-node-lib` 4. `frame-omni-bencher` On top of this, we have now: * `polkadot_sdk_docs::guides` contains two new steps demonstrating the most basic version of composing your pallet, putting it into a runtime, and putting that runtime into omni-node * `polkadot_sdk_docs::reference_docs::omni_node` to explain in more detail how omni-node differs from the old-school node. * `polkadot_sdk_docs::reference_docs::frame_weight_benchmarking` to finally have a minimal reference about weights and benchmarking. * It provides tests for some of the steps in paritytech#5568 closes paritytech#5568 closes paritytech#4781 Next steps - [x] Ensure the README of the parachain template is up-to-date. @iulianbarbu - [ ] Readme for `polkadot-omni-node` and similar is updated. For now, use `cargo-readme` and copy over the rust-docs. To build the branch locally and run this: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/meta_contributing/index.html#how-to-develop-locally --------- Co-authored-by: Iulian Barbu <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

@iulianbarbu

provides low-level documentation on how the omni-node is meant to work. This is meant to act as reusable material for other teams (e.g. Papermoon and W3F) to use and integrate into the high level Polkadot documentation. Broadly speaking, for omni-node to have great rust-docs, we need to focus on the following crates, all of which got a bit of love in this PR: 1. `sp-genesis-builder` 2. `polkadot-omni-node` 3. `polkadot-omni-node-lib` 4. `frame-omni-bencher` On top of this, we have now: * `polkadot_sdk_docs::guides` contains two new steps demonstrating the most basic version of composing your pallet, putting it into a runtime, and putting that runtime into omni-node * `polkadot_sdk_docs::reference_docs::omni_node` to explain in more detail how omni-node differs from the old-school node. * `polkadot_sdk_docs::reference_docs::frame_weight_benchmarking` to finally have a minimal reference about weights and benchmarking. * It provides tests for some of the steps in paritytech#5568 closes paritytech#5568 closes paritytech#4781 Next steps - [x] Ensure the README of the parachain template is up-to-date. @iulianbarbu - [ ] Readme for `polkadot-omni-node` and similar is updated. For now, use `cargo-readme` and copy over the rust-docs. To build the branch locally and run this: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/meta_contributing/index.html#how-to-develop-locally --------- Co-authored-by: Iulian Barbu <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

@iulianbarbu

provides low-level documentation on how the omni-node is meant to work. This is meant to act as reusable material for other teams (e.g. Papermoon and W3F) to use and integrate into the high level Polkadot documentation. Broadly speaking, for omni-node to have great rust-docs, we need to focus on the following crates, all of which got a bit of love in this PR: 1. `sp-genesis-builder` 2. `polkadot-omni-node` 3. `polkadot-omni-node-lib` 4. `frame-omni-bencher` On top of this, we have now: * `polkadot_sdk_docs::guides` contains two new steps demonstrating the most basic version of composing your pallet, putting it into a runtime, and putting that runtime into omni-node * `polkadot_sdk_docs::reference_docs::omni_node` to explain in more detail how omni-node differs from the old-school node. * `polkadot_sdk_docs::reference_docs::frame_weight_benchmarking` to finally have a minimal reference about weights and benchmarking. * It provides tests for some of the steps in paritytech#5568 closes paritytech#5568 closes paritytech#4781 Next steps - [x] Ensure the README of the parachain template is up-to-date. @iulianbarbu - [ ] Readme for `polkadot-omni-node` and similar is updated. For now, use `cargo-readme` and copy over the rust-docs. To build the branch locally and run this: https://paritytech.github.io/polkadot-sdk/master/polkadot_sdk_docs/meta_contributing/index.html#how-to-develop-locally --------- Co-authored-by: Iulian Barbu <[email protected]> Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

kianenigma added 6 commits October 14, 2024 10:43

all updates so far

7c2d349

all omni node tests work perfectly now

bcba502

update most of the docs as well

a09739b

all warnings removed

4156f88

add weights and benchmarking docs

751e871

fix

e297ba6

kianenigma requested a review from a team as a code owner October 16, 2024 14:03

kianenigma requested review from shawntabrizi, ggwpez, iulianbarbu and serban300 October 16, 2024 14:03

kianenigma mentioned this pull request Oct 16, 2024

Document the process to launch your first (omni) node #3946

Closed

2 tasks

Merge branch 'master' into kiz-omni-node-docs

fbfa80d

serban300 approved these changes Oct 18, 2024

View reviewed changes

michalkucharczyk reviewed Oct 18, 2024

View reviewed changes

kianenigma added 4 commits October 21, 2024 18:26

address a lot of the feedback

2f06367

Master.into()

41f702d

taply

7b66ec4

remove unused dep

308a3b1

kianenigma added R0-silent Changes should not be mentioned in any release notes T11-documentation This PR/Issue is related to documentation. labels Oct 21, 2024

kianenigma added 5 commits October 22, 2024 12:43

better external

1fd087f

fix signed ext

121be55

fix ci?

f3cecc4

prdocs

a53d3b6

Master.into()

06b3917

iulianbarbu reviewed Oct 22, 2024

View reviewed changes

kianenigma and others added 3 commits October 22, 2024 13:44

Update docs/sdk/src/guides/your_first_runtime.rs

36bad16

Co-authored-by: Iulian Barbu <[email protected]>

Update docs/sdk/src/reference_docs/omni_node.rs

0529176

Co-authored-by: Iulian Barbu <[email protected]>

Update docs/sdk/src/reference_docs/omni_node.rs

23d35e9

Co-authored-by: Iulian Barbu <[email protected]>

michalkucharczyk reviewed Oct 23, 2024

View reviewed changes

docs/sdk/src/guides/your_first_node.rs Show resolved Hide resolved

kianenigma mentioned this pull request Oct 23, 2024

polkadot-sdk-docs: Versioning #6191

Open

kianenigma and others added 3 commits October 23, 2024 13:08

review comments

cfdf9f5

Merge branch 'kiz-omni-node-docs' of github.com:paritytech/polkadot-s…

161abb6

…dk into kiz-omni-node-docs

Apply suggestions from code review

cf1e7f5

Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

kianenigma commented Oct 23, 2024

View reviewed changes

docs/sdk/src/reference_docs/omni_node.rs Outdated Show resolved Hide resolved

kianenigma commented Oct 23, 2024

View reviewed changes

substrate/bin/node/cli/src/service.rs Outdated Show resolved Hide resolved

kianenigma and others added 3 commits October 23, 2024 14:00

Apply suggestions from code review

cdd097a

Co-authored-by: Sebastian Kunert <[email protected]> Co-authored-by: Michal Kucharczyk <[email protected]>

comments

2c8402c

Merge branch 'kiz-omni-node-docs' of github.com:paritytech/polkadot-s…

27b9035

…dk into kiz-omni-node-docs

kianenigma and others added 8 commits October 23, 2024 14:03

Update cumulus/polkadot-omni-node/lib/src/nodes/manual_seal.rs

1bccc18

Co-authored-by: Sebastian Kunert <[email protected]>

Merge branch 'kiz-omni-node-docs' of github.com:paritytech/polkadot-s…

da96c78

…dk into kiz-omni-node-docs

fmt and more

8e735c3

fmt

9a95a2f

fix link

cbaff16

new binaries section

034e47e

fix ci

1ecf596

Merge branch 'master' of github.com:paritytech/polkadot-sdk into kiz-…

1e072ce

…omni-node-docs

kianenigma enabled auto-merge October 23, 2024 15:05

fix ci

af68dbb

kianenigma added this pull request to the merge queue Oct 23, 2024

kianenigma mentioned this pull request Oct 23, 2024

templates: make node compilation optional #5954

Open

3 tasks

Merged via the queue into master with commit fc486e5 Oct 23, 2024
194 of 196 checks passed

kianenigma deleted the kiz-omni-node-docs branch October 23, 2024 16:49

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Polkadot OmniNode Docs #6094

Polkadot OmniNode Docs #6094

kianenigma commented Oct 16, 2024 •

edited

Loading

serban300 Oct 18, 2024

kianenigma Oct 21, 2024

iulianbarbu Oct 21, 2024

michalkucharczyk left a comment

iulianbarbu Oct 21, 2024

iulianbarbu Oct 22, 2024 •

edited

Loading

kianenigma Oct 22, 2024

iulianbarbu Oct 22, 2024

kianenigma commented Oct 23, 2024

Polkadot OmniNode Docs #6094

Polkadot OmniNode Docs #6094

Conversation

kianenigma commented Oct 16, 2024 • edited Loading

serban300 Oct 18, 2024

Choose a reason for hiding this comment

kianenigma Oct 21, 2024

Choose a reason for hiding this comment

iulianbarbu Oct 21, 2024

Choose a reason for hiding this comment

michalkucharczyk left a comment

Choose a reason for hiding this comment

iulianbarbu Oct 21, 2024

Choose a reason for hiding this comment

iulianbarbu Oct 22, 2024 • edited Loading

Choose a reason for hiding this comment

kianenigma Oct 22, 2024

Choose a reason for hiding this comment

iulianbarbu Oct 22, 2024

Choose a reason for hiding this comment

kianenigma commented Oct 23, 2024

kianenigma commented Oct 16, 2024 •

edited

Loading

iulianbarbu Oct 22, 2024 •

edited

Loading