adr

Architecture Decision Records (ADRs)

This directory holds FlowFi's formal architecture decisions in MADR (Markdown ADR) format. Rationale that used to live in commit messages and ad-hoc audit notes is recorded here so new contributors, enterprise payroll clients, and security auditors can understand why the system looks the way it does — not just what it does.

Index

ADR	Title	Status
0001	Soroban storage TTL bump strategy	Accepted
0002	Keeper-key deprecation & client-side signing	Accepted
0003	Event indexer cursor pagination & dead-letter handling	Accepted
0004	Realtime transport: SSE + WebSocket coexistence	Accepted

Process

1. Propose a new ADR as docs/adr/NNNN-short-title.md using the MADR template (Status / Context / Decision / Consequences).
2. Link related issues, audits (docs/audits/), and code paths.
3. Mark superseded ADRs as Superseded by ADR-XXXX, never delete them.
4. Reference ADRs from docs/ARCHITECTURE.md and the root README.md so auditors can find them.

Related

• System architecture
• STRIDE threat model
• Keeper-key blast radius audit