-
Notifications
You must be signed in to change notification settings - Fork 24
doc: fix formatting of 'unfair' in auction documentation 💅 #554
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?
Conversation
|
@glokos is attempting to deploy a commit to the cow Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughUpdated a single documentation page to reword the auction flow: it now states that unfair batched bids are removed first (those worse than a regular single bid), then a bid mix is selected to maximize total value within computational limits; also made minor wording adjustments to the introductory paragraph. Changes
Sequence Diagram(s)sequenceDiagram
participant Client as Intent Collector
participant Doc as Auction Docs (flow)
participant Filter as Unfair-Bid Filter
participant Solver as Solver / Search
participant Output as Winning Mix
Note over Client,Doc: intents collected and auction described
Client->>Doc: submit intents
Doc->>Filter: evaluate batched bids
alt Batched bid worse than single
Filter->>Filter: mark as unfair (remove)
else Batched bid acceptable
Filter->>Solver: pass to solver
end
Filter->>Solver: pass remaining bids
Solver->>Solver: search/select bid mix (maximize total value within limits)
Solver->>Output: produce winning mix
Note over Output: results returned/presented
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes
Possibly related PRs
Suggested reviewers
Poem
Pre-merge checks and finishing touches❌ Failed checks (2 warnings)
✅ Passed checks (1 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
📜 Recent review detailsConfiguration used: CodeRabbit UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. Comment |
|
All contributors have signed the CLA ✍️ ✅ |
|
I have read the CLA Document and I hereby sign the CLA |
docs/cow-protocol/concepts/introduction/fair-combinatorial-auction.md
Outdated
Show resolved
Hide resolved
pretf00d
left a comment
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.
suggested an improvement
Summary by CodeRabbit