Skip to content

Commit

Permalink
Add sim-only deprecation notice
Browse files Browse the repository at this point in the history
  • Loading branch information
Ifropc committed Sep 27, 2024
1 parent c3aebe0 commit 11b4a37
Show file tree
Hide file tree
Showing 3 changed files with 39 additions and 9 deletions.
12 changes: 6 additions & 6 deletions FULL_HELP_DOCS.md
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ Deploy builtin Soroban Asset Contract
* `--cost` — Output the cost execution to stderr
* `--instructions <INSTRUCTIONS>` — Number of instructions to simulate
* `--build-only` — Build the transaction and only write the base64 xdr to stdout
* `--sim-only`Simulate the transaction and only write the base64 xdr to stdout
* `--sim-only`(Deprecated) simulate the transaction and only write the base64 xdr to stdout



Expand Down Expand Up @@ -373,7 +373,7 @@ If no keys are specified the contract itself is extended.
* `--cost` — Output the cost execution to stderr
* `--instructions <INSTRUCTIONS>` — Number of instructions to simulate
* `--build-only` — Build the transaction and only write the base64 xdr to stdout
* `--sim-only`Simulate the transaction and only write the base64 xdr to stdout
* `--sim-only`(Deprecated) simulate the transaction and only write the base64 xdr to stdout



Expand Down Expand Up @@ -401,7 +401,7 @@ Deploy a wasm contract
* `--cost` — Output the cost execution to stderr
* `--instructions <INSTRUCTIONS>` — Number of instructions to simulate
* `--build-only` — Build the transaction and only write the base64 xdr to stdout
* `--sim-only`Simulate the transaction and only write the base64 xdr to stdout
* `--sim-only`(Deprecated) simulate the transaction and only write the base64 xdr to stdout
* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts

Default value: `false`
Expand Down Expand Up @@ -679,7 +679,7 @@ Install a WASM file to the ledger without creating a contract instance
* `--cost` — Output the cost execution to stderr
* `--instructions <INSTRUCTIONS>` — Number of instructions to simulate
* `--build-only` — Build the transaction and only write the base64 xdr to stdout
* `--sim-only`Simulate the transaction and only write the base64 xdr to stdout
* `--sim-only`(Deprecated) simulate the transaction and only write the base64 xdr to stdout
* `--wasm <WASM>` — Path to wasm binary
* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts

Expand Down Expand Up @@ -718,7 +718,7 @@ stellar contract invoke ... -- --help
* `--cost` — Output the cost execution to stderr
* `--instructions <INSTRUCTIONS>` — Number of instructions to simulate
* `--build-only` — Build the transaction and only write the base64 xdr to stdout
* `--sim-only`Simulate the transaction and only write the base64 xdr to stdout
* `--sim-only`(Deprecated) simulate the transaction and only write the base64 xdr to stdout
* `--send <SEND>` — Whether or not to send a transaction

Default value: `default`
Expand Down Expand Up @@ -832,7 +832,7 @@ If no keys are specificed the contract itself is restored.
* `--cost` — Output the cost execution to stderr
* `--instructions <INSTRUCTIONS>` — Number of instructions to simulate
* `--build-only` — Build the transaction and only write the base64 xdr to stdout
* `--sim-only`Simulate the transaction and only write the base64 xdr to stdout
* `--sim-only`(Deprecated) simulate the transaction and only write the base64 xdr to stdout



Expand Down
16 changes: 13 additions & 3 deletions cmd/soroban-cli/src/fee.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
use clap::arg;
use clap::builder::TypedValueParser;

use soroban_env_host::xdr;
use soroban_rpc::Assembled;

use crate::commands::HEADING_RPC;
use crate::{commands::HEADING_RPC, deprecated_arg};

const DEPRECATION_MESSAGE: &str = "--sim-only is deprecated and will be removed \
in the future versions of CLI. The same functionality is offered by `tx simulate` command. To \
replicate the behaviour, you can run `stellar <command> --build only | stellar tx simulate`";

#[derive(Debug, clap::Args, Clone)]
#[group(skip)]
Expand All @@ -20,8 +25,13 @@ pub struct Args {
/// Build the transaction and only write the base64 xdr to stdout
#[arg(long, help_heading = HEADING_RPC)]
pub build_only: bool,
/// Simulate the transaction and only write the base64 xdr to stdout
#[arg(long, help_heading = HEADING_RPC, conflicts_with = "build_only")]
/// (Deprecated) simulate the transaction and only write the base64 xdr to stdout
#[arg(
long,
help_heading = HEADING_RPC,
conflicts_with = "build_only",
value_parser = deprecated_arg!(bool, DEPRECATION_MESSAGE))
]
pub sim_only: bool,
}

Expand Down
20 changes: 20 additions & 0 deletions cmd/soroban-cli/src/utils.rs
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,26 @@ pub fn get_name_from_stellar_asset_contract_storage(storage: &ScMap) -> Option<S
}
}

pub mod args {
/// Mark argument as deprecated with warning to be printed when it's used. Note: marco is only
/// supported for `bool` and `String` and is required to add
/// ```
/// use clap::builder::TypedValueParser;
/// ```
/// When using the marco
#[macro_export]
macro_rules! deprecated_arg {
(bool, $message: expr) => {
clap::builder::BoolValueParser::new().map(|x| {
if (x) {
crate::print::Print::new(false).warnln($message);
}
x
})
};
}
}

pub mod rpc {
use soroban_env_host::xdr;
use soroban_rpc::{Client, Error};
Expand Down

0 comments on commit 11b4a37

Please sign in to comment.