Skip to content

auguth/frame-suite

Repository files navigation

FRAME Suite Node

License Rust Substrate CI

A Substrate-based blockchain node built with the FRAME Suite ecosystem.

Current Primitives

The current FRAME Suite provides modular staking primitives, composed of reusable roles, bonding, orchestration, and behavior models.

This node currently integrates the following FRAME Suite primitives:

This set may evolve over time as new primitives are added to frame_suite and integrated into the node.

Getting Started

Build

Build the node:

cargo build --release

Build with Dev Features

For development (enables additional logging, debugging, and optional features):

cargo build --release --features dev

Run Development Chain

Start a local development chain:

./target/release/frame-suite-node --dev

Run with Dev Features

cargo run --release --features dev -- --dev

Purge Chain

./target/release/frame-suite-node purge-chain --dev

Run with Logs

RUST_BACKTRACE=1 ./target/release/frame-suite-node --dev -l debug

Structure

Node

The node/ directory defines:

  • networking (libp2p)
  • consensus integration
  • RPC interface

Key files:

Runtime

The runtime defines blockchain logic:

  • located in runtime/src/lib.rs
  • composed using FRAME pallets
  • configured via impl Config blocks

Key files:

Pallets

Custom pallets are located in pallets/:

  • define storage, extrinsics, and logic
  • are composed into the runtime

FRAME

The frame/ directory contains supporting crates used across the runtime:

They act as the foundation layer, while pallets provide concrete runtime behavior.

Development

Modify Runtime

To:

  • mod.rs to change plugin models and adjust parameters
  • lib.rs to add/remove pallets

Plugins

Logical behaviors are configurable via frame_plugins. These are selected at the runtime level.

Dev Feature

The dev feature enables:

  • additional logging and event emissions
  • debugging utilities via extrinsics
  • optional development configurations

Use it during development:

cargo build --features dev

Connect Frontend

Connect using Polkadot.js Apps:

ws://127.0.0.1:9944

Documentation

Please refer to generated Cargo-Docs for pallets and frame-utilities rust-documentation.

Contributing

Please refer to CONTRIBUTING.md for contribution guidelines.

License

MPL-2.0 (Mozilla Public License)

An Open-Source initiative by Auguth Labs (OPC) Pvt Ltd, India

About

A Substrate (Polkadot-SDK) based blockchain node built with the FRAME Suite ecosystem.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors