forked from paritytech/polkadot
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
update readme: archived repo (paritytech#7654)
* Update README.md * Update README.md
- Loading branch information
1 parent
598f4c6
commit 52209dc
Showing
1 changed file
with
7 additions
and
258 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,264 +1,13 @@ | ||
| # Polkadot | ||
| Dear contributors and users, | ||
|
|
||
| Implementation of a <https://polkadot.network> node in Rust based on the Substrate framework. | ||
| We would like to inform you that we have recently made significant changes to our repository structure. In order to streamline our development process and foster better contributions, we have merged three separate repositories Cumulus, Substrate and Polkadot into a single new repository: [the Polkadot SDK](https://github.com/paritytech/polkadot-sdk). Go ahead and make sure to support us by giving a star ⭐️ to the new repo. | ||
|
|
||
| > **NOTE:** In 2018, we split our implementation of "Polkadot" from its development framework | ||
| > "Substrate". See the [Substrate][substrate-repo] repo for git history prior to 2018. | ||
| By consolidating our codebase, we aim to enhance collaboration and provide a more efficient platform for future development. | ||
|
|
||
| [substrate-repo]: https://github.com/paritytech/substrate | ||
| If you currently have an open pull request in any of the merged repositories, we kindly request that you resubmit your PR in the new repository. This will ensure that your contributions are considered within the updated context and enable us to review and merge them more effectively. | ||
|
|
||
| This repo contains runtimes for the Polkadot, Kusama, and Westend networks. The README provides | ||
| information about installing the `polkadot` binary and developing on the codebase. For more | ||
| specific guides, like how to be a validator, see the | ||
| [Polkadot Wiki](https://wiki.polkadot.network/docs/getting-started). | ||
| We appreciate your understanding and ongoing support throughout this transition. Should you have any questions or require further assistance, please don't hesitate to [reach out to us](https://forum.polkadot.network/t/psa-parity-is-currently-working-on-merging-the-polkadot-stack-repositories-into-one-single-repository/2883). | ||
|
|
||
| ## Installation | ||
| Best Regards, | ||
|
|
||
| If you just wish to run a Polkadot node without compiling it yourself, you may | ||
| either run the latest binary from our | ||
| [releases](https://github.com/paritytech/polkadot/releases) page, or install | ||
| Polkadot from one of our package repositories. | ||
|
|
||
| Installation from the Debian repository will create a `systemd` | ||
| service that can be used to run a Polkadot node. This is disabled by default, | ||
| and can be started by running `systemctl start polkadot` on demand (use | ||
| `systemctl enable polkadot` to make it auto-start after reboot). By default, it | ||
| will run as the `polkadot` user. Command-line flags passed to the binary can | ||
| be customized by editing `/etc/default/polkadot`. This file will not be | ||
| overwritten on updating polkadot. You may also just run the node directly from | ||
| the command-line. | ||
|
|
||
| ### Debian-based (Debian, Ubuntu) | ||
|
|
||
| Currently supports Debian 10 (Buster) and Ubuntu 20.04 (Focal), and | ||
| derivatives. Run the following commands as the `root` user. | ||
|
|
||
| ```bash | ||
| # Import the security@parity.io GPG key | ||
| gpg --recv-keys --keyserver hkps://keys.mailvelope.com 9D4B2B6EB8F97156D19669A9FF0812D491B96798 | ||
| gpg --export 9D4B2B6EB8F97156D19669A9FF0812D491B96798 > /usr/share/keyrings/parity.gpg | ||
| # Add the Parity repository and update the package index | ||
| echo 'deb [signed-by=/usr/share/keyrings/parity.gpg] https://releases.parity.io/deb release main' > /etc/apt/sources.list.d/parity.list | ||
| apt update | ||
| # Install the `parity-keyring` package - This will ensure the GPG key | ||
| # used by APT remains up-to-date | ||
| apt install parity-keyring | ||
| # Install polkadot | ||
| apt install polkadot | ||
|
|
||
| ``` | ||
|
|
||
| ## Building | ||
|
|
||
| ### Install via Cargo | ||
|
|
||
| Make sure you have the support software installed from the **Build from Source** section | ||
| below this section. | ||
|
|
||
| If you want to install Polkadot in your PATH, you can do so with: | ||
|
|
||
| ```bash | ||
| cargo install --git https://github.com/paritytech/polkadot --tag <version> polkadot --locked | ||
| ``` | ||
|
|
||
| ### Build from Source | ||
|
|
||
| If you'd like to build from source, first install Rust. You may need to add Cargo's bin directory | ||
| to your PATH environment variable. Restarting your computer will do this for you automatically. | ||
|
|
||
| ```bash | ||
| curl https://sh.rustup.rs -sSf | sh | ||
| ``` | ||
|
|
||
| If you already have Rust installed, make sure you're using the latest version by running: | ||
|
|
||
| ```bash | ||
| rustup update | ||
| ``` | ||
|
|
||
| Once done, finish installing the support software: | ||
|
|
||
| ```bash | ||
| sudo apt install build-essential git clang libclang-dev pkg-config libssl-dev protobuf-compiler | ||
| ``` | ||
|
|
||
| Build the client by cloning this repository and running the following commands from the root | ||
| directory of the repo: | ||
|
|
||
| ```bash | ||
| git checkout <latest tagged release> | ||
| ./scripts/init.sh | ||
| cargo build --release | ||
| ``` | ||
|
|
||
| **Note:** compilation is a memory intensive process. We recommend having 4 GiB of physical RAM or swap available (keep in mind that if a build hits swap it tends to be very slow). | ||
|
|
||
| **Note:** if you want to move the built `polkadot` binary somewhere (e.g. into $PATH) you will also need to move `polkadot-execute-worker` and `polkadot-prepare-worker`. You can let cargo do all this for you by running: | ||
|
|
||
| ```sh | ||
| cargo install --path . --locked | ||
| ``` | ||
|
|
||
| #### Build from Source with Docker | ||
|
|
||
| You can also build from source using | ||
| [Parity CI docker image](https://github.com/paritytech/scripts/tree/master/dockerfiles/ci-linux): | ||
|
|
||
| ```bash | ||
| git checkout <latest tagged release> | ||
| docker run --rm -it -w /shellhere/polkadot \ | ||
| -v $(pwd):/shellhere/polkadot \ | ||
| paritytech/ci-linux:production cargo build --release | ||
| sudo chown -R $(id -u):$(id -g) target/ | ||
| ``` | ||
|
|
||
| If you want to reproduce other steps of CI process you can use the following | ||
| [guide](https://github.com/paritytech/scripts#gitlab-ci-for-building-docker-images). | ||
|
|
||
| ## Networks | ||
|
|
||
| This repo supports runtimes for Polkadot, Kusama, and Westend. | ||
|
|
||
| ### Connect to Polkadot Mainnet | ||
|
|
||
| Connect to the global Polkadot Mainnet network by running: | ||
|
|
||
| ```bash | ||
| ./target/release/polkadot --chain=polkadot | ||
| ``` | ||
|
|
||
| You can see your node on [telemetry] (set a custom name with `--name "my custom name"`). | ||
|
|
||
| [telemetry]: https://telemetry.polkadot.io/#list/Polkadot | ||
|
|
||
| ### Connect to the "Kusama" Canary Network | ||
|
|
||
| Connect to the global Kusama canary network by running: | ||
|
|
||
| ```bash | ||
| ./target/release/polkadot --chain=kusama | ||
| ``` | ||
|
|
||
| You can see your node on [telemetry] (set a custom name with `--name "my custom name"`). | ||
|
|
||
| [telemetry]: https://telemetry.polkadot.io/#list/Kusama | ||
|
|
||
| ### Connect to the Westend Testnet | ||
|
|
||
| Connect to the global Westend testnet by running: | ||
|
|
||
| ```bash | ||
| ./target/release/polkadot --chain=westend | ||
| ``` | ||
|
|
||
| You can see your node on [telemetry] (set a custom name with `--name "my custom name"`). | ||
|
|
||
| [telemetry]: https://telemetry.polkadot.io/#list/Westend | ||
|
|
||
| ### Obtaining DOTs | ||
|
|
||
| If you want to do anything on Polkadot, Kusama, or Westend, then you'll need to get an account and | ||
| some DOT, KSM, or WND tokens, respectively. See the | ||
| [claims instructions](https://claims.polkadot.network/) for Polkadot if you have DOTs to claim. For | ||
| Westend's WND tokens, see the faucet | ||
| [instructions](https://wiki.polkadot.network/docs/learn-DOT#getting-westies) on the Wiki. | ||
|
|
||
| ## Hacking on Polkadot | ||
|
|
||
| If you'd actually like to hack on Polkadot, you can grab the source code and build it. Ensure you have | ||
| Rust and the support software installed. This script will install or update Rust and install the | ||
| required dependencies (this may take up to 30 minutes on Mac machines): | ||
|
|
||
| ```bash | ||
| curl https://getsubstrate.io -sSf | bash -s -- --fast | ||
| ``` | ||
|
|
||
| Then, grab the Polkadot source code: | ||
|
|
||
| ```bash | ||
| git clone https://github.com/paritytech/polkadot.git | ||
| cd polkadot | ||
| ``` | ||
|
|
||
| Then build the code. You will need to build in release mode (`--release`) to start a network. Only | ||
| use debug mode for development (faster compile times for development and testing). | ||
|
|
||
| ```bash | ||
| ./scripts/init.sh # Install WebAssembly. Update Rust | ||
| cargo build # Builds all native code | ||
| ``` | ||
|
|
||
| You can run the tests if you like: | ||
|
|
||
| ```bash | ||
| cargo test --workspace --release | ||
| ``` | ||
|
|
||
| You can start a development chain with: | ||
|
|
||
| ```bash | ||
| cargo build | ||
| cargo run -- --dev | ||
| ``` | ||
|
|
||
| Detailed logs may be shown by running the node with the following environment variables set: | ||
|
|
||
| ```bash | ||
| RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev | ||
| ``` | ||
|
|
||
| ### Development | ||
|
|
||
| You can run a simple single-node development "network" on your machine by running: | ||
|
|
||
| ```bash | ||
| polkadot --dev | ||
| ``` | ||
|
|
||
| You can muck around by heading to <https://polkadot.js.org/apps> and choose "Local Node" from the | ||
| Settings menu. | ||
|
|
||
| ### Local Two-node Testnet | ||
|
|
||
| If you want to see the multi-node consensus algorithm in action locally, then you can create a | ||
| local testnet. You'll need two terminals open. In one, run: | ||
|
|
||
| ```bash | ||
| polkadot --chain=polkadot-local --alice -d /tmp/alice | ||
| ``` | ||
|
|
||
| And in the other, run: | ||
|
|
||
| ```bash | ||
| polkadot --chain=polkadot-local --bob -d /tmp/bob --port 30334 --bootnodes '/ip4/127.0.0.1/tcp/30333/p2p/ALICE_BOOTNODE_ID_HERE' | ||
| ``` | ||
|
|
||
| Ensure you replace `ALICE_BOOTNODE_ID_HERE` with the node ID from the output of the first terminal. | ||
|
|
||
| ### Monitoring | ||
|
|
||
| [Setup Prometheus and Grafana](https://wiki.polkadot.network/docs/maintain-guides-how-to-monitor-your-node). | ||
|
|
||
| Once you set this up you can take a look at the [Polkadot Grafana dashboards](grafana/README.md) that we currently maintain. | ||
|
|
||
| ### Using Docker | ||
|
|
||
| [Using Docker](doc/docker.md) | ||
|
|
||
| ### Shell Completion | ||
|
|
||
| [Shell Completion](doc/shell-completion.md) | ||
|
|
||
| ## Contributing | ||
|
|
||
| ### Contributing Guidelines | ||
|
|
||
| [Contribution Guidelines](CONTRIBUTING.md) | ||
|
|
||
| ### Contributor Code of Conduct | ||
|
|
||
| [Code of Conduct](CODE_OF_CONDUCT.md) | ||
|
|
||
| ## License | ||
|
|
||
| Polkadot is [GPL 3.0 licensed](LICENSE). | ||
| Parity Technologies |