reth_ethereum_engine_primitives/
lib.rs

1//! Ethereum specific engine API types and impls.
2
3#![doc(
4    html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png",
5    html_favicon_url = "https://avatars0.githubusercontent.com/u/97369466?s=256",
6    issue_tracker_base_url = "https://github.com/SeismicSystems/seismic-reth/issues/"
7)]
8#![cfg_attr(not(test), warn(unused_crate_dependencies))]
9#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
10
11mod payload;
12use std::sync::Arc;
13
14use alloy_rpc_types_engine::{ExecutionPayload, ExecutionPayloadSidecar, PayloadError};
15pub use alloy_rpc_types_engine::{
16    ExecutionPayloadEnvelopeV2, ExecutionPayloadEnvelopeV3, ExecutionPayloadEnvelopeV4,
17    ExecutionPayloadV1, PayloadAttributes as EthPayloadAttributes,
18};
19pub use payload::{EthBuiltPayload, EthPayloadBuilderAttributes};
20use reth_chainspec::ChainSpec;
21use reth_engine_primitives::{EngineTypes, EngineValidator, PayloadValidator};
22use reth_payload_primitives::{
23    validate_version_specific_fields, EngineApiMessageVersion, EngineObjectValidationError,
24    PayloadOrAttributes, PayloadTypes,
25};
26use reth_payload_validator::ExecutionPayloadValidator;
27use reth_primitives::{Block, SealedBlock};
28
29/// The types used in the default mainnet ethereum beacon consensus engine.
30#[derive(Debug, Default, Clone, serde::Deserialize, serde::Serialize)]
31#[non_exhaustive]
32pub struct EthEngineTypes<T: PayloadTypes = EthPayloadTypes> {
33    _marker: std::marker::PhantomData<T>,
34}
35
36impl<T: PayloadTypes> PayloadTypes for EthEngineTypes<T> {
37    type BuiltPayload = T::BuiltPayload;
38    type PayloadAttributes = T::PayloadAttributes;
39    type PayloadBuilderAttributes = T::PayloadBuilderAttributes;
40}
41
42impl<T: PayloadTypes> EngineTypes for EthEngineTypes<T>
43where
44    T::BuiltPayload: TryInto<ExecutionPayloadV1>
45        + TryInto<ExecutionPayloadEnvelopeV2>
46        + TryInto<ExecutionPayloadEnvelopeV3>
47        + TryInto<ExecutionPayloadEnvelopeV4>,
48{
49    type ExecutionPayloadEnvelopeV1 = ExecutionPayloadV1;
50    type ExecutionPayloadEnvelopeV2 = ExecutionPayloadEnvelopeV2;
51    type ExecutionPayloadEnvelopeV3 = ExecutionPayloadEnvelopeV3;
52    type ExecutionPayloadEnvelopeV4 = ExecutionPayloadEnvelopeV4;
53}
54
55/// A default payload type for [`EthEngineTypes`]
56#[derive(Debug, Default, Clone, serde::Deserialize, serde::Serialize)]
57#[non_exhaustive]
58pub struct EthPayloadTypes;
59
60impl PayloadTypes for EthPayloadTypes {
61    type BuiltPayload = EthBuiltPayload;
62    type PayloadAttributes = EthPayloadAttributes;
63    type PayloadBuilderAttributes = EthPayloadBuilderAttributes;
64}
65
66/// Validator for the ethereum engine API.
67#[derive(Debug, Clone)]
68pub struct EthereumEngineValidator {
69    inner: ExecutionPayloadValidator<ChainSpec>,
70}
71
72impl EthereumEngineValidator {
73    /// Instantiates a new validator.
74    pub const fn new(chain_spec: Arc<ChainSpec>) -> Self {
75        Self { inner: ExecutionPayloadValidator::new(chain_spec) }
76    }
77
78    /// Returns the chain spec used by the validator.
79    #[inline]
80    fn chain_spec(&self) -> &ChainSpec {
81        self.inner.chain_spec()
82    }
83}
84
85impl PayloadValidator for EthereumEngineValidator {
86    type Block = Block;
87
88    fn ensure_well_formed_payload(
89        &self,
90        payload: ExecutionPayload,
91        sidecar: ExecutionPayloadSidecar,
92    ) -> Result<SealedBlock, PayloadError> {
93        self.inner.ensure_well_formed_payload(payload, sidecar)
94    }
95}
96
97impl<Types> EngineValidator<Types> for EthereumEngineValidator
98where
99    Types: EngineTypes<PayloadAttributes = EthPayloadAttributes>,
100{
101    fn validate_version_specific_fields(
102        &self,
103        version: EngineApiMessageVersion,
104        payload_or_attrs: PayloadOrAttributes<'_, EthPayloadAttributes>,
105    ) -> Result<(), EngineObjectValidationError> {
106        validate_version_specific_fields(self.chain_spec(), version, payload_or_attrs)
107    }
108
109    fn ensure_well_formed_attributes(
110        &self,
111        version: EngineApiMessageVersion,
112        attributes: &EthPayloadAttributes,
113    ) -> Result<(), EngineObjectValidationError> {
114        validate_version_specific_fields(self.chain_spec(), version, attributes.into())
115    }
116}
reth_ethereum_engine_primitives/lib.rs

reth_ethereum_engine_primitives/
lib.rs
