Skip to content
Polkadot Node Implementation
Branch: master
Clone or download
rphmeier strip out all ICMP network code and begin gossip refactor for attesta…
…tions (#256)

* strip out all ICMP code and begin gossip refactor

* validate incoming statements

* message_allowed logic

* compiles

* do reporting and neighbor packet validation

* tests compile

* propagate gossip messages

* test message_allowed

* some more tests

* address grumbles
Latest commit 502205d May 17, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
availability-store redirect to polkadot-master updated (#261) May 17, 2019
ci Bring runtime API up to date with Substrate master (#17) Sep 12, 2018
cli Bump version to v0.5 (#262) May 17, 2019
collator strip out all ICMP network code and begin gossip refactor for attesta… May 17, 2019
doc Limiting Resources (#189) Mar 29, 2019
docker Add docker resources Sep 10, 2018
erasure-coding redirect to polkadot-master updated (#261) May 17, 2019
executor redirect to polkadot-master updated (#261) May 17, 2019
network strip out all ICMP network code and begin gossip refactor for attesta… May 17, 2019
parachain update substrate (#259) May 15, 2019
primitives redirect to polkadot-master updated (#261) May 17, 2019
runtime Bump version to v0.5 (#262) May 17, 2019
scripts WIP: ci uses new docker image (#236) May 2, 2019
service strip out all ICMP network code and begin gossip refactor for attesta… May 17, 2019
src Collators get incoming parachain messages (#149) Mar 21, 2019
statement-table
test-parachains redirect to polkadot-master updated (#261) May 17, 2019
validation strip out all ICMP network code and begin gossip refactor for attesta… May 17, 2019
.dockerignore Add docker resources Sep 10, 2018
.editorconfig Add same .editorconfig than Substrate Sep 10, 2018
.gitignore Remove runtime (again) May 15, 2019
.gitlab-ci.yml WIP: ci uses new docker image (#236) May 2, 2019
.travis.yml remove WASM publish step Aug 15, 2018
CODE_OF_CONDUCT.adoc Bring to Polkadot the doc removed from the Substrate repo (#16) Sep 12, 2018
CONTRIBUTING.adoc Bring to Polkadot the doc removed from the Substrate repo (#16) Sep 12, 2018
Cargo.lock strip out all ICMP network code and begin gossip refactor for attesta… May 17, 2019
Cargo.toml Bump version to v0.5 (#262) May 17, 2019
Dockerfile move over some files Aug 14, 2018
LICENSE move over some files Aug 14, 2018
README.adoc Update Readme to use the init.sh script (#243) May 15, 2019
build.rs Cleaning up dependencies (#125) Feb 8, 2019
license_header.txt move over some files Aug 14, 2018

README.adoc

Polkadot

Implementation of a https://polkadot.network node in Rust.

1. NOTE

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 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 play on the ("Alexander") testnet, you’ll want the PoC-4 code which is in this Polkadot repo. Note that PoC-3 uses the Alexander testnet, but will not be able to sync to the latest block.

  • Polkadot PoC-4 "Alexander" is in this Polkadotrepo branch v0.4

  • Polkadot PoC-3 "Alexander" is in this Polkadotrepo branch v0.3

  • Polkadot PoC-2 "Krumme Lanke" is in the Substrate repo branch v0.2

2. To play

2.1. Install Rust

If you’d like to play with Polkadot, you’ll need to install a client like this one. First, get Rust (1.32.0 or later) and the support software if you don’t already have it:

curl https://sh.rustup.rs -sSf | sh
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:

rustup update

2.2. Install PoC-4 on "Alexander" Testnet

Build Polkadot PoC-4 by cloning this repository and running the following commands from the root directory of the repo:

git checkout v0.4
./scripts/init.sh
./scripts/build.sh
cargo build --release

If you were previously running PoC-3 on this testnet, you may need to purge your chain data first:

./target/release/polkadot purge-chain

Finally, connect to the global "Alexander" testnet by default by running:

./target/release/polkadot

2.3. Install PoC-3 "Alexander" Testnet

Note: Connecting to the current Alexander testnet with this version will not allow synchronization.

Install Polkadot PoC-3 and have a polkadot binary installed to your PATH with:

cargo install --git https://github.com/paritytech/polkadot.git --branch v0.3 polkadot

Connect to the global "Alexander" testnet by default by running:

polkadot

2.4. Install PoC-2 "Krumme Lanke" Testnet

Install Polkadot PoC-2 and have a polkadot binary installed to your PATH with:

cargo install --git https://github.com/paritytech/substrate.git --branch v0.2 polkadot

Connect to the global "Krumme Lanke" testnet by default by running:

polkadot

2.5. Install a custom Testnet version

You can run the following to get the very latest version of Polkadot, but these instructions will not work in that case.

cargo install --git https://github.com/paritytech/polkadot.git polkadot

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

2.6. Obtaining DOTs

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/ ).

2.7. Development

You can run a simple single-node development "network" on your machine by running in a terminal:

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.

3. Building

3.1. 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:

curl https://sh.rustup.rs -sSf | sh
sudo apt install cmake pkg-config libssl-dev git clang

Then, grab the Polkadot source code:

git clone https://github.com/paritytech/polkadot.git
cd polkadot

Then build the code:

./scripts/init.sh   # Install WebAssembly. Update Rust
./scripts/build.sh  # Builds the WebAssembly binaries
cargo build # Builds all native code

You can run the tests if you like:

cargo test --all

You can start a development chain with:

cargo run -- --dev

Detailed logs may be shown by running the node with the following environment variables set:

RUST_LOG=debug RUST_BACKTRACE=1 cargo run —- --dev

3.2. 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:

polkadot --chain=local --validator --key Alice -d /tmp/alice

And in the other, run:

polkadot --chain=local --validator --key 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.

3.3. Using Docker

3.4. Shell Completion

3.5. Polkadot Networks

4. Contributing

4.1. Contributing Guidelines

4.2. Contributor Code of Conduct

5. License

You can’t perform that action at this time.