Skip to content

Latest commit

 

History

History
179 lines (122 loc) · 6.81 KB

README.md

File metadata and controls

179 lines (122 loc) · 6.81 KB
Raw

Dock Blockchain Node

Rust Docs. Javascript Client.

The dock blockchain serves as registry for Decentralized Identifiers and for revocations of Verifiable Credentials.

Quickstart

Docker can be used to quickly spin up a node (may require sudo):

docker run -p 9944:9944 -p 30333:30333 docknetwork/dock-substrate:mainnet --chain ./cspec/knox_raw.json --ws-external --enable-offchain-indexing=true
             |            |                       |                         |                              |                        |
             |     Expose p2p port                |                 Join the mainnet                       |                        |
             |                                    |                                                        |                        |
    Expose websocket port          Use the node image from dockerhub                     Listen for rpc over websocket   Enables off-chain indexing

The above command will run a mainnet node. To run a testnet node, use the chainspec knox_test_raw.json in place of knox_raw.json and image docknetwork/dock-substrate:testnet in place of docknetwork/dock-substrate:mainnet in the above command.

To view possible command line arguments:

docker run docknetwork/dock-substrate --help

Build

To build the node executable yourself, you'll need to install the following dependencies.

# Install Rust.
curl https://sh.rustup.rs -sSf | sh

# Ensure rust nightly version pinned by ./rust-toolchain is installed.
rustup update nightly

# Install the wasm32-unknown-unknown target for the rust version pinned by ./rust-toolchain.
rustup target add wasm32-unknown-unknown --toolchain nightly

The project is known to build with cargo 1.62.1 and rust 1.62.1. Upgrade to these versions or higher if unable to build

Now you can build the node binary.

cargo build --release --features wasmtime

Above command will build a node with ss58 prefix 42 which is for dev nodes. To build node for testnet or mainnet, use the features testnet and mainnet respectively as below

cargo build --release --features testnet,wasmtime

The spec_name with the above command will be dock-pos-test-runtime and ss58 prefix will be 21.

cargo build --release --features mainnet,wasmtime

The spec_name with the above command will be dock-pos-main-runtime and ss58 prefix will be 22.

Running without any features will result in spec_name of dock-dev-runtime

When building a node to run in the network, it's recommended to build with production profile rather than --release like this

cargo build --profile=production

This will put the dock-node binary in target/production

You can add the above features to it. For testnet

cargo build --profile=production --features testnet,wasmtime

For mainnet

cargo build --profile=production --features mainnet,wasmtime

Building a node for testing staking, governance

Testing staking, elections, governance, etc capabilities requires quite some time as the duration of corresponding operations varies between a few hours to few days. Eg. an epoch is 3 hours long, era is 12 hours long, it takes 7 days to unbond, a new referendum is launched every 20 days, voting lasts for 15 days, and so on. To test these features in a reasonable time, these durations need to be small. Such a node can be built by using feature small_durations as shown below. This feature can be combined with feature testnet or mainnet.

cargo build --release --features small_durations

Building a node for faster block production

For testing with SDK, faster block production is needed, i.e. < 1sec. Use the fastblock feature to achieve that.

cargo build --release --features fastblock

Building Docker image

To build image for testnet node, run the following from the repository's root

docker build --build-arg features='--features testnet,wasmtime' .

To build image for mainnet node, run the following from the repository's root

docker build --build-arg features='--features mainnet,wasmtime' .

The above commands will build the production profile which tradeoffs build time for performance. For slightly better build time, you can build the node in release mode as following

docker build --build-arg release=Y --build-arg features='--features testnet,wasmtime' .

Building chain spec

To build chain spec, use the build-spec command as shown below. The below commands show the spec being built for testnet (defined in load_spec of Cli) chain spec. Always use the raw chainspec (knox_test_raw) to run the chain

./target/release/dock-node build-spec --chain=testnet > knox_test.json
./target/release/dock-node build-spec --chain=knox_test.json --raw > knox_test_raw.json

See CONTRIBUTING.md for contribution guidelines.

Releases

The testnet and mainnet codebases are tagged as testnet and mainnet respectively. On the releases page, you will only find mainnet releases. Similarly, the docker images corresponding to testnet and mainnet are tagged as testnet and mainnet respectively, and you can find pull them as docker pull docknetwork/dock-substrate:testnet or docker pull docknetwork/dock-substrate:mainnet

Recipes

# Build and run unit tests.
cargo test --all

# Build and run a node in local development node for testing.
cargo run -- --dev

# Clear chain state after running the local development node.
cargo run -- purge-chain --dev

# View available command line options.
cargo run -- --help

# Incase block finalisation stalls for some reason, exporting the blocks, purging the chain and importing the blocks fixes it
# Make sure node is stopped before running followig commands. The `pruning mode` is by default `archive`

# Export blocks to file blocks.bin
./target/<debug or release>/dock-node export-blocks --binary --chain=<chain spec> --base-path=<data directory of the node> [--pruning=<pruning mode>] blocks.bin

# Purge chain
./target/<debug or release>/dock-node purge-chain --chain=<chain spec> --base-path=<data directory of the node>

# Import blocks from file blocks.bin
./target/<debug or release>/dock-node import-blocks --binary --chain=<chain spec> --base-path=<data directory of the node> [--pruning=<pruning mode>] blocks.bin

Polkadot-js UI

The polkadot-js UI UI can be used to interact with the dock network through a locally running node. Some custom types will need to be specified in the Settings > Developer section of the UI. The definitions for these types can currently be found in the types.json file.