docs(contracts): write architecture decision record (ADR) for Merkle … - #246
Open
HassanKorey wants to merge 1 commit into
Open
docs(contracts): write architecture decision record (ADR) for Merkle …#246HassanKorey wants to merge 1 commit into
HassanKorey wants to merge 1 commit into
Conversation
…receipt structure
|
@HassanKorey 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! 🚀 |
|
MergeKeeper review Scope: in scope for linked issue The ADR correctly documents the sorted-pair Merkle tree structure, mechanics, Mermaid diagram, trade-offs, and security context as requested in the issue. Reviewed commit: |
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.
docs(contracts): write architecture decision record (ADR) for Merkle receipt structure
Summary
This pull request introduces
ADR-001-merkle-structure.mdto formally document the "sorted-pair SHA-256" strategy utilized by theReceiptAnchorand off-chain SDK for Merkle tree construction.Without context, this specific approach can look like a non-standard deviation. The newly added ADR details:
payment_ref) constraints.Contract Change Safety Checklist
Please verify that your changes adhere to contract stability requirements:
docs/EVENTS.md)CHANGELOG.md?DEPLOYMENTS.mdbeen documented?cargo test) and/or exercised on Soroban testnet?Related Issues
Closes #81