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

Add docs for the common binaries exported from Polkadot SDK #5305

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docs for the common binaries exported from Polkadot SDK #5305

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,22 @@ curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/paritytec
* Other Resources:
* [Polkadot Wiki -> Build](https://wiki.polkadot.network/docs/build-guide)

## Binaries

This repo provides the source code to a number of useful binaries used throughout Polkadot SDK development. The most commonly used are:

- `polkadot`: A node for the main Polkadot Relay Chain.
- `polkadot-parachain`: A node for a generic Parachain. Can be combined with a custom chain specification to launch a custom Parachain.
- `chain-spec-builder`: A tool to generate a custom chain specification. Can be combined with a Polkadot-SDK compatible Wasm runtime to build a custom chain specification.

You can find released binaries for Linux in our [latest releases](https://github.com/paritytech/polkadot-sdk/releases/).

For other platforms, you can compile the binaries yourself with:

```bash
cargo install --git https://github.com/paritytech/polkadot-sdk/ --tag polkadot-stable2407 polkadot polkadot-parachain-bin staging-chain-spec-builder
Copy link
Member

@ggwpez ggwpez Aug 9, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I think it also needs the polkadot-execute-worker and polkadot-prepare-worker binaries to work?
Slightly unfortunate, but we split the polkadot binary into three (for security reasons) 🫠

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, you need those to run a node as validator.

Copy link
Member Author

Choose a reason for hiding this comment

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

Where can i learn how these other 2 binaries work and what they do?

Copy link
Contributor

Choose a reason for hiding this comment

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

See here for more info: paritytech/polkadot#7337

```

## 🚀 Releases

> [!NOTE]
Expand Down
Loading