From a4d0a11d0c841f814e84496a671d51be6984dee6 Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Mon, 3 Nov 2025 11:28:45 +1000 Subject: [PATCH 1/6] group CLI options into sections in help docs --- .github/workflows/rust.yml | 4 +- Cargo.lock | 3 +- FULL_HELP_DOCS.md | 1760 +++++++++++++++++++++++------------- Makefile | 2 +- cmd/soroban-cli/Cargo.toml | 7 +- 5 files changed, 1141 insertions(+), 635 deletions(-) diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 17e85a73fd..115eb77733 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -156,7 +156,7 @@ jobs: - os: macos-13 target: x86_64-apple-darwin cargo-hack-feature-options: - --feature-powerset --skip emulator-tests + --feature-powerset --skip emulator-tests, - os: macos-latest target: aarch64-apple-darwin cargo-hack-feature-options: @@ -185,5 +185,5 @@ jobs: with: runs-on: ${{ matrix.os }} target: ${{ matrix.target }} - cargo-hack-feature-options: ${{ matrix.cargo-hack-feature-options }} + cargo-hack-feature-options: ${{ matrix.cargo-hack-feature-options }} --skip doc-gen additional-deb-packages: ${{ matrix.additional-deb-packages }} diff --git a/Cargo.lock b/Cargo.lock index 62c5f64a9f..471ff45118 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -875,8 +875,7 @@ dependencies = [ [[package]] name = "clap-markdown" version = "0.1.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d2a2617956a06d4885b490697b5307ebb09fec10b088afc18c81762d848c2339" +source = "git+https://github.com/ConnorGray/clap-markdown?rev=42956b342cef3325d9060fc43995d595e7c8aa66#42956b342cef3325d9060fc43995d595e7c8aa66" dependencies = [ "clap", ] diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index dd096f9ce9..03e5e1864b 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -62,13 +62,16 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c ###### **Options:** +- `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. 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 -- `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` - `--no-cache` — Do not cache your simulations and transactions ## `stellar contract` @@ -117,12 +120,18 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a ###### **Options:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 asset deploy` @@ -133,17 +142,24 @@ Deploy builtin Soroban Asset Contract ###### **Options:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 +- `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -152,7 +168,6 @@ Deploy builtin Soroban Asset Contract - `--instructions ` — Number of instructions to simulate - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--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 ## `stellar contract alias` @@ -177,10 +192,13 @@ Remove contract alias - `` — The contract alias that will be removed -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server @@ -198,14 +216,20 @@ Add contract alias ###### **Options:** +- `--overwrite` — Overwrite the contract alias if it already exists +- `--id ` — The contract id that will be associated with the alias + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--overwrite` — Overwrite the contract alias if it already exists -- `--id ` — The contract id that will be associated with the alias ## `stellar contract alias show` @@ -217,10 +241,13 @@ Show the contract id associated with a given alias - `` — The contract alias that will be displayed -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server @@ -232,7 +259,7 @@ List all aliases **Usage:** `stellar contract alias ls [OPTIONS]` -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -285,14 +312,20 @@ Generate a TypeScript / JavaScript package - `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output-dir ` — Where to place generated project -- `--overwrite` — Whether to overwrite output directory if it already exists ## `stellar contract bindings python` @@ -336,6 +369,16 @@ To view the commands that will be executed, without executing them, use the --pr **Usage:** `stellar contract build [OPTIONS]` +###### **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 + +###### **Metadata:** + +- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) + ###### **Options:** - `--manifest-path ` — Path to Cargo.toml @@ -347,19 +390,18 @@ To view the commands that will be executed, without executing them, use the --pr Default value: `release` -- `--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 - `--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. -- `--print-commands-only` — Print commands to build without executing them -- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) - `--optimize` — Optimize the generated wasm +###### **Other:** + +- `--print-commands-only` — Print commands to build without executing them + ## `stellar contract extend` Extend the time to live ledger of a contract-data ledger entry. @@ -385,17 +427,23 @@ If no keys are specified the contract itself is extended. - `persistent`: Persistent - `temporary`: Temporary -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -419,18 +467,29 @@ Deploy a wasm contract - `--wasm ` — WASM file to deploy - `--wasm-hash ` — Hash of the already installed/deployed WASM file -- `--salt ` — Custom salt 32-byte salt for the token id -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 +- `-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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--salt ` — Custom salt 32-byte salt for the token id +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -439,11 +498,6 @@ Deploy a wasm contract - `--instructions ` — Number of instructions to simulate - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `-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 ## `stellar contract fetch` @@ -456,8 +510,14 @@ Fetch a contract's Wasm binary - `--id ` — Contract ID to fetch - `--wasm-hash ` — Wasm to fetch - `-o`, `--out-file ` — Where to write output otherwise stdout is used + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server @@ -483,12 +543,18 @@ Deploy builtin Soroban Asset Contract ###### **Options:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 id wasm` @@ -499,18 +565,24 @@ Deploy normal Wasm Contract ###### **Options:** - `--salt ` — ID of the Soroban contract -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Access info about contracts @@ -541,12 +613,6 @@ Outputs no data when no data is present in the contract. - `--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-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--output ` — Format of the output Default value: `rust` @@ -557,6 +623,18 @@ Outputs no data when no data is present in the contract. - `json`: JSON output of the info entry (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the info entry +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Output the metadata stored in a contract. @@ -574,12 +652,6 @@ Outputs no data when no data is present in the contract. - `--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-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--output ` — Format of the output Default value: `text` @@ -590,6 +662,18 @@ Outputs no data when no data is present in the contract. - `json`: JSON output of the info entry (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the info entry +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Output the env required metadata stored in a contract. @@ -607,12 +691,6 @@ Outputs no data when no data is present in the contract. - `--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-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--output ` — Format of the output Default value: `text` @@ -623,6 +701,18 @@ Outputs no data when no data is present in the contract. - `json`: JSON output of the info entry (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the info entry +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Output the contract build information, if available. @@ -636,12 +726,18 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma - `--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` + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 init` @@ -681,6 +777,8 @@ This command will create a Cargo workspace project and add a sample Stellar cont - `xdr-base64-array`: Array of xdr of contract spec entries - `docs`: Pretty print of contract spec entries +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -692,17 +790,27 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 +- `--wasm ` — Path to wasm binary +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + + Default value: `false` + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -711,10 +819,6 @@ Install a WASM file to the ledger without creating a contract instance - `--instructions ` — Number of instructions to simulate - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--wasm ` — Path to wasm binary -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts - - Default value: `false` ## `stellar contract install` @@ -724,17 +828,27 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 +- `--wasm ` — Path to wasm binary +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + + Default value: `false` + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -743,10 +857,6 @@ Install a WASM file to the ledger without creating a contract instance - `--instructions ` — Number of instructions to simulate - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--wasm ` — Path to wasm binary -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts - - Default value: `false` ## `stellar contract invoke` @@ -766,25 +876,11 @@ stellar contract invoke ... -- --help - `--id ` — Contract ID to invoke - `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - - Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--send ` — Whether or not to send a transaction Default value: `default` @@ -794,6 +890,26 @@ stellar contract invoke ... -- --help - `no`: Do not send transaction, return simulation result - `yes`: Always send transaction +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + + Default value: `100` + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar contract optimize` ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file @@ -835,12 +951,17 @@ Print the current value of a contract-data ledger entry - `persistent`: Persistent - `temporary`: Temporary +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 restore` @@ -867,17 +988,23 @@ If no keys are specificed the contract itself is restored. - `--ledgers-to-extend ` — Number of ledgers to extend the entry - `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -893,7 +1020,7 @@ Diagnose and troubleshoot CLI and network issues **Usage:** `stellar doctor [OPTIONS]` -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -904,22 +1031,7 @@ Watch the network for contract events **Usage:** `stellar events [OPTIONS]` -###### **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 - - Default value: `pretty` - - Possible values: - - `pretty`: Colorful, human-oriented console output - - `plain`: Human-oriented console output without colors - - `json`: JSON formatted console output - -- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) - - Default value: `10` +###### **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`. @@ -939,8 +1051,30 @@ Watch the network for contract events Possible values: `all`, `contract`, `system` +###### **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 + + Default value: `pretty` + + Possible values: + - `pretty`: Colorful, human-oriented console output + - `plain`: Human-oriented console output without colors + - `json`: JSON formatted console output + +- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) + + Default value: `10` + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server @@ -964,7 +1098,7 @@ If there are no environment variables in use, prints the defaults. E.g.: $ stellar env STELLAR_ACCOUNT -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1006,11 +1140,14 @@ Add a new identity (keypair, ledger, OS specific secure store) This only supports seed phrases for now. -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. - `--overwrite` — Overwrite existing identity if it already exists +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 public-key` Given an identity return its address (public key) @@ -1026,6 +1163,9 @@ Given an identity return its address (public key) ###### **Options:** - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1041,13 +1181,19 @@ Fund an identity on a test network ###### **Options:** +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 generate` @@ -1067,19 +1213,25 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be 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. -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--fund` — Fund generated key pair Default value: `false` - `--overwrite` — Overwrite existing identity if it already exists +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` List identities @@ -1088,9 +1240,12 @@ List identities ###### **Options:** +- `-l`, `--long` + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` ## `stellar keys rm` @@ -1102,7 +1257,7 @@ Remove an identity - `` — Identity to remove -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1121,6 +1276,9 @@ Output an identity's secret key - `--phrase` — Output seed phrase instead of private key - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1134,7 +1292,7 @@ Set the default identity that will be used on all commands. This allows you to s - `` — Set the default network name -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1165,13 +1323,16 @@ Add a new network - `` — Name of network -###### **Options:** +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 rm` @@ -1183,7 +1344,7 @@ Remove a network - `` — Network to remove -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1196,9 +1357,12 @@ List networks ###### **Options:** +- `-l`, `--long` — Get more info about the networks + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` — Get more info about the networks ## `stellar network use` @@ -1210,7 +1374,7 @@ Set the default network that will be used on all commands. This allows you to sk - `` — Set the default network name -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1223,12 +1387,6 @@ Fetch the health of the configured RPC ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--output ` — Format of the output Default value: `text` @@ -1238,6 +1396,18 @@ Fetch the health of the configured RPC - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Checks the health of the configured RPC @@ -1246,12 +1416,6 @@ Checks the health of the configured RPC ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--output ` — Format of the output Default value: `text` @@ -1261,6 +1425,18 @@ Checks the health of the configured RPC - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Fetch the network's config settings @@ -1269,12 +1445,6 @@ Fetch the network's config settings ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network - `--output ` — Format of the output @@ -1285,6 +1455,18 @@ Fetch the network's config settings - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + ## `stellar container` Start local networks in containers @@ -1376,7 +1558,7 @@ Migrate the local configuration to the global directory **Usage:** `stellar config migrate [OPTIONS]` -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1391,7 +1573,7 @@ The location will depend on how your system is configured. **Usage:** `stellar config dir [OPTIONS]` -###### **Options:** +###### **Options (Global):** - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1422,11 +1604,14 @@ Any invalid contract id passed as `--address` will be ignored. **Usage:** `stellar snapshot create [OPTIONS] --output ` -###### **Options:** +###### **Filter Options:** -- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger - `--address
` — Account or contract address/alias to include in the snapshot - `--wasm-hash ` — WASM hashes to include in the snapshot + +###### **Options:** + +- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger - `--output ` — Format of the out file Possible values: `json` @@ -1435,9 +1620,17 @@ Any invalid contract id passed as `--address` will be ignored. Default value: `snapshot.json` +###### **Options (Archive):** + - `--archive-url ` — Archive URL + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server @@ -1491,14 +1684,17 @@ Fetch the source account's seq-num and increment for the given tx **Usage:** `stellar tx update sequence-number next [OPTIONS]` -###### **Options:** +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 tx edit` @@ -1524,7 +1720,7 @@ Calculate the hash of a transaction envelope - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty -###### **Options:** +###### **Options (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider @@ -1570,34 +1766,19 @@ Transfer XLM balance to another account and remove source account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - - Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 - `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' -## `stellar tx new begin-sponsoring-future-reserves` - -Begin sponsoring future reserves for another account +###### **Options (Global):** -**Usage:** `stellar tx new begin-sponsoring-future-reserves [OPTIONS] --source-account --sponsored-id ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1611,22 +1792,28 @@ Begin sponsoring future reserves for another account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 begin-sponsoring-future-reserves` + +Begin sponsoring future reserves for another account + +**Usage:** `stellar tx new begin-sponsoring-future-reserves [OPTIONS] --source-account --sponsored-id ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 - `--sponsored-id ` — Account that will be sponsored -## `stellar tx new bump-sequence` - -Bump sequence number to invalidate older transactions +###### **Options (Global):** -**Usage:** `stellar tx new bump-sequence [OPTIONS] --source-account --bump-to ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1640,23 +1827,29 @@ Bump sequence number to invalidate older transactions - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--bump-to ` — Sequence number to bump to -## `stellar tx new change-trust` +## `stellar tx new bump-sequence` -Create, update, or delete a trustline +Bump sequence number to invalidate older transactions -**Usage:** `stellar tx new change-trust [OPTIONS] --source-account --line ` +**Usage:** `stellar tx new bump-sequence [OPTIONS] --source-account --bump-to ` ###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--bump-to ` — Sequence number to bump to + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -1669,9 +1862,16 @@ Create, update, or delete a trustline - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 change-trust` + +Create, update, or delete a trustline + +**Usage:** `stellar tx new change-trust [OPTIONS] --source-account --line ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -1681,13 +1881,12 @@ Create, update, or delete a trustline Default value: `9223372036854775807` -## `stellar tx new claim-claimable-balance` - -Claim a claimable balance by its balance ID +###### **Options (Global):** -**Usage:** `stellar tx new claim-claimable-balance [OPTIONS] --source-account --balance-id ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1701,22 +1900,28 @@ Claim a claimable balance by its balance ID - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 claim-claimable-balance` + +Claim a claimable balance by its balance ID + +**Usage:** `stellar tx new claim-claimable-balance [OPTIONS] --source-account --balance-id ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 - `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) -## `stellar tx new clawback` - -Clawback an asset from an account +###### **Options (Global):** -**Usage:** `stellar tx new clawback [OPTIONS] --source-account --from --asset --amount ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1730,9 +1935,16 @@ Clawback an asset from an account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 clawback` + +Clawback an asset from an account + +**Usage:** `stellar tx new clawback [OPTIONS] --source-account --from --asset --amount ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -1741,13 +1953,12 @@ Clawback an asset from an account - `--asset ` — Asset to clawback - `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset -## `stellar tx new clawback-claimable-balance` - -Clawback a claimable balance by its balance ID +###### **Options (Global):** -**Usage:** `stellar tx new clawback-claimable-balance [OPTIONS] --source-account --balance-id ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1761,22 +1972,28 @@ Clawback a claimable balance by its balance ID - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 clawback-claimable-balance` + +Clawback a claimable balance by its balance ID + +**Usage:** `stellar tx new clawback-claimable-balance [OPTIONS] --source-account --balance-id ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 - `--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 -## `stellar tx new create-account` - -Create and fund a new account +###### **Options (Global):** -**Usage:** `stellar tx new create-account [OPTIONS] --source-account --destination ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1790,9 +2007,16 @@ Create and fund a new account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 create-account` + +Create and fund a new account + +**Usage:** `stellar tx new create-account [OPTIONS] --source-account --destination ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -1802,13 +2026,12 @@ Create and fund a new account Default value: `10_000_000` -## `stellar tx new create-claimable-balance` - -Create a claimable balance that can be claimed by specified accounts +###### **Options (Global):** -**Usage:** `stellar tx new create-claimable-balance [OPTIONS] --source-account --amount ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1822,9 +2045,16 @@ Create a claimable balance that can be claimed by specified accounts - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 create-claimable-balance` + +Create a claimable balance that can be claimed by specified accounts + +**Usage:** `stellar tx new create-claimable-balance [OPTIONS] --source-account --amount ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -1839,13 +2069,12 @@ Create a claimable balance that can be claimed by specified accounts Examples: - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` -## `stellar tx new create-passive-sell-offer` - -Create a passive sell offer on the Stellar DEX +###### **Options (Global):** -**Usage:** `stellar tx new create-passive-sell-offer [OPTIONS] --source-account --selling --buying --amount --price ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1859,9 +2088,16 @@ Create a passive sell offer on the Stellar DEX - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 create-passive-sell-offer` + +Create a passive sell offer on the Stellar DEX + +**Usage:** `stellar tx new create-passive-sell-offer [OPTIONS] --source-account --selling --buying --amount --price ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -1871,13 +2107,12 @@ Create a passive sell offer on the Stellar DEX - `--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) -## `stellar tx new end-sponsoring-future-reserves` - -End sponsoring future reserves +###### **Options (Global):** -**Usage:** `stellar tx new end-sponsoring-future-reserves [OPTIONS] --source-account ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1891,21 +2126,27 @@ End sponsoring future reserves - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 end-sponsoring-future-reserves` + +End sponsoring future reserves + +**Usage:** `stellar tx new end-sponsoring-future-reserves [OPTIONS] --source-account ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 -## `stellar tx new liquidity-pool-deposit` - -Deposit assets into a liquidity pool +###### **Options (Global):** -**Usage:** `stellar tx new liquidity-pool-deposit [OPTIONS] --source-account --liquidity-pool-id --max-amount-a --max-amount-b ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1919,9 +2160,16 @@ Deposit assets into a liquidity pool - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 liquidity-pool-deposit` + +Deposit assets into a liquidity pool + +**Usage:** `stellar tx new liquidity-pool-deposit [OPTIONS] --source-account --liquidity-pool-id --max-amount-a --max-amount-b ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -1937,13 +2185,12 @@ Deposit assets into a liquidity pool Default value: `1:1` -## `stellar tx new liquidity-pool-withdraw` - -Withdraw assets from a liquidity pool +###### **Options (Global):** -**Usage:** `stellar tx new liquidity-pool-withdraw [OPTIONS] --source-account --liquidity-pool-id --amount --min-amount-a --min-amount-b ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1957,9 +2204,16 @@ Withdraw assets from a liquidity pool - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 liquidity-pool-withdraw` + +Withdraw assets from a liquidity pool + +**Usage:** `stellar tx new liquidity-pool-withdraw [OPTIONS] --source-account --liquidity-pool-id --amount --min-amount-a --min-amount-b ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -1969,13 +2223,12 @@ Withdraw assets from a liquidity pool - `--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 -## `stellar tx new manage-buy-offer` - -Create, update, or delete a buy offer +###### **Options (Global):** -**Usage:** `stellar tx new manage-buy-offer [OPTIONS] --source-account --selling --buying --amount --price ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -1989,9 +2242,16 @@ Create, update, or delete a buy offer - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 manage-buy-offer` + +Create, update, or delete a buy offer + +**Usage:** `stellar tx new manage-buy-offer [OPTIONS] --source-account --selling --buying --amount --price ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2004,13 +2264,12 @@ Create, update, or delete a buy offer Default value: `0` -## `stellar tx new manage-data` - -Set, modify, or delete account data entries +###### **Options (Global):** -**Usage:** `stellar tx new manage-data [OPTIONS] --source-account --data-name ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2024,9 +2283,16 @@ Set, modify, or delete account data entries - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 manage-data` + +Set, modify, or delete account data entries + +**Usage:** `stellar tx new manage-data [OPTIONS] --source-account --data-name ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2034,13 +2300,12 @@ Set, modify, or delete account data entries - `--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` -## `stellar tx new manage-sell-offer` - -Create, update, or delete a sell offer +###### **Options (Global):** -**Usage:** `stellar tx new manage-sell-offer [OPTIONS] --source-account --selling --buying --amount --price ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2054,9 +2319,16 @@ Create, update, or delete a sell offer - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 manage-sell-offer` + +Create, update, or delete a sell offer + +**Usage:** `stellar tx new manage-sell-offer [OPTIONS] --source-account --selling --buying --amount --price ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2069,13 +2341,12 @@ Create, update, or delete a sell offer Default value: `0` -## `stellar tx new path-payment-strict-send` - -Send a payment with a different asset using path finding, specifying the send amount +###### **Options (Global):** -**Usage:** `stellar tx new path-payment-strict-send [OPTIONS] --source-account --send-asset --send-amount --destination --dest-asset --dest-min ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2089,9 +2360,16 @@ Send a payment with a different asset using path finding, specifying the send am - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 tx new path-payment-strict-send` + +Send a payment with a different asset using path finding, specifying the send amount + +**Usage:** `stellar tx new path-payment-strict-send [OPTIONS] --source-account --send-asset --send-amount --destination --dest-asset --dest-min ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--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 @@ -2103,13 +2381,12 @@ Send a payment with a different asset using path finding, specifying the send am - `--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 -## `stellar tx new path-payment-strict-receive` - -Send a payment with a different asset using path finding, specifying the receive amount +###### **Options (Global):** -**Usage:** `stellar tx new path-payment-strict-receive [OPTIONS] --source-account --send-asset --send-max --destination --dest-asset --dest-amount ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2123,9 +2400,16 @@ Send a payment with a different asset using path finding, specifying the receive - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 path-payment-strict-receive` + +Send a payment with a different asset using path finding, specifying the receive amount + +**Usage:** `stellar tx new path-payment-strict-receive [OPTIONS] --source-account --send-asset --send-max --destination --dest-asset --dest-amount ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2137,13 +2421,12 @@ Send a payment with a different asset using path finding, specifying the 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 -## `stellar tx new payment` - -Send asset to destination account +###### **Options (Global):** -**Usage:** `stellar tx new payment [OPTIONS] --source-account --destination --amount ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2157,9 +2440,16 @@ Send asset to destination account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 payment` + +Send asset to destination account + +**Usage:** `stellar tx new payment [OPTIONS] --source-account --destination --amount ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2171,13 +2461,12 @@ Send asset to destination account - `--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) -## `stellar tx new revoke-sponsorship` - -Revoke sponsorship of a ledger entry or signer +###### **Options (Global):** -**Usage:** `stellar tx new revoke-sponsorship [OPTIONS] --source-account --account-id ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2191,9 +2480,16 @@ Revoke sponsorship of a ledger entry or signer - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 revoke-sponsorship` + +Revoke sponsorship of a ledger entry or signer + +**Usage:** `stellar tx new revoke-sponsorship [OPTIONS] --source-account --account-id ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2206,13 +2502,12 @@ Revoke sponsorship of a ledger entry or signer - `--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 -## `stellar tx new set-options` - -Set account options like flags, signers, and home domain +###### **Options (Global):** -**Usage:** `stellar tx new set-options [OPTIONS] --source-account ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2226,9 +2521,16 @@ Set account options like flags, signers, and home domain - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 set-options` + +Set account options like flags, signers, and home domain + +**Usage:** `stellar tx new set-options [OPTIONS] --source-account ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2250,13 +2552,12 @@ Set account options like flags, signers, and home domain - `--clear-immutable` - `--clear-clawback-enabled` -## `stellar tx new set-trustline-flags` - -Configure authorization and trustline flags for an asset +###### **Options (Global):** -**Usage:** `stellar tx new set-trustline-flags [OPTIONS] --source-account --trustor --asset ` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm @@ -2270,9 +2571,16 @@ Configure authorization and trustline flags for an asset - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--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 set-trustline-flags` + +Configure authorization and trustline flags for an asset + +**Usage:** `stellar tx new set-trustline-flags [OPTIONS] --source-account --trustor --asset ` + +###### **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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2286,6 +2594,26 @@ Configure authorization and trustline flags for an asset - `--clear-authorize-to-maintain-liabilities` - `--clear-trustline-clawback-enabled` +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + + Default value: `100` + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + ## `stellar tx operation` Manipulate the operations in a transaction, including adding new operations @@ -2342,6 +2670,20 @@ Transfer XLM balance to another account and remove source account ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2354,14 +2696,6 @@ Transfer XLM balance to another account and remove source account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx operation add begin-sponsoring-future-reserves` @@ -2376,6 +2710,20 @@ Begin sponsoring future reserves for another account ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--sponsored-id ` — Account that will be sponsored + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2388,14 +2736,6 @@ Begin sponsoring future reserves for another account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--sponsored-id ` — Account that will be sponsored ## `stellar tx operation add bump-sequence` @@ -2410,6 +2750,20 @@ Bump sequence number to invalidate older transactions ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--bump-to ` — Sequence number to bump to + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2422,14 +2776,6 @@ Bump sequence number to invalidate older transactions - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--bump-to ` — Sequence number to bump to ## `stellar tx operation add change-trust` @@ -2444,6 +2790,23 @@ Create, update, or delete a trustline ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line + + Default value: `9223372036854775807` + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2456,17 +2819,6 @@ Create, update, or delete a trustline - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line - - Default value: `9223372036854775807` ## `stellar tx operation add claim-claimable-balance` @@ -2481,6 +2833,20 @@ Claim a claimable balance by its balance ID ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2493,14 +2859,6 @@ Claim a claimable balance by its balance ID - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx operation add clawback` @@ -2515,6 +2873,22 @@ Clawback an asset from an account ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2527,16 +2901,6 @@ Clawback an asset from an account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--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 ## `stellar tx operation add clawback-claimable-balance` @@ -2551,7 +2915,21 @@ Clawback a claimable balance by its balance ID ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2563,14 +2941,6 @@ Clawback a claimable balance by its balance ID - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--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 ## `stellar tx operation add create-account` @@ -2585,6 +2955,23 @@ Create and fund a new account ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--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` + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2597,17 +2984,6 @@ Create and fund a new account - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--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` ## `stellar tx operation add create-claimable-balance` @@ -2622,21 +2998,7 @@ Create a claimable balance that can be claimed by specified accounts ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - - Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2651,6 +3013,26 @@ Create a claimable balance that can be claimed by specified accounts Examples: - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + + Default value: `100` + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + ## `stellar tx operation add create-passive-sell-offer` Create a passive sell offer on the Stellar DEX @@ -2664,6 +3046,23 @@ Create a passive sell offer on the Stellar DEX ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--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) + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2676,17 +3075,6 @@ Create a passive sell offer on the Stellar DEX - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--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) ## `stellar tx operation add end-sponsoring-future-reserves` @@ -2701,6 +3089,19 @@ End sponsoring future reserves ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2713,13 +3114,6 @@ End sponsoring future reserves - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 ## `stellar tx operation add liquidity-pool-deposit` @@ -2734,21 +3128,7 @@ Deposit assets into a liquidity pool ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - - Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2764,19 +3144,13 @@ Deposit assets into a liquidity pool Default value: `1:1` -## `stellar tx operation add liquidity-pool-withdraw` +###### **Options (Global):** -Withdraw assets from a liquidity pool - -**Usage:** `stellar tx operation add liquidity-pool-withdraw [OPTIONS] --source-account --liquidity-pool-id --amount --min-amount-a --min-amount-b [TX_XDR]` - -###### **Arguments:** - -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2789,9 +3163,21 @@ Withdraw assets from a liquidity pool - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config + +## `stellar tx operation add liquidity-pool-withdraw` + +Withdraw assets from a liquidity pool + +**Usage:** `stellar tx operation add liquidity-pool-withdraw [OPTIONS] --source-account --liquidity-pool-id --amount --min-amount-a --min-amount-b [TX_XDR]` + +###### **Arguments:** + +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty + +###### **Options:** + +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2801,19 +3187,13 @@ Withdraw assets from a liquidity pool - `--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 -## `stellar tx operation add manage-buy-offer` +###### **Options (Global):** -Create, update, or delete a buy offer - -**Usage:** `stellar tx operation add manage-buy-offer [OPTIONS] --source-account --selling --buying --amount --price [TX_XDR]` - -###### **Arguments:** - -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2826,9 +3206,21 @@ Create, update, or delete a buy offer - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config + +## `stellar tx operation add manage-buy-offer` + +Create, update, or delete a buy offer + +**Usage:** `stellar tx operation add manage-buy-offer [OPTIONS] --source-account --selling --buying --amount --price [TX_XDR]` + +###### **Arguments:** + +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty + +###### **Options:** + +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2841,6 +3233,26 @@ Create, update, or delete a buy offer Default value: `0` +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + + Default value: `100` + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + ## `stellar tx operation add manage-data` Set, modify, or delete account data entries @@ -2854,6 +3266,21 @@ Set, modify, or delete account data entries ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--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` + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2866,15 +3293,6 @@ Set, modify, or delete account data entries - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--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` ## `stellar tx operation add manage-sell-offer` @@ -2889,21 +3307,7 @@ Create, update, or delete a sell offer ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - - Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -2916,6 +3320,26 @@ Create, update, or delete a sell offer Default value: `0` +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + + Default value: `100` + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + ## `stellar tx operation add path-payment-strict-receive` Send a payment with a different asset using path finding, specifying the receive amount @@ -2929,6 +3353,25 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--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 +- `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2941,33 +3384,39 @@ Send a payment with a different asset using path finding, specifying the receive - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config + +## `stellar tx operation add path-payment-strict-send` + +Send a payment with a different asset using path finding, specifying the send amount + +**Usage:** `stellar tx operation add path-payment-strict-send [OPTIONS] --source-account --send-asset --send-amount --destination --dest-asset --dest-min [TX_XDR]` + +###### **Arguments:** + +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty + +###### **Options:** + +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 - `--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) +- `--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-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +- `--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 -## `stellar tx operation add path-payment-strict-send` - -Send a payment with a different asset using path finding, specifying the send amount - -**Usage:** `stellar tx operation add path-payment-strict-send [OPTIONS] --source-account --send-asset --send-amount --destination --dest-asset --dest-min [TX_XDR]` - -###### **Arguments:** +###### **Options (Global):** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -2980,19 +3429,6 @@ Send a payment with a different asset using path finding, specifying the send am - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--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 -- `--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 ## `stellar tx operation add payment` @@ -3007,21 +3443,7 @@ Send asset to destination account ###### **Options:** - `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - - Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -3033,19 +3455,13 @@ Send asset to destination account - `--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) -## `stellar tx operation add revoke-sponsorship` - -Revoke sponsorship of a ledger entry or signer - -**Usage:** `stellar tx operation add revoke-sponsorship [OPTIONS] --source-account --account-id [TX_XDR]` - -###### **Arguments:** +###### **Options (Global):** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -3058,9 +3474,21 @@ Revoke sponsorship of a ledger entry or signer - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config + +## `stellar tx operation add revoke-sponsorship` + +Revoke sponsorship of a ledger entry or signer + +**Usage:** `stellar tx operation add revoke-sponsorship [OPTIONS] --source-account --account-id [TX_XDR]` + +###### **Arguments:** + +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty + +###### **Options:** + +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -3073,19 +3501,13 @@ Revoke sponsorship of a ledger entry or signer - `--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 -## `stellar tx operation add set-options` - -Set account options like flags, signers, and home domain - -**Usage:** `stellar tx operation add set-options [OPTIONS] --source-account [TX_XDR]` - -###### **Arguments:** +###### **Options (Global):** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -3098,9 +3520,21 @@ Set account options like flags, signers, and home domain - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config + +## `stellar tx operation add set-options` + +Set account options like flags, signers, and home domain + +**Usage:** `stellar tx operation add set-options [OPTIONS] --source-account [TX_XDR]` + +###### **Arguments:** + +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty + +###### **Options:** + +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -3122,19 +3556,13 @@ Set account options like flags, signers, and home domain - `--clear-immutable` - `--clear-clawback-enabled` -## `stellar tx operation add set-trustline-flags` - -Configure authorization and trustline flags for an asset - -**Usage:** `stellar tx operation add set-trustline-flags [OPTIONS] --source-account --trustor --asset [TX_XDR]` - -###### **Arguments:** +###### **Options (Global):** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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:** +###### **Options (RPC):** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` @@ -3147,9 +3575,21 @@ Configure authorization and trustline flags for an asset - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config + +## `stellar tx operation add set-trustline-flags` + +Configure authorization and trustline flags for an asset + +**Usage:** `stellar tx operation add set-trustline-flags [OPTIONS] --source-account --trustor --asset [TX_XDR]` + +###### **Arguments:** + +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty + +###### **Options:** + +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 @@ -3163,6 +3603,26 @@ Configure authorization and trustline flags for an asset - `--clear-authorize-to-maintain-liabilities` - `--clear-trustline-clawback-enabled` +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + + Default value: `100` + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + ## `stellar tx send` Send a transaction envelope to the network @@ -3173,14 +3633,17 @@ Send a transaction envelope to the network - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty -###### **Options:** +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 tx sign` @@ -3198,12 +3661,18 @@ Sign a transaction envelope appending the signature to the envelope - `--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 + +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. 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 tx simulate` @@ -3217,19 +3686,25 @@ Simulate a transaction envelope from stdin ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `-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` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `--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 - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +###### **Options (Global):** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. 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 (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned @@ -3246,10 +3721,6 @@ Fetch a transaction from the network by hash If no subcommand is passed in, the ###### **Options:** - `--hash ` — Hash of transaction to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Format of the output Default value: `json` @@ -3259,6 +3730,13 @@ Fetch a transaction from the network by hash If no subcommand is passed in, the - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Fetch the transaction result @@ -3268,10 +3746,6 @@ Fetch the transaction result ###### **Options:** - `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Format of the output Default value: `json` @@ -3281,6 +3755,13 @@ Fetch the transaction result - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Fetch the transaction meta @@ -3290,10 +3771,6 @@ Fetch the transaction meta ###### **Options:** - `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Format of the output Default value: `json` @@ -3303,6 +3780,13 @@ Fetch the transaction meta - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Fetch the transaction fee information @@ -3312,10 +3796,6 @@ Fetch the transaction fee information ###### **Options:** - `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Output format for fee command Default value: `table` @@ -3325,6 +3805,13 @@ Fetch the transaction fee information - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `table`: Formatted in a table comparing fee types +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Fetch the transaction events @@ -3334,10 +3821,6 @@ Fetch the transaction events ###### **Options:** - `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Format of the output Default value: `json` @@ -3347,6 +3830,13 @@ Fetch the transaction events - `json-formatted`: Formatted (multiline) JSON output of events with parsed XDRs - `text`: Human readable event output with parsed XDRs +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` Decode a transaction envelope from XDR to JSON @@ -3681,9 +4171,12 @@ List cached actions (transactions, simulations) ###### **Options:** +- `-l`, `--long` + +###### **Options (Global):** + - `--global` — ⚠️ Deprecated: global config is always on - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` ## `stellar cache actionlog read` @@ -3748,10 +4241,6 @@ Get the latest ledger sequence and information from the network ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Format of the output Default value: `text` @@ -3761,6 +4250,13 @@ Get the latest ledger sequence and information from the network - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--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` **Usage:** `stellar ledger fetch [OPTIONS] ` @@ -3775,10 +4271,6 @@ Get the latest ledger sequence and information from the network Default value: `1` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Format of the output Default value: `text` @@ -3796,6 +4288,13 @@ Get the latest ledger sequence and information from the network - `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 +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + ## `stellar fee-stats` Fetch network feestats @@ -3804,10 +4303,6 @@ Fetch network feestats ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - `--output ` — Format of the output Default value: `text` @@ -3816,3 +4311,10 @@ Fetch network feestats - `text`: Text output of network info - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request + +###### **Options (RPC):** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config diff --git a/Makefile b/Makefile index ac5340245f..a150463ca1 100644 --- a/Makefile +++ b/Makefile @@ -44,7 +44,7 @@ build-test-wasms: build-test: build-test-wasms install docs: - cargo run --bin doc-gen + cargo run --bin doc-gen --features doc-gen ./node_modules/.bin/prettier --write --log-level warn FULL_HELP_DOCS.md test: build-test diff --git a/cmd/soroban-cli/Cargo.toml b/cmd/soroban-cli/Cargo.toml index 5937f3605a..de821d8c7d 100644 --- a/cmd/soroban-cli/Cargo.toml +++ b/cmd/soroban-cli/Cargo.toml @@ -27,6 +27,7 @@ bin-dir = "{ bin }{ binary-ext }" [[bin]] name = "doc-gen" path = "src/bin/doc-gen.rs" +required-features = ["doc-gen"] [lib] name = "soroban_cli" @@ -37,6 +38,7 @@ doctest = false default = ["additional-libs"] additional-libs = ["dep:wasm-opt", "dep:keyring", "dep:stellar-ledger"] emulator-tests = ["stellar-ledger/emulator-tests"] +doc-gen = ["dep:clap-markdown"] [dependencies] stellar-xdr = { workspace = true, features = ["cli"] } @@ -133,7 +135,10 @@ whoami = "1.5.2" serde_with = "3.11.0" rustc_version = "0.4.1" prettytable = "0.10.0" -clap-markdown = "0.1.5" + +# Only for doc-gen +# clap-markdown from https://github.com/ConnorGray/clap-markdown/pull/48 +clap-markdown = { version = "0.1.5", optional = true, git = "https://github.com/ConnorGray/clap-markdown", rev = "42956b342cef3325d9060fc43995d595e7c8aa66" } [build-dependencies] crate-git-revision = "0.0.6" From c2c32eb0df472063f41369c7cca358921d368e8e Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Mon, 3 Nov 2025 12:07:35 +1000 Subject: [PATCH 2/6] shift docgen into its own crate --- .github/workflows/rust.yml | 4 ++-- Cargo.lock | 9 ++++++++- Cargo.toml | 1 + Makefile | 2 +- cmd/doc-gen/Cargo.toml | 17 +++++++++++++++++ cmd/doc-gen/README.md | 9 +++++++++ cmd/doc-gen/src/main.rs | 33 +++++++++++++++++++++++++++++++++ cmd/soroban-cli/Cargo.toml | 10 ---------- 8 files changed, 71 insertions(+), 14 deletions(-) create mode 100644 cmd/doc-gen/Cargo.toml create mode 100644 cmd/doc-gen/README.md create mode 100644 cmd/doc-gen/src/main.rs diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml index 115eb77733..17e85a73fd 100644 --- a/.github/workflows/rust.yml +++ b/.github/workflows/rust.yml @@ -156,7 +156,7 @@ jobs: - os: macos-13 target: x86_64-apple-darwin cargo-hack-feature-options: - --feature-powerset --skip emulator-tests, + --feature-powerset --skip emulator-tests - os: macos-latest target: aarch64-apple-darwin cargo-hack-feature-options: @@ -185,5 +185,5 @@ jobs: with: runs-on: ${{ matrix.os }} target: ${{ matrix.target }} - cargo-hack-feature-options: ${{ matrix.cargo-hack-feature-options }} --skip doc-gen + cargo-hack-feature-options: ${{ matrix.cargo-hack-feature-options }} additional-deb-packages: ${{ matrix.additional-deb-packages }} diff --git a/Cargo.lock b/Cargo.lock index 471ff45118..aea22fb231 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1443,6 +1443,14 @@ version = "0.3.3" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "fea41bba32d969b513997752735605054bc0dfa92b4c56bf1189f2e174be7a10" +[[package]] +name = "doc-gen" +version = "23.1.4" +dependencies = [ + "clap-markdown", + "soroban-cli", +] + [[package]] name = "docker_credential" version = "1.3.2" @@ -4919,7 +4927,6 @@ dependencies = [ "cargo_metadata", "chrono", "clap", - "clap-markdown", "clap_complete", "crate-git-revision", "csv", diff --git a/Cargo.toml b/Cargo.toml index 72ffc5986e..59d5d0de96 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -3,6 +3,7 @@ resolver = "2" members = [ "cmd/stellar-cli", "cmd/soroban-cli", + "cmd/doc-gen", "cmd/crates/*", "cmd/crates/soroban-test/tests/fixtures/test-wasms/*", "cmd/crates/soroban-test/tests/fixtures/hello", diff --git a/Makefile b/Makefile index a150463ca1..5a0b99a28d 100644 --- a/Makefile +++ b/Makefile @@ -44,7 +44,7 @@ build-test-wasms: build-test: build-test-wasms install docs: - cargo run --bin doc-gen --features doc-gen + cargo run --package doc-gen ./node_modules/.bin/prettier --write --log-level warn FULL_HELP_DOCS.md test: build-test diff --git a/cmd/doc-gen/Cargo.toml b/cmd/doc-gen/Cargo.toml new file mode 100644 index 0000000000..4aa463c961 --- /dev/null +++ b/cmd/doc-gen/Cargo.toml @@ -0,0 +1,17 @@ +[package] +name = "doc-gen" +description = "Stellar CLI generator of markdown help documentation" +homepage = "https://github.com/stellar/stellar-cli" +repository = "https://github.com/stellar/stellar-cli" +authors = ["Stellar Development Foundation "] +license = "Apache-2.0" +readme = "README.md" +version.workspace = true +edition = "2021" +rust-version.workspace = true +publish = false + +[dependencies] +soroban-cli = { workspace = true } +# clap-markdown from https://github.com/ConnorGray/clap-markdown/pull/48 +clap-markdown = { version = "0.1.5", git = "https://github.com/ConnorGray/clap-markdown", rev = "42956b342cef3325d9060fc43995d595e7c8aa66" } diff --git a/cmd/doc-gen/README.md b/cmd/doc-gen/README.md new file mode 100644 index 0000000000..1bd83c75f1 --- /dev/null +++ b/cmd/doc-gen/README.md @@ -0,0 +1,9 @@ +# Stellar CLI Documentation Generator + +A generator for the help documentation using clap-markdown. + +## Usage + +``` +cargo run --package doc-gen +``` diff --git a/cmd/doc-gen/src/main.rs b/cmd/doc-gen/src/main.rs new file mode 100644 index 0000000000..d3aa3ecb21 --- /dev/null +++ b/cmd/doc-gen/src/main.rs @@ -0,0 +1,33 @@ +use std::{ + env, + path::{Path, PathBuf}, +}; + +type DynError = Box; + +fn main() -> Result<(), DynError> { + doc_gen()?; + Ok(()) +} + +fn doc_gen() -> std::io::Result<()> { + let out_dir = project_root(); + let options = clap_markdown::MarkdownOptions::new() + .show_footer(false) + .show_table_of_contents(false) + .title("Stellar CLI Manual".to_string()); + + let content = clap_markdown::help_markdown_custom::(&options); + + std::fs::write(out_dir.join("FULL_HELP_DOCS.md"), content)?; + + Ok(()) +} + +fn project_root() -> PathBuf { + Path::new(&env!("CARGO_MANIFEST_DIR")) + .ancestors() + .nth(2) + .unwrap() + .to_path_buf() +} diff --git a/cmd/soroban-cli/Cargo.toml b/cmd/soroban-cli/Cargo.toml index de821d8c7d..63b9a28be7 100644 --- a/cmd/soroban-cli/Cargo.toml +++ b/cmd/soroban-cli/Cargo.toml @@ -24,11 +24,6 @@ path = "src/bin/soroban.rs" pkg-url = "{ repo }/releases/download/v{ version }/{ name }-{ version }-{ target }{ archive-suffix }" bin-dir = "{ bin }{ binary-ext }" -[[bin]] -name = "doc-gen" -path = "src/bin/doc-gen.rs" -required-features = ["doc-gen"] - [lib] name = "soroban_cli" path = "src/lib.rs" @@ -38,7 +33,6 @@ doctest = false default = ["additional-libs"] additional-libs = ["dep:wasm-opt", "dep:keyring", "dep:stellar-ledger"] emulator-tests = ["stellar-ledger/emulator-tests"] -doc-gen = ["dep:clap-markdown"] [dependencies] stellar-xdr = { workspace = true, features = ["cli"] } @@ -136,10 +130,6 @@ serde_with = "3.11.0" rustc_version = "0.4.1" prettytable = "0.10.0" -# Only for doc-gen -# clap-markdown from https://github.com/ConnorGray/clap-markdown/pull/48 -clap-markdown = { version = "0.1.5", optional = true, git = "https://github.com/ConnorGray/clap-markdown", rev = "42956b342cef3325d9060fc43995d595e7c8aa66" } - [build-dependencies] crate-git-revision = "0.0.6" serde.workspace = true From 86a2975a63df5a81b531d6064fd1039da757e973 Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Mon, 3 Nov 2025 12:08:29 +1000 Subject: [PATCH 3/6] remove old doc gen --- cmd/soroban-cli/src/bin/doc-gen.rs | 33 ------------------------------ 1 file changed, 33 deletions(-) delete mode 100644 cmd/soroban-cli/src/bin/doc-gen.rs diff --git a/cmd/soroban-cli/src/bin/doc-gen.rs b/cmd/soroban-cli/src/bin/doc-gen.rs deleted file mode 100644 index d3aa3ecb21..0000000000 --- a/cmd/soroban-cli/src/bin/doc-gen.rs +++ /dev/null @@ -1,33 +0,0 @@ -use std::{ - env, - path::{Path, PathBuf}, -}; - -type DynError = Box; - -fn main() -> Result<(), DynError> { - doc_gen()?; - Ok(()) -} - -fn doc_gen() -> std::io::Result<()> { - let out_dir = project_root(); - let options = clap_markdown::MarkdownOptions::new() - .show_footer(false) - .show_table_of_contents(false) - .title("Stellar CLI Manual".to_string()); - - let content = clap_markdown::help_markdown_custom::(&options); - - std::fs::write(out_dir.join("FULL_HELP_DOCS.md"), content)?; - - Ok(()) -} - -fn project_root() -> PathBuf { - Path::new(&env!("CARGO_MANIFEST_DIR")) - .ancestors() - .nth(2) - .unwrap() - .to_path_buf() -} From 32fab497b9c4c69492d42d00c7aaeb894bb52577 Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Mon, 3 Nov 2025 12:12:55 +1000 Subject: [PATCH 4/6] remove git rev check because the deny.toml already achieves this --- .github/workflows/dependency-check.yml | 21 --------------------- 1 file changed, 21 deletions(-) delete mode 100644 .github/workflows/dependency-check.yml diff --git a/.github/workflows/dependency-check.yml b/.github/workflows/dependency-check.yml deleted file mode 100644 index 04d6be5bd6..0000000000 --- a/.github/workflows/dependency-check.yml +++ /dev/null @@ -1,21 +0,0 @@ -name: Dependency sanity checker - -on: - push: - branches: [main, release/**] - pull_request: - -concurrency: - group: ${{ github.workflow }}-${{ github.ref_protected == 'true' && github.sha || github.ref }} - cancel-in-progress: true - -defaults: - run: - shell: bash - -jobs: - validate-rust-git-rev-deps: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v5 - - uses: stellar/actions/rust-check-git-rev-deps@main From 3cda7f00aa705b2ac7c2cfe2a1f07e26f8c15437 Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Mon, 3 Nov 2025 12:17:39 +1000 Subject: [PATCH 5/6] allow the git rev --- deny.toml | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/deny.toml b/deny.toml index 6320d8fd8b..a22bd5462d 100644 --- a/deny.toml +++ b/deny.toml @@ -258,7 +258,10 @@ unknown-git = "deny" # if not specified. If it is specified but empty, no registries are allowed. allow-registry = ["https://github.com/rust-lang/crates.io-index"] # List of URLs for allowed Git repositories -allow-git = [] +allow-git = [ + # Only used by the unpublished doc-gen crate, temporarily until PR is merged: https://github.com/ConnorGray/clap-markdown/pull/48 + "https://github.com/ConnorGray/clap-markdown?rev=42956b342cef3325d9060fc43995d595e7c8aa66", +] [sources.allow-org] # 1 or more github.com organizations to allow git sources for From 1d11a3e93aea7dc6f5d074367dbdc05ca2725502 Mon Sep 17 00:00:00 2001 From: Leigh <351529+leighmcculloch@users.noreply.github.com> Date: Tue, 4 Nov 2025 07:33:42 +1000 Subject: [PATCH 6/6] Update README.md --- cmd/doc-gen/README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/cmd/doc-gen/README.md b/cmd/doc-gen/README.md index 1bd83c75f1..810eeade64 100644 --- a/cmd/doc-gen/README.md +++ b/cmd/doc-gen/README.md @@ -4,6 +4,18 @@ A generator for the help documentation using clap-markdown. ## Usage +Run the following command from the workspace root. + ``` cargo run --package doc-gen ``` + +The command will update the file `FULL_HELP_DOCS.md` located in the root of the workspace. + +Typically this command is not run directly, but in the root `Makefile` the `docs` target will run this command in conjunction with formatting the markdown. + +So typically run this command via make: + +``` +make docs +```