add unit tests

bnb-chain · May 9, 2024 · 9b9bceb · 9b9bceb
1 parent f422a6d
commit 9b9bceb
Show file tree

Hide file tree

Showing 4 changed files with 106 additions and 63 deletions.
diff --git a/crates/consensus/parlia/src/lib.rs b/crates/consensus/parlia/src/lib.rs
@@ -49,7 +49,7 @@ pub mod contract_upgrade;
 mod feynman_fork;
 pub use feynman_fork::*;
 pub mod go_rng;
-use crate::go_rng::{RngSource, Shuffle};
+use go_rng::{RngSource, Shuffle};
 
 const RECOVERED_PROPOSER_CACHE_NUM: usize = 4096;
 const SNAP_CACHE_NUM: usize = 2048;
@@ -138,7 +138,7 @@ impl<P> Parlia<P> {
         sig_hash_header.extra_data =
             Bytes::copy_from_slice(&header.extra_data[..header.extra_data.len() - EXTRA_SEAL_LEN]);
         let message = Message::from_slice(
-            sig_hash_header.hash_with_chain_id(self.chain_spec.chain.id()).as_slice(),
+            hash_with_chain_id(&sig_hash_header, self.chain_spec.chain.id()).as_slice(),
         )
         .map_err(|_| ParliaConsensusError::RecoverECDSAInnerError)?;
 

diff --git a/crates/consensus/parlia/src/util.rs b/crates/consensus/parlia/src/util.rs
@@ -1,7 +1,11 @@
 use lazy_static::lazy_static;
-use reth_primitives::{Address, Header, TransactionSigned};
+use reth_primitives::{
+    keccak256, Address, BufMut, BytesMut, Header, TransactionSigned, B256, B64, U256,
+};
 
+use crate::EXTRA_SEAL_LEN;
 use alloy_json_abi::JsonAbi;
+use alloy_rlp::Encodable;
 use serde_json::Error;
 use std::str::FromStr;
 
@@ -76,3 +80,102 @@ pub fn load_abi_from_file(path: &str) -> Result<JsonAbi, Error> {
     let abi: JsonAbi = serde_json::from_str(&json)?;
     Ok(abi)
 }
+
+pub fn hash_with_chain_id(header: &Header, chain_id: u64) -> B256 {
+    let mut out = BytesMut::new();
+    encode_header_with_chain_id(header, &mut out, chain_id);
+    keccak256(&out[..])
+}
+
+pub fn encode_header_with_chain_id(header: &Header, out: &mut dyn BufMut, chain_id: u64) {
+    rlp_header(header, chain_id).encode(out);
+    Encodable::encode(&U256::from(chain_id), out);
+    Encodable::encode(&header.parent_hash, out);
+    Encodable::encode(&header.ommers_hash, out);
+    Encodable::encode(&header.beneficiary, out);
+    Encodable::encode(&header.state_root, out);
+    Encodable::encode(&header.transactions_root, out);
+    Encodable::encode(&header.receipts_root, out);
+    Encodable::encode(&header.logs_bloom, out);
+    Encodable::encode(&header.difficulty, out);
+    Encodable::encode(&U256::from(header.number), out);
+    Encodable::encode(&header.gas_limit, out);
+    Encodable::encode(&header.gas_used, out);
+    Encodable::encode(&header.timestamp, out);
+    Encodable::encode(&header.extra_data[..header.extra_data.len() - EXTRA_SEAL_LEN], out); // will panic if extra_data is less than EXTRA_SEAL_LEN
+    Encodable::encode(&header.mix_hash, out);
+    Encodable::encode(&B64::new(header.nonce.to_be_bytes()), out);
+}
+
+fn rlp_header(header: &Header, chain_id: u64) -> alloy_rlp::Header {
+    let mut rlp_head = alloy_rlp::Header { list: true, payload_length: 0 };
+
+    // add chain_id make more security
+    rlp_head.payload_length += U256::from(chain_id).length(); // chain_id
+    rlp_head.payload_length += header.parent_hash.length(); // parent_hash
+    rlp_head.payload_length += header.ommers_hash.length(); // ommers_hash
+    rlp_head.payload_length += header.beneficiary.length(); // beneficiary
+    rlp_head.payload_length += header.state_root.length(); // state_root
+    rlp_head.payload_length += header.transactions_root.length(); // transactions_root
+    rlp_head.payload_length += header.receipts_root.length(); // receipts_root
+    rlp_head.payload_length += header.logs_bloom.length(); // logs_bloom
+    rlp_head.payload_length += header.difficulty.length(); // difficulty
+    rlp_head.payload_length += U256::from(header.number).length(); // block height
+    rlp_head.payload_length += header.gas_limit.length(); // gas_limit
+    rlp_head.payload_length += header.gas_used.length(); // gas_used
+    rlp_head.payload_length += header.timestamp.length(); // timestamp
+    rlp_head.payload_length +=
+        &header.extra_data[..header.extra_data.len() - EXTRA_SEAL_LEN].length(); // extra_data
+    rlp_head.payload_length += header.mix_hash.length(); // mix_hash
+    rlp_head.payload_length += &B64::new(header.nonce.to_be_bytes()).length(); // nonce
+
+    rlp_head
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::{encode_header_with_chain_id, hash_with_chain_id};
+    use reth_primitives::{address, b256, hex, Bloom, Bytes, Header, U256};
+
+    #[test]
+    fn test_encode_header_with_chain_id() {
+        // test data from bsc testnet
+        let expected_rlp = "f902d361a0b68487ffcf4a419f8f8b77afb31e47eeb05195b0b77fe7a0bbc50ebe2f365992a01dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d4934794b71b214cb885500844365e95cd9942c7276e7fd8a08fcdaf2f45f782142206517f6c059888db0da8ad7809f2101c19f68a68984499a06765de680f44a688e9eed23adfe732fee37b3376d2888a9d7a3523e3a01bfb10a0c783cd24949a5ab58293ee8d9bcb8638699308e055747d044e3317fe5e638494b90100000000000000000000000040100000000000000000000000000000000080018000001420000000100000000000000000000000060008000000000000002030000200001000100000000000080008000020100000000080004000100000001c00400880200002000000040000000008000804000000000010000000100000040000000008800000000000200400200000081004200080000000000000081000200600400020000020080000002200000000080080001000000000000000000002000000020800000000000020000200000001008020880000001040120000200000100002000000000100000400000102000080000000000040000800000000000284024b8ca68402faf0808316db1a8465f003e3b8d5d88301030a846765746888676f312e32312e37856c696e757800000096d46a82f8b381fbb8608a1933f7b78c4e5fcc87580635f39d8850ec66ed767bce1fafaf582b1b941fc6ab17c6b951e188e845e87f4b77136dd512dcf971b93472e4eb1f54799e5ff90ebc6e8d43339bb0e3009ff488cb87a03b104a7ce9d1ba6c17c54e34c1069c77a8f84c84024b8ca4a00bb45f286d475ad03dfa64215c3d21f9bccd5d199d6da149c2958923666b96f384024b8ca5a0b68487ffcf4a419f8f8b77afb31e47eeb05195b0b77fe7a0bbc50ebe2f36599280a00000000000000000000000000000000000000000000000000000000000000000880000000000000000";
+        let expected_hash = "1cc380de1196b5bb088f6b7a0eac87f9634864ee6c3f4a47396155464f6ef8f2";
+
+        let bloom = Bloom::from_slice(&hex::decode("000000000000000000000040100000000000000000000000000000000080018000001420000000100000000000000000000000060008000000000000002030000200001000100000000000080008000020100000000080004000100000001c0040088020000200000004000000000800080400000000001000000010000004000000000880000000000020040020000008100420008000000000000008100020060040002000002008000000220000000008008000100000000000000000000200000002080000000000002000020000000100802088000000104012000020000010000200000000010000040000010200008000000000004000080000000000").unwrap());
+        let extra = hex::decode("d88301030a846765746888676f312e32312e37856c696e757800000096d46a82f8b381fbb8608a1933f7b78c4e5fcc87580635f39d8850ec66ed767bce1fafaf582b1b941fc6ab17c6b951e188e845e87f4b77136dd512dcf971b93472e4eb1f54799e5ff90ebc6e8d43339bb0e3009ff488cb87a03b104a7ce9d1ba6c17c54e34c1069c77a8f84c84024b8ca4a00bb45f286d475ad03dfa64215c3d21f9bccd5d199d6da149c2958923666b96f384024b8ca5a0b68487ffcf4a419f8f8b77afb31e47eeb05195b0b77fe7a0bbc50ebe2f3659928094a6203400acc84400f2f1aa658e17180490e2f5b758124097751b9cd0a954dc672530d892214bfc77c35201473e34a5ad44100fc0e2235325ba393d5261c26800").unwrap();
+
+        let header = Header {
+            parent_hash: b256!("b68487ffcf4a419f8f8b77afb31e47eeb05195b0b77fe7a0bbc50ebe2f365992"),
+            ommers_hash: b256!("1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347"),
+            beneficiary: address!("B71b214Cb885500844365E95CD9942C7276E7fD8"),
+            state_root: b256!("8fcdaf2f45f782142206517f6c059888db0da8ad7809f2101c19f68a68984499"),
+            transactions_root: b256!(
+                "6765de680f44a688e9eed23adfe732fee37b3376d2888a9d7a3523e3a01bfb10"
+            ),
+            receipts_root: b256!(
+                "c783cd24949a5ab58293ee8d9bcb8638699308e055747d044e3317fe5e638494"
+            ),
+            logs_bloom: bloom,
+            difficulty: U256::from(2),
+            number: 38505638,
+            gas_limit: 50000000,
+            gas_used: 1497882,
+            timestamp: 1710228451,
+            extra_data: Bytes::from(extra),
+            mix_hash: b256!("0000000000000000000000000000000000000000000000000000000000000000"),
+            nonce: 0,
+            ..Default::default()
+        };
+
+        let mut data = vec![];
+        encode_header_with_chain_id(&header, &mut data, 97);
+        println!("rlp output: {:?}", hex::encode(&data));
+        assert_eq!(hex::encode(&data), expected_rlp);
+
+        let hash = hash_with_chain_id(&header, 97);
+        println!("encode hash: {:?}", hex::encode(hash.as_slice()));
+        assert_eq!(hex::encode(hash.as_slice()), expected_hash);
+    }
+}
diff --git a/crates/primitives/src/header.rs b/crates/primitives/src/header.rs
@@ -210,65 +210,6 @@ impl Header {
         keccak256(alloy_rlp::encode(self))
     }
 
-    /// hash_with_chain_id
-    /// It’s a dedicated method for bsc’s header rlp encode.
-    /// add chain_id in header encode make more security.
-    /// ignore baseFee encode in bsc rlp encode.
-    pub fn hash_with_chain_id(&self, chain_id: u64) -> B256 {
-        let mut out = BytesMut::new();
-        self.encode_with_chain_id(&mut out, chain_id);
-        keccak256(&out[..])
-    }
-
-    fn encode_with_chain_id(&self, out: &mut dyn BufMut, chain_id: u64) {
-        self.rlp_header_with_chain_id(chain_id).encode(out);
-        Encodable::encode(&chain_id, out);
-        Encodable::encode(&self.parent_hash, out);
-        Encodable::encode(&self.ommers_hash, out);
-        Encodable::encode(&self.beneficiary, out);
-        Encodable::encode(&self.state_root, out);
-        Encodable::encode(&self.transactions_root, out);
-        Encodable::encode(&self.receipts_root, out);
-        Encodable::encode(&self.logs_bloom, out);
-        Encodable::encode(&self.difficulty, out);
-        Encodable::encode(&self.number, out);
-        Encodable::encode(&self.gas_limit, out);
-        Encodable::encode(&self.gas_used, out);
-        Encodable::encode(&self.timestamp, out);
-        Encodable::encode(&self.extra_data, out);
-        Encodable::encode(&self.mix_hash, out);
-        Encodable::encode(&self.nonce, out);
-    }
-
-    fn rlp_header_with_chain_id(&self, chain_id: u64) -> alloy_rlp::Header {
-        let mut rlp_head = alloy_rlp::Header {
-            list: true,
-            payload_length: 0,
-        };
-
-        // add chain_id make more security
-        rlp_head.payload_length += chain_id.length(); // chain_id
-        // +1?
-        rlp_head.payload_length += self.parent_hash.length(); // parent_hash
-        rlp_head.payload_length += self.ommers_hash.length(); // ommers_hash
-        rlp_head.payload_length += self.beneficiary.length(); // beneficiary
-        rlp_head.payload_length += self.state_root.length(); // state_root
-        rlp_head.payload_length += self.transactions_root.length(); // transactions_root
-        rlp_head.payload_length += self.receipts_root.length(); // receipts_root
-        rlp_head.payload_length += self.logs_bloom.length() + length_of_length(self.logs_bloom.length()); // logs_bloom
-        rlp_head.payload_length += self.difficulty.length(); // difficulty
-        rlp_head.payload_length += U256::from(self.number).length(); // block height
-        rlp_head.payload_length += self.gas_limit.length(); // gas_limit
-        rlp_head.payload_length += self.gas_used.length(); // gas_used
-        rlp_head.payload_length += self.timestamp.length(); // timestamp
-        rlp_head.payload_length += self.extra_data.length(); // extra_data
-        rlp_head.payload_length += self.mix_hash.length(); // mix_hash
-        rlp_head.payload_length += B64::new(self.nonce.to_be_bytes()).length(); // nonce
-
-        //bsc don’t need basfee for header rlp encode
-        rlp_head
-    }
-
     /// Checks if the header is empty - has no transactions and no ommers
     pub fn is_empty(&self) -> bool {
         self.transaction_root_is_empty() &&

diff --git a/crates/storage/db/src/tables/models/parlia/snapshot.rs b/crates/storage/db/src/tables/models/parlia/snapshot.rs
@@ -67,7 +67,6 @@ impl Snapshot {
         }
     }
 
-    // TODO: test apply
     /// Apply the next block to the snapshot
     pub fn apply(
         &mut self,