docs: document OnChainBalance in core domain model - #264
Merged
Conversation
PR #262 added core.ledger.OnChainBalance and BalanceCalculator.computeOnChain() for the per-token on-chain balance breakdown, but docs/domain-model.md — the reference spec for the core module — never mentioned it. Signed-off-by: Claude <noreply@anthropic.com>
|
ⓘ Qodo reviews are paused because the subscription is no longer active. Ask your workspace admin to reactivate the subscription to resume reviews. Manage billing |
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
2 participants
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/domain-model.mdis the reference spec for thecoremodule, but it never covered the balance domain at all. PR #262 (feat: per-token on-chain balance breakdown on GET /balance) addedfinance.idem.core.ledger.OnChainBalanceandBalanceCalculator.computeOnChain(), and that gap is now visible: the doc documents every othercore.ledgerclass (Account,JournalLine,Transaction,Settlement, repository interfaces) but not this one.Adds a new "Balance domain — OnChainBalance" section, in the same style as the existing "Reconciliation domain — Settlement" section: package, purpose, signature, and behavior notes (per-token netting across chains, sorted by token name, DEBIT/CREDIT convention, empty list for fiat-only accounts), plus a pointer to where it's surfaced (
GET /balance,getBalanceMCP tool,docs/mcp-server.md).No code changes — documentation only.
Test plan
./mvnw clean verifypasses locallyN/A — documentation-only change, no code touched.
Checklist
git commit -s) — required by DCOcoreorapplication(Spring/JPA/web/persistence/etc)Generated by Claude Code