Documentation index

NUNCHI SDK DOCUMENTATION

Build financial chainswithout rebuilding the financial layer.

Nunchi is a modular Rust SDK for application-specific financial chains. Commonware supplies the low-level primitives. Nunchi packages finance-specific state, modules, and examples into a clearer starting point.

Start here View the source
LANGUAGE
Rust
FOUNDATION
Commonware
NETWORK SHAPES
Public, private, rollup
SOURCE
Public workspace

DOCUMENTATION INDEX

Choose what you need to understand.

Start with the architecture if you are evaluating fit. Start with modules and examples if you are already mapping a product.

01

START

Getting started

Choose a financial workflow, define its constraints, and follow the shortest path through the SDK.

Plan the first build
02

UNDERSTAND

Architecture

See where Commonware ends, where Nunchi begins, and which decisions remain in your application.

Read the architecture
03

BUILD

Module index

Browse blockchain basics, network infrastructure, financial primitives, and chain examples.

Browse modules
04

BUILD

Examples

Trace source-backed examples from an application type through finalized block activity.

Study the examples
05

FOUNDATION

Commonware foundation

Map the low-level runtime, networking, consensus, storage, and coordination primitives beneath the SDK.

Map the foundation

THE STACK

Three layers. Clear ownership.

The SDK sits between general-purpose infrastructure and the financial product your team operates.

01

LOW-LEVEL PRIMITIVES

Commonware

Runtime, peer communication, consensus, storage, cryptography, and reusable coordination components.

02

FINANCE-SPECIFIC LAYER

Nunchi SDK

Financial state, authority, data, market modules, composition patterns, and developer examples.

03

PRODUCT

Your application chain

Your workflow, participants, controls, transaction policy, operating model, interfaces, and user experience.

Read the architecture guide

MODULE MAP

From basic chain behavior to markets.

The repository organizes the SDK into four practical areas. Each area answers a different part of the build.

01

Blockchain Basics

Core components for assets, cryptography, access, data, connectivity, and reusable application behavior.

  • Coins
  • Crypto
  • RPC
  • DKG
  • Bridge
  • Oracle
  • Chat
  • Factory
02

Network Infrastructure

Components for authority and proof-of-stake based participation in a specialized network.

  • Authority
  • PoS
03

Financial Primitives

Purpose-built components for collateral, issuance, markets, balances, and other financial state.

  • Margin
  • Securities
  • Vaults
  • CLOB
  • Derivatives
  • Stablecoin
04

Chain Examples

Reference implementations that show how modules become working application chains and services.

  • Coins chain
  • Bridge chain
  • Custom module
Open the complete module index

NUNCHI SOURCE

Start with the SDK in working code.

The examples show how Nunchi types connect into an application chain. This Coins application composes a runtime with the CLOB extension through the shared application type.

examples/coins/chain/src/application.rsSource 
use nunchi_clob::ClobExtension;
use crate::CoinsRuntime;

pub type Application =
    nunchi_chain::Application<CoinsRuntime, ClobExtension>;
01 / APPLICATIONCoins chain composition

Trace the runtime, extension, and application type.

02 / SERVICECoins indexer

Follow finalized activity into an observable event stream.

03 / GUIDERead the examples guide

Learn what to inspect before designing a custom chain.

04 / NETWORKCheotsu devnet

Watch live consensus activity from a running Nunchi network.

COMMONWARE FOUNDATION

Follow each low-level concept to its source.

Commonware publishes each primitive as Rust documentation. Nunchi uses that foundation to build finance-specific components and examples.

commonware-actor

Safely coordinate concurrent components.

commonware-runtime

Execute asynchronous tasks in production or deterministic simulation.

commonware-p2p

Communicate with authenticated peers over encrypted connections.

commonware-consensus

Order opaque messages in a Byzantine environment.

commonware-storage

Persist and retrieve data from an abstract store.

commonware-glue

Use default constructions that span multiple primitives.

VERSION AND MATURITY

Track compatibility at the primitive level.

Commonware uses calendar versions and separate stability levels for individual primitives. The current repository and lockfile remain the source of truth for the combination used by Nunchi.

Read Commonware's readiness model

READY TO MAP A PRODUCT?

Bring one financial workflow and its constraints.

We will identify the smallest set of modules and the clearest path to a working pilot.