README: Document usage of RPC node #2313

skunert · 2023-03-14T10:37:27Z

This adds documentation to the readme about the usage of external relaychain RPC nodes.

koute

Feel free to use the suggestions as-is or edit them as you see fit.

README.md

koute · 2023-03-14T12:47:37Z

README.md

+#                                                                                    data via RPC from here.                     Backup node                           to the relaychain network
+#                                                                                              |                                      |                                           |
+#                                                                                |-------------------------------| |--------------------------------------|            |-----------------------|
+polkadot-parachain --chain parachain-chainspec.json --tmp --relay-chain-rpc-urls ws://relaychain-rpc-endpoint:9944 ws://relaychain-rpc-endpoint-backup:9944 -- --chain relaychain-chainspec.json


Hmm.... will this actually work? Shouldn't the URLs be double-quoted? "?

It actually works, I copied this out of some scripts I have in use 👍 . But you are still right, I will quote it and agree that its best practice.

README.md

Co-authored-by: Koute <[email protected]>

README.md

michalkucharczyk · 2023-03-14T14:10:17Z

README.md

+#### In-process Relaychain Node
+By default if an external relaychain node is not specified then a full relaychain node will be spawned within the same process.
+
+This node has all of the typical components of a normal Polkadot node, and will have to fully sync with the relaychain to work.


Suggested change

This node has all of the typical components of a normal Polkadot node, and will have to fully sync with the relaychain to work.

In-process node has all of the typical components of a normal Polkadot node, and will have to fully sync with the relaychain to work.

README.md

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

skunert · 2023-03-14T14:17:26Z

bot merge

paritytech-processbot · 2023-03-14T14:17:33Z

Waiting for commit status.

davxy · 2023-03-14T14:52:48Z

README.md

+```
+
+#### External Relaychain Node
+An external relaychain node can be connected via websocket RPC by using the  `--relay-chain-rpc-urls` command line argument. This option accepts one or more space-separated websocket URLs to a full relay chain node. By default only the first URL will be used, with the rest acting as a backup in case the connection to the first node will be lost.


mmm... Very long lines 😃

Can we stick to max 100 cols per line?
Long lines are best fitted for reading on github or on a proper markdown renderer.
I usually brutally read md files on an editor in the terminal

davxy · 2023-03-14T14:54:57Z

README.md

+#                                                                                     data via RPC from here.                      Backup node                            to the relaychain network
+#                                                                                               |                                       |                                           |
+#                                                                                |---------------------------------| |----------------------------------------|            |-----------------------|
+polkadot-parachain --chain parachain-chainspec.json --tmp --relay-chain-rpc-urls "ws://relaychain-rpc-endpoint:9944" "ws://relaychain-rpc-endpoint-backup:9944" -- --chain relaychain-chainspec.json


this is unreadable in raw format.

Maybe we should write long lines containing shell commands like:

> polkadot-parachain \ --chain parachain-chainspec.json \ --tmp\ --relay-chain-rpc-urls "ws://relaychain-rpc-endpoint:9944" "ws://relaychain-rpc-endpoint-backup:9944" \ -- \ --chain relaychain-chainspec.json

Then the explanation of the single lines may optionally follow:

--relay-chain-rpc-urls <primary-endpoint> <backup-endpoint>

I was a bit fast on this one, I will add your suggestions later 👍

davxy · 2023-03-14T15:00:01Z

I was late 😥

* Readme again * relaychain -> relay chain

* master: (44 commits) Companion for #13287 (#2155) timestamp ci job logs (#2327) Release parachain host API v4 (#2325) Bump clap from 4.1.6 to 4.1.8 (#2272) Enabled `polkadot-parachain` build for `runtime-benchmarks`, e.g.: (#2324) Bump tokio from 1.25.0 to 1.26.0 (#2273) Bump async-trait from 0.1.64 to 0.1.66 (#2318) ReadMe followup for #2313 (#2317) Fix runtime api import path (#2319) Update Westend collectives chainspec (#2311) README: Document usage of RPC node (#2313) Companion for paritytech/substrate#13592 (#2310) Update orchestra and metered-channel (#2304) Backport: Brigehub: Add in force upgrade xcm version (into master) (#2289) [Backport] version bumps from 9380 (#2309) Bump proc-macro2 from 1.0.50 to 1.0.52 (#2312) Remove use of trait Store (#2286) Companion for #13482 (#2303) add amforc bootnodes (#2246) Cleanup dependencies + dead code (#2302) ...

f822ebc450 Dynamic fees v1: report congestion status to sending chain (#2318) add9fb1d53 added/fixed some docs 569a80f233 Rename LocalXcmChannel to XcmChannelStatusProvider (#2319) dc3618a4a5 Clippy e7cab6ab49 (Suggestion) Ability to externalize configuration for `ExporterFor` (#2313) REVERT: c364846936 report congestion status: changes at the bridge hub REVERT: d78f10664a OnMessagesDelivered is back REVERT: ac799a88e3 report congestion status: changes at the sending chain git-subtree-dir: bridges git-subtree-split: f822ebc45081e67217e7395cae7d42c661dc8464

8f86ec78b7 ".git/.scripts/commands/fmt/fmt.sh" ccf2f9483b Merge remote-tracking branch 'origin/polkadot-staging' into dynamic-fees-v1 f822ebc450 Dynamic fees v1: report congestion status to sending chain (#2318) add9fb1d53 added/fixed some docs 569a80f233 Rename LocalXcmChannel to XcmChannelStatusProvider (#2319) dc3618a4a5 Clippy e7cab6ab49 (Suggestion) Ability to externalize configuration for `ExporterFor` (#2313) c68467beff fmt 5d76f25311 use saturated_len where possible 7cc1470528 Update modules/xcm-bridge-hub-router/src/lib.rs 8d7a38a409 change log target for xcm bridge router pallet 773f93209f Revert "trigger CI" 48f1ba0323 trigger CI b26aa98d1e fixing spellcheck, clippy and rustdoc c467911a37 add new pallet to verify-pallets-build.sh ed72ebe62b get rid of redundant storage value 522bbc7ec4 benchmarks for pallet-xcm-bridge-hub-router 958243564d extension_reject_call_when_dispatcher_is_inactive 38cd8f3df3 fix other tests in the bridge-runtime-common b75e64fdf7 tests for new logic in the XcmBlobHaulerAdapter 4c741714cb tests for LocalXcmQueueMessageProcessor d99420e14c tests for LocalXcmQueueSuspender 084f551bb6 new tests for logic changes in messages pallet d9515f7317 use LocalXcmChannel in XcmBlobMessageDispatch d9a0c2e468 improvements and tests for palle-xcm-bridge-router c24301374a removed commented code eea610a875 pallet-xcm-bridge-hub-router 1fdac85a14 forbid mesage delivery transactions when the channel between target bridge hub and target asset hub is suspended 3c98c245ac OnMessageDelviered callback 65787da038 LocalXcmQueueManager + more adapters 74b48e2cc3 impl backpressure in the XcmBlobHaulerAdapter git-subtree-dir: bridges git-subtree-split: 8f86ec78b7747ba32807e8691f022edb4ad3040d

skunert added 2 commits March 14, 2023 11:23

Update readme

4c3aa13

Improve

fb28a76

skunert added B0-silent Changes should not be mentioned in any release notes A0-please_review Pull request needs code review. C1-low PR touches the given topic and has a low impact on builders. T0-node This PR/Issue is related to the topic “node”. labels Mar 14, 2023

skunert requested a review from a team March 14, 2023 10:37

koute approved these changes Mar 14, 2023

View reviewed changes

skunert and others added 2 commits March 14, 2023 14:58

Apply suggestions from code review

1158ab9

Co-authored-by: Koute <[email protected]>

Quote urls

c89fc44

michalkucharczyk reviewed Mar 14, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

michalkucharczyk reviewed Mar 14, 2023

View reviewed changes

README.md Outdated Show resolved Hide resolved

michalkucharczyk approved these changes Mar 14, 2023

View reviewed changes

michalkucharczyk requested a review from a team March 14, 2023 14:12

Apply suggestions from code review

ea22a25

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

paritytech-processbot bot merged commit 7e799e7 into paritytech:master Mar 14, 2023

davxy reviewed Mar 14, 2023

View reviewed changes

skunert mentioned this pull request Mar 14, 2023

ReadMe followup for #2313 #2317

Merged

skunert added a commit that referenced this pull request Mar 15, 2023

ReadMe followup for #2313 (#2317)

4036124

* Readme again * relaychain -> relay chain

kiltbot mentioned this pull request Apr 3, 2023

3️⃣ [AUTOMATIC] Update Polkadot dependencies from 0.9.39 to 0.9.40 KILTprotocol/kilt-node#496

Closed

librelois mentioned this pull request Apr 6, 2023

Update substrate/polkadot/cumulus from v0.9.38 to v0.9.40 moonbeam-foundation/moonbeam#2200

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README: Document usage of RPC node #2313

README: Document usage of RPC node #2313

skunert commented Mar 14, 2023

koute left a comment

koute Mar 14, 2023

skunert Mar 14, 2023

michalkucharczyk Mar 14, 2023

skunert commented Mar 14, 2023

paritytech-processbot bot commented Mar 14, 2023

davxy Mar 14, 2023 •

edited

Loading

davxy Mar 14, 2023

skunert Mar 14, 2023

davxy commented Mar 14, 2023

	This node has all of the typical components of a normal Polkadot node, and will have to fully sync with the relaychain to work.
	In-process node has all of the typical components of a normal Polkadot node, and will have to fully sync with the relaychain to work.

README: Document usage of RPC node #2313

README: Document usage of RPC node #2313

Conversation

skunert commented Mar 14, 2023

koute left a comment

Choose a reason for hiding this comment

koute Mar 14, 2023

Choose a reason for hiding this comment

skunert Mar 14, 2023

Choose a reason for hiding this comment

michalkucharczyk Mar 14, 2023

Choose a reason for hiding this comment

skunert commented Mar 14, 2023

paritytech-processbot bot commented Mar 14, 2023

davxy Mar 14, 2023 • edited Loading

Choose a reason for hiding this comment

davxy Mar 14, 2023

Choose a reason for hiding this comment

skunert Mar 14, 2023

Choose a reason for hiding this comment

davxy commented Mar 14, 2023

davxy Mar 14, 2023 •

edited

Loading