mirror of
https://github.com/paradigmxyz/reth.git
synced 2026-02-14 17:05:06 -05:00
96 lines
3.3 KiB
Rust
96 lines
3.3 KiB
Rust
//! Ethereum specific engine API types and impls.
|
|
|
|
#![doc(
|
|
html_logo_url = "https://raw.githubusercontent.com/paradigmxyz/reth/main/assets/reth-docs.png",
|
|
html_favicon_url = "https://avatars0.githubusercontent.com/u/97369466?s=256",
|
|
issue_tracker_base_url = "https://github.com/paradigmxyz/reth/issues/"
|
|
)]
|
|
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
|
|
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
|
|
|
|
mod payload;
|
|
use std::sync::Arc;
|
|
|
|
pub use alloy_rpc_types_engine::{
|
|
ExecutionPayloadEnvelopeV2, ExecutionPayloadEnvelopeV3, ExecutionPayloadEnvelopeV4,
|
|
ExecutionPayloadV1, PayloadAttributes as EthPayloadAttributes,
|
|
};
|
|
pub use payload::{EthBuiltPayload, EthPayloadBuilderAttributes};
|
|
use reth_chainspec::ChainSpec;
|
|
use reth_engine_primitives::{EngineTypes, EngineValidator};
|
|
use reth_payload_primitives::{
|
|
validate_version_specific_fields, EngineApiMessageVersion, EngineObjectValidationError,
|
|
PayloadOrAttributes, PayloadTypes,
|
|
};
|
|
|
|
/// The types used in the default mainnet ethereum beacon consensus engine.
|
|
#[derive(Debug, Default, Clone, serde::Deserialize, serde::Serialize)]
|
|
#[non_exhaustive]
|
|
pub struct EthEngineTypes<T: PayloadTypes = EthPayloadTypes> {
|
|
_marker: std::marker::PhantomData<T>,
|
|
}
|
|
|
|
impl<T: PayloadTypes> PayloadTypes for EthEngineTypes<T> {
|
|
type BuiltPayload = T::BuiltPayload;
|
|
type PayloadAttributes = T::PayloadAttributes;
|
|
type PayloadBuilderAttributes = T::PayloadBuilderAttributes;
|
|
}
|
|
|
|
impl<T: PayloadTypes> EngineTypes for EthEngineTypes<T>
|
|
where
|
|
T::BuiltPayload: TryInto<ExecutionPayloadV1>
|
|
+ TryInto<ExecutionPayloadEnvelopeV2>
|
|
+ TryInto<ExecutionPayloadEnvelopeV3>
|
|
+ TryInto<ExecutionPayloadEnvelopeV4>,
|
|
{
|
|
type ExecutionPayloadV1 = ExecutionPayloadV1;
|
|
type ExecutionPayloadEnvelopeV2 = ExecutionPayloadEnvelopeV2;
|
|
type ExecutionPayloadEnvelopeV3 = ExecutionPayloadEnvelopeV3;
|
|
type ExecutionPayloadEnvelopeV4 = ExecutionPayloadEnvelopeV4;
|
|
}
|
|
|
|
/// A default payload type for [`EthEngineTypes`]
|
|
#[derive(Debug, Default, Clone, serde::Deserialize, serde::Serialize)]
|
|
#[non_exhaustive]
|
|
pub struct EthPayloadTypes;
|
|
|
|
impl PayloadTypes for EthPayloadTypes {
|
|
type BuiltPayload = EthBuiltPayload;
|
|
type PayloadAttributes = EthPayloadAttributes;
|
|
type PayloadBuilderAttributes = EthPayloadBuilderAttributes;
|
|
}
|
|
|
|
/// Validator for the ethereum engine API.
|
|
#[derive(Debug, Clone)]
|
|
pub struct EthereumEngineValidator {
|
|
chain_spec: Arc<ChainSpec>,
|
|
}
|
|
|
|
impl EthereumEngineValidator {
|
|
/// Instantiates a new validator.
|
|
pub const fn new(chain_spec: Arc<ChainSpec>) -> Self {
|
|
Self { chain_spec }
|
|
}
|
|
}
|
|
|
|
impl<Types> EngineValidator<Types> for EthereumEngineValidator
|
|
where
|
|
Types: EngineTypes<PayloadAttributes = EthPayloadAttributes>,
|
|
{
|
|
fn validate_version_specific_fields(
|
|
&self,
|
|
version: EngineApiMessageVersion,
|
|
payload_or_attrs: PayloadOrAttributes<'_, EthPayloadAttributes>,
|
|
) -> Result<(), EngineObjectValidationError> {
|
|
validate_version_specific_fields(&self.chain_spec, version, payload_or_attrs)
|
|
}
|
|
|
|
fn ensure_well_formed_attributes(
|
|
&self,
|
|
version: EngineApiMessageVersion,
|
|
attributes: &EthPayloadAttributes,
|
|
) -> Result<(), EngineObjectValidationError> {
|
|
validate_version_specific_fields(&self.chain_spec, version, attributes.into())
|
|
}
|
|
}
|