avoid panic, remove unnecessary contract func and Deserialize

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

Author: alxiong

contracts/src/KeyManager.sol

@@ -196,21 +196,6 @@ contract KeyManager is Initializable, OwnableUpgradeable, UUPSUpgradeable {
         return nextCommitteeId - 1;
     }
 
-    /**
-     * @notice This function is used to get the committee members.
-     * @dev We need this because alloy binding for `.committees(id)` getter doesn't include dynamic array pointer
-     * @dev Reverts if the id is greater than the length of the committees mapping.
-     * @dev Reverts if the id is less than the head committee id.
-     * @param id The id of the committee.
-     * @return members The committee members.
-     */
-    function getMembersById(uint64 id) external view virtual returns (CommitteeMember[] memory members) {
-        if (id < _oldestStoredCommitteeId || committees[id].id != id) {
-            revert CommitteeIdDoesNotExist(id);
-        }
-        return committees[id].members;
-    }
-
     /**
      * @notice This function is used to get the committee by id.
      * @dev Reverts if the id is greater than the length of the committees mapping.

timeboost-contract/src/binaries/deploy.rs

@@ -15,7 +15,7 @@
 use alloy::{primitives::Address, providers::WalletProvider};
 use anyhow::{Context, Result};
 use clap::Parser;
-use serde::{Deserialize, Serialize};
+use serde::Serialize;
 use std::{fs, path::PathBuf};
 use timeboost_contract::provider::build_provider;
 use timeboost_utils::types::logging;
@@ -39,20 +39,19 @@ struct Args {
 
 /// Config type for the key manager who has the permission to update the KeyManager contract
 /// See `test-configs/keymanager.toml` for an example
-#[derive(Debug, Deserialize, Serialize)]
+#[derive(Debug, Serialize)]
 struct KeyManagerConfig {
     wallet: LocalWalletConfig,
     deployments: Deployments,
 }
 
-#[derive(Debug, Deserialize, Serialize)]
+#[derive(Debug, Serialize)]
 struct LocalWalletConfig {
     mnemonic: String,
     account_index: u32,
 }
 
-#[derive(Debug, Deserialize, Serialize)]
-#[allow(dead_code)]
+#[derive(Debug, Serialize)]
 struct Deployments {
     /// RPC endpoint of the target chain
     chain_url: Url,
@@ -85,7 +84,7 @@ async fn main() -> Result<()> {
         cfg.wallet.mnemonic.clone(),
         cfg.wallet.account_index,
         cfg.deployments.chain_url.clone(),
-    );
+    )?;
 
     let manager = provider.default_signer_address();
     info!("Deploying with manager address: {manager:#x}");
@@ -104,7 +103,6 @@ async fn main() -> Result<()> {
         fs::write(out, &toml)?;
         info!(file=?out, "Config written to file");
     } else {
-        println!("===== OUTPUT ======");
         println!("{toml}");
     }
 

timeboost-contract/src/deployer.rs

@@ -48,7 +48,7 @@ mod tests {
     use alloy::{providers::WalletProvider, sol_types::SolValue};
     use rand::prelude::*;
 
-    use crate::{CommitteeMemberSol, KeyManager};
+    use crate::{CommitteeMemberSol, CommitteeSol, KeyManager};
 
     #[tokio::test]
     async fn test_key_manager_deployment() {
@@ -76,24 +76,19 @@ mod tests {
             .unwrap();
 
         // make sure next committee is correctly registered
-        assert_eq!(contract.nextCommitteeId().call().await.unwrap(), 1);
         assert_eq!(
             contract
-                .committees(0)
-                .call()
-                .await
-                .unwrap()
-                .effectiveTimestamp,
-            timestamp
-        );
-        assert_eq!(
-            contract
-                .getMembersById(0)
+                .getCommitteeById(0)
                 .call()
                 .await
                 .unwrap()
                 .abi_encode_sequence(),
-            members.abi_encode_sequence()
+            CommitteeSol {
+                id: 0,
+                effectiveTimestamp: timestamp,
+                members,
+            }
+            .abi_encode_sequence()
         );
     }
 }

timeboost-contract/src/provider.rs

@@ -9,7 +9,7 @@ use alloy::{
         layers::AnvilProvider,
         utils::JoinedRecommendedFillers,
     },
-    signers::local::{MnemonicBuilder, PrivateKeySigner, coins_bip39::English},
+    signers::local::{LocalSignerError, MnemonicBuilder, PrivateKeySigner, coins_bip39::English},
     transports::http::reqwest::Url,
 };
 
@@ -30,19 +30,24 @@ pub type TestProviderWithWallet = FillProvider<
 >;
 
 /// Build a local signer from wallet mnemonic and account index
-pub fn build_signer(mnemonic: String, account_index: u32) -> PrivateKeySigner {
+pub fn build_signer(
+    mnemonic: String,
+    account_index: u32,
+) -> Result<PrivateKeySigner, LocalSignerError> {
     MnemonicBuilder::<English>::default()
         .phrase(mnemonic)
-        .index(account_index)
-        .expect("wrong mnemonic or index")
+        .index(account_index)?
         .build()
-        .expect("fail to build signer")
 }
 
 /// a handy thin wrapper around wallet builder and provider builder that directly
 /// returns an instantiated `Provider` with default fillers with wallet, ready to send tx
-pub fn build_provider(mnemonic: String, account_index: u32, url: Url) -> HttpProviderWithWallet {
-    let signer = build_signer(mnemonic, account_index);
+pub fn build_provider(
+    mnemonic: String,
+    account_index: u32,
+    url: Url,
+) -> Result<HttpProviderWithWallet, LocalSignerError> {
+    let signer = build_signer(mnemonic, account_index)?;
     let wallet = EthereumWallet::from(signer);
-    ProviderBuilder::new().wallet(wallet).connect_http(url)
+    Ok(ProviderBuilder::new().wallet(wallet).connect_http(url))
 }