Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
9 changes: 1 addition & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,14 +65,7 @@ cargo build

You can find the documentation in the [documentation](./documentation) folder.

To build it and serve it locally, run the following commands:

```sh
bun install
bun run docs
```

Then open your browser and navigate to `http://localhost:5173`.
See the [README](./documentation/README.md) for instructions on how to build and contribute to the docs.

## Audits

Expand Down
13 changes: 10 additions & 3 deletions documentation/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Welcome to the Boundless documentation.

## Prerequisites

- [Node.js](https://nodejs.org/en) >= 24.0
- [Bun](https://bun.sh)

## Getting Started
Expand All @@ -19,19 +20,25 @@ Welcome to the Boundless documentation.
git clone https://github.com/boundless-xyz/boundless.git
```

2. Install dependencies
2. Navigate to the `documentation/` directory

```bash
cd boundless/documentation
```

3. Install dependencies

```bash
bun install
```

3. Start the development server
4. Start the development server

```bash
bun run dev
```

4. Open your browser and navigate to `http://localhost:5173`
5. Open your browser and navigate to `http://localhost:5173`

## Contributing

Expand Down
4 changes: 2 additions & 2 deletions documentation/site/pages/provers/broker.mdx
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

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

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