integrate key commands into CLI

Author: rphmeier

sugondat-shim/src/cli.rs

@@ -37,9 +37,32 @@ pub struct Cli {
     pub command: Commands,
 }
 
+/// Common parameters for key management subcommand.
+#[derive(clap::Args, Debug)]
+#[group(required = true, multiple = false)]
+pub struct KeyManagementParams {
+    /// Use the Alice development key to sign blob transactions.
+    ///
+    /// Cannot be used in conjunction with the `--submit-private-key` flag.
+    #[arg(long)]
+    pub submit_dev_alice: bool,
+
+    /// Use the keyfile at the provided path to sign blob transactions.
+    ///
+    /// The keyfile should be 32 bytes of unencrypted, hex-encoded sr25519
+    /// seed material.
+    ///
+    /// Cannot be used in conjunction with the `--submit-dev-alice` flag.
+    #[arg(long, value_name = "PATH")]
+    pub submit_private_key: Option<std::path::PathBuf>,
+}
+
 /// Common parameters for the adapter subcommands.
 #[derive(clap::Args, Debug)]
 pub struct AdapterServerParams {
+    #[clap(flatten)]
+    pub key_management: KeyManagementParams,
+
     /// The address on which the shim should listen for incoming connections from the rollup nodes.
     #[clap(short, long, default_value = "127.0.0.1", group = "listen")]
     pub address: String,
@@ -53,7 +76,8 @@ pub struct AdapterServerParams {
         group = "listen"
     )]
     pub port: u16,
-    // TODO: e.g. --submit-key, prometheus stuff, enabled adapters, etc.
+
+    // TODO: e.g. prometheus stuff, enabled adapters, etc.
 }
 
 /// Common parameters for that commands that connect to the sugondat-node.
@@ -105,7 +129,7 @@ pub mod query {
     // - query blob <id> - returns the blob for a given key. The key here is the same sense as
     //   described here https://github.com/thrumdev/sugondat/issues/9#issuecomment-1814005570.
 
-    use super::{SugondatRpcParams, ENV_SUGONDAT_NAMESPACE};
+    use super::{SugondatRpcParams, KeyManagementParams, ENV_SUGONDAT_NAMESPACE};
     use clap::{Args, Subcommand};
 
     #[derive(Debug, Args)]
@@ -123,7 +147,7 @@ pub mod query {
     pub mod submit {
         //! CLI definition for the `query submit` subcommand.
 
-        use super::{SugondatRpcParams, ENV_SUGONDAT_NAMESPACE};
+        use super::{SugondatRpcParams, KeyManagementParams, ENV_SUGONDAT_NAMESPACE};
         use clap::Args;
 
         #[derive(Debug, Args)]
@@ -141,6 +165,9 @@ pub mod query {
 
             /// The file path of the blob to submit. Pass `-` to read from stdin.
             pub blob_path: String,
+
+            #[clap(flatten)]
+            pub key_management: KeyManagementParams,
         }
     }
 }

sugondat-shim/src/cmd/mod.rs

@@ -1,4 +1,5 @@
 use crate::cli::{Cli, Commands};
+use crate::key;
 use clap::Parser;
 
 pub mod query;
@@ -29,3 +30,16 @@ fn init_logging() -> anyhow::Result<()> {
         .try_init()?;
     Ok(())
 }
+
+fn fetch_key(params: crate::cli::KeyManagementParams) -> anyhow::Result<key::Keypair> {
+    if params.submit_dev_alice {
+        return Ok(key::alice())
+    }
+
+    if let Some(path) = params.submit_private_key {
+        return key::load(path)
+    }
+
+    // sanity: clap is supposed to prevent this
+    return Err(anyhow::anyhow!("No blob submission key specified. See --help"))
+}

sugondat-shim/src/cmd/query/submit.rs

@@ -8,6 +8,7 @@ pub async fn run(params: Params) -> anyhow::Result<()> {
         blob_path,
         namespace,
         rpc,
+        key_management,
     } = params;
     let blob = read_blob(&blob_path)
         .with_context(|| format!("cannot read blob file path '{}'", blob_path))?;

sugondat-shim/src/key.rs

@@ -1,14 +1,16 @@
 //! Key management: sr25519 account key used for signing blob submission
 //! transactions.
 
-use subxt_signer::sr25519::{Seed, Keypair};
+use subxt_signer::sr25519::Seed;
 use std::path::Path;
 
+pub use subxt_signer::sr25519::Keypair;
+
 /// Load a key from the provided file path.
 ///
 /// The file should contain a hex-encoded 32-byte seed used to generate
 /// the underlying schnorrkel private key.
-pub fn load_key_from_file<P: AsRef<Path>>(path: P) -> anyhow::Result<Keypair> {
+pub fn load<P: AsRef<Path>>(path: P) -> anyhow::Result<Keypair> {
     let raw = hex::decode(std::fs::read(path)?)?;
     let mut seed: Seed = Seed::default();
     if raw.len() <= seed.len() {