chore(signer)!: reformat & clean up

Author: David-Petrov

config.example.toml

@@ -1,4 +1,4 @@
-# The main configuration file for the Commit-Boost sidecar. 
+# The main configuration file for the Commit-Boost sidecar.
 # Some fields are optional and can be omitted, in which case the default value, if present, will be used.
 
 # Chain spec id. Supported values: Mainnet, Holesky, Helder
@@ -18,7 +18,7 @@ port = 18550
 # Whether to forward `status` calls to relays or skip and return 200
 # OPTIONAL, DEFAULT: true
 relay_check = true
-# Timeout in milliseconds for the `get_header` call to relays. Note that the CL has also a timeout (e.g. 1 second) so 
+# Timeout in milliseconds for the `get_header` call to relays. Note that the CL has also a timeout (e.g. 1 second) so
 # this should be lower than that, leaving some margin for overhead
 # OPTIONAL, DEFAULT: 950
 timeout_get_header_ms = 950
@@ -34,10 +34,11 @@ skip_sigverify = false
 # Minimum bid in ETH that will be accepted from `get_header`
 # OPTIONAL, DEFAULT: 0.0
 min_bid_eth = 0.0
+# How late in milliseconds in the slot is "late". This impacts the `get_header` requests, by shortening timeouts for `get_header` calls to
 # List of URLs of relay monitors to send registrations to
 # OPTIONAL
 relay_monitors = []
-# How late in milliseconds in the slot is "late". This impacts the `get_header` requests, by shortening timeouts for `get_header` calls to 
+# How late in milliseconds in the slot is "late". This impacts the `get_header` requests, by shortening timeouts for `get_header` calls to
 # relays and make sure a header is returned within this deadline. If the request from the CL comes later in the slot, then fetching headers is skipped
 # to force local building and miniminzing the risk of missed slots. See also the timing games section below
 # OPTIONAL, DEFAULT: 2000
@@ -55,12 +56,12 @@ url = "http://0xa1cec75a3f0661e99299274182938151e8433c61a19222347ea1313d839229cb
 headers = { X-MyCustomHeader = "MyCustomValue" }
 # Whether to enable timing games, as tuned by `target_first_request_ms` and `frequency_get_header_ms`.
 # These values should be carefully chosen for each relay, as each relay has different latency and timing games setups.
-# They should only be used by advanced users, and if mis-configured can result in unforeseen effects, e.g. fetching a lower header value, 
+# They should only be used by advanced users, and if mis-configured can result in unforeseen effects, e.g. fetching a lower header value,
 # or getting a temporary IP ban.
-# 
+#
 # EXAMPLES
 # Assuming: timeout_get_header_ms = 950, frequency_get_header_ms = 300, target_first_request_ms = 200, late_in_slot_time_ms = 2000
-# 
+#
 # 1) CL request comes at 100ms in the slot (max timeout 1050ms in the slot), then:
 #   - sleep for 100ms
 #   - send request at 200ms with 850ms timeout
@@ -112,13 +113,13 @@ id = "DA_COMMIT"
 type = "commit"
 # Docker image of the module
 docker_image = "test_da_commit"
-# Additional config needed by the business logic of the module should also be set here. 
+# Additional config needed by the business logic of the module should also be set here.
 # See also `examples/da_commit/src/main.rs` for more information
 sleep_secs = 5
 
 # Configuration for how metrics should be collected and scraped
 [metrics]
-# Path to a `prometheus.yml` file to use in Prometheus. If using a custom config file, be sure to add a 
+# Path to a `prometheus.yml` file to use in Prometheus. If using a custom config file, be sure to add a
 # file discovery section as follows:
 # ```yml
 # file_sd_configs:

crates/common/src/signer/mod.rs

@@ -1,6 +1,4 @@
-use std::{
-    fmt::{self, LowerHex},
-};
+use std::fmt::{self, LowerHex};
 
 use alloy::rpc::types::beacon::BlsPublicKey;
 use eyre::Context;
@@ -12,38 +10,11 @@ pub mod schemes;
 #[allow(clippy::module_inception)]
 mod signer;
 
