alloy-rpc-types-engine 0.15.9

Types for the `engine` Ethereum JSON-RPC namespace
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118

//! Error variants when validating an execution payload.

use alloy_primitives::{Bytes, B256, U256};

/// Error that can occur when handling payloads.
#[derive(Debug, derive_more::Display)]
pub enum PayloadError {
    /// Invalid payload extra data.
    #[display("invalid payload extra data: {_0}")]
    ExtraData(Bytes),
    /// Invalid payload base fee.
    #[display("invalid payload base fee: {_0}")]
    BaseFee(U256),
    /// Invalid payload blob gas used.
    #[display("invalid payload blob gas used: {_0}")]
    BlobGasUsed(U256),
    /// Invalid payload excess blob gas.
    #[display("invalid payload excess blob gas: {_0}")]
    ExcessBlobGas(U256),
    /// withdrawals present in pre-shanghai payload.
    #[display("withdrawals present in pre-shanghai payload")]
    PreShanghaiBlockWithWithdrawals,
    /// withdrawals missing in post-shanghai payload.
    #[display("withdrawals missing in post-shanghai payload")]
    PostShanghaiBlockWithoutWithdrawals,
    /// parent beacon block root present in pre-cancun payload.
    #[display("parent beacon block root present in pre-cancun payload")]
    PreCancunBlockWithParentBeaconBlockRoot,
    /// blob transactions present in pre-cancun payload.
    #[display("blob transactions present in pre-cancun payload")]
    PreCancunBlockWithBlobTransactions,
    /// blob gas used present in pre-cancun payload.
    #[display("blob gas used present in pre-cancun payload")]
    PreCancunBlockWithBlobGasUsed,
    /// excess blob gas present in pre-cancun payload.
    #[display("excess blob gas present in pre-cancun payload")]
    PreCancunBlockWithExcessBlobGas,
    /// cancun fields present in pre-cancun payload.
    #[display("cancun fields present in pre-cancun payload")]
    PreCancunWithCancunFields,
    /// parent beacon block root missing in post-cancun payload.
    #[display("parent beacon block root missing in post-cancun payload")]
    PostCancunBlockWithoutParentBeaconBlockRoot,
    /// blob gas used missing in post-cancun payload.
    #[display("blob gas used missing in post-cancun payload")]
    PostCancunBlockWithoutBlobGasUsed,
    /// excess blob gas missing in post-cancun payload.
    #[display("excess blob gas missing in post-cancun payload")]
    PostCancunBlockWithoutExcessBlobGas,
    /// cancun fields missing in post-cancun payload.
    #[display("cancun fields missing in post-cancun payload")]
    PostCancunWithoutCancunFields,
    /// blob transactions present in pre-prague payload.
    #[display("eip 7702 transactions present in pre-prague payload")]
    PrePragueBlockWithEip7702Transactions,
    /// requests present in pre-prague payload.
    #[display("requests present in pre-prague payload")]
    PrePragueBlockRequests,
    /// Invalid payload block hash.
    #[display("block hash mismatch: want {execution}, got {consensus}")]
    BlockHash {
        /// The block hash computed from the payload.
        execution: B256,
        /// The block hash provided with the payload.
        consensus: B256,
    },
    /// Expected blob versioned hashes do not match the given transactions.
    #[display("expected blob versioned hashes do not match the given transactions")]
    InvalidVersionedHashes,
    /// Encountered decoding error.
    #[display("{_0}")]
    Decode(alloy_rlp::Error),
}

impl core::error::Error for PayloadError {}

impl From<alloy_rlp::Error> for PayloadError {
    fn from(value: alloy_rlp::Error) -> Self {
        Self::Decode(value)
    }
}

impl PayloadError {
    /// Returns `true` if the error is caused by a block hash mismatch.
    #[inline]
    pub const fn is_block_hash_mismatch(&self) -> bool {
        matches!(self, Self::BlockHash { .. })
    }

    /// Returns `true` if the error is caused by invalid block hashes (Cancun).
    #[inline]
    pub const fn is_invalid_versioned_hashes(&self) -> bool {
        matches!(self, Self::InvalidVersionedHashes)
    }
}

/// Various errors that can occur when validating a payload or forkchoice update.
///
/// This is intended for the [PayloadStatusEnum::Invalid](crate::PayloadStatusEnum) variant.
#[derive(Clone, Copy, Debug, PartialEq, Eq, derive_more::Display)]
pub enum PayloadValidationError {
    /// Thrown when a forkchoice update's head links to a previously rejected payload.
    #[display("links to previously rejected block")]
    LinksToRejectedPayload,
    /// Thrown when a new payload contains a wrong block number.
    #[display("invalid block number")]
    InvalidBlockNumber,
    /// Thrown when a new payload contains a wrong state root
    #[display("invalid merkle root: (remote: {remote:?} local: {local:?})")]
    InvalidStateRoot {
        /// The state root of the payload we received from remote (CL)
        remote: B256,
        /// The state root of the payload that we computed locally.
        local: B256,
    },
}

impl core::error::Error for PayloadValidationError {}