Documentation index
Docs

/ Getting started

START / GETTING STARTED

Plan the first application chain.

The fastest way into Nunchi SDK is to start with one financial workflow, name its constraints, and map only the modules that workflow requires.

01

Confirm the fit

Nunchi SDK is designed for teams that need control over financial state, transaction flow, data inputs, participants, or operating policy. The output can be a public chain, private financial network, sequencer, or rollup component.

A strong fit

  • The product needs application-specific financial state.
  • The team needs explicit control over network behavior.
  • Market, authority, data, or asset logic should be reusable.
  • A narrow pilot can prove the architecture.

Questions to answer first

  • Who submits, validates, and reads transactions?
  • Which assets and data sources enter the system?
  • What must be deterministic at the chain level?
  • Which operating controls belong to the application?
02

Define one workflow

Write the workflow as a sequence of actors and state changes. Keep the first scope small enough that every dependency and success criterion can be named.

01

Participants

Users, operators, validators, data publishers, and services.

02

State

Assets, balances, positions, permissions, orders, or vaults.

03

Inputs

Transactions, signatures, oracle updates, and bridge messages.

04

Decision gate

The measurable result that proves the pilot should continue.

COMMERCIAL PATH

Qualify, scope, prove.

Nunchi SDK engagements begin with one workflow, convert its requirements into a paid scope, and end with a measurable pilot decision.

03

Follow the reading path

  1. 01

    Understand the boundary

    Read Architecture to separate Commonware primitives, Nunchi modules, and application logic.

  2. 02

    Choose module families

    Use the Module index to map product requirements to the smallest useful component set.

  3. 03

    Trace a working shape

    Study the Examples to see how modules appear in an application type and indexer.

  4. 04

    Verify the foundation

    Use the Commonware guide to inspect the exact low-level primitives and maturity model.

04

Read a source-backed shape

The Coins chain example defines an application by pairing a runtime with an extension. This small type alias is the clearest starting point for understanding composition in the repository.

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

pub type Application =
    nunchi_chain::Application<CoinsRuntime, ClobExtension>;

CoinsRuntime supplies the application runtime. ClobExtension adds market behavior. The application type connects both through nunchi_chain::Application.

05

Choose the next step