* update readme for current networks
* remove networks docs (they were copy/paste from readme)
* remove trailing whitespace
* add polkadot wiki
* remove hello world name
* remove authors/revision
Implementation of a https://polkadot.network node in Rust.
Implementation of a https://polkadot.network node in Rust based on the Substrate framework.
## NOTE
In 2018 we split our implementation of "Polkadot" from its platform-level component "Substrate". When we split them, we split the Polkadot code off into another repo (this repo), leaving the [**Substrate** repo][substrate-repo] to be what used to be Polkadot, along with its branches and releases.
We are actively building both Substrate and Polkadot, but things will be a little odd for a while. If you see "substrate" and are wondering why you need it for Polkadot, now you know.
To connect on the "Kusama" canary network, you will want the `v0.7` code, which is in this **Polkadot** repo. To play on the ("Alexander") testnet, you'll want the PoC-4 code instead. Note that PoC-3 uses the Alexander testnet, but will not be able to sync to the latest block.
* **Kusama** (né Kusama CC-3) is in this [**Polkadot**] repo `master` branch.
* **Kusama CC-2** is in this [**Polkadot**][polkadot-v0.6] repo branch `v0.6`.
* **Kusama CC-1** is in this [**Polkadot**][polkadot-v0.5] repo branch `v0.5`.
* **Polkadot PoC-4 "Alexander"** is in this [**Polkadot**][polkadot-v0.4] repo branch `v0.4`.
* **Polkadot PoC-3 "Alexander"** is in this [**Polkadot**][polkadot-v0.3] repo branch `v0.3`.
* **Polkadot PoC-2 "Krumme Lanke"** is in the [**Substrate**][substrate-v0.2] repo branch `v0.2`.
> **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.
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
```
You may need to add Cargo's bin directoy to your PATH environment variable. Restarting your computer will do this for you automatically. Once done, finish installing the support software:
```bash
sudo apt install make clang pkg-config libssl-dev
```
If you already have Rust installed, make sure you're using the latest version by running:
```bash
rustup update
```
### Install "Kusama CC-3" Canary Network
Build Kusama by cloning this repository and running the following commands from the root directory of the repo:
Once done, finish installing the support software:
```bash
git checkout master
sudo apt install make clang pkg-config libssl-dev
```
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
```
Connect to the global Kusama canary network by default by running:
## Networks
This repo supports runtimes for Polkadot, Kusama, and Westend.
### Connect to Polkadot Chain Candidate 1 (CC1)
Connect to the global Polkadot CC1 network by running:
```bash
./target/release/polkadot --name "hello world!"
./target/release/polkadot --chain=polkadot
```
You can see your node on [telemetry].
You can see your node on [telemetry] (set a custom name with `--name "my custom name"`).
If you want to do anything on it (not that there's much to do), then you'll need to get an account and some Alexander or Krumme Lanke DOTs. Ask in the Polkadot watercooler ( https://riot.im/app/#/room/#polkadot-watercooler:matrix.org ) or get some from the Polkadot Testnet Faucet ( https://faucet.polkadot.network/ ).
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/en/learn-DOT#getting-westies) on the Wiki.
### Development
## Hacking on Polkadot
You can run a simple single-node development "network" on your machine by
running in a terminal:
If you'd actually like 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
polkadot --dev
```
You can muck around by cloning and building the http://github.com/paritytech/polka-ui and http://github.com/paritytech/polkadot-ui or just heading to https://polkadot.js.org/apps and choose "Alexander (hosted by Parity)" from the Settings menu.
## Building
### Hacking on Polkadot
If you'd actually like hack on Polkadot, you can just grab the source code and build it. Ensure you have Rust and the support software installed:
```bash
curl https://sh.rustup.rs -sSf | sh
```
You may need to add Cargo's bin directoy to your PATH environment variable. Restarting your computer will do this for you automatically. Once done, finish installing the support software:
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
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:
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:
You can run a simple single-node development "network" on your machine by running in a terminal:
```bash
polkadot --dev
```
You can muck around by cloning and building the http://github.com/paritytech/polka-ui and http://github.com/paritytech/polkadot-ui or just heading to https://polkadot.js.org/apps.
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
joe petrowski