Add SSZ types, content negotiation, and encoding helpers#466
Open
JasonVranek wants to merge 1 commit into
Open
Add SSZ types, content negotiation, and encoding helpers#466JasonVranek wants to merge 1 commit into
JasonVranek wants to merge 1 commit into
Conversation
Introduce EncodingType, AcceptedEncodings, and content negotiation primitives for SSZ support in the PBS pipeline. Includes: - EncodingType enum with FromStr/Display and MIME param tolerance - AcceptedEncodings with q-value aware Accept header parsing - SSZ bid value extraction from SignedBuilderBid by fork - deserialize_body and parse_response_encoding_and_fork helpers - Per-fork type aliases for BuilderBid and ExecutionPayloadHeader - SszValueError, PbsError::GeneralRequest, PbsClientError variants - Comprehensive unit tests for all new types and helpers - New deps: headers-accept, mediatype
ninaiiad
suggested changes
May 20, 2026
Comment on lines
+585
to
+586
| /// Pick the caller's highest-preference encoding that the server supports. | ||
| /// Returns `None` if no overlap exists. |
| /// dedup the accepted set is at most one primary plus one optional fallback. | ||
| #[derive(Debug, Clone, Copy, PartialEq, Eq)] | ||
| pub struct AcceptedEncodings { | ||
| /// Caller's highest-preference encoding. |
Comment on lines
+695
to
+696
| /// Parse CONTENT TYPE header to get the encoding type of the body, defaulting | ||
| /// to JSON if missing or malformed. |
| .unwrap_or(EncodingType::Json) | ||
| } | ||
|
|
||
| /// Parse CONSENSUS_VERSION header |
Comment on lines
+809
to
+822
| impl Display for BodyDeserializeError { | ||
| fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { | ||
| match self { | ||
| BodyDeserializeError::SerdeJsonError(e) => write!(f, "JSON deserialization error: {e}"), | ||
| BodyDeserializeError::SszDecodeError(e) => { | ||
| write!(f, "SSZ deserialization error: {e:?}") | ||
| } | ||
| BodyDeserializeError::UnsupportedMediaType => write!(f, "unsupported media type"), | ||
| BodyDeserializeError::MissingVersionHeader => { | ||
| write!(f, "missing consensus version header") | ||
| } | ||
| } | ||
| } | ||
| } |
Contributor
There was a problem hiding this comment.
can use thiserror, already a dependency
| NoPayload, | ||
| Internal, | ||
| DecodeError(String), | ||
| #[allow(dead_code)] |
Comment on lines
+125
to
+131
| match err { | ||
| SszValueError::InvalidPayloadLength { required, actual } => PbsError::GeneralRequest( | ||
| format!("invalid payload length: required {required} but payload was {actual}"), | ||
| ), | ||
| SszValueError::UnsupportedFork { name } => { | ||
| PbsError::GeneralRequest(format!("unsupported fork: {name}")) | ||
| } |
Contributor
There was a problem hiding this comment.
let's not bundle these under "GeneralRequest" with a string error message inside, could be an SszError maybe?
and you could derive it from this SszValueError instead of implementing a custom From using thiserror
| } | ||
| } | ||
|
|
||
| pub async fn deserialize_body( |
| } | ||
|
|
||
| // Get the offset of the message in a SignedBuilderBid SSZ structure | ||
| fn get_ssz_value_offset_for_fork(fork: ForkName) -> Option<usize> { |
Contributor
There was a problem hiding this comment.
None -> SszValueError::UnsupportedFork { name: fork.to_string() }
| step as f32 / 10.0 | ||
| } | ||
|
|
||
| /// Format a single `Accept` header entry as `"<media-type>;q=<x.x>"`. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Introduces the types and helpers needed for SSZ support in the PBS pipeline. No behavior changes, just plumbing the follow-up PRs build on.
What's in this PR
EncodingTypeenum withFromStr/Display, including MIME parameter tolerance (RFC 7231 §3.1.1.1)AcceptedEncodingswith q-value-aware Accept header parsing (RFC 9110 §12.5.1)SignedBuilderBidfor all supported forks (Bellatrix through Fulu)deserialize_bodyandparse_response_encoding_and_forkhelpersBuilderBidandExecutionPayloadHeaderSszValueError,PbsError::GeneralRequest,PbsClientError::DecodeError/RelayErrorheaders-accept,mediatypeReview notes
Part 1 of 4: SSZ types → get_header → submit_block → validation bypassing
Attribution
This work builds on the SSZ builder flow originally implemented by @eserilev
in #252 and ported to the current codebase by @jclapis in #403.
Co-authored-by: Eitan Seri-Levi eserilev@ucsc.edu
Co-authored-by: Joe Clapis jclapis@outlook.com