Skip to content

Home

Jump to bottom
Dmitry Olegovich Sorokin (@sorydima) edited this page Sep 30, 2025 · 1 revision

REChain SDK — Wiki / Documentation

Table of Contents

  1. Introduction

  2. Vision & Goals

  3. Architecture Overview

  4. Core Components & Modules

    1. Substrate / FRAME / Runtime

    2. Cumulus & Parachains

    3. XCM / Cross‑chain Messaging

    4. Bridges

    5. Templates

    6. Scripts & Tooling

  5. Releases & Versioning

  6. Getting Started / Quickstart

  7. Development Workflow

  8. APIs & Interfaces

  9. Security & Best Practices

  10. Contributing & Governance

  11. Roadmap & Future Directions

  12. Appendix

  13. Glossary

  14. External Resources

  15. Changelog Highlights

  16. Examples & Tutorials

1. Introduction

The REChain SDK repository is the core software development kit for building on Rechain, a multi-chain blockchain platform that enables different blockchains to interoperate and share information securely and scalably.

This repository houses the building blocks needed for both the core Rechain network and its parachains, including runtimes, frameworks, tooling, cross-chain communication modules, and templates.

The SDK is built largely on top of Substrate and Cumulus (the parachain framework for Polkadot / Substrate ecosystems).

2. Vision & Goals

  • Provide a modular, reusable, battle-tested SDK for building blockchains and parachains that are interoperable.

  • Enable developers to bootstrap chains quickly using templates and scaffolding.

  • Offer robust cross-chain communication (via XCM, bridges, etc.).

  • Maintain security, upgradeability, and maintainability.

  • Support multi-chain interoperability in the Rechain ecosystem.

3. Architecture Overview

+-----------------------+  
| Application-level / UI |  
+-----------------------+  
          │  
          ▼  
+-------------------------+  
| Runtime / FRAME Pallets |  
+-------------------------+  
          │  
          ▼  
+-------------------------+  
| Cumulus / Parachain Logic|  
+-------------------------+  
          │  
          ▼  
+-------------------------+  
| XCM / Cross-chain Layer  |  
+-------------------------+  
          │  
          ▼  
+-------------------------+  
| Bridges / External Chains|  
+-------------------------+

  • Runtime / FRAME Pallets: The heart of chain logic (governance, token, consensus, modules).

  • Cumulus / Parachain Logic: Parachain-specific primitives, parachain handshake, collator logic, etc.

  • XCM Layer: Messaging framework to send messages between chains.

  • Bridges: Connect Rechain with external chains (Ethereum, others).

4. Core Components & Modules

Module / Directory Purpose / Key Contents Comments / Notes
substrate/ Core Substrate-based crates (runtime, pallets) FRAME pallets, runtime logic, chain-specific logic.
cumulus/ Parachain / collator logic Integration with Cumulus, parachain handling, consensus bridging.
bridges/ Bridge modules Modules for bridging Rechain to other blockchains / external networks.
templates/ Project scaffolding / starter templates Ready-to-go starting points for new chains built using REChain SDK.
scripts/ Automation and utility scripts Bootstrapping, CI tasks, deployment, etc.
rechain/ Core chain code or configuration Contains network-level settings or rechain-specific logic.
docs/ Documentation content Guides, tutorials, technical docs.
docker/ Containerized environments For spinning up nodes, local networks, etc.
prdoc/ Documentation tooling Generating docs or managing documentation.

Notable Tools / Utilities:

  • Rechain SDK Version Manager: Manages and updates SDK dependencies in Cargo.toml.

  • psvm: Tool for aligning crate versions to specific SDK release cycles.

5. Releases & Versioning

  • Quarterly release cycle, versions named stableYYMM.

  • Each stable release supported with patches for one year.

  • Version tracking via Release Registry and RELEASE.md.

  • Upgrade assistance via Rechain SDK Version Manager or psvm.

6. Getting Started / Quickstart

Bootstrap a development node quickly:

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

Additional resources:

  • Docs Portal: docs.rechain.network

  • Rust API Docs: REChain‑Network‑Solutions.github.io

  • Templates: located in templates/

7. Development Workflow

  1. Clone the repo:

    git clone https://github.com/REChain-Network-Solutions/SDK.git
