Skip to content

Latest commit

 

History

History
38 lines (30 loc) · 3.3 KB

README.md

File metadata and controls

38 lines (30 loc) · 3.3 KB

Architecture Decision Records

This directory captures the significant technical decisions made in FlowStar — what was decided, why, and what the trade-offs are. Use these records to understand the reasoning behind the current design before changing it.

Index

ADR Title Status
ADR-000 ADR Template Template
ADR-001 Persistent vs Instance Storage for Streams Accepted
ADR-002 Client-Side Unlock Calculation Accepted
ADR-003 Mock Mode for Development Accepted
ADR-004 Polling vs WebSocket for Updates Accepted
ADR-005 BigInt for Token Amounts Accepted
ADR-006 Multi-Wallet Strategy (formerly Freighter-Only) Accepted (Updated)
ADR-007 Integer Division Dust Handling Accepted
ADR-008 Delegate Withdrawal Authorization Accepted (open questions)
ADR-009 Hidden Streams / Blocked Senders — Frontend-Only (localStorage) Accepted
ADR-010 CSV Batch-Import Column-Alias Resolution Accepted
ADR-011 Notification Polling, Dedup, and Per-Wallet Scoping Accepted
ADR-012 Webhook Delivery Retry, Backoff, and History Retention Accepted
ADR-013 Auto-Withdraw Strategy Pattern Accepted (open correctness issues)

New ADRs should continue from the highest number in this table.

How to add a new ADR

  1. Copy ADR-000-template.md to ADR-NNN-short-title.md
  2. Fill in all sections
  3. Add a row to the index above
  4. Link the ADR from the relevant code or PR for context

Statuses

  • Proposed — under discussion, not yet decided
  • Accepted — the current approach
  • Superseded by ADR-NNN — replaced by a later decision
  • Deprecated — no longer relevant