Madara

Report a Bug - Request a Feature - Ask a Question

Madara is a ⚡ blazing fast ⚡ Starknet sequencer, based on substrate and written in Rust 🦀.

This README file provides an overview of the Madara project, including its structure, components, and instructions for building, testing and running benchmarks.

Here is a high level overview of the current architecture of Starknet sequencer.

The Madara project consists of the following directories:

• benchmarking: Contains the code for benchmarking the custom FRAME pallets.
• crates: Holds all the crates used by the project, organized into the following subdirectories:
  • node: Implements services for the blockchain node (e.g., chain specification, RPC, etc.).
  • pallets: Contains custom FRAME pallets, including:
    • pallet-starknet: The Starknet pallet.
  • runtime: Assembles Madara's custom logic with the configured pallets.
  • primitives: Stores primitives used by the pallets.
• docs: Contains the project's documentation.
• examples: Provides example implementations for the project.
• infra: Houses infrastructure-related components, such as deployment scripts and Dockerfiles.

Benchmarking allows you to assess the performance of the project's pallets. To run the benchmarks, follow the instructions in the benchmarking document.

pallet-starknet is a pallet that provides a way to execute Starknet contracts in a Substrate environment.

Follow the steps below to get started with Madara 🛠️

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.

First, complete the basic Rust setup instructions.

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

cargo run --release -- --dev

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 -- --dev

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

cargo build --release

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

./target/release/madara -h

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.

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

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

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.

Build custom chain spec:

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

See more details about custom chain specs.

Run the local testnet:

./infra/local-testnet/run.sh

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

A Substrate project such as this consists of a number of components that are spread across a few directories.

A blockchain node is an application that allows users to participate in a blockchain network. Substrate-based blockchain nodes expose a number of capabilities:

• Networking: Substrate nodes use the libp2p networking stack to allow the nodes in the network to communicate with one another.
• Consensus: Blockchains must have a way to come to consensus on the state of the network. Substrate makes it possible to supply custom consensus engines and also ships with several consensus mechanisms that have been built on top of Web3 Foundation research.
• RPC Server: A remote procedure call (RPC) server is used to interact with Substrate nodes.

There are several files in the node directory - take special note of the following:

• chain_spec.rs: A chain specification is a source code file that defines a Substrate chain's initial (genesis) state. Chain specifications are useful for development and testing, and critical when architecting the launch of a production chain. Take note of the development_config and testnet_genesis functions, which are used to define the genesis state for the local development chain configuration. These functions identify some well-known accounts and use them to configure the blockchain's initial state.
• service.rs: This file defines the node implementation. Take note of the libraries that this file imports and the names of the functions it invokes. In particular, there are references to consensus-related topics, such as the block finalization and forks and other consensus mechanisms such as Aura for block authoring and GRANDPA for finality.

After the node has been built, refer to the embedded documentation to learn more about the capabilities and configuration parameters that it exposes:

./target/release/madara --help

In Substrate, the terms "runtime" and "state transition function" are analogous - they refer to the core logic of the blockchain that is responsible for validating blocks and executing the state changes they define. The Substrate project in this repository uses FRAME to construct a blockchain runtime. FRAME allows runtime developers to declare domain-specific logic in modules called "pallets". At the heart of FRAME is a helpful macro language that makes it easy to create pallets and flexibly compose them to create blockchains that can address a variety of needs.

Review the FRAME runtime implementation included in this template and note the following:

• This file configures several pallets to include in the runtime. Each pallet configuration is defined by a code block that begins with impl $PALLET_NAME::Config for Runtime.
• The pallets are composed into a single runtime by way of the construct_runtime! macro, which is part of the core FRAME Support system library.

The runtime in this project is constructed using many FRAME pallets that ship with the core Substrate repository and a template pallet that is defined in the pallets directory.

A FRAME pallet is compromised of a number of blockchain primitives:

• Storage: FRAME defines a rich set of powerful storage abstractions that makes it easy to use Substrate's efficient key-value database to manage the evolving state of a blockchain.
• Dispatchables: FRAME pallets define special types of functions that can be invoked (dispatched) from outside of the runtime in order to update its state.
• Events: Substrate uses events and errors to notify users of important changes in the runtime.
• Errors: When a dispatchable fails, it returns an error.
• Config: The Config configuration interface is used to define the types and parameters upon which a FRAME pallet depends.

First, install Docker and Docker Compose.

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

docker-compose -f infra/docker/docker-compose.yml up -d

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/madara --dev --ws-external) by appending your own. A few useful ones are as follow.

# Run Substrate node without re-compiling
./infra/docker_run.sh ./target/release/madara --dev --ws-external

# Purge the local dev chain
./infra/docker_run.sh ./target/release/madara purge-chain --dev

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

See the open issues for a list of proposed features (and known issues).

• Top Feature Requests (Add your votes using the 👍 reaction)
• Top Bugs (Add your votes using the 👍 reaction)
• Newest Bugs

Reach out to the maintainer at one of the following places:

• GitHub Discussions
• Contact options listed on this GitHub profile

If you want to say thank you or/and support active development of Madara:

• Add a GitHub Star to the project.
• Tweet about the Madara.
• Write interesting articles about the project on Dev.to, Medium or your personal blog.

Together, we can make Madara better!

First off, thanks for taking the time to contribute! Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make will benefit everybody else and are greatly appreciated.

Please read our contribution guidelines, and thank you for being involved!

For a full list of all authors and contributors, see the contributors page.

Madara follows good practices of security, but 100% security cannot be assured. Madara is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

This project is licensed under the MIT license.

See LICENSE for more information.

error: failed to run custom build command for `libp2p-core v0.37.0`

Caused by:
  process didn't exit successfully: `...` (exit status: 101)
  --- stderr
  thread 'main' panicked at 'Could not find `protoc` installation and this build crate cannot proceed without
      this knowledge. If `protoc` is installed and this crate had trouble finding
      it, you can set the `PROTOC` environment variable with the specific path to your
      installed `protoc` binary.You could try running `brew install protobuf` or downloading it from https://github.com/protocolbuffers/protobuf/releases

  For more information: https://docs.rs/prost-build/#sourcing-protoc
  ', /Users/abdel/.cargo/registry/src/github.com-1ecc6299db9ec823/prost-build-0.11.4/src/lib.rs:1296:10
  note: run with `RUST_BACKTRACE=1` environment variable to display a backtrace

error: failed to run custom build command for `madara-runtime v4.0.0-dev (/Users/abdel/dev/me/madara/runtime)`

Caused by:
  process didn't exit successfully: `.../madara/target/release/build/madara-runtime-9df5c70f9d1b72f5/build-script-build` (exit status: 1)
  --- stderr
  Rust WASM toolchain not installed, please install it!

  Further error information:
  ------------------------------------------------------------
     Compiling wasm-test v1.0.0 (/var/folders/...)
  error[E0463]: can't find crate for `std`
    |
    = note: the `wasm32-unknown-unknown` target may not be installed
    = help: consider downloading the target with `rustup target add wasm32-unknown-unknown`
    = help: consider building the standard library from source with `cargo build -Zbuild-std`

Thanks goes to these wonderful people (emoji key):

Abdel @ StarkWare 💻	Timothée Delabrouille 💻	0xevolve 💻	Lucas @ StarkWare 💻	Davide Silva 💻	Finiam 💻	Resende 💻
drspacemn 💻	Tarrence van As 💻	Siyuan Han 📖

This project follows the all-contributors specification. Contributions of any kind welcome!