docs(escrow): document undocumented public methods in escrow services - #710
Merged
Conversation
|
@chainsmt 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.
Adds JSDoc to the 14 previously undocumented public methods across the escrow services so their behaviour and non-obvious constraints are captured at the source.
buyer-dispute.service.ts:openDispute,getDisputeescrow.service.ts:getTracking,createEscrow,createIdempotent,findById,getEvents,getPublicEscrow,findVendorEscrows,generateEvidenceUploadUrl,cancelEscrow,cancelPendingEscrow,handleShipment,syncStateFromChainEach block explains what the method does and records what the signature alone does not convey: participant/state preconditions and the errors thrown, write/notification ordering, idempotency and caching behaviour, on-chain reconciliation rules, and deliberate non-actions (e.g.
createEscrowdoes not fund,cancelEscrownever touches the chain,getEvents/findVendorEscrowsperform no existence check or authorisation).Documentation only — no behaviour, signature, or test changes.
Verification:
npm run lint— passes (0 errors)npx tsc --noEmit— passesCloses #661