-pub use schemes::{bls::BlsSecretKey, ecdsa::EcdsaSecretKey, ecdsa::EcdsaPublicKey, ecdsa::EcdsaSignature};
-pub use signer::{ConsensusSigner, BlsSigner, EcdsaSigner};
-
-// pub type Pubkey<T> = <T as SecretKey>::PublicKey;
-
-// pub trait SecretKey {
-//     type PublicKey: AsRef<[u8]> + Clone + Verifier<Self>;
-//     type Signature: AsRef<[u8]> + Clone;
-
-//     fn new_random() -> Self;
-//     fn new_from_bytes(bytes: &[u8]) -> eyre::Result<Self>
-//     where
-//         Self: Sized;
-//     fn pubkey(&self) -> Self::PublicKey;
-//     fn sign(&self, msg: &[u8]) -> Self::Signature;
-//     fn sign_msg(&self, msg: &impl TreeHash) -> Self::Signature {
-//         self.sign(&msg.tree_hash_root().0)
-//     }
-// }
-
-// pub trait Verifier<T: SecretKey>
-// where
-//     T: ?Sized,
-// {
-//     type VerificationError: Error;
-
-//     fn verify_signature(
-//         &self,
-//         msg: &[u8],
-//         signature: &T::Signature,
-//     ) -> Result<(), Self::VerificationError>;
-// }
+pub use schemes::{
+    bls::BlsSecretKey,
+    ecdsa::{EcdsaPublicKey, EcdsaSecretKey, EcdsaSignature},
+};
+pub use signer::{BlsSigner, ConsensusSigner, EcdsaSigner};
 
 #[derive(Debug, Clone, Copy, Serialize, Deserialize, Encode, Decode)]
 #[serde(untagged)]

crates/common/src/signer/schemes/bls.rs

@@ -3,7 +3,8 @@ use blst::BLST_ERROR;
 use tree_hash::TreeHash;
 
 use crate::{
-    error::BlstErrorWrapper, signature::sign_builder_root, signer::GenericPubkey, types::Chain, utils::blst_pubkey_to_alloy
+    error::BlstErrorWrapper, signature::sign_builder_root, signer::GenericPubkey, types::Chain,
+    utils::blst_pubkey_to_alloy,
 };
 
 pub type BlsSecretKey = blst::min_pk::SecretKey;
@@ -54,39 +55,11 @@ fn random_secret() -> BlsSecretKey {
     }
 }
 
