Repository navigation
Document that signed feeAmount must be zero #663
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -75,6 +75,22 @@ If developing smart contracts that create orders, make sure at a contract level | |||||
|
|
||||||
| ::: | ||||||
|
|
||||||
| ### Signed fee amount | ||||||
|
|
||||||
| The order struct still contains a `feeAmount` field, which the settlement contract honors: if an order is signed with a non-zero `feeAmount`, that amount is transferred from the user in addition to the executed sell amount (pro rata for partially fillable orders). | ||||||
| The limit price is checked against `sellAmount` and `buyAmount` only, so the minimum effective rate of an order with a signed fee is `buyAmount / (sellAmount + feeAmount)` (the trade may execute at this rate or better). | ||||||
|
|
||||||
| The protocol no longer uses signed fees. Fees are included in the order's limit price, and the API rejects any order with a non-zero `feeAmount` (`NonZeroFee` error). On-chain orders (e.g. ETH flow) with a non-zero fee are recorded with a placement error and excluded from auctions. | ||||||
|
|
||||||
| Charging the signed `feeAmount` once per order, and the resulting effective price, is expected behavior: the user explicitly signed both. | ||||||
| This doesn't apply to orders with zero amounts, which can be executed more than once and charge the fee repeatedly (see [Orders with zero amounts](#orders-with-zero-amounts)). | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The entire reason we are writing this section in the docs I think comes down to this last sentance right here, right, where the feeAmount can be charged multiple times? This should be more clearly explained and stated rather than talking about the fee amount in general, as the focus here is to document known security vulnerabilities. Something like: |
||||||
|
|
||||||
| :::tip | ||||||
|
|
||||||
| Always sign orders with `feeAmount = 0`. | ||||||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. idk why, maybe one of those english things, but Would feel better to state the opposite
Suggested change
|
||||||
|
|
||||||
| ::: | ||||||
|
|
||||||
| ### `ERC-1271` Replayability | ||||||
|
|
||||||
| The security of [`ERC-1271`](../core/signing-schemes#erc-1271) signatures depend on the developers' implementation of the _signing smart contract_. | ||||||
|
|
||||||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -99,7 +99,7 @@ This key maps to a list containing the set of orders in the batch. Each entry in | |
| - `quote`: the winning quote for that order. | ||
| - `penaltyCapNative`: a stringified integer denoting the cap on the penalty a solver can incur for winning this order but not settling it within the auction deadline, measured in terms of the smallest denomination of the native token of the chain. See the [solver rewards](/cow-protocol/reference/core/auctions/rewards#penalty-caps) page for how this cap is computed and used. | ||
|
|
||
| We clarify here that all `market` orders have a potentially non-zero predetermined fee, while all `limit` orders have necessarily a zero signed fee, and the actual fee charged to the order is computed and provided by the solvers when they propose an execution of such an order. More details are provided in the [solutions section](#solutions-output). | ||
| We clarify here that all orders have a zero signed fee (`feeAmount`), and the actual fee charged to the order is computed and provided by the solvers when they propose an execution of such an order. More details are provided in the [solutions section](#solutions-output). | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 🗄️ Data Integrity & Integration | 🟡 Minor | ⚡ Quick win Clarify the solution fee mode. Line 102 says each auction order has 🤖 Prompt for AI Agents
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The auction example includes
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also, the example says the fee is zero because this is a limit order. The new text says every auction order has a zero signed fee. Please update the example. |
||
|
|
||
| An example Fill-or-Kill user limit buy order that sells 1000 [COW](https://etherscan.io/token/0xdef1ca1fb7fbcdc777520aa7f396b4e015f497ab) for at least 284.138335 USDC [USDC](https://etherscan.io/token/0xba100000625a3754423978a60c9317c58a424e3d) is given below: | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is struct the right word here?