Skip to content
This repository has been archived by the owner on Nov 15, 2023. It is now read-only.

README: Document usage of RPC node #2313

Merged
merged 5 commits into from
Mar 14, 2023
Merged

README: Document usage of RPC node #2313

merged 5 commits into from
Mar 14, 2023

Conversation

skunert
Copy link
Contributor

@skunert skunert commented Mar 14, 2023

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

@skunert 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 skunert requested a review from a team March 14, 2023 10:37
koute
koute approved these changes Mar 14, 2023
View reviewed changes
Copy link
Contributor

@koute koute left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated
# 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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 Outdated Show resolved Hide resolved
skunert and others added 2 commits March 14, 2023 14:58
@skunert @koute
Apply suggestions from code review
1158ab9 
Co-authored-by: Koute <koute@users.noreply.github.com>
@skunert
Quote urls
c89fc44
michalkucharczyk
michalkucharczyk reviewed Mar 14, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
michalkucharczyk
michalkucharczyk reviewed Mar 14, 2023
View reviewed changes
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

michalkucharczyk
michalkucharczyk reviewed Mar 14, 2023
View reviewed changes
README.md Outdated Show resolved Hide resolved
@michalkucharczyk michalkucharczyk requested a review from a team March 14, 2023 14:12
@skunert @michalkucharczyk
Apply suggestions from code review
ea22a25 
Co-authored-by: Michal Kucharczyk <1728078+michalkucharczyk@users.noreply.github.com>
@skunert
Copy link
Contributor Author

skunert commented Mar 14, 2023

bot merge

@paritytech-processbot
Copy link

Waiting for commit status.

@paritytech-processbot paritytech-processbot bot merged commit 7e799e7 into paritytech:master Mar 14, 2023
davxy
davxy reviewed Mar 14, 2023
View reviewed changes
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.
Copy link
Member

@davxy davxy Mar 14, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@davxy
Copy link
Member

davxy commented Mar 14, 2023

I was late 😥

@skunert skunert mentioned this pull request Mar 14, 2023
Merged
skunert added a commit that referenced this pull request Mar 15, 2023
@skunert
ReadMe followup for #2313 (#2317)
4036124 
* Readme again

* relaychain -> relay chain
ordian added a commit that referenced this pull request Mar 16, 2023
@ordian
Merge branch 'master' into ao-past-session-slashing-companion
1ba14e8 
* 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)
  ...
@kiltbot kiltbot mentioned this pull request Apr 3, 2023
Closed
@librelois librelois mentioned this pull request Apr 6, 2023
Closed
svyatonik added a commit that referenced this pull request Aug 7, 2023
@svyatonik
Squashed 'bridges/' changes from c364846936..f822ebc450
3ad67d3 
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
bkontur added a commit that referenced this pull request Aug 11, 2023
@bkontur
Squashed 'bridges/' changes from edf33a2c85..8f86ec78b7
429d6b0 
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
bkontur added a commit that referenced this pull request Aug 12, 2023
@bkontur
Squashed 'bridges/' changes from edf33a2c85..8f86ec78b7
02e00e6 
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
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@davxy davxy davxy left review comments

@koute koute koute approved these changes

@michalkucharczyk michalkucharczyk michalkucharczyk approved these changes

Assignees
No one assigned
Labels
A0-please_review Pull request needs code review. B0-silent Changes should not be mentioned in any release notes 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”.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@skunert @davxy @koute @michalkucharczyk