Skip to content
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

Update batch auction documentation #449

Open
wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Conversation

bram-vdberg
Copy link
Contributor

Description

This PR updates the batch auction documentation

Copy link

vercel bot commented Feb 6, 2025

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

Name Status Preview Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview Feb 14, 2025 5:38am

@bram-vdberg bram-vdberg marked this pull request as ready for review February 6, 2025 15:16
@bram-vdberg bram-vdberg requested a review from a team as a code owner February 6, 2025 15:16
@bram-vdberg bram-vdberg requested a review from a team February 6, 2025 15:17
- `signingScheme`: a string of the set {"eip712", "ethsign", "presign", "eip1271"}.
- `signature`: hex encoded bytes with `0x` prefix.
- `protocolFees`: array of any protocol fee policies that apply to the order.
- `quote`: the winning quote for that order.

We clarify here that all `market` and `liquidity` 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).
Copy link
Contributor

@harisang harisang Feb 12, 2025

Choose a reason for hiding this comment

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

I saw you removed 'liquidity' as an option in the class of orders. Not sure if this is still around, but if we decide to remove it, then this sentence needs to be corrected as well as it references such orders

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I followed the openapi from the driver: https://github.com/cowprotocol/services/blob/7333e77082a0fe7a6b0025aff248b1fb52f3c8ba/crates/driver/openapi.yml#L190

I saw that liquidity was removed there, so I assumed it was removed.

bram-vdberg and others added 2 commits February 14, 2025 06:35
Co-authored-by: Haris Angelidakis <64154020+harisang@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants