Documentation
Everything Atrium claims to do is documented in source-of-truth markdown files in the repo. Docs already published to GitHub link out; the rest live in the working tree and publish as they are finalized (marked below).
ATRIUM_PRD.md
Product spec · what + why · honesty baseline + build phase
TECH_DESIGN.md
Technical design · how it works · ADRs 001–012
docs/plan-tracker.md
Source of truth for every landed fix across the audit waves
docs/MASTER_PLAN.md
12-month build plan with status markers
docs/LAUNCH_READINESS.md
Pre-demo checklist · what is built · what is deferred
COMPETITIVE_POSITIONING.md
The wedge: cross-venue portfolio margin from a neutral layer, why no single venue can copy it
RESOURCES.md
The 18 cloned reference repos in resources/ and what each is for
SECURITY.md
Threat model, key handling, disclosure policy, bug bounty
Honest disclosures
Three venues are mocked or relayed on testnet because the real upstream is not on Sepolia (Aave V3, Pyth equity feeds, Hyperliquid). Plus a handful of interim states (deployer-EOA admin, monitoring-only keeper, empty cohort strip). Every one is named here with the mechanism + timeline to "real".
Honest disclosures
Every mock, relay, interim state, and third-party blocker. What it does, why, when it becomes real. Sourced from the tripwires/ folder.
10 disclosures . sourced
Codex API reference
x402-payable HTTP API. 8 endpoints, quickstart, auth, rate limits, TypeScript + Python SDK snippets.
8 endpoints . x402
Glossary
Every subsystem name (Plinth, Sigil, Lantern...) in plain English: what it is and what it does for you. The key to the product's vocabulary.
18 subsystems . plain language
Deployment
Every contract on Arbitrum Sepolia with its address + Arbiscan link, and who controls it. Read the bytecode and state yourself.
live registry . on-chain
Runbooks
The operational playbooks Atrium runs on: incident response, deploy, key rotation, monitoring, on-call. Rendered from the runbooks/ markdown in the repo.
34 runbooks . ops-ready
Architecture decision records
ADR-001 through ADR-012 record every consequential decision taken during the build phase, with context and the alternatives rejected: Stylus over Solidity, Kani over Halmos, the dual-oracle median, UUPS upgradeability, the open IPorticoAdapter, and more.
Read all 12 decisions →Adapter spec
IPorticoAdapter v1.0 + v1.1 with explicit originator. MIT-licensed. Curator grant $5K ARB per accepted adapter.
Sigil schema
EIP-712 IntentSigil + ActionSigil envelopes. 256-byte fixed body, count-prefixed venues/instruments (max 8 each), 65-byte trailing sig.
ReadSPAN scenarios
7 shock scenarios (±10%, ±5%, ±2%, 0) per instrument, sourced tospan.rs SCENARIOS_BPS, with cross-correlation netting across instruments in the same correlation class.