improve code quality

Co-authored-by: Toralf Wittner <[email protected]>

Author: alxiong

multisig/src/committee.rs

@@ -1,4 +1,5 @@
 use std::num::{NonZeroUsize, ParseIntError};
+use std::ops::{Add, Sub};
 use std::{fmt, str::FromStr};
 
 use std::sync::Arc;
@@ -107,6 +108,7 @@ impl Committee {
 #[derive(
     Debug,
     Copy,
+    Default,
     Clone,
     PartialEq,
     Eq,
@@ -163,3 +165,19 @@ impl Committable for CommitteeId {
             .finalize()
     }
 }
+
+impl Add<u64> for CommitteeId {
+    type Output = Self;
+
+    fn add(self, rhs: u64) -> Self::Output {
+        Self(self.0 + rhs)
+    }
+}
+
+impl Sub<u64> for CommitteeId {
+    type Output = Self;
+
+    fn sub(self, rhs: u64) -> Self::Output {
+        Self(self.0 - rhs)
+    }
+}

timeboost-contract/src/provider.rs

@@ -6,15 +6,15 @@ use std::{ops::Deref, pin::Pin};
 use alloy::{
     eips::BlockNumberOrTag,
     network::EthereumWallet,
-    primitives::Address,
+    primitives::{Address, BlockNumber},
     providers::{Provider, ProviderBuilder},
     rpc::types::{Filter, Log},
     signers::local::{LocalSignerError, MnemonicBuilder, PrivateKeySigner, coins_bip39::English},
     sol_types::SolEvent,
     transports::{http::reqwest::Url, ws::WsConnect},
 };
 use futures::{Stream, StreamExt};
-use timeboost_types::{HttpProvider, HttpProviderWithWallet};
+use timeboost_types::{HttpProvider, HttpProviderWithWallet, Timestamp};
 use tracing::error;
 
 /// Build a local signer from wallet mnemonic and account index
