Your path through Yano X
Start with a working example. Learn one concept at a time, then bring your own application rules.
Yano X is the Java 25 extension ecosystem for Yano app ledgers: application ledgers that several members run together. Yano handles ordering, member finality, proofs, and optional Cardano anchors. Yano X adds state machines, workflows, connectors, and application tooling as JVM plugins. Yano’s tooling calls an app ledger an app chain, so commands and settings use appchain and app-chain.
1. See a ledger work
Section titled “1. See a ledger work”Time: about 15 minutes after the download.
Follow the local showcase quickstart. You will start three members on a private devnet, submit data, and compare their state. You need Java 25, Python 3, curl, and jq. You do not need a public-network wallet or test ADA.
Ready to continue when: you can submit an order, verify member agreement, stop the instance, and restart it with the same data.
If the idea is new, read What is an app ledger? first. If you only need Cardano data, transaction submission, or devnet testing, begin with Yano.
2. Understand what you verified
Section titled “2. Understand what you verified”Time: about 30 minutes: 15 for the tutorial and 15 for the concepts.
Four results look similar but establish different things:
- 202 Accepted → Final.
- Final → Proof.
- Proof → Anchor.
Select a result to see what it establishes and what it does not.
- 202 Accepted
- Establishes: one member checked the envelope and the command against its current state, and queued the message in memory. Does not establish: that the message is ordered, final, or successful. A rule can still fail when the block runs, and a message that no other member received is lost if that member restarts.
- Final
- Establishes: a threshold of members re-executed the block, got the same state root, and signed it in two rounds, PREPARE then COMMIT. The message has a fixed height and position and is never rolled back. Does not establish: that your command succeeded. A command that breaks a business rule is final as a no-op, so read the application’s result. Consensus and finality →
- Proof
- Establishes: a record is, or is not, in the state under one specific root. Does not establish: that this root is the ledger’s certified root, unless you pinned it or checked it against a certificate or an anchor. Absence from the state does not prove a fact never happened, and no proof shows that data will stay available. State and proofs →
- Anchor
- Establishes: a Cardano transaction records the ledger’s height, block hash, and state root. In script mode, Cardano accepts each advance only with a threshold of member signatures; in metadata mode it enforces nothing. Does not establish: that the application rules were followed, because Cardano does not run them. It covers the anchored height, not later blocks, and finality never waits for it. Cardano anchoring →
Work through Registry and proofs, then read State and proofs for the trust model.
Ready to continue when: you can explain the difference between submission, a finalized result, a proof, and an anchor.
3. Model your application
Section titled “3. Model your application”Time: plan on an hour to choose a recipe and rehearse the setup.
Choose a recipe for your outcome: shared records, document history, approvals, or another supported workflow. Set up an application with the other operators, after rehearsing every step on one machine with ./yano.sh appchain try. Studio can help you compose several state machines with bindings.
Ready to continue when: you know which state machine and capabilities your application needs. You do not need to write a plugin if an existing recipe fits.
4. Extend or operate when you need to
Section titled “4. Extend or operate when you need to”Most tutorials state their time at the top.
| Your next task | Continue here |
|---|---|
| Follow examples in order | Guided tutorials |
| Connect existing machines using YAML | Declarative bindings: beginner to advanced |
| Combine existing rules or add custom Java logic | Plugin framework |
| Deliver webhooks or other external actions | Effects |
| Plan a multi-node deployment | Deployment guide |
| Look up an API, artifact, or setting | Reference shelf |
| Give a coding agent project context | AI starter pack |
Keep versions together
Section titled “Keep versions together”The documentation follows the current checkout. Release downloads contain their own exact host identity and plugin manifests; use those when running an older release. Yano X libraries use Maven group org.yanoproject.x and packages org.yanoproject.x.*. Yano host libraries use org.yanoproject. See the generated version and module table for this checkout.
Yano X is pre-release. Use the local devnet to learn, then review security, deployment, recovery, and domain requirements before planning production use.