Update competition_rules.md #498
Conversation
I removed the description of the batch auction and instead now discuss the fair combinatorial auction. Note the following: - we didn't have a specific page where we described the batch auction, and I kept this same structure. However, given that the fair combinatorial auction is more complex, then we may want to consider creating a dedicated page for it - I don't explain the specific algorithm we use to select winners, and instead I just provide a link to the CIP (in my mind, whether we do want to discuss the winner selection algorithm depends on whether we want to introduce a specific page in the docs dedicated to the fair combinatorial auction) - I kept the discussion about EBBO since, technically, it is still a rule
WalkthroughThe documentation for the off-chain protocol's auction competition rules has been updated. The uniform clearing price rule is replaced with a uniform directional clearing price (UDCP) rule. The auction process, scoring, bid selection, penalties, reward mechanisms, and governance enforcement are now described in greater detail, referencing relevant CIP proposals. Changes
Poem
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
docs/cow-protocol/reference/core/auctions/competition_rules.md (2)
23-23: Refine grammar in auction description
The phrase “is chosen using a Fair Combinatorial Auction” can be made more natural. For example:- The set of winning solutions (and corresponding winning solvers) is chosen using a Fair Combinatorial Auction (see [CIP-67](…)). + The set of winning solutions (and corresponding winning solvers) is selected using a Fair Combinatorial Auction (see [CIP-67](…)).🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: If ‘chosen’ is used as a verb, it usually requires the infinitive.
Context: ...orresponding winning solvers) is chosen using a Fair Combinatorial Auction (see [CIP-...(AFFORD_VBG)
23-25: Consider extracting detailed logic to its own page
This high-level summary of the Fair Combinatorial Auction is quite detailed and may overwhelm the main rules page. Splitting it into a dedicatedfair-combinatorial-auction.mdreference and linking to it here could improve readability and maintainability.🧰 Tools
🪛 LanguageTool
[grammar] ~23-~23: If ‘chosen’ is used as a verb, it usually requires the infinitive.
Context: ...orresponding winning solvers) is chosen using a Fair Combinatorial Auction (see [CIP-...(AFFORD_VBG)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/cow-protocol/reference/core/auctions/competition_rules.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
docs/cow-protocol/reference/core/auctions/competition_rules.md
[grammar] ~23-~23: If ‘chosen’ is used as a verb, it usually requires the infinitive.
Context: ...orresponding winning solvers) is chosen using a Fair Combinatorial Auction (see [CIP-...
(AFFORD_VBG)
🔇 Additional comments (2)
docs/cow-protocol/reference/core/auctions/competition_rules.md (2)
21-21: UDCP rule insertion looks good
The new Uniform Directional Clearing Prices (UDCP) rule clearly replaces the old UCP description and properly highlights the per-solution constraint and hook exception.
21-21: Verify UDCP reference
Consider adding a direct link to the CIP or specification that formally defines “Uniform Directional Clearing Prices (UDCP)” so that readers unfamiliar with the term can find the authoritative source.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
I removed the description of the batch auction and instead now discuss the fair combinatorial auction.
Note the following:
Description
Changes
Summary by CodeRabbit