You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: FULL_HELP_DOCS.md
+128Lines changed: 128 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1706,6 +1706,7 @@ Create a new transaction
1706
1706
###### **Subcommands:**
1707
1707
1708
1708
*`account-merge` — Transfer XLM balance to another account and remove source account
1709
+
*`begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account
1709
1710
*`bump-sequence` — Bump sequence number to invalidate older transactions
1710
1711
*`change-trust` — Create, update, or delete a trustline
1711
1712
*`claim-claimable-balance` — Claim a claimable balance by its balance ID
@@ -1714,6 +1715,7 @@ Create a new transaction
1714
1715
*`create-account` — Create and fund a new account
1715
1716
*`create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts
1716
1717
*`create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX
1718
+
*`end-sponsoring-future-reserves` — End sponsoring future reserves
1717
1719
*`liquidity-pool-deposit` — Deposit assets into a liquidity pool
1718
1720
*`liquidity-pool-withdraw` — Withdraw assets from a liquidity pool
1719
1721
*`manage-buy-offer` — Create, update, or delete a buy offer
@@ -1756,6 +1758,35 @@ Transfer XLM balance to another account and remove source account
1756
1758
1757
1759
1758
1760
1761
+
## `stellar tx new begin-sponsoring-future-reserves`
1762
+
1763
+
Begin sponsoring future reserves for another account
1764
+
1765
+
**Usage:**`stellar tx new begin-sponsoring-future-reserves [OPTIONS] --source-account <SOURCE_ACCOUNT> --sponsored-id <SPONSORED_ID>`
1766
+
1767
+
###### **Options:**
1768
+
1769
+
*`--fee <FEE>` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
1770
+
1771
+
Default value: `100`
1772
+
*`--cost` — Output the cost execution to stderr
1773
+
*`--instructions <INSTRUCTIONS>` — Number of instructions to simulate
1774
+
*`--build-only` — Build the transaction and only write the base64 xdr to stdout
1775
+
*`--rpc-url <RPC_URL>` — RPC server endpoint
1776
+
*`--rpc-header <RPC_HEADERS>` — RPC Header(s) to include in requests to the RPC provider
1777
+
*`--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
1778
+
*`-n`, `--network <NETWORK>` — Name of network to use from config
1779
+
*`-s`, `--source-account <SOURCE_ACCOUNT>`[alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail
1780
+
*`--global` — ⚠️ Deprecated: global config is always on
1781
+
*`--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
1782
+
*`--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
1783
+
*`--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
1784
+
*`--sign-with-lab` — Sign with https://lab.stellar.org
1785
+
*`--sign-with-ledger` — Sign with a ledger wallet
1786
+
*`--sponsored-id <SPONSORED_ID>` — Account that will be sponsored
1787
+
1788
+
1789
+
1759
1790
## `stellar tx new bump-sequence`
1760
1791
1761
1792
Bump sequence number to invalidate older transactions
@@ -2007,6 +2038,34 @@ Create a passive sell offer on the Stellar DEX
2007
2038
2008
2039
2009
2040
2041
+
## `stellar tx new end-sponsoring-future-reserves`
2042
+
2043
+
End sponsoring future reserves
2044
+
2045
+
**Usage:**`stellar tx new end-sponsoring-future-reserves [OPTIONS] --source-account <SOURCE_ACCOUNT>`
2046
+
2047
+
###### **Options:**
2048
+
2049
+
*`--fee <FEE>` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
2050
+
2051
+
Default value: `100`
2052
+
*`--cost` — Output the cost execution to stderr
2053
+
*`--instructions <INSTRUCTIONS>` — Number of instructions to simulate
2054
+
*`--build-only` — Build the transaction and only write the base64 xdr to stdout
2055
+
*`--rpc-url <RPC_URL>` — RPC server endpoint
2056
+
*`--rpc-header <RPC_HEADERS>` — RPC Header(s) to include in requests to the RPC provider
2057
+
*`--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
2058
+
*`-n`, `--network <NETWORK>` — Name of network to use from config
2059
+
*`-s`, `--source-account <SOURCE_ACCOUNT>`[alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail
2060
+
*`--global` — ⚠️ Deprecated: global config is always on
2061
+
*`--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
2062
+
*`--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
2063
+
*`--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
2064
+
*`--sign-with-lab` — Sign with https://lab.stellar.org
2065
+
*`--sign-with-ledger` — Sign with a ledger wallet
2066
+
2067
+
2068
+
2010
2069
## `stellar tx new liquidity-pool-deposit`
2011
2070
2012
2071
Deposit assets into a liquidity pool
@@ -2380,6 +2439,7 @@ Add Operation to a transaction
2380
2439
###### **Subcommands:**
2381
2440
2382
2441
*`account-merge` — Transfer XLM balance to another account and remove source account
2442
+
*`begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account
2383
2443
*`bump-sequence` — Bump sequence number to invalidate older transactions
2384
2444
*`change-trust` — Create, update, or delete a trustline
2385
2445
*`claim-claimable-balance` — Claim a claimable balance by its balance ID
@@ -2388,6 +2448,7 @@ Add Operation to a transaction
2388
2448
*`create-account` — Create and fund a new account
2389
2449
*`create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts
2390
2450
*`create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX
2451
+
*`end-sponsoring-future-reserves` — End sponsoring future reserves
2391
2452
*`liquidity-pool-deposit` — Deposit assets into a liquidity pool
2392
2453
*`liquidity-pool-withdraw` — Withdraw assets from a liquidity pool
2393
2454
*`manage-buy-offer` — Create, update, or delete a buy offer
@@ -2435,6 +2496,40 @@ Transfer XLM balance to another account and remove source account
*`<TX_XDR>` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty
2508
+
2509
+
###### **Options:**
2510
+
2511
+
*`--operation-source-account <OPERATION_SOURCE_ACCOUNT>`[alias: `op-source`] — Source account used for the operation
2512
+
*`--fee <FEE>` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
2513
+
2514
+
Default value: `100`
2515
+
*`--cost` — Output the cost execution to stderr
2516
+
*`--instructions <INSTRUCTIONS>` — Number of instructions to simulate
2517
+
*`--build-only` — Build the transaction and only write the base64 xdr to stdout
2518
+
*`--rpc-url <RPC_URL>` — RPC server endpoint
2519
+
*`--rpc-header <RPC_HEADERS>` — RPC Header(s) to include in requests to the RPC provider
2520
+
*`--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
2521
+
*`-n`, `--network <NETWORK>` — Name of network to use from config
2522
+
*`-s`, `--source-account <SOURCE_ACCOUNT>`[alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail
2523
+
*`--global` — ⚠️ Deprecated: global config is always on
2524
+
*`--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
2525
+
*`--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
2526
+
*`--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
2527
+
*`--sign-with-lab` — Sign with https://lab.stellar.org
2528
+
*`--sign-with-ledger` — Sign with a ledger wallet
2529
+
*`--sponsored-id <SPONSORED_ID>` — Account that will be sponsored
2530
+
2531
+
2532
+
2438
2533
## `stellar tx operation add bump-sequence`
2439
2534
2440
2535
Bump sequence number to invalidate older transactions
@@ -2726,6 +2821,39 @@ Create a passive sell offer on the Stellar DEX
*`<TX_XDR>` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty
2833
+
2834
+
###### **Options:**
2835
+
2836
+
*`--operation-source-account <OPERATION_SOURCE_ACCOUNT>`[alias: `op-source`] — Source account used for the operation
2837
+
*`--fee <FEE>` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm
2838
+
2839
+
Default value: `100`
2840
+
*`--cost` — Output the cost execution to stderr
2841
+
*`--instructions <INSTRUCTIONS>` — Number of instructions to simulate
2842
+
*`--build-only` — Build the transaction and only write the base64 xdr to stdout
2843
+
*`--rpc-url <RPC_URL>` — RPC server endpoint
2844
+
*`--rpc-header <RPC_HEADERS>` — RPC Header(s) to include in requests to the RPC provider
2845
+
*`--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
2846
+
*`-n`, `--network <NETWORK>` — Name of network to use from config
2847
+
*`-s`, `--source-account <SOURCE_ACCOUNT>`[alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail
2848
+
*`--global` — ⚠️ Deprecated: global config is always on
2849
+
*`--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
2850
+
*`--sign-with-key <SIGN_WITH_KEY>` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path
2851
+
*`--hd-path <HD_PATH>` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0`
2852
+
*`--sign-with-lab` — Sign with https://lab.stellar.org
0 commit comments