refactor: make signer optional, remove more unwraps

hyperlane-xyz · Nov 7, 2023 · 00f3b0c · 00f3b0c
1 parent ad875bf
commit 00f3b0c
Show file tree

Hide file tree

Showing 10 changed files with 57 additions and 61 deletions.
diff --git a/rust/chains/hyperlane-cosmos/src/aggregation_ism.rs b/rust/chains/hyperlane-cosmos/src/aggregation_ism.rs
@@ -23,8 +23,8 @@ pub struct CosmosAggregationIsm {
 
 impl CosmosAggregationIsm {
     /// create new Cosmos AggregationIsm agent
-    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
-        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
+    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
+        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer);
 
         Self {
             domain: locator.domain.clone(),

diff --git a/rust/chains/hyperlane-cosmos/src/interchain_gas.rs b/rust/chains/hyperlane-cosmos/src/interchain_gas.rs
@@ -44,8 +44,8 @@ impl InterchainGasPaymaster for CosmosInterchainGasPaymaster {}
 
 impl CosmosInterchainGasPaymaster {
     /// create new Cosmos InterchainGasPaymaster agent
-    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
-        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
+    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
+        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer);
 
         Self {
             domain: locator.domain.clone(),

diff --git a/rust/chains/hyperlane-cosmos/src/interchain_security_module.rs b/rust/chains/hyperlane-cosmos/src/interchain_security_module.rs
@@ -28,9 +28,9 @@ pub struct CosmosInterchainSecurityModule {
 /// The Cosmos Interchain Security Module Implementation.
 impl CosmosInterchainSecurityModule {
     /// Creates a new Cosmos Interchain Security Module.
-    pub fn new(conf: &ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
+    pub fn new(conf: &ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
         let provider: WasmGrpcProvider =
-            WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
+            WasmGrpcProvider::new(conf.clone(), locator.clone(), signer);
 
         Self {
             domain: locator.domain.clone(),

diff --git a/rust/chains/hyperlane-cosmos/src/mailbox.rs b/rust/chains/hyperlane-cosmos/src/mailbox.rs
@@ -35,25 +35,30 @@ use tracing::{instrument, warn};
 
 /// A reference to a Mailbox contract on some Cosmos chain
 pub struct CosmosMailbox {
+    config: ConnectionConf,
     domain: HyperlaneDomain,
     address: H256,
-    signer: Signer,
     provider: Box<WasmGrpcProvider>,
 }
 
 impl CosmosMailbox {
     /// Create a reference to a mailbox at a specific Ethereum address on some
     /// chain
-    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
-        let provider = WasmGrpcProvider::new(conf, locator.clone(), signer.clone());
+    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
+        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
 
         Self {
+            config: conf,
             domain: locator.domain.clone(),
             address: locator.address,
-            signer,
             provider: Box::new(provider),
         }
     }
+
+    /// Prefix used in the bech32 address encoding
+    pub fn prefix(&self) -> String {
+        self.config.get_prefix()
+    }
 }
 
 impl HyperlaneContract for CosmosMailbox {
@@ -136,7 +141,7 @@ impl Mailbox for CosmosMailbox {
 
     #[instrument(err, ret, skip(self))]
     async fn recipient_ism(&self, recipient: H256) -> ChainResult<H256> {
-        let address = CosmosAddress::from_h256(recipient, &self.signer.prefix)?.address();
+        let address = CosmosAddress::from_h256(recipient, &self.prefix())?.address();
 
         let payload = mailbox::RecipientIsmRequest {
             recipient_ism: mailbox::RecipientIsmRequestInner {
@@ -256,7 +261,7 @@ impl CosmosMailboxIndexer {
     pub fn new(
         conf: ConnectionConf,
         locator: ContractLocator,
-        signer: Signer,
+        signer: Option<Signer>,
         reorg_period: u32,
     ) -> ChainResult<Self> {
         let mailbox = CosmosMailbox::new(conf.clone(), locator.clone(), signer.clone());

diff --git a/rust/chains/hyperlane-cosmos/src/merkle_tree_hook.rs b/rust/chains/hyperlane-cosmos/src/merkle_tree_hook.rs
@@ -38,8 +38,8 @@ pub struct CosmosMerkleTreeHook {
 
 impl CosmosMerkleTreeHook {
     /// create new Cosmos MerkleTreeHook agent
-    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
-        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
+    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
+        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer);
 
         Self {
             domain: locator.domain.clone(),
@@ -189,7 +189,7 @@ impl CosmosMerkleTreeHookIndexer {
     pub fn new(
         conf: ConnectionConf,
         locator: ContractLocator,
-        signer: Signer,
+        signer: Option<Signer>,
         reorg_period: u32,
     ) -> ChainResult<Self> {
         let indexer = CosmosWasmIndexer::new(

diff --git a/rust/chains/hyperlane-cosmos/src/multisig_ism.rs b/rust/chains/hyperlane-cosmos/src/multisig_ism.rs
@@ -17,23 +17,19 @@ use crate::payloads::multisig_ism::{self, VerifyInfoRequest, VerifyInfoRequestIn
 /// A reference to a MultisigIsm contract on some Cosmos chain
 #[derive(Debug)]
 pub struct CosmosMultisigIsm {
-    _conf: ConnectionConf,
     domain: HyperlaneDomain,
     address: H256,
-    _signer: Signer,
     provider: Box<WasmGrpcProvider>,
 }
 
 impl CosmosMultisigIsm {
     /// create a new instance of CosmosMultisigIsm
-    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
-        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
+    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
+        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer);
 
         Self {
-            _conf: conf,
             domain: locator.domain.clone(),
             address: locator.address,
-            _signer: signer,
             provider: Box::new(provider),
         }
     }

diff --git a/rust/chains/hyperlane-cosmos/src/providers/grpc.rs b/rust/chains/hyperlane-cosmos/src/providers/grpc.rs
@@ -19,9 +19,7 @@ use cosmrs::proto::traits::Message;
 
 use cosmrs::tx::{self, Fee, MessageExt, SignDoc, SignerInfo};
 use cosmrs::{Amount, Coin};
-use hyperlane_core::{
-    ChainCommunicationError, ChainResult, ContractLocator, HyperlaneDomain, H256, U256,
-};
+use hyperlane_core::{ChainCommunicationError, ChainResult, ContractLocator, H256, U256};
 use serde::Serialize;
 
 use crate::address::CosmosAddress;
@@ -86,17 +84,15 @@ pub trait WasmProvider: Send + Sync {
 /// Cosmwasm GRPC Provider
 pub struct WasmGrpcProvider {
     conf: ConnectionConf,
-    _domain: HyperlaneDomain,
     address: H256,
-    signer: Signer,
+    signer: Option<Signer>,
 }
 
 impl WasmGrpcProvider {
     /// create new Cosmwasm GRPC Provider
-    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
+    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
         Self {
             conf,
-            _domain: locator.domain.clone(),
             address: locator.address,
             signer,
         }
@@ -110,6 +106,12 @@ impl WasmGrpcProvider {
         let cosmos_address = CosmosAddress::from_h256(self.address, &self.conf.get_prefix())?;
         Ok(cosmos_address.address())
     }
+
+    fn get_signer(&self) -> ChainResult<Signer> {
+        self.signer
+            .clone()
+            .ok_or(ChainCommunicationError::SignerUnavailable)
+    }
 }
 
 #[async_trait]
@@ -219,14 +221,14 @@ impl WasmProvider for WasmGrpcProvider {
     where
         I: IntoIterator<Item = cosmrs::Any> + Send + Sync,
     {
-        let account_info = self.account_query(self.signer.address.clone()).await?;
+        let signer = self.get_signer()?;
+        let account_info = self.account_query(signer.address.clone()).await?;
 
-        let private_key = self.signer.signing_key()?;
+        let private_key = signer.signing_key()?;
         let public_key = private_key.public_key();
 
         let tx_body = tx::Body::new(msgs, "", 9000000u32);
-        let signer_info =
-            SignerInfo::single_direct(Some(self.signer.public_key), account_info.sequence);
+        let signer_info = SignerInfo::single_direct(Some(signer.public_key), account_info.sequence);
 
         let gas_limit: u64 = gas_limit.unwrap_or(U256::from(300000u64)).as_u64();
 
@@ -255,10 +257,11 @@ impl WasmProvider for WasmGrpcProvider {
     where
         T: Serialize + Send + Sync,
     {
+        let signer = self.get_signer()?;
         let mut client = TxServiceClient::connect(self.get_conn_url()?).await?;
 
         let msgs = vec![MsgExecuteContract {
-            sender: self.signer.address.clone(),
+            sender: signer.address,
             contract: self.get_contract_addr()?,
             msg: serde_json::to_string(&payload)?.as_bytes().to_vec(),
             funds: vec![],
@@ -289,8 +292,9 @@ impl WasmProvider for WasmGrpcProvider {
     where
         T: Serialize + Send + Sync,
     {
+        let signer = self.get_signer()?;
         let msg = MsgExecuteContract {
-            sender: self.signer.address.clone(),
+            sender: signer.address,
             contract: self.get_contract_addr()?,
             msg: serde_json::to_string(&payload)?.as_bytes().to_vec(),
             funds: vec![],

diff --git a/rust/chains/hyperlane-cosmos/src/routing_ism.rs b/rust/chains/hyperlane-cosmos/src/routing_ism.rs
@@ -27,8 +27,8 @@ pub struct CosmosRoutingIsm {
 
 impl CosmosRoutingIsm {
     /// create a new instance of CosmosRoutingIsm
-    pub fn new(conf: &ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
-        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
+    pub fn new(conf: &ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
+        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer);
 
         Self {
             domain: locator.domain.clone(),

diff --git a/rust/chains/hyperlane-cosmos/src/validator_announce.rs b/rust/chains/hyperlane-cosmos/src/validator_announce.rs
@@ -20,23 +20,19 @@ use crate::{
 /// A reference to a ValidatorAnnounce contract on some Cosmos chain
 #[derive(Debug)]
 pub struct CosmosValidatorAnnounce {
-    _conf: ConnectionConf,
     domain: HyperlaneDomain,
     address: H256,
-    _signer: Signer,
     provider: Box<WasmGrpcProvider>,
 }
 
 impl CosmosValidatorAnnounce {
     /// create a new instance of CosmosValidatorAnnounce
-    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Signer) -> Self {
-        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer.clone());
+    pub fn new(conf: ConnectionConf, locator: ContractLocator, signer: Option<Signer>) -> Self {
+        let provider = WasmGrpcProvider::new(conf.clone(), locator.clone(), signer);
 
         Self {
-            _conf: conf,
             domain: locator.domain.clone(),
             address: locator.address,
-            _signer: signer,
             provider: Box::new(provider),
         }
     }

diff --git a/rust/hyperlane-base/src/settings/chains.rs b/rust/hyperlane-base/src/settings/chains.rs
@@ -149,7 +149,7 @@ impl ChainConf {
                 Ok(Box::new(h_cosmos::CosmosMailbox::new(
                     conf.clone(),
                     locator.clone(),
-                    signer.clone().expect("Cosmos signer not configured"),
+                    signer.clone(),
                 )) as Box<dyn Mailbox>)
             }
         }
@@ -184,12 +184,9 @@ impl ChainConf {
                     .map_err(Into::into)
             }
             ChainConnectionConf::Cosmos(conf) => {
-                let signer = self.cosmos_signer().await.context(ctx)?.unwrap();
-                let hook = h_cosmos::CosmosMerkleTreeHook::new(
-                    conf.clone(),
-                    locator.clone(),
-                    signer.clone(),
-                );
+                let signer = self.cosmos_signer().await.context(ctx)?;
+                let hook =
+                    h_cosmos::CosmosMerkleTreeHook::new(conf.clone(), locator.clone(), signer);
 
                 Ok(Box::new(hook) as Box<dyn MerkleTreeHook>)
             }
@@ -223,11 +220,11 @@ impl ChainConf {
                 Ok(indexer as Box<dyn SequenceIndexer<HyperlaneMessage>>)
             }
             ChainConnectionConf::Cosmos(conf) => {
-                let signer = self.cosmos_signer().await.context(ctx)?.unwrap();
+                let signer = self.cosmos_signer().await.context(ctx)?;
                 let indexer = Box::new(h_cosmos::CosmosMailboxIndexer::new(
                     conf.clone(),
                     locator,
-                    signer.clone(),
+                    signer,
                     self.reorg_period,
                 )?);
                 Ok(indexer as Box<dyn SequenceIndexer<HyperlaneMessage>>)
@@ -262,7 +259,7 @@ impl ChainConf {
                 Ok(indexer as Box<dyn SequenceIndexer<H256>>)
             }
             ChainConnectionConf::Cosmos(conf) => {
-                let signer = self.cosmos_signer().await.context(ctx)?.unwrap();
+                let signer = self.cosmos_signer().await.context(ctx)?;
                 let indexer = Box::new(h_cosmos::CosmosMailboxIndexer::new(
                     conf.clone(),
                     locator,
@@ -306,7 +303,7 @@ impl ChainConf {
                 let paymaster = Box::new(h_cosmos::CosmosInterchainGasPaymaster::new(
                     conf.clone(),
                     locator.clone(),
-                    signer.unwrap().clone(),
+                    signer,
                 ));
                 Ok(paymaster as Box<dyn InterchainGasPaymaster>)
             }
@@ -389,7 +386,7 @@ impl ChainConf {
                     conf.clone(),
                     locator,
                     // TODO: remove signer requirement entirely
-                    signer.unwrap().clone(),
+                    signer,
                     self.reorg_period,
                 )?);
                 Ok(indexer as Box<dyn SequenceIndexer<MerkleTreeInsertion>>)
@@ -420,7 +417,7 @@ impl ChainConf {
                 let va = Box::new(h_cosmos::CosmosValidatorAnnounce::new(
                     conf.clone(),
                     locator.clone(),
-                    signer.unwrap().clone(),
+                    signer,
                 ));
 
                 Ok(va as Box<dyn ValidatorAnnounce>)
@@ -460,9 +457,7 @@ impl ChainConf {
             ChainConnectionConf::Cosmos(conf) => {
                 let signer = self.cosmos_signer().await.context(ctx)?;
                 let ism = Box::new(h_cosmos::CosmosInterchainSecurityModule::new(
-                    conf,
-                    locator,
-                    signer.unwrap(),
+                    conf, locator, signer,
                 ));
                 Ok(ism as Box<dyn InterchainSecurityModule>)
             }
@@ -496,7 +491,7 @@ impl ChainConf {
                 let ism = Box::new(h_cosmos::CosmosMultisigIsm::new(
                     conf.clone(),
                     locator.clone(),
-                    signer.unwrap().clone(),
+                    signer,
                 ));
                 Ok(ism as Box<dyn MultisigIsm>)
             }
@@ -530,7 +525,7 @@ impl ChainConf {
                 let ism = Box::new(h_cosmos::CosmosRoutingIsm::new(
                     &conf.clone(),
                     locator.clone(),
-                    signer.unwrap().clone(),
+                    signer,
                 ));
                 Ok(ism as Box<dyn RoutingIsm>)
             }
@@ -564,7 +559,7 @@ impl ChainConf {
                 let ism = Box::new(h_cosmos::CosmosAggregationIsm::new(
                     conf.clone(),
                     locator.clone(),
-                    signer.unwrap().clone(),
+                    signer,
                 ));
 
                 Ok(ism as Box<dyn AggregationIsm>)