cd SDK

  2. Pick a template or start from scratch.

  3. Add or modify pallets in substrate/.

  4. Configure parachain logic in cumulus/.

  5. Set up cross-chain messaging and bridges.

  6. Sync dependencies with version tools.

  7. Build & test with cargo or make.

  8. Run nodes via Docker or native binaries.

  9. Generate / update docs.

  10. Contribute via PRs following repo guidelines.

  11. Release versions with proper tagging and changelogs.

8. APIs & Interfaces

Runtime / Crate APIs

  • Traits, types, functions exposed via FRAME pallets.

  • Runtime extrinsics & RPC endpoints.

  • Cross-chain messaging (XCM) interfaces.

Cross-Chain Messaging / XCM

  • Native XCM support for chain-to-chain messaging.

  • Safe, verifiable message passing.

Bridge Interfaces

  • Token/account mapping.

  • Event watchers / relayers.

  • Verification & proof handling.

9. Security & Best Practices

  • Security policy: in docs/contributor/SECURITY.md.

  • Key practices:

    • Runtime upgrades with proper migrations.

    • Validation of XCM messages.

    • Replay protection in bridges.

    • Access control in pallets.

    • Audits, fuzzing, and formal verification.

10. Contributing & Governance

  • Guidelines: CONTRIBUTING.md.

  • Community norms: Contributor Covenant Code of Conduct.

  • Issues labeled mentor are starter-friendly.

  • Contributions may be rewarded with on‑chain tips.

11. Roadmap & Future Directions

  • Enhanced interoperability.

  • More bridge protocols.

  • Expanded templates and examples.

  • Performance optimizations.

  • Ecosystem tooling (monitoring, analytics).

  • Security audits and formal verification.

12. Appendix

Glossary

  • SDK: Software Development Kit

  • FRAME: Substrate’s modular runtime framework

  • Cumulus: Parachain framework for Substrate

  • XCM: Cross‑Consensus Messaging

  • Pallet: Modular runtime component

  • Bridge: Connects two blockchains

  • Parachain: A blockchain connected to a relay chain

External Resources

  • Docs Portal: docs.rechain.network

  • Rust API Docs: REChain‑Network‑Solutions.github.io

  • Substrate / Polkadot developer documentation

Changelog Highlights

  • Refer to CHANGELOG.md for major and breaking updates.

Examples & Tutorials

  • Provided under templates/.

  • Additional guides available via docs portal.

# REChain SDK — Wiki / Documentation

Table of Contents

  1. Introduction

  2. Vision & Goals

  3. Architecture Overview

  4. Core Components & Modules

    1. Substrate / FRAME / Runtime
    2. Cumulus & Parachains
    3. XCM / Cross‑chain Messaging
    4. Bridges
    5. Templates
    6. Scripts & Tooling

  5. Releases & Versioning

  6. Getting Started / Quickstart

  7. Development Workflow

  8. APIs & Interfaces

  9. Security & Best Practices

  10. Contributing & Governance

  11. Roadmap & Future Directions

  12. Appendix

  13. Glossary

  14. External Resources

  15. Changelog Highlights

  16. Examples & Tutorials

1. Introduction

The REChain SDK repository is the core software development kit for building on Rechain, a multi-chain blockchain platform that enables different blockchains to interoperate and share information securely and scalably.

This repository houses the building blocks needed for both the core Rechain network and its parachains, including runtimes, frameworks, tooling, cross-chain communication modules, and templates.

The SDK is built largely on top of Substrate and Cumulus (the parachain framework for Polkadot / Substrate ecosystems).

2. Vision & Goals

  • Provide a modular, reusable, battle-tested SDK for building blockchains and parachains that are interoperable.
  • Enable developers to bootstrap chains quickly using templates and scaffolding.
  • Offer robust cross-chain communication (via XCM, bridges, etc.).
  • Maintain security, upgradeability, and maintainability.
  • Support multi-chain interoperability in the Rechain ecosystem.

3. Architecture Overview

+-----------------------+  
| Application-level / UI |  
+-----------------------+  
          │  
          ▼  
+-------------------------+  
| Runtime / FRAME Pallets |  
+-------------------------+  
          │  
          ▼  
+-------------------------+  
| Cumulus / Parachain Logic|  
+-------------------------+  
          │  
          ▼  
+-------------------------+  
| XCM / Cross-chain Layer  |  
+-------------------------+  
          │  
          ▼  
