docs: add architecture and settlement overview#231
Draft
vku2018 wants to merge 1 commit into
Draft
Conversation
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.
Summary
docs/architecture.mdcovering the Express composition root, middleware flow, in-memory stores, audit events, and pause/read behaviorPOST /api/v1/settleis an off-chain accounting drain and that durable storage/on-chain settlement are planned integration pointsCloses #56
Validation
npm run buildnpm run lint$env:NODE_ENV='test'; node --test <tracked dist test files>(89 passing)npx prettier --check docs/architecture.mdgit diff --checknpm testfails on Windows PowerShell before running tests because the script uses POSIX inlineNODE_ENV=test.npm run formatremains a repo-wide baseline failure across existing files; the new architecture doc passes Prettier directly.