docs: Add JS architecture, testing strategy, API examples, and security hardening - #965
Merged
fejilaup-cloud merged 4 commits intoAug 31, 2026
Conversation
Adds comprehensive documentation of src/ layer modules (batch, insurance, matching, reputation, royalty) and their integration with Soroban contracts and REST API server. Clarifies module responsibilities and data flow through the system. Closes AtomicIP#899
Adds comprehensive test suite documentation covering enabled/disabled test modules across ip_registry, atomic_swap contracts and api-server. Documents cleanup plan tied to issue AtomicIP#82 and provides guidance for re-enabling disabled tests. Closes AtomicIP#900
Adds comprehensive examples showing actual JSON request/response payloads for core API operations: list IPs, get IP record, initiate swap, accept swap, and reveal key. Includes success and error response codes with realistic data shapes and values. Closes AtomicIP#901
Adds comprehensive sections on Ed25519 request signing scheme with step-by-step signature generation, timestamp validation, and replay prevention. Includes rate limiting tier details and token-bucket algorithm. Documents RPC circuit breaker state machine, configuration parameters, metrics, and alerting recommendations. Closes AtomicIP#902
|
@famvilianity-eng 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
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.
Summary
Comprehensive documentation updates across four areas:
docs/testing-strategy.mddocumenting the disabled-module cleanup plan #900 — Createdocs/testing-strategy.mdwith full test suite status, tracking cleanup plan tied to issue Add SECURITY.md with vulnerability disclosure policy #82docs/integration-guide.mdwith real request/response examples once handlers are wired #901 — Add real REST API request/response examples for all core operations (list IPs, get IP, initiate/accept swap, reveal key)docs/security.mdwith request-signing and RPC circuit-breaker details #902 — Document Ed25519 request-signing scheme, rate-limit tiers, circuit-breaker state machine, and Prometheus metricsChanges
Architecture (
#899)Testing Strategy (New file,
#900)Integration Guide (
#901)Security Hardening (
#902)Closes #899
Closes #900
Closes #901
Closes #902