-// impl SecretKey for BlsSecretKey {
-//     // type PublicKey = BlsPublicKey;
-//     // type Signature = BlsSignature;
-
-//     // fn new_random() -> Self {
-//     //     use rand::RngCore;
-
-//     //     let mut rng = rand::thread_rng();
-//     //     let mut ikm = [0u8; 32];
-//     //     rng.fill_bytes(&mut ikm);
-
-//     //     match BlsSecretKey::key_gen(&ikm, &[]) {
-//     //         Ok(key) => key,
-//     //         // Key material is always valid (32 `u8`s), so `key_gen` can't return Err.
-//     //         Err(_) => unreachable!(),
-//     //     }
-//     // }
-
-//     fn new_from_bytes(bytes: &[u8]) -> eyre::Result<Self> {
-//         Ok(BlsSecretKey::from_bytes(bytes).map_err(BlstErrorWrapper::from)?)
-//     }
-
-//     fn pubkey(&self) -> Self::PublicKey {
-//         blst_pubkey_to_alloy(&self.sk_to_pk())
-//     }
-
-//     fn sign(&self, msg: &[u8]) -> Self::Signature {
-//         let signature = self.sign(msg, BLS_DST_SIG, &[]).to_bytes();
-//         BlsSignature::from_slice(&signature)
-//     }
-// }
-
-pub fn verify_bls_signature(pubkey: &BlsPublicKey, msg: &[u8], signature: &BlsSignature) -> Result<(), BlstErrorWrapper> {
+pub fn verify_bls_signature(
+    pubkey: &BlsPublicKey,
+    msg: &[u8],
+    signature: &BlsSignature,
+) -> Result<(), BlstErrorWrapper> {
     use crate::utils::{alloy_pubkey_to_blst, alloy_sig_to_blst};
 
     let pubkey = alloy_pubkey_to_blst(pubkey)?;
@@ -100,28 +73,6 @@ pub fn verify_bls_signature(pubkey: &BlsPublicKey, msg: &[u8], signature: &BlsSi
     }
 }
 
-// impl Verifier<BlsSecretKey> for Pubkey<BlsSecretKey> {
-//     type VerificationError = BlstErrorWrapper;
-
-//     fn verify_signature(
-//         &self,
-//         msg: &[u8],
-//         signature: &<BlsSecretKey as SecretKey>::Signature,
-//     ) -> Result<(), Self::VerificationError> {
-//         use crate::utils::{alloy_pubkey_to_blst, alloy_sig_to_blst};
-
-//         let pubkey = alloy_pubkey_to_blst(self)?;
-//         let signature = alloy_sig_to_blst(signature)?;
-
-//         let res = signature.verify(true, msg, BLS_DST_SIG, &[], &pubkey, true);
-//         if res == BLST_ERROR::BLST_SUCCESS {
-//             Ok(())
-//         } else {
-//             Err(res.into())
-//         }
-//     }
-// }
-
 impl From<BlsPublicKey> for GenericPubkey {
     fn from(value: BlsPublicKey) -> Self {
         GenericPubkey::Bls(value)

crates/common/src/signer/schemes/ecdsa.rs

@@ -192,9 +192,7 @@ impl EcdsaSigner {
 
     pub async fn sign(&self, chain: Chain, object_root: [u8; 32]) -> EcdsaSignature {
         match self {
-            EcdsaSigner::Local(sk) =>
-            /* sign_builder_root(chain, sk, object_root), */
-            {
+            EcdsaSigner::Local(sk) => {
                 let domain = chain.builder_domain();
                 let signing_root = compute_signing_root(object_root, domain);
                 k256::ecdsa::signature::Signer::<EcdsaSignatureInner>::sign(sk, &signing_root)
@@ -208,6 +206,7 @@ impl EcdsaSigner {
     }
 }
 
+// TODO(David): Add tests for this verification, most probably not properly working yet
 pub fn verify_ecdsa_signature(
     pubkey: &EcdsaPublicKey,
     msg: &[u8],
@@ -219,43 +218,6 @@ pub fn verify_ecdsa_signature(
     ecdsa_pubkey.verify(msg, &ecdsa_sig)
 }
 
-// impl SecretKey for EcdsaSecretKey {
-//     type PublicKey = EcdsaPublicKey;
-
-//     type Signature = EcdsaSignature;
-
-//     fn new_random() -> Self {
-//         EcdsaSecretKey::random(&mut rand::thread_rng())
-//     }
-
-//     fn new_from_bytes(bytes: &[u8]) -> Result<Self> {
-//         Ok(EcdsaSecretKey::from_slice(bytes)?)
-//     }
-
-//     fn pubkey(&self) -> Self::PublicKey {
-//         EcdsaPublicKeyInner::from(self).into()
-//     }
-
-//     fn sign(&self, msg: &[u8]) -> Self::Signature {
-//         k256::ecdsa::signature::Signer::<EcdsaSignatureInner>::sign(self, msg).into()
-//     }
-// }
-
-// impl Verifier<EcdsaSecretKey> for Pubkey<EcdsaSecretKey> {
-//     type VerificationError = k256::ecdsa::Error;
-
-//     fn verify_signature(
-//         &self,
-//         msg: &[u8],
-//         signature: &<EcdsaSecretKey as SecretKey>::Signature,
-//     ) -> Result<(), Self::VerificationError> {
-//         use k256::ecdsa::signature::Verifier;
-//         let ecdsa_pubkey = EcdsaPublicKeyInner::from_sec1_bytes(&self.encoded)?;
-//         let ecdsa_sig = EcdsaSignatureInner::from_bytes(signature)?;
-//         ecdsa_pubkey.verify(msg, &ecdsa_sig)
-//     }
-// }
-
 impl From<EcdsaPublicKey> for GenericPubkey {
     fn from(value: EcdsaPublicKey) -> Self {
         GenericPubkey::Ecdsa(value)

crates/common/src/signer/signer.rs

@@ -1,34 +1,4 @@
+// TODO(David): Remove module
 pub use super::schemes::bls::BlsSigner;
 pub type ConsensusSigner = BlsSigner;
 pub type EcdsaSigner = super::schemes::ecdsa::EcdsaSigner;
-
-// #[derive(Clone)]
-// pub enum Signer<T: SecretKey> {
-//     Local(T),
-// }
-
-// impl<T: SecretKey> Signer<T> {
-//     pub fn new_random() -> Self {
-//         Signer::Local(T::new_random())
-//     }
-
-//     pub fn new_from_bytes(bytes: &[u8]) -> Result<Self> {
-//         T::new_from_bytes(bytes).map(Self::Local)
-//     }
-
-//     pub fn pubkey(&self) -> T::PublicKey {
-//         match self {
-//             Signer::Local(secret) => secret.pubkey(),
-//         }
-//     }
-
-//     pub async fn sign(&self, chain: Chain, object_root: [u8; 32]) -> T::Signature {
-//         match self {
-//             Signer::Local(sk) => sign_builder_root(chain, sk, object_root),
-//         }
-//     }
-
-//     pub async fn sign_msg(&self, chain: Chain, msg: &impl TreeHash) -> T::Signature {
-//         self.sign(chain, msg.tree_hash_root().0).await
-//     }
-// }