Released version: 0.6.1
Developed version: 0.6.2
Ensure you have llvm
and clang
installed. On Ubuntu:
apt install -y llvm clang
Setup instructions for working with the Rust programming language can
be found at the
Substrate Developer Hub. Follow those
steps to install rustup
and configure the Rust toolchain to default to the
latest stable version.
Install Rust:
curl https://sh.rustup.rs -sSf | sh
This project uses a Makefile to document helpful commands and make it easier to execute
them. Get started by running these make
targets:
Install required tools:
make init
Build all native code:
make build
Once the project has been built, the following command can be used to explore all parameters and subcommands:
./target/release/minterest -h
The make run
command will launch the single-node development chain with persistent state. After the project has been built, there are other ways to launch the node.
This command will start the single-node development chain with persistent state:
./target/release/minterest --dev
This command will launch a temporary node and its state will be discarded after you terminate the process:
./target/release/minterest --dev --tmp
Start the development chain with detailed logging:
RUST_LOG=debug RUST_BACKTRACE=1 ./target/release/minterest -lruntime=debug --dev
To run parachain node you will need:
- At least 2 running relay nodes (Polkadot)
- At least 1 collator node and 1 normal node
For step-by-step instruction consult with scripts/README.md.
To type check:
make check
To purge old chain data:
make purge
To purge old chain data and run
make restart
A great description of the weights system lies here.
- Make sure to write or update benchmark tests. They should follow the longest and most read/write heavy path in the tested transaction to mark the maximum possible transaction weight. The tests are in runtime/src/benchmarking
- Build the app with
cargo build --release --features runtime-benchmarks
. - Take the command, commented in the pallet related weights.rs file and execute it. The weights should be updated.
This repo supports versioning system organized in the next way:
-
Patch version (0.5.1, 0.5.2) represents patch level for bugfixes, currently developing features and intermediate tags.
-
Minor version (0.5.0, 0.6.0) represents features developed and released.
-
Major version (1.0.0, 2.0.0) represents release of a scope of features within a stable build which is ready for production.
The project has latest cut version in Cargo.toml file in the project root. This means that current version in development is later then the one in Cargo.toml
To form a release, follow the steps:
- Update Cargo.toml in the project root and all internal pallets. The versions should be the same across the files.
- Commit the changes as a separate MR.
- Tag this commit with the same version.