Skip to content

docs: resolve issues 895-898 documentation updates - #964

Merged
fejilaup-cloud merged 4 commits into
AtomicIP:mainfrom
benjaminjohnsonfin-afk:docs/issues-895-896-897-898
Aug 31, 2026
Merged

docs: resolve issues 895-898 documentation updates#964
fejilaup-cloud merged 4 commits into
AtomicIP:mainfrom
benjaminjohnsonfin-afk:docs/issues-895-896-897-898

Conversation

@benjaminjohnsonfin-afk

Copy link
Copy Markdown
Contributor

Summary

Documentation updates addressing technical gaps and clarity improvements across multiple docs:

Changes Made

Issue #895 - threat-model.md

Issue #896 - api-reference.md

  • Added "Not yet implemented" markers for stubbed API handlers:
    • batch_commit_ip (line 752 in handlers.rs)
    • verify_commitment (line 167 in handlers.rs)
    • transfer_ip (line 138 in handlers.rs)
    • get_ip (line 117 in handlers.rs)
  • Clarifies contract functionality exists but REST API integration is pending

Issue #897 - atomic-swap.md

Issue #898 - commitment-scheme.md

  • Enhanced differential invariant section (Add differential test between zk_commitment and verify_commitment #818) with performance benchmarks
  • Added CPU instruction budgets for both verification paths:
    • SHA-256 full-reveal: ≤200,000 instructions
    • ZK Schnorr (single): ≤5,000,000 instructions
    • ZK Schnorr (batch of 10): ≤50,000,000 instructions
  • Added guidance for choosing between privacy-focused vs performance-optimized paths

Closes #895
Closes #896
Closes #897
Closes #898

Update threat-model.md to mark the treasury trustline gap as resolved. PR AtomicIP#942
fixed the protocol_config().treasury placeholder issue, allowing bond forfeiture
to be sent to the actual treasury address. Closes AtomicIP#895
Add implementation status markers for endpoints with TODO stubs in handlers.rs:
- batch_commit_ip (line 752)
- verify_commitment (line 167)
- transfer_ip (line 138)
- get_ip (line 117)

Clarifies that the contract functionality exists but REST API integration
is not yet complete. Closes AtomicIP#896
Add a 'Known Limitations / Test Coverage Gaps' section documenting disabled test
modules (tests, regression_tests, benchmarks) and recently re-enabled test suites.
Lists the issues associated with each re-enable fix and clarifies implications
for integrators regarding test coverage and guarantee verification.

Closes AtomicIP#897
… benchmarks

Add performance comparison section to the differential invariant (AtomicIP#818) documentation.
Includes CPU instruction budgets for both verification paths:
- SHA-256 full-reveal path: ≤200,000 instructions
- ZK Schnorr path: ≤5M (single) / ≤50M (batch of 10)

Clarifies the trade-off between privacy and performance for integrators choosing
a verification path. Emphasizes that the differential tests enforce invariant
agreement between both paths at the code level.

Closes AtomicIP#898
@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@benjaminjohnsonfin-afk 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 7e4b514 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

Labels

None yet

Projects

None yet

2 participants