Skip to content

docs: add diagrams-as-code for payment flows and escrow lifecycle - #506

Merged
devJaja merged 1 commit into
Epta-Node:mainfrom
gospeltout:Add-diagrams-as-code-for-payment-flows-
Aug 31, 2026
Merged

docs: add diagrams-as-code for payment flows and escrow lifecycle#506
devJaja merged 1 commit into
Epta-Node:mainfrom
gospeltout:Add-diagrams-as-code-for-payment-flows-

Conversation

@gospeltout

Copy link
Copy Markdown
Contributor

Summary

Added comprehensive diagrams-as-code and technical documentation for payment flows, escrow lifecycle state transitions, dispute resolution, and economic reconciliation. Also integrated illustrated empty states with guidance CTAs across all list views.

Changes

  • Payment & Escrow Lifecycle Docs: Created docs/architecture/payment-escrow-lifecycle.md featuring an Escrow State Machine matrix and 6 Mermaid sequence diagrams (Task Funding & Bidding, Token Locking, Escrow Release, Escrow Refund, Dispute Resolution, and Ledger Reconciliation) matching Soroban smart contracts (agent_bidding, dispute_resolution).
  • Architecture Overview: Updated docs/architecture/index.md with an embedded Payment & Escrow Architecture section.
  • Node Operators Guide: Added Step 6.4 to docs/NODE_OPERATORS_GUIDE.md detailing settlement guidelines and juror dispute participation.
  • Glossary: Updated docs/GLOSSARY.md with escrow lifecycle sequence diagram cross-references.
  • Illustrated Empty States: Created reusable EmptyState component (EmptyState.tsx, EmptyState.module.css, EmptyState.test.tsx) and applied it to Tasks, Agents, History, Payments, and Notifications list pages.

Verification & Testing

  • npm test (Backend/Frontend) — 34/34 test files & 251/251 tests passing.
  • cargo fmt --check (Smart Contract formatting)
  • Mermaid diagram syntax & rendering validation across markdown docs.

Contributor Checklist

  • PR title follows Conventional Commits (docs(architecture): add diagrams-as-code for payment flows and escrow lifecycle (#354))
  • All CI checks pass locally
  • Documentation updated in docs/ or README.md if applicable
  • No secrets or credentials committed

Closes #374

@drips-wave

drips-wave Bot commented Aug 31, 2026

Copy link
Copy Markdown

@gospeltout 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

@vercel

vercel Bot commented Aug 31, 2026

Copy link
Copy Markdown

@gospeltout is attempting to deploy a commit to the Jaja's projects Team on Vercel.

A member of the Team first needs to authorize it.

@devJaja
devJaja merged commit 56413c2 into Epta-Node: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

Development

Successfully merging this pull request may close these issues.

Add diagrams-as-code for payment flows and escrow lifecycle

2 participants