Merge pull request #1229 from input-output-hk/damien/798/implement-anyhow-for-common-protocol

Implement anyhow context for common/protocol

Author: dlachaume

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-aggregator"
-version = "0.3.88"
+version = "0.3.89"
 description = "A Mithril Aggregator server"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-aggregator/Cargo.toml

@@ -1,3 +1,4 @@
+use anyhow::Context;
 use async_trait::async_trait;
 use slog_scope::{debug, warn};
 use std::sync::Arc;
@@ -457,6 +458,7 @@ impl MultiSigner for MultiSignerImpl {
 
         protocol_multi_signer
             .verify_single_signature(message, single_signature)
+            .with_context(|| "Multi Signer can not verify multi-signature")
             .map_err(|error| ProtocolError::Core(error.to_string()))
     }
 

mithril-aggregator/src/multi_signer.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-common"
-version = "0.2.111"
+version = "0.2.112"
 authors = { workspace = true }
 edition = { workspace = true }
 documentation = { workspace = true }

mithril-common/Cargo.toml

@@ -1,4 +1,4 @@
-use anyhow::{anyhow, Context, Result};
+use anyhow::{anyhow, Context};
 use mithril_stm::stm::StmParameters;
 
 use crate::{
@@ -7,6 +7,7 @@ use crate::{
         ProtocolMultiSignature,
     },
     entities::{ProtocolMessage, SingleSignatures},
+    StdResult,
 };
 
 /// MultiSigner is the cryptographic engine in charge of producing multi-signatures from individual signatures
@@ -52,7 +53,7 @@ impl MultiSigner {
         &self,
         message: &ProtocolMessage,
         single_signature: &SingleSignatures,
-    ) -> Result<()> {
+    ) -> StdResult<()> {
         let protocol_signature = single_signature.to_protocol_signature();
 
         let avk = self.compute_aggregate_verification_key();

mithril-common/src/protocol/multi_signer.rs

@@ -1,4 +1,4 @@
-use anyhow::{Context, Result};
+use anyhow::Context;
 use rand_chacha::ChaCha20Rng;
 use rand_core::{CryptoRng, RngCore, SeedableRng};
 use std::path::Path;
@@ -11,6 +11,7 @@ use crate::{
     },
     entities::{PartyId, ProtocolParameters, SignerWithStake},
     protocol::MultiSigner,
+    StdResult,
 };
 
 use super::SingleSigner;
@@ -35,7 +36,7 @@ impl SignerBuilder {
     pub fn new(
         registered_signers: &[SignerWithStake],
         protocol_parameters: &ProtocolParameters,
-    ) -> Result<Self> {
+    ) -> StdResult<Self> {
         if registered_signers.is_empty() {
             return Err(SignerBuilderError::EmptySigners.into());
         }
@@ -91,7 +92,7 @@ impl SignerBuilder {
         signer_with_stake: SignerWithStake,
         kes_secret_key_path: Option<&Path>,
         rng: &mut R,
-    ) -> Result<(SingleSigner, ProtocolInitializer)> {
+    ) -> StdResult<(SingleSigner, ProtocolInitializer)> {
         let protocol_initializer = ProtocolInitializer::setup(
             self.protocol_parameters.clone().into(),
             kes_secret_key_path,
@@ -127,7 +128,7 @@ impl SignerBuilder {
         &self,
         signer_with_stake: SignerWithStake,
         kes_secret_key_path: Option<&Path>,
-    ) -> Result<(SingleSigner, ProtocolInitializer)> {
+    ) -> StdResult<(SingleSigner, ProtocolInitializer)> {
         self.build_single_signer_with_rng(
             signer_with_stake,
             kes_secret_key_path,
@@ -142,7 +143,7 @@ impl SignerBuilder {
         &self,
         signer_with_stake: SignerWithStake,
         kes_secret_key_path: Option<&Path>,
-    ) -> Result<(SingleSigner, ProtocolInitializer)> {
+    ) -> StdResult<(SingleSigner, ProtocolInitializer)> {
         let protocol_initializer_seed: [u8; 32] = signer_with_stake.party_id.as_bytes()[..32]
             .try_into()
             .unwrap();
@@ -169,7 +170,7 @@ impl SignerBuilder {
         &self,
         party_id: PartyId,
         protocol_initializer: ProtocolInitializer,
-    ) -> Result<SingleSigner> {
+    ) -> StdResult<SingleSigner> {
         let single_signer = protocol_initializer
             .new_signer(self.closed_key_registration.clone())
             .with_context(|| {

mithril-common/src/protocol/signer_builder.rs

@@ -1,8 +1,7 @@
-use anyhow::Result;
-
 use crate::{
     crypto_helper::ProtocolSigner,
     entities::{PartyId, ProtocolMessage, SingleSignatures},
+    StdResult,
 };
 
 /// The SingleSigner is the structure responsible for issuing SingleSignatures.
@@ -23,7 +22,7 @@ impl SingleSigner {
     /// Issue a single signature for the given message.
     ///
     /// If no lottery are won None will be returned.
-    pub fn sign(&self, message: &ProtocolMessage) -> Result<Option<SingleSignatures>> {
+    pub fn sign(&self, message: &ProtocolMessage) -> StdResult<Option<SingleSignatures>> {
         match self.protocol_signer.sign(message.compute_hash().as_bytes()) {
             Some(signature) => {
                 let won_indexes = signature.indexes.clone();

mithril-common/src/protocol/single_signer.rs

@@ -1,6 +1,6 @@
 [package]
 name = "mithril-signer"
-version = "0.2.77"
+version = "0.2.78"
 description = "A Mithril Signer"
 authors = { workspace = true }
 edition = { workspace = true }

mithril-signer/Cargo.toml

@@ -1,3 +1,4 @@
+use anyhow::Context;
 use hex::ToHex;
 use slog_scope::{info, trace, warn};
 use std::path::PathBuf;
@@ -102,8 +103,20 @@ impl SingleSigner for MithrilSingleSigner {
         info!("Signing protocol message"; "protocol_message" =>  #?protocol_message, "signed message" => protocol_message.compute_hash().encode_hex::<String>());
         let signatures = builder
             .restore_signer_from_initializer(self.party_id.clone(), protocol_initializer.clone())
+            .with_context(|| {
+                format!(
+                    "Mithril Single Signer can not restore signer with party_id: '{}'",
+                    self.party_id.clone()
+                )
+            })
             .map_err(|e| SingleSignerError::ProtocolSignerCreationFailure(e.to_string()))?
             .sign(protocol_message)
+            .with_context(|| {
+                format!(
+                    "Mithril Single Signer can not sign protocol_message: '{:?}'",
+                    protocol_message
+                )
+            })
             .map_err(SingleSignerError::SignatureFailed)?;
 
         match &signatures {