feat: combine variable

kamiyaa · kamiyaa · commit 582293220933 · 2025-10-16T11:43:00.000-04:00
diff --git a/rust/main/agents/relayer/src/msg/db_loader.rs b/rust/main/agents/relayer/src/msg/db_loader.rs
@@ -422,7 +422,7 @@ pub mod test {
         },
     };
     use hyperlane_core::{
-        identifiers::UniqueIdentifier, test_utils::dummy_domain, GasPaymentKey,
+        identifiers::UniqueIdentifier, test_utils::dummy_domain, CheckpointInfo, GasPaymentKey,
         InterchainGasPayment, InterchainGasPaymentMeta, MerkleTreeInsertion,
         PendingOperationStatus, H256,
     };
@@ -737,16 +737,8 @@ pub mod test {
 
             fn retrieve_payload_uuids_by_message_id(&self, message_id: &H256) -> DbResult<Option<Vec<UniqueIdentifier>>>;
 
-            fn store_latest_checkpoint_block_height(
-                &self,
-                checkpoint_block_height: u64,
-            ) -> DbResult<()>;
-            fn retrieve_latest_checkpoint_block_height(
-                &self,
-            ) -> DbResult<Option<u64>>;
-
-            fn store_latest_checkpoint_index(&self, checkpoint_index: u64) -> DbResult<()>;
-            fn retrieve_latest_checkpoint_index(&self) -> DbResult<Option<u64>>;
+            fn store_latest_checkpoint_info(&self, checkpoint_info: &CheckpointInfo) -> DbResult<()>;
+            fn retrieve_latest_checkpoint_info(&self) -> DbResult<Option<CheckpointInfo>>;
         }
     }
 
diff --git a/rust/main/agents/relayer/src/msg/pending_message.rs b/rust/main/agents/relayer/src/msg/pending_message.rs
@@ -1202,15 +1202,9 @@ mod test {
             fn retrieve_highest_seen_message_nonce_number(&self) -> DbResult<Option<u32>>;
             fn store_payload_uuids_by_message_id(&self, message_id: &H256, payload_uuids: Vec<UniqueIdentifier>) -> DbResult<()>;
             fn retrieve_payload_uuids_by_message_id(&self, message_id: &H256) -> DbResult<Option<Vec<UniqueIdentifier>>>;
-            fn store_latest_checkpoint_block_height(
-                &self,
-                checkpoint_block_height: u64,
-            ) -> DbResult<()>;
-            fn retrieve_latest_checkpoint_block_height(
-                &self,
-            ) -> DbResult<Option<u64>>;
-            fn store_latest_checkpoint_index(&self, checkpoint_index: u64) -> DbResult<()>;
-            fn retrieve_latest_checkpoint_index(&self) -> DbResult<Option<u64>>;
+
+            fn store_latest_checkpoint_info(&self, checkpoint_info: &CheckpointInfo) -> DbResult<()>;
+            fn retrieve_latest_checkpoint_info(&self) -> DbResult<Option<CheckpointInfo>>;
         }
     }
 
diff --git a/rust/main/agents/validator/src/submit.rs b/rust/main/agents/validator/src/submit.rs
@@ -118,14 +118,9 @@ impl ValidatorSubmitter {
             true
         };
 
-        let mut latest_seen_checkpoint_index = self
+        let mut latest_seen_checkpoint = self
             .db
-            .retrieve_latest_checkpoint_index()
-            .unwrap_or_default()
-            .unwrap_or_default() as u32;
-        let mut latest_seen_checkpoint_block_height = self
-            .db
-            .retrieve_latest_checkpoint_block_height()
+            .retrieve_latest_checkpoint_info()
             .unwrap_or_default()
             .unwrap_or_default();
 
@@ -138,59 +133,40 @@ impl ValidatorSubmitter {
             })
             .await;
 
