updating problem definition for combinatorial auctions

[harisang]

Accidentally messed up @acanidio-econ PR (see here for the actual changes: 983c25b)

so i am reproposing the changes here.

Sorry about that

Summary by CodeRabbit

• Documentation
  • Updated the definition of uniform pricing to clarify it applies to users trading the same token pair in the same direction and allows for gas cost adjustments.
  • Corrected the scoring formula for buy orders.
  • Simplified the explanation of how fees are specified in the scoring formula.
  • Clarified the description of solver competition and referenced additional competition rules.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated (UTC)
docs	✅ Ready (Inspect)	Visit Preview	Jun 16, 2025 10:18am

[coderabbitai]

Walkthrough

The documentation for the Cow Protocol auction mechanism was updated to clarify the uniform pricing constraint, correct the buy order scoring formula, simplify the fee explanation, and update the description of solver competition. No changes were made to code or exported/public entities.

Changes

File(s)	Change Summary
docs/cow-protocol/reference/core/auctions/the_problem.md	Updated uniform pricing constraint definition, corrected buy order scoring formula, simplified fee explanation, and revised solver competition description.

Poem

In the meadow of docs, a breeze of change,
Uniform prices now with a directional range.
Scoring tweaked, formulas set right,
Fees made simple, clear in the light.
Solvers compete, fair and aware—
Protocol progress, handled with care! 🐇✨

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Explain this complex logic.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai explain this code block.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need 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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

docs/cow-protocol/reference/core/auctions/the_problem.md (1)

84-84: Refine phrasing for correctness and clarity.
Consider revising “From the protocol viewpoint” to “From the protocol’s viewpoint” and adding a comma before “and the fees paid to the protocol” to improve the sentence flow.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2e9f4bb and b17f82c.

📒 Files selected for processing (1)

• docs/cow-protocol/reference/core/auctions/the_problem.md (2 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/cow-protocol/reference/core/auctions/the_problem.md

[grammar] ~84-~84: It looks like you are using the wrong form of the noun or the verb. Did you mean “constraint has” or “constraints have”?
Context: ... each solution that satisfies the above constraints has a score that is given by the total su...

(NOUN_PLURAL_HAS)

---

[uncategorized] ~84-~84: Use a comma before “and” if it connects two independent clauses (unless they are closely connected and short).
Context: ... is given by the total surplus generated and the fees paid to the protocol, all aggr...

(COMMA_COMPOUND_SENTENCE_2)

---

[uncategorized] ~84-~84: You might be missing the article “the” here.
Context: ...re of a solution is equal to the sum of scores of the orders the solution proposes to ...

(AI_EN_LECTOR_MISSING_DETERMINER_THE)

---

[misspelling] ~89-~89: Did you mean “for sale”?
Context: ...en of the order (i.e., in the buy token for sell orders and in the sell token for buy or...

(FOR_SELL)

🔇 Additional comments (3)

docs/cow-protocol/reference/core/auctions/the_problem.md (3)

74-74: Uniform directional clearing prices clarification is correct.
The updated wording scopes uniform pricing to the same token pair and direction, and appropriately notes allowed deviations for extra gas costs.

---

87-87: Buy order scoring formula adjustment is accurate.
Multiplying by the limit price (π) now correctly reflects the intended scoring logic for buy orders, replacing the former division.

---

89-89: Fees specification note is accurate.
Clarifying that fees are denominated in the surplus token for both sell and buy orders enhances transparency and aligns with current protocol behavior.

[pretf00d]

Looks good.