Accounting doc update, minor changes #570
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
WalkthroughAdds documentation to the auction accounting reference: a new top-level "Payout processing and operational adjustments" section with subsections on service fees for COW rewards, minimum transfer thresholds (dust handling), overdraft handling for negative net positions, and an "Auction price corrections" subsection. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
All contributors have signed the CLA ✍️ ✅ |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
docs/cow-protocol/reference/core/auctions/accounting.md (1)
113-115: Refine phrasing in dust handling threshold explanation.The phrase "very small transfers" uses imprecise language. Consider replacing "very" with a more specific descriptor that better conveys the intent (e.g., "minimal," "insignificant," or "sub-threshold").
Apply this diff to improve clarity:
-To avoid operational overhead from very small transfers, the accounting process enforces minimum transfer thresholds for both native-token and COW transfers. +To avoid operational overhead from minimal transfers, the accounting process enforces minimum transfer thresholds for both native-token and COW transfers.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/reference/core/auctions/accounting.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/reference/core/auctions/accounting.md
[style] ~115-~115: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ng) To avoid operational overhead from very small transfers, the accounting process enfor...
(EN_WEAK_ADJECTIVE)
🪛 markdownlint-cli2 (0.18.1)
docs/cow-protocol/reference/core/auctions/accounting.md
38-38: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🔇 Additional comments (1)
docs/cow-protocol/reference/core/auctions/accounting.md (1)
107-119: Well-structured additions to operational documentation.The new "Payout processing and operational adjustments" section clearly documents three important operational policies: COW reward service fees (with proper CIP-48 reference), dust handling thresholds, and overdraft treatment. The explanations integrate well with the existing accounting context and provide necessary detail for implementers.
| #### Auction price corrections | ||
|
|
||
| In rare cases where an auction price recorded for a specific token is clearly anomalous (for example, due to upstream data inconsistencies), the accounting process applies a curated correction list to override the affected auction/token price. These corrections are applied deterministically during the accounting so that protocol/partner/network fee conversions to the native token reflect the intended auction pricing. |
There was a problem hiding this comment.
Fix heading hierarchy violation.
The "Auction price corrections" subsection uses an h4 heading (####) where an h3 heading (###) is expected. Markdown heading levels must increment by one at a time. Since this is a subsection under "Protocol and partner fees" (h2), it should be h3 to match the pattern of other subsections like "Protocol and partner fees in the settlement contract" (line 51).
Apply this diff to fix the heading level:
-#### Auction price corrections
+### Auction price corrections📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| #### Auction price corrections | |
| In rare cases where an auction price recorded for a specific token is clearly anomalous (for example, due to upstream data inconsistencies), the accounting process applies a curated correction list to override the affected auction/token price. These corrections are applied deterministically during the accounting so that protocol/partner/network fee conversions to the native token reflect the intended auction pricing. | |
| ### Auction price corrections | |
| In rare cases where an auction price recorded for a specific token is clearly anomalous (for example, due to upstream data inconsistencies), the accounting process applies a curated correction list to override the affected auction/token price. These corrections are applied deterministically during the accounting so that protocol/partner/network fee conversions to the native token reflect the intended auction pricing. |
🧰 Tools
🪛 markdownlint-cli2 (0.18.1)
38-38: Heading levels should only increment by one level at a time
Expected: h3; Actual: h4
(MD001, heading-increment)
🤖 Prompt for AI Agents
In docs/cow-protocol/reference/core/auctions/accounting.md around lines 38 to
40, the "Auction price corrections" heading is currently an h4 (####) but should
be an h3 (###) to follow the document hierarchy under the h2 "Protocol and
partner fees"; change the heading marker from #### to ### so heading levels
increment by one and match neighboring subsections.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
docs/cow-protocol/reference/core/auctions/accounting.md (1)
109-111: Minor style refinement: replace intensifier "very".The phrase "very small transfers" uses an over-used intensifier. Consider a more direct phrasing to improve clarity.
-To avoid operational overhead from very small transfers, the accounting process enforces minimum transfer thresholds for both native-token and COW transfers. If a computed transfer amount is below the configured chain-specific threshold, that amount is not transferred for the given accounting period. +To avoid operational overhead from minimal transfers, the accounting process enforces minimum transfer thresholds for both native-token and COW transfers. If a computed transfer amount is below the configured chain-specific threshold, that amount is not transferred for the given accounting period.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/reference/core/auctions/accounting.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/reference/core/auctions/accounting.md
[style] ~111-~111: As an alternative to the over-used intensifier ‘very’, consider replacing this phrase.
Context: ...ng) To avoid operational overhead from very small transfers, the accounting process enfor...
(EN_WEAK_ADJECTIVE)
🔇 Additional comments (2)
docs/cow-protocol/reference/core/auctions/accounting.md (2)
103-119: Heading hierarchy is now correct.The "Auction price corrections" subsection at line 117 now properly uses h3 (###) instead of h4 (####), maintaining consistent hierarchy with the other subsections under the h2 "Payout processing and operational adjustments" heading. This resolves the previous review concern.
103-119: Documentation addition is well-structured and complete.The new "Payout processing and operational adjustments" section integrates smoothly with existing documentation. All four subsections (service fees, dust handling, overdraft handling, and price corrections) are clearly explained, properly referenced (CIP-48 link), and maintain consistent terminology with the broader document.
|
I have read the CLA Document and I hereby sign the CLA |
|
recheck |
Description
Changes
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.