docs: resolve issues 895-898 documentation updates - #964
Merged
fejilaup-cloud merged 4 commits intoAug 31, 2026
Merged
Conversation
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
|
@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! 🚀 |
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
Documentation updates addressing technical gaps and clarity improvements across multiple docs:
docs/threat-model.mdto close out the #781 treasury-trustline note #895: Resolve treasury-trustline issue in threat-model.md (PR fix(#831-#834): staleness boundary tests, full lifecycle cross-contra… #942 fix confirmed)docs/api-reference.mdwith the currently-stubbed handlers #896: Mark stubbed API handlers in api-reference.md for claritydocs/atomic-swap.md#897: Add known limitations section to atomic-swap.md documenting disabled test modulesdocs/commitment-scheme.mdwith the partial-disclosure differential-test invariant #898: Enhance commitment-scheme.md with differential test invariant and performance benchmarksChanges Made
Issue #895 - threat-model.md
Issue #896 - api-reference.md
Issue #897 - atomic-swap.md
batch_swap_features_tests.rsand fix the underlying treasury bug #825, Consolidate hardcoded protocol treasury address across contract and tests #831, Add explicit test forvalidate_upgrade-equivalent logic inupgrade.rs#832, Dispute resolution is a single-key instant ruling with none of the threat model's documented safeguards implemented #781, Audit and fix thearbitration_tests.rsre-enable for full correctness #830, Re-enableprop_tests.rs(property-based tests) #828, Re-enablechaos_tests.rs#829)Issue #898 - commitment-scheme.md
zk_commitmentandverify_commitment#818) with performance benchmarksCloses #895
Closes #896
Closes #897
Closes #898