Commit 3c6f561c authored by Luke Schoen's avatar Luke Schoen Committed by Gav Wood
Browse files

docs: Update Readme to PoC-3 (#64)

* docs: Update Readme for PoC-3

* docs: Fix formatting and update Docker section

* docs: Fix formatting. Start trying to make consistent with Substrate repo

* docs: Move Two-Node example into Hack on Substrate
parent f76c0b10
Pipeline #27927 passed with stages
in 18 minutes and 54 seconds
= Polkadot = Polkadot
:Author: Polkadot developers :Author: Polkadot developers
:Revision: 0.2.0 :Revision: 0.3.0
:toc: :toc:
:sectnums: :sectnums:
...@@ -8,18 +8,24 @@ Implementation of a https://polkadot.network node in Rust. ...@@ -8,18 +8,24 @@ Implementation of a https://polkadot.network node in Rust.
== NOTE == NOTE
We have recently split our implementation of Polkadot from its platform-level component "Substrate". In 2017 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 link:https://github.com/paritytech/substrate[**Substrate** repo] to be what used to be Polkadot, along with its branches and releases.
When we split them, we split the Polkadot code off into another repo, leaving the substrate repo to
be what used to be Polkadot, along with its branches and releases.
Things will be a little odd for a while. Polkadot PoC-2 remains as a branch `v0.2` in the **Substrate** We are actively building both Substrate and Polkadot, but things will be a little odd for a while.
repo. Polkadot PoC-3 *will be* in branch `v0.3` in the **Polkadot** repo. To play on the ("Krumme Lanke")
testnet, you'll want the PoC-2 code which is in the **Substrate** repo. These instructions are up to date To play on the ("Alexander") testnet, you'll want the PoC-3 code which is in this **Polkadot** repo.
with this, but if you see "substrate" and are wondering why you need it for Polkadot, now you know.
* **Polkadot PoC-3 "Alexander"** is in this link:https://github.com/paritytech/polkadot/tree/v0.3[**Polkadot**]repo branch `v0.3`
* **Polkadot PoC-2 "Krumme Lanke"** is in the link:https://github.com/paritytech/substrate/tree/v0.2[**Substrate**] repo branch `v0.2`
If you see "substrate" and are wondering why you need it for Polkadot, now you know.
Note that **Polkadot PoC-4** is yet to be released and *will be* in branch `v0.4` in this **Polkadot** repo.
== To play == To play
=== Install Rust
If you'd like to play with Polkadot, you'll need to install a client like this If you'd like to play with Polkadot, you'll need to install a client like this
one. First, get Rust (1.26.1 or later) and the support software if you don't already have it: one. First, get Rust (1.26.1 or later) and the support software if you don't already have it:
...@@ -29,58 +35,62 @@ curl https://sh.rustup.rs -sSf | sh ...@@ -29,58 +35,62 @@ curl https://sh.rustup.rs -sSf | sh
sudo apt install make clang pkg-config libssl-dev sudo apt install make clang pkg-config libssl-dev
---- ----
Then, install Polkadot PoC-2: === Install PoC-3 "Alexander" Testnet
Install Polkadot PoC-3 and have a `polkadot` binary installed to your `PATH` with:
[source, shell] [source, shell]
cargo install --git https://github.com/paritytech/substrate.git --branch v0.2 polkadot cargo install --git https://github.com/paritytech/polkdot.git --branch v0.3 polkadot
You'll now have a `polkadot` binary installed to your `PATH`. You can run `cargo install --git https://github.com/paritytech/polkadot.git polkadot` to get the very latest version of Polkadot, Connect to the global "Alexander" testnet by default by running:
but these instructions will not work in that case.
If you want a specific version of polkadot, say `0.2.5`, you may run `cargo install --git https://github.com/paritytech/substrate.git --tag v0.2.5 polkadot`. [source, shell]
polkadot
=== Krumme Lanke Testnet === Install PoC-2 "Krumme Lanke" Testnet
You will connect to the global Krumme Lanke testnet by default. To do this, just use: Install Polkadot PoC-2 and have a `polkadot` binary installed to your `PATH` with:
[source, shell] [source, shell]
polkadot cargo install --git https://github.com/paritytech/substrate.git --branch v0.2 polkadot
If you want to do anything on it (not that there's much to do), then you'll need Connect to the global "Krumme Lanke" testnet by default by running:
to get some Krumme Lanke DOTs. Ask in the Polkadot watercooler.
=== Development [source, shell]
polkadot
You can run a simple single-node development "network" on your machine by === Install a custom Testnet version
running in a terminal:
You can run the following to get the very latest version of Polkadot, but these instructions will not work in that case.
[source, shell] [source, shell]
polkadot --dev cargo install --git https://github.com/paritytech/polkadot.git polkadot
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. If you want a specific version of Polkadot, say `0.2.5`, you may run
[source, shell]
cargo install --git https://github.com/paritytech/substrate.git --tag v0.2.5 polkadot
== Local Two-node Testnet === Obtaining DOTs
If you want to see the multi-node consensus algorithm in action locally, then 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.
you can create a local testnet. You'll need two terminals open. In one, run:
[source, shell] === Development
polkadot --chain=local --validator --key Alice -d /tmp/alice
and in the other, run: You can run a simple single-node development "network" on your machine by
running in a terminal:
[source, shell] [source, shell]
polkadot --chain=local --validator --key Bob -d /tmp/bob --port 30334 --bootnodes '/ip4/127.0.0.1/tcp/30333/p2p/ALICE_BOOTNODE_ID_HERE' polkadot --dev
Ensure you replace `ALICE_BOOTNODE_ID_HERE` with the node ID from the output of 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.
the first terminal.
== Hacking on Polkadot == Building
If you'd actually like hack on Polkadot, you can just grab the source code and === Hacking on Polkadot
build it. Ensure you have Rust and the support software installed:
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:
[source, shell] [source, shell]
---- ----
...@@ -118,17 +128,44 @@ You can start a development chain with: ...@@ -118,17 +128,44 @@ You can start a development chain with:
[source, shell] [source, shell]
cargo run -- --dev cargo run -- --dev
include::doc/docker.adoc[] Detailed logs may be shown by running the node with the following environment variables set:
[source, shell]
RUST_LOG=debug RUST_BACKTRACE=1 cargo run —- --dev
=== 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:
include::doc/shell-completion.adoc[] [source, shell]
polkadot --chain=local --validator --key Alice -d /tmp/alice
include::doc/packages.adoc[] And in the other, run:
include::doc/networks/networks.adoc[leveloffset=+1] [source, shell]
polkadot --chain=local --validator --key Bob -d /tmp/bob --port 30334 --bootnodes '/ip4/127.0.0.1/tcp/30333/p2p/ALICE_BOOTNODE_ID_HERE'
include::CONTRIBUTING.adoc[leveloffset=+1] Ensure you replace `ALICE_BOOTNODE_ID_HERE` with the node ID from the output of the first terminal.
=== Using Docker
link:_includes/doc/docker.adoc[Using Docker]
=== Shell Completion
link:_includes/doc/shell-completion.adoc[Shell Completion]
=== Polkadot Networks
link:_includes/doc/networks/networks.adoc[Polkadot Networks]
== Contributing
=== Contributing Guidelines
link:_includes/CONTRIBUTING.adoc[Contribution Guidelines]
=== Contributor Code of Conduct
link:_includes/CODE_OF_CONDUCT.adoc[Code of Conduct]
== License == License
----
include::LICENSE[] https://github.com/paritytech/polkadot/blob/master/LICENSE[LICENSE]
----
== Using Docker
=== The easiest way === The easiest way
The easiest/faster option is to use the latest image. The easiest/faster option is to use the latest image.
...@@ -8,27 +6,37 @@ The easiest/faster option is to use the latest image. ...@@ -8,27 +6,37 @@ The easiest/faster option is to use the latest image.
Let´s first check the version we have. The first time you run this command, the polkadot docker image will be downloaded. This takes a bit of time and bandwidth, be patient: Let´s first check the version we have. The first time you run this command, the polkadot docker image will be downloaded. This takes a bit of time and bandwidth, be patient:
[source, shell] [source, shell]
docker run --rm -it chevdor/polkadot:0.2.0 polkadot --version docker run --rm -it chevdor/polkadot:0.3.0 polkadot --version
You can also pass any argument/flag that polkadot supports: You can also pass any argument/flag that polkadot supports:
[source, shell] [source, shell]
docker run --rm -it chevdor/polkadot:0.2.0 polkadot --name "PolkaDocker" docker run --rm -it chevdor/polkadot:0.3.0 polkadot --name "PolkaDocker"
Once you are done experimenting and picking the best node name :) you can start polkadot as daemon, exposes the polkadot ports and mount a volume that will keep your blockchain data locally: Once you are done experimenting and picking the best node name :) you can start polkadot as daemon, exposes the polkadot ports and mount a volume that will keep your blockchain data locally:
[source, shell] [source, shell]
docker run -d -p 30333:30333 -p 9933:9933 -v /my/local/folder:/data chevdor/polkadot:0.2.0 polkadot docker run -d -p 30333:30333 -p 9933:9933 -v /my/local/folder:/data chevdor/polkadot:0.3.0 polkadot
Start a shell session with the daemon:
[source, shell]
docker exec -it $(docker ps -q) bash;
Check the current version:
[source, shell]
polkadot --version
=== Build your own image === Build your own image
To get up and running with the smallest footprint on your system, you may use the Polkadot Docker image. To get up and running with the smallest footprint on your system, you may use the Polkadot Docker image.
You can either build it yourself (it takes a while...): You can build it yourself (it takes a while...) in the shell session of the daemon:
[source, shell] [source, shell]
---- ----
ccd docker cd docker
./build.sh ./build.sh
---- ----
......
=== Alexander
Alexander is a testnet network used during the developement of PoC-3.
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment