Add stellar keys unset to remove default identity. (#2337)

Author: fnando

FULL_HELP_DOCS.md

@@ -53,6 +53,7 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c
 - `snapshot` — Download a snapshot of a ledger from an archive
 - `tx` — Sign, Simulate, and Send transactions
 - `xdr` — Decode and encode XDR
+- `strkey` — Decode and encode strkey
 - `completion` — Print shell completion code for the specified shell
 - `cache` — Cache for transactions and contract specs
 - `version` — Print version information
@@ -1125,6 +1126,7 @@ Create and manage identities including keys and addresses
 - `rm` — Remove an identity
 - `secret` — Output an identity's secret key
 - `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it
+- `unset` — Unset the default key identity defined previously with `keys use <identity>`
 
 ## `stellar keys add`
 
@@ -1303,6 +1305,17 @@ Set the default identity that will be used on all commands. This allows you to s
 - `--global` — ⚠️ Deprecated: global config is always on
 - `--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
 
+## `stellar keys unset`
+
+Unset the default key identity defined previously with `keys use <identity>`
+
+**Usage:** `stellar keys unset [OPTIONS]`
+
+###### **Options (Global):**
+
+- `--global` — ⚠️ Deprecated: global config is always on
+- `--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
+
 ## `stellar network`
 
 Configure connection to networks
@@ -4141,6 +4154,65 @@ Print version information
 
 **Usage:** `stellar xdr version`
 
+## `stellar strkey`
+
+Decode and encode strkey
+
+**Usage:** `stellar strkey <COMMAND>`
+
+###### **Subcommands:**
+
+- `decode` — Decode strkey
+- `encode` — Encode strkey
+- `zero` — Generate the zero strkey
+- `version` — Print version information
+
+## `stellar strkey decode`
+
+Decode strkey
+
+**Usage:** `stellar strkey decode <STRKEY>`
+
+###### **Arguments:**
+
+- `<STRKEY>` — Strkey to decode
+
+## `stellar strkey encode`
+
+Encode strkey
+
+**Usage:** `stellar strkey encode <JSON>`
+
+###### **Arguments:**
+
+- `<JSON>` — JSON for Strkey to encode
+
+## `stellar strkey zero`
+
+Generate the zero strkey
+
+**Usage:** `stellar strkey zero [OPTIONS] <STRKEY>`
+
+###### **Arguments:**
+
+- `<STRKEY>` — Strkey type to generate the zero value for
+
+  Possible values: `public_key_ed25519`, `pre_auth_tx`, `hash_x`, `muxed_account_ed25519`, `signed_payload_ed25519`, `contract`, `liquidity_pool`, `claimable_balance_v0`
+
+###### **Options:**
+
+- `--output <OUTPUT>` — Output format
+
+  Default value: `strkey`
+
+  Possible values: `strkey`, `json`
+
+## `stellar strkey version`
+
+Print version information
+
+**Usage:** `stellar strkey version`
+
 ## `stellar completion`
 
 Print shell completion code for the specified shell

cmd/crates/soroban-test/tests/it/integration/keys.rs

@@ -1,4 +1,4 @@
-use predicates::prelude::predicate;
+use predicates::prelude::{predicate, PredicateBooleanExt};
 use soroban_test::AssertExt;
 use soroban_test::TestEnv;
 
@@ -143,3 +143,70 @@ async fn overwrite_identity_with_add() {
         pubkey_for_identity(sandbox, "test3").trim()
     );
 }
+
+#[tokio::test]
+#[allow(clippy::too_many_lines)]
+async fn set_default_identity() {
+    let sandbox = &TestEnv::new();
+    sandbox
+        .new_assert_cmd("keys")
+        .arg("generate")
+        .arg("test4")
+        .assert()
+        .success();
+
+    sandbox
+        .new_assert_cmd("keys")
+        .arg("use")
+        .arg("test4")
+        .assert()
+        .stderr(predicate::str::contains(
+            "The default source account is set to `test4`",
+        ))
+        .success();
+}
+
+#[tokio::test]
+#[allow(clippy::too_many_lines)]
+async fn unset_default_identity() {
+    let sandbox = &TestEnv::new();
+    sandbox
+        .new_assert_cmd("keys")
+        .arg("generate")
+        .arg("test5")
+        .assert()
+        .success();
+
+    sandbox
+        .new_assert_cmd("keys")
+        .arg("use")
+        .arg("test5")
+        .assert()
+        .stderr(predicate::str::contains(
+            "The default source account is set to `test5`",
+        ))
+        .success();
+
+    sandbox
+        .new_assert_cmd("env")
+        .env_remove("STELLAR_ACCOUNT")
+        .assert()
+        .stdout(predicate::str::contains("STELLAR_ACCOUNT=test5"))
+        .success();
+
+    sandbox
+        .new_assert_cmd("keys")
+        .arg("unset")
+        .assert()
+        .stderr(predicate::str::contains(
+            "The default source account has been unset",
+        ))
+        .success();
+
+    sandbox
+        .new_assert_cmd("env")
+        .env_remove("STELLAR_ACCOUNT")
+        .assert()
+        .stdout(predicate::str::contains("STELLAR_ACCOUNT=").not())
+        .success();
+}

cmd/soroban-cli/src/commands/keys/mod.rs

@@ -9,6 +9,7 @@ pub mod ls;
 pub mod public_key;
 pub mod rm;
 pub mod secret;
+pub mod unset;
 
 #[derive(Debug, Parser)]
 pub enum Cmd {
@@ -40,6 +41,9 @@ pub enum Cmd {
     /// variable, while reusing this value in all commands that require it.
     #[command(name = "use")]
     Default(default::Cmd),
+
+    /// Unset the default key identity defined previously with `keys use <identity>`
+    Unset(unset::Cmd),
 }
 
 #[derive(thiserror::Error, Debug)]
@@ -67,6 +71,9 @@ pub enum Error {
 
     #[error(transparent)]
     Default(#[from] default::Error),
+
+    #[error(transparent)]
+    Unset(#[from] unset::Error),
 }
 
 impl Cmd {
@@ -80,6 +87,7 @@ impl Cmd {
             Cmd::Rm(cmd) => cmd.run(global_args)?,
             Cmd::Secret(cmd) => cmd.run()?,
             Cmd::Default(cmd) => cmd.run(global_args)?,
+            Cmd::Unset(cmd) => cmd.run(global_args)?,
         }
         Ok(())
     }

cmd/soroban-cli/src/commands/keys/unset.rs

@@ -0,0 +1,26 @@
+use crate::{commands::global, config::locator, print::Print};
+
+#[derive(thiserror::Error, Debug)]
+pub enum Error {
+    #[error(transparent)]
+    Config(#[from] locator::Error),
+}
+
+#[derive(Debug, clap::Parser, Clone)]
+#[group(skip)]
+pub struct Cmd {
+    #[command(flatten)]
+    pub config_locator: locator::Args,
+}
+
+impl Cmd {
+    pub fn run(&self, global_args: &global::Args) -> Result<(), Error> {
+        let printer = Print::new(global_args.quiet);
+
+        self.config_locator.unset_identity()?;
+
+        printer.infoln("The default source account has been unset".to_string());
+
+        Ok(())
+    }
+}

cmd/soroban-cli/src/config/locator.rs

@@ -215,6 +215,10 @@ impl Args {
         Config::new()?.set_identity(name).save()
     }
 
+    pub fn unset_identity(&self) -> Result<(), Error> {
+        Config::new()?.unset_identity().save()
+    }
+
     pub fn list_identities(&self) -> Result<Vec<String>, Error> {
         Ok(KeyType::Identity
             .list_paths(&self.local_and_global()?)?

cmd/soroban-cli/src/config/mod.rs

@@ -207,6 +207,12 @@ impl Config {
         self
     }
 
+    #[must_use]
+    pub fn unset_identity(mut self) -> Self {
+        self.defaults.identity = None;
+        self
+    }
+
     pub fn save(&self) -> Result<(), locator::Error> {
         let toml_string = toml::to_string(&self)?;
         let path = cli_config_file()?;