fix: transaction object rlp decoding (#1740)

ethers-core/src/types/transaction/response.rs

@@ -4,7 +4,10 @@ use super::{
     rlp_opt_list,
 };
 use crate::{
-    types::{Address, Bloom, Bytes, Log, Signature, SignatureError, H256, U256, U64},
+    types::{
+        transaction::extract_chain_id, Address, Bloom, Bytes, Log, Signature, SignatureError, H256,
+        U256, U64,
+    },
     utils::keccak256,
 };
 use rlp::{Decodable, DecoderError, RlpStream};
@@ -340,39 +343,39 @@ impl Decodable for Transaction {
         let mut txn = Self::default();
         // we can get the type from the first value
         let mut offset = 0;
-        txn.transaction_type = match rlp.is_data() {
+        let data = rlp.data()?;
-            true => Ok(Some(rlp.data()?.into())),
+        let first = *data.first().ok_or(DecoderError::Custom("empty slice"))?;
-            false => Ok(None),
+        if rlp.is_list() {
-        }?;
+            // Legacy (0x00)
-
+            // use the original rlp
-        let rest = if txn.transaction_type.is_some() {
+            txn.decode_base_legacy(rlp, &mut offset)?;
-            rlp::Rlp::new(
+            let sig = decode_signature(rlp, &mut offset).unwrap();
-                rlp.as_raw().get(1..).ok_or(DecoderError::Custom("no transaction payload"))?,
+            txn.r = sig.r;
-            )
+            txn.s = sig.s;
+            txn.v = sig.v.into();
+            // extract chain id if legacy
+            txn.chain_id = extract_chain_id(sig.v).map(|id| id.as_u64().into());
         } else {
-            rlp.to_owned()
+            let bytes = data.get(1..).ok_or(DecoderError::Custom("no tx body"))?;
-        };
+            let rest = rlp::Rlp::new(bytes);
+            match first {
+                0x01 => {
+                    txn.decode_base_eip2930(&rest, &mut offset)?;
+                    txn.transaction_type = Some(1u64.into());
+                }
+                0x02 => {
+                    txn.decode_base_eip1559(&rest, &mut offset)?;
+                    txn.transaction_type = Some(2u64.into());
+                }
+                _ => return Err(DecoderError::Custom("invalid tx type")),
+            }
 
-        match txn.transaction_type {
+            let odd_y_parity: bool = rest.val_at(offset)?;
-            Some(x) if x == U64::from(1) => {
+            txn.v = (odd_y_parity as u8).into();
-                // EIP-2930 (0x01)
+            txn.r = rest.val_at(offset + 1)?;
-                txn.decode_base_eip2930(&rest, &mut offset)?;
+            txn.s = rest.val_at(offset + 2)?;
-            }
-            Some(x) if x == U64::from(2) => {
-                // EIP-1559 (0x02)
-                txn.decode_base_eip1559(&rest, &mut offset)?;
-            }
-            _ => {
-                // Legacy (0x00)
-                txn.decode_base_legacy(&rest, &mut offset)?;
-            }
         }
 
-        let sig = decode_signature(&rest, &mut offset)?;
-        txn.r = sig.r;
-        txn.s = sig.s;
-        txn.v = sig.v.into();
-
         Ok(txn)
     }
 }
@@ -717,6 +720,7 @@ mod tests {
         );
     }
 
