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

Change the chain to Rococo in the parachain template Zombienet config #5279

Merged
merged 10 commits into from
Aug 23, 2024
Merged

Change the chain to Rococo in the parachain template Zombienet config #5279

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
339455e
Update zombienet.toml
rzadp Aug 8, 2024
d30a6f3
Merge branch 'master' into rzadp-patch-1
shawntabrizi Aug 8, 2024
a6c0b86
update config and readme
rzadp Aug 8, 2024
263d088
mdlint
rzadp Aug 8, 2024
f8cf477
Apply suggestions from code review
rzadp Aug 14, 2024
403e4f4
restore path example
rzadp Aug 14, 2024
7be12e5
finish readme
rzadp Aug 14, 2024
2e3eb48
instructions to install the node
rzadp Aug 15, 2024
1dbddd9
Merge branch 'master' into rzadp-patch-1
rzadp Aug 15, 2024
406eb8f
Merge branch 'master' into rzadp-patch-1
rzadp Aug 16, 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
11 changes: 3 additions & 8 deletions templates/parachain/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,14 +63,9 @@ You still need a relaychain node - you can download the `polkadot`
(and the accompanying `polkadot-prepare-worker` and `polkadot-execute-worker`)
binaries from [Polkadot SDK releases](https://github.com/paritytech/polkadot-sdk/releases/latest).
Copy link
Contributor

Choose a reason for hiding this comment

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

Download binaries (of polkadot) only works on linux (x86_64), we should add a comment to compile those in macOS or arm64.

Copy link
Member

Choose a reason for hiding this comment

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

I prefer we solve like this: #802

Copy link
Contributor

Choose a reason for hiding this comment

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

Totally agree, we should push to include those as part of the release process to improve dx.


Make sure to bring the parachain node - as well as `polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`,
and `zombienet` - into `PATH` like so:

```sh
export PATH="./target/release/:$PATH"
```

This way, we can conveniently use them in the following steps.
Make sure to bring `zombienet` and the relaychain binaries
(`polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`)
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
(`polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`)
(`polkadot`, `polkadot-prepare-worker`, `polkadot-execute-worker`, `parachain-template-node`)

Copy link
Member

Choose a reason for hiding this comment

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

Maybe keeping the export PATH example is a good idea.

Copy link
Member

Choose a reason for hiding this comment

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

really though? seems super inconvenient?

compared to just having the path in the zombienet config itself?

Copy link
Member

Choose a reason for hiding this comment

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

better then imo to run cargo install so that the binary is placed into the cargo bin

Copy link
Contributor Author

Choose a reason for hiding this comment

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

There is one more argument supporting the PATH path.

The user could be trying out the readme, having downloaded the parachain-template-node binary from a release instead of building it.

Then, the hardcoded path in zombienet wouldn't make sense, but instructions to have it in PATH would still hold.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

better then imo to run cargo install so that the binary is placed into the cargo bin

OK, I've added a step with cargo install for the parachain binary.
And, I left an example with export PATH for the other binaries.

into `PATH`, so that they are available in the following steps.

👥 The following command starts a local development chain, with a single relay chain node and a single parachain collator:

Expand Down
11 changes: 8 additions & 3 deletions templates/parachain/zombienet.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
[relaychain]
default_command = "polkadot"
chain = "dev"
chain = "rococo-local"

[[relaychain.nodes]]
name = "alice"
validator = true
ws_port = 9944

[[relaychain.nodes]]
name = "bob"
validator = true
ws_port = 9955

[[parachains]]
id = 1000

[parachains.collator]
name = "alice"
name = "charlie"
ws_port = 9988
command = "parachain-template-node"
command = "./target/release/parachain-template-node"
rzadp marked this conversation as resolved.
Show resolved Hide resolved
Loading