Reference shelf
This site is curated. The Yano X repository holds several exhaustive documents that are deliberately not duplicated here, because a second copy would diverge from the code within a release.
They are linked below, and they are the authority whenever this site and the repository disagree.
The complete guides
Section titled “The complete guides”| Document | Size | What it covers |
|---|---|---|
| App ledger user guide | ~114 KB | The exhaustive reference: configuration, REST API, anchoring, custom app ledgers, multi-chain nodes, standard state machines, SSE/webhook/Kafka consumption, typed messages, security, compliance, operations, queries, client libraries, effects, troubleshooting, and current limitations. |
| App ledger overview | ~21 KB | The 10–15 minute architecture read, plus an editable presentation deck. |
| Consensus and internals guide (Yano) | ~23 KB | The consensus round check by check, vote locks, sequencer modes, catch-up and restart semantics. |
| Plugin query and domain API contract (Yano) | — | How plugins add read hooks and domain routes, and how the host secures them. |
| App ledger tutorial | ~22 KB | Run a cluster and build a custom state machine end to end. |
| Use-case catalogue | ~18 KB | Worked application patterns and their starting points. |
Domain and governance
Section titled “Domain and governance”| Document | What it covers |
|---|---|
| Domain actors and role-aware approvals | Governed organizations, actor and key revisions, role policies, and organization-distinct quorums. |
| Profile governance runbook | Packaging, authorizing, and activating a composite profile epoch. |
| Composable state and proofs | Reusing stock transitions and verifying portable proofs. |
| Proof Lab | Message, typed-state, imported, and on-chain proof workflows; independent-verifier and Cardano-validator guides. |
| Authenticated snapshots | Archiving and proving large immutable period datasets. |
Capabilities, connectors, and release
Section titled “Capabilities, connectors, and release”| Document | What it covers |
|---|---|
| Capability catalog | The release capability and recipe catalog in the repository. |
| Optional connectors | Per-connector installation, configuration, and security profiles. |
| Release acceptance | Acceptance scenarios and schema status. |
| Cardano History | The full product guide and route reference. |
Build, operate, demo
Section titled “Build, operate, demo”| Document | What it covers |
|---|---|
| Build and test | Every build task and verification gate. |
| Build distributions | Distribution inputs, outputs, and the artifact API prefix. |
| Cluster launcher | Per-node overlays, chain definitions, membership, load and soak tests. |
| Evidence chain demo | The complete scripted evidence scenario and its acceptance checks. |
| Showcase demo | Operating the unified showcase distribution. |
| Developer tools | The offline engine behind yano.sh appchain. |
| App-Chain Studio | The blueprint builder, hosted here. |
eUTxO ledger
Section titled “eUTxO ledger”| Document | What it covers |
|---|---|
| eUTxO product family | The virtual ledger, profiles, and genesis. |
| eUTxO demos | The disposable two-scenario quick start. |
| Indexer operations | Lifecycle API, SQLite, recovery, metrics. |
Decisions
Section titled “Decisions”Architecture decision records live in the adr/ directory of the repository.
They are point-in-time decisions rather than documentation — several are
explicitly marked pre-split evidence — so they are deliberately not published
here. Read them in the repository when you need the rationale behind a
contract; trust this site and the code for current behaviour.
The upstream host
Section titled “The upstream host”Yano itself lives at github.com/bloxbean/yano
and owns the node, consensus, proofs, anchoring, the effect runtime, the plugin
SPI, and ordered-log. Host-contract questions belong there. Its
ordered-log reference
and submission contract
are the host-side companions to this site.