update some comments

starcoinorg · Feb 26, 2024 · bb060a1 · bb060a1
1 parent 93c12e4
commit bb060a1
Show file tree

Hide file tree

Showing 3 changed files with 31 additions and 19 deletions.
diff --git a/chain/src/chain.rs b/chain/src/chain.rs
@@ -245,7 +245,10 @@ impl BlockChain {
             None => self.current_header(),
         };
 
-        debug!("jacktest: creating block template, previous header: {:?}", previous_header.number());
+        debug!(
+            "jacktest: creating block template, previous header: {:?}",
+            previous_header.number()
+        );
 
         self.create_block_template_by_header(
             author,
@@ -266,7 +269,11 @@ impl BlockChain {
         block_gas_limit: Option<u64>,
         tips: Option<Vec<HashValue>>,
     ) -> Result<(BlockTemplate, ExcludedTxns)> {
-        debug!("jacktest: parent hash: {:?}, number: {:?}", previous_header.id(), previous_header.number());
+        debug!(
+            "jacktest: parent hash: {:?}, number: {:?}",
+            previous_header.id(),
+            previous_header.number()
+        );
         let current_number = previous_header.number().saturating_add(1);
         let epoch = self.epoch();
         let on_chain_block_gas_limit = epoch.block_gas_limit();
@@ -987,14 +994,20 @@ impl ChainReader for BlockChain {
     fn find_ancestor(&self, another: &dyn ChainReader) -> Result<Option<BlockIdAndNumber>> {
         let other_header_number = another.current_header().number();
         let self_header_number = self.current_header().number();
-        debug!("jacktest: self_header_number: {}, other_header_number: {}", self_header_number, other_header_number);
+        debug!(
+            "jacktest: self_header_number: {}, other_header_number: {}",
+            self_header_number, other_header_number
+        );
         let min_number = std::cmp::min(other_header_number, self_header_number);
         debug!("jacktest: min_number: {}", min_number);
         let mut ancestor = None;
         for block_number in (0..=min_number).rev() {
             let block_id_1 = another.get_hash_by_number(block_number)?;
             let block_id_2 = self.get_hash_by_number(block_number)?;
-            debug!("jacktest: block number: {}, block_id_1: {:?}, block_id_2: {:?}", block_number, block_id_1, block_id_2);
+            debug!(
+                "jacktest: block number: {}, block_id_1: {:?}, block_id_2: {:?}",
+                block_number, block_id_1, block_id_2
+            );
             match (block_id_1, block_id_2) {
                 (Some(block_id_1), Some(block_id_2)) => {
                     if block_id_1 == block_id_2 {
@@ -1147,8 +1160,6 @@ impl ChainReader for BlockChain {
     }
 
     fn dag_fork_height(&self) -> Result<BlockNumber> {
-        // todo: change return type to Result<BlockNumber>,
-        // try to handle db io error
         match self.dag.block_dag_config() {
             BlockDAGType::BlockDAGFormal => Ok(self
                 .statedb

diff --git a/miner/src/create_block_template/mod.rs b/miner/src/create_block_template/mod.rs
@@ -293,9 +293,10 @@ where
     fn uncles_prune(&mut self) {
         if !self.uncles.is_empty() {
             let epoch = self.chain.epoch();
-            // epoch的end_number是开区间，当前块已经生成但还没有apply，所以应该在epoch（最终状态）
-            // 的倒数第二块处理时清理uncles
             if epoch.end_block_number() == (self.chain.current_header().number() + 2) {
+                // 1. The last block of current epoch is `end_block_number`-1,
+                // 2. If current block number is `end_block_number`-2, then last block has been mined but un-applied to db,
+                // 3. So current uncles should be cleared now.
                 self.uncles.clear();
             }
         }

diff --git a/types/src/block/mod.rs b/types/src/block/mod.rs
@@ -95,8 +95,8 @@ impl std::fmt::Display for BlockHeaderExtra {
 
 impl<'de> Deserialize<'de> for BlockHeaderExtra {
     fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
-        where
-            D: Deserializer<'de>,
+    where
+        D: Deserializer<'de>,
     {
         if deserializer.is_human_readable() {
             let s = <String>::deserialize(deserializer)?;
@@ -123,8 +123,8 @@ impl<'de> Deserialize<'de> for BlockHeaderExtra {
 
 impl Serialize for BlockHeaderExtra {
     fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
-        where
-            S: Serializer,
+    where
+        S: Serializer,
     {
         if serializer.is_human_readable() {
             format!("0x{}", hex::encode(self.0)).serialize(serializer)
@@ -135,7 +135,7 @@ impl Serialize for BlockHeaderExtra {
 }
 
 #[derive(
-Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize, JsonSchema,
+    Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Deserialize, Serialize, JsonSchema,
 )]
 pub struct BlockIdAndNumber {
     pub id: HashValue,
@@ -485,8 +485,8 @@ impl BlockHeader {
 
 impl<'de> Deserialize<'de> for BlockHeader {
     fn deserialize<D>(deserializer: D) -> Result<Self, <D as Deserializer<'de>>::Error>
-        where
-            D: Deserializer<'de>,
+    where
+        D: Deserializer<'de>,
     {
         #[derive(Deserialize)]
         #[serde(rename = "BlockHeader")]
@@ -731,7 +731,7 @@ impl BlockHeaderBuilder {
 }
 
 #[derive(
-Default, Clone, Debug, Hash, Eq, PartialEq, Serialize, Deserialize, CryptoHasher, CryptoHash,
+    Default, Clone, Debug, Hash, Eq, PartialEq, Serialize, Deserialize, CryptoHasher, CryptoHash,
 )]
 pub struct BlockBody {
     /// The transactions in this block.
@@ -801,8 +801,8 @@ pub struct Block {
 
 impl Block {
     pub fn new<B>(header: BlockHeader, body: B) -> Self
-        where
-            B: Into<BlockBody>,
+    where
+        B: Into<BlockBody>,
     {
         Block {
             header,
@@ -954,7 +954,7 @@ impl Sample for Block {
 /// `BlockInfo` is the object we store in the storage. It consists of the
 /// block as well as the execution result of this block.
 #[derive(
-Clone, Debug, Hash, Eq, PartialEq, Serialize, Deserialize, CryptoHasher, CryptoHash, JsonSchema,
+    Clone, Debug, Hash, Eq, PartialEq, Serialize, Deserialize, CryptoHasher, CryptoHash, JsonSchema,
 )]
 pub struct BlockInfo {
     /// Block id