mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-05-06 19:38:02 +00:00
Update Node Template (#10710)
* update node template from downsteam template version = 4.0.0-dev rust setup updated * Update bin/node-template/runtime/Cargo.toml Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> * Review Rust setup README * Apply suggestions from code review Co-authored-by: Shawn Tabrizi <shawntabrizi@gmail.com> Co-authored-by: Sacha Lansky <sacha@parity.io>
This commit is contained in:
Dan Shields
Generated
+3
-3
@@ -4858,7 +4858,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "node-template"
|
||||
version = "3.0.0"
|
||||
version = "4.0.0-dev"
|
||||
dependencies = [
|
||||
"clap 3.0.7",
|
||||
"frame-benchmarking",
|
||||
@@ -4895,7 +4895,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "node-template-runtime"
|
||||
version = "3.0.0"
|
||||
version = "4.0.0-dev"
|
||||
dependencies = [
|
||||
"frame-benchmarking",
|
||||
"frame-executive",
|
||||
@@ -6200,7 +6200,7 @@ dependencies = [
|
||||
|
||||
[[package]]
|
||||
name = "pallet-template"
|
||||
version = "3.0.0"
|
||||
version = "4.0.0-dev"
|
||||
dependencies = [
|
||||
"frame-benchmarking",
|
||||
"frame-support",
|
||||
|
||||
@@ -72,20 +72,20 @@ Start the development chain with detailed logging:
|
||||
```bash
|
||||
RUST_BACKTRACE=1 ./target/release/node-template -ldebug --dev
|
||||
```
|
||||
|
||||
> Development chain means that the state of our chain will be in a tmp folder while the nodes are
|
||||
> running. Also, **alice** account will be authority and sudo account as declared in the [genesis
|
||||
> state](https://github.com/substrate-developer-hub/substrate-node-template/blob/main/node/src/chain_spec.rs#L49).
|
||||
> At the same time the following accounts will be prefunded:
|
||||
> running. Also, **alice** account will be authority and sudo account as declared in the
|
||||
> [genesis state](https://github.com/substrate-developer-hub/substrate-node-template/blob/main/node/src/chain_spec.rs#L49).
|
||||
> At the same time the following accounts will be pre-funded:
|
||||
> - Alice
|
||||
> - Bob
|
||||
> - Alice//stash
|
||||
> - Bob//stash
|
||||
|
||||
In case of being interested in maintaining the chain' state futher in time a base path other than
|
||||
a temporary directory must be added so the db can be stored in the provided folder. We could use
|
||||
this folder to store different chain databases, as a different folder will be created per different
|
||||
chain that is ran. The following commands shows how to use a newly created folder as our db base
|
||||
path.
|
||||
In case of being interested in maintaining the chain' state between runs a base path must be added
|
||||
so the db can be stored in the provided folder instead of a temporal one. We could use this folder
|
||||
to store different chain databases, as a different folder will be created per different chain that
|
||||
is ran. The following commands shows how to use a newly created folder as our db base path.
|
||||
|
||||
```bash
|
||||
// Create a folder to use as the db base path
|
||||
@@ -103,6 +103,7 @@ $ ls ./my-chain-state/chains/dev
|
||||
db keystore network
|
||||
```
|
||||
|
||||
|
||||
### Connect with Polkadot-JS Apps Front-end
|
||||
|
||||
Once the node template is running locally, you can connect it with **Polkadot-JS Apps** front-end
|
||||
|
||||
@@ -2,32 +2,21 @@
|
||||
title: Installation
|
||||
---
|
||||
|
||||
This page will guide you through the steps needed to prepare a computer for development with the
|
||||
Substrate Node Template. Since Substrate is built with
|
||||
[the Rust programming language](https://www.rust-lang.org/), the first thing you will need to do is
|
||||
prepare the computer for Rust development - these steps will vary based on the computer's operating
|
||||
system. Once Rust is configured, you will use its toolchains to interact with Rust projects; the
|
||||
commands for Rust's toolchains will be the same for all supported, Unix-based operating systems.
|
||||
This guide is for reference only, please check the latest information on getting starting with Substrate
|
||||
[here](https://docs.substrate.io/v3/getting-started/installation/).
|
||||
|
||||
## Unix-Based Operating Systems
|
||||
This page will guide you through the **2 steps** needed to prepare a computer for **Substrate** development.
|
||||
Since Substrate is built with [the Rust programming language](https://www.rust-lang.org/), the first
|
||||
thing you will need to do is prepare the computer for Rust development - these steps will vary based
|
||||
on the computer's operating system. Once Rust is configured, you will use its toolchains to interact
|
||||
with Rust projects; the commands for Rust's toolchains will be the same for all supported,
|
||||
Unix-based operating systems.
|
||||
|
||||
## Build dependencies
|
||||
|
||||
Substrate development is easiest on Unix-based operating systems like macOS or Linux. The examples
|
||||
in the Substrate [Tutorials](https://docs.substrate.io/tutorials/v3) and
|
||||
[How-to Guides](https://docs.substrate.io/how-to-guides/v3) use Unix-style terminals to demonstrate
|
||||
how to interact with Substrate from the command line.
|
||||
|
||||
### macOS
|
||||
|
||||
Open the Terminal application and execute the following commands:
|
||||
|
||||
```bash
|
||||
# Install Homebrew if necessary https://brew.sh/
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
||||
|
||||
# Make sure Homebrew is up-to-date, install openssl and cmake
|
||||
brew update
|
||||
brew install openssl cmake
|
||||
```
|
||||
in the [Substrate Docs](https://docs.substrate.io) use Unix-style terminals to demonstrate how to
|
||||
interact with Substrate from the command line.
|
||||
|
||||
### Ubuntu/Debian
|
||||
|
||||
@@ -36,7 +25,7 @@ Use a terminal shell to execute the following commands:
|
||||
```bash
|
||||
sudo apt update
|
||||
# May prompt for location information
|
||||
sudo apt install -y cmake pkg-config libssl-dev git build-essential clang libclang-dev curl
|
||||
sudo apt install -y git clang curl libssl-dev llvm libudev-dev
|
||||
```
|
||||
|
||||
### Arch Linux
|
||||
@@ -44,39 +33,193 @@ sudo apt install -y cmake pkg-config libssl-dev git build-essential clang libcla
|
||||
Run these commands from a terminal:
|
||||
|
||||
```bash
|
||||
pacman -Syu --needed --noconfirm cmake gcc openssl-1.0 pkgconf git clang
|
||||
export OPENSSL_LIB_DIR="/usr/lib/openssl-1.0"
|
||||
export OPENSSL_INCLUDE_DIR="/usr/include/openssl-1.0"
|
||||
pacman -Syu --needed --noconfirm curl git clang
|
||||
```
|
||||
|
||||
### Fedora/RHEL/CentOS
|
||||
### Fedora
|
||||
|
||||
Use a terminal to run the following commands:
|
||||
Run these commands from a terminal:
|
||||
|
||||
```bash
|
||||
# Update
|
||||
sudo dnf update
|
||||
# Install packages
|
||||
sudo dnf install cmake pkgconfig rocksdb rocksdb-devel llvm git libcurl libcurl-devel curl-devel clang
|
||||
sudo dnf install clang curl git openssl-devel
|
||||
```
|
||||
|
||||
## Rust Developer Environment
|
||||
### OpenSUSE
|
||||
|
||||
This project uses [`rustup`](https://rustup.rs/) to help manage the Rust toolchain. First install
|
||||
and configure `rustup`:
|
||||
Run these commands from a terminal:
|
||||
|
||||
```bash
|
||||
sudo zypper install clang curl git openssl-devel llvm-devel libudev-devel
|
||||
```
|
||||
|
||||
### macOS
|
||||
|
||||
> **Apple M1 ARM**
|
||||
> If you have an Apple M1 ARM system on a chip, make sure that you have Apple Rosetta 2
|
||||
> installed through `softwareupdate --install-rosetta`. This is only needed to run the
|
||||
> `protoc` tool during the build. The build itself and the target binaries would remain native.
|
||||
|
||||
Open the Terminal application and execute the following commands:
|
||||
|
||||
```bash
|
||||
# Install Homebrew if necessary https://brew.sh/
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install.sh)"
|
||||
|
||||
# Make sure Homebrew is up-to-date, install openssl
|
||||
brew update
|
||||
brew install openssl
|
||||
```
|
||||
|
||||
### Windows
|
||||
|
||||
**_PLEASE NOTE:_** Native development of Substrate is _not_ very well supported! It is _highly_
|
||||
recommend to use [Windows Subsystem Linux](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
|
||||
(WSL) and follow the instructions for [Ubuntu/Debian](#ubuntudebian).
|
||||
Please refer to the separate
|
||||
[guide for native Windows development](https://docs.substrate.io/v3/getting-started/windows-users/).
|
||||
|
||||
## Rust developer environment
|
||||
|
||||
This guide uses <https://rustup.rs> installer and the `rustup` tool to manage the Rust toolchain.
|
||||
First install and configure `rustup`:
|
||||
|
||||
```bash
|
||||
# Install
|
||||
curl https://sh.rustup.rs -sSf | sh
|
||||
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
|
||||
# Configure
|
||||
source ~/.cargo/env
|
||||
```
|
||||
|
||||
Finally, configure the Rust toolchain:
|
||||
Configure the Rust toolchain to default to the latest stable version, add nightly and the nightly wasm target:
|
||||
|
||||
```bash
|
||||
rustup default stable
|
||||
rustup update
|
||||
rustup update nightly
|
||||
rustup update stable
|
||||
rustup target add wasm32-unknown-unknown --toolchain nightly
|
||||
```
|
||||
|
||||
## Test your set-up
|
||||
|
||||
Now the best way to ensure that you have successfully prepared a computer for Substrate
|
||||
development is to follow the steps in [our first Substrate tutorial](https://docs.substrate.io/tutorials/v3/create-your-first-substrate-chain/).
|
||||
|
||||
## Troubleshooting Substrate builds
|
||||
|
||||
Sometimes you can't get the Substrate node template
|
||||
to compile out of the box. Here are some tips to help you work through that.
|
||||
|
||||
### Rust configuration check
|
||||
|
||||
To see what Rust toolchain you are presently using, run:
|
||||
|
||||
```bash
|
||||
rustup show
|
||||
```
|
||||
|
||||
This will show something like this (Ubuntu example) output:
|
||||
|
||||
```text
|
||||
Default host: x86_64-unknown-linux-gnu
|
||||
rustup home: /home/user/.rustup
|
||||
|
||||
installed toolchains
|
||||
--------------------
|
||||
|
||||
stable-x86_64-unknown-linux-gnu (default)
|
||||
nightly-2020-10-06-x86_64-unknown-linux-gnu
|
||||
nightly-x86_64-unknown-linux-gnu
|
||||
|
||||
installed targets for active toolchain
|
||||
--------------------------------------
|
||||
|
||||
wasm32-unknown-unknown
|
||||
x86_64-unknown-linux-gnu
|
||||
|
||||
active toolchain
|
||||
----------------
|
||||
|
||||
stable-x86_64-unknown-linux-gnu (default)
|
||||
rustc 1.50.0 (cb75ad5db 2021-02-10)
|
||||
```
|
||||
|
||||
As you can see above, the default toolchain is stable, and the
|
||||
`nightly-x86_64-unknown-linux-gnu` toolchain as well as its `wasm32-unknown-unknown` target is installed.
|
||||
You also see that `nightly-2020-10-06-x86_64-unknown-linux-gnu` is installed, but is not used unless explicitly defined as illustrated in the [specify your nightly version](#specifying-nightly-version)
|
||||
section.
|
||||
|
||||
### WebAssembly compilation
|
||||
|
||||
Substrate uses [WebAssembly](https://webassembly.org) (Wasm) to produce portable blockchain
|
||||
runtimes. You will need to configure your Rust compiler to use
|
||||
[`nightly` builds](https://doc.rust-lang.org/book/appendix-07-nightly-rust.html) to allow you to
|
||||
compile Substrate runtime code to the Wasm target.
|
||||
|
||||
> There are upstream issues in Rust that need to be resolved before all of Substrate can use the stable Rust toolchain.
|
||||
> [This is our tracking issue](https://github.com/paritytech/substrate/issues/1252) if you're curious as to why and how this will be resolved.
|
||||
|
||||
#### Latest nightly for Substrate `master`
|
||||
|
||||
Developers who are building Substrate _itself_ should always use the latest bug-free versions of
|
||||
Rust stable and nightly. This is because the Substrate codebase follows the tip of Rust nightly,
|
||||
which means that changes in Substrate often depend on upstream changes in the Rust nightly compiler.
|
||||
To ensure your Rust compiler is always up to date, you should run:
|
||||
|
||||
```bash
|
||||
rustup update
|
||||
rustup update nightly
|
||||
rustup target add wasm32-unknown-unknown --toolchain nightly
|
||||
```
|
||||
|
||||
> NOTE: It may be necessary to occasionally rerun `rustup update` if a change in the upstream Substrate
|
||||
> codebase depends on a new feature of the Rust compiler. When you do this, both your nightly
|
||||
> and stable toolchains will be pulled to the most recent release, and for nightly, it is
|
||||
> generally _not_ expected to compile WASM without error (although it very often does).
|
||||
> Be sure to [specify your nightly version](#specifying-nightly-version) if you get WASM build errors
|
||||
> from `rustup` and [downgrade nightly as needed](#downgrading-rust-nightly).
|
||||
|
||||
#### Rust nightly toolchain
|
||||
|
||||
If you want to guarantee that your build works on your computer as you update Rust and other
|
||||
dependencies, you should use a specific Rust nightly version that is known to be
|
||||
compatible with the version of Substrate they are using; this version will vary from project to
|
||||
project and different projects may use different mechanisms to communicate this version to
|
||||
developers. For instance, the Polkadot client specifies this information in its
|
||||
[release notes](https://github.com/paritytech/polkadot/releases).
|
||||
|
||||
```bash
|
||||
# Specify the specific nightly toolchain in the date below:
|
||||
rustup install nightly-<yyyy-MM-dd>
|
||||
```
|
||||
|
||||
#### Wasm toolchain
|
||||
|
||||
Now, configure the nightly version to work with the Wasm compilation target:
|
||||
|
||||
```bash
|
||||
rustup target add wasm32-unknown-unknown --toolchain nightly-<yyyy-MM-dd>
|
||||
```
|
||||
|
||||
### Specifying nightly version
|
||||
|
||||
Use the `WASM_BUILD_TOOLCHAIN` environment variable to specify the Rust nightly version a Substrate
|
||||
project should use for Wasm compilation:
|
||||
|
||||
```bash
|
||||
WASM_BUILD_TOOLCHAIN=nightly-<yyyy-MM-dd> cargo build --release
|
||||
```
|
||||
|
||||
> Note that this only builds _the runtime_ with the specified nightly. The rest of project will be
|
||||
> compiled with **your default toolchain**, i.e. the latest installed stable toolchain.
|
||||
|
||||
### Downgrading Rust nightly
|
||||
|
||||
If your computer is configured to use the latest Rust nightly and you would like to downgrade to a
|
||||
specific nightly version, follow these steps:
|
||||
|
||||
```bash
|
||||
rustup uninstall nightly
|
||||
rustup install nightly-<yyyy-MM-dd>
|
||||
rustup target add wasm32-unknown-unknown --toolchain nightly-<yyyy-MM-dd>
|
||||
```
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "node-template"
|
||||
version = "3.0.0"
|
||||
version = "4.0.0-dev"
|
||||
description = "A fresh FRAME-based Substrate node, ready for hacking."
|
||||
authors = ["Substrate DevHub <https://github.com/substrate-developer-hub>"]
|
||||
homepage = "https://substrate.io/"
|
||||
@@ -52,7 +52,8 @@ pallet-transaction-payment-rpc = { version = "4.0.0-dev", path = "../../../frame
|
||||
frame-benchmarking = { version = "4.0.0-dev", path = "../../../frame/benchmarking" }
|
||||
frame-benchmarking-cli = { version = "4.0.0-dev", path = "../../../utils/frame/benchmarking-cli" }
|
||||
|
||||
node-template-runtime = { version = "3.0.0", path = "../runtime" }
|
||||
# Local Dependencies
|
||||
node-template-runtime = { version = "4.0.0-dev", path = "../runtime" }
|
||||
|
||||
[build-dependencies]
|
||||
substrate-build-script-utils = { version = "3.0.0", path = "../../../utils/build-script-utils" }
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
[package]
|
||||
name = "pallet-template"
|
||||
version = "3.0.0"
|
||||
version = "4.0.0-dev"
|
||||
description = "FRAME pallet template for defining custom runtime logic."
|
||||
authors = ["Substrate DevHub <https://github.com/substrate-developer-hub>"]
|
||||
homepage = "https://substrate.io/"
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
[package]
|
||||
name = "node-template-runtime"
|
||||
version = "3.0.0"
|
||||
description = "A fresh FRAME-based Substrate runtime, ready for hacking."
|
||||
version = "4.0.0-dev"
|
||||
description = "A fresh FRAME-based Substrate node, ready for hacking."
|
||||
authors = ["Substrate DevHub <https://github.com/substrate-developer-hub>"]
|
||||
homepage = "https://substrate.io/"
|
||||
edition = "2021"
|
||||
@@ -27,10 +27,10 @@ pallet-timestamp = { version = "4.0.0-dev", default-features = false, path = "..
|
||||
pallet-transaction-payment = { version = "4.0.0-dev", default-features = false, path = "../../../frame/transaction-payment" }
|
||||
frame-executive = { version = "4.0.0-dev", default-features = false, path = "../../../frame/executive" }
|
||||
sp-api = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/api" }
|
||||
sp-block-builder = { path = "../../../primitives/block-builder", default-features = false, version = "4.0.0-dev"}
|
||||
sp-block-builder = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/block-builder"}
|
||||
sp-consensus-aura = { version = "0.10.0-dev", default-features = false, path = "../../../primitives/consensus/aura" }
|
||||
sp-core = { version = "4.1.0-dev", default-features = false, path = "../../../primitives/core" }
|
||||
sp-inherents = { path = "../../../primitives/inherents", default-features = false, version = "4.0.0-dev"}
|
||||
sp-inherents = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/inherents"}
|
||||
sp-offchain = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/offchain" }
|
||||
sp-runtime = { version = "4.1.0-dev", default-features = false, path = "../../../primitives/runtime" }
|
||||
sp-session = { version = "4.0.0-dev", default-features = false, path = "../../../primitives/session" }
|
||||
@@ -47,7 +47,8 @@ frame-benchmarking = { version = "4.0.0-dev", default-features = false, path = "
|
||||
frame-system-benchmarking = { version = "4.0.0-dev", default-features = false, path = "../../../frame/system/benchmarking", optional = true }
|
||||
hex-literal = { version = "0.3.4", optional = true }
|
||||
|
||||
pallet-template = { version = "3.0.0", default-features = false, path = "../pallets/template" }
|
||||
# Local Dependencies
|
||||
pallet-template = { version = "4.0.0-dev", default-features = false, path = "../pallets/template" }
|
||||
|
||||
[build-dependencies]
|
||||
substrate-wasm-builder = { version = "5.0.0-dev", path = "../../../utils/wasm-builder" }
|
||||
|
||||
Reference in New Issue
Block a user