@@ -46,6 +46,7 @@ pub struct PubSubProvider(HttpProvider);
 
 impl Deref for PubSubProvider {
     type Target = HttpProvider;
+
     fn deref(&self) -> &Self::Target {
         &self.0
     }
@@ -64,10 +65,6 @@ impl PubSubProvider {
         Ok(Self(provider))
     }
 
-    pub fn inner(&self) -> &HttpProvider {
-        &self.0
-    }
-
     /// create an event stream of event type `E`, subscribing since `from_block` on `contract`
     pub async fn event_stream<E: SolEvent>(
         &self,
@@ -89,22 +86,24 @@ impl PubSubProvider {
             .into_stream();
 
         let validated = events.filter_map(|log| async move {
-            let Ok(event) = log.log_decode_validate::<E>() else {
-                error!("fail to parse CommitteeCreated event log");
-                return None;
-            };
-            Some(event)
+            match log.log_decode_validate::<E>() {
+                Ok(event) => Some(event),
+                Err(err) => {
+                    error!(%err, "fail to parse `CommitteeCreated` event log");
+                    None
+                }
+            }
         });
 
         Ok(Box::pin(validated))
     }
 
     /// Returns the smallest block number whose timestamp is >= `target_ts` through binary search.
-    /// Useful to determine `from_block` input of `Self::event_strea()` subscription.
+    /// Useful to determine `from_block` input of `Self::event_stream()` subscription.
     pub async fn get_block_number_by_timestamp(
         &self,
-        target_ts: u64,
-    ) -> anyhow::Result<Option<u64>> {
+        target_ts: Timestamp,
+    ) -> anyhow::Result<Option<BlockNumber>> {
         let latest = self.get_block_number().await?;
         let mut lo: u64 = 0;
         let mut hi: u64 = latest;
@@ -124,7 +123,7 @@ impl PubSubProvider {
                 }
             };
 
-            if block.header.timestamp >= target_ts {
+            if block.header.timestamp >= target_ts.into() {
                 if mid == 0 {
                     return Ok(Some(0));
                 }

timeboost/src/binaries/sailfish.rs

@@ -92,7 +92,7 @@ async fn main() -> Result<()> {
     let comm_info = CommitteeInfo::fetch(
         config.chain.parent.rpc_url,
         config.chain.parent.key_manager_contract,
-        cli.committee_id.into(),
+        cli.committee_id,
     )
     .await?;
     info!(label = %config.keys.signing.public, committee_id = %cli.committee_id, "committee info synced");
@@ -110,7 +110,7 @@ async fn main() -> Result<()> {
         config.net.public.address.clone(),
         signing_keypair.public_key(),
         dh_keypair.clone(),
-        comm_info.group(),
+        comm_info.address_info(),
         net_metrics,
     )
     .await?;

timeboost/src/binaries/timeboost.rs

@@ -73,7 +73,7 @@ async fn main() -> Result<()> {
     let comm_info = CommitteeInfo::fetch(
         node_config.chain.parent.rpc_url.clone(),
         node_config.chain.parent.key_manager_contract,
-        cli.committee_id.into(),
+        cli.committee_id,
     )
     .await?;
     info!(label = %sign_keypair.public_key(), committee_id = %cli.committee_id, "committee info synced");
@@ -95,8 +95,8 @@ async fn main() -> Result<()> {
     let pubkey = sign_keypair.public_key();
 
     // optionally fetch previous committee info
-    let cid: u64 = cli.committee_id.into();
-    let prev_comm = if cid > 0u64 {
+    let cid = cli.committee_id;
+    let prev_comm = if cid > CommitteeId::default() {
         let c = &node_config.chain.parent;
         let prev_comm =
             CommitteeInfo::fetch(c.rpc_url.clone(), c.key_manager_contract, cid - 1).await?;

timeboost/src/committee.rs

@@ -37,18 +37,25 @@ pub struct CommitteeInfo {
 
 impl CommitteeInfo {
     /// Fetch the committee info for `committee_id` from `key_manager_addr` on chain
-    pub async fn fetch(rpc: Url, key_manager_addr: Address, committee_id: u64) -> Result<Self> {
+    pub async fn fetch(
+        rpc: Url,
+        key_manager_addr: Address,
+        committee_id: CommitteeId,
+    ) -> Result<Self> {
         let provider = ProviderBuilder::new().connect_http(rpc);
         Self::fetch_with(provider, key_manager_addr, committee_id).await
     }
 
     pub(crate) async fn fetch_with(
         provider: impl Provider,
         key_manager_addr: Address,
-        committee_id: u64,
+        committee_id: CommitteeId,
     ) -> Result<Self> {
         let contract = KeyManager::new(key_manager_addr, &provider);
-        let c = contract.getCommitteeById(committee_id).call().await?;
+        let c = contract
+            .getCommitteeById(committee_id.into())
+            .call()
+            .await?;
 
         let (signing_keys, dh_keys, dkg_keys, public_addresses) = c
             .members
@@ -69,7 +76,7 @@ impl CommitteeInfo {
             .multiunzip();
 
         Ok(Self {
-            id: committee_id.into(),
+            id: committee_id,
             timestamp: c.effectiveTimestamp.into(),
             signing_keys,
             dh_keys,
@@ -100,7 +107,7 @@ impl CommitteeInfo {
         )
     }
 
-    pub fn group(
+    pub fn address_info(
         &self,
     ) -> impl Iterator<Item = (multisig::PublicKey, x25519::PublicKey, cliquenet::Address)> {
         izip!(
@@ -111,7 +118,7 @@ impl CommitteeInfo {
     }
 
     pub fn sailfish_committee(&self) -> AddressableCommittee {
-        AddressableCommittee::new(self.committee(), self.group())
+        AddressableCommittee::new(self.committee(), self.address_info())
     }
 
     pub fn decrypt_committee(&self) -> AddressableCommittee {
@@ -157,7 +164,7 @@ impl CommitteeInfo {
         config: &ParentChain,
     ) -> Result<NewCommitteeStream> {
         let from_block = provider
-            .get_block_number_by_timestamp(start_ts.into())
+            .get_block_number_by_timestamp(start_ts)
             .await?
             .unwrap_or_default();
         let events = provider
@@ -176,11 +183,13 @@ impl CommitteeInfo {
         let s = events.filter_map(move |log| {
             let provider = provider.clone();
             async move {
-                let id = log.data().id;
-                match CommitteeInfo::fetch_with(provider.inner(), key_manager_contract, id).await {
+                let committee_id: CommitteeId = log.data().id.into();
+                match CommitteeInfo::fetch_with(&*provider, key_manager_contract, committee_id)
+                    .await
+                {
                     Ok(comm_info) => Some(comm_info),
-                    Err(_) => {
-                        error!(committee_id = %id, "fail to fetch new CommitteeInfo");
+                    Err(err) => {
+                        error!(%committee_id, %err, "fail to fetch new `CommitteeInfo`");
                         None
                     }
                 }

timeboost/src/lib.rs

@@ -154,8 +154,8 @@ impl Timeboost {
                 },
                 res = self.events.next() => match res {
                     Some(comm_info) => {
-                        let cur: u64 = self.config.key_store.committee().id().into();
-                        let new_id: u64 = comm_info.id().into();
+                        let cur = self.config.key_store.committee().id();
+                        let new_id = comm_info.id();
 
                         // contract ensures consecutive CommitteeId assignment
                         if new_id == cur + 1 {