docs(context): correct Source, Order Id, Instrument wire semantics#54
Merged
Conversation
Sharpen Source to operator-assigned and connection-independent; remove the "never on the wire" overclaims from Order Id and Instrument. Order Id travels OATH's Bus (Domain Events / frontend) but is never rendered to a venue id; the Instrument record is distributed to consumers, with fold-relevant attributes logged so Replay reproduces P&L. Aligns the glossary with ADR-0025 §5, ADR-0026, and ADR-0028. Closes #53 Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThree glossary entries in CONTEXT.md Glossary Alignment
🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
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
Aligns the
CONTEXT.mdglossary with the model's actual wire/distribution semantics,surfaced during a
/grill-with-docssession onoath-model. Glossary-only; no code.Source— sharpened to operator-assigned, connection-independent (one venue =one Source; redundancy/failover stays internal to the adapter). Required for stable
Accountidentity — a per-connection Source would split one broker account into twoidentities and double-count
Positions.Order Id— removed "never sent on the wire". It is never rendered to avenue id (no broker sees it), but it does travel OATH's Bus: it anchors the
Domain Eventaudit narrative and the order views aFrontendtracks.Instrument— removed "never travels on the wire or the Event Log". Therecord is distributed to consumers that need precision; fold-relevant attributes
(e.g.
multiplier) are logged Core inputs soReplayreproduces P&L, whiledisplay-only attributes (the
Symbolticker) refresh off-log.These overclaims contradicted ADR-0026 (carries
order_idin theOrderInstructionBus message) and ADR-0025 §5 (logs fold-relevant instrument metadata), and would
mislead implementation of the
oath-modelwire types.Test plan
just cigreen locally via the pre-push hook: fmt, typos, clippy, test, doc, machete,gitleaks, actionlint, shellcheck.
Closes #53
🤖 Generated with Claude Code
Summary by CodeRabbit