-            if latest_checkpoint.index < latest_seen_checkpoint_index {
-                if let Some(block_height) = latest_checkpoint.block_height {
-                    if block_height >= latest_seen_checkpoint_block_height {
-                        tracing::error!(
-                            ?latest_checkpoint,
-                            ?latest_seen_checkpoint_index,
-                            ?latest_seen_checkpoint_block_height,
-                            "Latest checkpoint index is lower than previously seen, but has a block height equal or greater.");
-
-                        let checkpoint = self.checkpoint(&tree);
-                        Self::panic_with_reorg(
-                            &self.reorg_reporter,
-                            &self.reorg_period,
-                            &self.checkpoint_syncer,
-                            tree.root(),
-                            &latest_checkpoint,
-                            &checkpoint,
-                        )
-                        .await;
-                    }
+            if let Some(block_height) = latest_checkpoint.block_height {
+                if latest_checkpoint.index < latest_seen_checkpoint.checkpoint_index
+                    && block_height >= latest_seen_checkpoint.block_height
+                {
+                    tracing::error!(
+                        ?latest_checkpoint,
+                        ?latest_seen_checkpoint,
+                        "Latest checkpoint index is lower than previously seen, but has a block height equal or greater.");
+
+                    let checkpoint = self.checkpoint(&tree);
+                    Self::panic_with_reorg(
+                        &self.reorg_reporter,
+                        &self.reorg_period,
+                        &self.checkpoint_syncer,
+                        tree.root(),
+                        &latest_checkpoint,
+                        &checkpoint,
+                    )
+                    .await;
                 }
-            }
-
-            if latest_checkpoint.index > latest_seen_checkpoint_index {
                 tracing::debug!(
-                    old_index = latest_seen_checkpoint_index,
-                    new_index = latest_checkpoint.index,
+                    ?latest_checkpoint,
+                    ?latest_seen_checkpoint,
                     "Updating latest seen checkpoint index"
                 );
-                latest_seen_checkpoint_index = latest_checkpoint.index;
-                if let Err(err) = self
-                    .db
-                    .store_latest_checkpoint_index(latest_seen_checkpoint_index as u64)
-                {
-                    tracing::error!(?err, "Failed to store latest_checkpoint_index");
-                };
-                if let Some(block_height) = latest_checkpoint.block_height {
-                    if block_height < latest_seen_checkpoint_block_height {
-                        tracing::warn!(
-                            checkpoint_index = latest_checkpoint.index,
-                            checkpoint_block_height = block_height,
-                            latest_seen_checkpoint_block_height,
-                            "Receive a checkpoint with a higher index, but lower block height"
-                        );
-                    }
-                    latest_seen_checkpoint_block_height = block_height;
-                    if let Err(err) = self
-                        .db
-                        .store_latest_checkpoint_block_height(latest_seen_checkpoint_block_height)
-                    {
-                        tracing::error!(?err, "Failed to store latest_checkpoint_block_height");
-                    }
+                if block_height < latest_seen_checkpoint.block_height {
+                    tracing::warn!(
+                        ?latest_checkpoint,
+                        ?latest_seen_checkpoint,
+                        "Receive a checkpoint with a higher index, but lower block height"
+                    );
                 }
+                latest_seen_checkpoint.block_height = block_height;
+                latest_seen_checkpoint.checkpoint_index = latest_checkpoint.index;
             }
 
             self.metrics
@@ -344,13 +320,14 @@ impl ValidatorSubmitter {
         correctness_checkpoint: &CheckpointAtBlock,
         incorrect_checkpoint: &Checkpoint,
     ) {
-        let reorg_event = ReorgEvent::new(
-            tree_root,
-            correctness_checkpoint.root,
-            incorrect_checkpoint.index,
-            chrono::Utc::now().timestamp() as u64,
-            reorg_period.clone(),
-        );
+        let reorg_event = ReorgEvent {
+            local_merkle_root: tree_root,
+            local_checkpoint_index: incorrect_checkpoint.index,
+            canonical_merkle_root: correctness_checkpoint.root,
+            canonical_checkpoint_index: correctness_checkpoint.index,
+            unix_timestamp: chrono::Utc::now().timestamp() as u64,
+            reorg_period: reorg_period.clone(),
+        };
         error!(
             ?incorrect_checkpoint,
             ?correctness_checkpoint,
diff --git a/rust/main/agents/validator/src/submit/tests.rs b/rust/main/agents/validator/src/submit/tests.rs
@@ -9,10 +9,11 @@ use hyperlane_base::db::{
     DbResult, HyperlaneDb, InterchainGasExpenditureData, InterchainGasPaymentData,
 };
 use hyperlane_core::{
-    identifiers::UniqueIdentifier, test_utils::dummy_domain, GasPaymentKey, HyperlaneChain,
-    HyperlaneContract, HyperlaneDomain, HyperlaneMessage, HyperlaneProvider, InterchainGasPayment,
-    InterchainGasPaymentMeta, MerkleTreeHook, MerkleTreeInsertion, PendingOperationStatus,
-    ReorgEvent, SignedAnnouncement, SignedCheckpointWithMessageId, H160, H256,
+    identifiers::UniqueIdentifier, test_utils::dummy_domain, CheckpointInfo, GasPaymentKey,
+    HyperlaneChain, HyperlaneContract, HyperlaneDomain, HyperlaneMessage, HyperlaneProvider,
+    InterchainGasPayment, InterchainGasPaymentMeta, MerkleTreeHook, MerkleTreeInsertion,
+    PendingOperationStatus, ReorgEvent, SignedAnnouncement, SignedCheckpointWithMessageId, H160,
+    H256,
 };
 
 use super::*;
@@ -130,15 +131,9 @@ mockall::mock! {
         fn retrieve_highest_seen_message_nonce_number(&self) -> DbResult<Option<u32>>;
         fn store_payload_uuids_by_message_id(&self, message_id: &H256, payload_uuids: Vec<UniqueIdentifier>) -> DbResult<()>;
         fn retrieve_payload_uuids_by_message_id(&self, message_id: &H256) -> DbResult<Option<Vec<UniqueIdentifier>>>;
-        fn store_latest_checkpoint_block_height(
-            &self,
-            checkpoint_block_height: u64,
-        ) -> DbResult<()>;
-        fn retrieve_latest_checkpoint_block_height(
-            &self,
-        ) -> DbResult<Option<u64>>;
-        fn store_latest_checkpoint_index(&self, checkpoint_index: u64) -> DbResult<()>;
-        fn retrieve_latest_checkpoint_index(&self) -> DbResult<Option<u64>>;
+
+        fn store_latest_checkpoint_info(&self, checkpoint_info: &CheckpointInfo) -> DbResult<()>;
+        fn retrieve_latest_checkpoint_info(&self) -> DbResult<Option<CheckpointInfo>>;
     }
 }
 
@@ -227,12 +222,16 @@ fn reorg_event_is_correct(
         reorg_event.canonical_merkle_root,
         mock_onchain_merkle_tree.root()
     );
+    assert_eq!(
+        reorg_event.canonical_checkpoint_index,
+        mock_onchain_merkle_tree.index()
+    );
     assert_eq!(
         reorg_event.local_merkle_root,
         expected_local_merkle_tree.root()
     );
     assert_eq!(
-        reorg_event.checkpoint_index,
+        reorg_event.local_checkpoint_index,
         expected_local_merkle_tree.index()
     );
     // timestamp diff should be less than 1 second
diff --git a/rust/main/hyperlane-base/src/db/mod.rs b/rust/main/hyperlane-base/src/db/mod.rs
@@ -3,9 +3,9 @@ pub use error::*;
 pub use rocks::*;
 
 use hyperlane_core::{
-    identifiers::UniqueIdentifier, GasPaymentKey, HyperlaneDomain, HyperlaneMessage,
-    InterchainGasPayment, InterchainGasPaymentMeta, MerkleTreeInsertion, PendingOperationStatus,
-    H256,
+    identifiers::UniqueIdentifier, CheckpointInfo, GasPaymentKey, HyperlaneDomain,
+    HyperlaneMessage, InterchainGasPayment, InterchainGasPaymentMeta, MerkleTreeInsertion,
+    PendingOperationStatus, H256,
 };
 
 mod error;
@@ -174,13 +174,8 @@ pub trait HyperlaneDb: Send + Sync {
         message_id: &H256,
     ) -> DbResult<Option<Vec<UniqueIdentifier>>>;
 
-    /// Store latest seen checkpoint block height
-    fn store_latest_checkpoint_block_height(&self, checkpoint_block_height: u64) -> DbResult<()>;
-    /// Retrieve latest seen checkpoint block height
-    fn retrieve_latest_checkpoint_block_height(&self) -> DbResult<Option<u64>>;
-
-    /// Store latest seen checkpoint index
-    fn store_latest_checkpoint_index(&self, checkpoint_index: u64) -> DbResult<()>;
-    /// Retrieve latest seen checkpoint index
-    fn retrieve_latest_checkpoint_index(&self) -> DbResult<Option<u64>>;
+    /// Store latest seen checkpoint info
+    fn store_latest_checkpoint_info(&self, checkpoint_info: &CheckpointInfo) -> DbResult<()>;
+    /// Retrieve latest seen checkpoint info
+    fn retrieve_latest_checkpoint_info(&self) -> DbResult<Option<CheckpointInfo>>;
 }
diff --git a/rust/main/hyperlane-base/src/db/rocks/hyperlane_db.rs b/rust/main/hyperlane-base/src/db/rocks/hyperlane_db.rs
@@ -5,7 +5,7 @@ use eyre::{bail, Result};
 use tracing::{debug, instrument, trace};
 
 use hyperlane_core::{
-    identifiers::UniqueIdentifier, Decode, Encode, GasPaymentKey, HyperlaneDomain,
+    identifiers::UniqueIdentifier, CheckpointInfo, Decode, Encode, GasPaymentKey, HyperlaneDomain,
     HyperlaneLogStore, HyperlaneMessage, HyperlaneSequenceAwareIndexerStoreReader,
     HyperlaneWatermarkedLogStore, Indexed, InterchainGasExpenditure, InterchainGasPayment,
     InterchainGasPaymentMeta, LogMeta, MerkleTreeInsertion, PendingOperationStatus, H256,
@@ -40,8 +40,7 @@ const MERKLE_TREE_INSERTION_BLOCK_NUMBER_BY_LEAF_INDEX: &str =
     "merkle_tree_insertion_block_number_by_leaf_index_";
 const LATEST_INDEXED_GAS_PAYMENT_BLOCK: &str = "latest_indexed_gas_payment_block";
 const PAYLOAD_UUIDS_BY_MESSAGE_ID: &str = "payload_uuids_by_message_id_";
-const LATEST_CHECKPOINT_BLOCK_HEIGHT: &str = "latest_checkpoint_block_height";
-const LATEST_CHECKPOINT_INDEX: &str = "latest_checkpoint_index";
+const LATEST_CHECKPOINT_INFO: &str = "latest_checkpoint_info";
 
 /// Rocks DB result type
 pub type DbResult<T> = std::result::Result<T, DbError>;
@@ -701,22 +700,11 @@ impl HyperlaneDb for HyperlaneRocksDB {
         self.retrieve_value_by_key(PAYLOAD_UUIDS_BY_MESSAGE_ID, message_id)
     }
 
-    fn store_latest_checkpoint_block_height(&self, checkpoint_block_height: u64) -> DbResult<()> {
-        self.store_value_by_key(
-            LATEST_CHECKPOINT_BLOCK_HEIGHT,
-            &bool::default(),
-            &checkpoint_block_height,
-        )
-    }
-    fn retrieve_latest_checkpoint_block_height(&self) -> DbResult<Option<u64>> {
-        self.retrieve_value_by_key(LATEST_CHECKPOINT_BLOCK_HEIGHT, &bool::default())
-    }
-
-    fn store_latest_checkpoint_index(&self, checkpoint_index: u64) -> DbResult<()> {
-        self.store_value_by_key(LATEST_CHECKPOINT_INDEX, &bool::default(), &checkpoint_index)
+    fn store_latest_checkpoint_info(&self, checkpoint_info: &CheckpointInfo) -> DbResult<()> {
+        self.store_value_by_key(LATEST_CHECKPOINT_INFO, &bool::default(), checkpoint_info)
     }
-    fn retrieve_latest_checkpoint_index(&self) -> DbResult<Option<u64>> {
-        self.retrieve_value_by_key(LATEST_CHECKPOINT_INDEX, &bool::default())
+    fn retrieve_latest_checkpoint_info(&self) -> DbResult<Option<CheckpointInfo>> {
+        self.retrieve_value_by_key(LATEST_CHECKPOINT_INFO, &bool::default())
     }
 }
 
diff --git a/rust/main/hyperlane-base/src/settings/checkpoint_syncer.rs b/rust/main/hyperlane-base/src/settings/checkpoint_syncer.rs
@@ -207,13 +207,15 @@ mod test {
         let dummy_canonical_merkle_root =
             H256::from_str("0xb437b888332ef12f7260c7f679aad3c96b91ab81c2dc7242f8b290f0b6bba92b")
                 .unwrap();
-        let dummy_checkpoint_index = 56;
+        let dummy_local_checkpoint_index = 56;
+        let dummy_canonical_checkpoint_index = 56;
         let unix_timestamp = 1620000000;
         let reorg_period = ReorgPeriod::from_blocks(5);
         let dummy_reorg_event = ReorgEvent {
             local_merkle_root: dummy_local_merkle_root,
+            local_checkpoint_index: dummy_local_checkpoint_index,
             canonical_merkle_root: dummy_canonical_merkle_root,
-            checkpoint_index: dummy_checkpoint_index,
+            canonical_checkpoint_index: dummy_canonical_checkpoint_index,
             unix_timestamp,
             reorg_period,
         };
diff --git a/rust/main/hyperlane-core/src/types/checkpoint.rs b/rust/main/hyperlane-core/src/types/checkpoint.rs
@@ -4,7 +4,7 @@ use derive_more::Deref;
 use serde::{Deserialize, Serialize};
 use sha3::{digest::Update, Digest, Keccak256};
 
-use crate::{utils::domain_hash, Signable, Signature, SignedType, H256};
+use crate::{utils::domain_hash, Decode, Encode, Signable, Signature, SignedType, H256};
 
 /// An Hyperlane checkpoint
 #[derive(Copy, Clone, Eq, PartialEq, Serialize, Deserialize, Debug)]
@@ -98,3 +98,38 @@ impl TryFrom<&mut Vec<SignedCheckpointWithMessageId>> for MultisigSignedCheckpoi
         })
     }
 }
+
+/// Information about the checkpoint
+#[derive(Copy, Clone, Eq, PartialEq, Serialize, Deserialize, Debug, Default)]
+pub struct CheckpointInfo {
+    /// block height of checkpoint
+    pub block_height: u64,
+    /// index of checkpoint
+    pub checkpoint_index: u32,
+}
+
+impl Encode for CheckpointInfo {
+    fn write_to<W>(&self, writer: &mut W) -> std::io::Result<usize>
+    where
+        W: std::io::Write,
+    {
+        let mut written: usize = self.checkpoint_index.write_to(writer)?;
+        written = written.saturating_add(self.block_height.write_to(writer)?);
+        Ok(written)
+    }
+}
+
+impl Decode for CheckpointInfo {
+    fn read_from<R>(reader: &mut R) -> Result<Self, crate::HyperlaneProtocolError>
+    where
+        R: std::io::Read,
+        Self: Sized,
+    {
+        let checkpoint_index = u32::read_from(reader)?;
+        let block_height = u64::read_from(reader)?;
+        Ok(Self {
+            checkpoint_index,
+            block_height,
+        })
+    }
+}
diff --git a/rust/main/hyperlane-core/src/types/reorg.rs b/rust/main/hyperlane-core/src/types/reorg.rs
@@ -10,9 +10,10 @@ pub struct ReorgEvent {
     pub local_merkle_root: H256,
     /// the onchain merkle root
     pub canonical_merkle_root: H256,
-    /// the index of the checkpoint when the reorg was detected
-    /// (due to a mismatch between local and canonical merkle roots)
-    pub checkpoint_index: u32,
+    /// the latest local checkpoint index
+    pub local_checkpoint_index: u32,
+    /// the latest onchain checkpoint index
+    pub canonical_checkpoint_index: u32,
     /// the timestamp when the reorg was detected, in seconds since the Unix epoch
     pub unix_timestamp: u64,
     /// the reorg period configured for the agent
