From a6b2208d39aa4da10790db617ccc0410cc152c8f Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Thu, 28 May 2026 12:20:51 +0000 Subject: [PATCH 1/4] add --only-commit flag to stellar version --- cmd/soroban-cli/src/commands/version.rs | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/cmd/soroban-cli/src/commands/version.rs b/cmd/soroban-cli/src/commands/version.rs index 7b9670af6d..62ae55a78b 100644 --- a/cmd/soroban-cli/src/commands/version.rs +++ b/cmd/soroban-cli/src/commands/version.rs @@ -10,6 +10,9 @@ pub struct Cmd { /// Print only the major version. #[arg(long)] only_version_major: bool, + /// Print only the commit sha. + #[arg(long)] + only_commit: bool, } impl Cmd { @@ -19,6 +22,8 @@ impl Cmd { println!("{}", pkg()); } else if self.only_version_major { println!("{}", major()); + } else if self.only_commit { + println!("{}", git()); } else { println!("stellar {}", long()); } From 74c53e80a845b83fc0558db9d3e5a9a164125f06 Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Thu, 28 May 2026 22:55:17 +1000 Subject: [PATCH 2/4] refactor help docs usage syntax --- FULL_HELP_DOCS.md | 4125 +++++++++++++++++++++++++-------------------- 1 file changed, 2314 insertions(+), 1811 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index d80a458038..b1b5f2d15f 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -38,39 +38,42 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world + **Usage:** `stellar [OPTIONS] ` ###### **Subcommands:** -- `contract` — Tools for smart contract developers -- `doctor` — Diagnose and troubleshoot CLI and network issues -- `events` — Watch the network for contract events -- `env` — Prints the environment variables -- `keys` — Create and manage identities including keys and addresses -- `network` — Configure connection to networks -- `container` — Start local networks in containers -- `config` — Manage CLI configuration -- `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 -- `plugin` — The subcommand for CLI plugins -- `ledger` — Fetch ledger information -- `message` — Sign and verify arbitrary messages using SEP-53 -- `fee-stats` — ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats -- `fees` — Fetch network feestats and configure CLI fee settings +* `contract` — Tools for smart contract developers +* `doctor` — Diagnose and troubleshoot CLI and network issues +* `events` — Watch the network for contract events +* `env` — Prints the environment variables +* `keys` — Create and manage identities including keys and addresses +* `network` — Configure connection to networks +* `container` — Start local networks in containers +* `config` — Manage CLI configuration +* `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 +* `plugin` — The subcommand for CLI plugins +* `ledger` — Fetch ledger information +* `message` — Sign and verify arbitrary messages using SEP-53 +* `fee-stats` — ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats +* `fees` — Fetch network feestats and configure CLI fee settings ###### **Global Options:** -- `--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 -- `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` -- `-q`, `--quiet` — Do not write logs to stderr including `INFO` -- `-v`, `--verbose` — Log DEBUG events -- `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events -- `--no-cache` — Do not cache your simulations and transactions +* `--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 +* `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` +* `-q`, `--quiet` — Do not write logs to stderr including `INFO` +* `-v`, `--verbose` — Log DEBUG events +* `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events +* `--no-cache` — Do not cache your simulations and transactions + + ## `stellar contract` @@ -80,23 +83,25 @@ Tools for smart contract developers ###### **Subcommands:** -- `asset` — Utilities to deploy a Stellar Asset Contract or get its id -- `alias` — Utilities to manage contract aliases -- `bindings` — Generate code client bindings for a contract -- `build` — Build a contract from source -- `extend` — Extend the time to live ledger of a contract-data ledger entry -- `deploy` — Deploy a wasm contract -- `fetch` — Fetch a contract's Wasm binary -- `id` — Generate the contract id for a given contract or asset -- `info` — Access info about contracts -- `init` — Initialize a Soroban contract project -- `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc -- `upload` — Install a WASM file to the ledger without creating a contract instance -- `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance -- `invoke` — Invoke a contract function -- `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file -- `read` — Print the current value of a contract-data ledger entry -- `restore` — Restore an evicted value for a contract-data legder entry +* `asset` — Utilities to deploy a Stellar Asset Contract or get its id +* `alias` — Utilities to manage contract aliases +* `bindings` — Generate code client bindings for a contract +* `build` — Build a contract from source +* `extend` — Extend the time to live ledger of a contract-data ledger entry +* `deploy` — Deploy a wasm contract +* `fetch` — Fetch a contract's Wasm binary +* `id` — Generate the contract id for a given contract or asset +* `info` — Access info about contracts +* `init` — Initialize a Soroban contract project +* `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc +* `upload` — Install a WASM file to the ledger without creating a contract instance +* `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance +* `invoke` — Invoke a contract function +* `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file +* `read` — Print the current value of a contract-data ledger entry +* `restore` — Restore an evicted value for a contract-data legder entry + + ## `stellar contract asset` @@ -106,8 +111,10 @@ Utilities to deploy a Stellar Asset Contract or get its id ###### **Subcommands:** -- `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead -- `deploy` — Deploy builtin Soroban Asset Contract +* `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead +* `deploy` — Deploy builtin Soroban Asset Contract + + ## `stellar contract asset id` @@ -117,18 +124,20 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract asset deploy` @@ -138,38 +147,40 @@ Deploy builtin Soroban Asset Contract ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -- `--cost` — Output the cost execution to stderr +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +* `--cost` — Output the cost execution to stderr ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar contract alias` @@ -179,10 +190,12 @@ Utilities to manage contract aliases ###### **Subcommands:** -- `remove` — Remove contract alias -- `add` — Add contract alias -- `show` — Show the contract id associated with a given alias -- `ls` — List all aliases +* `remove` — Remove contract alias +* `add` — Add contract alias +* `show` — Show the contract id associated with a given alias +* `ls` — List all aliases + + ## `stellar contract alias remove` @@ -192,18 +205,20 @@ Remove contract alias ###### **Arguments:** -- `` — The contract alias that will be removed +* `` — The contract alias that will be removed ###### **Global Options:** -- `--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 +* `--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 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract alias add` @@ -213,23 +228,25 @@ Add contract alias ###### **Arguments:** -- `` — The contract alias that will be used +* `` — The contract alias that will be used ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--overwrite` — Overwrite the contract alias if it already exists -- `--id ` — The contract id that will be associated with the alias +* `--overwrite` — Overwrite the contract alias if it already exists +* `--id ` — The contract id that will be associated with the alias ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract alias show` @@ -239,18 +256,20 @@ Show the contract id associated with a given alias ###### **Arguments:** -- `` — The contract alias that will be displayed +* `` — The contract alias that will be displayed ###### **Global Options:** -- `--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 +* `--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 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract alias ls` @@ -260,7 +279,9 @@ List all aliases ###### **Global Options:** -- `--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 +* `--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 contract bindings` @@ -270,13 +291,15 @@ Generate code client bindings for a contract ###### **Subcommands:** -- `rust` — Generate Rust bindings -- `typescript` — Generate a TypeScript / JavaScript package -- `python` — Generate Python bindings -- `java` — Generate Java bindings -- `flutter` — Generate Flutter bindings -- `swift` — Generate Swift bindings -- `php` — Generate PHP bindings +* `rust` — Generate Rust bindings +* `typescript` — Generate a TypeScript / JavaScript package +* `python` — Generate Python bindings +* `java` — Generate Java bindings +* `flutter` — Generate Flutter bindings +* `swift` — Generate Swift bindings +* `php` — Generate PHP bindings + + ## `stellar contract bindings rust` @@ -286,7 +309,9 @@ Generate Rust bindings ###### **Options:** -- `--wasm ` — Path to wasm binary +* `--wasm ` — Path to wasm binary + + ## `stellar contract bindings typescript` @@ -296,22 +321,24 @@ Generate a TypeScript / JavaScript package ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -- `--output-dir ` — Where to place generated project -- `--overwrite` — Whether to overwrite output directory if it already exists +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--output-dir ` — Where to place generated project +* `--overwrite` — Whether to overwrite output directory if it already exists ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract bindings python` @@ -319,30 +346,40 @@ Generate Python bindings **Usage:** `stellar contract bindings python` + + ## `stellar contract bindings java` Generate Java bindings **Usage:** `stellar contract bindings java` + + ## `stellar contract bindings flutter` Generate Flutter bindings **Usage:** `stellar contract bindings flutter` + + ## `stellar contract bindings swift` Generate Swift bindings **Usage:** `stellar contract bindings swift` + + ## `stellar contract bindings php` Generate PHP bindings **Usage:** `stellar contract bindings php` + + ## `stellar contract build` Build a contract from source @@ -357,41 +394,41 @@ To view the commands that will be executed, without executing them, use the --pr ###### **Features:** -- `--features ` — Build with the list of features activated, space or comma separated -- `--all-features` — Build with the all features activated -- `--no-default-features` — Build with the default feature not activated +* `--features ` — Build with the list of features activated, space or comma separated +* `--all-features` — Build with the all features activated +* `--no-default-features` — Build with the default feature not activated ###### **Metadata:** -- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -- `--manifest-path ` — Path to Cargo.toml -- `--package ` — Package to build +* `--manifest-path ` — Path to Cargo.toml +* `--package ` — Package to build - If omitted, all packages that build for crate-type cdylib are built. - -- `--profile ` — Build with the specified profile + If omitted, all packages that build for crate-type cdylib are built. +* `--profile ` — Build with the specified profile Default value: `release` +* `--out-dir ` — Directory to copy wasm files to -- `--out-dir ` — Directory to copy wasm files to - - If provided, wasm files can be found in the cargo target directory, and the specified directory. + If provided, wasm files can be found in the cargo target directory, and the specified directory. - If ommitted, wasm files are written only to the cargo target directory. - -- `--locked` — Assert that `Cargo.lock` will remain unchanged -- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature + If ommitted, wasm files are written only to the cargo target directory. +* `--locked` — Assert that `Cargo.lock` will remain unchanged +* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` + ###### **Other:** -- `--print-commands-only` — Print commands to build without executing them +* `--print-commands-only` — Print commands to build without executing them + + ## `stellar contract extend` @@ -403,50 +440,55 @@ If no keys are specified the contract itself is extended. ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--ledgers-to-extend ` — Number of ledgers to extend the entries -- `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--ledgers-to-extend ` — Number of ledgers to extend the entries +* `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary + - `persistent`: + Persistent + - `temporary`: + Temporary + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -- `--cost` — Output the cost execution to stderr +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +* `--cost` — Output the cost execution to stderr ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar contract deploy` @@ -456,61 +498,63 @@ Deploy a wasm contract ###### **Arguments:** -- `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` +* `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Build Options:** -- `--package ` — Package to build when auto-building without --wasm +* `--package ` — Package to build when auto-building without --wasm ###### **Global Options:** -- `--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 +* `--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 ###### **Metadata:** -- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -- `--wasm ` — WASM file to deploy. When neither --wasm nor --wasm-hash is provided inside a Cargo workspace, builds the project automatically. One of --wasm or --wasm-hash is required when outside a Cargo workspace -- `--wasm-hash ` — Hash of the already installed/deployed WASM file -- `--salt ` — Custom salt 32-byte salt for the token id -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--wasm ` — WASM file to deploy. When neither --wasm nor --wasm-hash is provided inside a Cargo workspace, builds the project automatically. One of --wasm or --wasm-hash is required when outside a Cargo workspace +* `--wasm-hash ` — Hash of the already installed/deployed WASM file +* `--salt ` — Custom salt 32-byte salt for the token id +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - -- `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation -- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature +* `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation +* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -- `--cost` — Output the cost execution to stderr +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +* `--cost` — Output the cost execution to stderr ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar contract fetch` @@ -520,20 +564,22 @@ Fetch a contract's Wasm binary ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--id ` — Contract ID to fetch -- `--wasm-hash ` — Wasm to fetch -- `-o`, `--out-file ` — Where to write output otherwise stdout is used +* `--id ` — Contract ID to fetch +* `--wasm-hash ` — Wasm to fetch +* `-o`, `--out-file ` — Where to write output otherwise stdout is used ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract id` @@ -543,8 +589,10 @@ Generate the contract id for a given contract or asset ###### **Subcommands:** -- `asset` — Deploy builtin Soroban Asset Contract -- `wasm` — Deploy normal Wasm Contract +* `asset` — Deploy builtin Soroban Asset Contract +* `wasm` — Deploy normal Wasm Contract + + ## `stellar contract id asset` @@ -554,18 +602,20 @@ Deploy builtin Soroban Asset Contract ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract id wasm` @@ -575,32 +625,34 @@ Deploy normal Wasm Contract ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--salt ` — ID of the Soroban contract +* `--salt ` — ID of the Soroban contract ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided + + ## `stellar contract info` @@ -610,11 +662,13 @@ Access info about contracts ###### **Subcommands:** -- `interface` — Output the interface of a contract -- `meta` — Output the metadata stored in a contract -- `env-meta` — Output the env required metadata stored in a contract -- `build` — Output the contract build information, if available -- `hash` — Output the SHA-256 hash of a contract's Wasm +* `interface` — Output the interface of a contract +* `meta` — Output the metadata stored in a contract +* `env-meta` — Output the env required metadata stored in a contract +* `build` — Output the contract build information, if available +* `hash` — Output the SHA-256 hash of a contract's Wasm + + ## `stellar contract info interface` @@ -630,29 +684,36 @@ Outputs no data when no data is present in the contract. ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--output ` — Format of the output Default value: `rust` Possible values: - - `rust`: Rust code output of the contract interface - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `rust`: + Rust code output of the contract interface + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract info meta` @@ -668,29 +729,36 @@ Outputs no data when no data is present in the contract. ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of the meta info entry - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `text`: + Text output of the meta info entry + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract info env-meta` @@ -706,29 +774,36 @@ Outputs no data when no data is present in the contract. ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of the meta info entry - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `text`: + Text output of the meta info entry + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract info build` @@ -740,20 +815,22 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract info hash` @@ -767,19 +844,21 @@ Stellar Asset Contracts have no Wasm and therefore no hash; using `--id` against ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm ` — Path to a local .wasm file -- `--contract-id ` [alias: `id`] — Contract ID or alias of a deployed contract +* `--wasm ` — Path to a local .wasm file +* `--contract-id ` [alias: `id`] — Contract ID or alias of a deployed contract ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract init` @@ -791,15 +870,16 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Arguments:** -- `` +* `` ###### **Options:** -- `--name ` — An optional flag to specify a new contract's name. +* `--name ` — An optional flag to specify a new contract's name. Default value: `hello-world` +* `--overwrite` — Overwrite all existing files. + -- `--overwrite` — Overwrite all existing files. ## `stellar contract inspect` @@ -809,19 +889,25 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm ` — Path to wasm binary -- `--output ` — Output just XDR in base64 +* `--wasm ` — Path to wasm binary +* `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - - `xdr-base64`: XDR of array of contract spec entries - - `xdr-base64-array`: Array of xdr of contract spec entries - - `docs`: Pretty print of contract spec entries + - `xdr-base64`: + XDR of array of contract spec entries + - `xdr-base64-array`: + Array of xdr of contract spec entries + - `docs`: + Pretty print of contract spec entries + + + ## `stellar contract upload` @@ -831,54 +917,56 @@ Install a WASM file to the ledger without creating a contract instance ###### **Build Options:** -- `--package ` — Package to build when --wasm is not provided +* `--package ` — Package to build when --wasm is not provided ###### **Global Options:** -- `--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 +* `--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 ###### **Metadata:** -- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -- `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - -- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature +* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -- `--cost` — Output the cost execution to stderr +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +* `--cost` — Output the cost execution to stderr ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar contract install` @@ -888,54 +976,56 @@ Install a WASM file to the ledger without creating a contract instance ###### **Build Options:** -- `--package ` — Package to build when --wasm is not provided +* `--package ` — Package to build when --wasm is not provided ###### **Global Options:** -- `--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 +* `--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 ###### **Metadata:** -- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -- `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` - -- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature +* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -- `--cost` — Output the cost execution to stderr +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +* `--cost` — Output the cost execution to stderr ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar contract invoke` @@ -949,50 +1039,56 @@ stellar contract invoke ... -- --help ###### **Arguments:** -- `` — Function name as subcommand, then arguments for that function as `--arg-name value` +* `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--id ` — Contract ID to invoke -- `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction -- `--send ` — Whether or not to send a transaction +* `--id ` — Contract ID to invoke +* `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction +* `--send ` — Whether or not to send a transaction Default value: `default` Possible values: - - `default`: Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result - - `no`: Do not send transaction, return simulation result - - `yes`: Always send transaction + - `default`: + Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result + - `no`: + Do not send transaction, return simulation result + - `yes`: + Always send transaction + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -- `--cost` — Output the cost execution to stderr +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +* `--cost` — Output the cost execution to stderr ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar contract optimize` @@ -1002,8 +1098,10 @@ stellar contract invoke ... -- --help ###### **Options:** -- `--wasm ` — Path to one or more wasm binaries -- `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) +* `--wasm ` — Path to one or more wasm binaries +* `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) + + ## `stellar contract read` @@ -1013,38 +1111,46 @@ Print the current value of a contract-data ledger entry ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--output ` — Type of output to generate +* `--output ` — Type of output to generate Default value: `string` Possible values: - - `string`: String - - `json`: Json - - `xdr`: XDR - -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability + - `string`: + String + - `json`: + Json + - `xdr`: + XDR + +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary + - `persistent`: + Persistent + - `temporary`: + Temporary + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract restore` @@ -1056,51 +1162,55 @@ If no keys are specificed the contract itself is restored. ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary + - `persistent`: + Persistent + - `temporary`: + Temporary -- `--ledgers-to-extend ` — Number of ledgers to extend the entry -- `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--ledgers-to-extend ` — Number of ledgers to extend the entry +* `--ttl-ledger-only` — Only print the new Time To Live ledger ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -- `--cost` — Output the cost execution to stderr +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +* `--cost` — Output the cost execution to stderr ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar doctor` @@ -1110,7 +1220,9 @@ Diagnose and troubleshoot CLI and network issues ###### **Global Options:** -- `--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 +* `--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 events` @@ -1120,58 +1232,63 @@ Watch the network for contract events ###### **FILTERS:** -- `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. - - Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. +* `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. -- `--topic ` — A set of (up to 5) topic filters to filter event topics on. A single topic filter can contain 1-4 different segments, separated by commas. An asterisk (`*` character) indicates a wildcard segment. + Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. +* `--topic ` — A set of (up to 5) topic filters to filter event topics on. A single topic filter can contain 1-4 different segments, separated by commas. An asterisk (`*` character) indicates a wildcard segment. - In addition to up to 4 possible topic filter segments, the "**" wildcard can also be added, and will allow for a flexible number of topics in the returned events. The "**" wildcard must be the last segment in a query. + In addition to up to 4 possible topic filter segments, the "**" wildcard can also be added, and will allow for a flexible number of topics in the returned events. The "**" wildcard must be the last segment in a query. - If the "\*\*" wildcard is not included, only events with the exact number of topics as the given filter will be returned. + If the "**" wildcard is not included, only events with the exact number of topics as the given filter will be returned. - **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` + **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` - **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` + **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` - **Example:** topic filter with four segments and the "**" wildcard: --topic "AAAABQAAAAdDT1VOVEVSAA==,_,_,\*,**" + **Example:** topic filter with four segments and the "**" wildcard: --topic "AAAABQAAAAdDT1VOVEVSAA==,*,*,*,**" - Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). - -- `--type ` — Specifies which type of contract events to display + Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). +* `--type ` — Specifies which type of contract events to display Default value: `all` Possible values: `all`, `contract`, `system` + ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence -- `--cursor ` — The cursor corresponding to the start of the event range -- `--output ` — Output formatting options for event stream +* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence +* `--cursor ` — The cursor corresponding to the start of the event range +* `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - - `pretty`: Human-readable output with decoded event names and parameters - - `plain`: Human-readable output without colors - - `json`: JSON output with decoded event names and parameters - - `raw`: Raw event output without self-describing decoding + - `pretty`: + Human-readable output with decoded event names and parameters + - `plain`: + Human-readable output without colors + - `json`: + JSON output with decoded event names and parameters + - `raw`: + Raw event output without self-describing decoding -- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) +* `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar env` @@ -1187,13 +1304,15 @@ If there are no environment variables in use, prints the defaults. ###### **Arguments:** -- `` — Env variable name to get the value of. +* `` — Env variable name to get the value of. - E.g.: $ stellar env STELLAR_ACCOUNT + E.g.: $ stellar env STELLAR_ACCOUNT ###### **Global Options:** -- `--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 +* `--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` @@ -1203,15 +1322,17 @@ Create and manage identities including keys and addresses ###### **Subcommands:** -- `add` — Add a new identity (keypair, ledger, OS specific secure store) -- `public-key` — Given an identity return its address (public key) -- `fund` — Fund an identity on a test network -- `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store -- `ls` — List identities -- `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 ` +* `add` — Add a new identity (keypair, ledger, OS specific secure store) +* `public-key` — Given an identity return its address (public key) +* `fund` — Fund an identity on a test network +* `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store +* `ls` — List identities +* `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 ` + + ## `stellar keys add` @@ -1221,26 +1342,27 @@ Add a new identity (keypair, ledger, OS specific secure store) ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted -- `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase -- `--secure-store` — Save the new key in your OS's credential secure store. +* `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted +* `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase +* `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + + This only supports seed phrases for now. +* `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. +* `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path`. Persists the derived public key (and `--hd-path`, when provided) so later commands work without the device +* `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry +* `--hd-path ` — When importing a seed phrase, which `hd_path` to derive the key at. Persisted on the identity so later commands derive the same account without re-passing the flag. Not valid with `--public-key` or a raw secret key - This only supports seed phrases for now. -- `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. -- `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path`. Persists the derived public key (and `--hd-path`, when provided) so later commands work without the device -- `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry -- `--hd-path ` — When importing a seed phrase, which `hd_path` to derive the key at. Persisted on the identity so later commands derive the same account without re-passing the flag. Not valid with `--public-key` or a raw secret key ## `stellar keys public-key` @@ -1252,16 +1374,18 @@ Given an identity return its address (public key) ###### **Arguments:** -- `` — Name of identity to lookup. Required unless `--ledger` is provided +* `` — Name of identity to lookup. Required unless `--ledger` is provided ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) -- `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) +* `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` + + ## `stellar keys fund` @@ -1271,23 +1395,25 @@ Fund an identity on a test network ###### **Arguments:** -- `` — Name of identity to lookup. Required unless `--ledger` is provided +* `` — Name of identity to lookup. Required unless `--ledger` is provided ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) -- `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) +* `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar keys generate` @@ -1297,33 +1423,33 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -- `-s`, `--as-secret` — Output the generated identity as a secret key -- `--secure-store` — Save the new key in your OS's credential secure store. +* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +* `-s`, `--as-secret` — Output the generated identity as a secret key +* `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - -- `--hd-path ` — Which `hd_path` to derive the key at from the seed phrase. Honored across all storage modes: with `--as-secret` it picks which derived key is stored, with `--secure-store` or plain seed-phrase storage it is persisted on the identity so later commands derive the same account without re-passing the flag -- `--fund` — Fund generated key pair + On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. +* `--hd-path ` — Which `hd_path` to derive the key at from the seed phrase. Honored across all storage modes: with `--as-secret` it picks which derived key is stored, with `--secure-store` or plain seed-phrase storage it is persisted on the identity so later commands derive the same account without re-passing the flag +* `--fund` — Fund generated key pair Default value: `false` - -- `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry +* `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar keys ls` @@ -1333,11 +1459,13 @@ List identities ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `-l`, `--long` +* `-l`, `--long` + + ## `stellar keys rm` @@ -1347,15 +1475,17 @@ Remove an identity ###### **Arguments:** -- `` — Identity to remove +* `` — Identity to remove ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--force` — Skip confirmation prompt +* `--force` — Skip confirmation prompt + + ## `stellar keys secret` @@ -1365,16 +1495,18 @@ Output an identity's secret key ###### **Arguments:** -- `` — Name of identity to lookup, default is test identity +* `` — Name of identity to lookup, default is test identity ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--phrase` — Output seed phrase instead of private key -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--phrase` — Output seed phrase instead of private key +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + + ## `stellar keys use` @@ -1384,11 +1516,13 @@ Set the default identity that will be used on all commands. This allows you to s ###### **Arguments:** -- `` — Set the default network name +* `` — Set the default network name ###### **Global Options:** -- `--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 +* `--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` @@ -1398,7 +1532,9 @@ Unset the default key identity defined previously with `keys use ` ###### **Global Options:** -- `--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 +* `--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` @@ -1408,15 +1544,17 @@ Configure connection to networks ###### **Subcommands:** -- `add` — Add a new network -- `rm` — Remove a network -- `ls` — List networks -- `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it -- `health` — Fetch the health of the configured RPC -- `info` — Checks the health of the configured RPC -- `settings` — Fetch the network's config settings -- `unset` — Unset the default network defined previously with `network use ` -- `root-account` — Compute the root account keypair for a network +* `add` — Add a new network +* `rm` — Remove a network +* `ls` — List networks +* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +* `health` — Fetch the health of the configured RPC +* `info` — Checks the health of the configured RPC +* `settings` — Fetch the network's config settings +* `unset` — Unset the default network defined previously with `network use ` +* `root-account` — Compute the root account keypair for a network + + ## `stellar network add` @@ -1426,17 +1564,19 @@ Add a new network ###### **Arguments:** -- `` — Name of network +* `` — Name of network ###### **Global Options:** -- `--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 +* `--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 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — Optional header to include in requests to the RPC, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — Optional header to include in requests to the RPC, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server + + ## `stellar network rm` @@ -1446,11 +1586,13 @@ Remove a network ###### **Arguments:** -- `` — Network to remove +* `` — Network to remove ###### **Global Options:** -- `--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 +* `--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 ls` @@ -1460,11 +1602,13 @@ List networks ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `-l`, `--long` — Get more info about the networks +* `-l`, `--long` — Get more info about the networks + + ## `stellar network use` @@ -1474,11 +1618,13 @@ Set the default network that will be used on all commands. This allows you to sk ###### **Arguments:** -- `` — Set the default network name +* `` — Set the default network name ###### **Global Options:** -- `--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 +* `--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 health` @@ -1488,25 +1634,31 @@ Fetch the health of the configured RPC ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network health status - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network health status + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar network info` @@ -1516,25 +1668,31 @@ Checks the health of the configured RPC ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar network settings` @@ -1544,26 +1702,32 @@ Fetch the network's config settings ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network -- `--output ` — Format of the output +* `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network +* `--output ` — Format of the output Default value: `json` Possible values: - - `xdr`: XDR (`ConfigUpgradeSet` type) - - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `xdr`: + XDR (`ConfigUpgradeSet` type) + - `json`: + JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `json-formatted`: + JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar network unset` @@ -1573,7 +1737,9 @@ Unset the default network defined previously with `network use ` ###### **Global Options:** -- `--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 +* `--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 root-account` @@ -1583,8 +1749,10 @@ Compute the root account keypair for a network ###### **Subcommands:** -- `public-key` — Output a network's root account address (public key) -- `secret` — Output a network's root account secret key +* `public-key` — Output a network's root account address (public key) +* `secret` — Output a network's root account secret key + + ## `stellar network root-account public-key` @@ -1596,12 +1764,14 @@ Output a network's root account address (public key) ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--network-passphrase ` — Network passphrase to derive the root account from -- `-n`, `--network ` — Name of network to use from config +* `--network-passphrase ` — Network passphrase to derive the root account from +* `-n`, `--network ` — Name of network to use from config + + ## `stellar network root-account secret` @@ -1611,12 +1781,14 @@ Output a network's root account secret key ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--network-passphrase ` — Network passphrase to derive the root account from -- `-n`, `--network ` — Name of network to use from config +* `--network-passphrase ` — Network passphrase to derive the root account from +* `-n`, `--network ` — Name of network to use from config + + ## `stellar container` @@ -1626,9 +1798,11 @@ Start local networks in containers ###### **Subcommands:** -- `logs` — Get logs from a running network container -- `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) -- `stop` — Stop a network container started with `stellar container start` +* `logs` — Get logs from a running network container +* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) +* `stop` — Stop a network container started with `stellar container start` + + ## `stellar container logs` @@ -1638,13 +1812,15 @@ Get logs from a running network container ###### **Arguments:** -- `` — Container to get logs from +* `` — Container to get logs from Default value: `local` ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `stellar container start` @@ -1660,21 +1836,23 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Arguments:** -- `` — Network to start. Default is `local` +* `` — Network to start. Default is `local` Possible values: `local`, `testnet`, `futurenet`, `pubnet` + ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -- `--name ` — Optional argument to specify the container name -- `-l`, `--limits ` — Optional argument to specify the limits for the local network only -- `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `--name ` — Optional argument to specify the container name +* `-l`, `--limits ` — Optional argument to specify the limits for the local network only +* `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping Default value: `8000:8000` +* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +* `--protocol-version ` — Optional argument to specify the protocol version for the local network only + -- `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network -- `--protocol-version ` — Optional argument to specify the protocol version for the local network only ## `stellar container stop` @@ -1684,13 +1862,15 @@ Stop a network container started with `stellar container start` ###### **Arguments:** -- `` — Container to stop +* `` — Container to stop Default value: `local` ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `stellar config` @@ -1700,8 +1880,10 @@ Manage CLI configuration ###### **Subcommands:** -- `migrate` — Migrate the local configuration to the global directory -- `dir` — Show the global configuration directory +* `migrate` — Migrate the local configuration to the global directory +* `dir` — Show the global configuration directory + + ## `stellar config migrate` @@ -1711,7 +1893,9 @@ Migrate the local configuration to the global directory ###### **Global Options:** -- `--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 +* `--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 config dir` @@ -1725,7 +1909,9 @@ The location will depend on how your system is configured. ###### **Global Options:** -- `--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 +* `--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 snapshot` @@ -1735,8 +1921,10 @@ Download a snapshot of a ledger from an archive ###### **Subcommands:** -- `create` — Create a ledger snapshot using a history archive -- `merge` — Merge multiple ledger snapshots into a single snapshot file +* `create` — Create a ledger snapshot using a history archive +* `merge` — Merge multiple ledger snapshots into a single snapshot file + + ## `stellar snapshot create` @@ -1756,36 +1944,38 @@ Any invalid contract id passed as `--address` will be ignored. ###### **Archive Options:** -- `--archive-url ` — Archive URL +* `--archive-url ` — Archive URL ###### **Filter Options:** -- `--address
` — Account or contract address/alias to include in the snapshot -- `--wasm-hash ` — WASM hashes to include in the snapshot +* `--address
` — Account or contract address/alias to include in the snapshot +* `--wasm-hash ` — WASM hashes to include in the snapshot ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger -- `--output ` — Format of the out file +* `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger +* `--output ` — Format of the out file Default value: `json` Possible values: `json` -- `--out ` — Out path that the snapshot is written to +* `--out ` — Out path that the snapshot is written to Default value: `snapshot.json` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar snapshot merge` @@ -1801,14 +1991,16 @@ This allows combining snapshots from different contract deployments or manually ###### **Arguments:** -- `` — Snapshot files to merge (at least 2 required) +* `` — Snapshot files to merge (at least 2 required) ###### **Options:** -- `-o`, `--out ` — Output path for the merged snapshot +* `-o`, `--out ` — Output path for the merged snapshot Default value: `snapshot.json` + + ## `stellar tx` Sign, Simulate, and Send transactions @@ -1817,17 +2009,19 @@ Sign, Simulate, and Send transactions ###### **Subcommands:** -- `update` — Update the transaction -- `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order -- `hash` — Calculate the hash of a transaction envelope -- `new` — Create a new transaction -- `operation` — Manipulate the operations in a transaction, including adding new operations -- `send` — Send a transaction envelope to the network -- `sign` — Sign a transaction envelope appending the signature to the envelope -- `simulate` — Simulate a transaction envelope from stdin -- `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -- `decode` — Decode a transaction envelope from XDR to JSON -- `encode` — Encode a transaction envelope from JSON to XDR +* `update` — Update the transaction +* `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order +* `hash` — Calculate the hash of a transaction envelope +* `new` — Create a new transaction +* `operation` — Manipulate the operations in a transaction, including adding new operations +* `send` — Send a transaction envelope to the network +* `sign` — Sign a transaction envelope appending the signature to the envelope +* `simulate` — Simulate a transaction envelope from stdin +* `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned +* `decode` — Decode a transaction envelope from XDR to JSON +* `encode` — Encode a transaction envelope from JSON to XDR + + ## `stellar tx update` @@ -1837,7 +2031,9 @@ Update the transaction ###### **Subcommands:** -- `sequence-number` — Edit the sequence number on a transaction +* `sequence-number` — Edit the sequence number on a transaction + + ## `stellar tx update sequence-number` @@ -1849,7 +2045,9 @@ Edit the sequence number on a transaction ###### **Subcommands:** -- `next` — Fetch the source account's seq-num and increment for the given tx +* `next` — Fetch the source account's seq-num and increment for the given tx + + ## `stellar tx update sequence-number next` @@ -1859,14 +2057,16 @@ Fetch the source account's seq-num and increment for the given tx ###### **Global Options:** -- `--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 +* `--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 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx edit` @@ -1882,6 +2082,8 @@ $ stellar tx new manage-data --data-name hello --build-only | stellar tx edit **Usage:** `stellar tx edit` + + ## `stellar tx hash` Calculate the hash of a transaction envelope @@ -1890,14 +2092,16 @@ Calculate the hash of a transaction envelope ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx new` @@ -1907,28 +2111,30 @@ Create a new transaction ###### **Subcommands:** -- `account-merge` — Transfer XLM balance to another account and remove source account -- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -- `bump-sequence` — Bump sequence number to invalidate older transactions -- `change-trust` — Create, update, or delete a trustline -- `claim-claimable-balance` — Claim a claimable balance by its balance ID -- `clawback` — Clawback an asset from an account -- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -- `create-account` — Create and fund a new account -- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -- `end-sponsoring-future-reserves` — End sponsoring future reserves -- `liquidity-pool-deposit` — Deposit assets into a liquidity pool -- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -- `manage-buy-offer` — Create, update, or delete a buy offer -- `manage-data` — Set, modify, or delete account data entries -- `manage-sell-offer` — Create, update, or delete a sell offer -- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -- `payment` — Send asset to destination account -- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -- `set-options` — Set account options like flags, signers, and home domain -- `set-trustline-flags` — Configure authorization and trustline flags for an asset +* `account-merge` — Transfer XLM balance to another account and remove source account +* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +* `bump-sequence` — Bump sequence number to invalidate older transactions +* `change-trust` — Create, update, or delete a trustline +* `claim-claimable-balance` — Claim a claimable balance by its balance ID +* `clawback` — Clawback an asset from an account +* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +* `create-account` — Create and fund a new account +* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +* `end-sponsoring-future-reserves` — End sponsoring future reserves +* `liquidity-pool-deposit` — Deposit assets into a liquidity pool +* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +* `manage-buy-offer` — Create, update, or delete a buy offer +* `manage-data` — Set, modify, or delete account data entries +* `manage-sell-offer` — Create, update, or delete a sell offer +* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +* `payment` — Send asset to destination account +* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +* `set-options` — Set account options like flags, signers, and home domain +* `set-trustline-flags` — Configure authorization and trustline flags for an asset + + ## `stellar tx new account-merge` @@ -1938,33 +2144,35 @@ Transfer XLM balance to another account and remove source account ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' +* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new begin-sponsoring-future-reserves` @@ -1974,33 +2182,35 @@ Begin sponsoring future reserves for another account ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--sponsored-id ` — Account that will be sponsored +* `--sponsored-id ` — Account that will be sponsored ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new bump-sequence` @@ -2010,33 +2220,35 @@ Bump sequence number to invalidate older transactions ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--bump-to ` — Sequence number to bump to +* `--bump-to ` — Sequence number to bump to ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new change-trust` @@ -2046,36 +2258,38 @@ Create, update, or delete a trustline ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line +* `--line ` +* `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new claim-claimable-balance` @@ -2085,33 +2299,35 @@ Claim a claimable balance by its balance ID ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) +* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new clawback` @@ -2121,35 +2337,37 @@ Clawback an asset from an account ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--from ` — Account to clawback assets from, e.g. `GBX...` -- `--asset ` — Asset to clawback -- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset +* `--from ` — Account to clawback assets from, e.g. `GBX...` +* `--asset ` — Asset to clawback +* `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new clawback-claimable-balance` @@ -2159,33 +2377,35 @@ Clawback a claimable balance by its balance ID ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new create-account` @@ -2195,36 +2415,38 @@ Create and fund a new account ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--destination ` — Account Id to create, e.g. `GBX...` -- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +* `--destination ` — Account Id to create, e.g. `GBX...` +* `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new create-claimable-balance` @@ -2234,41 +2456,43 @@ Create a claimable balance that can be claimed by specified accounts ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--asset ` — Asset to be held in the ClaimableBalanceEntry +* `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` +* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. -- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + Examples: - Examples: - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new create-passive-sell-offer` @@ -2278,36 +2502,38 @@ Create a passive sell offer on the Stellar DEX ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new end-sponsoring-future-reserves` @@ -2317,29 +2543,31 @@ End sponsoring future reserves ###### **Global Options:** -- `--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 +* `--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 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new liquidity-pool-deposit` @@ -2349,42 +2577,43 @@ Deposit assets into a liquidity pool ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--liquidity-pool-id ` — Liquidity pool ID to deposit to -- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--liquidity-pool-id ` — Liquidity pool ID to deposit to +* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` - -- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new liquidity-pool-withdraw` @@ -2394,36 +2623,38 @@ Withdraw assets from a liquidity pool ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--liquidity-pool-id ` — Liquidity pool ID to withdraw from -- `--amount ` — Amount of pool shares to withdraw, in stroops -- `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops -- `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops +* `--liquidity-pool-id ` — Liquidity pool ID to withdraw from +* `--amount ` — Amount of pool shares to withdraw, in stroops +* `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops +* `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new manage-buy-offer` @@ -2433,39 +2664,41 @@ Create, update, or delete a buy offer ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new manage-data` @@ -2475,34 +2708,36 @@ Set, modify, or delete account data entries ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` +* `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +* `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new manage-sell-offer` @@ -2512,39 +2747,41 @@ Create, update, or delete a sell offer ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new path-payment-strict-send` @@ -2554,38 +2791,40 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--send-asset ` — Asset to send (pay with) -- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +* `--send-asset ` — Asset to send (pay with) +* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new path-payment-strict-receive` @@ -2595,38 +2834,40 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--send-asset ` — Asset to send (pay with) -- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +* `--send-asset ` — Asset to send (pay with) +* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new payment` @@ -2636,38 +2877,39 @@ Send asset to destination account ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--destination ` — Account to send to, e.g. `GBX...` -- `--asset ` — Asset to send, default native, e.i. XLM +* `--destination ` — Account to send to, e.g. `GBX...` +* `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` - -- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new revoke-sponsorship` @@ -2677,39 +2919,41 @@ Revoke sponsorship of a ledger entry or signer ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--account-id ` — Account ID (required for all sponsorship types) -- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -- `--data-name ` — Data name for data entry sponsorship -- `--offer-id ` — Offer ID for offer sponsorship -- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -- `--signer-key ` — Signer key for signer sponsorship +* `--account-id ` — Account ID (required for all sponsorship types) +* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +* `--data-name ` — Data name for data entry sponsorship +* `--offer-id ` — Offer ID for offer sponsorship +* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--signer-key ` — Signer key for signer sponsorship ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new set-options` @@ -2719,48 +2963,50 @@ Set account options like flags, signers, and home domain ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--inflation-dest ` — Account of the inflation destination -- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -- `--signer ` — Add, update, or remove a signer from an account -- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -- `--clear-required` -- `--clear-revocable` -- `--clear-immutable` -- `--clear-clawback-enabled` +* `--inflation-dest ` — Account of the inflation destination +* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +* `--signer ` — Add, update, or remove a signer from an account +* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +* `--clear-required` +* `--clear-revocable` +* `--clear-immutable` +* `--clear-clawback-enabled` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx new set-trustline-flags` @@ -2770,40 +3016,42 @@ Configure authorization and trustline flags for an asset ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -- `--asset ` — Asset to set trustline flags for -- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -- `--clear-authorize` -- `--clear-authorize-to-maintain-liabilities` -- `--clear-trustline-clawback-enabled` +* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +* `--asset ` — Asset to set trustline flags for +* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +* `--clear-authorize` +* `--clear-authorize-to-maintain-liabilities` +* `--clear-trustline-clawback-enabled` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation` @@ -2815,7 +3063,9 @@ Manipulate the operations in a transaction, including adding new operations ###### **Subcommands:** -- `add` — Add Operation to a transaction +* `add` — Add Operation to a transaction + + ## `stellar tx operation add` @@ -2825,28 +3075,30 @@ Add Operation to a transaction ###### **Subcommands:** -- `account-merge` — Transfer XLM balance to another account and remove source account -- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -- `bump-sequence` — Bump sequence number to invalidate older transactions -- `change-trust` — Create, update, or delete a trustline -- `claim-claimable-balance` — Claim a claimable balance by its balance ID -- `clawback` — Clawback an asset from an account -- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -- `create-account` — Create and fund a new account -- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -- `end-sponsoring-future-reserves` — End sponsoring future reserves -- `liquidity-pool-deposit` — Deposit assets into a liquidity pool -- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -- `manage-buy-offer` — Create, update, or delete a buy offer -- `manage-data` — Set, modify, or delete account data entries -- `manage-sell-offer` — Create, update, or delete a sell offer -- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -- `payment` — Send asset to destination account -- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -- `set-options` — Set account options like flags, signers, and home domain -- `set-trustline-flags` — Configure authorization and trustline flags for an asset +* `account-merge` — Transfer XLM balance to another account and remove source account +* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +* `bump-sequence` — Bump sequence number to invalidate older transactions +* `change-trust` — Create, update, or delete a trustline +* `claim-claimable-balance` — Claim a claimable balance by its balance ID +* `clawback` — Clawback an asset from an account +* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +* `create-account` — Create and fund a new account +* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +* `end-sponsoring-future-reserves` — End sponsoring future reserves +* `liquidity-pool-deposit` — Deposit assets into a liquidity pool +* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +* `manage-buy-offer` — Create, update, or delete a buy offer +* `manage-data` — Set, modify, or delete account data entries +* `manage-sell-offer` — Create, update, or delete a sell offer +* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +* `payment` — Send asset to destination account +* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +* `set-options` — Set account options like flags, signers, and home domain +* `set-trustline-flags` — Configure authorization and trustline flags for an asset + + ## `stellar tx operation add account-merge` @@ -2856,38 +3108,40 @@ Transfer XLM balance to another account and remove source account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add begin-sponsoring-future-reserves` @@ -2897,38 +3151,40 @@ Begin sponsoring future reserves for another account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--sponsored-id ` — Account that will be sponsored +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--sponsored-id ` — Account that will be sponsored ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add bump-sequence` @@ -2938,38 +3194,40 @@ Bump sequence number to invalidate older transactions ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--bump-to ` — Sequence number to bump to +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--bump-to ` — Sequence number to bump to ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add change-trust` @@ -2979,41 +3237,43 @@ Create, update, or delete a trustline ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--line ` +* `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add claim-claimable-balance` @@ -3023,38 +3283,40 @@ Claim a claimable balance by its balance ID ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add clawback` @@ -3064,40 +3326,42 @@ Clawback an asset from an account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--from ` — Account to clawback assets from, e.g. `GBX...` -- `--asset ` — Asset to clawback -- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--from ` — Account to clawback assets from, e.g. `GBX...` +* `--asset ` — Asset to clawback +* `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add clawback-claimable-balance` @@ -3107,38 +3371,40 @@ Clawback a claimable balance by its balance ID ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add create-account` @@ -3148,41 +3414,43 @@ Create and fund a new account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--destination ` — Account Id to create, e.g. `GBX...` -- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--destination ` — Account Id to create, e.g. `GBX...` +* `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add create-claimable-balance` @@ -3192,46 +3460,48 @@ Create a claimable balance that can be claimed by specified accounts ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--asset ` — Asset to be held in the ClaimableBalanceEntry +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` +* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. -- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + Examples: - Examples: - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add create-passive-sell-offer` @@ -3241,41 +3511,43 @@ Create a passive sell offer on the Stellar DEX ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add end-sponsoring-future-reserves` @@ -3285,37 +3557,39 @@ End sponsoring future reserves ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add liquidity-pool-deposit` @@ -3325,47 +3599,48 @@ Deposit assets into a liquidity pool ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--liquidity-pool-id ` — Liquidity pool ID to deposit to -- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--liquidity-pool-id ` — Liquidity pool ID to deposit to +* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` - -- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add liquidity-pool-withdraw` @@ -3375,41 +3650,43 @@ Withdraw assets from a liquidity pool ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--liquidity-pool-id ` — Liquidity pool ID to withdraw from -- `--amount ` — Amount of pool shares to withdraw, in stroops -- `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops -- `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--liquidity-pool-id ` — Liquidity pool ID to withdraw from +* `--amount ` — Amount of pool shares to withdraw, in stroops +* `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops +* `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add manage-buy-offer` @@ -3419,44 +3696,46 @@ Create, update, or delete a buy offer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add manage-data` @@ -3466,39 +3745,41 @@ Set, modify, or delete account data entries ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +* `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add manage-sell-offer` @@ -3508,44 +3789,46 @@ Create, update, or delete a sell offer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add path-payment-strict-receive` @@ -3555,43 +3838,45 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--send-asset ` — Asset to send (pay with) -- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--send-asset ` — Asset to send (pay with) +* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add path-payment-strict-send` @@ -3601,43 +3886,45 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--send-asset ` — Asset to send (pay with) -- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--send-asset ` — Asset to send (pay with) +* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add payment` @@ -3647,43 +3934,44 @@ Send asset to destination account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--destination ` — Account to send to, e.g. `GBX...` -- `--asset ` — Asset to send, default native, e.i. XLM +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--destination ` — Account to send to, e.g. `GBX...` +* `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` - -- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add revoke-sponsorship` @@ -3693,44 +3981,46 @@ Revoke sponsorship of a ledger entry or signer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--account-id ` — Account ID (required for all sponsorship types) -- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -- `--data-name ` — Data name for data entry sponsorship -- `--offer-id ` — Offer ID for offer sponsorship -- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -- `--signer-key ` — Signer key for signer sponsorship +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--account-id ` — Account ID (required for all sponsorship types) +* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +* `--data-name ` — Data name for data entry sponsorship +* `--offer-id ` — Offer ID for offer sponsorship +* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--signer-key ` — Signer key for signer sponsorship ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add set-options` @@ -3740,53 +4030,55 @@ Set account options like flags, signers, and home domain ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--inflation-dest ` — Account of the inflation destination -- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -- `--signer ` — Add, update, or remove a signer from an account -- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -- `--clear-required` -- `--clear-revocable` -- `--clear-immutable` -- `--clear-clawback-enabled` +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--inflation-dest ` — Account of the inflation destination +* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +* `--signer ` — Add, update, or remove a signer from an account +* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +* `--clear-required` +* `--clear-revocable` +* `--clear-immutable` +* `--clear-clawback-enabled` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx operation add set-trustline-flags` @@ -3796,45 +4088,47 @@ Configure authorization and trustline flags for an asset ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -- `--asset ` — Asset to set trustline flags for -- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -- `--clear-authorize` -- `--clear-authorize-to-maintain-liabilities` -- `--clear-trustline-clawback-enabled` +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +* `--asset ` — Asset to set trustline flags for +* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +* `--clear-authorize` +* `--clear-authorize-to-maintain-liabilities` +* `--clear-trustline-clawback-enabled` ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + + ## `stellar tx send` @@ -3844,18 +4138,20 @@ Send a transaction envelope to the network ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx sign` @@ -3865,26 +4161,28 @@ Sign a transaction envelope appending the signature to the envelope ###### **Arguments:** -- `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries + + ## `stellar tx simulate` @@ -3894,68 +4192,77 @@ Simulate a transaction envelope from stdin ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided + + ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -**Usage:** `stellar tx fetch [OPTIONS] fetch ` +**Usage:** `stellar tx fetch [OPTIONS] + fetch ` ###### **Subcommands:** -- `result` — Fetch the transaction result -- `meta` — Fetch the transaction meta -- `fee` — Fetch the transaction fee information -- `events` — Fetch the transaction events +* `result` — Fetch the transaction result +* `meta` — Fetch the transaction meta +* `fee` — Fetch the transaction fee information +* `events` — Fetch the transaction events ###### **Options:** -- `--hash ` — Hash of transaction to fetch -- `--output ` — Format of the output +* `--hash ` — Hash of transaction to fetch +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx fetch result` @@ -3965,22 +4272,28 @@ Fetch the transaction result ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--output ` — Format of the output +* `--hash ` — Transaction hash to fetch +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx fetch meta` @@ -3990,22 +4303,28 @@ Fetch the transaction meta ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--output ` — Format of the output +* `--hash ` — Transaction hash to fetch +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx fetch fee` @@ -4015,22 +4334,28 @@ Fetch the transaction fee information ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--output ` — Output format for fee command +* `--hash ` — Transaction hash to fetch +* `--output ` — Output format for fee command Default value: `table` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `table`: Formatted in a table comparing fee types + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `table`: + Formatted in a table comparing fee types + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx fetch events` @@ -4040,22 +4365,28 @@ Fetch the transaction events ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--output ` — Format of the output +* `--hash ` — Transaction hash to fetch +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the events with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of events with parsed XDRs - - `text`: Human readable event output with parsed XDRs + - `json`: + JSON output of the events with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of events with parsed XDRs + - `text`: + Human readable event output with parsed XDRs + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx decode` @@ -4065,22 +4396,25 @@ Decode a transaction envelope from XDR to JSON ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `single-base64` Possible values: `single-base64`, `single` -- `--output ` +* `--output ` Default value: `json` Possible values: `json`, `json-formatted` + + + ## `stellar tx encode` Encode a transaction envelope from JSON to XDR @@ -4089,22 +4423,25 @@ Encode a transaction envelope from JSON to XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `json` Possible values: `json` -- `--output ` +* `--output ` Default value: `single-base64` Possible values: `single-base64`, `single` + + + ## `stellar xdr` Decode and encode XDR @@ -4113,23 +4450,26 @@ Decode and encode XDR ###### **Subcommands:** -- `types` — View information about types -- `guess` — Guess the XDR type -- `decode` — Decode XDR -- `encode` — Encode XDR -- `compare` — Compare two XDR values with each other -- `generate` — Generate XDR values -- `xfile` — Preprocess XDR .x files -- `version` — Print version information +* `types` — View information about types +* `guess` — Guess the XDR type +* `decode` — Decode XDR +* `encode` — Encode XDR +* `compare` — Compare two XDR values with each other +* `generate` — Generate XDR values +* `xfile` — Preprocess XDR .x files +* `version` — Print version information ###### **Arguments:** -- `` — Channel of XDR to operate on +* `` — Channel of XDR to operate on Default value: `+curr` Possible values: `+curr`, `+next` + + + ## `stellar xdr types` View information about types @@ -4138,9 +4478,11 @@ View information about types ###### **Subcommands:** -- `list` — -- `schema` — -- `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory +* `list` — +* `schema` — +* `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory + + ## `stellar xdr types list` @@ -4148,25 +4490,31 @@ View information about types ###### **Options:** -- `--output ` +* `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` + + + ## `stellar xdr types schema` **Usage:** `stellar xdr types schema [OPTIONS] --type ` ###### **Options:** -- `--type ` — XDR type to generate schema for -- `--output ` +* `--type ` — XDR type to generate schema for +* `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` + + + ## `stellar xdr types schema-files` Generate JSON schema files for the XDR types, writing a file for each type to the out directory @@ -4175,13 +4523,16 @@ Generate JSON schema files for the XDR types, writing a file for each type to th ###### **Options:** -- `--out-dir ` -- `--output ` +* `--out-dir ` +* `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` + + + ## `stellar xdr guess` Guess the XDR type. @@ -4192,26 +4543,28 @@ Prints a list of types that the XDR values can be decoded into. ###### **Arguments:** -- `` — XDR or file containing XDR to decode, or stdin if empty +* `` — XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `list` Possible values: `list` -- `--certainty ` — Certainty as an arbitrary value +* `--certainty ` — Certainty as an arbitrary value Default value: `2` + + ## `stellar xdr decode` Decode XDR @@ -4220,23 +4573,26 @@ Decode XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--type ` — XDR type to decode -- `--input ` +* `--type ` — XDR type to decode +* `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `json` Possible values: `json`, `json-formatted`, `text`, `rust-debug`, `rust-debug-formatted` + + + ## `stellar xdr encode` Encode XDR @@ -4245,23 +4601,26 @@ Encode XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--type ` — XDR type to encode -- `--input ` +* `--type ` — XDR type to encode +* `--input ` Default value: `json` Possible values: `json` -- `--output ` +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream` + + + ## `stellar xdr compare` Compare two XDR values with each other @@ -4272,18 +4631,21 @@ Outputs: `-1` when the left XDR value is less than the right XDR value, `0` when ###### **Arguments:** -- `` — XDR file to decode and compare with the right value -- `` — XDR file to decode and compare with the left value +* `` — XDR file to decode and compare with the right value +* `` — XDR file to decode and compare with the left value ###### **Options:** -- `--type ` — XDR type of both inputs -- `--input ` +* `--type ` — XDR type of both inputs +* `--input ` Default value: `single-base64` Possible values: `single`, `single-base64` + + + ## `stellar xdr generate` Generate XDR values @@ -4292,8 +4654,10 @@ Generate XDR values ###### **Subcommands:** -- `default` — Generate default XDR values -- `arbitrary` — Generate arbitrary XDR values +* `default` — Generate default XDR values +* `arbitrary` — Generate arbitrary XDR values + + ## `stellar xdr generate default` @@ -4303,13 +4667,16 @@ Generate default XDR values ###### **Options:** -- `--type ` — XDR type to generate -- `--output ` +* `--type ` — XDR type to generate +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` + + + ## `stellar xdr generate arbitrary` Generate arbitrary XDR values @@ -4318,13 +4685,16 @@ Generate arbitrary XDR values ###### **Options:** -- `--type ` — XDR type to generate -- `--output ` +* `--type ` — XDR type to generate +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` + + + ## `stellar xdr xfile` Preprocess XDR .x files @@ -4333,7 +4703,9 @@ Preprocess XDR .x files ###### **Subcommands:** -- `preprocess` — Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directives +* `preprocess` — Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directives + + ## `stellar xdr xfile preprocess` @@ -4343,12 +4715,14 @@ Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directiv ###### **Arguments:** -- `` — XDR .x file to preprocess, or stdin if omitted +* `` — XDR .x file to preprocess, or stdin if omitted ###### **Options:** -- `--features ` — Features/symbols to define -- `--all-features` — Enable all features/symbols found in the input +* `--features ` — Features/symbols to define +* `--all-features` — Enable all features/symbols found in the input + + ## `stellar xdr version` @@ -4356,6 +4730,8 @@ Print version information **Usage:** `stellar xdr version` + + ## `stellar strkey` Decode and encode strkey @@ -4364,10 +4740,12 @@ Decode and encode strkey ###### **Subcommands:** -- `decode` — Decode strkey -- `encode` — Encode strkey -- `zero` — Generate the zero strkey -- `version` — Print version information +* `decode` — Decode strkey +* `encode` — Encode strkey +* `zero` — Generate the zero strkey +* `version` — Print version information + + ## `stellar strkey decode` @@ -4377,7 +4755,9 @@ Decode strkey ###### **Arguments:** -- `` — Strkey to decode +* `` — Strkey to decode + + ## `stellar strkey encode` @@ -4387,7 +4767,9 @@ Encode strkey ###### **Arguments:** -- `` — JSON for Strkey to encode +* `` — JSON for Strkey to encode + + ## `stellar strkey zero` @@ -4397,24 +4779,30 @@ Generate the zero strkey ###### **Arguments:** -- `` — Strkey type to generate the zero value for +* `` — 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 format +* `--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 @@ -4425,14 +4813,18 @@ To enable autocomplete in the current bash shell, run: `source <(stellar complet To enable autocomplete permanently, run: `echo "source <(stellar completion --shell bash)" >> ~/.bashrc` + **Usage:** `stellar completion --shell ` ###### **Options:** -- `--shell ` — The shell type +* `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` + + + ## `stellar cache` Cache for transactions and contract specs @@ -4441,9 +4833,11 @@ Cache for transactions and contract specs ###### **Subcommands:** -- `clean` — Delete the cache -- `path` — Show the location of the cache -- `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) +* `clean` — Delete the cache +* `path` — Show the location of the cache +* `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) + + ## `stellar cache clean` @@ -4451,12 +4845,16 @@ Delete the cache **Usage:** `stellar cache clean` + + ## `stellar cache path` Show the location of the cache **Usage:** `stellar cache path` + + ## `stellar cache actionlog` Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) @@ -4465,8 +4863,10 @@ Access details about cached actions like transactions, and simulations. (Experim ###### **Subcommands:** -- `ls` — List cached actions (transactions, simulations) -- `read` — Read cached action +* `ls` — List cached actions (transactions, simulations) +* `read` — Read cached action + + ## `stellar cache actionlog ls` @@ -4476,11 +4876,13 @@ List cached actions (transactions, simulations) ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `-l`, `--long` +* `-l`, `--long` + + ## `stellar cache actionlog read` @@ -4490,7 +4892,9 @@ Read cached action ###### **Options:** -- `--id ` — ID of the cache entry +* `--id ` — ID of the cache entry + + ## `stellar version` @@ -4500,8 +4904,11 @@ Print version information ###### **Options:** -- `--only-version` — Print only the version -- `--only-version-major` — Print only the major version +* `--only-version` — Print only the version +* `--only-version-major` — Print only the major version +* `--only-commit` — Print only the commit sha + + ## `stellar plugin` @@ -4511,8 +4918,10 @@ The subcommand for CLI plugins ###### **Subcommands:** -- `search` — Search for CLI plugins using GitHub -- `ls` — List installed plugins +* `search` — Search for CLI plugins using GitHub +* `ls` — List installed plugins + + ## `stellar plugin search` @@ -4520,12 +4929,16 @@ Search for CLI plugins using GitHub **Usage:** `stellar plugin search` + + ## `stellar plugin ls` List installed plugins **Usage:** `stellar plugin ls` + + ## `stellar ledger` Fetch ledger information @@ -4534,9 +4947,11 @@ Fetch ledger information ###### **Subcommands:** -- `entry` — Work with ledger entries -- `latest` — Get the latest ledger sequence and information from the network -- `fetch` — +* `entry` — Work with ledger entries +* `latest` — Get the latest ledger sequence and information from the network +* `fetch` — + + ## `stellar ledger entry` @@ -4546,7 +4961,9 @@ Work with ledger entries ###### **Subcommands:** -- `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) +* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) + + ## `stellar ledger entry fetch` @@ -4556,14 +4973,16 @@ Fetch ledger entries. This command supports all types of ledger entries supporte ###### **Subcommands:** -- `account` — Fetch account entry by public key or alias -- `contract-data` — Fetch contract ledger entry by address or alias and storage key -- `claimable-balance` — Fetch a claimable balance ledger entry by id -- `liquidity-pool` — Fetch a liquidity pool ledger entry by id -- `contract-code` — Fetch a Contract's WASM bytecode by WASM hash -- `trustline` — Fetch a trustline by account and asset -- `data` — Fetch key-value data entries attached to an account (see manageDataOp) -- `offer` — Fetch an offer by account and offer id +* `account` — Fetch account entry by public key or alias +* `contract-data` — Fetch contract ledger entry by address or alias and storage key +* `claimable-balance` — Fetch a claimable balance ledger entry by id +* `liquidity-pool` — Fetch a liquidity pool ledger entry by id +* `contract-code` — Fetch a Contract's WASM bytecode by WASM hash +* `trustline` — Fetch a trustline by account and asset +* `data` — Fetch key-value data entries attached to an account (see manageDataOp) +* `offer` — Fetch an offer by account and offer id + + ## `stellar ledger entry fetch account` @@ -4573,28 +4992,33 @@ Fetch account entry by public key or alias ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--account ` — Account alias or address to lookup -- `--output ` — Format of the output +* `--account ` — Account alias or address to lookup +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger entry fetch contract-data` @@ -4604,38 +5028,45 @@ Fetch contract ledger entry by address or alias and storage key ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--contract ` — Contract alias or address to fetch -- `--output ` — Format of the output +* `--contract ` — Contract alias or address to fetch +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) -- `--durability ` — Storage entry durability +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary + - `persistent`: + Persistent + - `temporary`: + Temporary -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--instance` — If the contract instance ledger entry should be included in the output +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--instance` — If the contract instance ledger entry should be included in the output ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger entry fetch claimable-balance` @@ -4645,26 +5076,32 @@ Fetch a claimable balance ledger entry by id ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--id ` — Claimable Balance Ids to fetch an entry for -- `--output ` — Format of the output +* `--id ` — Claimable Balance Ids to fetch an entry for +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger entry fetch liquidity-pool` @@ -4674,26 +5111,32 @@ Fetch a liquidity pool ledger entry by id ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--id ` — Liquidity pool ids -- `--output ` — Format of the output +* `--id ` — Liquidity pool ids +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger entry fetch contract-code` @@ -4703,26 +5146,32 @@ Fetch a Contract's WASM bytecode by WASM hash ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--wasm-hash ` — Get WASM bytecode by hash -- `--output ` — Format of the output +* `--wasm-hash ` — Get WASM bytecode by hash +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger entry fetch trustline` @@ -4732,29 +5181,34 @@ Fetch a trustline by account and asset ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) -- `--account ` — Account alias or address to lookup -- `--asset ` — Assets to get trustline info for -- `--hd-path ` — If account is a seed phrase use this hd path, default is 0 +* `--account ` — Account alias or address to lookup +* `--asset ` — Assets to get trustline info for +* `--hd-path ` — If account is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger entry fetch data` @@ -4764,29 +5218,34 @@ Fetch key-value data entries attached to an account (see manageDataOp) ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) -- `--account ` — Account alias or address to lookup -- `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--account ` — Account alias or address to lookup +* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger entry fetch offer` @@ -4796,29 +5255,34 @@ Fetch an offer by account and offer id ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) -- `--account ` — Account alias or address to lookup -- `--offer ` — ID of an offer made on the Stellar DEX -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--account ` — Account alias or address to lookup +* `--offer ` — ID of an offer made on the Stellar DEX +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger latest` @@ -4828,21 +5292,27 @@ Get the latest ledger sequence and information from the network ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar ledger fetch` @@ -4850,37 +5320,44 @@ Get the latest ledger sequence and information from the network ###### **Arguments:** -- `` — Ledger Sequence to start fetch (inclusive) +* `` — Ledger Sequence to start fetch (inclusive) ###### **Options:** -- `--limit ` — Number of ledgers to fetch +* `--limit ` — Number of ledgers to fetch Default value: `1` - -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request -- `--xdr-format ` — Format of the xdr in the output +* `--xdr-format ` — Format of the xdr in the output Default value: `json` Possible values: - - `json`: XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields - - `xdr`: XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields + - `json`: + XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields + - `xdr`: + XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar message` @@ -4890,8 +5367,10 @@ Sign and verify arbitrary messages using SEP-53 ###### **Subcommands:** -- `sign` — Sign an arbitrary message using SEP-53 -- `verify` — Verify a SEP-53 signed message +* `sign` — Sign an arbitrary message using SEP-53 +* `verify` — Verify a SEP-53 signed message + + ## `stellar message sign` @@ -4905,20 +5384,22 @@ Example: stellar message sign "Hello, World!" --sign-with-key alice ###### **Arguments:** -- `` — The message to sign. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically +* `` — The message to sign. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--base64` — Treat the message as base64-encoded binary data +* `--base64` — Treat the message as base64-encoded binary data ###### **Signing Options:** -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` + + ## `stellar message verify` @@ -4932,18 +5413,20 @@ Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public- ###### **Arguments:** -- `` — The message to verify. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically +* `` — The message to verify. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--base64` — Treat the message as base64-encoded binary data -- `-s`, `--signature ` — The base64-encoded signature to verify -- `-p`, `--public-key ` — The public key to verify the signature against. Can be an identity (--public-key alice), a public key (--public-key GDKW...) -- `--hd-path ` — If public key identity is a seed phrase use this hd path, default is 0 +* `--base64` — Treat the message as base64-encoded binary data +* `-s`, `--signature ` — The base64-encoded signature to verify +* `-p`, `--public-key ` — The public key to verify the signature against. Can be an identity (--public-key alice), a public key (--public-key GDKW...) +* `--hd-path ` — If public key identity is a seed phrase use this hd path, default is 0 + + ## `stellar fee-stats` @@ -4953,21 +5436,27 @@ Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public- ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar fees` @@ -4977,9 +5466,11 @@ Fetch network feestats and configure CLI fee settings ###### **Subcommands:** -- `stats` — Fetch the feestats from the network -- `use` — Set the default inclusion fee settings for the CLI -- `unset` — Remove the default inclusion fee settings for the CLI +* `stats` — Fetch the feestats from the network +* `use` — Set the default inclusion fee settings for the CLI +* `unset` — Remove the default inclusion fee settings for the CLI + + ## `stellar fees stats` @@ -4989,21 +5480,27 @@ Fetch the feestats from the network ###### **Options:** -- `--output ` — Format of the output +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar fees use` @@ -5013,21 +5510,24 @@ Set the default inclusion fee settings for the CLI ###### **Global Options:** -- `--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 +* `--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 ###### **Options:** -- `--amount ` — Set the default inclusion fee amount, in stroops. 1 stroop = 0.0000001 xlm -- `--fee-metric ` — Set the default inclusion fee based on a metric from the network's fee stats +* `--amount ` — Set the default inclusion fee amount, in stroops. 1 stroop = 0.0000001 xlm +* `--fee-metric ` — Set the default inclusion fee based on a metric from the network's fee stats Possible values: `max`, `min`, `mode`, `p10`, `p20`, `p30`, `p40`, `p50`, `p60`, `p70`, `p80`, `p90`, `p95`, `p99` + ###### **RPC Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar fees unset` @@ -5037,4 +5537,7 @@ Remove the default inclusion fee settings for the CLI ###### **Global Options:** -- `--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 +* `--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 + + + From d05a4dcd606ae599601cd661b4c87932c3cbd42a Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Thu, 28 May 2026 22:59:47 +1000 Subject: [PATCH 3/4] update docs for stellar contract commands --- FULL_HELP_DOCS.md | 4126 ++++++++++++++++++++------------------------- 1 file changed, 1812 insertions(+), 2314 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index b1b5f2d15f..2894cec629 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -38,42 +38,39 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world - **Usage:** `stellar [OPTIONS] ` ###### **Subcommands:** -* `contract` — Tools for smart contract developers -* `doctor` — Diagnose and troubleshoot CLI and network issues -* `events` — Watch the network for contract events -* `env` — Prints the environment variables -* `keys` — Create and manage identities including keys and addresses -* `network` — Configure connection to networks -* `container` — Start local networks in containers -* `config` — Manage CLI configuration -* `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 -* `plugin` — The subcommand for CLI plugins -* `ledger` — Fetch ledger information -* `message` — Sign and verify arbitrary messages using SEP-53 -* `fee-stats` — ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats -* `fees` — Fetch network feestats and configure CLI fee settings +- `contract` — Tools for smart contract developers +- `doctor` — Diagnose and troubleshoot CLI and network issues +- `events` — Watch the network for contract events +- `env` — Prints the environment variables +- `keys` — Create and manage identities including keys and addresses +- `network` — Configure connection to networks +- `container` — Start local networks in containers +- `config` — Manage CLI configuration +- `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 +- `plugin` — The subcommand for CLI plugins +- `ledger` — Fetch ledger information +- `message` — Sign and verify arbitrary messages using SEP-53 +- `fee-stats` — ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats +- `fees` — Fetch network feestats and configure CLI fee settings ###### **Global Options:** -* `--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 -* `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` -* `-q`, `--quiet` — Do not write logs to stderr including `INFO` -* `-v`, `--verbose` — Log DEBUG events -* `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events -* `--no-cache` — Do not cache your simulations and transactions - - +- `--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 +- `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` +- `-q`, `--quiet` — Do not write logs to stderr including `INFO` +- `-v`, `--verbose` — Log DEBUG events +- `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events +- `--no-cache` — Do not cache your simulations and transactions ## `stellar contract` @@ -83,25 +80,23 @@ Tools for smart contract developers ###### **Subcommands:** -* `asset` — Utilities to deploy a Stellar Asset Contract or get its id -* `alias` — Utilities to manage contract aliases -* `bindings` — Generate code client bindings for a contract -* `build` — Build a contract from source -* `extend` — Extend the time to live ledger of a contract-data ledger entry -* `deploy` — Deploy a wasm contract -* `fetch` — Fetch a contract's Wasm binary -* `id` — Generate the contract id for a given contract or asset -* `info` — Access info about contracts -* `init` — Initialize a Soroban contract project -* `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc -* `upload` — Install a WASM file to the ledger without creating a contract instance -* `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance -* `invoke` — Invoke a contract function -* `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file -* `read` — Print the current value of a contract-data ledger entry -* `restore` — Restore an evicted value for a contract-data legder entry - - +- `asset` — Utilities to deploy a Stellar Asset Contract or get its id +- `alias` — Utilities to manage contract aliases +- `bindings` — Generate code client bindings for a contract +- `build` — Build a contract from source +- `extend` — Extend the time to live ledger of a contract-data ledger entry +- `deploy` — Deploy a wasm contract +- `fetch` — Fetch a contract's Wasm binary +- `id` — Generate the contract id for a given contract or asset +- `info` — Access info about contracts +- `init` — Initialize a Soroban contract project +- `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc +- `upload` — Install a WASM file to the ledger without creating a contract instance +- `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance +- `invoke` — Invoke a contract function +- `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file +- `read` — Print the current value of a contract-data ledger entry +- `restore` — Restore an evicted value for a contract-data legder entry ## `stellar contract asset` @@ -111,10 +106,8 @@ Utilities to deploy a Stellar Asset Contract or get its id ###### **Subcommands:** -* `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead -* `deploy` — Deploy builtin Soroban Asset Contract - - +- `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead +- `deploy` — Deploy builtin Soroban Asset Contract ## `stellar contract asset id` @@ -124,20 +117,18 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract asset deploy` @@ -147,40 +138,38 @@ Deploy builtin Soroban Asset Contract ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -* `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +- `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -* `--cost` — Output the cost execution to stderr +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +- `--cost` — Output the cost execution to stderr ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract alias` @@ -190,12 +179,10 @@ Utilities to manage contract aliases ###### **Subcommands:** -* `remove` — Remove contract alias -* `add` — Add contract alias -* `show` — Show the contract id associated with a given alias -* `ls` — List all aliases - - +- `remove` — Remove contract alias +- `add` — Add contract alias +- `show` — Show the contract id associated with a given alias +- `ls` — List all aliases ## `stellar contract alias remove` @@ -205,20 +192,18 @@ Remove contract alias ###### **Arguments:** -* `` — The contract alias that will be removed +- `` — The contract alias that will be removed ###### **Global Options:** -* `--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 +- `--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 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract alias add` @@ -228,25 +213,23 @@ Add contract alias ###### **Arguments:** -* `` — The contract alias that will be used +- `` — The contract alias that will be used ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--overwrite` — Overwrite the contract alias if it already exists -* `--id ` — The contract id that will be associated with the alias +- `--overwrite` — Overwrite the contract alias if it already exists +- `--id ` — The contract id that will be associated with the alias ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract alias show` @@ -256,20 +239,18 @@ Show the contract id associated with a given alias ###### **Arguments:** -* `` — The contract alias that will be displayed +- `` — The contract alias that will be displayed ###### **Global Options:** -* `--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 +- `--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 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract alias ls` @@ -279,9 +260,7 @@ List all aliases ###### **Global Options:** -* `--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 - - +- `--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 contract bindings` @@ -291,15 +270,13 @@ Generate code client bindings for a contract ###### **Subcommands:** -* `rust` — Generate Rust bindings -* `typescript` — Generate a TypeScript / JavaScript package -* `python` — Generate Python bindings -* `java` — Generate Java bindings -* `flutter` — Generate Flutter bindings -* `swift` — Generate Swift bindings -* `php` — Generate PHP bindings - - +- `rust` — Generate Rust bindings +- `typescript` — Generate a TypeScript / JavaScript package +- `python` — Generate Python bindings +- `java` — Generate Java bindings +- `flutter` — Generate Flutter bindings +- `swift` — Generate Swift bindings +- `php` — Generate PHP bindings ## `stellar contract bindings rust` @@ -309,9 +286,7 @@ Generate Rust bindings ###### **Options:** -* `--wasm ` — Path to wasm binary - - +- `--wasm ` — Path to wasm binary ## `stellar contract bindings typescript` @@ -321,24 +296,22 @@ Generate a TypeScript / JavaScript package ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -* `--output-dir ` — Where to place generated project -* `--overwrite` — Whether to overwrite output directory if it already exists +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--output-dir ` — Where to place generated project +- `--overwrite` — Whether to overwrite output directory if it already exists ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract bindings python` @@ -346,40 +319,30 @@ Generate Python bindings **Usage:** `stellar contract bindings python` - - ## `stellar contract bindings java` Generate Java bindings **Usage:** `stellar contract bindings java` - - ## `stellar contract bindings flutter` Generate Flutter bindings **Usage:** `stellar contract bindings flutter` - - ## `stellar contract bindings swift` Generate Swift bindings **Usage:** `stellar contract bindings swift` - - ## `stellar contract bindings php` Generate PHP bindings **Usage:** `stellar contract bindings php` - - ## `stellar contract build` Build a contract from source @@ -394,41 +357,41 @@ To view the commands that will be executed, without executing them, use the --pr ###### **Features:** -* `--features ` — Build with the list of features activated, space or comma separated -* `--all-features` — Build with the all features activated -* `--no-default-features` — Build with the default feature not activated +- `--features ` — Build with the list of features activated, space or comma separated +- `--all-features` — Build with the all features activated +- `--no-default-features` — Build with the default feature not activated ###### **Metadata:** -* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -* `--manifest-path ` — Path to Cargo.toml -* `--package ` — Package to build +- `--manifest-path ` — Path to Cargo.toml +- `--package ` — Package to build - If omitted, all packages that build for crate-type cdylib are built. -* `--profile ` — Build with the specified profile + If omitted, all packages that build for crate-type cdylib are built. + +- `--profile ` — Build with the specified profile Default value: `release` -* `--out-dir ` — Directory to copy wasm files to - If provided, wasm files can be found in the cargo target directory, and the specified directory. +- `--out-dir ` — Directory to copy wasm files to + + If provided, wasm files can be found in the cargo target directory, and the specified directory. - If ommitted, wasm files are written only to the cargo target directory. -* `--locked` — Assert that `Cargo.lock` will remain unchanged -* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature + If ommitted, wasm files are written only to the cargo target directory. + +- `--locked` — Assert that `Cargo.lock` will remain unchanged +- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` - ###### **Other:** -* `--print-commands-only` — Print commands to build without executing them - - +- `--print-commands-only` — Print commands to build without executing them ## `stellar contract extend` @@ -440,55 +403,50 @@ If no keys are specified the contract itself is extended. ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--ledgers-to-extend ` — Number of ledgers to extend the entries -* `--ttl-ledger-only` — Only print the new Time To Live ledger -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability +- `--ledgers-to-extend ` — Number of ledgers to extend the entries +- `--ttl-ledger-only` — Only print the new Time To Live ledger +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - + - `persistent`: Persistent + - `temporary`: Temporary ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -* `--cost` — Output the cost execution to stderr +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +- `--cost` — Output the cost execution to stderr ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract deploy` @@ -498,63 +456,61 @@ Deploy a wasm contract ###### **Arguments:** -* `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` +- `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Build Options:** -* `--package ` — Package to build when auto-building without --wasm +- `--package ` — Package to build when auto-building without --wasm ###### **Global Options:** -* `--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 +- `--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 ###### **Metadata:** -* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -* `--wasm ` — WASM file to deploy. When neither --wasm nor --wasm-hash is provided inside a Cargo workspace, builds the project automatically. One of --wasm or --wasm-hash is required when outside a Cargo workspace -* `--wasm-hash ` — Hash of the already installed/deployed WASM file -* `--salt ` — Custom salt 32-byte salt for the token id -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +- `--wasm ` — WASM file to deploy. When neither --wasm nor --wasm-hash is provided inside a Cargo workspace, builds the project automatically. One of --wasm or --wasm-hash is required when outside a Cargo workspace +- `--wasm-hash ` — Hash of the already installed/deployed WASM file +- `--salt ` — Custom salt 32-byte salt for the token id +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` -* `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation -* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature + +- `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation +- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` - ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -* `--cost` — Output the cost execution to stderr +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +- `--cost` — Output the cost execution to stderr ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract fetch` @@ -564,22 +520,20 @@ Fetch a contract's Wasm binary ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--id ` — Contract ID to fetch -* `--wasm-hash ` — Wasm to fetch -* `-o`, `--out-file ` — Where to write output otherwise stdout is used +- `--id ` — Contract ID to fetch +- `--wasm-hash ` — Wasm to fetch +- `-o`, `--out-file ` — Where to write output otherwise stdout is used ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract id` @@ -589,10 +543,8 @@ Generate the contract id for a given contract or asset ###### **Subcommands:** -* `asset` — Deploy builtin Soroban Asset Contract -* `wasm` — Deploy normal Wasm Contract - - +- `asset` — Deploy builtin Soroban Asset Contract +- `wasm` — Deploy normal Wasm Contract ## `stellar contract id asset` @@ -602,20 +554,18 @@ Deploy builtin Soroban Asset Contract ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract id wasm` @@ -625,34 +575,32 @@ Deploy normal Wasm Contract ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--salt ` — ID of the Soroban contract +- `--salt ` — ID of the Soroban contract ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided ## `stellar contract info` @@ -662,13 +610,11 @@ Access info about contracts ###### **Subcommands:** -* `interface` — Output the interface of a contract -* `meta` — Output the metadata stored in a contract -* `env-meta` — Output the env required metadata stored in a contract -* `build` — Output the contract build information, if available -* `hash` — Output the SHA-256 hash of a contract's Wasm - - +- `interface` — Output the interface of a contract +- `meta` — Output the metadata stored in a contract +- `env-meta` — Output the env required metadata stored in a contract +- `build` — Output the contract build information, if available +- `hash` — Output the SHA-256 hash of a contract's Wasm ## `stellar contract info interface` @@ -684,36 +630,29 @@ Outputs no data when no data is present in the contract. ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--output ` — Format of the output Default value: `rust` Possible values: - - `rust`: - Rust code output of the contract interface - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - + - `rust`: Rust code output of the contract interface + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract info meta` @@ -729,36 +668,29 @@ Outputs no data when no data is present in the contract. ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of the meta info entry - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - + - `text`: Text output of the meta info entry + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract info env-meta` @@ -774,36 +706,29 @@ Outputs no data when no data is present in the contract. ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of the meta info entry - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - + - `text`: Text output of the meta info entry + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract info build` @@ -815,22 +740,20 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` -* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` -* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract info hash` @@ -844,21 +767,19 @@ Stellar Asset Contracts have no Wasm and therefore no hash; using `--id` against ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm ` — Path to a local .wasm file -* `--contract-id ` [alias: `id`] — Contract ID or alias of a deployed contract +- `--wasm ` — Path to a local .wasm file +- `--contract-id ` [alias: `id`] — Contract ID or alias of a deployed contract ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract init` @@ -870,16 +791,15 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Arguments:** -* `` +- `` ###### **Options:** -* `--name ` — An optional flag to specify a new contract's name. +- `--name ` — An optional flag to specify a new contract's name. Default value: `hello-world` -* `--overwrite` — Overwrite all existing files. - +- `--overwrite` — Overwrite all existing files. ## `stellar contract inspect` @@ -889,25 +809,19 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm ` — Path to wasm binary -* `--output ` — Output just XDR in base64 +- `--wasm ` — Path to wasm binary +- `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - - `xdr-base64`: - XDR of array of contract spec entries - - `xdr-base64-array`: - Array of xdr of contract spec entries - - `docs`: - Pretty print of contract spec entries - - - + - `xdr-base64`: XDR of array of contract spec entries + - `xdr-base64-array`: Array of xdr of contract spec entries + - `docs`: Pretty print of contract spec entries ## `stellar contract upload` @@ -917,56 +831,54 @@ Install a WASM file to the ledger without creating a contract instance ###### **Build Options:** -* `--package ` — Package to build when --wasm is not provided +- `--package ` — Package to build when --wasm is not provided ###### **Global Options:** -* `--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 +- `--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 ###### **Metadata:** -* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -* `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +- `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` -* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature + +- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` - ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -* `--cost` — Output the cost execution to stderr +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +- `--cost` — Output the cost execution to stderr ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract install` @@ -976,56 +888,54 @@ Install a WASM file to the ledger without creating a contract instance ###### **Build Options:** -* `--package ` — Package to build when --wasm is not provided +- `--package ` — Package to build when --wasm is not provided ###### **Global Options:** -* `--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 +- `--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 ###### **Metadata:** -* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -* `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +- `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` -* `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature + +- `--optimize ` — Optimize the generated wasm. Enabled by default; pass `--optimize=false` to disable. Requires the `additional-libs` feature Default value: `true` Possible values: `true`, `false` - ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -* `--cost` — Output the cost execution to stderr +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +- `--cost` — Output the cost execution to stderr ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract invoke` @@ -1039,56 +949,50 @@ stellar contract invoke ... -- --help ###### **Arguments:** -* `` — Function name as subcommand, then arguments for that function as `--arg-name value` +- `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--id ` — Contract ID to invoke -* `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction -* `--send ` — Whether or not to send a transaction +- `--id ` — Contract ID to invoke +- `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction +- `--send ` — Whether or not to send a transaction Default value: `default` Possible values: - - `default`: - Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result - - `no`: - Do not send transaction, return simulation result - - `yes`: - Always send transaction - + - `default`: Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result + - `no`: Do not send transaction, return simulation result + - `yes`: Always send transaction ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -* `--cost` — Output the cost execution to stderr +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +- `--cost` — Output the cost execution to stderr ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract optimize` @@ -1098,10 +1002,8 @@ stellar contract invoke ... -- --help ###### **Options:** -* `--wasm ` — Path to one or more wasm binaries -* `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) - - +- `--wasm ` — Path to one or more wasm binaries +- `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) ## `stellar contract read` @@ -1111,46 +1013,38 @@ Print the current value of a contract-data ledger entry ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--output ` — Type of output to generate +- `--output ` — Type of output to generate Default value: `string` Possible values: - - `string`: - String - - `json`: - Json - - `xdr`: - XDR - -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability + - `string`: String + - `json`: Json + - `xdr`: XDR + +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - + - `persistent`: Persistent + - `temporary`: Temporary ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract restore` @@ -1162,55 +1056,51 @@ If no keys are specificed the contract itself is restored. ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary + - `persistent`: Persistent + - `temporary`: Temporary -* `--ledgers-to-extend ` — Number of ledgers to extend the entry -* `--ttl-ledger-only` — Only print the new Time To Live ledger +- `--ledgers-to-extend ` — Number of ledgers to extend the entry +- `--ttl-ledger-only` — Only print the new Time To Live ledger ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee -* `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation -* `--cost` — Output the cost execution to stderr +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--resource-fee ` — Set the fee for smart contract resource consumption, in stroops. 1 stroop = 0.0000001 xlm. Overrides the simulated resource fee +- `--instructions ` — ⚠️ Deprecated, use `--instruction-leeway` to increase instructions. Number of instructions to allocate for the transaction +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation +- `--cost` — Output the cost execution to stderr ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar doctor` @@ -1220,9 +1110,7 @@ Diagnose and troubleshoot CLI and network issues ###### **Global Options:** -* `--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 - - +- `--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 events` @@ -1232,63 +1120,58 @@ Watch the network for contract events ###### **FILTERS:** -* `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. +- `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. + + Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. - Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. -* `--topic ` — A set of (up to 5) topic filters to filter event topics on. A single topic filter can contain 1-4 different segments, separated by commas. An asterisk (`*` character) indicates a wildcard segment. +- `--topic ` — A set of (up to 5) topic filters to filter event topics on. A single topic filter can contain 1-4 different segments, separated by commas. An asterisk (`*` character) indicates a wildcard segment. - In addition to up to 4 possible topic filter segments, the "**" wildcard can also be added, and will allow for a flexible number of topics in the returned events. The "**" wildcard must be the last segment in a query. + In addition to up to 4 possible topic filter segments, the "**" wildcard can also be added, and will allow for a flexible number of topics in the returned events. The "**" wildcard must be the last segment in a query. - If the "**" wildcard is not included, only events with the exact number of topics as the given filter will be returned. + If the "\*\*" wildcard is not included, only events with the exact number of topics as the given filter will be returned. - **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` + **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` - **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` + **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` - **Example:** topic filter with four segments and the "**" wildcard: --topic "AAAABQAAAAdDT1VOVEVSAA==,*,*,*,**" + **Example:** topic filter with four segments and the "**" wildcard: --topic "AAAABQAAAAdDT1VOVEVSAA==,_,_,\*,**" - Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). -* `--type ` — Specifies which type of contract events to display + Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). + +- `--type ` — Specifies which type of contract events to display Default value: `all` Possible values: `all`, `contract`, `system` - ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence -* `--cursor ` — The cursor corresponding to the start of the event range -* `--output ` — Output formatting options for event stream +- `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence +- `--cursor ` — The cursor corresponding to the start of the event range +- `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - - `pretty`: - Human-readable output with decoded event names and parameters - - `plain`: - Human-readable output without colors - - `json`: - JSON output with decoded event names and parameters - - `raw`: - Raw event output without self-describing decoding + - `pretty`: Human-readable output with decoded event names and parameters + - `plain`: Human-readable output without colors + - `json`: JSON output with decoded event names and parameters + - `raw`: Raw event output without self-describing decoding -* `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) +- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar env` @@ -1304,15 +1187,13 @@ If there are no environment variables in use, prints the defaults. ###### **Arguments:** -* `` — Env variable name to get the value of. +- `` — Env variable name to get the value of. - E.g.: $ stellar env STELLAR_ACCOUNT + E.g.: $ stellar env STELLAR_ACCOUNT ###### **Global Options:** -* `--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 - - +- `--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` @@ -1322,17 +1203,15 @@ Create and manage identities including keys and addresses ###### **Subcommands:** -* `add` — Add a new identity (keypair, ledger, OS specific secure store) -* `public-key` — Given an identity return its address (public key) -* `fund` — Fund an identity on a test network -* `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store -* `ls` — List identities -* `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 ` - - +- `add` — Add a new identity (keypair, ledger, OS specific secure store) +- `public-key` — Given an identity return its address (public key) +- `fund` — Fund an identity on a test network +- `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store +- `ls` — List identities +- `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 ` ## `stellar keys add` @@ -1342,27 +1221,26 @@ Add a new identity (keypair, ledger, OS specific secure store) ###### **Arguments:** -* `` — Name of identity +- `` — Name of identity ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted -* `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase -* `--secure-store` — Save the new key in your OS's credential secure store. +- `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted +- `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase +- `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - - This only supports seed phrases for now. -* `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. -* `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path`. Persists the derived public key (and `--hd-path`, when provided) so later commands work without the device -* `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry -* `--hd-path ` — When importing a seed phrase, which `hd_path` to derive the key at. Persisted on the identity so later commands derive the same account without re-passing the flag. Not valid with `--public-key` or a raw secret key + On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + This only supports seed phrases for now. +- `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. +- `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path`. Persists the derived public key (and `--hd-path`, when provided) so later commands work without the device +- `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry +- `--hd-path ` — When importing a seed phrase, which `hd_path` to derive the key at. Persisted on the identity so later commands derive the same account without re-passing the flag. Not valid with `--public-key` or a raw secret key ## `stellar keys public-key` @@ -1374,18 +1252,16 @@ Given an identity return its address (public key) ###### **Arguments:** -* `` — Name of identity to lookup. Required unless `--ledger` is provided +- `` — Name of identity to lookup. Required unless `--ledger` is provided ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) -* `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` - - +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) +- `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` ## `stellar keys fund` @@ -1395,25 +1271,23 @@ Fund an identity on a test network ###### **Arguments:** -* `` — Name of identity to lookup. Required unless `--ledger` is provided +- `` — Name of identity to lookup. Required unless `--ledger` is provided ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) -* `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) +- `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar keys generate` @@ -1423,33 +1297,33 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store ###### **Arguments:** -* `` — Name of identity +- `` — Name of identity ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -* `-s`, `--as-secret` — Output the generated identity as a secret key -* `--secure-store` — Save the new key in your OS's credential secure store. +- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +- `-s`, `--as-secret` — Output the generated identity as a secret key +- `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. -* `--hd-path ` — Which `hd_path` to derive the key at from the seed phrase. Honored across all storage modes: with `--as-secret` it picks which derived key is stored, with `--secure-store` or plain seed-phrase storage it is persisted on the identity so later commands derive the same account without re-passing the flag -* `--fund` — Fund generated key pair + On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - Default value: `false` -* `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry +- `--hd-path ` — Which `hd_path` to derive the key at from the seed phrase. Honored across all storage modes: with `--as-secret` it picks which derived key is stored, with `--secure-store` or plain seed-phrase storage it is persisted on the identity so later commands derive the same account without re-passing the flag +- `--fund` — Fund generated key pair -###### **RPC Options:** + Default value: `false` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry +###### **RPC Options:** +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar keys ls` @@ -1459,13 +1333,11 @@ List identities ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `-l`, `--long` - - +- `-l`, `--long` ## `stellar keys rm` @@ -1475,17 +1347,15 @@ Remove an identity ###### **Arguments:** -* `` — Identity to remove +- `` — Identity to remove ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--force` — Skip confirmation prompt - - +- `--force` — Skip confirmation prompt ## `stellar keys secret` @@ -1495,18 +1365,16 @@ Output an identity's secret key ###### **Arguments:** -* `` — Name of identity to lookup, default is test identity +- `` — Name of identity to lookup, default is test identity ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--phrase` — Output seed phrase instead of private key -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 - - +- `--phrase` — Output seed phrase instead of private key +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar keys use` @@ -1516,13 +1384,11 @@ Set the default identity that will be used on all commands. This allows you to s ###### **Arguments:** -* `` — Set the default network name +- `` — Set the default network name ###### **Global Options:** -* `--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 - - +- `--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` @@ -1532,9 +1398,7 @@ Unset the default key identity defined previously with `keys use ` ###### **Global Options:** -* `--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 - - +- `--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` @@ -1544,17 +1408,15 @@ Configure connection to networks ###### **Subcommands:** -* `add` — Add a new network -* `rm` — Remove a network -* `ls` — List networks -* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it -* `health` — Fetch the health of the configured RPC -* `info` — Checks the health of the configured RPC -* `settings` — Fetch the network's config settings -* `unset` — Unset the default network defined previously with `network use ` -* `root-account` — Compute the root account keypair for a network - - +- `add` — Add a new network +- `rm` — Remove a network +- `ls` — List networks +- `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +- `health` — Fetch the health of the configured RPC +- `info` — Checks the health of the configured RPC +- `settings` — Fetch the network's config settings +- `unset` — Unset the default network defined previously with `network use ` +- `root-account` — Compute the root account keypair for a network ## `stellar network add` @@ -1564,19 +1426,17 @@ Add a new network ###### **Arguments:** -* `` — Name of network +- `` — Name of network ###### **Global Options:** -* `--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 +- `--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 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — Optional header to include in requests to the RPC, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — Optional header to include in requests to the RPC, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server ## `stellar network rm` @@ -1586,13 +1446,11 @@ Remove a network ###### **Arguments:** -* `` — Network to remove +- `` — Network to remove ###### **Global Options:** -* `--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 - - +- `--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 ls` @@ -1602,13 +1460,11 @@ List networks ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `-l`, `--long` — Get more info about the networks - - +- `-l`, `--long` — Get more info about the networks ## `stellar network use` @@ -1618,13 +1474,11 @@ Set the default network that will be used on all commands. This allows you to sk ###### **Arguments:** -* `` — Set the default network name +- `` — Set the default network name ###### **Global Options:** -* `--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 - - +- `--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 health` @@ -1634,31 +1488,25 @@ Fetch the health of the configured RPC ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network health status - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - + - `text`: Text output of network health status + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar network info` @@ -1668,31 +1516,25 @@ Checks the health of the configured RPC ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar network settings` @@ -1702,32 +1544,26 @@ Fetch the network's config settings ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network -* `--output ` — Format of the output +- `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network +- `--output ` — Format of the output Default value: `json` Possible values: - - `xdr`: - XDR (`ConfigUpgradeSet` type) - - `json`: - JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - - `json-formatted`: - JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type - + - `xdr`: XDR (`ConfigUpgradeSet` type) + - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar network unset` @@ -1737,9 +1573,7 @@ Unset the default network defined previously with `network use ` ###### **Global Options:** -* `--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 - - +- `--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 root-account` @@ -1749,10 +1583,8 @@ Compute the root account keypair for a network ###### **Subcommands:** -* `public-key` — Output a network's root account address (public key) -* `secret` — Output a network's root account secret key - - +- `public-key` — Output a network's root account address (public key) +- `secret` — Output a network's root account secret key ## `stellar network root-account public-key` @@ -1764,14 +1596,12 @@ Output a network's root account address (public key) ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--network-passphrase ` — Network passphrase to derive the root account from -* `-n`, `--network ` — Name of network to use from config - - +- `--network-passphrase ` — Network passphrase to derive the root account from +- `-n`, `--network ` — Name of network to use from config ## `stellar network root-account secret` @@ -1781,14 +1611,12 @@ Output a network's root account secret key ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--network-passphrase ` — Network passphrase to derive the root account from -* `-n`, `--network ` — Name of network to use from config - - +- `--network-passphrase ` — Network passphrase to derive the root account from +- `-n`, `--network ` — Name of network to use from config ## `stellar container` @@ -1798,11 +1626,9 @@ Start local networks in containers ###### **Subcommands:** -* `logs` — Get logs from a running network container -* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) -* `stop` — Stop a network container started with `stellar container start` - - +- `logs` — Get logs from a running network container +- `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) +- `stop` — Stop a network container started with `stellar container start` ## `stellar container logs` @@ -1812,15 +1638,13 @@ Get logs from a running network container ###### **Arguments:** -* `` — Container to get logs from +- `` — Container to get logs from Default value: `local` ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock - - +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar container start` @@ -1836,23 +1660,21 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Arguments:** -* `` — Network to start. Default is `local` +- `` — Network to start. Default is `local` Possible values: `local`, `testnet`, `futurenet`, `pubnet` - ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -* `--name ` — Optional argument to specify the container name -* `-l`, `--limits ` — Optional argument to specify the limits for the local network only -* `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +- `--name ` — Optional argument to specify the container name +- `-l`, `--limits ` — Optional argument to specify the limits for the local network only +- `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping Default value: `8000:8000` -* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network -* `--protocol-version ` — Optional argument to specify the protocol version for the local network only - +- `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +- `--protocol-version ` — Optional argument to specify the protocol version for the local network only ## `stellar container stop` @@ -1862,15 +1684,13 @@ Stop a network container started with `stellar container start` ###### **Arguments:** -* `` — Container to stop +- `` — Container to stop Default value: `local` ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock - - +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar config` @@ -1880,10 +1700,8 @@ Manage CLI configuration ###### **Subcommands:** -* `migrate` — Migrate the local configuration to the global directory -* `dir` — Show the global configuration directory - - +- `migrate` — Migrate the local configuration to the global directory +- `dir` — Show the global configuration directory ## `stellar config migrate` @@ -1893,9 +1711,7 @@ Migrate the local configuration to the global directory ###### **Global Options:** -* `--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 - - +- `--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 config dir` @@ -1909,9 +1725,7 @@ The location will depend on how your system is configured. ###### **Global Options:** -* `--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 - - +- `--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 snapshot` @@ -1921,10 +1735,8 @@ Download a snapshot of a ledger from an archive ###### **Subcommands:** -* `create` — Create a ledger snapshot using a history archive -* `merge` — Merge multiple ledger snapshots into a single snapshot file - - +- `create` — Create a ledger snapshot using a history archive +- `merge` — Merge multiple ledger snapshots into a single snapshot file ## `stellar snapshot create` @@ -1944,38 +1756,36 @@ Any invalid contract id passed as `--address` will be ignored. ###### **Archive Options:** -* `--archive-url ` — Archive URL +- `--archive-url ` — Archive URL ###### **Filter Options:** -* `--address
` — Account or contract address/alias to include in the snapshot -* `--wasm-hash ` — WASM hashes to include in the snapshot +- `--address
` — Account or contract address/alias to include in the snapshot +- `--wasm-hash ` — WASM hashes to include in the snapshot ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger -* `--output ` — Format of the out file +- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger +- `--output ` — Format of the out file Default value: `json` Possible values: `json` -* `--out ` — Out path that the snapshot is written to +- `--out ` — Out path that the snapshot is written to Default value: `snapshot.json` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar snapshot merge` @@ -1991,16 +1801,14 @@ This allows combining snapshots from different contract deployments or manually ###### **Arguments:** -* `` — Snapshot files to merge (at least 2 required) +- `` — Snapshot files to merge (at least 2 required) ###### **Options:** -* `-o`, `--out ` — Output path for the merged snapshot +- `-o`, `--out ` — Output path for the merged snapshot Default value: `snapshot.json` - - ## `stellar tx` Sign, Simulate, and Send transactions @@ -2009,19 +1817,17 @@ Sign, Simulate, and Send transactions ###### **Subcommands:** -* `update` — Update the transaction -* `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order -* `hash` — Calculate the hash of a transaction envelope -* `new` — Create a new transaction -* `operation` — Manipulate the operations in a transaction, including adding new operations -* `send` — Send a transaction envelope to the network -* `sign` — Sign a transaction envelope appending the signature to the envelope -* `simulate` — Simulate a transaction envelope from stdin -* `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -* `decode` — Decode a transaction envelope from XDR to JSON -* `encode` — Encode a transaction envelope from JSON to XDR - - +- `update` — Update the transaction +- `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order +- `hash` — Calculate the hash of a transaction envelope +- `new` — Create a new transaction +- `operation` — Manipulate the operations in a transaction, including adding new operations +- `send` — Send a transaction envelope to the network +- `sign` — Sign a transaction envelope appending the signature to the envelope +- `simulate` — Simulate a transaction envelope from stdin +- `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned +- `decode` — Decode a transaction envelope from XDR to JSON +- `encode` — Encode a transaction envelope from JSON to XDR ## `stellar tx update` @@ -2031,9 +1837,7 @@ Update the transaction ###### **Subcommands:** -* `sequence-number` — Edit the sequence number on a transaction - - +- `sequence-number` — Edit the sequence number on a transaction ## `stellar tx update sequence-number` @@ -2045,9 +1849,7 @@ Edit the sequence number on a transaction ###### **Subcommands:** -* `next` — Fetch the source account's seq-num and increment for the given tx - - +- `next` — Fetch the source account's seq-num and increment for the given tx ## `stellar tx update sequence-number next` @@ -2057,16 +1859,14 @@ Fetch the source account's seq-num and increment for the given tx ###### **Global Options:** -* `--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 +- `--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 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx edit` @@ -2082,8 +1882,6 @@ $ stellar tx new manage-data --data-name hello --build-only | stellar tx edit **Usage:** `stellar tx edit` - - ## `stellar tx hash` Calculate the hash of a transaction envelope @@ -2092,16 +1890,14 @@ Calculate the hash of a transaction envelope ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx new` @@ -2111,30 +1907,28 @@ Create a new transaction ###### **Subcommands:** -* `account-merge` — Transfer XLM balance to another account and remove source account -* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -* `bump-sequence` — Bump sequence number to invalidate older transactions -* `change-trust` — Create, update, or delete a trustline -* `claim-claimable-balance` — Claim a claimable balance by its balance ID -* `clawback` — Clawback an asset from an account -* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -* `create-account` — Create and fund a new account -* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -* `end-sponsoring-future-reserves` — End sponsoring future reserves -* `liquidity-pool-deposit` — Deposit assets into a liquidity pool -* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -* `manage-buy-offer` — Create, update, or delete a buy offer -* `manage-data` — Set, modify, or delete account data entries -* `manage-sell-offer` — Create, update, or delete a sell offer -* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -* `payment` — Send asset to destination account -* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -* `set-options` — Set account options like flags, signers, and home domain -* `set-trustline-flags` — Configure authorization and trustline flags for an asset - - +- `account-merge` — Transfer XLM balance to another account and remove source account +- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +- `bump-sequence` — Bump sequence number to invalidate older transactions +- `change-trust` — Create, update, or delete a trustline +- `claim-claimable-balance` — Claim a claimable balance by its balance ID +- `clawback` — Clawback an asset from an account +- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +- `create-account` — Create and fund a new account +- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +- `end-sponsoring-future-reserves` — End sponsoring future reserves +- `liquidity-pool-deposit` — Deposit assets into a liquidity pool +- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +- `manage-buy-offer` — Create, update, or delete a buy offer +- `manage-data` — Set, modify, or delete account data entries +- `manage-sell-offer` — Create, update, or delete a sell offer +- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +- `payment` — Send asset to destination account +- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +- `set-options` — Set account options like flags, signers, and home domain +- `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx new account-merge` @@ -2144,35 +1938,33 @@ Transfer XLM balance to another account and remove source account ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new begin-sponsoring-future-reserves` @@ -2182,35 +1974,33 @@ Begin sponsoring future reserves for another account ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--sponsored-id ` — Account that will be sponsored +- `--sponsored-id ` — Account that will be sponsored ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new bump-sequence` @@ -2220,35 +2010,33 @@ Bump sequence number to invalidate older transactions ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--bump-to ` — Sequence number to bump to +- `--bump-to ` — Sequence number to bump to ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new change-trust` @@ -2258,38 +2046,36 @@ Create, update, or delete a trustline ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--line ` -* `--limit ` — Limit for the trust line, 0 to remove the trust line +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new claim-claimable-balance` @@ -2299,35 +2085,33 @@ Claim a claimable balance by its balance ID ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new clawback` @@ -2337,37 +2121,35 @@ Clawback an asset from an account ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--from ` — Account to clawback assets from, e.g. `GBX...` -* `--asset ` — Asset to clawback -* `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset +- `--from ` — Account to clawback assets from, e.g. `GBX...` +- `--asset ` — Asset to clawback +- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new clawback-claimable-balance` @@ -2377,35 +2159,33 @@ Clawback a claimable balance by its balance ID ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new create-account` @@ -2415,38 +2195,36 @@ Create and fund a new account ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--destination ` — Account Id to create, e.g. `GBX...` -* `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +- `--destination ` — Account Id to create, e.g. `GBX...` +- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new create-claimable-balance` @@ -2456,43 +2234,41 @@ Create a claimable balance that can be claimed by specified accounts ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--asset ` — Asset to be held in the ClaimableBalanceEntry +- `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` -* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - Examples: +- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + Examples: + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new create-passive-sell-offer` @@ -2502,38 +2278,36 @@ Create a passive sell offer on the Stellar DEX ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new end-sponsoring-future-reserves` @@ -2543,31 +2317,29 @@ End sponsoring future reserves ###### **Global Options:** -* `--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 +- `--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 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new liquidity-pool-deposit` @@ -2577,43 +2349,42 @@ Deposit assets into a liquidity pool ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--liquidity-pool-id ` — Liquidity pool ID to deposit to -* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--liquidity-pool-id ` — Liquidity pool ID to deposit to +- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` -* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + +- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new liquidity-pool-withdraw` @@ -2623,38 +2394,36 @@ Withdraw assets from a liquidity pool ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--liquidity-pool-id ` — Liquidity pool ID to withdraw from -* `--amount ` — Amount of pool shares to withdraw, in stroops -* `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops -* `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops +- `--liquidity-pool-id ` — Liquidity pool ID to withdraw from +- `--amount ` — Amount of pool shares to withdraw, in stroops +- `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops +- `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new manage-buy-offer` @@ -2664,41 +2433,39 @@ Create, update, or delete a buy offer ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new manage-data` @@ -2708,36 +2475,34 @@ Set, modify, or delete account data entries ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -* `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` +- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new manage-sell-offer` @@ -2747,41 +2512,39 @@ Create, update, or delete a sell offer ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new path-payment-strict-send` @@ -2791,40 +2554,38 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--send-asset ` — Asset to send (pay with) -* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +- `--send-asset ` — Asset to send (pay with) +- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new path-payment-strict-receive` @@ -2834,40 +2595,38 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--send-asset ` — Asset to send (pay with) -* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +- `--send-asset ` — Asset to send (pay with) +- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new payment` @@ -2877,39 +2636,38 @@ Send asset to destination account ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--destination ` — Account to send to, e.g. `GBX...` -* `--asset ` — Asset to send, default native, e.i. XLM +- `--destination ` — Account to send to, e.g. `GBX...` +- `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` -* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) + +- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new revoke-sponsorship` @@ -2919,41 +2677,39 @@ Revoke sponsorship of a ledger entry or signer ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--account-id ` — Account ID (required for all sponsorship types) -* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -* `--data-name ` — Data name for data entry sponsorship -* `--offer-id ` — Offer ID for offer sponsorship -* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -* `--signer-key ` — Signer key for signer sponsorship +- `--account-id ` — Account ID (required for all sponsorship types) +- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +- `--data-name ` — Data name for data entry sponsorship +- `--offer-id ` — Offer ID for offer sponsorship +- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--signer-key ` — Signer key for signer sponsorship ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new set-options` @@ -2963,50 +2719,48 @@ Set account options like flags, signers, and home domain ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--inflation-dest ` — Account of the inflation destination -* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -* `--signer ` — Add, update, or remove a signer from an account -* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -* `--clear-required` -* `--clear-revocable` -* `--clear-immutable` -* `--clear-clawback-enabled` +- `--inflation-dest ` — Account of the inflation destination +- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +- `--signer ` — Add, update, or remove a signer from an account +- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +- `--clear-required` +- `--clear-revocable` +- `--clear-immutable` +- `--clear-clawback-enabled` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new set-trustline-flags` @@ -3016,42 +2770,40 @@ Configure authorization and trustline flags for an asset ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -* `--asset ` — Asset to set trustline flags for -* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -* `--clear-authorize` -* `--clear-authorize-to-maintain-liabilities` -* `--clear-trustline-clawback-enabled` +- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +- `--asset ` — Asset to set trustline flags for +- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +- `--clear-authorize` +- `--clear-authorize-to-maintain-liabilities` +- `--clear-trustline-clawback-enabled` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation` @@ -3063,9 +2815,7 @@ Manipulate the operations in a transaction, including adding new operations ###### **Subcommands:** -* `add` — Add Operation to a transaction - - +- `add` — Add Operation to a transaction ## `stellar tx operation add` @@ -3075,30 +2825,28 @@ Add Operation to a transaction ###### **Subcommands:** -* `account-merge` — Transfer XLM balance to another account and remove source account -* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -* `bump-sequence` — Bump sequence number to invalidate older transactions -* `change-trust` — Create, update, or delete a trustline -* `claim-claimable-balance` — Claim a claimable balance by its balance ID -* `clawback` — Clawback an asset from an account -* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -* `create-account` — Create and fund a new account -* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -* `end-sponsoring-future-reserves` — End sponsoring future reserves -* `liquidity-pool-deposit` — Deposit assets into a liquidity pool -* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -* `manage-buy-offer` — Create, update, or delete a buy offer -* `manage-data` — Set, modify, or delete account data entries -* `manage-sell-offer` — Create, update, or delete a sell offer -* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -* `payment` — Send asset to destination account -* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -* `set-options` — Set account options like flags, signers, and home domain -* `set-trustline-flags` — Configure authorization and trustline flags for an asset - - +- `account-merge` — Transfer XLM balance to another account and remove source account +- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +- `bump-sequence` — Bump sequence number to invalidate older transactions +- `change-trust` — Create, update, or delete a trustline +- `claim-claimable-balance` — Claim a claimable balance by its balance ID +- `clawback` — Clawback an asset from an account +- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +- `create-account` — Create and fund a new account +- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +- `end-sponsoring-future-reserves` — End sponsoring future reserves +- `liquidity-pool-deposit` — Deposit assets into a liquidity pool +- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +- `manage-buy-offer` — Create, update, or delete a buy offer +- `manage-data` — Set, modify, or delete account data entries +- `manage-sell-offer` — Create, update, or delete a sell offer +- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +- `payment` — Send asset to destination account +- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +- `set-options` — Set account options like flags, signers, and home domain +- `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx operation add account-merge` @@ -3108,40 +2856,38 @@ Transfer XLM balance to another account and remove source account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add begin-sponsoring-future-reserves` @@ -3151,40 +2897,38 @@ Begin sponsoring future reserves for another account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--sponsored-id ` — Account that will be sponsored +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--sponsored-id ` — Account that will be sponsored ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add bump-sequence` @@ -3194,40 +2938,38 @@ Bump sequence number to invalidate older transactions ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--bump-to ` — Sequence number to bump to +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--bump-to ` — Sequence number to bump to ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add change-trust` @@ -3237,43 +2979,41 @@ Create, update, or delete a trustline ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--line ` -* `--limit ` — Limit for the trust line, 0 to remove the trust line +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add claim-claimable-balance` @@ -3283,40 +3023,38 @@ Claim a claimable balance by its balance ID ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add clawback` @@ -3326,42 +3064,40 @@ Clawback an asset from an account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--from ` — Account to clawback assets from, e.g. `GBX...` -* `--asset ` — Asset to clawback -* `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--from ` — Account to clawback assets from, e.g. `GBX...` +- `--asset ` — Asset to clawback +- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add clawback-claimable-balance` @@ -3371,40 +3107,38 @@ Clawback a claimable balance by its balance ID ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add create-account` @@ -3414,43 +3148,41 @@ Create and fund a new account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--destination ` — Account Id to create, e.g. `GBX...` -* `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--destination ` — Account Id to create, e.g. `GBX...` +- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add create-claimable-balance` @@ -3460,48 +3192,46 @@ Create a claimable balance that can be claimed by specified accounts ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--asset ` — Asset to be held in the ClaimableBalanceEntry +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` -* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - Examples: +- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + Examples: + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add create-passive-sell-offer` @@ -3511,43 +3241,41 @@ Create a passive sell offer on the Stellar DEX ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add end-sponsoring-future-reserves` @@ -3557,39 +3285,37 @@ End sponsoring future reserves ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add liquidity-pool-deposit` @@ -3599,48 +3325,47 @@ Deposit assets into a liquidity pool ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--liquidity-pool-id ` — Liquidity pool ID to deposit to -* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--liquidity-pool-id ` — Liquidity pool ID to deposit to +- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` -* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + +- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add liquidity-pool-withdraw` @@ -3650,43 +3375,41 @@ Withdraw assets from a liquidity pool ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--liquidity-pool-id ` — Liquidity pool ID to withdraw from -* `--amount ` — Amount of pool shares to withdraw, in stroops -* `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops -* `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--liquidity-pool-id ` — Liquidity pool ID to withdraw from +- `--amount ` — Amount of pool shares to withdraw, in stroops +- `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops +- `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add manage-buy-offer` @@ -3696,46 +3419,44 @@ Create, update, or delete a buy offer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add manage-data` @@ -3745,41 +3466,39 @@ Set, modify, or delete account data entries ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -* `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add manage-sell-offer` @@ -3789,46 +3508,44 @@ Create, update, or delete a sell offer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add path-payment-strict-receive` @@ -3838,45 +3555,43 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--send-asset ` — Asset to send (pay with) -* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--send-asset ` — Asset to send (pay with) +- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add path-payment-strict-send` @@ -3886,45 +3601,43 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--send-asset ` — Asset to send (pay with) -* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--send-asset ` — Asset to send (pay with) +- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add payment` @@ -3934,44 +3647,43 @@ Send asset to destination account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--destination ` — Account to send to, e.g. `GBX...` -* `--asset ` — Asset to send, default native, e.i. XLM +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--destination ` — Account to send to, e.g. `GBX...` +- `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` -* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) + +- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add revoke-sponsorship` @@ -3981,46 +3693,44 @@ Revoke sponsorship of a ledger entry or signer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--account-id ` — Account ID (required for all sponsorship types) -* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -* `--data-name ` — Data name for data entry sponsorship -* `--offer-id ` — Offer ID for offer sponsorship -* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -* `--signer-key ` — Signer key for signer sponsorship +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--account-id ` — Account ID (required for all sponsorship types) +- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +- `--data-name ` — Data name for data entry sponsorship +- `--offer-id ` — Offer ID for offer sponsorship +- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--signer-key ` — Signer key for signer sponsorship ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add set-options` @@ -4030,55 +3740,53 @@ Set account options like flags, signers, and home domain ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--inflation-dest ` — Account of the inflation destination -* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -* `--signer ` — Add, update, or remove a signer from an account -* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -* `--clear-required` -* `--clear-revocable` -* `--clear-immutable` -* `--clear-clawback-enabled` +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--inflation-dest ` — Account of the inflation destination +- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +- `--signer ` — Add, update, or remove a signer from an account +- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +- `--clear-required` +- `--clear-revocable` +- `--clear-immutable` +- `--clear-clawback-enabled` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx operation add set-trustline-flags` @@ -4088,47 +3796,45 @@ Configure authorization and trustline flags for an asset ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -* `--asset ` — Asset to set trustline flags for -* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -* `--clear-authorize` -* `--clear-authorize-to-maintain-liabilities` -* `--clear-trustline-clawback-enabled` +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +- `--asset ` — Asset to set trustline flags for +- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +- `--clear-authorize` +- `--clear-authorize-to-maintain-liabilities` +- `--clear-trustline-clawback-enabled` ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx send` @@ -4138,20 +3844,18 @@ Send a transaction envelope to the network ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx sign` @@ -4161,28 +3865,26 @@ Sign a transaction envelope appending the signature to the envelope ###### **Arguments:** -* `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries - - +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ## `stellar tx simulate` @@ -4192,77 +3894,68 @@ Simulate a transaction envelope from stdin ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--auto-sign` — Sign without prompting for approval. Only applies to signatures that require user approval, like non-root Soroban auth entries ###### **Transaction Options:** -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -* `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - - +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -**Usage:** `stellar tx fetch [OPTIONS] - fetch ` +**Usage:** `stellar tx fetch [OPTIONS] fetch ` ###### **Subcommands:** -* `result` — Fetch the transaction result -* `meta` — Fetch the transaction meta -* `fee` — Fetch the transaction fee information -* `events` — Fetch the transaction events +- `result` — Fetch the transaction result +- `meta` — Fetch the transaction meta +- `fee` — Fetch the transaction fee information +- `events` — Fetch the transaction events ###### **Options:** -* `--hash ` — Hash of transaction to fetch -* `--output ` — Format of the output +- `--hash ` — Hash of transaction to fetch +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - + - `json`: JSON output with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx fetch result` @@ -4272,28 +3965,22 @@ Fetch the transaction result ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--output ` — Format of the output +- `--hash ` — Transaction hash to fetch +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - + - `json`: JSON output with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx fetch meta` @@ -4303,28 +3990,22 @@ Fetch the transaction meta ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--output ` — Format of the output +- `--hash ` — Transaction hash to fetch +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - + - `json`: JSON output with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx fetch fee` @@ -4334,28 +4015,22 @@ Fetch the transaction fee information ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--output ` — Output format for fee command +- `--hash ` — Transaction hash to fetch +- `--output ` — Output format for fee command Default value: `table` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `table`: - Formatted in a table comparing fee types - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `table`: Formatted in a table comparing fee types ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx fetch events` @@ -4365,28 +4040,22 @@ Fetch the transaction events ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--output ` — Format of the output +- `--hash ` — Transaction hash to fetch +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the events with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of events with parsed XDRs - - `text`: - Human readable event output with parsed XDRs - + - `json`: JSON output of the events with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of events with parsed XDRs + - `text`: Human readable event output with parsed XDRs ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx decode` @@ -4396,25 +4065,22 @@ Decode a transaction envelope from XDR to JSON ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `single-base64` Possible values: `single-base64`, `single` -* `--output ` +- `--output ` Default value: `json` Possible values: `json`, `json-formatted` - - - ## `stellar tx encode` Encode a transaction envelope from JSON to XDR @@ -4423,25 +4089,22 @@ Encode a transaction envelope from JSON to XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `json` Possible values: `json` -* `--output ` +- `--output ` Default value: `single-base64` Possible values: `single-base64`, `single` - - - ## `stellar xdr` Decode and encode XDR @@ -4450,26 +4113,23 @@ Decode and encode XDR ###### **Subcommands:** -* `types` — View information about types -* `guess` — Guess the XDR type -* `decode` — Decode XDR -* `encode` — Encode XDR -* `compare` — Compare two XDR values with each other -* `generate` — Generate XDR values -* `xfile` — Preprocess XDR .x files -* `version` — Print version information +- `types` — View information about types +- `guess` — Guess the XDR type +- `decode` — Decode XDR +- `encode` — Encode XDR +- `compare` — Compare two XDR values with each other +- `generate` — Generate XDR values +- `xfile` — Preprocess XDR .x files +- `version` — Print version information ###### **Arguments:** -* `` — Channel of XDR to operate on +- `` — Channel of XDR to operate on Default value: `+curr` Possible values: `+curr`, `+next` - - - ## `stellar xdr types` View information about types @@ -4478,11 +4138,9 @@ View information about types ###### **Subcommands:** -* `list` — -* `schema` — -* `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory - - +- `list` — +- `schema` — +- `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory ## `stellar xdr types list` @@ -4490,31 +4148,25 @@ View information about types ###### **Options:** -* `--output ` +- `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` - - - ## `stellar xdr types schema` **Usage:** `stellar xdr types schema [OPTIONS] --type ` ###### **Options:** -* `--type ` — XDR type to generate schema for -* `--output ` +- `--type ` — XDR type to generate schema for +- `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` - - - ## `stellar xdr types schema-files` Generate JSON schema files for the XDR types, writing a file for each type to the out directory @@ -4523,16 +4175,13 @@ Generate JSON schema files for the XDR types, writing a file for each type to th ###### **Options:** -* `--out-dir ` -* `--output ` +- `--out-dir ` +- `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` - - - ## `stellar xdr guess` Guess the XDR type. @@ -4543,28 +4192,26 @@ Prints a list of types that the XDR values can be decoded into. ###### **Arguments:** -* `` — XDR or file containing XDR to decode, or stdin if empty +- `` — XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -* `--output ` +- `--output ` Default value: `list` Possible values: `list` -* `--certainty ` — Certainty as an arbitrary value +- `--certainty ` — Certainty as an arbitrary value Default value: `2` - - ## `stellar xdr decode` Decode XDR @@ -4573,26 +4220,23 @@ Decode XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--type ` — XDR type to decode -* `--input ` +- `--type ` — XDR type to decode +- `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -* `--output ` +- `--output ` Default value: `json` Possible values: `json`, `json-formatted`, `text`, `rust-debug`, `rust-debug-formatted` - - - ## `stellar xdr encode` Encode XDR @@ -4601,26 +4245,23 @@ Encode XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--type ` — XDR type to encode -* `--input ` +- `--type ` — XDR type to encode +- `--input ` Default value: `json` Possible values: `json` -* `--output ` +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream` - - - ## `stellar xdr compare` Compare two XDR values with each other @@ -4631,21 +4272,18 @@ Outputs: `-1` when the left XDR value is less than the right XDR value, `0` when ###### **Arguments:** -* `` — XDR file to decode and compare with the right value -* `` — XDR file to decode and compare with the left value +- `` — XDR file to decode and compare with the right value +- `` — XDR file to decode and compare with the left value ###### **Options:** -* `--type ` — XDR type of both inputs -* `--input ` +- `--type ` — XDR type of both inputs +- `--input ` Default value: `single-base64` Possible values: `single`, `single-base64` - - - ## `stellar xdr generate` Generate XDR values @@ -4654,10 +4292,8 @@ Generate XDR values ###### **Subcommands:** -* `default` — Generate default XDR values -* `arbitrary` — Generate arbitrary XDR values - - +- `default` — Generate default XDR values +- `arbitrary` — Generate arbitrary XDR values ## `stellar xdr generate default` @@ -4667,16 +4303,13 @@ Generate default XDR values ###### **Options:** -* `--type ` — XDR type to generate -* `--output ` +- `--type ` — XDR type to generate +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` - - - ## `stellar xdr generate arbitrary` Generate arbitrary XDR values @@ -4685,16 +4318,13 @@ Generate arbitrary XDR values ###### **Options:** -* `--type ` — XDR type to generate -* `--output ` +- `--type ` — XDR type to generate +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` - - - ## `stellar xdr xfile` Preprocess XDR .x files @@ -4703,9 +4333,7 @@ Preprocess XDR .x files ###### **Subcommands:** -* `preprocess` — Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directives - - +- `preprocess` — Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directives ## `stellar xdr xfile preprocess` @@ -4715,14 +4343,12 @@ Preprocess XDR .x files by evaluating #ifdef/#ifndef/#elif/#else/#endif directiv ###### **Arguments:** -* `` — XDR .x file to preprocess, or stdin if omitted +- `` — XDR .x file to preprocess, or stdin if omitted ###### **Options:** -* `--features ` — Features/symbols to define -* `--all-features` — Enable all features/symbols found in the input - - +- `--features ` — Features/symbols to define +- `--all-features` — Enable all features/symbols found in the input ## `stellar xdr version` @@ -4730,8 +4356,6 @@ Print version information **Usage:** `stellar xdr version` - - ## `stellar strkey` Decode and encode strkey @@ -4740,12 +4364,10 @@ Decode and encode strkey ###### **Subcommands:** -* `decode` — Decode strkey -* `encode` — Encode strkey -* `zero` — Generate the zero strkey -* `version` — Print version information - - +- `decode` — Decode strkey +- `encode` — Encode strkey +- `zero` — Generate the zero strkey +- `version` — Print version information ## `stellar strkey decode` @@ -4755,9 +4377,7 @@ Decode strkey ###### **Arguments:** -* `` — Strkey to decode - - +- `` — Strkey to decode ## `stellar strkey encode` @@ -4767,9 +4387,7 @@ Encode strkey ###### **Arguments:** -* `` — JSON for Strkey to encode - - +- `` — JSON for Strkey to encode ## `stellar strkey zero` @@ -4779,30 +4397,24 @@ Generate the zero strkey ###### **Arguments:** -* `` — Strkey type to generate the zero value for +- `` — 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 format +- `--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 @@ -4813,18 +4425,14 @@ To enable autocomplete in the current bash shell, run: `source <(stellar complet To enable autocomplete permanently, run: `echo "source <(stellar completion --shell bash)" >> ~/.bashrc` - **Usage:** `stellar completion --shell ` ###### **Options:** -* `--shell ` — The shell type +- `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` - - - ## `stellar cache` Cache for transactions and contract specs @@ -4833,11 +4441,9 @@ Cache for transactions and contract specs ###### **Subcommands:** -* `clean` — Delete the cache -* `path` — Show the location of the cache -* `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) - - +- `clean` — Delete the cache +- `path` — Show the location of the cache +- `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) ## `stellar cache clean` @@ -4845,16 +4451,12 @@ Delete the cache **Usage:** `stellar cache clean` - - ## `stellar cache path` Show the location of the cache **Usage:** `stellar cache path` - - ## `stellar cache actionlog` Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) @@ -4863,10 +4465,8 @@ Access details about cached actions like transactions, and simulations. (Experim ###### **Subcommands:** -* `ls` — List cached actions (transactions, simulations) -* `read` — Read cached action - - +- `ls` — List cached actions (transactions, simulations) +- `read` — Read cached action ## `stellar cache actionlog ls` @@ -4876,13 +4476,11 @@ List cached actions (transactions, simulations) ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `-l`, `--long` - - +- `-l`, `--long` ## `stellar cache actionlog read` @@ -4892,9 +4490,7 @@ Read cached action ###### **Options:** -* `--id ` — ID of the cache entry - - +- `--id ` — ID of the cache entry ## `stellar version` @@ -4904,11 +4500,9 @@ Print version information ###### **Options:** -* `--only-version` — Print only the version -* `--only-version-major` — Print only the major version -* `--only-commit` — Print only the commit sha - - +- `--only-version` — Print only the version +- `--only-version-major` — Print only the major version +- `--only-commit` — Print only the commit sha ## `stellar plugin` @@ -4918,10 +4512,8 @@ The subcommand for CLI plugins ###### **Subcommands:** -* `search` — Search for CLI plugins using GitHub -* `ls` — List installed plugins - - +- `search` — Search for CLI plugins using GitHub +- `ls` — List installed plugins ## `stellar plugin search` @@ -4929,16 +4521,12 @@ Search for CLI plugins using GitHub **Usage:** `stellar plugin search` - - ## `stellar plugin ls` List installed plugins **Usage:** `stellar plugin ls` - - ## `stellar ledger` Fetch ledger information @@ -4947,11 +4535,9 @@ Fetch ledger information ###### **Subcommands:** -* `entry` — Work with ledger entries -* `latest` — Get the latest ledger sequence and information from the network -* `fetch` — - - +- `entry` — Work with ledger entries +- `latest` — Get the latest ledger sequence and information from the network +- `fetch` — ## `stellar ledger entry` @@ -4961,9 +4547,7 @@ Work with ledger entries ###### **Subcommands:** -* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) - - +- `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) ## `stellar ledger entry fetch` @@ -4973,16 +4557,14 @@ Fetch ledger entries. This command supports all types of ledger entries supporte ###### **Subcommands:** -* `account` — Fetch account entry by public key or alias -* `contract-data` — Fetch contract ledger entry by address or alias and storage key -* `claimable-balance` — Fetch a claimable balance ledger entry by id -* `liquidity-pool` — Fetch a liquidity pool ledger entry by id -* `contract-code` — Fetch a Contract's WASM bytecode by WASM hash -* `trustline` — Fetch a trustline by account and asset -* `data` — Fetch key-value data entries attached to an account (see manageDataOp) -* `offer` — Fetch an offer by account and offer id - - +- `account` — Fetch account entry by public key or alias +- `contract-data` — Fetch contract ledger entry by address or alias and storage key +- `claimable-balance` — Fetch a claimable balance ledger entry by id +- `liquidity-pool` — Fetch a liquidity pool ledger entry by id +- `contract-code` — Fetch a Contract's WASM bytecode by WASM hash +- `trustline` — Fetch a trustline by account and asset +- `data` — Fetch key-value data entries attached to an account (see manageDataOp) +- `offer` — Fetch an offer by account and offer id ## `stellar ledger entry fetch account` @@ -4992,33 +4574,28 @@ Fetch account entry by public key or alias ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--account ` — Account alias or address to lookup -* `--output ` — Format of the output +- `--account ` — Account alias or address to lookup +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger entry fetch contract-data` @@ -5028,45 +4605,38 @@ Fetch contract ledger entry by address or alias and storage key ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--contract ` — Contract alias or address to fetch -* `--output ` — Format of the output +- `--contract ` — Contract alias or address to fetch +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) -* `--durability ` — Storage entry durability +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary + - `persistent`: Persistent + - `temporary`: Temporary -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--instance` — If the contract instance ledger entry should be included in the output +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--instance` — If the contract instance ledger entry should be included in the output ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger entry fetch claimable-balance` @@ -5076,32 +4646,26 @@ Fetch a claimable balance ledger entry by id ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--id ` — Claimable Balance Ids to fetch an entry for -* `--output ` — Format of the output +- `--id ` — Claimable Balance Ids to fetch an entry for +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger entry fetch liquidity-pool` @@ -5111,32 +4675,26 @@ Fetch a liquidity pool ledger entry by id ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--id ` — Liquidity pool ids -* `--output ` — Format of the output +- `--id ` — Liquidity pool ids +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger entry fetch contract-code` @@ -5146,32 +4704,26 @@ Fetch a Contract's WASM bytecode by WASM hash ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--wasm-hash ` — Get WASM bytecode by hash -* `--output ` — Format of the output +- `--wasm-hash ` — Get WASM bytecode by hash +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger entry fetch trustline` @@ -5181,34 +4733,29 @@ Fetch a trustline by account and asset ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) -* `--account ` — Account alias or address to lookup -* `--asset ` — Assets to get trustline info for -* `--hd-path ` — If account is a seed phrase use this hd path, default is 0 +- `--account ` — Account alias or address to lookup +- `--asset ` — Assets to get trustline info for +- `--hd-path ` — If account is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger entry fetch data` @@ -5218,34 +4765,29 @@ Fetch key-value data entries attached to an account (see manageDataOp) ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) -* `--account ` — Account alias or address to lookup -* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--account ` — Account alias or address to lookup +- `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger entry fetch offer` @@ -5255,34 +4797,29 @@ Fetch an offer by account and offer id ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) -* `--account ` — Account alias or address to lookup -* `--offer ` — ID of an offer made on the Stellar DEX -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--account ` — Account alias or address to lookup +- `--offer ` — ID of an offer made on the Stellar DEX +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger latest` @@ -5292,27 +4829,21 @@ Get the latest ledger sequence and information from the network ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar ledger fetch` @@ -5320,44 +4851,37 @@ Get the latest ledger sequence and information from the network ###### **Arguments:** -* `` — Ledger Sequence to start fetch (inclusive) +- `` — Ledger Sequence to start fetch (inclusive) ###### **Options:** -* `--limit ` — Number of ledgers to fetch +- `--limit ` — Number of ledgers to fetch Default value: `1` -* `--output ` — Format of the output + +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request -* `--xdr-format ` — Format of the xdr in the output +- `--xdr-format ` — Format of the xdr in the output Default value: `json` Possible values: - - `json`: - XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields - - `xdr`: - XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields - + - `json`: XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields + - `xdr`: XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar message` @@ -5367,10 +4891,8 @@ Sign and verify arbitrary messages using SEP-53 ###### **Subcommands:** -* `sign` — Sign an arbitrary message using SEP-53 -* `verify` — Verify a SEP-53 signed message - - +- `sign` — Sign an arbitrary message using SEP-53 +- `verify` — Verify a SEP-53 signed message ## `stellar message sign` @@ -5384,22 +4906,20 @@ Example: stellar message sign "Hello, World!" --sign-with-key alice ###### **Arguments:** -* `` — The message to sign. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically +- `` — The message to sign. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--base64` — Treat the message as base64-encoded binary data +- `--base64` — Treat the message as base64-encoded binary data ###### **Signing Options:** -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - - +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` ## `stellar message verify` @@ -5413,20 +4933,18 @@ Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public- ###### **Arguments:** -* `` — The message to verify. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically +- `` — The message to verify. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--base64` — Treat the message as base64-encoded binary data -* `-s`, `--signature ` — The base64-encoded signature to verify -* `-p`, `--public-key ` — The public key to verify the signature against. Can be an identity (--public-key alice), a public key (--public-key GDKW...) -* `--hd-path ` — If public key identity is a seed phrase use this hd path, default is 0 - - +- `--base64` — Treat the message as base64-encoded binary data +- `-s`, `--signature ` — The base64-encoded signature to verify +- `-p`, `--public-key ` — The public key to verify the signature against. Can be an identity (--public-key alice), a public key (--public-key GDKW...) +- `--hd-path ` — If public key identity is a seed phrase use this hd path, default is 0 ## `stellar fee-stats` @@ -5436,27 +4954,21 @@ Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public- ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar fees` @@ -5466,11 +4978,9 @@ Fetch network feestats and configure CLI fee settings ###### **Subcommands:** -* `stats` — Fetch the feestats from the network -* `use` — Set the default inclusion fee settings for the CLI -* `unset` — Remove the default inclusion fee settings for the CLI - - +- `stats` — Fetch the feestats from the network +- `use` — Set the default inclusion fee settings for the CLI +- `unset` — Remove the default inclusion fee settings for the CLI ## `stellar fees stats` @@ -5480,27 +4990,21 @@ Fetch the feestats from the network ###### **Options:** -* `--output ` — Format of the output +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar fees use` @@ -5510,24 +5014,21 @@ Set the default inclusion fee settings for the CLI ###### **Global Options:** -* `--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 +- `--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 ###### **Options:** -* `--amount ` — Set the default inclusion fee amount, in stroops. 1 stroop = 0.0000001 xlm -* `--fee-metric ` — Set the default inclusion fee based on a metric from the network's fee stats +- `--amount ` — Set the default inclusion fee amount, in stroops. 1 stroop = 0.0000001 xlm +- `--fee-metric ` — Set the default inclusion fee based on a metric from the network's fee stats Possible values: `max`, `min`, `mode`, `p10`, `p20`, `p30`, `p40`, `p50`, `p60`, `p70`, `p80`, `p90`, `p95`, `p99` - ###### **RPC Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar fees unset` @@ -5537,7 +5038,4 @@ Remove the default inclusion fee settings for the CLI ###### **Global Options:** -* `--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 - - - +- `--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 From 67689f35ade506cfe720c02f2fe77e3d93c56c14 Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Thu, 28 May 2026 21:24:12 +0000 Subject: [PATCH 4/4] enforce mutually exclusive --only-* version flags --- cmd/soroban-cli/src/commands/version.rs | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/cmd/soroban-cli/src/commands/version.rs b/cmd/soroban-cli/src/commands/version.rs index 62ae55a78b..96689456ed 100644 --- a/cmd/soroban-cli/src/commands/version.rs +++ b/cmd/soroban-cli/src/commands/version.rs @@ -5,13 +5,13 @@ use std::fmt::Debug; #[group(skip)] pub struct Cmd { /// Print only the version. - #[arg(long)] + #[arg(long, group = "only")] only_version: bool, /// Print only the major version. - #[arg(long)] + #[arg(long, group = "only")] only_version_major: bool, /// Print only the commit sha. - #[arg(long)] + #[arg(long, group = "only")] only_commit: bool, }