Skip to content

Add Architecture Decision Records (ADRs) for key design choices #406

@Emeka000

Description

@Emeka000

Summary

The repository implements many non-obvious design choices but the rationale behind them is not documented. New contributors and auditors must reverse-engineer intent from code.

ADRs to Write

  1. ADR-001: Why Soroban/Stellar vs other blockchain platforms
  2. ADR-002: Storage TTL retention class design (Critical/Operational/Ephemeral)
  3. ADR-003: Hash-based privacy for sensitive fields
  4. ADR-004: Multi-sig governance threshold design
  5. ADR-005: Actor verification caching strategy in shared module
  6. ADR-006: Why no-std with WASM target

Format

Each ADR: Context → Decision → Consequences

Acceptance Criteria

  • ADR directory created at docs/adr/
  • All 6 ADRs written
  • README links to the ADR directory

Metadata

Metadata

Assignees

Labels

Stellar WaveIssues in the Stellar wave programdocumentationImprovements or additions to documentation

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions