feat: return proxy map (#118)

* feat: publish bins

* update get pubkeys return

* update api

* fix

* clippy

* comments

Author: ltitanb

.github/workflows/release.yml

@@ -36,6 +36,13 @@ jobs:
             os: macos-latest
           - target: aarch64-apple-darwin
             os: macos-latest
+        names:
+          - binary: commit-boost
+            publish: commit-boost-cli
+          - binary: default-pbs
+            publish: commit-boost-pbs
+          - binary: signer-module
+            publish: commit-boost-signer
 
     runs-on: ${{ matrix.os }}
     steps:

README.md

@@ -46,9 +46,9 @@ struct Datagram {
 #[tokio::main]
 async fn main() {
     let config = load_commit_module_config::<()>().unwrap();
-    let pubkeys = config.signer_client.get_pubkeys().await.unwrap();
+    let pubkeys = config.signer_client.get_pubkeys().await.unwrap().keys;
 
-    let pubkey = *pubkeys.consensus.first().unwrap();
+    let pubkey = *pubkeys.consensus.first().unwrap().consensus;
 
     let datagram = Datagram { data: 42 };
     let request = SignConsensusRequest::builder(pubkey).with_msg(&datagram);

api/signer-api.yml

@@ -21,21 +21,25 @@ paths:
               schema:
                 type: object
                 properties:
-                  consensus:
-                    description: Consensus validator pubkeys
+                  keys:
+                    description: List of mappings between consensus pubkeys and their proxies
                     type: array
                     items:
-                      $ref: '#/components/schemas/BlsPubkey'
-                  proxy_bls:
-                    description: BLS proxy validator pubkeys
-                    type: array
-                    items:
-                      $ref: '#/components/schemas/BlsPubkey'
-                  proxy_ecdsa:
-                    description: ECDSA proxy validator pubkeys
-                    type: array
-                    items:
-                      $ref: '#/components/schemas/EcdsaPubkey'
+                      type: object
+                      properties:
+                        consensus:
+                          description: Consensus validator pubkey
+                          $ref: "#/components/schemas/BlsPubkey"
+                        proxy_bls:
+                          description: BLS proxy validator pubkeys
+                          type: array
+                          items:
+                            $ref: "#/components/schemas/BlsPubkey"
+                        proxy_ecdsa:
+                          description: ECDSA proxy validator pubkeys
+                          type: array
+                          items:
+                            $ref: "#/components/schemas/EcdsaPubkey"
         "500":
           description: Internal error
           content:
@@ -75,8 +79,8 @@ paths:
                 pubkey:
                   description: Public key of the validator
                   oneOf:
-                    - $ref: '#/components/schemas/BlsPubkey'
-                    - $ref: '#/components/schemas/EcdsaPubkey'
+                    - $ref: "#/components/schemas/BlsPubkey"
+                    - $ref: "#/components/schemas/EcdsaPubkey"
                 object_root:
                   description: The root of the object to be signed
                   type: string
@@ -106,8 +110,8 @@ paths:
             application/json:
               schema:
                 oneOf:
-                  - $ref: '#/components/schemas/BlsSignature'
-                  - $ref: '#/components/schemas/EcdsaSignature'
+                  - $ref: "#/components/schemas/BlsSignature"
+                  - $ref: "#/components/schemas/EcdsaSignature"
               examples:
                 Consensus:
                   value: "0xa3ffa9241f78279f1af04644cb8c79c2d8f02bcf0e28e2f186f6dcccac0a869c2be441fda50f0dea895cfce2e53f0989a3ffa9241f78279f1af04644cb8c79c2d8f02bcf0e28e2f186f6dcccac0a869c2be441fda50f0dea895cfce2e53f0989"
@@ -166,7 +170,7 @@ paths:
                 pubkey:
                   description: a validator BLS public key for which to generate a proxy key
                   allOf:
-                    - $ref: '#/components/schemas/BlsPubkey'
+                    - $ref: "#/components/schemas/BlsPubkey"
                 scheme:
                   description: signature scheme to generate proxy keypair for
                   type: string
@@ -194,16 +198,16 @@ paths:
                       delegator:
                         description: the validator BLS public key for which the proxy key was generated (the same one as requested)
                         allOf:
-                          - $ref: '#/components/schemas/BlsPubkey'
+                          - $ref: "#/components/schemas/BlsPubkey"
                       proxy:
                         description: the generated proxy public key
                         oneOf:
-                          - $ref: '#/components/schemas/BlsPubkey'
-                          - $ref: '#/components/schemas/EcdsaPubkey'
+                          - $ref: "#/components/schemas/BlsPubkey"
+                          - $ref: "#/components/schemas/EcdsaPubkey"
                   signature:
                     description: The signature of the proxy delegation
                     allOf:
-                      - $ref: '#/components/schemas/BlsSignature'
+                      - $ref: "#/components/schemas/BlsSignature"
               examples:
                 Bls:
                   value:

crates/common/src/commit/request.rs

@@ -153,7 +153,19 @@ impl GenerateProxyRequest {
 
 #[derive(Debug, Clone, Deserialize, Serialize)]
 pub struct GetPubkeysResponse {
-    pub consensus: Vec<BlsPublicKey>,
+    pub keys: Vec<ConsensusProxyMap>,
+}
+
+/// Map of consensus pubkeys to proxies
+#[derive(Debug, Clone, Deserialize, Serialize)]
+pub struct ConsensusProxyMap {
+    pub consensus: BlsPublicKey,
     pub proxy_bls: Vec<BlsPublicKey>,
     pub proxy_ecdsa: Vec<EcdsaPublicKey>,
 }
+
+impl ConsensusProxyMap {
+    pub fn new(consensus: BlsPublicKey) -> Self {
+        Self { consensus, proxy_bls: vec![], proxy_ecdsa: vec![] }
+    }
+}

crates/signer/src/error.rs

@@ -15,6 +15,9 @@ pub enum SignerModuleError {
 
     #[error("unknown proxy signer: 0x{}", hex::encode(.0))]
     UnknownProxySigner(Vec<u8>),
+
+    #[error("internal error {0}")]
+    Internal(String),
 }
 
 impl IntoResponse for SignerModuleError {
@@ -23,6 +26,7 @@ impl IntoResponse for SignerModuleError {
             SignerModuleError::Unauthorized => StatusCode::UNAUTHORIZED,
             SignerModuleError::UnknownConsensusSigner(_) => StatusCode::NOT_FOUND,
             SignerModuleError::UnknownProxySigner(_) => StatusCode::NOT_FOUND,
+            SignerModuleError::Internal(_) => StatusCode::INTERNAL_SERVER_ERROR,
         };
 
         (status, self.to_string()).into_response()

crates/signer/src/manager.rs

@@ -3,7 +3,7 @@ use std::collections::HashMap;
 use alloy::rpc::types::beacon::BlsSignature;
 use cb_common::{
     commit::request::{
-        ProxyDelegationBls, ProxyDelegationEcdsa, SignedProxyDelegationBls,
+        ConsensusProxyMap, ProxyDelegationBls, ProxyDelegationEcdsa, SignedProxyDelegationBls,
         SignedProxyDelegationEcdsa,
     },
     signer::{
@@ -16,6 +16,7 @@ use cb_common::{
     types::{Chain, ModuleId},
 };
 use derive_more::derive::Deref;
+use eyre::OptionExt;
 use tree_hash::TreeHash;
 
 use crate::error::SignerModuleError;
@@ -209,6 +210,39 @@ impl SigningManager {
             .map(|x| x.delegation)
             .ok_or(SignerModuleError::UnknownProxySigner(pubkey.as_ref().to_vec()))
     }
+
+    pub fn get_consensus_proxy_maps(
+        &self,
+        module_id: &ModuleId,
+    ) -> eyre::Result<Vec<ConsensusProxyMap>> {
+        let consensus = self.consensus_pubkeys();
+        let proxy_bls = self.proxy_pubkeys_bls.get(module_id).cloned().unwrap_or_default();
+        let proxy_ecdsa = self.proxy_pubkeys_ecdsa.get(module_id).cloned().unwrap_or_default();
+
+        let mut keys: Vec<_> = consensus.into_iter().map(ConsensusProxyMap::new).collect();
+
+        for bls in proxy_bls {
+            let delegator = self.get_delegation_bls(&bls)?.message.delegator;
+            let entry = keys
+                .iter_mut()
+                .find(|x| x.consensus == delegator)
+                .ok_or_eyre("missing consensus")?;
+
+            entry.proxy_bls.push(bls);
+        }
+
+        for ecdsa in proxy_ecdsa {
+            let delegator = self.get_delegation_ecdsa(&ecdsa)?.message.delegator;
+            let entry = keys
+                .iter_mut()
+                .find(|x| x.consensus == delegator)
+                .ok_or_eyre("missing consensus")?;
+
+            entry.proxy_ecdsa.push(ecdsa);
+        }
+
+        Ok(keys)
+    }
 }
 
 #[cfg(test)]

crates/signer/src/service.rs

@@ -108,14 +108,11 @@ async fn handle_get_pubkeys(
     debug!(event = "get_pubkeys", ?req_id, "New request");
 
     let signing_manager = state.manager.read().await;
+    let map = signing_manager
+        .get_consensus_proxy_maps(&module_id)
+        .map_err(|err| SignerModuleError::Internal(err.to_string()))?;
 
-    let consensus = signing_manager.consensus_pubkeys();
-    let proxy_bls =
-        signing_manager.proxy_pubkeys_bls().get(&module_id).cloned().unwrap_or_default();
-    let proxy_ecdsa =
-        signing_manager.proxy_pubkeys_ecdsa().get(&module_id).cloned().unwrap_or_default();
-
-    let res = GetPubkeysResponse { consensus, proxy_bls, proxy_ecdsa };
+    let res = GetPubkeysResponse { keys: map };
 
     Ok((StatusCode::OK, Json(res)).into_response())
 }

docs/docs/developing/commit-module.md

@@ -61,7 +61,7 @@ Furthermore, in order to request a signature, we'd need a public key of the vali
 let pubkeys = config.signer_client.get_pubkeys().await.unwrap();
 ```
 
-Which will essentially call the `get_pubkeys` endpoint of the [SignerAPI](/api).
+Which will call the `get_pubkeys` endpoint of the [SignerAPI](/api), returning all the consensus pubkeys and the corresponding proxy keys, of your module.
 
 Then, we can request a signature either with a consensus key or with a proxy key:
 

examples/da_commit/Cargo.toml

@@ -15,6 +15,7 @@ tokio.workspace = true
 
 # serialization
 serde.workspace = true
+serde_json.workspace = true
 
 # telemetry
 tracing.workspace = true

examples/da_commit/src/main.rs

@@ -39,15 +39,10 @@ impl DaCommitService {
     pub async fn run(self) -> Result<()> {
         // the config has the signer_client already setup, we can use it to interact
         // with the Signer API
-        let pubkeys = self.config.signer_client.get_pubkeys().await?;
-        info!(
-            consensus = pubkeys.consensus.len(),
-            proxy_bls = pubkeys.proxy_bls.len(),
-            proxy_ecdsa = pubkeys.proxy_ecdsa.len(),
-            "Received pubkeys"
-        );
-
-        let pubkey = *pubkeys.consensus.first().ok_or_eyre("no key available")?;
+        let pubkeys = self.config.signer_client.get_pubkeys().await?.keys;
+        info!(pubkeys = %serde_json::to_string_pretty(&pubkeys).unwrap(), "Received pubkeys");
+
+        let pubkey = pubkeys.first().ok_or_eyre("no key available")?.consensus;
         info!("Registered validator {pubkey}");
 
         let proxy_delegation_bls = self.config.signer_client.generate_proxy_key_bls(pubkey).await?;