Developer onboarding path
A suggested order for reading and running things when you are new to the repository.
Read the status and scope
Project status and What is Tobin?. Five minutes, and it prevents the most common misunderstanding: the system is experimental and Testnet-only.
Learn the vocabulary
Domain model and State and trust boundaries. Tobin separates things that look alike (a prepared batch, a signed transaction, a submitted one, a confirmed one). Most review comments in this repository are about keeping them apart.
Get the code running
Follow Prerequisites and Install and run.
Start the web console and sign in at http://127.0.0.1:8787/sign-in.
See the architecture
Architecture overview, then Netting and contract validation for the engine-versus-contract split.
Run the tests you will touch
Testing lists the command for each layer. Run the layer you plan to change before you change it, so you know the baseline.
Make a small change
Pick a documentation fix or a small bug. Follow Contributing: branch type prefixes, Conventional Commits, and the pull request template.
Reading the canonical records
When a page links to a milestone record (acceptance, closure, security review), read the closure document first: it
states what was and was not shown. The records live in
docs/product/architecture and are not
rewritten when the code moves on.
If you are an AI coding agent, read AGENTS.md first;
it is authoritative for agents.