README.md

Joystream-Node - full node/validator

The joystream-node is the main server application that connects to the network, synchronizes the blockchain with other nodes and produces blocks if configured as a validator node.

A step by step guide to setup a full node and validator on the Joystream testnet, can be found here.

Pre-built binaries

The latest pre-built binaries can be downloaded from the releases page. Generally these will be built from master branch and will pertain to the currently active testnet.

Building from source

Clone the repository and install build tools:

git clone https://github.com/Joystream/joystream.git

cd joystream/

./setup.sh

Compile the node and runtime:

cargo build --release

This produces the binary in ./target/release/joystream-node

Running local development chain

cargo run --release -- --dev

If you repeatedly need to restart a new chain, this script will build and run a fresh new local development chain (purging existing chain data):

./scripts/run-dev-chain.sh

Joystream Public Testnets

Use the --chain argument, and specify the path to the genesis chain.json file for that public network. The JSON "chain spec" files for Joystream public networks can be found in ../testnets/.

cargo run --release -- --chain testnets/rome.json

Tests and code quality

Running unit tests:

cargo test --all

Running full suite of checks, tests, formatting and linting:

yarn cargo-checks

Always format your rust code with cargo fmt before committing:

cargo fmt --all

Integration tests

./scripts/run-test-chain.sh
yarn workspace joystream-testing test

To run the integration tests with a different chain, you can omit the step of running the local development chain and simply set the node URL using NODE_URL environment variable.

Installing a release build

If you are building a tagged release from master branch and want to install the executable to your path follow the step below.

This will install the executable joystream-node to your ~/.cargo/bin folder, which you would normally have in your $PATH environment.

cargo install joystream-node --path node/

Now you can run and connect to the Rome testnet:

joystream-node --chain testnets/rome.json