chore: Add dfx-core dependency and use it in the SNS CLI to allow it to use the user's DFX identities (dfinity#2927)

This is needed for the DFX SNS extension to better integrate with DFX.
The dependency is maintained by DFINITY, it is just not part of the
monrepo (and not currently depended on by the monorepo, prior to this
PR).

dfx-core uses a newer version of ic-agent, which means we need to update
ic-agent in the monorepo, and that means we need to update
ic-http-gateway (which I do here).

SNS CLI commands after this PR have a slightly different command after
this. You should pass `--network` to specify the network and
`--identity` to specify the identity if you don't want to use the
default one in DFX. The default network is the local one if none is
specified, for compatibility with DFX.

Author: anchpop

Cargo.Bazel.Fuzzing.json.lock

@@ -522,7 +522,7 @@ chrono = { version = "0.4.38", default-features = false, features = [
     "serde",
 ] }
 ciborium = "0.2.1"
-clap = { version = "4.5.18", features = ["derive", "string"] }
+clap = { version = "4.5.20", features = ["derive", "string"] }
 # cloudflare v0.12 is broken, master is partly fixed but unreleased yet.
 # see:
 # - https://github.com/cloudflare/cloudflare-rs/issues/222
@@ -534,6 +534,7 @@ curve25519-dalek = { version = "4.1.3", features = [
     "group",
     "precomputed-tables",
 ] }
+dfx-core = { version = "0.1.3" }
 ed25519-dalek = { version = "2.1.1", features = [
     "std",
     "zeroize",

Cargo.Bazel.Fuzzing.toml.lock

@@ -434,6 +434,9 @@ def external_crates_repository(name, cargo_lockfile, lockfile, sanitizers_enable
             "dashmap": crate.spec(
                 version = "^5.3.4",
             ),
+            "dfx-core": crate.spec(
+                version = "^0.1.3",
+            ),
             "dyn-clone": crate.spec(
                 version = "^1.0.14",
             ),

Cargo.Bazel.json.lock

@@ -26,6 +26,7 @@ DEPENDENCIES = [
     "@crate_index//:base64",
     "@crate_index//:candid",
     "@crate_index//:clap",
+    "@crate_index//:dfx-core",
     "@crate_index//:futures",
     "@crate_index//:hex",
     "@crate_index//:ic-agent",

Cargo.Bazel.toml.lock

@@ -19,6 +19,7 @@ base64 = { workspace = true }
 candid = { workspace = true }
 candid-utils = { path = "../../nervous_system/candid_utils" }
 clap = { workspace = true }
+dfx-core = { workspace = true }
 futures = { workspace = true }
 hex = { workspace = true }
 ic-agent = { workspace = true }

Cargo.lock

@@ -6,8 +6,7 @@ use crate::{
 };
 use anyhow::{anyhow, bail, Context, Result};
 use candid::{CandidType, Decode, Encode, IDLArgs};
-use clap::Parser;
-use ic_agent::{identity::Secp256k1Identity, Agent};
+use ic_agent::Agent;
 use ic_base_types::PrincipalId;
 use ic_crypto_sha2::Sha256;
 use ic_nervous_system_common_test_keys::TEST_NEURON_1_OWNER_KEYPAIR;
@@ -29,7 +28,6 @@ use std::{
     sync::Once,
 };
 use tempfile::NamedTempFile;
-
 pub mod deploy;
 pub mod health;
 pub mod init_config_file;
@@ -40,7 +38,8 @@ pub mod propose;
 mod table;
 pub mod unit_helpers;
 pub mod upgrade_sns_controlled_canister;
-mod utils;
+use clap::{ArgGroup, Args, Parser};
+pub mod utils;
 
 #[cfg(test)]
 mod tests;
@@ -62,17 +61,46 @@ pub struct CliArgs {
     #[clap(subcommand)]
     pub sub_command: SubCommand,
 
+    /// The user identity to run this command as. It contains your principal as well as some things DFX associates with it like the wallet.
+    #[arg(long, global = true)]
+    identity: Option<String>,
+
+    #[command(flatten)]
+    network: NetworkOpt,
+}
+
+#[derive(Args, Clone, Debug, Default)]
+#[clap(
+group(ArgGroup::new("network-select").multiple(false)),
+)]
+pub struct NetworkOpt {
     /// Override the compute network to connect to. By default, the local network is used.
-    /// A valid URL (starting with `http:` or `https:`) can be used here,
-    /// e.g., "http://localhost:8000" is a valid network name.
-    // TODO[NNS1-3569]: Remove this argument once we can inherit the same data from dfx_core.
-    #[clap(long, aliases = ["ic-url"], default_value = MAINNET_NETWORK)]
-    pub network: Option<String>,
-
-    /// Path to the PEM file of an identity to run this command as.
-    // TODO[NNS1-3569]: Remove this argument once we can inherit the same data from dfx_core.
-    #[clap(long)]
-    pub pem: Option<String>,
+    /// A valid URL (starting with `http:` or `https:`) can be used here, and a special
+    /// ephemeral network will be created specifically for this request. E.g.
+    /// "http://localhost:12345/" is a valid network name.
+    #[arg(long, global(true), group = "network-select")]
+    network: Option<String>,
+
+    /// Shorthand for --network=playground.
+    /// Borrows short-lived canisters on the real IC network instead of creating normal canisters.
+    #[clap(long, global(true), group = "network-select")]
+    playground: bool,
+
+    /// Shorthand for --network=ic.
+    #[clap(long, global(true), group = "network-select")]
+    ic: bool,
+}
+
+impl NetworkOpt {
+    pub fn to_network_name(&self) -> Option<String> {
+        if self.playground {
+            Some("playground".to_string())
+        } else if self.ic {
+            Some("ic".to_string())
+        } else {
+            self.network.clone()
+        }
+    }
 }
 
 #[derive(Debug, Parser)]
@@ -103,21 +131,17 @@ pub enum SubCommand {
 
 impl CliArgs {
     pub async fn agent(&self) -> Result<Agent> {
-        let mut agent = match &self.network {
-            Some(network) if !network.contains(MAINNET_NETWORK) => {
-                let agent = crate::utils::get_agent(network)?;
-                agent.fetch_root_key().await?;
-                agent
+        let network = match self.network.to_network_name() {
+            Some(network) => network,
+            None => {
+                eprintln!(
+                    "No network specified. Defaulting to the local network. To connect to the mainnet IC instead, try passing `--network=ic`"
+                );
+                "local".to_string()
             }
-            None | Some(_) => crate::utils::get_mainnet_agent()?,
         };
 
-        if let Some(pem) = &self.pem {
-            let identity = Secp256k1Identity::from_pem(pem.as_bytes())?;
-            agent.set_identity(identity);
-        }
-
-        Ok(agent)
+        crate::utils::get_agent(&network, self.identity.clone()).await
     }
 }