Merge branch 'main' into sim-only-deprecation

stellar · Oct 7, 2024 · 2010b0a · 2010b0a
2 parents 622b004 + fb4e6bd
commit 2010b0a
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md
@@ -85,7 +85,7 @@ Tools for smart contract developers
 * `id` — Generate the contract id for a given contract or asset
 * `info` — Access info about contracts
 * `init` — Initialize a Soroban project with an example contract
-* `inspect` — Inspect a WASM file listing contract functions, meta, etc
+* `inspect` — (Deprecated in favor of `contract info` subcommands) Inspect a WASM file listing contract functions, meta, etc
 * `install` — Install a WASM file to the ledger without creating a contract instance
 * `invoke` — Invoke a contract function
 * `optimize` — Optimize a WASM file
@@ -630,7 +630,7 @@ Initialize a Soroban project with an example contract
 
 ## `stellar contract inspect`
 
-Inspect a WASM file listing contract functions, meta, etc
+(Deprecated in favor of `contract info` subcommands) Inspect a WASM file listing contract functions, meta, etc
 
 **Usage:** `stellar contract inspect [OPTIONS] --wasm <WASM>`
 

diff --git a/cmd/soroban-cli/src/commands/contract/inspect.rs b/cmd/soroban-cli/src/commands/contract/inspect.rs
@@ -5,6 +5,8 @@ use std::{fmt::Debug, path::PathBuf};
 use tracing::debug;
 
 use super::SpecOutput;
+use crate::commands::global::Args;
+use crate::print::Print;
 use crate::{config::locator, wasm};
 
 #[derive(Parser, Debug, Clone)]
@@ -33,7 +35,11 @@ pub enum Error {
 }
 
 impl Cmd {
-    pub fn run(&self) -> Result<(), Error> {
+    pub fn run(&self, global_args: &Args) -> Result<(), Error> {
+        Print::new(global_args.quiet).warnln(
+            "`contract inspect` has been deprecated in favor of `contract info`. \
+            Please use `contract info` instead.",
+        );
         let wasm = self.wasm.parse()?;
         debug!("File: {}", self.wasm.wasm.to_string_lossy());
         let output = match self.output {

diff --git a/cmd/soroban-cli/src/commands/contract/mod.rs b/cmd/soroban-cli/src/commands/contract/mod.rs
@@ -56,7 +56,8 @@ pub enum Cmd {
     /// Initialize a Soroban project with an example contract
     Init(init::Cmd),
 
-    /// Inspect a WASM file listing contract functions, meta, etc
+    /// (Deprecated in favor of `contract info` subcommands) Inspect a WASM file listing contract functions, meta, etc
+    #[command(display_order = 100)]
     Inspect(inspect::Cmd),
 
     /// Install a WASM file to the ledger without creating a contract instance
@@ -147,7 +148,7 @@ impl Cmd {
             Cmd::Id(id) => id.run()?,
             Cmd::Info(info) => info.run().await?,
             Cmd::Init(init) => init.run(global_args)?,
-            Cmd::Inspect(inspect) => inspect.run()?,
+            Cmd::Inspect(inspect) => inspect.run(global_args)?,
             Cmd::Install(install) => install.run(global_args).await?,
             Cmd::Invoke(invoke) => invoke.run(global_args).await?,
             Cmd::Optimize(optimize) => optimize.run()?,