flashbots / relay-specs

MEV-Boost Relay API Specs
https://flashbots.github.io/relay-specs
Creative Commons Zero v1.0 Universal
28 stars 12 forks source link

Update API docs to specify how to set content encoding #32

Closed ralexstokes closed 7 months ago

ralexstokes commented 8 months ago

The submitBlock API supports optional GZIP compression for the request body.

Right now, the API docs only indicate how to hint at content type (Content-Type: {application/json, application/octet-stream}).

Following the relay implementation from flashbots/mev-boost-relay, it seems the preference is to support the optional header: Content-Encoding with a single allowed value gzip.

The API docs should reflect this so implementers know how to support this feature.