docs: create architecture decision records (ADRs)#927
Merged
Xoulomon merged 2 commits intoMay 30, 2026
Conversation
- Add measured gas costs for all contract functions at various group sizes * create_group: ~1.2M gas (fixed) * join_group: ~1.8M gas (O(1)) * contribute: ~2.5M gas (10.5% optimized) * execute_payout: ~2.2M gas (86% optimized for 100-member groups) * Full lifecycle analysis for 5-100 member groups - Document storage access patterns and identify optimization opportunities * Current storage layout (group data, member profiles, contributions, payouts) * 4 identified bottlenecks with status and measurable savings * Caching recommendations with TTLs (30s groups, 60s members, 10s contributions, 5m history) * Event-based invalidation patterns for real-time updates - Add frontend performance budget targets with current measurements * FCP: 1.5s (target < 1.8s) ✅ * LCP: 2.2s (target < 2.5s) ✅ * CLS: 0.05 (target < 0.1) ✅ * FID: 45ms (target < 100ms) ✅ * INP: 120ms (target < 200ms) ✅ * Lighthouse scores: Performance 88, Accessibility 92, Best Practices 87, SEO 89 * Bundle size: ~300KB (target < 350KB) - Expand caching best practices with React Query, browser storage, and Service Worker - Enhance performance monitoring with gas tracking, Web Vitals, custom metrics, Sentry - Add optimization roadmap (Phase 1-3 through Q4 2026) - Include 30+ production-ready code examples Document now includes 1,695 lines with 73 subsections and 15+ benchmark tables.
- ADR-001: Choice of Soroban over other smart contract platforms * Rationale: Low costs (~$0.000001), fast finality, financial focus * Alternatives: Ethereum, Polygon, Cosmos * Consequences: Smaller ecosystem but better alignment with mission - ADR-002: Sequential payout order default design decision * Rationale: Simple, predictable, matches traditional ROSCA practices * Alternatives: Random, auction-based, configurable * Consequences: Easy to audit but less flexible - ADR-003: Backend event indexing approach vs. pure on-chain queries * Rationale: 10-50x faster queries, better scalability * Alternatives: Pure Horizon API, hybrid, GraphQL * Consequences: Requires infrastructure but enables rich analytics - Add ADR README with format guidelines and index Preserves institutional knowledge for future maintainers.
|
@wendypetersondev Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Created Architecture Decision Records (ADRs) to document key architectural decisions and preserve institutional knowledge.
ADRs Created
ADR-001: Choice of Soroban Over Other Smart Contract Platforms
ADR-002: Sequential Payout Order Default Design Decision
ADR-003: Backend Event Indexing Approach vs. Pure On-Chain Queries
Documentation Structure
Benefits
✅ Preserves institutional knowledge
✅ Provides context for future maintainers
✅ Documents trade-offs and alternatives
✅ Enables informed decision-making
✅ Facilitates onboarding of new contributors
Related Issue
Closes #868