Skip to content

Fix broker pricing/commitment priority config docs #1302

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.

Sign up for GitHub

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

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

Fix broker pricing/commitment priority config docs #1302

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
980f813
Fix pricing priority options
mintybasil Nov 7, 2025
545069e
Update docs readme
mintybasil Nov 11, 2025
e4a1491
Merge branch 'main' into mintybasil/broker-config-docs
mintybasil Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions documentation/site/pages/provers/broker.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,8 @@ Below are all `broker.toml` settings organized by section:
| set\_builder\_default\_image\_url | Default URL for set builder image. This URL will be tried first before falling back to the image URL from the set verifier contract. |
| max\_concurrent\_proofs | Maximum number of concurrent proofs that can be processed at once. Used to limit proof tasks spawned to prevent overwhelming the system. |
| max\_concurrent\_preflights | Maximum number of orders to concurrently preflight. Used to limit preflight tasks spawned to prevent overwhelming the system. |
| order\_pricing\_priority | Determines how orders are prioritized for pricing. Options: "random" (process orders in random order), "observation_time" (FIFO), "shortest_expiry" (earliest deadline), "price" (highest ETH payment), "cycle_price" (highest ETH price per cycle, default). |
| order\_commitment\_priority | Determines how orders are prioritized when committing to prove them. Options: "random" (process orders in random order, default), "shortest_expiry" (process orders by shortest expiry first). |
| order\_pricing\_priority | Determines how orders are prioritized for pricing. Options: "random" (process orders in random order, default), "observation_time" (Process orders in the order they were observed (FIFO)), "shortest_expiry" (process orders by shortest expiry first). |
| order\_commitment\_priority | Determines how orders are prioritized when committing to prove them. Options: "random" (process orders in random order), "shortest_expiry" (earliest deadline), "price" (highest ETH payment), "cycle_price" (highest ETH price per cycle, default). |
Copy link
Contributor

@austinabell austinabell Nov 7, 2025

Choose a reason for hiding this comment

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

Suggested change
| order\_commitment\_priority | Determines how orders are prioritized when committing to prove them. Options: "random" (process orders in random order), "shortest_expiry" (earliest deadline), "price" (highest ETH payment), "cycle_price" (highest ETH price per cycle, default). |
| order\_commitment\_priority | Determines how orders are prioritized when committing to prove them. Options: "random" (process orders in random order), "shortest_expiry" (earliest deadline), "price" (highest payment), "cycle_price" (highest price per cycle, default). |

The rust comment you are referencing is also out of date, as it was from before slashed orders were switched to be biased based on the collateral (randomly weighted by the collateral/cycle value). I'll leave up to @neutronmoderator to decide how we want to document, if keeping the description here simple or sharing details about how slashed orders are lightly shuffled also.

Copy link
Contributor

@neutronmoderator neutronmoderator Nov 11, 2025

Choose a reason for hiding this comment

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

Let me take a proper look later this week and get back to you both @mintybasil @austinabell, thanks

| max\_critical\_task\_retries | Max critical task retries on recoverable failures. The broker service has a number of subtasks. Some are considered critical. If a task fails, it will be retried, but after this number of retries, the process will exit. |
| allow\_client\_addresses | Optional allow list for customer address. If enabled, all requests from clients not in the allow list are skipped. |
| deny\_requestor\_addresses | Optional deny list for requestor address. If enabled, all requests from clients in the deny list are skipped. |
Expand Down