Skip to content

README.md

Latest commit

 

History

History
47 lines (32 loc) · 2.45 KB

README.md

File metadata and controls

47 lines (32 loc) · 2.45 KB
Raw

Architecture Decision Records (ADRs)

This directory contains Architecture Decision Records for QuorumProof. Each ADR documents a significant design decision: the context that prompted it, the alternatives considered, and the rationale for the chosen approach.

What is an ADR?

An ADR is a short document that captures why a decision was made, not just what was decided. Future maintainers can read ADRs to understand the reasoning behind the architecture without having to reverse-engineer it from the code.

Index

# Title Status Date
001 Federated Byzantine Agreement (FBA) Trust Model Accepted 2024-01-15
002 Soulbound Token (SBT) Non-Transferability Accepted 2024-01-20
003 Zero-Knowledge Verification Approach Accepted 2024-02-01
004 Soroban Platform Choice Accepted 2026-06-26
005 Registry Attestation Proof for Licensing Body Integrations Accepted 2026-07-20
006 Economic Security Model Accepted 2026-07-21
006 Quorum Intersection Verification Accepted 2026-07-21
007 BBS+ Signatures for Selective Disclosure Accepted 2026-07-26

Note: two ADRs were numbered 006 independently before this index was reconciled. Both are kept under their original filenames for stable links; do not reuse 006 or 007 for new ADRs — the next available number is 008.

How to Add a New ADR

  1. Copy the template: cp 0000-adr-template.md NNNN-short-title.md
  2. Fill in every section — especially Alternatives Considered and Consequences.
  3. Set the status to Proposed until the team agrees; change to Accepted after review.
  4. Add a row to the index table above.
  5. Submit as part of a pull request.

ADR Lifecycle

Proposed → Accepted → (Deprecated | Superseded by ADR-NNNN)

A deprecated or superseded ADR is kept for historical context; do not delete it.

Template

See 0000-adr-template.md.

References