Skip to content

docs(escrow): document undocumented public methods in escrow services - #710

Merged
Omoboi-dev merged 2 commits into
JSE-ORG:devfrom
chainsmt:feat/issue-661
Aug 31, 2026
Merged

docs(escrow): document undocumented public methods in escrow services#710
Omoboi-dev merged 2 commits into
JSE-ORG:devfrom
chainsmt:feat/issue-661

Conversation

@chainsmt

Copy link
Copy Markdown
Contributor

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, getDispute
  • escrow.service.ts: getTracking, createEscrow, createIdempotent, findById, getEvents, getPublicEscrow, findVendorEscrows, generateEvidenceUploadUrl, cancelEscrow, cancelPendingEscrow, handleShipment, syncStateFromChain

Each 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. createEscrow does not fund, cancelEscrow never touches the chain, getEvents/findVendorEscrows perform no existence check or authorisation).

Documentation only — no behaviour, signature, or test changes.

Verification:

  • npm run lint — passes (0 errors)
  • npx tsc --noEmit — passes

Closes #661

@chainsmt
chainsmt requested a review from Omoboi-dev as a code owner August 31, 2026 08:40
@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

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

Learn more about application limits

@Omoboi-dev
Omoboi-dev merged commit 9ab5840 into JSE-ORG:dev Aug 31, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document the 14 undocumented public methods in the escrow services

2 participants