Repository navigation
chore: Executed surplus fee in surplus token #2963
Description
Background
Both solver team and frontend team would like to have this field expressed over surplus token, instead of sell token. This would help a lot with showing complete breakdown of fees (network fee, protocol fee, total fee) as protocol fees are already calculated in surplus tokens.
Details
Steps:
- Add
executed_surplus_fee_tokento order_execution database table and populate historic entries with sell token of the order. - Expose the field
executed_surplus_fee_tokenover API wheneverexecuted_surplus_feeis exposed. - Switch to saving surplus fee in surplus token instead of sell token
So, bottom line, there will be a timestamp after which all fees will be in surplus token. For historic entries, executed surplus fee in sell token will remain.
Both solver and frontend team need to cope with this. I assume frontend will have to have a special IF to show things differently depending on if executed_surplus_fee is in sell token (for historic entries) or in surplus token (for new entries). There is also an alternative to try to convert executed_surplus_fee to surplus token for historic entries on the frontend side, where traded sell/buy amounts could be decent approximates (at least in most cases).
In the meantime, we decided to do a manual migration for historic entries, so that ALL fees will be expressed over SURPLUS token, so no special handling will be needed to support backward compatibility.
Acceptance criteria
Complete breakdown of taken fees is exposed on get_trades and get_order endpoints:
- network fee in surplus token
- protocol fees per fee policy, in surplus token
- total fee in surplus token (or maybe omitted since it can be calculated by summarizing (1) and (2))
Activity
fleupold commentedon Sep 10, 2024
Not sure about the naming (maybe we can finally drop the "surplus" from the field, given that there is no non surplus fee anymore and "surplus fee token" = surplus token is 🤯)
Otherwise I think the plan is sound since the surplus token can either be buy or sell token (and so the frontend in any case needs to handle both cases). It's just that for historic orders it will displayed in sell token regardless of order kind.
I'm just not sure in terms of priority if this is something we should do this quarter. cc @MartinquaXD
sunce86 commentedon Sep 11, 2024
Agreed, just wasn't sure if it's the right time for renaming. But why not, will adjust the field.
I was almost finished with the implementation when you posted the comment. Will finish it since already started, frontend will be happy about it.
github-actions commentedon Nov 11, 2024
This issue has been marked as stale because it has been inactive a while. Please update this issue or it will be automatically closed.
Executed total fee token (#2966)
Executed total fee token (#2966)
github-actions commentedon Mar 11, 2025
This issue has been marked as stale because it has been inactive a while. Please update this issue or it will be automatically closed.
MartinquaXD commentedon May 6, 2025
AFAICS this still depends on changes from @cowprotocol/frontend. Is this part of the roadmap?
alfetopito commentedon May 7, 2025
Yes.
Not sure we'll make it for Q2 at this point, but it's on our radar.