+-------------------------+  
| Bridges / External Chains|  
+-------------------------+
  • Runtime / FRAME Pallets: The heart of chain logic (governance, token, consensus, modules).
  • Cumulus / Parachain Logic: Parachain-specific primitives, parachain handshake, collator logic, etc.
  • XCM Layer: Messaging framework to send messages between chains.
  • Bridges: Connect Rechain with external chains (Ethereum, others).

4. Core Components & Modules

Module / Directory Purpose / Key Contents Comments / Notes
substrate/ Core Substrate-based crates (runtime, pallets) FRAME pallets, runtime logic, chain-specific logic.
cumulus/ Parachain / collator logic Integration with Cumulus, parachain handling, consensus bridging.
bridges/ Bridge modules Modules for bridging Rechain to other blockchains / external networks.
templates/ Project scaffolding / starter templates Ready-to-go starting points for new chains built using REChain SDK.
scripts/ Automation and utility scripts Bootstrapping, CI tasks, deployment, etc.
rechain/ Core chain code or configuration Contains network-level settings or rechain-specific logic.
docs/ Documentation content Guides, tutorials, technical docs.
docker/ Containerized environments For spinning up nodes, local networks, etc.
prdoc/ Documentation tooling Generating docs or managing documentation.

Notable Tools / Utilities:

  • Rechain SDK Version Manager: Manages and updates SDK dependencies in Cargo.toml.
  • psvm: Tool for aligning crate versions to specific SDK release cycles.

5. Releases & Versioning

  • Quarterly release cycle, versions named stableYYMM.
  • Each stable release supported with patches for one year.
  • Version tracking via Release Registry and RELEASE.md.
  • Upgrade assistance via Rechain SDK Version Manager or psvm.

6. Getting Started / Quickstart

Bootstrap a development node quickly:

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

Additional resources:

  • Docs Portal: docs.rechain.network
  • Rust API Docs: REChain‑Network‑Solutions.github.io
  • Templates: located in templates/

7. Development Workflow

  1. Clone the repo:

    git clone https://github.com/REChain-Network-Solutions/SDK.git
cd SDK

  2. Pick a template or start from scratch.

  3. Add or modify pallets in substrate/.

  4. Configure parachain logic in cumulus/.

  5. Set up cross-chain messaging and bridges.

  6. Sync dependencies with version tools.

  7. Build & test with cargo or make.

  8. Run nodes via Docker or native binaries.

  9. Generate / update docs.

  10. Contribute via PRs following repo guidelines.

  11. Release versions with proper tagging and changelogs.

8. APIs & Interfaces

Runtime / Crate APIs

  • Traits, types, functions exposed via FRAME pallets.
  • Runtime extrinsics & RPC endpoints.
  • Cross-chain messaging (XCM) interfaces.

Cross-Chain Messaging / XCM

  • Native XCM support for chain-to-chain messaging.
  • Safe, verifiable message passing.

Bridge Interfaces

  • Token/account mapping.
  • Event watchers / relayers.
  • Verification & proof handling.

9. Security & Best Practices

  • Security policy: in docs/contributor/SECURITY.md.

  • Key practices:

    • Runtime upgrades with proper migrations.
    • Validation of XCM messages.
    • Replay protection in bridges.
    • Access control in pallets.
    • Audits, fuzzing, and formal verification.

10. Contributing & Governance

  • Guidelines: CONTRIBUTING.md.
  • Community norms: Contributor Covenant Code of Conduct.
  • Issues labeled mentor are starter-friendly.
  • Contributions may be rewarded with on‑chain tips.

11. Roadmap & Future Directions

  • Enhanced interoperability.
  • More bridge protocols.
  • Expanded templates and examples.
  • Performance optimizations.
  • Ecosystem tooling (monitoring, analytics).
  • Security audits and formal verification.

12. Appendix

Glossary

  • SDK: Software Development Kit
  • FRAME: Substrate’s modular runtime framework
  • Cumulus: Parachain framework for Substrate
  • XCM: Cross‑Consensus Messaging
  • Pallet: Modular runtime component
  • Bridge: Connects two blockchains
  • Parachain: A blockchain connected to a relay chain

External Resources

Changelog Highlights

  • Refer to CHANGELOG.md for major and breaking updates.

Examples & Tutorials

  • Provided under templates/.
  • Additional guides available via docs portal.
Clone this wiki locally