Skip to content

docs: Add JS architecture, testing strategy, API examples, and security hardening - #965

Merged
fejilaup-cloud merged 4 commits into
AtomicIP:mainfrom
famvilianity-eng:feat/issues-899-900-901-902
Aug 31, 2026
Merged

docs: Add JS architecture, testing strategy, API examples, and security hardening#965
fejilaup-cloud merged 4 commits into
AtomicIP:mainfrom
famvilianity-eng:feat/issues-899-900-901-902

Conversation

@famvilianity-eng

Copy link
Copy Markdown
Contributor

Summary

Comprehensive documentation updates across four areas:

Changes

Architecture (#899)

  • Added "JavaScript Processing Layer" section showing batch, insurance, matching, reputation, royalty modules
  • Mermaid diagram of JS layer integration with Soroban contracts
  • Module responsibilities table
  • Integration flow explanation

Testing Strategy (New file, #900)

  • Complete inventory of enabled test modules across ip_registry and atomic_swap
  • List of 5 disabled test modules with reasons and cleanup tracking
  • Cleanup plan with phased re-enabling steps
  • Test execution commands and re-enable instructions
  • Known issues section

Integration Guide (#901)

  • Added REST API section with real JSON request/response examples
  • Covers: list IPs, get IP record, initiate swap, accept swap, reveal key
  • Includes success (200/201) and error (400/404) responses
  • Realistic data shapes and values

Security Hardening (#902)

  • Request Signing: Ed25519 signature scheme, signing payload format, header requirements, example Python code
  • Rate Limiting: Tier table (Free/Premium/Enterprise), token-bucket algorithm, rate-limit headers, backoff strategy, multi-instance deployment modes
  • Circuit Breaker: State machine diagram, configuration parameters, named breakers, metrics, Prometheus alerting expressions

Closes #899
Closes #900
Closes #901
Closes #902

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
@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@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! 🚀

Learn more about application limits

@fejilaup-cloud
fejilaup-cloud merged commit eb1ae35 into AtomicIP:main Aug 31, 2026
1 check failed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment