Skip to content

Latest commit

 

History

History
221 lines (158 loc) · 6.22 KB

getting-started.md

File metadata and controls

221 lines (158 loc) · 6.22 KB
Raw

Getting Started

Follow the steps below to get started with Madara 🛠️

Rust Setup

First, Install rust using the rustup toolchain installer, then run:

rustup show

Cargo Run

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

cargo run --release -- setup
cargo run --release -- run --dev

The node also supports to use manual seal (to produce block manually through RPC). This is also used by the typescript tests:

$ cargo run --release -- run --dev --sealing=manual
# Or
$ cargo run --release -- run --dev --sealing=instant

Log level can be specified with -l flag. For example, -ldebug will show debug logs. It can also be specified via the RUST_LOG environment variable. For example:

RUSTLOG=runtime=info cargo run --release -- run --dev

Cargo Build

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

cargo build --release

You can optionally specify the compiler version for the build:

COMPILER_VERSION=0.12.0 cargo build --release

Using Nix (optional, only for degens)

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.

Embedded Docs

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

./target/release/madara -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/madara setup
./target/release/madara run --dev

Purge the development chain's state:

./target/release/madara purge-chain --dev

Start the development chain with detailed logging:

RUST_BACKTRACE=1 ./target/release/madara run -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 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.

// 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/madara run --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.

Multi-Node Local Testnet

Build custom chain spec:

# Build plain chain spec
cargo run --release -- build-spec --chain local > chain-specs/madara-local-testnet-plain.json
# Build final raw chain spec
cargo run --release -- build-spec --chain chain-specs/madara-local-testnet-plain.json --raw > chain-specs/madara-local-testnet.json

See more details about custom chain specs.

Testing Madara RPC Endpoints

To test the Madara RPC endpoints, follow the steps below:

Run Madara locally (by default, it runs on port 9944):

cargo run --release -- --dev
# Alternatively, use other methods to run Madara

Execute hurl tests sequentially:

hurl --variables-file examples/rpc/hurl.config  --test examples/rpc/**/*.hurl

The output should be similar to the image provided:

Hurl Test Output

Set Ethereum Node URL for offchain worker

In order for the offchain worker to access an Ethereum RPC node, we need to set the URL for that in offchain local storage. We can do that by making use of the default offchain rpc calls provided by Substrate.

In the polkadot explorer, navigate to Developer > RPC calls and choose the offchain endpoint. In there, you can set the value for ETHEREUM_EXECUTION_RPC by using the localStorageSet function. You need to select the type of storage, in this case PERSISTENT, and use the starknet::ETHEREUM_EXECUTION_RPC as the key. The value is the RPC URL you intend to use.

You can check that the value was properly set by using the localStorageGet function

Run in Docker

First, install Docker and Docker Compose.

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

docker run --rm [TAG] --dev

This command will firstly compile your code, and then start a local development network. The TAGS are available here.

You can also use the command appending your own options. A few useful ones are as follow.

# Run Substrate node without re-compiling
docker run --rm [TAG] --dev --ws-external

# Purge the local dev chain
docker run --rm [TAG] purge-chain --dev