+    // <https://goerli.etherscan.io/tx/0x5e2fc091e15119c97722e9b63d5d32b043d077d834f377b91f80d32872c78109>
     #[test]
     fn decode_rlp_london_goerli() {
         let tx = Transaction {
@@ -756,11 +760,40 @@ mod tests {
             other: Default::default(),
         };
 
-        let rlp_bytes = hex::decode("02f86f05418459682f008459682f098301a0cf9411d7c2ab0d4aa26b7d8502f6a7ef6844908495c28084e5225381c001a01a8d7bef47f6155cbdf13d57107fc577fd52880fa2862b1a50d47641f8839419a03279bbf73fde76de83440d04b9d97f3809fec8617d3557ee40ac3e0edc391514").unwrap();
+        let tx_bytes = hex::decode("02f86f05418459682f008459682f098301a0cf9411d7c2ab0d4aa26b7d8502f6a7ef6844908495c28084e5225381c001a01a8d7bef47f6155cbdf13d57107fc577fd52880fa2862b1a50d47641f8839419a03279bbf73fde76de83440d04b9d97f3809fec8617d3557ee40ac3e0edc391514").unwrap();
+
+        // the `Transaction` a valid rlp input,
+        // but EIP-1559 prepends a version byte, so we need to encode the data first to get a
+        // valid rlp and then rlp decode impl of `Transaction` will remove and check the
+        // version byte
+
+        let rlp_bytes = rlp::encode(&tx_bytes);
         let decoded_transaction = Transaction::decode(&rlp::Rlp::new(&rlp_bytes)).unwrap();
 
-        // we compare hash because the hash depends on the rlp encoding
+        assert_eq!(
+            decoded_transaction.hash(),
+            "0x5e2fc091e15119c97722e9b63d5d32b043d077d834f377b91f80d32872c78109".parse().unwrap()
+        );
         assert_eq!(decoded_transaction.hash(), tx.hash());
+
+        let from = decoded_transaction.recover_from().unwrap();
+        assert_eq!(from, "0xe66b278fa9fbb181522f6916ec2f6d66ab846e04".parse().unwrap());
+    }
+
+    /// <https://etherscan.io/tx/0x280cde7cdefe4b188750e76c888f13bd05ce9a4d7767730feefe8a0e50ca6fc4>
+    /// https://github.com/gakonst/ethers-rs/issues/1732
+    #[test]
+    fn test_rlp_decoding_issue_1732() {
+        let raw_tx = "f9015482078b8505d21dba0083022ef1947a250d5630b4cf539739df2c5dacb4c659f2488d880c46549a521b13d8b8e47ff36ab50000000000000000000000000000000000000000000066ab5a608bd00a23f2fe000000000000000000000000000000000000000000000000000000000000008000000000000000000000000048c04ed5691981c42154c6167398f95e8f38a7ff00000000000000000000000000000000000000000000000000000000632ceac70000000000000000000000000000000000000000000000000000000000000002000000000000000000000000c02aaa39b223fe8d0a0e5c4f27ead9083c756cc20000000000000000000000006c6ee5e31d828de241282b9606c8e98ea48526e225a0c9077369501641a92ef7399ff81c21639ed4fd8fc69cb793cfa1dbfab342e10aa0615facb2f1bcf3274a354cfe384a38d0cc008a11c2dd23a69111bc6930ba27a8";
+
+        let rlp_bytes = hex::decode(raw_tx).unwrap();
+
+        let decoded_tx: Transaction = rlp::decode(&rlp_bytes).unwrap();
+
+        assert_eq!(
+            decoded_tx.recover_from().unwrap(),
+            "0xa12e1462d0ced572f396f58b6e2d03894cd7c8a4".parse().unwrap()
+        );
     }
 
     #[test]
@@ -797,6 +830,7 @@ mod tests {
         assert_eq!(decoded_transaction.hash(), tx.hash());
     }
 
+    // <https://etherscan.io/tx/0x929ff27a5c7833953df23103c4eb55ebdfb698678139d751c51932163877fada>
     #[test]
     fn decode_rlp_legacy_in_envelope() {
         let tx = Transaction {
@@ -824,11 +858,18 @@ mod tests {
             other: Default::default()
         };
 
-        let rlp_bytes = hex::decode("00f8aa808512ec276caf83010e2b94dac17f958d2ee523a2206206994597c13d831ec780b844a9059cbb000000000000000000000000fdae129ecc2c27d166a3131098bc05d143fa258e0000000000000000000000000000000000000000000000000000000002faf08025a0c81e70f9e49e0d3b854720143e86d172fecc9e76ef8a8666f2fdc017017c5141a01dd3410180f6a6ca3e25ad3058789cd0df3321ed76b5b4dbe0a2bb2dc28ae274").unwrap();
+        let rlp_bytes = hex::decode("f8aa808512ec276caf83010e2b94dac17f958d2ee523a2206206994597c13d831ec780b844a9059cbb000000000000000000000000fdae129ecc2c27d166a3131098bc05d143fa258e0000000000000000000000000000000000000000000000000000000002faf08025a0c81e70f9e49e0d3b854720143e86d172fecc9e76ef8a8666f2fdc017017c5141a01dd3410180f6a6ca3e25ad3058789cd0df3321ed76b5b4dbe0a2bb2dc28ae274").unwrap();
 
-        let decoded_transaction = Transaction::decode(&rlp::Rlp::new(&rlp_bytes)).unwrap();
+        let decoded = Transaction::decode(&rlp::Rlp::new(&rlp_bytes)).unwrap();
-
+        assert_eq!(
-        assert_eq!(decoded_transaction.hash(), tx.hash());
+            decoded.hash(),
+            "929ff27a5c7833953df23103c4eb55ebdfb698678139d751c51932163877fada".parse().unwrap()
+        );
+        assert_eq!(decoded.hash(), tx.hash());
+        assert_eq!(
+            decoded.recover_from().unwrap(),
+            "0xc26ad91f4e7a0cad84c4b9315f420ca9217e315d".parse().unwrap()
+        );
     }
 
     #[test]