Societal Node

Getting Started

Follow the steps below to get started with the Societal's node.

Using Nix

Install nix and optionally direnv and lorri for a fully plug and play experience for setting up the development environment. To get all the correct dependencies activate direnv direnv allow and lorri lorri shell.

Rust Setup

First, complete the basic Rust setup instructions.

Run

Use Rust's native cargo command to build and launch the node:

cargo run --release -- --dev

Build

The cargo run command will perform an initial build. Use the following command to build the node without launching it:

cargo build --release

Embedded Docs

Once the project has been built, the following command can be used to explore all parameters and subcommands:

./target/release/societal-node -h

Run

The provided cargo run command will launch a temporary node and its state will be discarded after you terminate the process. After the project has been built, there are other ways to launch the node.

Single-Node Development Chain

This command will start the single-node development chain with non-persistent state:

./target/release/societal-node --dev

Purge the development chain's state:

./target/release/societal-node purge-chain --dev

Start the development chain with detailed logging:

RUST_BACKTRACE=1 ./target/release/societal-node -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. 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 between runs a base path must be added so the db can be stored in the provided folder instead of a temporary one. We could use this folder to store different chain databases, as a different folder will be created for each chain that is ran. The following commands shows how to use a newly created folder as our db base path.

// Create a folder to use as the db base path
$ mkdir my-chain-state

// Use of that folder to store the chain state
$ ./target/release/societal-node --dev --base-path ./my-chain-state/

// Check the folder structure created inside the base path after running the chain
$ ls ./my-chain-state
chains
$ ls ./my-chain-state/chains/
dev
$ 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 to interact with your chain. Click here connecting the Apps to your local node template.

Connect with Societal Front-end

Alternativley you can use the Societal's front-end to connect with the local node. Please find the societal front-end repo here. Follow the readme for instructions on how to build and run the front-end.

Societal's Runtime

Review Societal's runtime implementation included in this node. This file configures several pallets that make up Societal's runtime. Each pallet has its own code block that begins with impl $PALLET_NAME::Config for Runtime, which define its configuration settings. Then the pallets are composed into a single runtime by way of the construct_runtime! macro.

Run in Docker

First, install Docker and Docker Compose.

Then run the following command to start a single node development chain.

./scripts/docker_run.sh

This command will firstly compile your code, and then start a local development network. You can also replace the default command (cargo build --release && ./target/release/societal-node --dev --ws-external) by appending your own. A few useful ones are as follow.

# Run Soceital node without re-compiling
./scripts/docker_run.sh ./target/release/societal-node --dev --ws-external

# Purge the local dev chain
./scripts/docker_run.sh ./target/release/societal-node purge-chain --dev

# Check whether the code is compilable
./scripts/docker_run.sh cargo check

Unit Test

To run Unit Tests, execute the following command:

cargo test