-
Notifications
You must be signed in to change notification settings - Fork 168
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.
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?
Fix broker pricing/commitment priority config docs #1302
Conversation
|
Could just be me, but I was unable to build the docs locally based on the docs README: ❯ bun run dev 1m 8s 11:39:37
$ vocs dev
node:internal/validators:162
throw new ERR_INVALID_ARG_TYPE(name, 'string', value);
^
TypeError [ERR_INVALID_ARG_TYPE]: The "paths[0]" argument must be of type string. Received undefined
at validateString (node:internal/validators:162:11)
at resolve (node:path:1101:7)
at file:///Users/d/dev/mintybasil/boundless-mintybasil-upstream/documentation/node_modules/vocs/_lib/vite/plugins/remark/links.js:9:23
at ModuleJob.run (node:internal/modules/esm/module_job:218:25)
at async ModuleLoader.import (node:internal/modules/esm/loader:329:24)
at async loadESM (node:internal/process/esm_loader:34:7)
at async handleMainPromise (node:internal/modules/run_main:113:12) {
code: 'ERR_INVALID_ARG_TYPE'
}
Node.js v20.10.0
error: script "dev" exited with code 1 |
| | 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). | |
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.
| | 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.
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.
Let me take a proper look later this week and get back to you both @mintybasil @austinabell, thanks
Yeah vocs is a bit of a pain, you need lts node so thats 24.11.0, and to do a full |
Ahh, yeah upgrading to node 24.11 fixed it. Went ahead and updated the README's accordingly, there was also a conflicting instruction in the main README. Hope that isn't bloating this PR. Will keep keep an eye out for your response on the comment above 👍 |
Seemingly the docs are incorrect for the options available for the broker configs
order_pricing_priorityandorder_commitment_priority.boundless/crates/broker/src/config.rs
Lines 171 to 178 in 12980d0
boundless/crates/broker/src/config.rs
Lines 189 to 198 in 12980d0