Skip to content

Update api.mdx #85

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

Merged
dvush merged 1 commit into from
Jun 3, 2026
Merged

Update api.mdx #85

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 10 additions & 1 deletion docs/api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,15 @@ When multiple updates for the same state are available at the time a block is bu

The mode is set per API key, which can be granted on request (see [How to participate](how-to-participate)). This requirement may be dropped in future. Operators needing both modes can request multiple keys.

#### propAMM stream addresses <!-- omit in toc -->

State overrides can be sent to `0xda7afeed01fe625cf15d187a19f94b45f00b8c5f`.

| Name | Stream address |
| --- | --- |
| FermiSwap | `0xb1076fe3ab5e28005c7c323bac5ac06a680d452e` |
| Kipseli | `0x5CDbE59400Cc2EFDCC2B54acca4a99FE00dD588c` |

#### Endpoints <!-- omit in toc -->

Priority updates are submitted over WebSocket on the same hosts as the JSON-RPC endpoints (see [BuilderNet endpoints](send-orderflow#buildernet-endpoints)) at the path `/ws/sendquoteupdate`, e.g. `wss://rpc.buildernet.org/ws/sendquoteupdate`.
Expand Down Expand Up @@ -280,7 +289,7 @@ Each message is a JSON snapshot describing the aggregated state overrides for th
| `slot` | Target slot for the snapshot. |
| `blockNumber` | Target block number. |
| `timestamp` | Snapshot time (UNIX nanoseconds). |
| `0x…` (address keys) | State overrides are grouped by an address — typically the main proPAMM contract. Each maps to a `stateOverride` object describing the storage the builder would apply for priority updates associated with that group. |
| `0x…` (address keys) | State overrides are grouped by an address — typically the main propAMM contract. Each maps to a `stateOverride` object describing the storage the builder would apply for priority updates associated with that group. |

The `stateOverride` object uses the standard Ethereum state-override format: it maps each contract address to a `stateDiff`, which in turn maps 32-byte storage slots to their 32-byte values.

Expand Down