Skip to content

Commit b6bfc95

Browse files
committed
Move node-template up a folder
1 parent 22fc495 commit b6bfc95

File tree

15 files changed

+69
-95
lines changed

15 files changed

+69
-95
lines changed
File renamed without changes.
File renamed without changes.

README.md

Lines changed: 69 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,70 @@
1-
# substrate-node-template
1+
# Substrate Node Template
2+
23
A new SRML-based Substrate node, ready for hacking.
4+
5+
## Build
6+
7+
Install Rust:
8+
9+
```bash
10+
curl https://sh.rustup.rs -sSf | sh
11+
```
12+
13+
Install required tools:
14+
15+
```bash
16+
./scripts/init.sh
17+
```
18+
19+
Build Wasm and native code:
20+
21+
```bash
22+
cargo build
23+
```
24+
25+
## Run
26+
27+
### Single node development chain
28+
29+
You can start a development chain with:
30+
31+
```bash
32+
cargo run -- --dev
33+
```
34+
35+
Detailed logs may be shown by running the node with the following environment variables set: `RUST_LOG=debug RUST_BACKTRACE=1 cargo run -- --dev`.
36+
37+
### Multi-node local testnet
38+
39+
If you want to see the multi-node consensus algorithm in action locally, then you can create a local testnet with two validator nodes for Alice and Bob, who are the initial authorities of the genesis chain that have been endowed with testnet units.
40+
41+
Optionally, give each node a name and expose them so they are listed on the Polkadot [telemetry site](https://telemetry.polkadot.io/#/Local%20Testnet).
42+
43+
You'll need two terminal windows open.
44+
45+
We'll start Alice's substrate node first on default TCP port 30333 with her chain database stored locally at `/tmp/alice`. The bootnode ID of her node is `QmRpheLN4JWdAnY7HGJfWFNbfkQCb6tFf4vvA6hgjMZKrR`, which is generated from the `--node-key` value that we specify below:
46+
47+
```bash
48+
cargo run -- \
49+
--base-path /tmp/alice \
50+
--chain=local \
51+
--alice \
52+
--node-key 0000000000000000000000000000000000000000000000000000000000000001 \
53+
--telemetry-url ws://telemetry.polkadot.io:1024 \
54+
--validator
55+
```
56+
57+
In the second terminal, we'll start Bob's substrate node on a different TCP port of 30334, and with his chain database stored locally at `/tmp/bob`. We'll specify a value for the `--bootnodes` option that will connect his node to Alice's bootnode ID on TCP port 30333:
58+
59+
```bash
60+
cargo run -- \
61+
--base-path /tmp/bob \
62+
--bootnodes /ip4/127.0.0.1/tcp/30333/p2p/QmRpheLN4JWdAnY7HGJfWFNbfkQCb6tFf4vvA6hgjMZKrR \
63+
--chain=local \
64+
--bob \
65+
--port 30334 \
66+
--telemetry-url ws://telemetry.polkadot.io:1024 \
67+
--validator
68+
```
69+
70+
Additional CLI usage options are available and may be shown by running `cargo run -- --help`.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)