docs(log): document totalBalanceChf semantics and guardrails#3826
Merged
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
Adds documentation (comments only, no behavior change) explaining how to read
totalBalanceChfin theFinancialDataLog, so future contributors and agents interpret balance movements correctly — both from the code and from thedb-debugscript.BalancesTotalinterface (log.dto.ts) describing the invariant and the only three drivers of a total-balance change.LogJobService.scripts/db-debug.sh, so an agent using--balance/--anomalies/--statsunderstands the numbers without reading the source.Why
totalBalanceChf = plusBalanceChf - minusBalanceChf. Customer flow is balance-neutral: a deposit raises plus AND minus equally, and completing the order lowers both again, leaving only the fee. So the total is effectively the operating equity of the flow business and only moves due to:This clarifies why the two existing guardrails exist: the
valid: falseflag on jumps beyondConfig.financeLogTotalBalanceChangeLimit, and theminTotalBalanceChfsafety-mode floor. A sudden (especially negative) step is suspicious rather than customer activity.Test plan
npm run format:checknpm run lintnpm run type-checkbash -n scripts/db-debug.sh