reth_codecs/alloy/transaction/
eip4844.rs

1//! Compact implementation for [`AlloyTxEip4844`]
2
3use crate::{Compact, CompactPlaceholder};
4use alloc::vec::Vec;
5use alloy_consensus::TxEip4844 as AlloyTxEip4844;
6use alloy_eips::eip2930::AccessList;
7use alloy_primitives::{Address, Bytes, ChainId, B256, U256};
8use reth_codecs_derive::add_arbitrary_tests;
9
10/// [EIP-4844 Blob Transaction](https://eips.ethereum.org/EIPS/eip-4844#blob-transaction)
11///
12/// This is a helper type to use derive on it instead of manually managing `bitfield`.
13///
14/// By deriving `Compact` here, any future changes or enhancements to the `Compact` derive
15/// will automatically apply to this type.
16///
17/// Notice: Make sure this struct is 1:1 with [`alloy_consensus::TxEip4844`]
18#[derive(Debug, Clone, PartialEq, Eq, Hash, Default, Compact)]
19#[reth_codecs(crate = "crate")]
20#[cfg_attr(any(test, feature = "test-utils"), derive(serde::Serialize, serde::Deserialize))]
21#[cfg_attr(feature = "test-utils", allow(unreachable_pub), visibility::make(pub))]
22#[add_arbitrary_tests(crate, compact)]
23pub(crate) struct TxEip4844 {
24    chain_id: ChainId,
25    nonce: u64,
26    gas_limit: u64,
27    max_fee_per_gas: u128,
28    max_priority_fee_per_gas: u128,
29    /// TODO(debt): this should be removed if we break the DB.
30    /// Makes sure that the Compact bitflag struct has one bit after the above field:
31    /// <https://github.com/paradigmxyz/reth/pull/8291#issuecomment-2117545016>
32    #[cfg_attr(
33        feature = "test-utils",
34        serde(
35            serialize_with = "serialize_placeholder",
36            deserialize_with = "deserialize_placeholder"
37        )
38    )]
39    placeholder: Option<CompactPlaceholder>,
40    to: Address,
41    value: U256,
42    access_list: AccessList,
43    blob_versioned_hashes: Vec<B256>,
44    max_fee_per_blob_gas: u128,
45    input: Bytes,
46}
47
48impl Compact for AlloyTxEip4844 {
49    fn to_compact<B>(&self, buf: &mut B) -> usize
50    where
51        B: bytes::BufMut + AsMut<[u8]>,
52    {
53        let tx = TxEip4844 {
54            chain_id: self.chain_id,
55            nonce: self.nonce,
56            gas_limit: self.gas_limit,
57            max_fee_per_gas: self.max_fee_per_gas,
58            max_priority_fee_per_gas: self.max_priority_fee_per_gas,
59            placeholder: Some(()),
60            to: self.to,
61            value: self.value,
62            access_list: self.access_list.clone(),
63            blob_versioned_hashes: self.blob_versioned_hashes.clone(),
64            max_fee_per_blob_gas: self.max_fee_per_blob_gas,
65            input: self.input.clone(),
66        };
67        tx.to_compact(buf)
68    }
69
70    fn from_compact(buf: &[u8], len: usize) -> (Self, &[u8]) {
71        // Return the remaining slice from the inner from_compact to advance the cursor correctly.
72        let (tx, remaining) = TxEip4844::from_compact(buf, len);
73        let alloy_tx = Self {
74            chain_id: tx.chain_id,
75            nonce: tx.nonce,
76            gas_limit: tx.gas_limit,
77            max_fee_per_gas: tx.max_fee_per_gas,
78            max_priority_fee_per_gas: tx.max_priority_fee_per_gas,
79            to: tx.to,
80            value: tx.value,
81            access_list: tx.access_list,
82            blob_versioned_hashes: tx.blob_versioned_hashes,
83            max_fee_per_blob_gas: tx.max_fee_per_blob_gas,
84            input: tx.input,
85        };
86        (alloy_tx, remaining)
87    }
88}
89
90#[cfg(any(test, feature = "test-utils"))]
91impl<'a> arbitrary::Arbitrary<'a> for TxEip4844 {
92    fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
93        Ok(Self {
94            chain_id: ChainId::arbitrary(u)?,
95            nonce: u64::arbitrary(u)?,
96            gas_limit: u64::arbitrary(u)?,
97            max_fee_per_gas: u128::arbitrary(u)?,
98            max_priority_fee_per_gas: u128::arbitrary(u)?,
99            // Should always be Some for TxEip4844
100            placeholder: Some(()),
101            to: Address::arbitrary(u)?,
102            value: U256::arbitrary(u)?,
103            access_list: AccessList::arbitrary(u)?,
104            blob_versioned_hashes: Vec::<B256>::arbitrary(u)?,
105            max_fee_per_blob_gas: u128::arbitrary(u)?,
106            input: Bytes::arbitrary(u)?,
107        })
108    }
109}
110
111#[cfg(feature = "test-utils")]
112fn serialize_placeholder<S>(value: &Option<()>, serializer: S) -> Result<S::Ok, S::Error>
113where
114    S: serde::Serializer,
115{
116    // Required otherwise `serde_json` will serialize it as null and would be `None` when decoding
117    // it again.
118    match value {
119        Some(()) => serializer.serialize_str("placeholder"), // Custom serialization
120        None => serializer.serialize_none(),
121    }
122}
123
124#[cfg(feature = "test-utils")]
125fn deserialize_placeholder<'de, D>(deserializer: D) -> Result<Option<()>, D::Error>
126where
127    D: serde::Deserializer<'de>,
128{
129    use serde::de::Deserialize;
130    let s: Option<String> = Option::deserialize(deserializer)?;
131    match s.as_deref() {
132        Some("placeholder") => Ok(Some(())),
133        None => Ok(None),
134        _ => Err(serde::de::Error::custom("unexpected value")),
135    }
136}
137
138#[cfg(test)]
139mod tests {
140    use super::*;
141    use alloy_primitives::{address, bytes};
142
143    #[test]
144    fn backwards_compatible_txkind_test() {
145        // TxEip4844 encoded with TxKind on to field
146        // holesky tx hash: <0xa3b1668225bf0fbfdd6c19aa6fd071fa4ff5d09a607c67ccd458b97735f745ac>
147        let tx = bytes!("224348a100426844cb2dc6c0b2d05e003b9aca0079c9109b764609df928d16fc4a91e9081f7e87db09310001019101fb28118ceccaabca22a47e35b9c3f12eb2dcb25e5c543d5b75e6cd841f0a05328d26ef16e8450000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000052000000000000000000000000000000000000000000000000000000000000004c000000000000000000000000000000000000000000000000000000000000000200000000000000000000000007b399987d24fc5951f3e94a4cb16e87414bf22290000000000000000000000001670090000000000000000000000000000010001302e31382e302d64657600000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000420000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000009e640a6aadf4f664cf467b795c31332f44acbe6c000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000002c00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006614c2d1000000000000000000000000000000000000000000000000000000000014012c000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001e000000000000000000000000000000000000000000000000000000000000000030000000000000000000000000000000000000000000000000000000000000064000000000000000000000000000000000000000000000000000000000000093100000000000000000000000000000000000000000000000000000000000000c8000000000000000000000000000000000000000000000000000000000000093100000000000000000000000000000000000000000000000000000000000003e800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041f06fd78f4dcdf089263524731620941747b9b93fd8f631557e25b23845a78b685bd82f9d36bce2f4cc812b6e5191df52479d349089461ffe76e9f2fa2848a0fe1b0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000410819f04aba17677807c61ae72afdddf7737f26931ecfa8af05b7c669808b36a2587e32c90bb0ed2100266dd7797c80121a109a2b0fe941ca5a580e438988cac81c000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000");
148        let (tx, _) = TxEip4844::from_compact(&tx, tx.len());
149        assert_eq!(tx.to, address!("0x79C9109b764609df928d16fC4a91e9081F7e87DB"));
150        assert_eq!(tx.placeholder, Some(()));
151        assert_eq!(tx.input, bytes!("ef16e8450000000000000000000000000000000000000000000000000000000000000040000000000000000000000000000000000000000000000000000000000000052000000000000000000000000000000000000000000000000000000000000004c000000000000000000000000000000000000000000000000000000000000000200000000000000000000000007b399987d24fc5951f3e94a4cb16e87414bf22290000000000000000000000001670090000000000000000000000000000010001302e31382e302d64657600000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000c00000000000000000000000000000000000000000000000000000000000000420000000000000000000000000000000000000000000000000000000000000000100000000000000000000000000000000000000000000000000000000000000200000000000000000000000009e640a6aadf4f664cf467b795c31332f44acbe6c000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000002c00000000000000000000000000000000000000000000000000000000000000020000000000000000000000000000000000000000000000000000000000000004000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000006614c2d1000000000000000000000000000000000000000000000000000000000014012c000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000000000000000000000000000000000000000000001e000000000000000000000000000000000000000000000000000000000000000030000000000000000000000000000000000000000000000000000000000000064000000000000000000000000000000000000000000000000000000000000093100000000000000000000000000000000000000000000000000000000000000c8000000000000000000000000000000000000000000000000000000000000093100000000000000000000000000000000000000000000000000000000000003e800000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000041f06fd78f4dcdf089263524731620941747b9b93fd8f631557e25b23845a78b685bd82f9d36bce2f4cc812b6e5191df52479d349089461ffe76e9f2fa2848a0fe1b0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000410819f04aba17677807c61ae72afdddf7737f26931ecfa8af05b7c669808b36a2587e32c90bb0ed2100266dd7797c80121a109a2b0fe941ca5a580e438988cac81c000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000"));
152    }
153}
reth_codecs/alloy/transaction/eip4844.rs

reth_codecs/alloy/transaction/
eip4844.rs
