Skip to content

docs: add architecture and settlement overview#231

Draft
vku2018 wants to merge 1 commit into
Agentpay-Org:mainfrom
vku2018:grantfox-56-architecture-docs
Draft

docs: add architecture and settlement overview#231
vku2018 wants to merge 1 commit into
Agentpay-Org:mainfrom
vku2018:grantfox-56-architecture-docs

Conversation

@vku2018

@vku2018 vku2018 commented Jul 4, 2026

Copy link
Copy Markdown

Summary

  • add docs/architecture.md covering the Express composition root, middleware flow, in-memory stores, audit events, and pause/read behavior
  • document the record-usage -> quote -> settle lifecycle with Mermaid sequence diagrams
  • clarify that POST /api/v1/settle is an off-chain accounting drain and that durable storage/on-chain settlement are planned integration points
  • link the new architecture doc from the README documentation section

Closes #56

Validation

  • PASS: npm run build
  • PASS: npm run lint
  • PASS: tracked-source test run after build: $env:NODE_ENV='test'; node --test <tracked dist test files> (89 passing)
  • PASS: npx prettier --check docs/architecture.md
  • PASS: git diff --check
  • NOTE: npm test fails on Windows PowerShell before running tests because the script uses POSIX inline NODE_ENV=test.
  • NOTE: npm run format remains a repo-wide baseline failure across existing files; the new architecture doc passes Prettier directly.

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 architecture documentation explaining the off-chain mirror and on-chain settlement relationship

2 participants