diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 311df98d2f..8f23f3b0f2 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -63,7 +63,7 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c - `fee-stats` — ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats - `fees` — Fetch network feestats and configure CLI fee settings -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` @@ -115,15 +115,15 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a **Usage:** `stellar contract asset id [OPTIONS] --asset ` -###### **Options:** +###### **Global Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -136,24 +136,16 @@ Deploy builtin Soroban Asset Contract **Usage:** `stellar contract asset deploy [OPTIONS] --asset --source-account ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--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 -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -164,6 +156,20 @@ Deploy builtin Soroban Asset Contract - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar contract alias` Utilities to manage contract aliases @@ -187,11 +193,11 @@ Remove contract alias - `` — The contract alias that will be removed -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -208,16 +214,16 @@ Add contract alias - `` — The contract alias that will be used +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--overwrite` — Overwrite the contract alias if it already exists - `--id ` — The contract id that will be associated with the alias -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -234,11 +240,11 @@ Show the contract id associated with a given alias - `` — The contract alias that will be displayed -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -251,7 +257,7 @@ List all aliases **Usage:** `stellar contract alias ls [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -287,6 +293,10 @@ Generate a TypeScript / JavaScript package **Usage:** `stellar contract bindings typescript [OPTIONS] --output-dir <--wasm |--wasm-hash |--contract-id >` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` @@ -295,11 +305,7 @@ Generate a TypeScript / JavaScript package - `--output-dir ` — Where to place generated project - `--overwrite` — Whether to overwrite output directory if it already exists -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -390,6 +396,10 @@ If no keys are specified the contract itself is extended. **Usage:** `stellar contract extend [OPTIONS] --ledgers-to-extend --source-account ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--ledgers-to-extend ` — Number of ledgers to extend the entries @@ -407,20 +417,7 @@ If no keys are specified the contract itself is extended. - `persistent`: Persistent - `temporary`: Temporary -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -431,6 +428,20 @@ If no keys are specified the contract itself is extended. - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar contract deploy` Deploy a wasm contract @@ -445,6 +456,10 @@ Deploy a wasm contract - `--package ` — Package to build when auto-building without --wasm +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Metadata:** - `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) @@ -454,26 +469,14 @@ Deploy a wasm contract - `--wasm ` — WASM file to deploy. When neither --wasm nor --wasm-hash is provided inside a Cargo workspace, builds the project automatically. One of --wasm or --wasm-hash is required when outside a Cargo workspace - `--wasm-hash ` — Hash of the already installed/deployed WASM file - `--salt ` — Custom salt 32-byte salt for the token id -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `-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 -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--optimize` — Optimize the generated wasm -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -484,23 +487,37 @@ Deploy a wasm contract - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar contract fetch` Fetch a contract's Wasm binary **Usage:** `stellar contract fetch [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--id ` — Contract ID to fetch - `--wasm-hash ` — Wasm to fetch - `-o`, `--out-file ` — Where to write output otherwise stdout is used -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -524,15 +541,15 @@ Deploy builtin Soroban Asset Contract **Usage:** `stellar contract id asset [OPTIONS] --asset ` -###### **Options:** +###### **Global Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -545,28 +562,34 @@ Deploy normal Wasm Contract **Usage:** `stellar contract id wasm [OPTIONS] --salt --source-account ` -###### **Options:** +###### **Global Options:** -- `--salt ` — ID of the Soroban contract -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--salt ` — ID of the Soroban contract -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided + ## `stellar contract info` Access info about contracts @@ -592,6 +615,10 @@ Outputs no data when no data is present in the contract. **Usage:** `stellar contract info interface [OPTIONS] <--wasm |--wasm-hash |--contract-id >` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` @@ -607,11 +634,7 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -630,6 +653,10 @@ Outputs no data when no data is present in the contract. **Usage:** `stellar contract info meta [OPTIONS] <--wasm |--wasm-hash |--contract-id >` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` @@ -645,11 +672,7 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -668,6 +691,10 @@ Outputs no data when no data is present in the contract. **Usage:** `stellar contract info env-meta [OPTIONS] <--wasm |--wasm-hash |--contract-id >` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` @@ -683,11 +710,7 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -702,17 +725,17 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma **Usage:** `stellar contract info build [OPTIONS] <--wasm |--wasm-hash |--contract-id >` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` - `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` - `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -745,6 +768,10 @@ This command will create a Cargo workspace project and add a sample Stellar cont **Usage:** `stellar contract inspect [OPTIONS] --wasm ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--wasm ` — Path to wasm binary @@ -757,10 +784,6 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 upload` Install a WASM file to the ledger without creating a contract instance @@ -771,32 +794,24 @@ Install a WASM file to the ledger without creating a contract instance - `--package ` — Package to build when --wasm is not provided +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Metadata:** - `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace - `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--optimize` — Optimize the generated wasm -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -807,6 +822,20 @@ Install a WASM file to the ledger without creating a contract instance - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar contract install` ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance @@ -817,32 +846,24 @@ Install a WASM file to the ledger without creating a contract instance - `--package ` — Package to build when --wasm is not provided +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Metadata:** - `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ###### **Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--wasm ` — Path to wasm binary. When omitted inside a Cargo workspace, builds the project automatically. Required when outside a Cargo workspace - `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--optimize` — Optimize the generated wasm -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -853,6 +874,20 @@ Install a WASM file to the ledger without creating a contract instance - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar contract invoke` Invoke a contract function @@ -867,17 +902,14 @@ stellar contract invoke ... -- --help - `` — Function name as subcommand, then arguments for that function as `--arg-name value` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--id ` — Contract ID to invoke - `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--send ` — Whether or not to send a transaction Default value: `default` @@ -887,13 +919,7 @@ stellar contract invoke ... -- --help - `no`: Do not send transaction, return simulation result - `yes`: Always send transaction -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -904,6 +930,20 @@ stellar contract invoke ... -- --help - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar contract optimize` ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file @@ -921,6 +961,10 @@ Print the current value of a contract-data ledger entry **Usage:** `stellar contract read [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--output ` — Type of output to generate @@ -945,11 +989,7 @@ Print the current value of a contract-data ledger entry - `persistent`: Persistent - `temporary`: Temporary -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -964,6 +1004,10 @@ If no keys are specificed the contract itself is restored. **Usage:** `stellar contract restore [OPTIONS] --source-account ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended @@ -981,20 +1025,8 @@ 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 -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - -###### **Options (Global):** -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1005,13 +1037,27 @@ If no keys are specificed the contract itself is restored. - `--instruction-leeway ` — Allow this many extra instructions when budgeting resources with transaction simulation - `--cost` — Output the cost execution to stderr +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar doctor` Diagnose and troubleshoot CLI and network issues **Usage:** `stellar doctor [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1047,6 +1093,10 @@ Watch the network for contract events Possible values: `all`, `contract`, `system` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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 @@ -1065,11 +1115,7 @@ Watch the network for contract events Default value: `10` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1094,7 +1140,7 @@ If there are no environment variables in use, prints the defaults. E.g.: $ stellar env STELLAR_ACCOUNT -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1126,6 +1172,10 @@ Add a new identity (keypair, ledger, OS specific secure store) - `` — Name of identity +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted @@ -1141,10 +1191,6 @@ Add a new identity (keypair, ledger, OS specific secure store) - `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry - `--hd-path ` — When importing a seed phrase, which `hd_path` to derive the key at. Persisted on the identity so later commands derive the same account without re-passing the flag. Not valid with `--public-key` or a raw secret key -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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) @@ -1157,15 +1203,15 @@ Given an identity return its address (public key) - `` — Name of identity to lookup. Required unless `--ledger` is provided +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) - `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 fund` Fund an identity on a test network @@ -1176,16 +1222,16 @@ Fund an identity on a test network - `` — Name of identity to lookup. Required unless `--ledger` is provided +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0. With --ledger this is the Ledger account index (default 0) - `--ledger` — Derive the address from a connected Ledger hardware wallet at `m/44'/148'/N'`, where `N` defaults to 0 and can be set with `--hd-path` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1202,6 +1248,10 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store - `` — Name of identity +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--seed ` — Optional seed to use when generating seed phrase. Random otherwise @@ -1217,11 +1267,7 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store - `--overwrite` — Overwrite existing identity if it already exists. When combined with --secure-store, also replaces the existing Secure Store entry -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1234,13 +1280,13 @@ List identities **Usage:** `stellar keys ls [OPTIONS]` -###### **Options:** +###### **Global Options:** -- `-l`, `--long` +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` ## `stellar keys rm` @@ -1252,13 +1298,13 @@ Remove an identity - `` — Identity to remove -###### **Options:** +###### **Global Options:** -- `--force` — Skip confirmation prompt +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--force` — Skip confirmation prompt ## `stellar keys secret` @@ -1270,15 +1316,15 @@ Output an identity's secret key - `` — Name of identity to lookup, default is test identity +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--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):** - -- `--config-dir ` — Location of config directory. 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 use` Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it @@ -1289,7 +1335,7 @@ Set the default identity that will be used on all commands. This allows you to s - `` — Set the default network name -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1299,7 +1345,7 @@ Unset the default key identity defined previously with `keys use ` **Usage:** `stellar keys unset [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1331,11 +1377,11 @@ Add a new network - `` — Name of network -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — Optional header to include in requests to the RPC, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1351,7 +1397,7 @@ Remove a network - `` — Network to remove -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1361,13 +1407,13 @@ List networks **Usage:** `stellar network ls [OPTIONS]` -###### **Options:** +###### **Global Options:** -- `-l`, `--long` — Get more info about the networks +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` — Get more info about the networks ## `stellar network use` @@ -1379,7 +1425,7 @@ Set the default network that will be used on all commands. This allows you to sk - `` — Set the default network name -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1389,6 +1435,10 @@ Fetch the health of the configured RPC **Usage:** `stellar network health [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--output ` — Format of the output @@ -1400,11 +1450,7 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1417,6 +1463,10 @@ Checks the health of the configured RPC **Usage:** `stellar network info [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--output ` — Format of the output @@ -1428,11 +1478,7 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1445,6 +1491,10 @@ Fetch the network's config settings **Usage:** `stellar network settings [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network @@ -1457,11 +1507,7 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1474,7 +1520,7 @@ Unset the default network defined previously with `network use ` **Usage:** `stellar network unset [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1497,30 +1543,30 @@ Output a network's root account address (public key) **Command Alias:** `address` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--network-passphrase ` — Network passphrase to derive the root account from - `-n`, `--network ` — Name of network to use from config -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - ## `stellar network root-account secret` Output a network's root account secret key **Usage:** `stellar network root-account secret [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--network-passphrase ` — Network passphrase to derive the root account from - `-n`, `--network ` — Name of network to use from config -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 container` Start local networks in containers @@ -1612,7 +1658,7 @@ Migrate the local configuration to the global directory **Usage:** `stellar config migrate [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1626,7 +1672,7 @@ The location will depend on how your system is configured. **Usage:** `stellar config dir [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings @@ -1657,11 +1703,19 @@ Any invalid contract id passed as `--address` will be ignored. **Usage:** `stellar snapshot create [OPTIONS]` +###### **Archive Options:** + +- `--archive-url ` — Archive URL + ###### **Filter Options:** - `--address
` — Account or contract address/alias to include in the snapshot - `--wasm-hash ` — WASM hashes to include in the snapshot +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger @@ -1675,15 +1729,7 @@ Any invalid contract id passed as `--address` will be ignored. Default value: `snapshot.json` -###### **Options (Archive):** - -- `--archive-url ` — Archive URL - -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1760,11 +1806,11 @@ Fetch the source account's seq-num and increment for the given tx **Usage:** `stellar tx update sequence-number next [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1795,7 +1841,7 @@ Calculate the hash of a transaction envelope - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -1839,256 +1885,300 @@ Transfer XLM balance to another account and remove source account **Usage:** `stellar tx new account-merge [OPTIONS] --source-account --account ` -###### **Options:** +###### **Global Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--sponsored-id ` — Account that will be sponsored -###### **Options (Global):** +## `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 ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--sponsored-id ` — Account that will be sponsored + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new bump-sequence` - -Bump sequence number to invalidate older transactions - -**Usage:** `stellar tx new bump-sequence [OPTIONS] --source-account --bump-to ` - -###### **Options:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--bump-to ` — Sequence number to bump to -###### **Options (Global):** +## `stellar tx new bump-sequence` + +Bump sequence number to invalidate older transactions + +**Usage:** `stellar tx new bump-sequence [OPTIONS] --source-account --bump-to ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--bump-to ` — Sequence number to bump to + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new change-trust` - -Create, update, or delete a trustline - -**Usage:** `stellar tx new change-trust [OPTIONS] --source-account --line ` - -###### **Options:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line - Default value: `9223372036854775807` +## `stellar tx new change-trust` + +Create, update, or delete a trustline + +**Usage:** `stellar tx new change-trust [OPTIONS] --source-account --line ` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line + + Default value: `9223372036854775807` + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) -###### **Options (Global):** +## `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 ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new clawback` - -Clawback an asset from an account - -**Usage:** `stellar tx new clawback [OPTIONS] --source-account --from --asset --amount ` - -###### **Options:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--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):** +## `stellar tx new clawback` + +Clawback an asset from an account + +**Usage:** `stellar tx new clawback [OPTIONS] --source-account --from --asset --amount ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--from ` — Account to clawback assets from, e.g. `GBX...` +- `--asset ` — Asset to clawback +- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--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):** +## `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 ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new create-account` - -Create and fund a new account - -**Usage:** `stellar tx new create-account [OPTIONS] --source-account --destination ` +###### **Signing Options:** -###### **Options:** - -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--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 new create-account` -###### **Options (Global):** +Create and fund a new account + +**Usage:** `stellar tx new create-account [OPTIONS] --source-account --destination ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--destination ` — Account Id to create, e.g. `GBX...` +- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM + + Default value: `10_000_000` + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` @@ -2099,93 +2189,108 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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 ` +###### **Signing Options:** -###### **Options:** - -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new end-sponsoring-future-reserves` - -End sponsoring future reserves - -**Usage:** `stellar tx new end-sponsoring-future-reserves [OPTIONS] --source-account ` +###### **Signing Options:** -###### **Options:** - -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -###### **Options (Global):** +## `stellar tx new end-sponsoring-future-reserves` + +End sponsoring future reserves + +**Usage:** `stellar tx new end-sponsoring-future-reserves [OPTIONS] --source-account ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--liquidity-pool-id ` — Liquidity pool ID to deposit to - `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops - `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops @@ -2197,65 +2302,77 @@ Deposit assets into a liquidity pool Default value: `1:1` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--liquidity-pool-id ` — Liquidity pool ID to withdraw from - `--amount ` — Amount of pool shares to withdraw, in stroops - `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops - `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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 ` +###### **Signing Options:** -###### **Options:** - -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer @@ -2264,63 +2381,75 @@ Create, update, or delete a buy offer Default value: `0` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new manage-data` - -Set, modify, or delete account data entries - -**Usage:** `stellar tx new manage-data [OPTIONS] --source-account --data-name ` - -###### **Options:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--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):** +## `stellar tx new manage-data` + +Set, modify, or delete account data entries + +**Usage:** `stellar tx new manage-data [OPTIONS] --source-account --data-name ` + +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **Options:** + +- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` + +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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 ` +###### **Signing Options:** -###### **Options:** - -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer @@ -2329,33 +2458,39 @@ Create, update, or delete a sell offer Default value: `0` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--send-asset ` — Asset to send (pay with) - `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--destination ` — Account that receives the payment @@ -2363,33 +2498,39 @@ 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 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--send-asset ` — Asset to send (pay with) - `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) - `--destination ` — Account that receives the payment @@ -2397,33 +2538,39 @@ 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 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new payment` - -Send asset to destination account - -**Usage:** `stellar tx new payment [OPTIONS] --source-account --destination --amount ` +###### **Signing Options:** -###### **Options:** - -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `stellar tx new payment` + +Send asset to destination account + +**Usage:** `stellar tx new payment [OPTIONS] --source-account --destination --amount ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--destination ` — Account to send to, e.g. `GBX...` - `--asset ` — Asset to send, default native, e.i. XLM @@ -2431,16 +2578,26 @@ 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) -###### **Options (Global):** +###### **RPC Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet -###### **Options (RPC):** +###### **Transaction Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar tx new revoke-sponsorship` @@ -2448,16 +2605,12 @@ Revoke sponsorship of a ledger entry or signer **Usage:** `stellar tx new revoke-sponsorship [OPTIONS] --source-account --account-id ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--account-id ` — Account ID (required for all sponsorship types) - `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) - `--data-name ` — Data name for data entry sponsorship @@ -2466,33 +2619,39 @@ 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 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar tx new set-options` - -Set account options like flags, signers, and home domain - -**Usage:** `stellar tx new set-options [OPTIONS] --source-account ` - -###### **Options:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `stellar tx new set-options` + +Set account options like flags, signers, and home domain + +**Usage:** `stellar tx new set-options [OPTIONS] --source-account ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--inflation-dest ` — Account of the inflation destination - `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled - `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig @@ -2510,33 +2669,39 @@ Set account options like flags, signers, and home domain - `--clear-immutable` - `--clear-clawback-enabled` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config -## `stellar 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:** +###### **Signing Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout + +## `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 ` + +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + +###### **Options:** + - `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` - `--asset ` — Asset to set trustline flags for - `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders @@ -2546,17 +2711,27 @@ Configure authorization and trustline flags for an asset - `--clear-authorize-to-maintain-liabilities` - `--clear-trustline-clawback-enabled` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation` Manipulate the operations in a transaction, including adding new operations @@ -2610,30 +2785,36 @@ Transfer XLM balance to another account and remove source account - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add begin-sponsoring-future-reserves` Begin sponsoring future reserves for another account @@ -2644,30 +2825,36 @@ Begin sponsoring future reserves for another account - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--sponsored-id ` — Account that will be sponsored -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add bump-sequence` Bump sequence number to invalidate older transactions @@ -2678,30 +2865,36 @@ Bump sequence number to invalidate older transactions - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--bump-to ` — Sequence number to bump to -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add change-trust` Create, update, or delete a trustline @@ -2712,33 +2905,39 @@ Create, update, or delete a trustline - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--line ` - `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add claim-claimable-balance` Claim a claimable balance by its balance ID @@ -2749,30 +2948,36 @@ Claim a claimable balance by its balance ID - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add clawback` Clawback an asset from an account @@ -2783,32 +2988,38 @@ Clawback an asset from an account - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add clawback-claimable-balance` Clawback a claimable balance by its balance ID @@ -2819,29 +3030,35 @@ Clawback a claimable balance by its balance ID - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA + +###### **RPC Options:** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + +###### **Signing Options:** + - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--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):** - -- `--config-dir ` — Location of config directory. 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, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config ## `stellar tx operation add create-account` @@ -2853,33 +3070,39 @@ Create and fund a new account - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add create-claimable-balance` Create a claimable balance that can be claimed by specified accounts @@ -2890,17 +3113,13 @@ Create a claimable balance that can be claimed by specified accounts - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` @@ -2911,17 +3130,27 @@ 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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add create-passive-sell-offer` Create a passive sell offer on the Stellar DEX @@ -2932,33 +3161,39 @@ Create a passive sell offer on the Stellar DEX - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add end-sponsoring-future-reserves` End sponsoring future reserves @@ -2969,29 +3204,35 @@ End sponsoring future reserves - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail + +###### **RPC Options:** + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config + +###### **Signing Options:** + - `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path - `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` - `--sign-with-lab` — Sign with https://lab.stellar.org - `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail - `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - `--build-only` — Build the transaction and only write the base64 xdr to stdout -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - ## `stellar tx operation add liquidity-pool-deposit` Deposit assets into a liquidity pool @@ -3002,17 +3243,13 @@ Deposit assets into a liquidity pool - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--liquidity-pool-id ` — Liquidity pool ID to deposit to - `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops - `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops @@ -3024,17 +3261,27 @@ Deposit assets into a liquidity pool Default value: `1:1` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add liquidity-pool-withdraw` Withdraw assets from a liquidity pool @@ -3045,33 +3292,39 @@ Withdraw assets from a liquidity pool - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--liquidity-pool-id ` — Liquidity pool ID to withdraw from - `--amount ` — Amount of pool shares to withdraw, in stroops - `--min-amount-a ` — Minimum amount of the first asset to receive, in stroops - `--min-amount-b ` — Minimum amount of the second asset to receive, in stroops -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add manage-buy-offer` Create, update, or delete a buy offer @@ -3082,17 +3335,13 @@ Create, update, or delete a buy offer - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer @@ -3101,17 +3350,27 @@ Create, update, or delete a buy offer Default value: `0` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add manage-data` Set, modify, or delete account data entries @@ -3122,31 +3381,37 @@ Set, modify, or delete account data entries - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--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):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add manage-sell-offer` Create, update, or delete a sell offer @@ -3157,17 +3422,13 @@ Create, update, or delete a sell offer - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--selling ` — Asset to sell - `--buying ` — Asset to buy - `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer @@ -3176,17 +3437,27 @@ Create, update, or delete a sell offer Default value: `0` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add path-payment-strict-receive` Send a payment with a different asset using path finding, specifying the receive amount @@ -3197,17 +3468,13 @@ Send a payment with a different asset using path finding, specifying the receive - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--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 @@ -3215,17 +3482,27 @@ 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 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add path-payment-strict-send` Send a payment with a different asset using path finding, specifying the send amount @@ -3236,17 +3513,13 @@ Send a payment with a different asset using path finding, specifying the send am - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--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 @@ -3254,17 +3527,27 @@ 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 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add payment` Send asset to destination account @@ -3275,17 +3558,13 @@ Send asset to destination account - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--destination ` — Account to send to, e.g. `GBX...` - `--asset ` — Asset to send, default native, e.i. XLM @@ -3293,17 +3572,27 @@ 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) -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add revoke-sponsorship` Revoke sponsorship of a ledger entry or signer @@ -3314,17 +3603,13 @@ Revoke sponsorship of a ledger entry or signer - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--account-id ` — Account ID (required for all sponsorship types) - `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) - `--data-name ` — Data name for data entry sponsorship @@ -3333,17 +3618,27 @@ 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 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add set-options` Set account options like flags, signers, and home domain @@ -3354,17 +3649,13 @@ Set account options like flags, signers, and home domain - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--inflation-dest ` — Account of the inflation destination - `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled - `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig @@ -3382,17 +3673,27 @@ Set account options like flags, signers, and home domain - `--clear-immutable` - `--clear-clawback-enabled` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx operation add set-trustline-flags` Configure authorization and trustline flags for an asset @@ -3403,17 +3704,13 @@ Configure authorization and trustline flags for an asset - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **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` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--build-only` — Build the transaction and only write the base64 xdr to stdout - `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` - `--asset ` — Asset to set trustline flags for - `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders @@ -3423,17 +3720,27 @@ Configure authorization and trustline flags for an asset - `--clear-authorize-to-maintain-liabilities` - `--clear-trustline-clawback-enabled` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided +- `--build-only` — Build the transaction and only write the base64 xdr to stdout + ## `stellar tx send` Send a transaction envelope to the network @@ -3444,11 +3751,11 @@ Send a transaction envelope to the network - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -3465,24 +3772,24 @@ Sign a transaction envelope appending the signature to the envelope - `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty -###### **Options:** - -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet - -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + ## `stellar tx simulate` Simulate a transaction envelope from stdin @@ -3493,28 +3800,34 @@ Simulate a transaction envelope from stdin - `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty -###### **Options:** +###### **Global Options:** -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_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 ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm -- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided -- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times - `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server - `-n`, `--network ` — Name of network to use from config +###### **Signing Options:** + +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet + +###### **Transaction Options:** + +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` was NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--fee ` — ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--inclusion-fee ` — Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided + ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned @@ -3540,7 +3853,7 @@ 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -3565,7 +3878,7 @@ Fetch the transaction result - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -3590,7 +3903,7 @@ Fetch the transaction meta - `json-formatted`: Formatted (multiline) JSON output with parsed XDRs - `xdr`: Original RPC output (containing XDRs) -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -3615,7 +3928,7 @@ 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -3640,7 +3953,7 @@ 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4064,13 +4377,13 @@ List cached actions (transactions, simulations) **Usage:** `stellar cache actionlog ls [OPTIONS]` -###### **Options:** +###### **Global Options:** -- `-l`, `--long` +- `--config-dir ` — Location of config directory. 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 (Global):** +###### **Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` ## `stellar cache actionlog read` @@ -4161,6 +4474,10 @@ Fetch account entry by public key or alias **Usage:** `stellar ledger entry fetch account [OPTIONS] --account ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--account ` — Account alias or address to lookup @@ -4175,11 +4492,7 @@ Fetch account entry by public key or alias - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4192,6 +4505,10 @@ Fetch contract ledger entry by address or alias and storage key **Usage:** `stellar ledger entry fetch contract-data [OPTIONS] --contract ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--contract ` — Contract alias or address to fetch @@ -4216,11 +4533,7 @@ Fetch contract ledger entry by address or alias and storage key - `--key-xdr ` — Storage key (base64-encoded XDR) - `--instance` — If the contract instance ledger entry should be included in the output -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4233,6 +4546,10 @@ Fetch a claimable balance ledger entry by id **Usage:** `stellar ledger entry fetch claimable-balance [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--id ` — Claimable Balance Ids to fetch an entry for @@ -4245,11 +4562,7 @@ Fetch a claimable balance ledger entry by id - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4262,6 +4575,10 @@ Fetch a liquidity pool ledger entry by id **Usage:** `stellar ledger entry fetch liquidity-pool [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--id ` — Liquidity pool ids @@ -4274,11 +4591,7 @@ Fetch a liquidity pool ledger entry by id - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4291,6 +4604,10 @@ Fetch a Contract's WASM bytecode by WASM hash **Usage:** `stellar ledger entry fetch contract-code [OPTIONS]` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--wasm-hash ` — Get WASM bytecode by hash @@ -4303,11 +4620,7 @@ Fetch a Contract's WASM bytecode by WASM hash - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - `xdr`: Original RPC output (containing XDRs) -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4320,6 +4633,10 @@ Fetch a trustline by account and asset **Usage:** `stellar ledger entry fetch trustline [OPTIONS] --account --asset ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--output ` — Format of the output @@ -4335,11 +4652,7 @@ Fetch a trustline by account and asset - `--asset ` — Assets to get trustline info for - `--hd-path ` — If account is a seed phrase use this hd path, default is 0 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4352,6 +4665,10 @@ Fetch key-value data entries attached to an account (see manageDataOp) **Usage:** `stellar ledger entry fetch data [OPTIONS] --account --data-name ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--output ` — Format of the output @@ -4367,11 +4684,7 @@ Fetch key-value data entries attached to an account (see manageDataOp) - `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4384,6 +4697,10 @@ Fetch an offer by account and offer id **Usage:** `stellar ledger entry fetch offer [OPTIONS] --account --offer ` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--output ` — Format of the output @@ -4399,11 +4716,7 @@ Fetch an offer by account and offer id - `--offer ` — ID of an offer made on the Stellar DEX - `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4427,7 +4740,7 @@ 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4465,7 +4778,7 @@ 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4497,15 +4810,18 @@ Example: stellar message sign "Hello, World!" --sign-with-key alice - `` — The message to sign. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--base64` — Treat the message as base64-encoded binary data -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -###### **Options (Global):** +###### **Signing Options:** -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` ## `stellar message verify` @@ -4521,6 +4837,10 @@ Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public- - `` — The message to verify. If not provided, reads from stdin. This should **not** include the SEP-53 prefix "Stellar Signed Message:\n", as it will be added automatically +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--base64` — Treat the message as base64-encoded binary data @@ -4528,10 +4848,6 @@ Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public- - `-p`, `--public-key ` — The public key to verify the signature against. Can be an identity (--public-key alice), a public key (--public-key GDKW...) - `--hd-path ` — If public key identity is a seed phrase use this hd path, default is 0 -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 fee-stats` ⚠️ Deprecated, use `fees stats` instead. Fetch network feestats @@ -4549,7 +4865,7 @@ Example: stellar message verify "Hello, World!" --signature BASE64_SIG --public- - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4585,7 +4901,7 @@ Fetch the feestats from the network - `json`: JSON result of the RPC request - `json-formatted`: Formatted (multiline) JSON output of the RPC request -###### **Options (RPC):** +###### **RPC Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4598,6 +4914,10 @@ Set the default inclusion fee settings for the CLI **Usage:** `stellar fees use [OPTIONS] <--amount |--fee-metric >` +###### **Global Options:** + +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + ###### **Options:** - `--amount ` — Set the default inclusion fee amount, in stroops. 1 stroop = 0.0000001 xlm @@ -4605,11 +4925,7 @@ Set the default inclusion fee settings for the CLI Possible values: `max`, `min`, `mode`, `p10`, `p20`, `p30`, `p40`, `p50`, `p60`, `p70`, `p80`, `p90`, `p95`, `p99` -###### **Options (Global):** - -- `--config-dir ` — Location of config directory. 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 Options:** - `--rpc-url ` — RPC server endpoint - `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider, example: "X-API-Key: abc123". Multiple headers can be added by passing the option multiple times @@ -4622,6 +4938,6 @@ Remove the default inclusion fee settings for the CLI **Usage:** `stellar fees unset [OPTIONS]` -###### **Options (Global):** +###### **Global Options:** - `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings diff --git a/cmd/soroban-cli/src/commands/contract/deploy/asset.rs b/cmd/soroban-cli/src/commands/contract/deploy/asset.rs index 601ecb2f19..5aa4c408b7 100644 --- a/cmd/soroban-cli/src/commands/contract/deploy/asset.rs +++ b/cmd/soroban-cli/src/commands/contract/deploy/asset.rs @@ -17,6 +17,7 @@ use crate::{ commands::{ global, txn_result::{TxnEnvelopeResult, TxnResult}, + HEADING_TRANSACTION, }, config::{self, data, network}, rpc::Error as SorobanRpcError, @@ -91,7 +92,7 @@ pub struct Cmd { pub alias: Option, /// Build the transaction and only write the base64 xdr to stdout - #[arg(long)] + #[arg(long, help_heading = HEADING_TRANSACTION)] pub build_only: bool, } diff --git a/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs b/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs index 0ece438f53..dbfe34caaf 100644 --- a/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs +++ b/cmd/soroban-cli/src/commands/contract/deploy/wasm.rs @@ -24,6 +24,7 @@ use crate::{ contract::{self, arg_parsing, build, id::wasm::get_contract_id, upload}, global, txn_result::{TxnEnvelopeResult, TxnResult}, + HEADING_TRANSACTION, }, config::{self, data, locator, network}, print::Print, @@ -66,7 +67,7 @@ pub struct Cmd { #[command(flatten)] pub resources: resources::Args, /// Build the transaction and only write the base64 xdr to stdout - #[arg(long)] + #[arg(long, help_heading = HEADING_TRANSACTION)] pub build_only: bool, /// If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` #[arg(last = true, id = "CONTRACT_CONSTRUCTOR_ARGS")] diff --git a/cmd/soroban-cli/src/commands/contract/extend.rs b/cmd/soroban-cli/src/commands/contract/extend.rs index 09b3a8e0d3..17373f96ca 100644 --- a/cmd/soroban-cli/src/commands/contract/extend.rs +++ b/cmd/soroban-cli/src/commands/contract/extend.rs @@ -21,6 +21,7 @@ use crate::{ commands::{ global, txn_result::{TxnEnvelopeResult, TxnResult}, + HEADING_TRANSACTION, }, config::{self, data, locator, network}, key, rpc, wasm, Pwd, @@ -47,7 +48,7 @@ pub struct Cmd { pub resources: resources::Args, /// Build the transaction and only write the base64 xdr to stdout - #[arg(long)] + #[arg(long, help_heading = HEADING_TRANSACTION)] pub build_only: bool, } diff --git a/cmd/soroban-cli/src/commands/contract/invoke.rs b/cmd/soroban-cli/src/commands/contract/invoke.rs index 2e4fbded8c..c5641dc88f 100644 --- a/cmd/soroban-cli/src/commands/contract/invoke.rs +++ b/cmd/soroban-cli/src/commands/contract/invoke.rs @@ -24,6 +24,7 @@ use crate::{ global, tx::fetch::fee, txn_result::{TxnEnvelopeResult, TxnResult}, + HEADING_TRANSACTION, }, config::{self, data, locator, network}, get_spec::{self, get_remote_contract_spec}, @@ -70,7 +71,7 @@ pub struct Cmd { pub send: Send, /// Build the transaction and only write the base64 xdr to stdout - #[arg(long)] + #[arg(long, help_heading = HEADING_TRANSACTION)] pub build_only: bool, } diff --git a/cmd/soroban-cli/src/commands/contract/restore.rs b/cmd/soroban-cli/src/commands/contract/restore.rs index 9de43bb189..7f75462a68 100644 --- a/cmd/soroban-cli/src/commands/contract/restore.rs +++ b/cmd/soroban-cli/src/commands/contract/restore.rs @@ -20,6 +20,7 @@ use crate::{ contract::extend, global, txn_result::{TxnEnvelopeResult, TxnResult}, + HEADING_TRANSACTION, }, config::{self, data, locator, network}, key, rpc, wasm, Pwd, @@ -46,7 +47,7 @@ pub struct Cmd { pub resources: crate::resources::Args, /// Build the transaction and only write the base64 xdr to stdout - #[arg(long)] + #[arg(long, help_heading = HEADING_TRANSACTION)] pub build_only: bool, } diff --git a/cmd/soroban-cli/src/commands/contract/upload.rs b/cmd/soroban-cli/src/commands/contract/upload.rs index 5f7743cf3c..463adf5d21 100644 --- a/cmd/soroban-cli/src/commands/contract/upload.rs +++ b/cmd/soroban-cli/src/commands/contract/upload.rs @@ -16,6 +16,7 @@ use crate::{ commands::{ global, txn_result::{TxnEnvelopeResult, TxnResult}, + HEADING_TRANSACTION, }, config::{self, data, network}, key, @@ -50,7 +51,7 @@ pub struct Cmd { pub ignore_checks: bool, /// Build the transaction and only write the base64 xdr to stdout - #[arg(long)] + #[arg(long, help_heading = HEADING_TRANSACTION)] pub build_only: bool, /// Package to build when --wasm is not provided diff --git a/cmd/soroban-cli/src/commands/message/sign.rs b/cmd/soroban-cli/src/commands/message/sign.rs index 41e41fc5f0..3a20e0dccb 100644 --- a/cmd/soroban-cli/src/commands/message/sign.rs +++ b/cmd/soroban-cli/src/commands/message/sign.rs @@ -5,7 +5,7 @@ use clap::Parser; use sha2::{Digest, Sha256}; use crate::{ - commands::global, + commands::{global, HEADING_SIGNING}, config::{locator, secret}, print::Print, signer::{self, Signer}, @@ -57,10 +57,15 @@ pub struct Cmd { // @dev: Ledger and Lab don't support signing arbitrary messages yet. Once they do, use `sign_with::Args` here. /// Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path. - #[arg(long, env = "STELLAR_SIGN_WITH_KEY", hide_env_values = true)] + #[arg( + long, + env = "STELLAR_SIGN_WITH_KEY", + hide_env_values = true, + help_heading = HEADING_SIGNING + )] pub sign_with_key: String, - #[arg(long)] + #[arg(long, help_heading = HEADING_SIGNING)] /// If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` pub hd_path: Option, diff --git a/cmd/soroban-cli/src/commands/mod.rs b/cmd/soroban-cli/src/commands/mod.rs index d470edb773..4da22942ac 100644 --- a/cmd/soroban-cli/src/commands/mod.rs +++ b/cmd/soroban-cli/src/commands/mod.rs @@ -26,9 +26,11 @@ pub mod version; pub mod txn_result; -pub const HEADING_RPC: &str = "Options (RPC)"; -pub const HEADING_ARCHIVE: &str = "Options (Archive)"; -pub const HEADING_GLOBAL: &str = "Options (Global)"; +pub const HEADING_RPC: &str = "RPC Options"; +pub const HEADING_ARCHIVE: &str = "Archive Options"; +pub const HEADING_GLOBAL: &str = "Global Options"; +pub const HEADING_SIGNING: &str = "Signing Options"; +pub const HEADING_TRANSACTION: &str = "Transaction Options"; const ABOUT: &str = "Work seamlessly with Stellar accounts, contracts, and assets from the command line. diff --git a/cmd/soroban-cli/src/commands/tx/args.rs b/cmd/soroban-cli/src/commands/tx/args.rs index 265f92a9fb..4556a042a7 100644 --- a/cmd/soroban-cli/src/commands/tx/args.rs +++ b/cmd/soroban-cli/src/commands/tx/args.rs @@ -1,5 +1,5 @@ use crate::{ - commands::{global, txn_result::TxnEnvelopeResult}, + commands::{global, txn_result::TxnEnvelopeResult, HEADING_TRANSACTION}, config::{ self, address::{self, UnresolvedMuxedAccount}, @@ -16,7 +16,7 @@ pub struct Args { #[clap(flatten)] pub config: config::Args, /// Build the transaction and only write the base64 xdr to stdout - #[arg(long)] + #[arg(long, help_heading = HEADING_TRANSACTION)] pub build_only: bool, } diff --git a/cmd/soroban-cli/src/config/mod.rs b/cmd/soroban-cli/src/config/mod.rs index b773eb5d6f..b24e9f855a 100644 --- a/cmd/soroban-cli/src/config/mod.rs +++ b/cmd/soroban-cli/src/config/mod.rs @@ -5,6 +5,7 @@ use std::{ }; use crate::{ + commands::HEADING_TRANSACTION, print::Print, signer::{self, Signer}, utils::deprecate_message, @@ -59,7 +60,13 @@ pub struct Args { #[command(flatten)] pub network: network::Args, - #[arg(long, short = 's', visible_alias = "source", env = "STELLAR_ACCOUNT")] + #[arg( + long, + short = 's', + visible_alias = "source", + env = "STELLAR_ACCOUNT", + help_heading = HEADING_TRANSACTION + )] /// Account that where transaction originates from. Alias `source`. /// Can be an identity (--source alice), a public key (--source GDKW...), /// a muxed account (--source MDA…), a secret key (--source SC36…), @@ -75,11 +82,15 @@ pub struct Args { pub sign_with: sign_with::Args, /// ⚠️ Deprecated, use `--inclusion-fee`. Fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm - #[arg(long, env = "STELLAR_FEE")] + #[arg(long, env = "STELLAR_FEE", help_heading = HEADING_TRANSACTION)] pub fee: Option, /// Maximum fee amount for transaction inclusion, in stroops. 1 stroop = 0.0000001 xlm. Defaults to 100 if no arg, env, or config value is provided - #[arg(long, env = "STELLAR_INCLUSION_FEE")] + #[arg( + long, + env = "STELLAR_INCLUSION_FEE", + help_heading = HEADING_TRANSACTION + )] pub inclusion_fee: Option, } diff --git a/cmd/soroban-cli/src/config/sign_with.rs b/cmd/soroban-cli/src/config/sign_with.rs index 6dd68904a1..b026653fd6 100644 --- a/cmd/soroban-cli/src/config/sign_with.rs +++ b/cmd/soroban-cli/src/config/sign_with.rs @@ -10,6 +10,7 @@ use super::{ network::{self, Network}, secret, }; +use crate::commands::HEADING_SIGNING; #[derive(thiserror::Error, Debug)] pub enum Error { @@ -37,16 +38,26 @@ pub enum Error { #[group(skip)] pub struct Args { /// Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path. - #[arg(long, env = "STELLAR_SIGN_WITH_KEY", hide_env_values = true)] + #[arg( + long, + env = "STELLAR_SIGN_WITH_KEY", + hide_env_values = true, + help_heading = HEADING_SIGNING + )] pub sign_with_key: Option, - #[arg(long, conflicts_with = "sign_with_lab")] + #[arg(long, conflicts_with = "sign_with_lab", help_heading = HEADING_SIGNING)] /// If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` pub hd_path: Option, #[allow(clippy::doc_markdown)] /// Sign with https://lab.stellar.org - #[arg(long, conflicts_with = "sign_with_key", env = "STELLAR_SIGN_WITH_LAB")] + #[arg( + long, + conflicts_with = "sign_with_key", + env = "STELLAR_SIGN_WITH_LAB", + help_heading = HEADING_SIGNING + )] pub sign_with_lab: bool, /// Sign with a ledger wallet @@ -54,7 +65,8 @@ pub struct Args { long, conflicts_with = "sign_with_key", conflicts_with = "sign_with_lab", - env = "STELLAR_SIGN_WITH_LEDGER" + env = "STELLAR_SIGN_WITH_LEDGER", + help_heading = HEADING_SIGNING )] pub sign_with_ledger: bool, }