Skip to content

Only use score and not quality as a term #475

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Apr 16, 2025

Conversation

harisang
Copy link
Contributor

@harisang harisang commented Apr 3, 2025

This PR removes the term "quality" that was still used in the solver/mechanism documentation and only uses score, as using both terms created unnecessary confusion.

@harisang harisang requested a review from a team as a code owner April 3, 2025 01:15
Copy link

vercel bot commented Apr 3, 2025

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

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Apr 14, 2025 2:35pm

@@ -92,12 +92,12 @@ At CoW DAO's discretion, systematic violation of these rules may lead to penaliz

More details about how a certificate of an EBBO violation is computed, and what are the steps taken in case such a violation occurs can be found in [this](/cow-protocol/reference/core/auctions/ebbo-rules) section.

- Inflation of the objective function ([CIP-11](https://snapshot.org/#/cow.eth/proposal/0x16d8c681d52b24f1ccd854084e07a99fce6a7af1e25fd21ddae6534b411df870)). Using tokens for the sole purpose of inflating the objective value or maximizing the reward is forbidden (e.g., by creating fake tokens, or wash-trading with real tokens).
- Inflation of the score ([CIP-11](https://snapshot.org/#/cow.eth/proposal/0x16d8c681d52b24f1ccd854084e07a99fce6a7af1e25fd21ddae6534b411df870)). Using tokens for the sole purpose of inflating the score of a solution or maximizing the reward is forbidden (e.g., by creating fake tokens, or wash-trading with real tokens).

- Illegal use of internal buffers ([CIP-11](https://snapshot.org/#/cow.eth/proposal/0x16d8c681d52b24f1ccd854084e07a99fce6a7af1e25fd21ddae6534b411df870)). The internal buffers may only be used to replace legitimate AMM interactions available to the general public for the purpose of saving transaction costs, and also to allow for the successful execution of settlements that occur some slippage. However, systematic and intentional buffer trading with tokens that are not safe, although will be accounted for as slippage, is discouraged as it poses a significant inventory risk to the protocol, and solvers that do so can be flagged and potentially slashed. In general, any attack vector to the internal buffers that is created by a solver can be considered a malicious and illegal behavior.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"occur some slippage" needs to change to "incur slippage"

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch!

@@ -41,11 +41,11 @@ The payment is capped from above and below using the function $$\textrm{cap}(x)
- Ethereum mainnet, Arbitrum, and Base chain: $$c_l = 0.010 \;\textrm{ETH}$$ and $$c_u = 0.012 \;\textrm{ETH}$$,
- Gnosis Chain: $$c_l = c_u = 10 \;\textrm{xDAI}$$.

Submitted scores that are non-positive will be ignored. If only one solution is submitted, $$\textrm{referenceQuality}$$ is set to zero. Formally, this corresponds to always considering the empty solution which does not settle any trades and has quality zero as part of the submitted solutions.
Submitted scores that are non-positive will be ignored. If only one solution is submitted, $$\textrm{referenceScore}$$ is set to zero. Formally, this corresponds to always considering the empty solution which does not settle any trades and has score equal to zero as part of the submitted solutions.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"does not settle any trades and has score equal to" --> "does not settle any trades and has a score equal to"


:::note

There is no guarantee that the per-auction rewards are greater than the gas costs of executing a transaction. Hence, solvers cover these costs by adjusting their reported quality. Of course, a solver who adjusts quality downward too aggressively is then at a disadvantage in the auction. The mechanism, therefore, incentivizes the accurate estimation of gas costs.
There is no guarantee that the per-auction rewards are greater than the gas costs of executing a transaction. Hence, solvers cover these costs by adjusting their reported score. Of course, a solver who adjusts score downward too aggressively is then at a disadvantage in the auction. The mechanism, therefore, incentivizes the accurate estimation of gas costs.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Of course, a solver who adjusts score downward too aggressively is then at a disadvantage in the auction." --> "Of course, a solver who adjusts their score downward too aggressively is at a disadvantage in the auction."

Copy link

@pretf00d pretf00d left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey guys, dropped a few comments in.

@harisang
Copy link
Contributor Author

Hey guys, dropped a few comments in.

Thanks! Addressed all comments

@harisang harisang merged commit 6252226 into main Apr 16, 2025
4 checks passed
@harisang harisang deleted the cleanup_of_technical_solver_documentation branch April 16, 2025 11:07
@github-actions github-actions bot locked and limited conversation to collaborators Apr 16, 2025
@harisang
Copy link
Contributor Author

Merging as we need to do a follow-up PR with the CIP-65 changes

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants