Update the_problem.md #497
Conversation
Changed UCP rule to "directional" Changed the description of the auction to better fit the "Fair combinatorial auction"
WalkthroughThe documentation update refines the auction protocol's price uniformity constraint from a global to a directional scope, specifying that users trading the same token pair in the same direction receive identical prices. It also corrects the scoring formula for buy orders and clarifies the treatment of gas costs and order hooks. 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 (1)
docs/cow-protocol/reference/core/auctions/the_problem.md (1)
84-84: Minor grammar and clarity adjustment.To improve readability, consider adding a comma in the compound clause and making the article usage more explicit. For example:
- From the protocol viewpoint, each solution that satisfies the above constraints has a _score_ that is given by the total surplus generated and the fees paid to the protocol, all aggregated and denominated in some numéraire. + From the protocol viewpoint, each solution that satisfies the above constraints has a _score_ that is given by the total surplus generated, the fees paid to the protocol, and any additional components, all aggregated and denominated in some numéraire. - the score of a solution is equal to the sum of scores of the orders the solution proposes to execute + the score of a solution is equal to the sum of the scores of the orders that the solution proposes to execute🧰 Tools
🪛 LanguageTool
[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)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 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)
⏰ Context from checks skipped due to timeout of 90000ms (1)
- GitHub Check: cla
🔇 Additional comments (2)
docs/cow-protocol/reference/core/auctions/the_problem.md (2)
74-74: Directional price uniformity clarified.The updated bullet correctly narrows the uniform price constraint to a per-pair, per-direction basis and mentions gas‐cost deviations. This aligns precisely with the PR objective to define “Uniform directional clearing prices.”
87-87: Corrected buy-order scoring formula.Switching from division by π to multiplication by π accurately reflects the intended economic interpretation for buy orders and matches the PR’s specification.
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
Changed UCP rule to "directional"
Changed the description of the auction to better fit the "Fair combinatorial auction"
Summary by CodeRabbit