Skip to content

README.md

Latest commit

 

History

History
260 lines (169 loc) · 5.65 KB

README.md

File metadata and controls

260 lines (169 loc) · 5.65 KB

🌐 REChain SDK

GitHub stars GitHub forks License StackExchange

1️⃣ Home / Overview

REChain SDK is the ultimate toolkit for building scalable, interoperable, and secure blockchains.

Quick Facts:

  • 🌍 Multi-chain & parachain-ready
  • 🛠️ FRAME + Cumulus + XCM built-in
  • 📦 Pre-built pallets & templates
  • 🦀 Rust-native development

Links

Quickstart

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/REChain-Network-Solutions/SDK/master/scripts/getting-started.sh | bash

2️⃣ Getting Started

Prerequisites

  • Rust & Cargo (rustc --version)
  • Node.js & npm (node -v)
  • WASM toolchain (wasm32-unknown-unknown target)

Steps

  1. Run the quickstart script
  2. Set environment variables
  3. Launch node: rechain-node --version
  4. Create your first chain using a template

Troubleshooting

  • Check logs: ~/.rechain/logs/node.log
  • Common errors & solutions table:
Error Solution
Cargo build fails Update Rust to latest stable
WASM compilation fails Ensure wasm32-unknown-unknown target installed
Node won't start Verify environment variables & ports

3️⃣ Architecture

REChain SDK Layered Architecture

Components

  • FRAME → Runtime logic
  • Cumulus → Parachain integration
  • XCM → Cross-chain messaging
  • Runtime Pallets → Plug-and-play modules

Topology Example

+--------------------+
|  REChain Relay     |
+--------+-----------+
         |
+--------v-----------+
|  Parachain Node    |
+--------------------+

4️⃣ Guides

FRAME Pallet Development

  • Create pallet, define storage, events, extrinsics
  • Unit testing & debugging

Cumulus Parachain

  • Deploy parachain
  • Connect to relay chain
  • Lifecycle & upgrade management

XCM Messaging

  • Cross-chain token & message transfers
  • Security considerations

Runtime Upgrades

  • Upgrade pallets & runtime versions
  • Migration best practices

5️⃣ Templates

  • Minimal chain template
  • Enterprise chain template
  • Pallet starter kits

Example

git clone https://github.com/REChain-Network-Solutions/SDK-template.git
cd SDK-template
cargo build
cargo run

6️⃣ Tutorials

Levels

  • Beginner: First blockchain app
  • Intermediate: NFT marketplace
  • Advanced: Cross-chain DeFi protocol

Step-by-step examples, diagrams, and code snippets included.

7️⃣ Tooling

  • REChain SDK Version Manager → Manage dependencies in Cargo.toml
  • CLI commands cheat sheet
  • Debug & logging utilities
  • IDE integrations: VSCode, JetBrains

8️⃣ API Reference

  • Rust crates & modules
  • Full function & struct reference
  • Examples for each major module

📖 Generated Rust Docs

9️⃣ Security

  • Security Policy
  • Bug bounty program (upcoming)
  • Responsible disclosure guidelines
  • Encryption & signing best practices
  • XCM safety tips

🔟 Contributing

11️⃣ Ecosystem

  • REChain mainnet & parachains
  • Partner projects & integrations
  • Community initiatives
  • Enterprise & DeFi adoption

12️⃣ Roadmap

Timeline Goals
Short-term (3-6m) Core SDK release, FRAME pallet templates
Medium-term (6-12m) Advanced XCM tutorials, SDK GUI dashboard
Long-term (2-3y) WASM IDE, enterprise adoption

13️⃣ FAQ

Q: What is REChain SDK? A: Modular blockchain development kit built on Substrate.

Q: Can I launch a parachain? A: Yes, FRAME + Cumulus + XCM support included.

Q: Do I need Rust? A: Recommended, but templates & guides available.

14️⃣ Changelog / Releases

  • Stable releases: stableYYMM
  • Patch updates & hotfixes
  • Migration notes

Release Registry

15️⃣ References & Resources

  • Official docs & portal
  • Substrate, Rust, Cumulus references
  • Tutorials, blogs, webinars
  • Community links

16️⃣ Community

  • Forums & StackExchange
  • Discord / Telegram / Twitter
  • Meetups & events
  • How to get involved

Optional Advanced Pages

Case Studies

  • Showcase of projects using REChain SDK

SDK Internals

  • Deep dive into runtime & pallets

Migration Guide

  • From Substrate / Polkadot SDKs to REChain

🔥 REChain SDK is the backbone of the decentralized internet. Start building today!