diff --git a/docs/2024-06_bidcollect.md b/docs/2024-06_bidcollect.md index b499f24..a2be172 100644 --- a/docs/2024-06_bidcollect.md +++ b/docs/2024-06_bidcollect.md @@ -27,18 +27,18 @@ Source types: Different data sources have different limitations: -- `getHeader` polling: +- `getHeader` polling ([code](/services/bidcollect/getheader-poller.go)): - The received header only has limited information, with these implications: - Optimistic is always `false` - No `builder_pubkey` - No bid timestamp (need to use receive timestamp) - getHeader bid timestamps are always when the response from polling at t=1s comes back (but not when the bid was received at a relay) - Some relays only allow a single `getHeader` request per slot, so we time it at `t=1s` -- Data API polling: +- Data API polling ([code](/services/bidcollect/data-api-poller.go): - Has all the necessary information - Due to rate limits, we only poll at specific times - - Polling at t-4, t-2, t-0.5, t+0.5, t+2 (see also [`services/bidcollect/data-api-poller.go`](services/bidcollect/data-api-poller.go#64-69)) -- Ultrasound websocket stream + - Polling at t-4, t-2, t-0.5, t+0.5, t+2 (see also [`/services/bidcollect/data-api-poller.go`](/services/bidcollect/data-api-poller.go#64-69)) +- Ultrasound websocket stream ([code](/services/bidcollect/ultrasound-stream.go): - doesn't expose optimistic, thus that field is always `false` ## Other notes