From 47a6133cc7d7ee6e6fa260e45ba923ae476b0012 Mon Sep 17 00:00:00 2001 From: Gleb Date: Wed, 16 Apr 2025 16:46:13 -0700 Subject: [PATCH 01/76] Add entry get implementation: account entry --- Cargo.lock | 3 +- Cargo.toml | 4 +- .../src/commands/contract/extend.rs | 2 +- cmd/soroban-cli/src/commands/contract/read.rs | 6 +- .../src/commands/ledger/entry/get.rs | 104 ++++++++++++++++++ .../src/commands/ledger/entry/mod.rs | 23 ++++ cmd/soroban-cli/src/commands/ledger/mod.rs | 25 +++++ cmd/soroban-cli/src/commands/mod.rs | 9 ++ 8 files changed, 169 insertions(+), 7 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/get.rs create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/mod.rs create mode 100644 cmd/soroban-cli/src/commands/ledger/mod.rs diff --git a/Cargo.lock b/Cargo.lock index cb1b2d372f..212d60c9ef 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4825,8 +4825,7 @@ dependencies = [ [[package]] name = "stellar-rpc-client" version = "22.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d3ce469900dde4426b3456692fd2778ac9c50d55195aed93188f153358b71f63" +source = "git+https://github.com/stellar/rs-stellar-rpc-client?branch=serde-le#a8659895a4b7d4f61481b523e086cc5dd560f69c" dependencies = [ "clap", "hex", diff --git a/Cargo.toml b/Cargo.toml index 72ecf7ba99..cca79b52fe 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -64,7 +64,9 @@ version = "=22.0.4" # Dependencies from the rs-stellar-rpc-client repo: [workspace.dependencies.soroban-rpc] package = "stellar-rpc-client" -version = "=22.1.0" +#version = "=22.1.0" +git = "https://github.com/stellar/rs-stellar-rpc-client" +branch = "serde-le" [workspace.dependencies.stellar-ledger] version = "=22.8.0" diff --git a/cmd/soroban-cli/src/commands/contract/extend.rs b/cmd/soroban-cli/src/commands/contract/extend.rs index fcbfc0d537..58f14b21de 100644 --- a/cmd/soroban-cli/src/commands/contract/extend.rs +++ b/cmd/soroban-cli/src/commands/contract/extend.rs @@ -207,7 +207,7 @@ impl NetworkRunnable for Cmd { if operations[0].changes.is_empty() { let entry = client.get_full_ledger_entries(&keys).await?; - let extension = entry.entries[0].live_until_ledger_seq; + let extension = entry.entries[0].live_until_ledger_seq.unwrap_or_default(); if entry.latest_ledger + i64::from(extend_to) < i64::from(extension) { return Ok(TxnResult::Res(extension)); } diff --git a/cmd/soroban-cli/src/commands/contract/read.rs b/cmd/soroban-cli/src/commands/contract/read.rs index 58efc93b7c..4977bd7cb6 100644 --- a/cmd/soroban-cli/src/commands/contract/read.rs +++ b/cmd/soroban-cli/src/commands/contract/read.rs @@ -123,7 +123,7 @@ impl Cmd { error: e, })?, last_modified_ledger.to_string(), - live_until_ledger_seq.to_string(), + live_until_ledger_seq.unwrap_or_default().to_string(), ], Output::Json => [ serde_json::to_string_pretty(&key).map_err(|error| { @@ -144,7 +144,7 @@ impl Cmd { error, } })?, - serde_json::to_string_pretty(&live_until_ledger_seq).map_err(|error| { + serde_json::to_string_pretty(&live_until_ledger_seq.unwrap_or_default()).map_err(|error| { Error::CannotPrintJsonResult { result: val.clone(), error, @@ -155,7 +155,7 @@ impl Cmd { key.to_xdr_base64(Limits::none())?, val.to_xdr_base64(Limits::none())?, last_modified_ledger.to_xdr_base64(Limits::none())?, - live_until_ledger_seq.to_xdr_base64(Limits::none())?, + live_until_ledger_seq.unwrap_or_default().to_xdr_base64(Limits::none())?, ], }; out.write_record(output) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/get.rs b/cmd/soroban-cli/src/commands/ledger/entry/get.rs new file mode 100644 index 0000000000..bc409228ac --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/get.rs @@ -0,0 +1,104 @@ + +use std::fmt::Debug; + +use clap::{command, Parser}; +use stellar_xdr::curr::{LedgerKey, LedgerKeyAccount, MuxedAccount}; +use crate::commands::config::network; +use crate::config; +use crate::config::{locator}; +use crate::{ + rpc::{self}, +}; +use crate::commands::ledger::entry::get::Error::EmptyKeys; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Name of identity to lookup, default is test identity + #[arg(long)] + pub account: Option, + + /// If identity is a seed phrase use this hd path, default is 0 + #[arg(long)] + pub hd_path: Option, + + /// Format of the output + #[arg(long, default_value = "original")] + pub output: OutputFormat, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), + #[error("at least one key must be provided")] + EmptyKeys, +} + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// Original RPC output (containing XDRs) + #[default] + Original, + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, +} + + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let client = self.network.get(&self.locator)?.rpc_client()?; + let mut ledger_keys = vec![]; + + if let Some(acc) = &self.account { + let acc = self.muxed_account(acc)?; + let key = LedgerKey::Account(LedgerKeyAccount { account_id: acc.account_id() }); + ledger_keys.push(key); + } + + if ledger_keys.is_empty() { + return Err(EmptyKeys); + } + + match self.output { + OutputFormat::Original => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + + return Ok(()); + } + + fn muxed_account(&self, account: &str) -> Result { + Ok(self + .locator + .read_identity(account)? + .muxed_account(self.hd_path)?) + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs new file mode 100644 index 0000000000..0556a90d4a --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -0,0 +1,23 @@ +pub mod get; +use clap::Parser; + +#[derive(Debug, Parser)] +pub enum Cmd { + /// Get ledger entries. + Get(get::Cmd), +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Get(#[from] get::Error), +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + match self { + Cmd::Get(cmd) => cmd.run().await?, + }; + Ok(()) + } +} \ No newline at end of file diff --git a/cmd/soroban-cli/src/commands/ledger/mod.rs b/cmd/soroban-cli/src/commands/ledger/mod.rs new file mode 100644 index 0000000000..a74606df46 --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/mod.rs @@ -0,0 +1,25 @@ +pub mod entry; + +use clap::Parser; + +#[derive(Debug, Parser)] +pub enum Cmd { + /// Work with ledger entries. + #[command(subcommand)] + Entry(entry::Cmd), +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Entry(#[from] entry::Error), +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + match self { + Cmd::Entry(cmd) => cmd.run().await?, + }; + Ok(()) + } +} \ No newline at end of file diff --git a/cmd/soroban-cli/src/commands/mod.rs b/cmd/soroban-cli/src/commands/mod.rs index be28fb2eb2..d10fb42b89 100644 --- a/cmd/soroban-cli/src/commands/mod.rs +++ b/cmd/soroban-cli/src/commands/mod.rs @@ -20,6 +20,7 @@ pub mod tx; pub mod version; pub mod txn_result; +pub mod ledger; pub const HEADING_RPC: &str = "Options (RPC)"; pub const HEADING_GLOBAL: &str = "Options (Global)"; @@ -117,6 +118,7 @@ impl Root { Cmd::Version(version) => version.run(), Cmd::Keys(id) => id.run(&self.global_args).await?, Cmd::Tx(tx) => tx.run(&self.global_args).await?, + Cmd::Ledger(ledger) => ledger.run().await?, Cmd::Cache(cache) => cache.run()?, Cmd::Env(env) => env.run(&self.global_args)?, } @@ -188,6 +190,10 @@ pub enum Cmd { /// The subcommand for CLI plugins #[command(subcommand)] Plugin(plugin::Cmd), + + /// Fetch ledger information + #[command(subcommand)] + Ledger(ledger::Cmd), } #[derive(thiserror::Error, Debug)] @@ -231,6 +237,9 @@ pub enum Error { #[error(transparent)] Env(#[from] env::Error), + + #[error(transparent)] + Ledger(#[from] ledger::Error), } #[async_trait] From b2d5be88172944276754c6721aace362b9eba4bc Mon Sep 17 00:00:00 2001 From: Gleb Date: Thu, 17 Apr 2025 09:58:24 -0700 Subject: [PATCH 02/76] Add reading contract entries --- .../src/commands/ledger/entry/get.rs | 68 +++++++++++++++++-- 1 file changed, 63 insertions(+), 5 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/get.rs b/cmd/soroban-cli/src/commands/ledger/entry/get.rs index bc409228ac..5808ecac6b 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/get.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/get.rs @@ -1,15 +1,15 @@ - use std::fmt::Debug; use clap::{command, Parser}; -use stellar_xdr::curr::{LedgerKey, LedgerKeyAccount, MuxedAccount}; +use stellar_xdr::curr::{ContractDataDurability, Hash, LedgerKey, LedgerKeyAccount, LedgerKeyContractData, Limits, MuxedAccount, ReadXdr, ScAddress, ScVal}; use crate::commands::config::network; -use crate::config; +use crate::{config, xdr}; use crate::config::{locator}; use crate::{ rpc::{self}, }; -use crate::commands::ledger::entry::get::Error::EmptyKeys; +use crate::commands::contract::Durability; +use crate::commands::ledger::entry::get::Error::{ContractRequired, EmptyKeys}; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -28,6 +28,21 @@ pub struct Cmd { #[arg(long)] pub hd_path: Option, + + #[arg(long = "id", env = "STELLAR_CONTRACT_ID")] + pub contract_id: Option, + + /// Storage entry durability + #[arg(long, value_enum, default_value = "persistent")] + pub durability: Durability, + + /// Storage key (symbols only) + #[arg(long = "key")] + pub key: Option>, + /// Storage key (base64-encoded XDR) + #[arg(long = "key-xdr")] + pub key_xdr: Option>, + /// Format of the output #[arg(long, default_value = "original")] pub output: OutputFormat, @@ -45,8 +60,14 @@ pub enum Error { Network(#[from] network::Error), #[error(transparent)] Serde(#[from] serde_json::Error), + #[error(transparent)] + StellarXdr(#[from] stellar_xdr::curr::Error), + #[error(transparent)] + Spec(#[from] soroban_spec_tools::Error), #[error("at least one key must be provided")] EmptyKeys, + #[error("contract id is required but was not provided")] + ContractRequired, } #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] @@ -63,15 +84,52 @@ pub enum OutputFormat { impl Cmd { pub async fn run(&self) -> Result<(), Error> { - let client = self.network.get(&self.locator)?.rpc_client()?; + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; let mut ledger_keys = vec![]; + if let Some(contract_id) = &self.contract_id { + let contract_id = contract_id.resolve_contract_id(&self.locator, &network.network_passphrase)?; + + let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); + + if let Some(keys) = &self.key { + for key in keys { + let key = LedgerKey::ContractData(LedgerKeyContractData { + contract: contract_address_arg.clone(), + key: soroban_spec_tools::from_string_primitive( + key, + &xdr::ScSpecTypeDef::Symbol, + )?, + durability: ContractDataDurability::Persistent, + }); + + ledger_keys.push(key); + } + } + + if let Some(keys) = &self.key_xdr { + for key in keys { + let key = LedgerKey::ContractData(LedgerKeyContractData { + contract: contract_address_arg.clone(), + key: ScVal::from_xdr_base64(key, Limits::none())?, + durability: ContractDataDurability::Persistent, + }); + + ledger_keys.push(key); + } + } + } else if self.key.is_some() || self.key_xdr.is_some() { + return Err(ContractRequired) + } + if let Some(acc) = &self.account { let acc = self.muxed_account(acc)?; let key = LedgerKey::Account(LedgerKeyAccount { account_id: acc.account_id() }); ledger_keys.push(key); } + if ledger_keys.is_empty() { return Err(EmptyKeys); } From 0f2e01eacc860eb252fce717d6ea64ccd94eab01 Mon Sep 17 00:00:00 2001 From: Gleb Date: Thu, 17 Apr 2025 15:02:37 -0700 Subject: [PATCH 03/76] Add remaining types --- cmd/soroban-cli/src/commands/contract/read.rs | 11 +- .../src/commands/ledger/entry/get.rs | 201 ++++++++++++++++-- .../src/commands/ledger/entry/mod.rs | 5 +- cmd/soroban-cli/src/commands/ledger/mod.rs | 2 +- cmd/soroban-cli/src/commands/mod.rs | 2 +- 5 files changed, 195 insertions(+), 26 deletions(-) diff --git a/cmd/soroban-cli/src/commands/contract/read.rs b/cmd/soroban-cli/src/commands/contract/read.rs index 4977bd7cb6..bb327a07b3 100644 --- a/cmd/soroban-cli/src/commands/contract/read.rs +++ b/cmd/soroban-cli/src/commands/contract/read.rs @@ -144,18 +144,19 @@ impl Cmd { error, } })?, - serde_json::to_string_pretty(&live_until_ledger_seq.unwrap_or_default()).map_err(|error| { - Error::CannotPrintJsonResult { + serde_json::to_string_pretty(&live_until_ledger_seq.unwrap_or_default()) + .map_err(|error| Error::CannotPrintJsonResult { result: val.clone(), error, - } - })?, + })?, ], Output::Xdr => [ key.to_xdr_base64(Limits::none())?, val.to_xdr_base64(Limits::none())?, last_modified_ledger.to_xdr_base64(Limits::none())?, - live_until_ledger_seq.unwrap_or_default().to_xdr_base64(Limits::none())?, + live_until_ledger_seq + .unwrap_or_default() + .to_xdr_base64(Limits::none())?, ], }; out.write_record(output) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/get.rs b/cmd/soroban-cli/src/commands/ledger/entry/get.rs index 5808ecac6b..7906d64fdc 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/get.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/get.rs @@ -1,41 +1,79 @@ +use std::array::TryFromSliceError; use std::fmt::Debug; -use clap::{command, Parser}; -use stellar_xdr::curr::{ContractDataDurability, Hash, LedgerKey, LedgerKeyAccount, LedgerKeyContractData, Limits, MuxedAccount, ReadXdr, ScAddress, ScVal}; use crate::commands::config::network; +use crate::commands::contract::Durability; +use crate::commands::ledger::entry::get::Error::{ + AccountRequired, ContractRequired, EmptyKeys, InvalidAsset, InvalidConfigId, InvalidDataName, + InvalidHash, +}; +use crate::config::locator; +use crate::rpc::{self}; use crate::{config, xdr}; -use crate::config::{locator}; -use crate::{ - rpc::{self}, +use clap::{command, Parser}; +use hex::FromHexError; +use soroban_spec_tools::utils::padded_hex_from_str; +use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; +use stellar_xdr::curr::ClaimableBalanceId::ClaimableBalanceIdTypeV0; +use stellar_xdr::curr::{ + AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, ConfigSettingId, + ContractDataDurability, Hash, LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, + LedgerKeyConfigSetting, LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, + LedgerKeyLiquidityPool, LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limits, MuxedAccount, + PoolId, PublicKey, ReadXdr, ScAddress, ScVal, String64, TrustLineAsset, Uint256, }; -use crate::commands::contract::Durability; -use crate::commands::ledger::entry::get::Error::{ContractRequired, EmptyKeys}; #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { #[command(flatten)] pub network: network::Args, - #[command(flatten)] pub locator: locator::Args, /// Name of identity to lookup, default is test identity #[arg(long)] pub account: Option, - /// If identity is a seed phrase use this hd path, default is 0 #[arg(long)] pub hd_path: Option, + /// Assets to get trustline info for + #[arg(long)] + pub asset: Option>, + /// ID of an offer made on the Stellar DEX + #[arg(long)] + pub offer: Option>, + /// Fetch key-value data entries attached to an account (see manageDataOp) + #[arg(long)] + pub data_name: Option>, + + /// Claimable Balance id + #[arg(long)] + pub claimable_id: Option>, + /// Liquidity pool id + #[arg(long)] + pub pool_id: Option>, + + /// Defines the currently active network configuration + #[arg(long)] + pub config_setting_id: Option>, + + /// Get WASM bytecode by hash + #[arg(long)] + pub wasm_hash: Option>, + + /// Get the time-to-live of an associated contract data or code entry + #[arg(long)] + pub ttl: Option>, + + /// Contract id to fetch an info for #[arg(long = "id", env = "STELLAR_CONTRACT_ID")] pub contract_id: Option, - /// Storage entry durability #[arg(long, value_enum, default_value = "persistent")] pub durability: Durability, - /// Storage key (symbols only) #[arg(long = "key")] pub key: Option>, @@ -64,10 +102,24 @@ pub enum Error { StellarXdr(#[from] stellar_xdr::curr::Error), #[error(transparent)] Spec(#[from] soroban_spec_tools::Error), + #[error(transparent)] + TryFromSliceError(#[from] TryFromSliceError), + #[error(transparent)] + FromHexError(#[from] FromHexError), #[error("at least one key must be provided")] EmptyKeys, #[error("contract id is required but was not provided")] ContractRequired, + #[error("account is required but was not provided")] + AccountRequired, + #[error("provided asset is invalid: {0}")] + InvalidAsset(String), + #[error("provided data name is invalid: {0}")] + InvalidDataName(String), + #[error("provided hash value is invalid: {0}")] + InvalidHash(String), + #[error("provided config id is invalid: {0}")] + InvalidConfigId(i32), } #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] @@ -81,7 +133,6 @@ pub enum OutputFormat { JsonFormatted, } - impl Cmd { pub async fn run(&self) -> Result<(), Error> { let network = self.network.get(&self.locator)?; @@ -89,7 +140,8 @@ impl Cmd { let mut ledger_keys = vec![]; if let Some(contract_id) = &self.contract_id { - let contract_id = contract_id.resolve_contract_id(&self.locator, &network.network_passphrase)?; + let contract_id = + contract_id.resolve_contract_id(&self.locator, &network.network_passphrase)?; let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); @@ -120,15 +172,131 @@ impl Cmd { } } } else if self.key.is_some() || self.key_xdr.is_some() { - return Err(ContractRequired) + return Err(ContractRequired); } if let Some(acc) = &self.account { let acc = self.muxed_account(acc)?; - let key = LedgerKey::Account(LedgerKeyAccount { account_id: acc.account_id() }); - ledger_keys.push(key); + + if let Some(asset) = &self.asset { + for asset in asset { + let asset = if asset.to_ascii_uppercase() == "XLM" { + TrustLineAsset::Native + } else if asset.contains(":") { + let mut parts = asset.split(":"); + let code = parts.next().ok_or(InvalidAsset(asset.clone()))?; + let issuer = parts.next().ok_or(InvalidAsset(asset.clone()))?; + if !parts.next().is_none() { + Err(InvalidAsset(asset.clone()))? + } + let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; + let issuer = + AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); + + match code.len() { + 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { + asset_code: AssetCode4(code.as_bytes().try_into()?), + issuer, + }), + 12 => TrustLineAsset::CreditAlphanum12(AlphaNum12 { + asset_code: AssetCode12(code.as_bytes().try_into()?), + issuer, + }), + _ => Err(InvalidAsset(asset.clone()))?, + } + } else { + Err(InvalidAsset(asset.clone()))? + }; + let key = LedgerKey::Trustline(LedgerKeyTrustLine { + account_id: acc.clone().account_id(), + asset, + }); + ledger_keys.push(key); + } + } + + if let Some(offer) = &self.offer { + for offer in offer { + let key = LedgerKey::Offer(LedgerKeyOffer { + seller_id: acc.clone().account_id(), + offer_id: *offer, + }); + ledger_keys.push(key); + } + } + + if let Some(data_name) = &self.data_name { + for data_name in data_name { + let data_name: xdr::StringM<64> = data_name + .parse() + .map_err(|_| InvalidDataName(data_name.clone()))?; + let data_name = String64(data_name); + let key = LedgerKey::Data(LedgerKeyData { + account_id: acc.clone().account_id(), + data_name, + }); + ledger_keys.push(key); + } + } + + if self.asset.is_none() && self.offer.is_none() && self.data_name.is_none() { + let key = LedgerKey::Account(LedgerKeyAccount { + account_id: acc.account_id(), + }); + ledger_keys.push(key); + } + } else if self.asset.is_some() || self.offer.is_some() || self.data_name.is_some() { + return Err(AccountRequired); } + if let Some(claimable_id) = &self.claimable_id { + for x in claimable_id { + let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); + let key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { + balance_id: ClaimableBalanceIdTypeV0(hash), + }); + ledger_keys.push(key); + } + } + + if let Some(pool_id) = &self.pool_id { + for x in pool_id { + let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); + let key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { + liquidity_pool_id: PoolId(hash), + }); + ledger_keys.push(key); + } + } + + if let Some(wasm_hash) = &self.wasm_hash { + for wasm_hash in wasm_hash { + let hash = Hash( + soroban_spec_tools::utils::contract_id_from_str(wasm_hash) + .map_err(|_| InvalidHash(wasm_hash.clone()))?, + ); + let key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); + ledger_keys.push(key); + } + } + + if let Some(config_setting_id) = &self.config_setting_id { + for x in config_setting_id { + let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { + config_setting_id: ConfigSettingId::try_from(*x) + .map_err(|_| InvalidConfigId(*x))?, + }); + ledger_keys.push(key); + } + } + + if let Some(ttl) = &self.ttl { + for x in ttl { + let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); + let key = LedgerKey::Ttl(LedgerKeyTtl { key_hash: hash }); + ledger_keys.push(key); + } + } if ledger_keys.is_empty() { return Err(EmptyKeys); @@ -149,7 +317,6 @@ impl Cmd { } } - return Ok(()); } diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs index 0556a90d4a..98bb2cefd0 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -3,7 +3,8 @@ use clap::Parser; #[derive(Debug, Parser)] pub enum Cmd { - /// Get ledger entries. + /// Get ledger entries. This command supports every type of ledger entries supported by the + /// RPC. Read more about RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys Get(get::Cmd), } @@ -20,4 +21,4 @@ impl Cmd { }; Ok(()) } -} \ No newline at end of file +} diff --git a/cmd/soroban-cli/src/commands/ledger/mod.rs b/cmd/soroban-cli/src/commands/ledger/mod.rs index a74606df46..14bdf0f144 100644 --- a/cmd/soroban-cli/src/commands/ledger/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/mod.rs @@ -22,4 +22,4 @@ impl Cmd { }; Ok(()) } -} \ No newline at end of file +} diff --git a/cmd/soroban-cli/src/commands/mod.rs b/cmd/soroban-cli/src/commands/mod.rs index d10fb42b89..388c532de2 100644 --- a/cmd/soroban-cli/src/commands/mod.rs +++ b/cmd/soroban-cli/src/commands/mod.rs @@ -19,8 +19,8 @@ pub mod snapshot; pub mod tx; pub mod version; -pub mod txn_result; pub mod ledger; +pub mod txn_result; pub const HEADING_RPC: &str = "Options (RPC)"; pub const HEADING_GLOBAL: &str = "Options (Global)"; From 26e3d38a3d28e41eed1d2e34fd04d375f6ee1573 Mon Sep 17 00:00:00 2001 From: Gleb Date: Thu, 17 Apr 2025 15:19:56 -0700 Subject: [PATCH 04/76] clippy --- FULL_HELP_DOCS.md | 77 +++++++ .../src/commands/ledger/entry/get.rs | 195 ++++++++++-------- 2 files changed, 181 insertions(+), 91 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 3445dec997..3d2c911b8a 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -56,6 +56,7 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c * `cache` — Cache for transactions and contract specs * `version` — Print version information * `plugin` — The subcommand for CLI plugins +* `ledger` — Fetch ledger information ###### **Options:** @@ -2693,3 +2694,79 @@ List installed plugins +## `stellar ledger` + +Fetch ledger information + +**Usage:** `stellar ledger ` + +###### **Subcommands:** + +* `entry` — Work with ledger entries + + + +## `stellar ledger entry` + +Work with ledger entries + +**Usage:** `stellar ledger entry ` + +###### **Subcommands:** + +* `get` — Get ledger entries. This command supports every type of ledger entries supported by the RPC. Read more about RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys + + + +## `stellar ledger entry get` + +Get ledger entries. This command supports every type of ledger entries supported by the RPC. Read more about RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys + +**Usage:** `stellar ledger entry get [OPTIONS]` + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--account ` — Name of identity to lookup, default is test identity +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--asset ` — Assets to get trustline info for +* `--offer ` — ID of an offer made on the Stellar DEX +* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) +* `--claimable-id ` — Claimable Balance id +* `--pool-id ` — Liquidity pool id +* `--config-setting-id ` — Defines the currently active network configuration +* `--wasm-hash ` — Get WASM bytecode by hash +* `--ttl ` — Get the time-to-live of an associated contract data or code entry +* `--id ` — Contract id to fetch an info for +* `--durability ` — Storage entry durability + + Default value: `persistent` + + Possible values: + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--output ` — Format of the output + + Default value: `original` + + Possible values: + - `original`: + Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + + + + diff --git a/cmd/soroban-cli/src/commands/ledger/entry/get.rs b/cmd/soroban-cli/src/commands/ledger/entry/get.rs index 7906d64fdc..aaa873bfca 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/get.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/get.rs @@ -22,6 +22,7 @@ use stellar_xdr::curr::{ LedgerKeyLiquidityPool, LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limits, MuxedAccount, PoolId, PublicKey, ReadXdr, ScAddress, ScVal, String64, TrustLineAsset, Uint256, }; +use crate::config::network::Network; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -139,55 +140,95 @@ impl Cmd { let client = network.rpc_client()?; let mut ledger_keys = vec![]; - if let Some(contract_id) = &self.contract_id { - let contract_id = - contract_id.resolve_contract_id(&self.locator, &network.network_passphrase)?; + self.insert_contract_keys(&network, &mut ledger_keys)?; - let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); + self.insert_accpount_keys(&mut ledger_keys)?; - if let Some(keys) = &self.key { - for key in keys { - let key = LedgerKey::ContractData(LedgerKeyContractData { - contract: contract_address_arg.clone(), - key: soroban_spec_tools::from_string_primitive( - key, - &xdr::ScSpecTypeDef::Symbol, - )?, - durability: ContractDataDurability::Persistent, - }); + if let Some(claimable_id) = &self.claimable_id { + for x in claimable_id { + let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); + let key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { + balance_id: ClaimableBalanceIdTypeV0(hash), + }); + ledger_keys.push(key); + } + } - ledger_keys.push(key); - } + if let Some(pool_id) = &self.pool_id { + for x in pool_id { + let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); + let key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { + liquidity_pool_id: PoolId(hash), + }); + ledger_keys.push(key); } + } - if let Some(keys) = &self.key_xdr { - for key in keys { - let key = LedgerKey::ContractData(LedgerKeyContractData { - contract: contract_address_arg.clone(), - key: ScVal::from_xdr_base64(key, Limits::none())?, - durability: ContractDataDurability::Persistent, - }); + if let Some(wasm_hash) = &self.wasm_hash { + for wasm_hash in wasm_hash { + let hash = Hash( + soroban_spec_tools::utils::contract_id_from_str(wasm_hash) + .map_err(|_| InvalidHash(wasm_hash.clone()))?, + ); + let key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); + ledger_keys.push(key); + } + } - ledger_keys.push(key); - } + if let Some(config_setting_id) = &self.config_setting_id { + for x in config_setting_id { + let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { + config_setting_id: ConfigSettingId::try_from(*x) + .map_err(|_| InvalidConfigId(*x))?, + }); + ledger_keys.push(key); + } + } + + if let Some(ttl) = &self.ttl { + for x in ttl { + let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); + let key = LedgerKey::Ttl(LedgerKeyTtl { key_hash: hash }); + ledger_keys.push(key); + } + } + + if ledger_keys.is_empty() { + return Err(EmptyKeys); + } + + match self.output { + OutputFormat::Original => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); } - } else if self.key.is_some() || self.key_xdr.is_some() { - return Err(ContractRequired); } + Ok(()) + } + + fn insert_accpount_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { if let Some(acc) = &self.account { let acc = self.muxed_account(acc)?; if let Some(asset) = &self.asset { for asset in asset { - let asset = if asset.to_ascii_uppercase() == "XLM" { + let asset = if asset.eq_ignore_ascii_case("XLM") { TrustLineAsset::Native - } else if asset.contains(":") { - let mut parts = asset.split(":"); + } else if asset.contains(':') { + let mut parts = asset.split(':'); let code = parts.next().ok_or(InvalidAsset(asset.clone()))?; let issuer = parts.next().ok_or(InvalidAsset(asset.clone()))?; - if !parts.next().is_none() { - Err(InvalidAsset(asset.clone()))? + if parts.next().is_some() { + Err(InvalidAsset(asset.clone()))?; } let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; let issuer = @@ -249,75 +290,47 @@ impl Cmd { return Err(AccountRequired); } - if let Some(claimable_id) = &self.claimable_id { - for x in claimable_id { - let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); - let key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { - balance_id: ClaimableBalanceIdTypeV0(hash), - }); - ledger_keys.push(key); - } - } + Ok(()) + } - if let Some(pool_id) = &self.pool_id { - for x in pool_id { - let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); - let key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { - liquidity_pool_id: PoolId(hash), - }); - ledger_keys.push(key); - } - } + fn insert_contract_keys(&self, network: &Network, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(contract_id) = &self.contract_id { + let contract_id = + contract_id.resolve_contract_id(&self.locator, &network.network_passphrase)?; - if let Some(wasm_hash) = &self.wasm_hash { - for wasm_hash in wasm_hash { - let hash = Hash( - soroban_spec_tools::utils::contract_id_from_str(wasm_hash) - .map_err(|_| InvalidHash(wasm_hash.clone()))?, - ); - let key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); - ledger_keys.push(key); - } - } + let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); - if let Some(config_setting_id) = &self.config_setting_id { - for x in config_setting_id { - let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { - config_setting_id: ConfigSettingId::try_from(*x) - .map_err(|_| InvalidConfigId(*x))?, - }); - ledger_keys.push(key); - } - } + if let Some(keys) = &self.key { + for key in keys { + let key = LedgerKey::ContractData(LedgerKeyContractData { + contract: contract_address_arg.clone(), + key: soroban_spec_tools::from_string_primitive( + key, + &xdr::ScSpecTypeDef::Symbol, + )?, + durability: ContractDataDurability::Persistent, + }); - if let Some(ttl) = &self.ttl { - for x in ttl { - let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); - let key = LedgerKey::Ttl(LedgerKeyTtl { key_hash: hash }); - ledger_keys.push(key); + ledger_keys.push(key); + } } - } - if ledger_keys.is_empty() { - return Err(EmptyKeys); - } + if let Some(keys) = &self.key_xdr { + for key in keys { + let key = LedgerKey::ContractData(LedgerKeyContractData { + contract: contract_address_arg.clone(), + key: ScVal::from_xdr_base64(key, Limits::none())?, + durability: ContractDataDurability::Persistent, + }); - match self.output { - OutputFormat::Original => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); + ledger_keys.push(key); + } } + } else if self.key.is_some() || self.key_xdr.is_some() { + return Err(ContractRequired); } - return Ok(()); + Ok(()) } fn muxed_account(&self, account: &str) -> Result { From ae1c0954d993e0d6eb3f8efcd986c08a2dbbcc74 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 28 Apr 2025 10:39:08 -0400 Subject: [PATCH 05/76] Change ledger entry get -> ledger entry fetch --- .../src/commands/ledger/entry/{get.rs => fetch.rs} | 2 +- cmd/soroban-cli/src/commands/ledger/entry/mod.rs | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) rename cmd/soroban-cli/src/commands/ledger/entry/{get.rs => fetch.rs} (99%) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/get.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs similarity index 99% rename from cmd/soroban-cli/src/commands/ledger/entry/get.rs rename to cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index aaa873bfca..911dd9daa8 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/get.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -3,7 +3,7 @@ use std::fmt::Debug; use crate::commands::config::network; use crate::commands::contract::Durability; -use crate::commands::ledger::entry::get::Error::{ +use crate::commands::ledger::entry::fetch::Error::{ AccountRequired, ContractRequired, EmptyKeys, InvalidAsset, InvalidConfigId, InvalidDataName, InvalidHash, }; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs index 98bb2cefd0..7c0b57ab01 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -1,23 +1,23 @@ -pub mod get; use clap::Parser; +pub mod fetch; #[derive(Debug, Parser)] pub enum Cmd { - /// Get ledger entries. This command supports every type of ledger entries supported by the - /// RPC. Read more about RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys - Get(get::Cmd), + /// Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. + /// Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys + Fetch(fetch::Cmd), } #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] - Get(#[from] get::Error), + Fetch(#[from] fetch::Error), } impl Cmd { pub async fn run(&self) -> Result<(), Error> { match self { - Cmd::Get(cmd) => cmd.run().await?, + Cmd::Fetch(cmd) => cmd.run().await?, }; Ok(()) } From f51e84ba81f63c60ed3b659d7c9666a757ba3b10 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 28 Apr 2025 12:25:57 -0400 Subject: [PATCH 06/76] Fix typo --- cmd/soroban-cli/src/commands/ledger/entry/fetch.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index 911dd9daa8..bbbad547b9 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -142,7 +142,7 @@ impl Cmd { self.insert_contract_keys(&network, &mut ledger_keys)?; - self.insert_accpount_keys(&mut ledger_keys)?; + self.insert_account_keys(&mut ledger_keys)?; if let Some(claimable_id) = &self.claimable_id { for x in claimable_id { @@ -215,7 +215,7 @@ impl Cmd { Ok(()) } - fn insert_accpount_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + fn insert_account_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { if let Some(acc) = &self.account { let acc = self.muxed_account(acc)?; From 9c5fce46f13535196cc87c34d828d47fcc7ecf6a Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 28 Apr 2025 18:02:31 -0400 Subject: [PATCH 07/76] Start to add ledger int tests --- .../soroban-test/tests/it/integration.rs | 1 + .../tests/it/integration/ledger.rs | 57 +++++++++++++++++++ .../src/commands/ledger/entry/fetch.rs | 3 +- 3 files changed, 60 insertions(+), 1 deletion(-) create mode 100644 cmd/crates/soroban-test/tests/it/integration/ledger.rs diff --git a/cmd/crates/soroban-test/tests/it/integration.rs b/cmd/crates/soroban-test/tests/it/integration.rs index da7eaec7c4..962dbd955c 100644 --- a/cmd/crates/soroban-test/tests/it/integration.rs +++ b/cmd/crates/soroban-test/tests/it/integration.rs @@ -7,6 +7,7 @@ mod hello_world; mod init; mod keys; mod secure_store; +mod ledger; mod snapshot; mod tx; mod util; diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger.rs b/cmd/crates/soroban-test/tests/it/integration/ledger.rs new file mode 100644 index 0000000000..526047a3b3 --- /dev/null +++ b/cmd/crates/soroban-test/tests/it/integration/ledger.rs @@ -0,0 +1,57 @@ +use predicates::prelude::predicate; +use soroban_test::AssertExt; +use soroban_test::TestEnv; +use soroban_rpc::{GetLedgerEntriesResponse, FullLedgerEntries}; +use soroban_cli::xdr::{LedgerKey, LedgerKeyAccount, WriteXdr, Limits, PublicKey, Uint256, AccountId, AccountEntry, LedgerEntryData}; +use stellar_strkey::ed25519::PublicKey as StrkeyPublicKeyEd25519; + +fn new_account(sandbox: &TestEnv, name: &str) -> String { + sandbox.generate_account(name, None).assert().success(); + sandbox.fund_account(name).success(); + + sandbox + .new_assert_cmd("keys") + .args(["address", name]) + .assert() + .success() + .stdout_as_str() +} + + +// todo: test with --asset, --offer, --data-name +#[tokio::test] +async fn test_account_data(){ + let sandbox = &TestEnv::new(); + let new_account_addr = new_account(sandbox, "new_account"); + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--account") + .arg("new_account") + .arg("--asset") + // though xlm does not have nor need a trustline, "xlm" is a valid argument to `--asset` + // so this test is including it to make sure that the account ledger entry is still included in the output + .arg("xlm") + .arg("--output") + .arg("json") + .assert() + .success() + .stdout_as_str(); + + // create the expected LedgerKeyAccount key + let strkey = StrkeyPublicKeyEd25519::from_string(&new_account_addr).unwrap().0; + let uint256 = Uint256(strkey); + let pk = PublicKey::PublicKeyTypeEd25519(uint256); + let account_id = AccountId(pk); + let expected_key = LedgerKey::Account(LedgerKeyAccount { account_id: account_id.clone() }); + + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed.entries.is_empty()); + assert_eq!(parsed.entries[0].key, expected_key); + if let LedgerEntryData::Account(account) = &parsed.entries[0].val { + assert_eq!(account.account_id, account_id); + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index bbbad547b9..480250f3c8 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -14,8 +14,8 @@ use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; -use stellar_xdr::curr::ClaimableBalanceId::ClaimableBalanceIdTypeV0; use stellar_xdr::curr::{ + ClaimableBalanceId::ClaimableBalanceIdTypeV0, AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, ConfigSettingId, ContractDataDurability, Hash, LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, LedgerKeyConfigSetting, LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, @@ -248,6 +248,7 @@ impl Cmd { } else { Err(InvalidAsset(asset.clone()))? }; + let key = LedgerKey::Trustline(LedgerKeyTrustLine { account_id: acc.clone().account_id(), asset, From b11cd634ea4a2c746bef824112f5b74cea5d99b8 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 30 Apr 2025 14:21:02 -0400 Subject: [PATCH 08/76] Remove check for self.asset, offer or data_name before adding LedgerKeyAccount We were previously checking to see if asset, offer or data-name were also passed in. If not, the LedgerKeyAccount of the given account was added to the list of keys. However, there is an edge case, that if the user passes in 'xlm' as the asset, the entries was returning empty because there is not an xlm trustline so no key was passed in. As a solution, this PR always include the LedgerKeyAccount in the list of keys, so the LedgerEntryAccount is always returned when --account is passed in as an arg --- .../src/commands/ledger/entry/fetch.rs | 15 +++++++++------ 1 file changed, 9 insertions(+), 6 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index 480250f3c8..a62df135de 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -253,6 +253,7 @@ impl Cmd { account_id: acc.clone().account_id(), asset, }); + ledger_keys.push(key); } } @@ -273,20 +274,22 @@ impl Cmd { .parse() .map_err(|_| InvalidDataName(data_name.clone()))?; let data_name = String64(data_name); + println!("data_name: {:?}", data_name); let key = LedgerKey::Data(LedgerKeyData { account_id: acc.clone().account_id(), data_name, }); + println!("key: {:?}", key); ledger_keys.push(key); } } - if self.asset.is_none() && self.offer.is_none() && self.data_name.is_none() { - let key = LedgerKey::Account(LedgerKeyAccount { - account_id: acc.account_id(), - }); - ledger_keys.push(key); - } + let key = LedgerKey::Account(LedgerKeyAccount { + account_id: acc.account_id(), + }); + + ledger_keys.push(key); + } else if self.asset.is_some() || self.offer.is_some() || self.data_name.is_some() { return Err(AccountRequired); } From cdcba74c926f17c82ab57147d52085fb3f368505 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 1 May 2025 11:54:24 -0400 Subject: [PATCH 09/76] Make json formatting the default over xdr --- .../src/commands/ledger/entry/fetch.rs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index a62df135de..54e237584a 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -83,7 +83,7 @@ pub struct Cmd { pub key_xdr: Option>, /// Format of the output - #[arg(long, default_value = "original")] + #[arg(long, default_value = "json")] pub output: OutputFormat, } @@ -125,13 +125,13 @@ pub enum Error { #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { - /// Original RPC output (containing XDRs) - #[default] - Original, /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] Json, /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, } impl Cmd { @@ -198,14 +198,14 @@ impl Cmd { } match self.output { - OutputFormat::Original => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } OutputFormat::Json => { let resp = client.get_full_ledger_entries(&ledger_keys).await?; println!("{}", serde_json::to_string(&resp)?); } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } OutputFormat::JsonFormatted => { let resp = client.get_full_ledger_entries(&ledger_keys).await?; println!("{}", serde_json::to_string_pretty(&resp)?); From 07c5b95bfeb85e69a9a472c0a9db7553d6b22021 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 1 May 2025 12:44:03 -0400 Subject: [PATCH 10/76] Continue adding to ledger fetch entry tests --- .../tests/it/integration/ledger.rs | 58 +--- .../tests/it/integration/ledger/entry.rs | 308 ++++++++++++++++++ .../tests/it/integration/tx/operations.rs | 6 +- .../src/commands/ledger/entry/fetch.rs | 5 +- 4 files changed, 315 insertions(+), 62 deletions(-) create mode 100644 cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger.rs b/cmd/crates/soroban-test/tests/it/integration/ledger.rs index 526047a3b3..f8eef26358 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger.rs @@ -1,57 +1 @@ -use predicates::prelude::predicate; -use soroban_test::AssertExt; -use soroban_test::TestEnv; -use soroban_rpc::{GetLedgerEntriesResponse, FullLedgerEntries}; -use soroban_cli::xdr::{LedgerKey, LedgerKeyAccount, WriteXdr, Limits, PublicKey, Uint256, AccountId, AccountEntry, LedgerEntryData}; -use stellar_strkey::ed25519::PublicKey as StrkeyPublicKeyEd25519; - -fn new_account(sandbox: &TestEnv, name: &str) -> String { - sandbox.generate_account(name, None).assert().success(); - sandbox.fund_account(name).success(); - - sandbox - .new_assert_cmd("keys") - .args(["address", name]) - .assert() - .success() - .stdout_as_str() -} - - -// todo: test with --asset, --offer, --data-name -#[tokio::test] -async fn test_account_data(){ - let sandbox = &TestEnv::new(); - let new_account_addr = new_account(sandbox, "new_account"); - let output = sandbox - .new_assert_cmd("ledger") - .arg("entry") - .arg("fetch") - .arg("--network") - .arg("testnet") - .arg("--account") - .arg("new_account") - .arg("--asset") - // though xlm does not have nor need a trustline, "xlm" is a valid argument to `--asset` - // so this test is including it to make sure that the account ledger entry is still included in the output - .arg("xlm") - .arg("--output") - .arg("json") - .assert() - .success() - .stdout_as_str(); - - // create the expected LedgerKeyAccount key - let strkey = StrkeyPublicKeyEd25519::from_string(&new_account_addr).unwrap().0; - let uint256 = Uint256(strkey); - let pk = PublicKey::PublicKeyTypeEd25519(uint256); - let account_id = AccountId(pk); - let expected_key = LedgerKey::Account(LedgerKeyAccount { account_id: account_id.clone() }); - - let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed.entries.is_empty()); - assert_eq!(parsed.entries[0].key, expected_key); - if let LedgerEntryData::Account(account) = &parsed.entries[0].val { - assert_eq!(account.account_id, account_id); - } -} +mod entry; diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs new file mode 100644 index 0000000000..8ff73edd6a --- /dev/null +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -0,0 +1,308 @@ +use soroban_test::AssertExt; +use soroban_test::TestEnv; +use soroban_rpc::FullLedgerEntries; +use soroban_cli::xdr::{LedgerKey, LedgerKeyTrustLine, LedgerKeyAccount, PublicKey, Uint256, AccountId, LedgerKeyData, LedgerEntryData, AssetCode4, AlphaNum4, TrustLineAsset, LedgerKeyContractData, ScVal, ScAddress, StringM, String64, Hash, ContractDataDurability }; +use stellar_strkey::{ + ed25519::PublicKey as StrkeyPublicKeyEd25519, + Contract +}; + +use crate::integration::util::{deploy_contract, test_address, HELLO_WORLD, DeployOptions}; + + +// account data tests +// todo: test with--offer, +#[tokio::test] +async fn ledger_entry_account_only(){ + let sandbox = &TestEnv::new(); + let account_alias = "new_account"; + let new_account_addr = new_account(sandbox, account_alias); + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--account") + .arg(account_alias) + .assert() + .success() + .stdout_as_str(); + + let (_, expected_key) = expected_account_ledger_key(&new_account_addr).await; + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + + assert!(!parsed.entries.is_empty()); + assert_eq!(parsed.entries[0].key, expected_key); + assert!(matches!(parsed.entries[0].val, LedgerEntryData::Account { .. })); +} + +#[tokio::test] +async fn ledger_entry_account_asset_xlm(){ + let sandbox = &TestEnv::new(); + let account_alias = "new_account"; + let new_account_addr = new_account(sandbox, account_alias); + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--account") + .arg(account_alias) + .arg("--asset") + // though xlm does not have, nor need, a trustline, "xlm" is a valid argument to `--asset` + // so this test is including it to make sure that the account ledger entry is still included in the output + .arg("xlm") + .assert() + .success() + .stdout_as_str(); + + let (_, expected_key) = expected_account_ledger_key(&new_account_addr).await; + + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed.entries.is_empty()); + assert_eq!(parsed.entries[0].key, expected_key); + assert!(matches!(parsed.entries[0].val, LedgerEntryData::Account { .. })); +} + +#[tokio::test] +async fn ledger_entry_account_asset_usdc(){ + let sandbox = &TestEnv::new(); + let test_account_alias = "test"; + let test_account_address = test_address(sandbox); + let issuer_alias = "test1"; + let issuer_address = new_account(sandbox, issuer_alias); + let asset = &format!("usdc:{issuer_address}"); + let limit = 100_000; + let initial_balance = 100; + issue_asset(sandbox, &test_account_address, asset, limit, initial_balance).await; + + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--account") + .arg(test_account_alias) + .arg("--asset") + .arg(asset) + .assert() + .success() + .stdout_as_str(); + + let (account_id, expected_account_key) = expected_account_ledger_key(&test_account_address).await; + let (issuer_account_id, _) = expected_account_ledger_key(&issuer_address).await; + + let trustline_asset = TrustLineAsset::CreditAlphanum4(AlphaNum4 { + asset_code: AssetCode4(*b"usdc"), + issuer: issuer_account_id, + }); + let expected_trustline_key = LedgerKey::Trustline(LedgerKeyTrustLine { + account_id, + asset: trustline_asset, + }); + + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed.entries.is_empty()); + + let trustline_entry = &parsed.entries[0]; + assert_eq!(trustline_entry.key, expected_trustline_key); + assert!(matches!(trustline_entry.val, LedgerEntryData::Trustline { .. })); + + let account_entry = &parsed.entries[1]; + assert_eq!(account_entry.key, expected_account_key); + assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); +} + +#[tokio::test] +async fn ledger_entry_account_data() { + let sandbox = &TestEnv::new(); + let account_alias = "new_account"; + let new_account_addr = new_account(sandbox, account_alias); + let data_name = "test_data_key"; + add_data(sandbox, account_alias, data_name, "abcdef").await; + + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--account") + .arg(account_alias) + .arg("--data-name") + .arg(data_name) + .assert() + .success() + .stdout_as_str(); + + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed.entries.is_empty()); + + let (account_id, expected_account_key) = expected_account_ledger_key(&new_account_addr).await; + + let data_entry = &parsed.entries[0]; + let name_bounded_string = StringM::<64>::try_from(data_name).unwrap(); + let expected_data_key = LedgerKey::Data(LedgerKeyData { + account_id, + data_name: String64::from(name_bounded_string), + }); + assert_eq!(data_entry.key, expected_data_key); + assert!(matches!(data_entry.val, LedgerEntryData::Data { .. })); + + let account_entry = &parsed.entries[1]; + assert_eq!(account_entry.key, expected_account_key); + assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); +} + +// contract data tests +#[tokio::test] +async fn ledger_entry_contract_data() { + let sandbox = &TestEnv::new(); + let test_account_alias = "test"; + let contract_id = deploy_contract( + sandbox, + HELLO_WORLD, + DeployOptions { + deployer: Some(test_account_alias.to_string()), + ..Default::default() + }, + ).await; + + let storage_key = "COUNTER"; + sandbox + .invoke_with_test(&["--id", &contract_id, "--", "inc"]) + .await + .unwrap(); + + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--id") + .arg(&contract_id) + .arg("--key") + .arg(storage_key) + .assert() + .success() + .stdout_as_str(); + + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed.entries.is_empty()); + + let contract_bytes: [u8; 32] = Contract::from_string(&contract_id).unwrap().0; + let contract_id = Hash(contract_bytes); + + let expected_contract_data_key = LedgerKey::ContractData(LedgerKeyContractData { + contract: ScAddress::Contract(contract_id), + key: ScVal::Symbol(storage_key.try_into().unwrap()), + durability: ContractDataDurability::Persistent} + ); + assert_eq!(parsed.entries[0].key, expected_contract_data_key); + assert!(matches!(parsed.entries[0].val, LedgerEntryData::ContractData{ .. })); +} + +// top level test + +// Helper Fns +fn new_account(sandbox: &TestEnv, name: &str) -> String { + sandbox.generate_account(name, None).assert().success(); + sandbox.fund_account(name).success(); + + sandbox + .new_assert_cmd("keys") + .args(["address", name]) + .assert() + .success() + .stdout_as_str() +} + +async fn issue_asset(sandbox: &TestEnv, test: &str, asset: &str, limit: u64, initial_balance: u64) { + let client = sandbox.network.rpc_client().unwrap(); + let test_before = client.get_account(test).await.unwrap(); + sandbox + .new_assert_cmd("tx") + .args([ + "new", + "change-trust", + "--line", + asset, + "--limit", + limit.to_string().as_str(), + ]) + .assert() + .success() + .stdout_as_str(); + + sandbox + .new_assert_cmd("tx") + .args(["new", "set-options", "--set-required"]) + .assert() + .success(); + sandbox + .new_assert_cmd("tx") + .args([ + "new", + "set-trustline-flags", + "--asset", + asset, + "--trustor", + test, + "--set-authorize", + "--source", + "test1", + ]) + .assert() + .success(); + + let after = client.get_account(test).await.unwrap(); + assert_eq!(test_before.num_sub_entries + 1, after.num_sub_entries); + + // Send a payment to the issuer + sandbox + .new_assert_cmd("tx") + .args([ + "new", + "payment", + "--destination", + test, + "--asset", + asset, + "--amount", + initial_balance.to_string().as_str(), + "--source=test1", + ]) + .assert() + .success(); +} + +async fn expected_account_ledger_key(account_addr: &str) -> (AccountId, LedgerKey){ + let strkey = StrkeyPublicKeyEd25519::from_string(account_addr).unwrap().0; + + let uint256 = Uint256(strkey); + let pk = PublicKey::PublicKeyTypeEd25519(uint256); + let account_id = AccountId(pk); + let ledger_key = LedgerKey::Account(LedgerKeyAccount { account_id: account_id.clone() }); + (account_id, ledger_key) +} + +async fn add_data(sandbox: &TestEnv, account_alias: &str, key: &str, value: &str) { + sandbox + .new_assert_cmd("tx") + .args([ + "new", + "manage-data", + "--data-name", + key, + "--data-value", + value, + "--source", + account_alias, + ]) + .assert() + .success(); +} \ No newline at end of file diff --git a/cmd/crates/soroban-test/tests/it/integration/tx/operations.rs b/cmd/crates/soroban-test/tests/it/integration/tx/operations.rs index ff3f7aa60c..b4ee1b092a 100644 --- a/cmd/crates/soroban-test/tests/it/integration/tx/operations.rs +++ b/cmd/crates/soroban-test/tests/it/integration/tx/operations.rs @@ -277,6 +277,7 @@ async fn set_trustline_flags() { let sandbox = &TestEnv::new(); let (test, test1_address) = setup_accounts(sandbox); let asset = "usdc:test1"; + issue_asset(sandbox, &test, asset, 100_000, 100).await; sandbox .new_assert_cmd("contract") @@ -694,7 +695,8 @@ async fn issue_asset(sandbox: &TestEnv, test: &str, asset: &str, limit: u64, ini limit.to_string().as_str(), ]) .assert() - .success(); + .success() + .stdout_as_str(); sandbox .new_assert_cmd("tx") @@ -719,7 +721,7 @@ async fn issue_asset(sandbox: &TestEnv, test: &str, asset: &str, limit: u64, ini let after = client.get_account(test).await.unwrap(); assert_eq!(test_before.num_sub_entries + 1, after.num_sub_entries); - println!("aa"); + // Send a payment to the issuer sandbox .new_assert_cmd("tx") diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index 54e237584a..afa374f22d 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -274,22 +274,21 @@ impl Cmd { .parse() .map_err(|_| InvalidDataName(data_name.clone()))?; let data_name = String64(data_name); - println!("data_name: {:?}", data_name); let key = LedgerKey::Data(LedgerKeyData { account_id: acc.clone().account_id(), data_name, }); - println!("key: {:?}", key); ledger_keys.push(key); } } + // always add the account key into the list + // should we allow this to be configurable? let key = LedgerKey::Account(LedgerKeyAccount { account_id: acc.account_id(), }); ledger_keys.push(key); - } else if self.asset.is_some() || self.offer.is_some() || self.data_name.is_some() { return Err(AccountRequired); } From dab59ef474b22ab9b4b3cde585c6eb5b962228fd Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 6 May 2025 10:01:48 -0400 Subject: [PATCH 11/76] Change --id -> --contract-id for clarity --- cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs | 2 +- cmd/soroban-cli/src/commands/ledger/entry/fetch.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 8ff73edd6a..e8002c4e92 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -183,7 +183,7 @@ async fn ledger_entry_contract_data() { .arg("fetch") .arg("--network") .arg("testnet") - .arg("--id") + .arg("--contract-id") .arg(&contract_id) .arg("--key") .arg(storage_key) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index afa374f22d..9f9363eaee 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -70,7 +70,7 @@ pub struct Cmd { pub ttl: Option>, /// Contract id to fetch an info for - #[arg(long = "id", env = "STELLAR_CONTRACT_ID")] + #[arg(long = "contract-id", env = "STELLAR_CONTRACT_ID")] pub contract_id: Option, /// Storage entry durability #[arg(long, value_enum, default_value = "persistent")] From 8861054b306d9b81933b68b9010bbf4e4f9b780a Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 6 May 2025 10:24:27 -0400 Subject: [PATCH 12/76] Refactor contract data test --- .../tests/it/integration/ledger/entry.rs | 59 ++++++++++++++----- 1 file changed, 45 insertions(+), 14 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index e8002c4e92..16c6d18b59 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -1,7 +1,7 @@ use soroban_test::AssertExt; use soroban_test::TestEnv; use soroban_rpc::FullLedgerEntries; -use soroban_cli::xdr::{LedgerKey, LedgerKeyTrustLine, LedgerKeyAccount, PublicKey, Uint256, AccountId, LedgerKeyData, LedgerEntryData, AssetCode4, AlphaNum4, TrustLineAsset, LedgerKeyContractData, ScVal, ScAddress, StringM, String64, Hash, ContractDataDurability }; +use soroban_cli::xdr::{LedgerKey, LedgerKeyTrustLine, LedgerKeyAccount, PublicKey, Uint256, AccountId, LedgerKeyData, LedgerEntryData, AssetCode4, AlphaNum4, TrustLineAsset, LedgerKeyContractData, ScVal, ScAddress, StringM, String64, Hash, ContractDataDurability, WriteXdr, Limits}; use stellar_strkey::{ ed25519::PublicKey as StrkeyPublicKeyEd25519, Contract @@ -52,7 +52,7 @@ async fn ledger_entry_account_asset_xlm(){ .arg(account_alias) .arg("--asset") // though xlm does not have, nor need, a trustline, "xlm" is a valid argument to `--asset` - // so this test is including it to make sure that the account ledger entry is still included in the output + // this test is including it to make sure that the account ledger entry is still included in the output .arg("xlm") .assert() .success() @@ -172,12 +172,16 @@ async fn ledger_entry_contract_data() { ).await; let storage_key = "COUNTER"; + let storage_key_xdr = ScVal::Symbol(storage_key.try_into().unwrap()).to_xdr_base64(Limits::none()).unwrap(); + + // update contract storage sandbox .invoke_with_test(&["--id", &contract_id, "--", "inc"]) .await .unwrap(); - let output = sandbox + // get entry by key + let key_output = sandbox .new_assert_cmd("ledger") .arg("entry") .arg("fetch") @@ -190,20 +194,37 @@ async fn ledger_entry_contract_data() { .assert() .success() .stdout_as_str(); + let parsed_key_output: FullLedgerEntries = serde_json::from_str(&key_output).expect("Failed to parse JSON"); + assert!(!parsed_key_output.entries.is_empty()); + + // get entry by key xdr + let key_xdr_output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--contract-id") + .arg(&contract_id) + .arg("--key-xdr") + .arg(storage_key_xdr) + .assert() + .success() + .stdout_as_str(); - let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed.entries.is_empty()); + let parsed_key_xdr_output: FullLedgerEntries = serde_json::from_str(&key_xdr_output).expect("Failed to parse JSON"); + assert!(!parsed_key_xdr_output.entries.is_empty()); - let contract_bytes: [u8; 32] = Contract::from_string(&contract_id).unwrap().0; - let contract_id = Hash(contract_bytes); + let expected_contract_data_key = expected_contract_ledger_key(&contract_id, storage_key).await; - let expected_contract_data_key = LedgerKey::ContractData(LedgerKeyContractData { - contract: ScAddress::Contract(contract_id), - key: ScVal::Symbol(storage_key.try_into().unwrap()), - durability: ContractDataDurability::Persistent} - ); - assert_eq!(parsed.entries[0].key, expected_contract_data_key); - assert!(matches!(parsed.entries[0].val, LedgerEntryData::ContractData{ .. })); + assert_eq!(parsed_key_output.entries[0].key, expected_contract_data_key); + assert!(matches!(parsed_key_output.entries[0].val, LedgerEntryData::ContractData{ .. })); + + assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); + assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); + + // the output should be the same regardless of key format + assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } // top level test @@ -290,6 +311,16 @@ async fn expected_account_ledger_key(account_addr: &str) -> (AccountId, LedgerKe (account_id, ledger_key) } +async fn expected_contract_ledger_key(contract_id: &str, storage_key: &str) -> LedgerKey{ + let contract_bytes: [u8; 32] = Contract::from_string(contract_id).unwrap().0; + let contract_id = Hash(contract_bytes); + LedgerKey::ContractData(LedgerKeyContractData { + contract: ScAddress::Contract(contract_id), + key: ScVal::Symbol(storage_key.try_into().unwrap()), + durability: ContractDataDurability::Persistent} + ) +} + async fn add_data(sandbox: &TestEnv, account_alias: &str, key: &str, value: &str) { sandbox .new_assert_cmd("tx") From d4a33a81a89eb5114ad56f3e161306b143330a1a Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 6 May 2025 16:27:06 -0400 Subject: [PATCH 13/76] More ledger entry fetch tests --- .../tests/it/integration/ledger/entry.rs | 147 +++++++++++++++++- .../src/commands/ledger/entry/fetch.rs | 2 + 2 files changed, 146 insertions(+), 3 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 16c6d18b59..f718c21a7e 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -1,11 +1,12 @@ use soroban_test::AssertExt; use soroban_test::TestEnv; use soroban_rpc::FullLedgerEntries; -use soroban_cli::xdr::{LedgerKey, LedgerKeyTrustLine, LedgerKeyAccount, PublicKey, Uint256, AccountId, LedgerKeyData, LedgerEntryData, AssetCode4, AlphaNum4, TrustLineAsset, LedgerKeyContractData, ScVal, ScAddress, StringM, String64, Hash, ContractDataDurability, WriteXdr, Limits}; +use soroban_cli::xdr::{LedgerKey, LedgerKeyTrustLine, LedgerKeyAccount, PublicKey, Uint256, AccountId, LedgerKeyData, LedgerEntryData, AssetCode4, AlphaNum4, TrustLineAsset, LedgerKeyContractData, ScVal, ScAddress, StringM, String64, Hash, ContractDataDurability, WriteXdr, Limits, LedgerKeyContractCode, ConfigSettingId, LedgerKeyConfigSetting}; use stellar_strkey::{ ed25519::PublicKey as StrkeyPublicKeyEd25519, Contract }; +use soroban_spec_tools::utils::padded_hex_from_str; use crate::integration::util::{deploy_contract, test_address, HELLO_WORLD, DeployOptions}; @@ -122,7 +123,7 @@ async fn ledger_entry_account_data() { let account_alias = "new_account"; let new_account_addr = new_account(sandbox, account_alias); let data_name = "test_data_key"; - add_data(sandbox, account_alias, data_name, "abcdef").await; + add_account_data(sandbox, account_alias, data_name, "abcdef").await; let output = sandbox .new_assert_cmd("ledger") @@ -227,7 +228,147 @@ async fn ledger_entry_contract_data() { assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } + // top level test +// todo: test --ttl, --claimable-id, --pool-id, +#[tokio::test] +async fn ledger_entry_wasm_hash() { + let sandbox = &TestEnv::new(); + let test_account_alias = "test"; + let wasm = HELLO_WORLD; + let wasm_path = wasm.path(); + let contract_wasm_hash = sandbox.new_assert_cmd("contract") + .arg("upload") + .arg("--wasm") + .arg(wasm_path) + .assert() + .success() + .stdout_as_str(); + + deploy_contract( + sandbox, + HELLO_WORLD, + DeployOptions { + deployer: Some(test_account_alias.to_string()), + ..Default::default() + }, + ).await; + + // get the contract's wasm bytecode + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--wasm-hash") + .arg(&contract_wasm_hash) + .assert() + .success() + .stdout_as_str(); + let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed_output.entries.is_empty()); + + let hash = Hash(padded_hex_from_str(&contract_wasm_hash, 32).unwrap().try_into().unwrap()); + let expected_contract_key = LedgerKey::ContractCode(LedgerKeyContractCode { + hash + }); + + assert_eq!(parsed_output.entries[0].key, expected_contract_key); + assert!(matches!(parsed_output.entries[0].val, LedgerEntryData::ContractCode{ .. })); + // key: ContractCode(LedgerKeyContractCode { hash: Hash(74a0a58bee2730d38dfaa547c0f3e64b1b76cf7d7e430373a9bf7aad122aff9f) } + + // assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); + // assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); + + // // the output should be the same regardless of key format + // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); +} + +#[tokio::test] +async fn ledger_entry_config_setting_id() { + let sandbox = &TestEnv::new(); + let config_setting_ids = ConfigSettingId::VARIANTS; + + for config_setting_variant in config_setting_ids { + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--config-setting-id") + .arg((config_setting_variant as i32).to_string()) + .assert() + .success() + .stdout_as_str(); + let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed_output.entries.is_empty()); + + let expected_key = LedgerKey::ConfigSetting( + LedgerKeyConfigSetting{ + config_setting_id: config_setting_variant, + } + ); + assert_eq!(parsed_output.entries[0].key, expected_key); + assert!(matches!(parsed_output.entries[0].val, LedgerEntryData::ConfigSetting{ .. })); + } +} + + +#[ignore] +#[tokio::test] +async fn ledger_entry_ttl() { + let sandbox = &TestEnv::new(); + let test_account_alias = "test"; + let contract_id = deploy_contract( + sandbox, + HELLO_WORLD, + DeployOptions { + deployer: Some(test_account_alias.to_string()), + ..Default::default() + }, + ).await; + + let storage_key = "COUNTER"; + let storage_key_xdr = ScVal::Symbol(storage_key.try_into().unwrap()).to_xdr_base64(Limits::none()).unwrap(); + println!("storage key: {}", storage_key_xdr); + + // update contract storage + sandbox + .invoke_with_test(&["--id", &contract_id, "--", "inc"]) + .await + .unwrap(); + + // get the data's TTL + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("--network") + .arg("testnet") + .arg("--ttl") + .arg(storage_key_xdr) + .assert() + .success() + .stdout_as_str(); + let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed_output.entries.is_empty()); + + // let parsed_key_xdr_output: FullLedgerEntries = serde_json::from_str(&key_xdr_output).expect("Failed to parse JSON"); + // assert!(!parsed_key_xdr_output.entries.is_empty()); + + // let expected_contract_data_key = expected_contract_ledger_key(&contract_id, storage_key).await; + + // assert_eq!(parsed_key_output.entries[0].key, expected_contract_data_key); + // assert!(matches!(parsed_key_output.entries[0].val, LedgerEntryData::ContractData{ .. })); + + // assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); + // assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); + + // // the output should be the same regardless of key format + // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); +} // Helper Fns fn new_account(sandbox: &TestEnv, name: &str) -> String { @@ -321,7 +462,7 @@ async fn expected_contract_ledger_key(contract_id: &str, storage_key: &str) -> L ) } -async fn add_data(sandbox: &TestEnv, account_alias: &str, key: &str, value: &str) { +async fn add_account_data(sandbox: &TestEnv, account_alias: &str, key: &str, value: &str) { sandbox .new_assert_cmd("tx") .args([ diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index 9f9363eaee..2a66336a8b 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -175,6 +175,8 @@ impl Cmd { } } + // todo: should there be a flag that returns all config settings? + if let Some(config_setting_id) = &self.config_setting_id { for x in config_setting_id { let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { From e8cbc2382988423bbe9a5e5d125f62cc34f54e97 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 7 May 2025 11:45:00 -0400 Subject: [PATCH 14/76] Update generated docs --- FULL_HELP_DOCS.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 3d2c911b8a..02acb7f2c1 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -2714,15 +2714,15 @@ Work with ledger entries ###### **Subcommands:** -* `get` — Get ledger entries. This command supports every type of ledger entries supported by the RPC. Read more about RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys +* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys -## `stellar ledger entry get` +## `stellar ledger entry fetch` -Get ledger entries. This command supports every type of ledger entries supported by the RPC. Read more about RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys +Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys -**Usage:** `stellar ledger entry get [OPTIONS]` +**Usage:** `stellar ledger entry fetch [OPTIONS]` ###### **Options:** @@ -2742,7 +2742,7 @@ Get ledger entries. This command supports every type of ledger entries supported * `--config-setting-id ` — Defines the currently active network configuration * `--wasm-hash ` — Get WASM bytecode by hash * `--ttl ` — Get the time-to-live of an associated contract data or code entry -* `--id ` — Contract id to fetch an info for +* `--contract-id ` — Contract id to fetch an info for * `--durability ` — Storage entry durability Default value: `persistent` @@ -2757,15 +2757,15 @@ Get ledger entries. This command supports every type of ledger entries supported * `--key-xdr ` — Storage key (base64-encoded XDR) * `--output ` — Format of the output - Default value: `original` + Default value: `json` Possible values: - - `original`: - Original RPC output (containing XDRs) - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) From b03b1a4241c76bdab26796aa0ac1145132eedc2b Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 7 May 2025 11:54:02 -0400 Subject: [PATCH 15/76] Cargo fmt --- .../soroban-test/tests/it/integration.rs | 2 +- .../tests/it/integration/ledger/entry.rs | 195 +++++++++++------- .../src/commands/ledger/entry/fetch.rs | 20 +- 3 files changed, 134 insertions(+), 83 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration.rs b/cmd/crates/soroban-test/tests/it/integration.rs index 962dbd955c..67688dcf16 100644 --- a/cmd/crates/soroban-test/tests/it/integration.rs +++ b/cmd/crates/soroban-test/tests/it/integration.rs @@ -6,8 +6,8 @@ mod dotenv; mod hello_world; mod init; mod keys; -mod secure_store; mod ledger; +mod secure_store; mod snapshot; mod tx; mod util; diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index f718c21a7e..60b8b14be2 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -1,20 +1,21 @@ -use soroban_test::AssertExt; -use soroban_test::TestEnv; -use soroban_rpc::FullLedgerEntries; -use soroban_cli::xdr::{LedgerKey, LedgerKeyTrustLine, LedgerKeyAccount, PublicKey, Uint256, AccountId, LedgerKeyData, LedgerEntryData, AssetCode4, AlphaNum4, TrustLineAsset, LedgerKeyContractData, ScVal, ScAddress, StringM, String64, Hash, ContractDataDurability, WriteXdr, Limits, LedgerKeyContractCode, ConfigSettingId, LedgerKeyConfigSetting}; -use stellar_strkey::{ - ed25519::PublicKey as StrkeyPublicKeyEd25519, - Contract +use soroban_cli::xdr::{ + AccountId, AlphaNum4, AssetCode4, ConfigSettingId, ContractDataDurability, Hash, + LedgerEntryData, LedgerKey, LedgerKeyAccount, LedgerKeyConfigSetting, LedgerKeyContractCode, + LedgerKeyContractData, LedgerKeyData, LedgerKeyTrustLine, Limits, PublicKey, ScAddress, ScVal, + String64, StringM, TrustLineAsset, Uint256, WriteXdr, }; +use soroban_rpc::FullLedgerEntries; use soroban_spec_tools::utils::padded_hex_from_str; +use soroban_test::AssertExt; +use soroban_test::TestEnv; +use stellar_strkey::{ed25519::PublicKey as StrkeyPublicKeyEd25519, Contract}; -use crate::integration::util::{deploy_contract, test_address, HELLO_WORLD, DeployOptions}; - +use crate::integration::util::{deploy_contract, test_address, DeployOptions, HELLO_WORLD}; // account data tests // todo: test with--offer, #[tokio::test] -async fn ledger_entry_account_only(){ +async fn ledger_entry_account_only() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; let new_account_addr = new_account(sandbox, account_alias); @@ -35,11 +36,14 @@ async fn ledger_entry_account_only(){ assert!(!parsed.entries.is_empty()); assert_eq!(parsed.entries[0].key, expected_key); - assert!(matches!(parsed.entries[0].val, LedgerEntryData::Account { .. })); + assert!(matches!( + parsed.entries[0].val, + LedgerEntryData::Account { .. } + )); } #[tokio::test] -async fn ledger_entry_account_asset_xlm(){ +async fn ledger_entry_account_asset_xlm() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; let new_account_addr = new_account(sandbox, account_alias); @@ -53,7 +57,7 @@ async fn ledger_entry_account_asset_xlm(){ .arg(account_alias) .arg("--asset") // though xlm does not have, nor need, a trustline, "xlm" is a valid argument to `--asset` - // this test is including it to make sure that the account ledger entry is still included in the output + // this test is including it to make sure that the account ledger entry is still included in the output .arg("xlm") .assert() .success() @@ -64,11 +68,14 @@ async fn ledger_entry_account_asset_xlm(){ let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed.entries.is_empty()); assert_eq!(parsed.entries[0].key, expected_key); - assert!(matches!(parsed.entries[0].val, LedgerEntryData::Account { .. })); + assert!(matches!( + parsed.entries[0].val, + LedgerEntryData::Account { .. } + )); } #[tokio::test] -async fn ledger_entry_account_asset_usdc(){ +async fn ledger_entry_account_asset_usdc() { let sandbox = &TestEnv::new(); let test_account_alias = "test"; let test_account_address = test_address(sandbox); @@ -77,7 +84,14 @@ async fn ledger_entry_account_asset_usdc(){ let asset = &format!("usdc:{issuer_address}"); let limit = 100_000; let initial_balance = 100; - issue_asset(sandbox, &test_account_address, asset, limit, initial_balance).await; + issue_asset( + sandbox, + &test_account_address, + asset, + limit, + initial_balance, + ) + .await; let output = sandbox .new_assert_cmd("ledger") @@ -93,7 +107,8 @@ async fn ledger_entry_account_asset_usdc(){ .success() .stdout_as_str(); - let (account_id, expected_account_key) = expected_account_ledger_key(&test_account_address).await; + let (account_id, expected_account_key) = + expected_account_ledger_key(&test_account_address).await; let (issuer_account_id, _) = expected_account_ledger_key(&issuer_address).await; let trustline_asset = TrustLineAsset::CreditAlphanum4(AlphaNum4 { @@ -110,7 +125,10 @@ async fn ledger_entry_account_asset_usdc(){ let trustline_entry = &parsed.entries[0]; assert_eq!(trustline_entry.key, expected_trustline_key); - assert!(matches!(trustline_entry.val, LedgerEntryData::Trustline { .. })); + assert!(matches!( + trustline_entry.val, + LedgerEntryData::Trustline { .. } + )); let account_entry = &parsed.entries[1]; assert_eq!(account_entry.key, expected_account_key); @@ -124,7 +142,7 @@ async fn ledger_entry_account_data() { let new_account_addr = new_account(sandbox, account_alias); let data_name = "test_data_key"; add_account_data(sandbox, account_alias, data_name, "abcdef").await; - + let output = sandbox .new_assert_cmd("ledger") .arg("entry") @@ -170,10 +188,13 @@ async fn ledger_entry_contract_data() { deployer: Some(test_account_alias.to_string()), ..Default::default() }, - ).await; + ) + .await; let storage_key = "COUNTER"; - let storage_key_xdr = ScVal::Symbol(storage_key.try_into().unwrap()).to_xdr_base64(Limits::none()).unwrap(); + let storage_key_xdr = ScVal::Symbol(storage_key.try_into().unwrap()) + .to_xdr_base64(Limits::none()) + .unwrap(); // update contract storage sandbox @@ -195,9 +216,10 @@ async fn ledger_entry_contract_data() { .assert() .success() .stdout_as_str(); - let parsed_key_output: FullLedgerEntries = serde_json::from_str(&key_output).expect("Failed to parse JSON"); + let parsed_key_output: FullLedgerEntries = + serde_json::from_str(&key_output).expect("Failed to parse JSON"); assert!(!parsed_key_output.entries.is_empty()); - + // get entry by key xdr let key_xdr_output = sandbox .new_assert_cmd("ledger") @@ -213,22 +235,31 @@ async fn ledger_entry_contract_data() { .success() .stdout_as_str(); - let parsed_key_xdr_output: FullLedgerEntries = serde_json::from_str(&key_xdr_output).expect("Failed to parse JSON"); + let parsed_key_xdr_output: FullLedgerEntries = + serde_json::from_str(&key_xdr_output).expect("Failed to parse JSON"); assert!(!parsed_key_xdr_output.entries.is_empty()); let expected_contract_data_key = expected_contract_ledger_key(&contract_id, storage_key).await; assert_eq!(parsed_key_output.entries[0].key, expected_contract_data_key); - assert!(matches!(parsed_key_output.entries[0].val, LedgerEntryData::ContractData{ .. })); + assert!(matches!( + parsed_key_output.entries[0].val, + LedgerEntryData::ContractData { .. } + )); + + assert_eq!( + parsed_key_xdr_output.entries[0].key, + expected_contract_data_key + ); + assert!(matches!( + parsed_key_xdr_output.entries[0].val, + LedgerEntryData::ContractData { .. } + )); - assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); - assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); - // the output should be the same regardless of key format assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } - // top level test // todo: test --ttl, --claimable-id, --pool-id, #[tokio::test] @@ -237,7 +268,8 @@ async fn ledger_entry_wasm_hash() { let test_account_alias = "test"; let wasm = HELLO_WORLD; let wasm_path = wasm.path(); - let contract_wasm_hash = sandbox.new_assert_cmd("contract") + let contract_wasm_hash = sandbox + .new_assert_cmd("contract") .arg("upload") .arg("--wasm") .arg(wasm_path) @@ -252,7 +284,8 @@ async fn ledger_entry_wasm_hash() { deployer: Some(test_account_alias.to_string()), ..Default::default() }, - ).await; + ) + .await; // get the contract's wasm bytecode let output = sandbox @@ -266,21 +299,28 @@ async fn ledger_entry_wasm_hash() { .assert() .success() .stdout_as_str(); - let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + let parsed_output: FullLedgerEntries = + serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed_output.entries.is_empty()); - - let hash = Hash(padded_hex_from_str(&contract_wasm_hash, 32).unwrap().try_into().unwrap()); - let expected_contract_key = LedgerKey::ContractCode(LedgerKeyContractCode { - hash - }); + + let hash = Hash( + padded_hex_from_str(&contract_wasm_hash, 32) + .unwrap() + .try_into() + .unwrap(), + ); + let expected_contract_key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); assert_eq!(parsed_output.entries[0].key, expected_contract_key); - assert!(matches!(parsed_output.entries[0].val, LedgerEntryData::ContractCode{ .. })); + assert!(matches!( + parsed_output.entries[0].val, + LedgerEntryData::ContractCode { .. } + )); // key: ContractCode(LedgerKeyContractCode { hash: Hash(74a0a58bee2730d38dfaa547c0f3e64b1b76cf7d7e430373a9bf7aad122aff9f) } // assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); // assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); - + // // the output should be the same regardless of key format // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } @@ -301,21 +341,22 @@ async fn ledger_entry_config_setting_id() { .arg((config_setting_variant as i32).to_string()) .assert() .success() - .stdout_as_str(); - let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + .stdout_as_str(); + let parsed_output: FullLedgerEntries = + serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed_output.entries.is_empty()); - let expected_key = LedgerKey::ConfigSetting( - LedgerKeyConfigSetting{ - config_setting_id: config_setting_variant, - } - ); + let expected_key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { + config_setting_id: config_setting_variant, + }); assert_eq!(parsed_output.entries[0].key, expected_key); - assert!(matches!(parsed_output.entries[0].val, LedgerEntryData::ConfigSetting{ .. })); + assert!(matches!( + parsed_output.entries[0].val, + LedgerEntryData::ConfigSetting { .. } + )); } } - #[ignore] #[tokio::test] async fn ledger_entry_ttl() { @@ -328,10 +369,13 @@ async fn ledger_entry_ttl() { deployer: Some(test_account_alias.to_string()), ..Default::default() }, - ).await; + ) + .await; let storage_key = "COUNTER"; - let storage_key_xdr = ScVal::Symbol(storage_key.try_into().unwrap()).to_xdr_base64(Limits::none()).unwrap(); + let storage_key_xdr = ScVal::Symbol(storage_key.try_into().unwrap()) + .to_xdr_base64(Limits::none()) + .unwrap(); println!("storage key: {}", storage_key_xdr); // update contract storage @@ -352,9 +396,10 @@ async fn ledger_entry_ttl() { .assert() .success() .stdout_as_str(); - let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + let parsed_output: FullLedgerEntries = + serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed_output.entries.is_empty()); - + // let parsed_key_xdr_output: FullLedgerEntries = serde_json::from_str(&key_xdr_output).expect("Failed to parse JSON"); // assert!(!parsed_key_xdr_output.entries.is_empty()); @@ -365,7 +410,7 @@ async fn ledger_entry_ttl() { // assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); // assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); - + // // the output should be the same regardless of key format // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } @@ -374,7 +419,7 @@ async fn ledger_entry_ttl() { fn new_account(sandbox: &TestEnv, name: &str) -> String { sandbox.generate_account(name, None).assert().success(); sandbox.fund_account(name).success(); - + sandbox .new_assert_cmd("keys") .args(["address", name]) @@ -442,39 +487,41 @@ async fn issue_asset(sandbox: &TestEnv, test: &str, asset: &str, limit: u64, ini .success(); } -async fn expected_account_ledger_key(account_addr: &str) -> (AccountId, LedgerKey){ +async fn expected_account_ledger_key(account_addr: &str) -> (AccountId, LedgerKey) { let strkey = StrkeyPublicKeyEd25519::from_string(account_addr).unwrap().0; let uint256 = Uint256(strkey); let pk = PublicKey::PublicKeyTypeEd25519(uint256); let account_id = AccountId(pk); - let ledger_key = LedgerKey::Account(LedgerKeyAccount { account_id: account_id.clone() }); + let ledger_key = LedgerKey::Account(LedgerKeyAccount { + account_id: account_id.clone(), + }); (account_id, ledger_key) } -async fn expected_contract_ledger_key(contract_id: &str, storage_key: &str) -> LedgerKey{ +async fn expected_contract_ledger_key(contract_id: &str, storage_key: &str) -> LedgerKey { let contract_bytes: [u8; 32] = Contract::from_string(contract_id).unwrap().0; let contract_id = Hash(contract_bytes); - LedgerKey::ContractData(LedgerKeyContractData { + LedgerKey::ContractData(LedgerKeyContractData { contract: ScAddress::Contract(contract_id), key: ScVal::Symbol(storage_key.try_into().unwrap()), - durability: ContractDataDurability::Persistent} - ) + durability: ContractDataDurability::Persistent, + }) } async fn add_account_data(sandbox: &TestEnv, account_alias: &str, key: &str, value: &str) { sandbox - .new_assert_cmd("tx") - .args([ - "new", - "manage-data", - "--data-name", - key, - "--data-value", - value, - "--source", - account_alias, - ]) - .assert() - .success(); -} \ No newline at end of file + .new_assert_cmd("tx") + .args([ + "new", + "manage-data", + "--data-name", + key, + "--data-value", + value, + "--source", + account_alias, + ]) + .assert() + .success(); +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index 2a66336a8b..772957b3c0 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -8,6 +8,7 @@ use crate::commands::ledger::entry::fetch::Error::{ InvalidHash, }; use crate::config::locator; +use crate::config::network::Network; use crate::rpc::{self}; use crate::{config, xdr}; use clap::{command, Parser}; @@ -15,14 +16,13 @@ use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; use stellar_xdr::curr::{ - ClaimableBalanceId::ClaimableBalanceIdTypeV0, - AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, ConfigSettingId, - ContractDataDurability, Hash, LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, - LedgerKeyConfigSetting, LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, - LedgerKeyLiquidityPool, LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limits, MuxedAccount, - PoolId, PublicKey, ReadXdr, ScAddress, ScVal, String64, TrustLineAsset, Uint256, + AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, + ClaimableBalanceId::ClaimableBalanceIdTypeV0, ConfigSettingId, ContractDataDurability, Hash, + LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, LedgerKeyConfigSetting, + LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, LedgerKeyLiquidityPool, + LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limits, MuxedAccount, PoolId, PublicKey, + ReadXdr, ScAddress, ScVal, String64, TrustLineAsset, Uint256, }; -use crate::config::network::Network; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -298,7 +298,11 @@ impl Cmd { Ok(()) } - fn insert_contract_keys(&self, network: &Network, ledger_keys: &mut Vec) -> Result<(), Error> { + fn insert_contract_keys( + &self, + network: &Network, + ledger_keys: &mut Vec, + ) -> Result<(), Error> { if let Some(contract_id) = &self.contract_id { let contract_id = contract_id.resolve_contract_id(&self.locator, &network.network_passphrase)?; From 12e2d337721e8206c61affb0d96dcb7e824f34cd Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 7 May 2025 13:54:29 -0400 Subject: [PATCH 16/76] Update rs-stellar-rpc-client sha in Cargo.lock --- Cargo.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.lock b/Cargo.lock index 212d60c9ef..6773d551ed 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4825,7 +4825,7 @@ dependencies = [ [[package]] name = "stellar-rpc-client" version = "22.1.0" -source = "git+https://github.com/stellar/rs-stellar-rpc-client?branch=serde-le#a8659895a4b7d4f61481b523e086cc5dd560f69c" +source = "git+https://github.com/stellar/rs-stellar-rpc-client?branch=serde-le#530e210de1ab7474a0cad6ef3325d8dd09ae4c1d" dependencies = [ "clap", "hex", From 398d112cb41de9dbceb24910fbe3629121e8ea46 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 7 May 2025 14:03:04 -0400 Subject: [PATCH 17/76] Update ttl ledger entry option --- .../tests/it/integration/ledger/entry.rs | 30 ++----------------- .../src/commands/ledger/entry/fetch.rs | 25 ++++++++++++++-- 2 files changed, 24 insertions(+), 31 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 60b8b14be2..80fb0408e1 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -372,19 +372,7 @@ async fn ledger_entry_ttl() { ) .await; - let storage_key = "COUNTER"; - let storage_key_xdr = ScVal::Symbol(storage_key.try_into().unwrap()) - .to_xdr_base64(Limits::none()) - .unwrap(); - println!("storage key: {}", storage_key_xdr); - - // update contract storage - sandbox - .invoke_with_test(&["--id", &contract_id, "--", "inc"]) - .await - .unwrap(); - - // get the data's TTL + // get the contract's TTL let output = sandbox .new_assert_cmd("ledger") .arg("entry") @@ -392,27 +380,13 @@ async fn ledger_entry_ttl() { .arg("--network") .arg("testnet") .arg("--ttl") - .arg(storage_key_xdr) + .arg(contract_id) .assert() .success() .stdout_as_str(); let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed_output.entries.is_empty()); - - // let parsed_key_xdr_output: FullLedgerEntries = serde_json::from_str(&key_xdr_output).expect("Failed to parse JSON"); - // assert!(!parsed_key_xdr_output.entries.is_empty()); - - // let expected_contract_data_key = expected_contract_ledger_key(&contract_id, storage_key).await; - - // assert_eq!(parsed_key_output.entries[0].key, expected_contract_data_key); - // assert!(matches!(parsed_key_output.entries[0].val, LedgerEntryData::ContractData{ .. })); - - // assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); - // assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); - - // // the output should be the same regardless of key format - // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } // Helper Fns diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs index 772957b3c0..672e66b69c 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs @@ -12,9 +12,10 @@ use crate::config::network::Network; use crate::rpc::{self}; use crate::{config, xdr}; use clap::{command, Parser}; -use hex::FromHexError; +use hex::{FromHex, FromHexError}; use soroban_spec_tools::utils::padded_hex_from_str; -use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; +use stellar_strkey::Strkey; +use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey, Contract}; use stellar_xdr::curr::{ AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, ClaimableBalanceId::ClaimableBalanceIdTypeV0, ConfigSettingId, ContractDataDurability, Hash, @@ -189,7 +190,25 @@ impl Cmd { if let Some(ttl) = &self.ttl { for x in ttl { - let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); + let bytes: [u8; 32] = if x.starts_with('C') && x.len() == 56 { + // Contract ID (StrKey-encoded) + if let stellar_strkey::Strkey::Contract(Contract(contract_id)) = + Strkey::from_string(x).unwrap() + { + contract_id + } else { + //todo: handle this error + panic!("Invalid StrKey type, expected Contract"); + } + } else { + // Hex-encoded 32-byte hash + let clean = x.trim_start_matches("0x"); + // todo: handle this error + let vec = Vec::from_hex(clean).unwrap(); + vec.try_into().unwrap() + }; + + let hash = Hash(bytes); let key = LedgerKey::Ttl(LedgerKeyTtl { key_hash: hash }); ledger_keys.push(key); } From 345a9a8d24fba8854c1fcab47f4ccc5b7a3cc1ad Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 12 May 2025 15:30:45 -0400 Subject: [PATCH 18/76] Update ledger entry fetch cmd structure to use subcommands --- .../tests/it/integration/ledger/entry.rs | 41 +- .../src/commands/ledger/entry/fetch.rs | 370 ------------------ .../commands/ledger/entry/fetch/account.rs | 187 +++++++++ .../src/commands/ledger/entry/fetch/mod.rs | 30 ++ .../src/commands/ledger/entry/mod.rs | 1 + 5 files changed, 256 insertions(+), 373 deletions(-) delete mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch.rs create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 80fb0408e1..20ed5a8849 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -15,7 +15,7 @@ use crate::integration::util::{deploy_contract, test_address, DeployOptions, HEL // account data tests // todo: test with--offer, #[tokio::test] -async fn ledger_entry_account_only() { +async fn ledger_entry_account_only_with_account_alias() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; let new_account_addr = new_account(sandbox, account_alias); @@ -23,10 +23,38 @@ async fn ledger_entry_account_only() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") + .arg("account") + .arg(account_alias) + .arg("--network") + .arg("testnet") + .assert() + .success() + .stdout_as_str(); + + let (_, expected_key) = expected_account_ledger_key(&new_account_addr).await; + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + + assert!(!parsed.entries.is_empty()); + assert_eq!(parsed.entries[0].key, expected_key); + assert!(matches!( + parsed.entries[0].val, + LedgerEntryData::Account { .. } + )); +} + +#[ignore] +#[tokio::test] +async fn ledger_entry_account_only_with_account_addr() { + let sandbox = &TestEnv::new(); + let new_account_addr = new_account(sandbox, "new_account"); + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("account") + .arg(&new_account_addr) .arg("--network") .arg("testnet") - .arg("--account") - .arg(account_alias) .assert() .success() .stdout_as_str(); @@ -42,7 +70,9 @@ async fn ledger_entry_account_only() { )); } + #[tokio::test] +#[ignore] async fn ledger_entry_account_asset_xlm() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; @@ -75,6 +105,7 @@ async fn ledger_entry_account_asset_xlm() { } #[tokio::test] +#[ignore] async fn ledger_entry_account_asset_usdc() { let sandbox = &TestEnv::new(); let test_account_alias = "test"; @@ -136,6 +167,7 @@ async fn ledger_entry_account_asset_usdc() { } #[tokio::test] +#[ignore] async fn ledger_entry_account_data() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; @@ -177,6 +209,7 @@ async fn ledger_entry_account_data() { } // contract data tests +#[ignore] #[tokio::test] async fn ledger_entry_contract_data() { let sandbox = &TestEnv::new(); @@ -262,6 +295,7 @@ async fn ledger_entry_contract_data() { // top level test // todo: test --ttl, --claimable-id, --pool-id, +#[ignore] #[tokio::test] async fn ledger_entry_wasm_hash() { let sandbox = &TestEnv::new(); @@ -325,6 +359,7 @@ async fn ledger_entry_wasm_hash() { // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } +#[ignore] #[tokio::test] async fn ledger_entry_config_setting_id() { let sandbox = &TestEnv::new(); diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs deleted file mode 100644 index 672e66b69c..0000000000 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch.rs +++ /dev/null @@ -1,370 +0,0 @@ -use std::array::TryFromSliceError; -use std::fmt::Debug; - -use crate::commands::config::network; -use crate::commands::contract::Durability; -use crate::commands::ledger::entry::fetch::Error::{ - AccountRequired, ContractRequired, EmptyKeys, InvalidAsset, InvalidConfigId, InvalidDataName, - InvalidHash, -}; -use crate::config::locator; -use crate::config::network::Network; -use crate::rpc::{self}; -use crate::{config, xdr}; -use clap::{command, Parser}; -use hex::{FromHex, FromHexError}; -use soroban_spec_tools::utils::padded_hex_from_str; -use stellar_strkey::Strkey; -use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey, Contract}; -use stellar_xdr::curr::{ - AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, - ClaimableBalanceId::ClaimableBalanceIdTypeV0, ConfigSettingId, ContractDataDurability, Hash, - LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, LedgerKeyConfigSetting, - LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, LedgerKeyLiquidityPool, - LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limits, MuxedAccount, PoolId, PublicKey, - ReadXdr, ScAddress, ScVal, String64, TrustLineAsset, Uint256, -}; - -#[derive(Parser, Debug, Clone)] -#[group(skip)] -pub struct Cmd { - #[command(flatten)] - pub network: network::Args, - #[command(flatten)] - pub locator: locator::Args, - - /// Name of identity to lookup, default is test identity - #[arg(long)] - pub account: Option, - /// If identity is a seed phrase use this hd path, default is 0 - #[arg(long)] - pub hd_path: Option, - - /// Assets to get trustline info for - #[arg(long)] - pub asset: Option>, - /// ID of an offer made on the Stellar DEX - #[arg(long)] - pub offer: Option>, - /// Fetch key-value data entries attached to an account (see manageDataOp) - #[arg(long)] - pub data_name: Option>, - - /// Claimable Balance id - #[arg(long)] - pub claimable_id: Option>, - - /// Liquidity pool id - #[arg(long)] - pub pool_id: Option>, - - /// Defines the currently active network configuration - #[arg(long)] - pub config_setting_id: Option>, - - /// Get WASM bytecode by hash - #[arg(long)] - pub wasm_hash: Option>, - - /// Get the time-to-live of an associated contract data or code entry - #[arg(long)] - pub ttl: Option>, - - /// Contract id to fetch an info for - #[arg(long = "contract-id", env = "STELLAR_CONTRACT_ID")] - pub contract_id: Option, - /// Storage entry durability - #[arg(long, value_enum, default_value = "persistent")] - pub durability: Durability, - /// Storage key (symbols only) - #[arg(long = "key")] - pub key: Option>, - /// Storage key (base64-encoded XDR) - #[arg(long = "key-xdr")] - pub key_xdr: Option>, - - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, -} - -#[derive(thiserror::Error, Debug)] -pub enum Error { - #[error(transparent)] - Config(#[from] config::key::Error), - #[error(transparent)] - Locator(#[from] locator::Error), - #[error(transparent)] - Rpc(#[from] rpc::Error), - #[error(transparent)] - Network(#[from] network::Error), - #[error(transparent)] - Serde(#[from] serde_json::Error), - #[error(transparent)] - StellarXdr(#[from] stellar_xdr::curr::Error), - #[error(transparent)] - Spec(#[from] soroban_spec_tools::Error), - #[error(transparent)] - TryFromSliceError(#[from] TryFromSliceError), - #[error(transparent)] - FromHexError(#[from] FromHexError), - #[error("at least one key must be provided")] - EmptyKeys, - #[error("contract id is required but was not provided")] - ContractRequired, - #[error("account is required but was not provided")] - AccountRequired, - #[error("provided asset is invalid: {0}")] - InvalidAsset(String), - #[error("provided data name is invalid: {0}")] - InvalidDataName(String), - #[error("provided hash value is invalid: {0}")] - InvalidHash(String), - #[error("provided config id is invalid: {0}")] - InvalidConfigId(i32), -} - -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} - -impl Cmd { - pub async fn run(&self) -> Result<(), Error> { - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; - let mut ledger_keys = vec![]; - - self.insert_contract_keys(&network, &mut ledger_keys)?; - - self.insert_account_keys(&mut ledger_keys)?; - - if let Some(claimable_id) = &self.claimable_id { - for x in claimable_id { - let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); - let key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { - balance_id: ClaimableBalanceIdTypeV0(hash), - }); - ledger_keys.push(key); - } - } - - if let Some(pool_id) = &self.pool_id { - for x in pool_id { - let hash = Hash(padded_hex_from_str(x, 32)?.try_into().unwrap()); - let key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { - liquidity_pool_id: PoolId(hash), - }); - ledger_keys.push(key); - } - } - - if let Some(wasm_hash) = &self.wasm_hash { - for wasm_hash in wasm_hash { - let hash = Hash( - soroban_spec_tools::utils::contract_id_from_str(wasm_hash) - .map_err(|_| InvalidHash(wasm_hash.clone()))?, - ); - let key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); - ledger_keys.push(key); - } - } - - // todo: should there be a flag that returns all config settings? - - if let Some(config_setting_id) = &self.config_setting_id { - for x in config_setting_id { - let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { - config_setting_id: ConfigSettingId::try_from(*x) - .map_err(|_| InvalidConfigId(*x))?, - }); - ledger_keys.push(key); - } - } - - if let Some(ttl) = &self.ttl { - for x in ttl { - let bytes: [u8; 32] = if x.starts_with('C') && x.len() == 56 { - // Contract ID (StrKey-encoded) - if let stellar_strkey::Strkey::Contract(Contract(contract_id)) = - Strkey::from_string(x).unwrap() - { - contract_id - } else { - //todo: handle this error - panic!("Invalid StrKey type, expected Contract"); - } - } else { - // Hex-encoded 32-byte hash - let clean = x.trim_start_matches("0x"); - // todo: handle this error - let vec = Vec::from_hex(clean).unwrap(); - vec.try_into().unwrap() - }; - - let hash = Hash(bytes); - let key = LedgerKey::Ttl(LedgerKeyTtl { key_hash: hash }); - ledger_keys.push(key); - } - } - - if ledger_keys.is_empty() { - return Err(EmptyKeys); - } - - match self.output { - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Xdr => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); - } - } - - Ok(()) - } - - fn insert_account_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(acc) = &self.account { - let acc = self.muxed_account(acc)?; - - if let Some(asset) = &self.asset { - for asset in asset { - let asset = if asset.eq_ignore_ascii_case("XLM") { - TrustLineAsset::Native - } else if asset.contains(':') { - let mut parts = asset.split(':'); - let code = parts.next().ok_or(InvalidAsset(asset.clone()))?; - let issuer = parts.next().ok_or(InvalidAsset(asset.clone()))?; - if parts.next().is_some() { - Err(InvalidAsset(asset.clone()))?; - } - let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; - let issuer = - AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); - - match code.len() { - 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { - asset_code: AssetCode4(code.as_bytes().try_into()?), - issuer, - }), - 12 => TrustLineAsset::CreditAlphanum12(AlphaNum12 { - asset_code: AssetCode12(code.as_bytes().try_into()?), - issuer, - }), - _ => Err(InvalidAsset(asset.clone()))?, - } - } else { - Err(InvalidAsset(asset.clone()))? - }; - - let key = LedgerKey::Trustline(LedgerKeyTrustLine { - account_id: acc.clone().account_id(), - asset, - }); - - ledger_keys.push(key); - } - } - - if let Some(offer) = &self.offer { - for offer in offer { - let key = LedgerKey::Offer(LedgerKeyOffer { - seller_id: acc.clone().account_id(), - offer_id: *offer, - }); - ledger_keys.push(key); - } - } - - if let Some(data_name) = &self.data_name { - for data_name in data_name { - let data_name: xdr::StringM<64> = data_name - .parse() - .map_err(|_| InvalidDataName(data_name.clone()))?; - let data_name = String64(data_name); - let key = LedgerKey::Data(LedgerKeyData { - account_id: acc.clone().account_id(), - data_name, - }); - ledger_keys.push(key); - } - } - - // always add the account key into the list - // should we allow this to be configurable? - let key = LedgerKey::Account(LedgerKeyAccount { - account_id: acc.account_id(), - }); - - ledger_keys.push(key); - } else if self.asset.is_some() || self.offer.is_some() || self.data_name.is_some() { - return Err(AccountRequired); - } - - Ok(()) - } - - fn insert_contract_keys( - &self, - network: &Network, - ledger_keys: &mut Vec, - ) -> Result<(), Error> { - if let Some(contract_id) = &self.contract_id { - let contract_id = - contract_id.resolve_contract_id(&self.locator, &network.network_passphrase)?; - - let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); - - if let Some(keys) = &self.key { - for key in keys { - let key = LedgerKey::ContractData(LedgerKeyContractData { - contract: contract_address_arg.clone(), - key: soroban_spec_tools::from_string_primitive( - key, - &xdr::ScSpecTypeDef::Symbol, - )?, - durability: ContractDataDurability::Persistent, - }); - - ledger_keys.push(key); - } - } - - if let Some(keys) = &self.key_xdr { - for key in keys { - let key = LedgerKey::ContractData(LedgerKeyContractData { - contract: contract_address_arg.clone(), - key: ScVal::from_xdr_base64(key, Limits::none())?, - durability: ContractDataDurability::Persistent, - }); - - ledger_keys.push(key); - } - } - } else if self.key.is_some() || self.key_xdr.is_some() { - return Err(ContractRequired); - } - - Ok(()) - } - - fn muxed_account(&self, account: &str) -> Result { - Ok(self - .locator - .read_identity(account)? - .muxed_account(self.hd_path)?) - } -} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs new file mode 100644 index 0000000000..17a5d04da4 --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -0,0 +1,187 @@ +use std::array::TryFromSliceError; +use std::fmt::Debug; + +use crate::commands::config::network; +use crate::commands::contract::Durability; +use crate::config::locator; +use crate::config::network::Network; +use crate::rpc::{self}; +use crate::{config, xdr}; +use clap::{command, Parser}; +use hex::{FromHex, FromHexError}; +use soroban_spec_tools::utils::padded_hex_from_str; +use stellar_strkey::Strkey; +use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey, Contract}; +use stellar_xdr::curr::{ + AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, + ClaimableBalanceId::ClaimableBalanceIdTypeV0, ConfigSettingId, ContractDataDurability, Hash, + LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, LedgerKeyConfigSetting, + LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, LedgerKeyLiquidityPool, + LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limits, MuxedAccount, PoolId, PublicKey, + ReadXdr, ScAddress, ScVal, String64, TrustLineAsset, Uint256, +}; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Name of identity to lookup, default is test identity + pub account: String, + + /// If identity is a seed phrase use this hd path, default is 0 + #[arg(long)] + pub hd_path: Option, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, +} + + +// /// Assets to get trustline info for +// #[arg(long)] +// pub asset: Option>, +// /// ID of an offer made on the Stellar DEX +// #[arg(long)] +// pub offer: Option>, +// /// Fetch key-value data entries attached to an account (see manageDataOp) +// #[arg(long)] +// pub data_name: Option>, + +// /// Claimable Balance id +// #[arg(long)] +// pub claimable_id: Option>, + +// /// Liquidity pool id +// #[arg(long)] +// pub pool_id: Option>, + +// /// Defines the currently active network configuration +// #[arg(long)] +// pub config_setting_id: Option>, + +// /// Get WASM bytecode by hash +// #[arg(long)] +// pub wasm_hash: Option>, + +// /// Get the time-to-live of an associated contract data or code entry +// #[arg(long)] +// pub ttl: Option>, + +// /// Contract id to fetch an info for +// #[arg(long = "contract-id", env = "STELLAR_CONTRACT_ID")] +// pub contract_id: Option, +// /// Storage entry durability +// #[arg(long, value_enum, default_value = "persistent")] +// pub durability: Durability, +// /// Storage key (symbols only) +// #[arg(long = "key")] +// pub key: Option>, +// /// Storage key (base64-encoded XDR) +// #[arg(long = "key-xdr")] +// pub key_xdr: Option>, + +// } + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), +} + +// #[error(transparent)] +// StellarXdr(#[from] stellar_xdr::curr::Error), +// #[error(transparent)] +// Spec(#[from] soroban_spec_tools::Error), +// #[error(transparent)] +// TryFromSliceError(#[from] TryFromSliceError), +// #[error(transparent)] +// FromHexError(#[from] FromHexError), +// #[error("at least one key must be provided")] +// EmptyKeys, +// #[error("contract id is required but was not provided")] +// ContractRequired, +// #[error("account is required but was not provided")] +// AccountRequired, +// #[error("provided asset is invalid: {0}")] +// InvalidAsset(String), +// #[error("provided data name is invalid: {0}")] +// InvalidDataName(String), +// #[error("provided hash value is invalid: {0}")] +// InvalidHash(String), +// #[error("provided config id is invalid: {0}")] +// InvalidConfigId(i32), +// } + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; + let mut ledger_keys = vec![]; + + self.insert_account_keys(&mut ledger_keys)?; + + match self.output { + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + Ok(()) + } + + fn insert_account_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + let acc = self.muxed_account(&self.account)?; + // always add the account key into the list + // should we allow this to be configurable? + let key = LedgerKey::Account(LedgerKeyAccount { + account_id: acc.account_id(), + }); + + ledger_keys.push(key); + + + Ok(()) + } + + fn muxed_account(&self, account: &str) -> Result { + Ok(self + .locator + .read_identity(account)? + .muxed_account(self.hd_path)?) + } + +} \ No newline at end of file diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs new file mode 100644 index 0000000000..268a9e11a6 --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -0,0 +1,30 @@ +use std::fmt::Debug; + +use crate::rpc::{self}; +use clap::{command, Parser}; +use hex::{FromHex, FromHexError}; +use soroban_spec_tools::utils::padded_hex_from_str; +use stellar_strkey::Strkey; +use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey, Contract}; + +pub mod account; + +#[derive(Debug, Parser)] +pub enum Cmd { + Account(account::Cmd), +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Account(#[from] account::Error), +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + match self { + Cmd::Account(cmd) => cmd.run().await?, + } + Ok(()) + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs index 7c0b57ab01..f99d61fa7b 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -5,6 +5,7 @@ pub mod fetch; pub enum Cmd { /// Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. /// Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys + #[command(subcommand)] Fetch(fetch::Cmd), } From aecf0b3d7c9f4a204059de3142731c331862c5e1 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 12 May 2025 15:33:23 -0400 Subject: [PATCH 19/76] Allow a user to pass in a pub key when fetching acct ledger entries --- cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs | 1 - cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 20ed5a8849..6812f4423b 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -42,7 +42,6 @@ async fn ledger_entry_account_only_with_account_alias() { )); } -#[ignore] #[tokio::test] async fn ledger_entry_account_only_with_account_addr() { let sandbox = &TestEnv::new(); diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 17a5d04da4..65dbefbd0e 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -180,7 +180,7 @@ impl Cmd { fn muxed_account(&self, account: &str) -> Result { Ok(self .locator - .read_identity(account)? + .read_key(account)? .muxed_account(self.hd_path)?) } From ce360254e8543155a21c2835a37a466162dc9b83 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 12 May 2025 15:43:07 -0400 Subject: [PATCH 20/76] Keep updating ledger entry fetch account command to be a subcommand --- .../tests/it/integration/ledger/entry.rs | 35 +++--- .../commands/ledger/entry/fetch/account.rs | 113 +++++++++++++++--- 2 files changed, 115 insertions(+), 33 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 6812f4423b..55eb9602aa 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -71,7 +71,6 @@ async fn ledger_entry_account_only_with_account_addr() { #[tokio::test] -#[ignore] async fn ledger_entry_account_asset_xlm() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; @@ -80,10 +79,10 @@ async fn ledger_entry_account_asset_xlm() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") + .arg("account") + .arg(account_alias) .arg("--network") .arg("testnet") - .arg("--account") - .arg(account_alias) .arg("--asset") // though xlm does not have, nor need, a trustline, "xlm" is a valid argument to `--asset` // this test is including it to make sure that the account ledger entry is still included in the output @@ -104,7 +103,6 @@ async fn ledger_entry_account_asset_xlm() { } #[tokio::test] -#[ignore] async fn ledger_entry_account_asset_usdc() { let sandbox = &TestEnv::new(); let test_account_alias = "test"; @@ -127,10 +125,10 @@ async fn ledger_entry_account_asset_usdc() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") + .arg("account") + .arg(test_account_alias) .arg("--network") .arg("testnet") - .arg("--account") - .arg(test_account_alias) .arg("--asset") .arg(asset) .assert() @@ -153,20 +151,19 @@ async fn ledger_entry_account_asset_usdc() { let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed.entries.is_empty()); - let trustline_entry = &parsed.entries[0]; + let account_entry = &parsed.entries[0]; + assert_eq!(account_entry.key, expected_account_key); + assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); + + let trustline_entry = &parsed.entries[1]; assert_eq!(trustline_entry.key, expected_trustline_key); assert!(matches!( trustline_entry.val, LedgerEntryData::Trustline { .. } )); - - let account_entry = &parsed.entries[1]; - assert_eq!(account_entry.key, expected_account_key); - assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); } #[tokio::test] -#[ignore] async fn ledger_entry_account_data() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; @@ -178,10 +175,10 @@ async fn ledger_entry_account_data() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") + .arg("account") + .arg(account_alias) .arg("--network") .arg("testnet") - .arg("--account") - .arg(account_alias) .arg("--data-name") .arg(data_name) .assert() @@ -193,7 +190,11 @@ async fn ledger_entry_account_data() { let (account_id, expected_account_key) = expected_account_ledger_key(&new_account_addr).await; - let data_entry = &parsed.entries[0]; + let account_entry = &parsed.entries[0]; + assert_eq!(account_entry.key, expected_account_key); + assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); + + let data_entry = &parsed.entries[1]; let name_bounded_string = StringM::<64>::try_from(data_name).unwrap(); let expected_data_key = LedgerKey::Data(LedgerKeyData { account_id, @@ -201,10 +202,6 @@ async fn ledger_entry_account_data() { }); assert_eq!(data_entry.key, expected_data_key); assert!(matches!(data_entry.val, LedgerEntryData::Data { .. })); - - let account_entry = &parsed.entries[1]; - assert_eq!(account_entry.key, expected_account_key); - assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); } // contract data tests diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 65dbefbd0e..908579dc48 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -40,18 +40,24 @@ pub struct Cmd { /// Format of the output #[arg(long, default_value = "json")] pub output: OutputFormat, -} + //Options + + /// Assets to get trustline info for + #[arg(long)] + pub asset: Option>, + + /// Fetch key-value data entries attached to an account (see manageDataOp) + #[arg(long)] + pub data_name: Option>, + + /// ID of an offer made on the Stellar DEX + #[arg(long)] + pub offer: Option>, -// /// Assets to get trustline info for -// #[arg(long)] -// pub asset: Option>, // /// ID of an offer made on the Stellar DEX // #[arg(long)] // pub offer: Option>, -// /// Fetch key-value data entries attached to an account (see manageDataOp) -// #[arg(long)] -// pub data_name: Option>, // /// Claimable Balance id // #[arg(long)] @@ -92,6 +98,10 @@ pub struct Cmd { pub enum Error { #[error(transparent)] Config(#[from] config::key::Error), + #[error("provided asset is invalid: {0}")] + InvalidAsset(String), + #[error("provided data name is invalid: {0}")] + InvalidDataName(String), #[error(transparent)] Locator(#[from] locator::Error), #[error(transparent)] @@ -100,6 +110,8 @@ pub enum Error { Rpc(#[from] rpc::Error), #[error(transparent)] Serde(#[from] serde_json::Error), + #[error(transparent)] + TryFromSliceError(#[from] TryFromSliceError), } // #[error(transparent)] @@ -107,8 +119,6 @@ pub enum Error { // #[error(transparent)] // Spec(#[from] soroban_spec_tools::Error), // #[error(transparent)] -// TryFromSliceError(#[from] TryFromSliceError), -// #[error(transparent)] // FromHexError(#[from] FromHexError), // #[error("at least one key must be provided")] // EmptyKeys, @@ -116,10 +126,6 @@ pub enum Error { // ContractRequired, // #[error("account is required but was not provided")] // AccountRequired, -// #[error("provided asset is invalid: {0}")] -// InvalidAsset(String), -// #[error("provided data name is invalid: {0}")] -// InvalidDataName(String), // #[error("provided hash value is invalid: {0}")] // InvalidHash(String), // #[error("provided config id is invalid: {0}")] @@ -144,6 +150,9 @@ impl Cmd { let mut ledger_keys = vec![]; self.insert_account_keys(&mut ledger_keys)?; + self.insert_asset_keys(&mut ledger_keys)?; + self.insert_data_keys(&mut ledger_keys)?; + self.insert_offer_keys(&mut ledger_keys)?; match self.output { OutputFormat::Json => { @@ -177,11 +186,87 @@ impl Cmd { Ok(()) } + fn insert_asset_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(asset) = &self.asset { + let acc = self.muxed_account(&self.account)?; + for asset in asset { + let asset = if asset.eq_ignore_ascii_case("XLM") { + TrustLineAsset::Native + } else if asset.contains(':') { + let mut parts = asset.split(':'); + let code = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; + let issuer = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; + if parts.next().is_some() { + Err(Error::InvalidAsset(asset.clone()))?; + } + let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; + let issuer = + AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); + + match code.len() { + 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { + asset_code: AssetCode4(code.as_bytes().try_into()?), + issuer, + }), + 12 => TrustLineAsset::CreditAlphanum12(AlphaNum12 { + asset_code: AssetCode12(code.as_bytes().try_into()?), + issuer, + }), + _ => Err(Error::InvalidAsset(asset.clone()))?, + } + } else { + Err(Error::InvalidAsset(asset.clone()))? + }; + + let key = LedgerKey::Trustline(LedgerKeyTrustLine { + account_id: acc.clone().account_id(), + asset, + }); + + ledger_keys.push(key); + } + } + Ok(()) + } + + fn insert_data_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(data_name) = &self.data_name { + let acc = self.muxed_account(&self.account)?; + for data_name in data_name { + let data_name: xdr::StringM<64> = data_name + .parse() + .map_err(|_| Error::InvalidDataName(data_name.clone()))?; + let data_name = String64(data_name); + let key = LedgerKey::Data(LedgerKeyData { + account_id: acc.clone().account_id(), + data_name, + }); + ledger_keys.push(key); + } + } + + Ok(()) + } + + fn insert_offer_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(offer) = &self.offer { + let acc = self.muxed_account(&self.account)?; + for offer in offer { + let key = LedgerKey::Offer(LedgerKeyOffer { + seller_id: acc.clone().account_id(), + offer_id: *offer, + }); + ledger_keys.push(key); + } + } + + Ok(()) + } + fn muxed_account(&self, account: &str) -> Result { Ok(self .locator .read_key(account)? .muxed_account(self.hd_path)?) } - } \ No newline at end of file From de51902f98787968c497e8a432f5400181ad35df Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 12 May 2025 16:08:16 -0400 Subject: [PATCH 21/76] Add --hide-account flag --- .../tests/it/integration/ledger/entry.rs | 41 ++++++++++++++++++- .../commands/ledger/entry/fetch/account.rs | 10 +++-- 2 files changed, 47 insertions(+), 4 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 55eb9602aa..68817382b4 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -69,7 +69,6 @@ async fn ledger_entry_account_only_with_account_addr() { )); } - #[tokio::test] async fn ledger_entry_account_asset_xlm() { let sandbox = &TestEnv::new(); @@ -204,6 +203,46 @@ async fn ledger_entry_account_data() { assert!(matches!(data_entry.val, LedgerEntryData::Data { .. })); } +#[tokio::test] +async fn ledger_entries_hide_account() { + let sandbox = &TestEnv::new(); + let account_alias = "new_account"; + let new_account_addr = new_account(sandbox, account_alias); + let data_name = "test_data_key"; + add_account_data(sandbox, account_alias, data_name, "abcdef").await; + + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("account") + .arg(account_alias) + .arg("--network") + .arg("testnet") + .arg("--hide-account") + .arg("--data-name") + .arg(data_name) + .assert() + .success() + .stdout_as_str(); + + let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed.entries.is_empty()); + assert_eq!(parsed.entries.len(), 1); + + + let (account_id, _) = expected_account_ledger_key(&new_account_addr).await; + + let data_entry = &parsed.entries[0]; + let name_bounded_string = StringM::<64>::try_from(data_name).unwrap(); + let expected_data_key = LedgerKey::Data(LedgerKeyData { + account_id, + data_name: String64::from(name_bounded_string), + }); + assert_eq!(data_entry.key, expected_data_key); + assert!(matches!(data_entry.val, LedgerEntryData::Data { .. })); +} + // contract data tests #[ignore] #[tokio::test] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 908579dc48..23a5d1dae6 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -55,9 +55,10 @@ pub struct Cmd { #[arg(long)] pub offer: Option>, -// /// ID of an offer made on the Stellar DEX -// #[arg(long)] -// pub offer: Option>, + /// Hide the account ledger entry from the output + #[arg(long)] + pub hide_account: bool +} // /// Claimable Balance id // #[arg(long)] @@ -173,6 +174,9 @@ impl Cmd { } fn insert_account_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if self.hide_account { + return Ok(()) + } let acc = self.muxed_account(&self.account)?; // always add the account key into the list // should we allow this to be configurable? From 02a039323bb4ab3f2c618504a99fce4a3025a34f Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 12 May 2025 16:10:16 -0400 Subject: [PATCH 22/76] Cleanup ledger entry fetch account --- .../commands/ledger/entry/fetch/account.rs | 71 ++----------------- 1 file changed, 4 insertions(+), 67 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 23a5d1dae6..c1fdad2fee 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -2,23 +2,15 @@ use std::array::TryFromSliceError; use std::fmt::Debug; use crate::commands::config::network; -use crate::commands::contract::Durability; use crate::config::locator; -use crate::config::network::Network; -use crate::rpc::{self}; use crate::{config, xdr}; use clap::{command, Parser}; -use hex::{FromHex, FromHexError}; -use soroban_spec_tools::utils::padded_hex_from_str; -use stellar_strkey::Strkey; -use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey, Contract}; +use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey }; use stellar_xdr::curr::{ AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, - ClaimableBalanceId::ClaimableBalanceIdTypeV0, ConfigSettingId, ContractDataDurability, Hash, - LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, LedgerKeyConfigSetting, - LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, LedgerKeyLiquidityPool, - LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limits, MuxedAccount, PoolId, PublicKey, - ReadXdr, ScAddress, ScVal, String64, TrustLineAsset, Uint256, + LedgerKey, LedgerKeyAccount, LedgerKeyData, + LedgerKeyOffer, LedgerKeyTrustLine, MuxedAccount, PublicKey, + String64, TrustLineAsset, Uint256, }; #[derive(Parser, Debug, Clone)] @@ -60,41 +52,6 @@ pub struct Cmd { pub hide_account: bool } -// /// Claimable Balance id -// #[arg(long)] -// pub claimable_id: Option>, - -// /// Liquidity pool id -// #[arg(long)] -// pub pool_id: Option>, - -// /// Defines the currently active network configuration -// #[arg(long)] -// pub config_setting_id: Option>, - -// /// Get WASM bytecode by hash -// #[arg(long)] -// pub wasm_hash: Option>, - -// /// Get the time-to-live of an associated contract data or code entry -// #[arg(long)] -// pub ttl: Option>, - -// /// Contract id to fetch an info for -// #[arg(long = "contract-id", env = "STELLAR_CONTRACT_ID")] -// pub contract_id: Option, -// /// Storage entry durability -// #[arg(long, value_enum, default_value = "persistent")] -// pub durability: Durability, -// /// Storage key (symbols only) -// #[arg(long = "key")] -// pub key: Option>, -// /// Storage key (base64-encoded XDR) -// #[arg(long = "key-xdr")] -// pub key_xdr: Option>, - -// } - #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] @@ -115,24 +72,6 @@ pub enum Error { TryFromSliceError(#[from] TryFromSliceError), } -// #[error(transparent)] -// StellarXdr(#[from] stellar_xdr::curr::Error), -// #[error(transparent)] -// Spec(#[from] soroban_spec_tools::Error), -// #[error(transparent)] -// FromHexError(#[from] FromHexError), -// #[error("at least one key must be provided")] -// EmptyKeys, -// #[error("contract id is required but was not provided")] -// ContractRequired, -// #[error("account is required but was not provided")] -// AccountRequired, -// #[error("provided hash value is invalid: {0}")] -// InvalidHash(String), -// #[error("provided config id is invalid: {0}")] -// InvalidConfigId(i32), -// } - #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) @@ -178,8 +117,6 @@ impl Cmd { return Ok(()) } let acc = self.muxed_account(&self.account)?; - // always add the account key into the list - // should we allow this to be configurable? let key = LedgerKey::Account(LedgerKeyAccount { account_id: acc.account_id(), }); From 0dbf4233df495a8e5c1bddf71570966b71c61326 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 13 May 2025 11:10:17 -0400 Subject: [PATCH 23/76] Add ledger entry fetch contract subcommand --- .../tests/it/integration/ledger/entry.rs | 9 +- .../commands/ledger/entry/fetch/account.rs | 7 +- .../commands/ledger/entry/fetch/contract.rs | 135 ++++++++++++++++++ .../src/commands/ledger/entry/fetch/mod.rs | 13 +- 4 files changed, 149 insertions(+), 15 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 68817382b4..0a18514844 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -244,7 +244,6 @@ async fn ledger_entries_hide_account() { } // contract data tests -#[ignore] #[tokio::test] async fn ledger_entry_contract_data() { let sandbox = &TestEnv::new(); @@ -275,10 +274,10 @@ async fn ledger_entry_contract_data() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") + .arg("contract") + .arg(&contract_id) .arg("--network") .arg("testnet") - .arg("--contract-id") - .arg(&contract_id) .arg("--key") .arg(storage_key) .assert() @@ -293,10 +292,10 @@ async fn ledger_entry_contract_data() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") + .arg("contract") + .arg(&contract_id) .arg("--network") .arg("testnet") - .arg("--contract-id") - .arg(&contract_id) .arg("--key-xdr") .arg(storage_key_xdr) .assert() diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index c1fdad2fee..ecc0e31f02 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -4,8 +4,9 @@ use std::fmt::Debug; use crate::commands::config::network; use crate::config::locator; use crate::{config, xdr}; +use crate::rpc; use clap::{command, Parser}; -use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey }; +use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; use stellar_xdr::curr::{ AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, LedgerKeyAccount, LedgerKeyData, @@ -85,8 +86,6 @@ pub enum OutputFormat { impl Cmd { pub async fn run(&self) -> Result<(), Error> { - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; let mut ledger_keys = vec![]; self.insert_account_keys(&mut ledger_keys)?; @@ -94,6 +93,8 @@ impl Cmd { self.insert_data_keys(&mut ledger_keys)?; self.insert_offer_keys(&mut ledger_keys)?; + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; match self.output { OutputFormat::Json => { let resp = client.get_full_ledger_entries(&ledger_keys).await?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs new file mode 100644 index 0000000000..da423105f9 --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -0,0 +1,135 @@ +use crate::commands::config::network; +use crate::commands::contract::Durability; +use crate::config::locator; +use crate::config::network::Network; +use crate::rpc; +use crate::{config, xdr}; +use clap::{command, Parser}; +use stellar_xdr::curr::{ + ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, ScAddress, ScVal +}; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Contract to fetch an info for + pub contract: config::UnresolvedContract, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, + + //Options + /// Storage entry durability + #[arg(long, value_enum, default_value = "persistent")] + pub durability: Durability, + + /// Storage key (symbols only) + #[arg(long = "key")] + pub key: Option>, + + /// Storage key (base64-encoded XDR) + #[arg(long = "key-xdr")] + pub key_xdr: Option>, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), + #[error(transparent)] + Spec(#[from] soroban_spec_tools::Error), + #[error(transparent)] + StellarXdr(#[from] stellar_xdr::curr::Error), +} + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; + let mut ledger_keys = vec![]; + + self.insert_keys(&network, &mut ledger_keys)?; + + match self.output { + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + Ok(()) + } + + fn insert_keys( + &self, + network: &Network, + ledger_keys: &mut Vec, + ) -> Result<(), Error> { + let contract_id = + self.contract.resolve_contract_id(&self.locator, &network.network_passphrase)?; + let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); + + if let Some(keys) = &self.key { + for key in keys { + let key = LedgerKey::ContractData(LedgerKeyContractData { + contract: contract_address_arg.clone(), + key: soroban_spec_tools::from_string_primitive( + key, + &xdr::ScSpecTypeDef::Symbol, + )?, + durability: ContractDataDurability::Persistent, + }); + + ledger_keys.push(key); + } + } + + if let Some(keys) = &self.key_xdr { + for key in keys { + let key = LedgerKey::ContractData(LedgerKeyContractData { + contract: contract_address_arg.clone(), + key: ScVal::from_xdr_base64(key, Limits::none())?, + durability: ContractDataDurability::Persistent, + }); + + ledger_keys.push(key); + } + } + + Ok(()) + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 268a9e11a6..1ef54f568b 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -1,29 +1,28 @@ use std::fmt::Debug; - -use crate::rpc::{self}; -use clap::{command, Parser}; -use hex::{FromHex, FromHexError}; -use soroban_spec_tools::utils::padded_hex_from_str; -use stellar_strkey::Strkey; -use stellar_strkey::{ed25519::PublicKey as Ed25519PublicKey, Contract}; +use clap::Parser; pub mod account; +pub mod contract; #[derive(Debug, Parser)] pub enum Cmd { Account(account::Cmd), + Contract(contract::Cmd), } #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] Account(#[from] account::Error), + #[error(transparent)] + Contract(#[from] contract::Error), } impl Cmd { pub async fn run(&self) -> Result<(), Error> { match self { Cmd::Account(cmd) => cmd.run().await?, + Cmd::Contract(cmd) => cmd.run().await?, } Ok(()) } From 8a7c80abcca7ae46ed57f216a7a194ec6b8b67dc Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 13 May 2025 11:22:59 -0400 Subject: [PATCH 24/76] Cleanup --- .../commands/ledger/entry/fetch/account.rs | 26 +++++++++---------- .../commands/ledger/entry/fetch/contract.rs | 14 +++++----- 2 files changed, 20 insertions(+), 20 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index ecc0e31f02..97db102802 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -17,25 +17,16 @@ use stellar_xdr::curr::{ #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { + /// Account alias or public key to lookup, default is test identity + pub account: String, + #[command(flatten)] pub network: network::Args, #[command(flatten)] pub locator: locator::Args, - - /// Name of identity to lookup, default is test identity - pub account: String, - /// If identity is a seed phrase use this hd path, default is 0 - #[arg(long)] - pub hd_path: Option, - - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, - //Options - /// Assets to get trustline info for #[arg(long)] pub asset: Option>, @@ -50,7 +41,16 @@ pub struct Cmd { /// Hide the account ledger entry from the output #[arg(long)] - pub hide_account: bool + pub hide_account: bool, + + /// If identity is a seed phrase use this hd path, default is 0 + #[arg(long)] + pub hd_path: Option, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, + } #[derive(thiserror::Error, Debug)] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs index da423105f9..54aa64cd99 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -12,19 +12,15 @@ use stellar_xdr::curr::{ #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { + /// Contract alias or address to fetch + pub contract: config::UnresolvedContract, + #[command(flatten)] pub network: network::Args, #[command(flatten)] pub locator: locator::Args, - - /// Contract to fetch an info for - pub contract: config::UnresolvedContract, - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, - //Options /// Storage entry durability #[arg(long, value_enum, default_value = "persistent")] @@ -37,6 +33,10 @@ pub struct Cmd { /// Storage key (base64-encoded XDR) #[arg(long = "key-xdr")] pub key_xdr: Option>, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, } #[derive(thiserror::Error, Debug)] From 4429476e7b691373ab88bf113a570870c7440474 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 13 May 2025 15:54:07 -0400 Subject: [PATCH 25/76] Add ledger entry fetch config subcommand --- .../tests/it/integration/ledger/entry.rs | 75 ++++++---- .../src/commands/ledger/entry/fetch/config.rs | 129 ++++++++++++++++++ .../src/commands/ledger/entry/fetch/mod.rs | 5 + 3 files changed, 183 insertions(+), 26 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 0a18514844..e1cc7e9c78 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -393,37 +393,60 @@ async fn ledger_entry_wasm_hash() { // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } -#[ignore] #[tokio::test] async fn ledger_entry_config_setting_id() { let sandbox = &TestEnv::new(); let config_setting_ids = ConfigSettingId::VARIANTS; - for config_setting_variant in config_setting_ids { - let output = sandbox - .new_assert_cmd("ledger") - .arg("entry") - .arg("fetch") - .arg("--network") - .arg("testnet") - .arg("--config-setting-id") - .arg((config_setting_variant as i32).to_string()) - .assert() - .success() - .stdout_as_str(); - let parsed_output: FullLedgerEntries = - serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed_output.entries.is_empty()); - - let expected_key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { - config_setting_id: config_setting_variant, - }); - assert_eq!(parsed_output.entries[0].key, expected_key); - assert!(matches!( - parsed_output.entries[0].val, - LedgerEntryData::ConfigSetting { .. } - )); - } + // for individual ids + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("config") + .arg((ConfigSettingId::ContractMaxSizeBytes as i32).to_string()) + .arg((ConfigSettingId::ContractDataEntrySizeBytes as i32).to_string()) + .arg("--network") + .arg("testnet") + .assert() + .success() + .stdout_as_str(); + let parsed_output: FullLedgerEntries = + serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed_output.entries.is_empty()); + + let expected_key_1 = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { + config_setting_id: ConfigSettingId::ContractMaxSizeBytes, + }); + let expected_key_2 = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { + config_setting_id: ConfigSettingId::ContractDataEntrySizeBytes, + }); + assert_eq!(parsed_output.entries[0].key, expected_key_1); + assert_eq!(parsed_output.entries[1].key, expected_key_2); + assert!(matches!( + parsed_output.entries[0].val, + LedgerEntryData::ConfigSetting { .. } + )); + assert!(matches!( + parsed_output.entries[1].val, + LedgerEntryData::ConfigSetting { .. } + )); + + // for all ids + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("config") + .arg("--network") + .arg("testnet") + .assert() + .success() + .stdout_as_str(); + let parsed_output: FullLedgerEntries = + serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed_output.entries.is_empty()); + assert_eq!(parsed_output.entries.len(), ConfigSettingId::variants().len()); } #[ignore] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs new file mode 100644 index 0000000000..0b595c97ab --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs @@ -0,0 +1,129 @@ +use std::fmt::Debug; +use std::collections::HashMap; +use crate::rpc; +use crate::config::{ + self, locator, network +}; +use clap::{command, Parser}; +use stellar_xdr::curr::{ + ConfigSettingId, LedgerKey, LedgerKeyConfigSetting, +}; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Defines the network configuration to fetch + #[arg(long_help = long_help() )] + pub config_setting_ids: Option>, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, +} + +fn long_help() -> String { + let mut config_settings = ConfigSettingId::variants(); + config_settings.sort_by_key(|v| *v as i32); + + let config_setting_strings: Vec = config_settings + .iter() + .map(|v| format!("{} => {:?}", *v as i32, v)) + .collect(); + + let setting_options = config_setting_strings.join("\n"); + + format!( + "Valid config setting IDs (Config Setting ID => Name):\n{}", + setting_options + ) +} + +fn config_setting_variants_to_ids() -> HashMap{ + ConfigSettingId::variants().iter() + .map(|v| (*v, *v as i32)) + .collect() +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), + #[error("provided config id is invalid: {0}")] + InvalidConfigId(i32), +} + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; + let mut ledger_keys = vec![]; + + self.insert_keys(&mut ledger_keys)?; + + match self.output { + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + Ok(()) + } + + fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(config_setting_id) = &self.config_setting_ids { + for x in config_setting_id { + let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { + config_setting_id: ConfigSettingId::try_from(*x) + .map_err(|_| Error::InvalidConfigId(*x))?, + }); + ledger_keys.push(key); + } + } else { + for (_, d) in config_setting_variants_to_ids() { + let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { + config_setting_id: ConfigSettingId::try_from(d) + .map_err(|_| Error::InvalidConfigId(d))?, + }); + ledger_keys.push(key); + } + } + + Ok(()) + } + +} + diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 1ef54f568b..35bd1cd401 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -3,11 +3,13 @@ use clap::Parser; pub mod account; pub mod contract; +pub mod config; #[derive(Debug, Parser)] pub enum Cmd { Account(account::Cmd), Contract(contract::Cmd), + Config(config::Cmd), } #[derive(thiserror::Error, Debug)] @@ -16,6 +18,8 @@ pub enum Error { Account(#[from] account::Error), #[error(transparent)] Contract(#[from] contract::Error), + #[error(transparent)] + Config(#[from] config::Error), } impl Cmd { @@ -23,6 +27,7 @@ impl Cmd { match self { Cmd::Account(cmd) => cmd.run().await?, Cmd::Contract(cmd) => cmd.run().await?, + Cmd::Config(cmd) => cmd.run().await?, } Ok(()) } From 82b1f37c3166461f688f1890a99ee712f81e7836 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 09:35:44 -0400 Subject: [PATCH 26/76] Add claimable balance subcommand --- .../ledger/entry/fetch/claimable_balance.rs | 98 +++++++++++++++++++ .../src/commands/ledger/entry/fetch/mod.rs | 5 + 2 files changed, 103 insertions(+) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs new file mode 100644 index 0000000000..34876cf7e0 --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs @@ -0,0 +1,98 @@ +use crate::commands::config::network; +use crate::config::locator; +use crate::rpc; +use clap::{command, Parser}; +use hex::FromHexError; +use soroban_spec_tools::utils::padded_hex_from_str; +use stellar_xdr::curr::{ + ClaimableBalanceId::ClaimableBalanceIdTypeV0, Hash, + LedgerKey, LedgerKeyClaimableBalance, +}; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Claimable Balance Ids to fetch an entry for + pub ids: Vec, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, + +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + FromHexError(#[from] FromHexError), + #[error("provided hash value is invalid: {0}")] + InvalidHash(String), + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), +} + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; + let mut ledger_keys = vec![]; + + self.insert_keys(&mut ledger_keys)?; + + match self.output { + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + Ok(()) + } + + fn insert_keys( + &self, + ledger_keys: &mut Vec, + ) -> Result<(), Error> { + for x in &self.ids { + let padded_hex = padded_hex_from_str(&x, 32)?; + let hash_bytes: [u8; 32] = padded_hex + .try_into() + .map_err(|_| Error::InvalidHash(x.to_string()))?; + let hash = Hash(hash_bytes); + let key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { + balance_id: ClaimableBalanceIdTypeV0(hash), + }); + ledger_keys.push(key); + } + Ok(()) + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 35bd1cd401..1c9cd12028 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -4,12 +4,14 @@ use clap::Parser; pub mod account; pub mod contract; pub mod config; +pub mod claimable_balance; #[derive(Debug, Parser)] pub enum Cmd { Account(account::Cmd), Contract(contract::Cmd), Config(config::Cmd), + ClaimableBalance(claimable_balance::Cmd), } #[derive(thiserror::Error, Debug)] @@ -20,6 +22,8 @@ pub enum Error { Contract(#[from] contract::Error), #[error(transparent)] Config(#[from] config::Error), + #[error(transparent)] + ClaimableBalance(#[from] claimable_balance::Error), } impl Cmd { @@ -28,6 +32,7 @@ impl Cmd { Cmd::Account(cmd) => cmd.run().await?, Cmd::Contract(cmd) => cmd.run().await?, Cmd::Config(cmd) => cmd.run().await?, + Cmd::ClaimableBalance(cmd) => cmd.run().await?, } Ok(()) } From 8d55919471aa231463b21e813e8b8838a8d30fc6 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 09:49:56 -0400 Subject: [PATCH 27/76] Add liquidity_pool subcommand --- .../ledger/entry/fetch/liquidity_pool.rs | 97 +++++++++++++++++++ .../src/commands/ledger/entry/fetch/mod.rs | 5 + 2 files changed, 102 insertions(+) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs new file mode 100644 index 0000000000..bb5fbde0eb --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs @@ -0,0 +1,97 @@ +use std::fmt::Debug; +use crate::commands::config::network; +use crate::config::locator; +use crate::rpc; +use clap::{command, Parser}; +use hex::FromHexError; +use soroban_spec_tools::utils::padded_hex_from_str; +use stellar_xdr::curr::{ Hash, LedgerKey, LedgerKeyLiquidityPool, PoolId, }; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Liquidity pool ids + pub ids: Vec, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, +} + + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), + #[error(transparent)] + FromHexError(#[from] FromHexError), + #[error("provided hash value is invalid: {0}")] + InvalidHash(String), +} + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; + let mut ledger_keys = vec![]; + + self.insert_keys(&mut ledger_keys)?; + + match self.output { + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + Ok(()) + } + + fn insert_keys( + &self, + ledger_keys: &mut Vec, + ) -> Result<(), Error> { + for x in &self.ids { + let padded_hex = padded_hex_from_str(&x, 32)?; + let hash_bytes: [u8; 32] = padded_hex + .try_into() + .map_err(|_| Error::InvalidHash(x.to_string()))?; + let hash = Hash(hash_bytes); + let key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { + liquidity_pool_id: PoolId(hash), + }); + ledger_keys.push(key); + } + + Ok(()) + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 1c9cd12028..4916c19812 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -5,6 +5,7 @@ pub mod account; pub mod contract; pub mod config; pub mod claimable_balance; +pub mod liquidity_pool; #[derive(Debug, Parser)] pub enum Cmd { @@ -12,6 +13,7 @@ pub enum Cmd { Contract(contract::Cmd), Config(config::Cmd), ClaimableBalance(claimable_balance::Cmd), + LiquidityPool(liquidity_pool::Cmd), } #[derive(thiserror::Error, Debug)] @@ -24,6 +26,8 @@ pub enum Error { Config(#[from] config::Error), #[error(transparent)] ClaimableBalance(#[from] claimable_balance::Error), + #[error(transparent)] + LiquidityPool(#[from] liquidity_pool::Error), } impl Cmd { @@ -33,6 +37,7 @@ impl Cmd { Cmd::Contract(cmd) => cmd.run().await?, Cmd::Config(cmd) => cmd.run().await?, Cmd::ClaimableBalance(cmd) => cmd.run().await?, + Cmd::LiquidityPool(cmd) => cmd.run().await?, } Ok(()) } From 5cfb146b32cff6255d95d0eba8e1d5e6dca86df3 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 09:56:05 -0400 Subject: [PATCH 28/76] Add wasm subcommand --- .../tests/it/integration/ledger/entry.rs | 5 +- .../src/commands/ledger/entry/fetch/mod.rs | 5 + .../src/commands/ledger/entry/fetch/wasm.rs | 98 +++++++++++++++++++ 3 files changed, 105 insertions(+), 3 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index e1cc7e9c78..1c8b6b0b2c 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -329,7 +329,6 @@ async fn ledger_entry_contract_data() { // top level test // todo: test --ttl, --claimable-id, --pool-id, -#[ignore] #[tokio::test] async fn ledger_entry_wasm_hash() { let sandbox = &TestEnv::new(); @@ -360,10 +359,10 @@ async fn ledger_entry_wasm_hash() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") + .arg("wasm") + .arg(&contract_wasm_hash) .arg("--network") .arg("testnet") - .arg("--wasm-hash") - .arg(&contract_wasm_hash) .assert() .success() .stdout_as_str(); diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 4916c19812..1022545f48 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -6,6 +6,7 @@ pub mod contract; pub mod config; pub mod claimable_balance; pub mod liquidity_pool; +pub mod wasm; #[derive(Debug, Parser)] pub enum Cmd { @@ -14,6 +15,7 @@ pub enum Cmd { Config(config::Cmd), ClaimableBalance(claimable_balance::Cmd), LiquidityPool(liquidity_pool::Cmd), + Wasm(wasm::Cmd), } #[derive(thiserror::Error, Debug)] @@ -28,6 +30,8 @@ pub enum Error { ClaimableBalance(#[from] claimable_balance::Error), #[error(transparent)] LiquidityPool(#[from] liquidity_pool::Error), + #[error(transparent)] + Wasm(#[from] wasm::Error), } impl Cmd { @@ -38,6 +42,7 @@ impl Cmd { Cmd::Config(cmd) => cmd.run().await?, Cmd::ClaimableBalance(cmd) => cmd.run().await?, Cmd::LiquidityPool(cmd) => cmd.run().await?, + Cmd::Wasm(cmd) => cmd.run().await?, } Ok(()) } diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs new file mode 100644 index 0000000000..0767e881e0 --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs @@ -0,0 +1,98 @@ +use crate::commands::config::network; +use crate::config::locator; +use crate::rpc; +use crate::config; +use clap::{command, Parser}; +use stellar_xdr::curr::{ Hash, LedgerKey, LedgerKeyContractCode, +}; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Get WASM bytecode by hash + pub wasm_hashes: Vec, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), + #[error(transparent)] + Spec(#[from] soroban_spec_tools::Error), + #[error(transparent)] + StellarXdr(#[from] stellar_xdr::curr::Error), + #[error("provided hash value is invalid: {0}")] + InvalidHash(String), +} + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; + let mut ledger_keys = vec![]; + + self.insert_keys(&mut ledger_keys)?; + + match self.output { + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + Ok(()) + } + + fn insert_keys( + &self, + ledger_keys: &mut Vec, + ) -> Result<(), Error> { + for wasm_hash in &self.wasm_hashes { + let hash = Hash( + soroban_spec_tools::utils::contract_id_from_str(&wasm_hash) + .map_err(|_| Error::InvalidHash(wasm_hash.clone()))?, + ); + let key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); + ledger_keys.push(key); + } + + Ok(()) + } +} From e63d29adc3eba9a0c765ed2adf952a6beead8242 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 10:12:25 -0400 Subject: [PATCH 29/76] Update fetch doc strings --- cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 1022545f48..caeef7838c 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -10,11 +10,19 @@ pub mod wasm; #[derive(Debug, Parser)] pub enum Cmd { + /// Fetch account entry by public key or alias. + /// Additional account-related keys are available with optional flags. Account(account::Cmd), + /// Fetch contract ledger entry by address or alias and storage key. Contract(contract::Cmd), + /// Fetch the current network config by ConfigSettingId. + /// All config settings are returned if no id is provided. Config(config::Cmd), + ///Fetch a claimable balance ledger entry by id ClaimableBalance(claimable_balance::Cmd), + ///Fetch a liquidity pool ledger entry by id LiquidityPool(liquidity_pool::Cmd), + /// Fetch WASM bytecode by hash Wasm(wasm::Cmd), } From 3c2b87189b0aeef5a9a04bf55362a5ed7d765abc Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 12:33:42 -0400 Subject: [PATCH 30/76] Update generated docs --- FULL_HELP_DOCS.md | 214 +++++++++++++++++++++++++++++++++++++++++++--- 1 file changed, 204 insertions(+), 10 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 02acb7f2c1..58d5852fc4 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -2722,7 +2722,28 @@ Work with ledger entries Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys -**Usage:** `stellar ledger entry fetch [OPTIONS]` +**Usage:** `stellar ledger entry fetch ` + +###### **Subcommands:** + +* `account` — Fetch account entry by public key or alias. Additional account-related keys are available with optional flags +* `contract` — Fetch contract ledger entry by address or alias and storage key +* `config` — Fetch the current network config by ConfigSettingId. All config settings are returned if no id is provided +* `claimable-balance` — Fetch a claimable balance ledger entry by id +* `liquidity-pool` — Fetch a liquidity pool ledger entry by id +* `wasm` — Fetch WASM bytecode by hash + + + +## `stellar ledger entry fetch account` + +Fetch account entry by public key or alias. Additional account-related keys are available with optional flags + +**Usage:** `stellar ledger entry fetch account [OPTIONS] ` + +###### **Arguments:** + +* `` — Account alias or public key to lookup, default is test identity ###### **Options:** @@ -2732,17 +2753,44 @@ Fetch ledger entries. This command supports all types of ledger entries supporte * `-n`, `--network ` — Name of network to use from config * `--global` — Use global config * `--config-dir ` — Location of config directory, default is "." -* `--account ` — Name of identity to lookup, default is test identity -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--asset ` — Assets to get trustline info for -* `--offer ` — ID of an offer made on the Stellar DEX * `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) -* `--claimable-id ` — Claimable Balance id -* `--pool-id ` — Liquidity pool id -* `--config-setting-id ` — Defines the currently active network configuration -* `--wasm-hash ` — Get WASM bytecode by hash -* `--ttl ` — Get the time-to-live of an associated contract data or code entry -* `--contract-id ` — Contract id to fetch an info for +* `--offer ` — ID of an offer made on the Stellar DEX +* `--hide-account` — Hide the account ledger entry from the output +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + + +## `stellar ledger entry fetch contract` + +Fetch contract ledger entry by address or alias and storage key + +**Usage:** `stellar ledger entry fetch contract [OPTIONS] ` + +###### **Arguments:** + +* `` — Contract alias or address to fetch + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." * `--durability ` — Storage entry durability Default value: `persistent` @@ -2770,3 +2818,149 @@ Fetch ledger entries. This command supports all types of ledger entries supporte +## `stellar ledger entry fetch config` + +Fetch the current network config by ConfigSettingId. All config settings are returned if no id is provided + +**Usage:** `stellar ledger entry fetch config [OPTIONS] [CONFIG_SETTING_IDS]...` + +###### **Arguments:** + +* `` — Valid config setting IDs (Config Setting ID => Name): + 0 => ContractMaxSizeBytes + 1 => ContractComputeV0 + 2 => ContractLedgerCostV0 + 3 => ContractHistoricalDataV0 + 4 => ContractEventsV0 + 5 => ContractBandwidthV0 + 6 => ContractCostParamsCpuInstructions + 7 => ContractCostParamsMemoryBytes + 8 => ContractDataKeySizeBytes + 9 => ContractDataEntrySizeBytes + 10 => StateArchival + 11 => ContractExecutionLanes + 12 => BucketlistSizeWindow + 13 => EvictionIterator + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + + +## `stellar ledger entry fetch claimable-balance` + +Fetch a claimable balance ledger entry by id + +**Usage:** `stellar ledger entry fetch claimable-balance [OPTIONS] [IDS]...` + +###### **Arguments:** + +* `` — Claimable Balance Ids to fetch an entry for + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + + +## `stellar ledger entry fetch liquidity-pool` + +Fetch a liquidity pool ledger entry by id + +**Usage:** `stellar ledger entry fetch liquidity-pool [OPTIONS] [IDS]...` + +###### **Arguments:** + +* `` — Liquidity pool ids + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + + +## `stellar ledger entry fetch wasm` + +Fetch WASM bytecode by hash + +**Usage:** `stellar ledger entry fetch wasm [OPTIONS] [WASM_HASHES]...` + +###### **Arguments:** + +* `` — Get WASM bytecode by hash + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — Use global config +* `--config-dir ` — Location of config directory, default is "." +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + + From ad18d250deac7b5cbc31fc393c83f03047279308 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 13:52:13 -0400 Subject: [PATCH 31/76] Clippy & fmt --- .../tests/it/integration/ledger/entry.rs | 6 ++- .../commands/ledger/entry/fetch/account.rs | 24 +++++------- .../ledger/entry/fetch/claimable_balance.rs | 15 +++----- .../src/commands/ledger/entry/fetch/config.rs | 38 ++++++++----------- .../commands/ledger/entry/fetch/contract.rs | 14 ++++--- .../ledger/entry/fetch/liquidity_pool.rs | 16 +++----- .../src/commands/ledger/entry/fetch/mod.rs | 6 +-- .../src/commands/ledger/entry/fetch/wasm.rs | 16 +++----- 8 files changed, 58 insertions(+), 77 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 1c8b6b0b2c..1b7cfb89bc 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -229,7 +229,6 @@ async fn ledger_entries_hide_account() { let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed.entries.is_empty()); assert_eq!(parsed.entries.len(), 1); - let (account_id, _) = expected_account_ledger_key(&new_account_addr).await; @@ -445,7 +444,10 @@ async fn ledger_entry_config_setting_id() { let parsed_output: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed_output.entries.is_empty()); - assert_eq!(parsed_output.entries.len(), ConfigSettingId::variants().len()); + assert_eq!( + parsed_output.entries.len(), + ConfigSettingId::variants().len() + ); } #[ignore] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 97db102802..aa561c74b9 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -3,15 +3,14 @@ use std::fmt::Debug; use crate::commands::config::network; use crate::config::locator; -use crate::{config, xdr}; use crate::rpc; +use crate::{config, xdr}; use clap::{command, Parser}; use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; use stellar_xdr::curr::{ - AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, - LedgerKey, LedgerKeyAccount, LedgerKeyData, - LedgerKeyOffer, LedgerKeyTrustLine, MuxedAccount, PublicKey, - String64, TrustLineAsset, Uint256, + AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, LedgerKeyAccount, + LedgerKeyData, LedgerKeyOffer, LedgerKeyTrustLine, MuxedAccount, PublicKey, String64, + TrustLineAsset, Uint256, }; #[derive(Parser, Debug, Clone)] @@ -25,7 +24,7 @@ pub struct Cmd { #[command(flatten)] pub locator: locator::Args, - + //Options /// Assets to get trustline info for #[arg(long)] @@ -46,11 +45,10 @@ pub struct Cmd { /// If identity is a seed phrase use this hd path, default is 0 #[arg(long)] pub hd_path: Option, - + /// Format of the output #[arg(long, default_value = "json")] pub output: OutputFormat, - } #[derive(thiserror::Error, Debug)] @@ -71,7 +69,7 @@ pub enum Error { Serde(#[from] serde_json::Error), #[error(transparent)] TryFromSliceError(#[from] TryFromSliceError), -} +} #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { @@ -115,7 +113,7 @@ impl Cmd { fn insert_account_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { if self.hide_account { - return Ok(()) + return Ok(()); } let acc = self.muxed_account(&self.account)?; let key = LedgerKey::Account(LedgerKeyAccount { @@ -124,7 +122,6 @@ impl Cmd { ledger_keys.push(key); - Ok(()) } @@ -142,8 +139,7 @@ impl Cmd { Err(Error::InvalidAsset(asset.clone()))?; } let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; - let issuer = - AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); + let issuer = AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); match code.len() { 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { @@ -211,4 +207,4 @@ impl Cmd { .read_key(account)? .muxed_account(self.hd_path)?) } -} \ No newline at end of file +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs index 34876cf7e0..13cc463abb 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs @@ -5,8 +5,7 @@ use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; use stellar_xdr::curr::{ - ClaimableBalanceId::ClaimableBalanceIdTypeV0, Hash, - LedgerKey, LedgerKeyClaimableBalance, + ClaimableBalanceId::ClaimableBalanceIdTypeV0, Hash, LedgerKey, LedgerKeyClaimableBalance, }; #[derive(Parser, Debug, Clone)] @@ -20,11 +19,10 @@ pub struct Cmd { /// Claimable Balance Ids to fetch an entry for pub ids: Vec, - + /// Format of the output #[arg(long, default_value = "json")] pub output: OutputFormat, - } #[derive(thiserror::Error, Debug)] @@ -39,7 +37,7 @@ pub enum Error { Rpc(#[from] rpc::Error), #[error(transparent)] Serde(#[from] serde_json::Error), -} +} #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { @@ -78,12 +76,9 @@ impl Cmd { Ok(()) } - fn insert_keys( - &self, - ledger_keys: &mut Vec, - ) -> Result<(), Error> { + fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { for x in &self.ids { - let padded_hex = padded_hex_from_str(&x, 32)?; + let padded_hex = padded_hex_from_str(x, 32)?; let hash_bytes: [u8; 32] = padded_hex .try_into() .map_err(|_| Error::InvalidHash(x.to_string()))?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs index 0b595c97ab..a3b7d17d28 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs @@ -1,13 +1,9 @@ -use std::fmt::Debug; -use std::collections::HashMap; +use crate::config::{self, locator, network}; use crate::rpc; -use crate::config::{ - self, locator, network -}; use clap::{command, Parser}; -use stellar_xdr::curr::{ - ConfigSettingId, LedgerKey, LedgerKeyConfigSetting, -}; +use std::collections::HashMap; +use std::fmt::Debug; +use stellar_xdr::curr::{ConfigSettingId, LedgerKey, LedgerKeyConfigSetting}; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -32,22 +28,22 @@ fn long_help() -> String { config_settings.sort_by_key(|v| *v as i32); let config_setting_strings: Vec = config_settings - .iter() - .map(|v| format!("{} => {:?}", *v as i32, v)) - .collect(); + .iter() + .map(|v| format!("{} => {:?}", *v as i32, v)) + .collect(); let setting_options = config_setting_strings.join("\n"); - + format!( - "Valid config setting IDs (Config Setting ID => Name):\n{}", - setting_options + "Valid config setting IDs (Config Setting ID => Name):\n{setting_options}", ) } -fn config_setting_variants_to_ids() -> HashMap{ - ConfigSettingId::variants().iter() - .map(|v| (*v, *v as i32)) - .collect() +fn config_setting_variants_to_ids() -> HashMap { + ConfigSettingId::variants() + .iter() + .map(|v| (*v, *v as i32)) + .collect() } #[derive(thiserror::Error, Debug)] @@ -64,7 +60,7 @@ pub enum Error { Serde(#[from] serde_json::Error), #[error("provided config id is invalid: {0}")] InvalidConfigId(i32), -} +} #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { @@ -121,9 +117,7 @@ impl Cmd { ledger_keys.push(key); } } - + Ok(()) } - } - diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs index 54aa64cd99..929fc1b1fa 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -6,7 +6,8 @@ use crate::rpc; use crate::{config, xdr}; use clap::{command, Parser}; use stellar_xdr::curr::{ - ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, ScAddress, ScVal + ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, ScAddress, + ScVal, }; #[derive(Parser, Debug, Clone)] @@ -20,7 +21,7 @@ pub struct Cmd { #[command(flatten)] pub locator: locator::Args, - + //Options /// Storage entry durability #[arg(long, value_enum, default_value = "persistent")] @@ -29,7 +30,7 @@ pub struct Cmd { /// Storage key (symbols only) #[arg(long = "key")] pub key: Option>, - + /// Storage key (base64-encoded XDR) #[arg(long = "key-xdr")] pub key_xdr: Option>, @@ -55,7 +56,7 @@ pub enum Error { Spec(#[from] soroban_spec_tools::Error), #[error(transparent)] StellarXdr(#[from] stellar_xdr::curr::Error), -} +} #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { @@ -99,8 +100,9 @@ impl Cmd { network: &Network, ledger_keys: &mut Vec, ) -> Result<(), Error> { - let contract_id = - self.contract.resolve_contract_id(&self.locator, &network.network_passphrase)?; + let contract_id = self + .contract + .resolve_contract_id(&self.locator, &network.network_passphrase)?; let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); if let Some(keys) = &self.key { diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs index bb5fbde0eb..c3559452bd 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs @@ -1,11 +1,11 @@ -use std::fmt::Debug; use crate::commands::config::network; use crate::config::locator; use crate::rpc; use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; -use stellar_xdr::curr::{ Hash, LedgerKey, LedgerKeyLiquidityPool, PoolId, }; +use std::fmt::Debug; +use stellar_xdr::curr::{Hash, LedgerKey, LedgerKeyLiquidityPool, PoolId}; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -18,13 +18,12 @@ pub struct Cmd { /// Liquidity pool ids pub ids: Vec, - + /// Format of the output #[arg(long, default_value = "json")] pub output: OutputFormat, } - #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] @@ -37,7 +36,7 @@ pub enum Error { FromHexError(#[from] FromHexError), #[error("provided hash value is invalid: {0}")] InvalidHash(String), -} +} #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { @@ -76,12 +75,9 @@ impl Cmd { Ok(()) } - fn insert_keys( - &self, - ledger_keys: &mut Vec, - ) -> Result<(), Error> { + fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { for x in &self.ids { - let padded_hex = padded_hex_from_str(&x, 32)?; + let padded_hex = padded_hex_from_str(x, 32)?; let hash_bytes: [u8; 32] = padded_hex .try_into() .map_err(|_| Error::InvalidHash(x.to_string()))?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index caeef7838c..01d8d8399f 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -1,10 +1,10 @@ -use std::fmt::Debug; use clap::Parser; +use std::fmt::Debug; pub mod account; -pub mod contract; -pub mod config; pub mod claimable_balance; +pub mod config; +pub mod contract; pub mod liquidity_pool; pub mod wasm; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs index 0767e881e0..91f57c7d7a 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs @@ -1,10 +1,9 @@ use crate::commands::config::network; +use crate::config; use crate::config::locator; use crate::rpc; -use crate::config; use clap::{command, Parser}; -use stellar_xdr::curr::{ Hash, LedgerKey, LedgerKeyContractCode, -}; +use stellar_xdr::curr::{Hash, LedgerKey, LedgerKeyContractCode}; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -17,7 +16,7 @@ pub struct Cmd { /// Get WASM bytecode by hash pub wasm_hashes: Vec, - + /// Format of the output #[arg(long, default_value = "json")] pub output: OutputFormat, @@ -41,7 +40,7 @@ pub enum Error { StellarXdr(#[from] stellar_xdr::curr::Error), #[error("provided hash value is invalid: {0}")] InvalidHash(String), -} +} #[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] pub enum OutputFormat { @@ -80,13 +79,10 @@ impl Cmd { Ok(()) } - fn insert_keys( - &self, - ledger_keys: &mut Vec, - ) -> Result<(), Error> { + fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { for wasm_hash in &self.wasm_hashes { let hash = Hash( - soroban_spec_tools::utils::contract_id_from_str(&wasm_hash) + soroban_spec_tools::utils::contract_id_from_str(wasm_hash) .map_err(|_| Error::InvalidHash(wasm_hash.clone()))?, ); let key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); From e27bb3b265f9c28f99d485f5f1b37d7bcf0a98dc Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 14:10:10 -0400 Subject: [PATCH 32/76] Reorganize imports --- .../tests/it/integration/ledger/entry.rs | 2 -- .../commands/ledger/entry/fetch/account.rs | 18 +++++++-------- .../ledger/entry/fetch/claimable_balance.rs | 13 ++++++----- .../src/commands/ledger/entry/fetch/config.rs | 12 +++++----- .../commands/ledger/entry/fetch/contract.rs | 23 +++++++++++-------- .../ledger/entry/fetch/liquidity_pool.rs | 9 ++++---- .../src/commands/ledger/entry/fetch/wasm.rs | 11 +++++---- 7 files changed, 46 insertions(+), 42 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 1b7cfb89bc..862a12c051 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -394,8 +394,6 @@ async fn ledger_entry_wasm_hash() { #[tokio::test] async fn ledger_entry_config_setting_id() { let sandbox = &TestEnv::new(); - let config_setting_ids = ConfigSettingId::VARIANTS; - // for individual ids let output = sandbox .new_assert_cmd("ledger") diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index aa561c74b9..7646134914 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -1,17 +1,17 @@ use std::array::TryFromSliceError; use std::fmt::Debug; -use crate::commands::config::network; -use crate::config::locator; -use crate::rpc; -use crate::{config, xdr}; +use crate::{ + commands::config::{self, locator, network}, + rpc, + xdr::{ + self, AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, + LedgerKeyAccount, LedgerKeyData, LedgerKeyOffer, LedgerKeyTrustLine, MuxedAccount, + PublicKey, String64, TrustLineAsset, Uint256, + }, +}; use clap::{command, Parser}; use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; -use stellar_xdr::curr::{ - AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, LedgerKeyAccount, - LedgerKeyData, LedgerKeyOffer, LedgerKeyTrustLine, MuxedAccount, PublicKey, String64, - TrustLineAsset, Uint256, -}; #[derive(Parser, Debug, Clone)] #[group(skip)] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs index 13cc463abb..c6659b5a4a 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs @@ -1,12 +1,13 @@ -use crate::commands::config::network; -use crate::config::locator; -use crate::rpc; +use crate::{ + commands::config::{locator, network}, + rpc, + xdr::{ + ClaimableBalanceId::ClaimableBalanceIdTypeV0, Hash, LedgerKey, LedgerKeyClaimableBalance, + }, +}; use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; -use stellar_xdr::curr::{ - ClaimableBalanceId::ClaimableBalanceIdTypeV0, Hash, LedgerKey, LedgerKeyClaimableBalance, -}; #[derive(Parser, Debug, Clone)] #[group(skip)] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs index a3b7d17d28..d6558513ac 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs @@ -1,9 +1,11 @@ -use crate::config::{self, locator, network}; -use crate::rpc; +use crate::{ + config::{self, locator, network}, + rpc, + xdr::{ConfigSettingId, LedgerKey, LedgerKeyConfigSetting}, +}; use clap::{command, Parser}; use std::collections::HashMap; use std::fmt::Debug; -use stellar_xdr::curr::{ConfigSettingId, LedgerKey, LedgerKeyConfigSetting}; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -34,9 +36,7 @@ fn long_help() -> String { let setting_options = config_setting_strings.join("\n"); - format!( - "Valid config setting IDs (Config Setting ID => Name):\n{setting_options}", - ) + format!("Valid config setting IDs (Config Setting ID => Name):\n{setting_options}",) } fn config_setting_variants_to_ids() -> HashMap { diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs index 929fc1b1fa..4ef369fe4c 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -1,14 +1,17 @@ -use crate::commands::config::network; -use crate::commands::contract::Durability; -use crate::config::locator; -use crate::config::network::Network; -use crate::rpc; -use crate::{config, xdr}; -use clap::{command, Parser}; -use stellar_xdr::curr::{ - ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, ScAddress, - ScVal, +use crate::{ + commands::contract::Durability, + config, + config::{ + locator, + network::{self, Network}, + }, + rpc, + xdr::{ + self, ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, + ScAddress, ScVal, + }, }; +use clap::{command, Parser}; #[derive(Parser, Debug, Clone)] #[group(skip)] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs index c3559452bd..39061fcdec 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs @@ -1,11 +1,12 @@ -use crate::commands::config::network; -use crate::config::locator; -use crate::rpc; +use crate::{ + config::{locator, network}, + rpc, + xdr::{Hash, LedgerKey, LedgerKeyLiquidityPool, PoolId}, +}; use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; use std::fmt::Debug; -use stellar_xdr::curr::{Hash, LedgerKey, LedgerKeyLiquidityPool, PoolId}; #[derive(Parser, Debug, Clone)] #[group(skip)] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs index 91f57c7d7a..85de8a63af 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs @@ -1,9 +1,10 @@ -use crate::commands::config::network; -use crate::config; -use crate::config::locator; -use crate::rpc; +use crate::{ + config::{self, locator, network}, + rpc, + xdr::{Hash, LedgerKey, LedgerKeyContractCode}, +}; + use clap::{command, Parser}; -use stellar_xdr::curr::{Hash, LedgerKey, LedgerKeyContractCode}; #[derive(Parser, Debug, Clone)] #[group(skip)] From 9dce72346b96b83001d4db08c9224dd44a4fef2a Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 14:22:16 -0400 Subject: [PATCH 33/76] Cleanup --- .../tests/it/integration/ledger/entry.rs | 41 +------------------ 1 file changed, 1 insertion(+), 40 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 862a12c051..0cd24cde5a 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -327,7 +327,7 @@ async fn ledger_entry_contract_data() { } // top level test -// todo: test --ttl, --claimable-id, --pool-id, +// todo: test --claimable-id, --pool-id, #[tokio::test] async fn ledger_entry_wasm_hash() { let sandbox = &TestEnv::new(); @@ -382,13 +382,6 @@ async fn ledger_entry_wasm_hash() { parsed_output.entries[0].val, LedgerEntryData::ContractCode { .. } )); - // key: ContractCode(LedgerKeyContractCode { hash: Hash(74a0a58bee2730d38dfaa547c0f3e64b1b76cf7d7e430373a9bf7aad122aff9f) } - - // assert_eq!(parsed_key_xdr_output.entries[0].key, expected_contract_data_key); - // assert!(matches!(parsed_key_xdr_output.entries[0].val, LedgerEntryData::ContractData{ .. })); - - // // the output should be the same regardless of key format - // assert_eq!(parsed_key_output.entries, parsed_key_xdr_output.entries); } #[tokio::test] @@ -448,38 +441,6 @@ async fn ledger_entry_config_setting_id() { ); } -#[ignore] -#[tokio::test] -async fn ledger_entry_ttl() { - let sandbox = &TestEnv::new(); - let test_account_alias = "test"; - let contract_id = deploy_contract( - sandbox, - HELLO_WORLD, - DeployOptions { - deployer: Some(test_account_alias.to_string()), - ..Default::default() - }, - ) - .await; - - // get the contract's TTL - let output = sandbox - .new_assert_cmd("ledger") - .arg("entry") - .arg("fetch") - .arg("--network") - .arg("testnet") - .arg("--ttl") - .arg(contract_id) - .assert() - .success() - .stdout_as_str(); - let parsed_output: FullLedgerEntries = - serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed_output.entries.is_empty()); -} - // Helper Fns fn new_account(sandbox: &TestEnv, name: &str) -> String { sandbox.generate_account(name, None).assert().success(); From 1c01b6691012e05e89b4bcacd5d1f1c9e5885e39 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 14:33:22 -0400 Subject: [PATCH 34/76] Factor out duplicate code for all entry fetch cmds --- .../src/commands/ledger/entry/fetch/account.rs | 14 ++------------ .../ledger/entry/fetch/claimable_balance.rs | 12 +----------- .../src/commands/ledger/entry/fetch/config.rs | 12 +----------- .../src/commands/ledger/entry/fetch/contract.rs | 12 +----------- .../commands/ledger/entry/fetch/liquidity_pool.rs | 12 +----------- .../src/commands/ledger/entry/fetch/mod.rs | 11 +++++++++++ .../src/commands/ledger/entry/fetch/wasm.rs | 12 +----------- cmd/soroban-cli/src/commands/ledger/entry/mod.rs | 2 +- 8 files changed, 19 insertions(+), 68 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 7646134914..1114335c22 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -2,7 +2,7 @@ use std::array::TryFromSliceError; use std::fmt::Debug; use crate::{ - commands::config::{self, locator, network}, + commands::{config::{self, locator, network}}, rpc, xdr::{ self, AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, @@ -12,6 +12,7 @@ use crate::{ }; use clap::{command, Parser}; use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; +use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -71,17 +72,6 @@ pub enum Error { TryFromSliceError(#[from] TryFromSliceError), } -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} - impl Cmd { pub async fn run(&self) -> Result<(), Error> { let mut ledger_keys = vec![]; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs index c6659b5a4a..1ee67aabbb 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs @@ -8,6 +8,7 @@ use crate::{ use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; +use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -40,17 +41,6 @@ pub enum Error { Serde(#[from] serde_json::Error), } -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} - impl Cmd { pub async fn run(&self) -> Result<(), Error> { let network = self.network.get(&self.locator)?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs index d6558513ac..aa0b5034e2 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs @@ -6,6 +6,7 @@ use crate::{ use clap::{command, Parser}; use std::collections::HashMap; use std::fmt::Debug; +use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -62,17 +63,6 @@ pub enum Error { InvalidConfigId(i32), } -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} - impl Cmd { pub async fn run(&self) -> Result<(), Error> { let network = self.network.get(&self.locator)?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs index 4ef369fe4c..97d8d0393b 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -12,6 +12,7 @@ use crate::{ }, }; use clap::{command, Parser}; +use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -61,17 +62,6 @@ pub enum Error { StellarXdr(#[from] stellar_xdr::curr::Error), } -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} - impl Cmd { pub async fn run(&self) -> Result<(), Error> { let network = self.network.get(&self.locator)?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs index 39061fcdec..9056f6ee93 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs @@ -7,6 +7,7 @@ use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; use std::fmt::Debug; +use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -39,17 +40,6 @@ pub enum Error { InvalidHash(String), } -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} - impl Cmd { pub async fn run(&self) -> Result<(), Error> { let network = self.network.get(&self.locator)?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 01d8d8399f..5b4e7bf3a4 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -55,3 +55,14 @@ impl Cmd { Ok(()) } } + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} \ No newline at end of file diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs index 85de8a63af..88a0e9f1e1 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs @@ -5,6 +5,7 @@ use crate::{ }; use clap::{command, Parser}; +use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -43,17 +44,6 @@ pub enum Error { InvalidHash(String), } -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} - impl Cmd { pub async fn run(&self) -> Result<(), Error> { let network = self.network.get(&self.locator)?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs index f99d61fa7b..89cfabdb75 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -22,4 +22,4 @@ impl Cmd { }; Ok(()) } -} +} \ No newline at end of file From 4b590bdc0b1e51fd1036a43f4f2b9ca5d56c6447 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 14:57:19 -0400 Subject: [PATCH 35/76] Factor out shared Args for all entry subcmds --- .../commands/ledger/entry/fetch/account.rs | 43 ++---------- .../src/commands/ledger/entry/fetch/args.rs | 70 +++++++++++++++++++ .../ledger/entry/fetch/claimable_balance.rs | 48 ++----------- .../src/commands/ledger/entry/fetch/config.rs | 62 +++++----------- .../commands/ledger/entry/fetch/contract.rs | 58 +++------------ .../ledger/entry/fetch/liquidity_pool.rs | 48 ++----------- .../src/commands/ledger/entry/fetch/mod.rs | 12 +--- .../src/commands/ledger/entry/fetch/wasm.rs | 57 ++------------- .../src/commands/ledger/entry/mod.rs | 2 +- 9 files changed, 126 insertions(+), 274 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/args.rs diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 1114335c22..3ff8352b38 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -1,9 +1,9 @@ use std::array::TryFromSliceError; use std::fmt::Debug; +use super::args::Args; use crate::{ - commands::{config::{self, locator, network}}, - rpc, + commands::config::{self, locator}, xdr::{ self, AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, LedgerKeyAccount, LedgerKeyData, LedgerKeyOffer, LedgerKeyTrustLine, MuxedAccount, @@ -12,7 +12,6 @@ use crate::{ }; use clap::{command, Parser}; use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; -use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -21,10 +20,7 @@ pub struct Cmd { pub account: String, #[command(flatten)] - pub network: network::Args, - - #[command(flatten)] - pub locator: locator::Args, + pub args: Args, //Options /// Assets to get trustline info for @@ -46,10 +42,6 @@ pub struct Cmd { /// If identity is a seed phrase use this hd path, default is 0 #[arg(long)] pub hd_path: Option, - - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, } #[derive(thiserror::Error, Debug)] @@ -63,42 +55,20 @@ pub enum Error { #[error(transparent)] Locator(#[from] locator::Error), #[error(transparent)] - Network(#[from] network::Error), - #[error(transparent)] - Rpc(#[from] rpc::Error), - #[error(transparent)] - Serde(#[from] serde_json::Error), - #[error(transparent)] TryFromSliceError(#[from] TryFromSliceError), + #[error(transparent)] + Run(#[from] super::args::Error), } impl Cmd { pub async fn run(&self) -> Result<(), Error> { let mut ledger_keys = vec![]; - self.insert_account_keys(&mut ledger_keys)?; self.insert_asset_keys(&mut ledger_keys)?; self.insert_data_keys(&mut ledger_keys)?; self.insert_offer_keys(&mut ledger_keys)?; - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; - match self.output { - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Xdr => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); - } - } - - Ok(()) + Ok(self.args.run(ledger_keys).await?) } fn insert_account_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { @@ -193,6 +163,7 @@ impl Cmd { fn muxed_account(&self, account: &str) -> Result { Ok(self + .args .locator .read_key(account)? .muxed_account(self.hd_path)?) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/args.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/args.rs new file mode 100644 index 0000000000..33d5b6e0ca --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/args.rs @@ -0,0 +1,70 @@ +use crate::{ + config::{ + locator, + network::{self, Network}, + }, + rpc, + xdr::LedgerKey, +}; + +#[derive(Debug, clap::Args, Clone)] +#[group(skip)] +pub struct Args { + #[command(flatten)] + pub network: network::Args, + + #[command(flatten)] + pub locator: locator::Args, + + /// Format of the output + #[arg(long, default_value = "json")] + pub output: OutputFormat, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Network(#[from] network::Error), + #[error(transparent)] + Serde(#[from] serde_json::Error), + #[error(transparent)] + Rpc(#[from] rpc::Error), +} + +#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] +pub enum OutputFormat { + /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) + #[default] + Json, + /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs + JsonFormatted, + /// Original RPC output (containing XDRs) + Xdr, +} + +impl Args { + pub fn network(&self) -> Result { + Ok(self.network.get(&self.locator)?) + } + + pub async fn run(&self, ledger_keys: Vec) -> Result<(), Error> { + let network = self.network.get(&self.locator)?; + let client = network.rpc_client()?; + match self.output { + OutputFormat::Json => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::Xdr => { + let resp = client.get_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string(&resp)?); + } + OutputFormat::JsonFormatted => { + let resp = client.get_full_ledger_entries(&ledger_keys).await?; + println!("{}", serde_json::to_string_pretty(&resp)?); + } + } + + Ok(()) + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs index 1ee67aabbb..0e8fb44caf 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs @@ -1,30 +1,19 @@ -use crate::{ - commands::config::{locator, network}, - rpc, - xdr::{ - ClaimableBalanceId::ClaimableBalanceIdTypeV0, Hash, LedgerKey, LedgerKeyClaimableBalance, - }, +use super::args::Args; +use crate::xdr::{ + ClaimableBalanceId::ClaimableBalanceIdTypeV0, Hash, LedgerKey, LedgerKeyClaimableBalance, }; use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; -use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { - #[command(flatten)] - pub network: network::Args, - - #[command(flatten)] - pub locator: locator::Args, - /// Claimable Balance Ids to fetch an entry for pub ids: Vec, - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, + #[command(flatten)] + pub args: Args, } #[derive(thiserror::Error, Debug)] @@ -34,37 +23,14 @@ pub enum Error { #[error("provided hash value is invalid: {0}")] InvalidHash(String), #[error(transparent)] - Network(#[from] network::Error), - #[error(transparent)] - Rpc(#[from] rpc::Error), - #[error(transparent)] - Serde(#[from] serde_json::Error), + Run(#[from] super::args::Error), } impl Cmd { pub async fn run(&self) -> Result<(), Error> { - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; let mut ledger_keys = vec![]; - self.insert_keys(&mut ledger_keys)?; - - match self.output { - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Xdr => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); - } - } - - Ok(()) + Ok(self.args.run(ledger_keys).await?) } fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs index aa0b5034e2..82eb57b539 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs @@ -1,29 +1,18 @@ -use crate::{ - config::{self, locator, network}, - rpc, - xdr::{ConfigSettingId, LedgerKey, LedgerKeyConfigSetting}, -}; +use super::args::Args; +use crate::xdr::{ConfigSettingId, LedgerKey, LedgerKeyConfigSetting}; use clap::{command, Parser}; use std::collections::HashMap; use std::fmt::Debug; -use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { - #[command(flatten)] - pub network: network::Args, - - #[command(flatten)] - pub locator: locator::Args, - /// Defines the network configuration to fetch #[arg(long_help = long_help() )] pub config_setting_ids: Option>, - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, + #[command(flatten)] + pub args: Args, } fn long_help() -> String { @@ -49,44 +38,27 @@ fn config_setting_variants_to_ids() -> HashMap { #[derive(thiserror::Error, Debug)] pub enum Error { - #[error(transparent)] - Config(#[from] config::key::Error), - #[error(transparent)] - Locator(#[from] locator::Error), - #[error(transparent)] - Network(#[from] network::Error), - #[error(transparent)] - Rpc(#[from] rpc::Error), - #[error(transparent)] - Serde(#[from] serde_json::Error), + // #[error(transparent)] + // Config(#[from] config::key::Error), + // #[error(transparent)] + // Locator(#[from] locator::Error), + // #[error(transparent)] + // Network(#[from] network::Error), + // #[error(transparent)] + // Rpc(#[from] rpc::Error), + // #[error(transparent)] + // Serde(#[from] serde_json::Error), #[error("provided config id is invalid: {0}")] InvalidConfigId(i32), + #[error(transparent)] + Run(#[from] super::args::Error), } impl Cmd { pub async fn run(&self) -> Result<(), Error> { - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; let mut ledger_keys = vec![]; - self.insert_keys(&mut ledger_keys)?; - - match self.output { - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Xdr => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); - } - } - - Ok(()) + Ok(self.args.run(ledger_keys).await?) } fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs index 97d8d0393b..8c25702812 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -1,18 +1,13 @@ +use super::args::Args; use crate::{ commands::contract::Durability, - config, - config::{ - locator, - network::{self, Network}, - }, - rpc, + config::{self, locator}, xdr::{ self, ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, ScAddress, ScVal, }, }; use clap::{command, Parser}; -use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -21,10 +16,7 @@ pub struct Cmd { pub contract: config::UnresolvedContract, #[command(flatten)] - pub network: network::Args, - - #[command(flatten)] - pub locator: locator::Args, + pub args: Args, //Options /// Storage entry durability @@ -38,25 +30,15 @@ pub struct Cmd { /// Storage key (base64-encoded XDR) #[arg(long = "key-xdr")] pub key_xdr: Option>, - - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, } #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] - Config(#[from] config::key::Error), + Run(#[from] super::args::Error), #[error(transparent)] Locator(#[from] locator::Error), #[error(transparent)] - Network(#[from] network::Error), - #[error(transparent)] - Rpc(#[from] rpc::Error), - #[error(transparent)] - Serde(#[from] serde_json::Error), - #[error(transparent)] Spec(#[from] soroban_spec_tools::Error), #[error(transparent)] StellarXdr(#[from] stellar_xdr::curr::Error), @@ -64,38 +46,16 @@ pub enum Error { impl Cmd { pub async fn run(&self) -> Result<(), Error> { - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; let mut ledger_keys = vec![]; - - self.insert_keys(&network, &mut ledger_keys)?; - - match self.output { - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Xdr => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); - } - } - - Ok(()) + self.insert_keys(&mut ledger_keys)?; + Ok(self.args.run(ledger_keys).await?) } - fn insert_keys( - &self, - network: &Network, - ledger_keys: &mut Vec, - ) -> Result<(), Error> { + fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + let network = self.args.network()?; let contract_id = self .contract - .resolve_contract_id(&self.locator, &network.network_passphrase)?; + .resolve_contract_id(&self.args.locator, &network.network_passphrase)?; let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); if let Some(keys) = &self.key { diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs index 9056f6ee93..e6ccd5696e 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs @@ -1,69 +1,35 @@ -use crate::{ - config::{locator, network}, - rpc, - xdr::{Hash, LedgerKey, LedgerKeyLiquidityPool, PoolId}, -}; +use super::args::Args; +use crate::xdr::{Hash, LedgerKey, LedgerKeyLiquidityPool, PoolId}; use clap::{command, Parser}; use hex::FromHexError; use soroban_spec_tools::utils::padded_hex_from_str; use std::fmt::Debug; -use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { - #[command(flatten)] - pub network: network::Args, - - #[command(flatten)] - pub locator: locator::Args, - /// Liquidity pool ids pub ids: Vec, - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, + #[command(flatten)] + pub args: Args, } #[derive(thiserror::Error, Debug)] pub enum Error { - #[error(transparent)] - Network(#[from] network::Error), - #[error(transparent)] - Rpc(#[from] rpc::Error), - #[error(transparent)] - Serde(#[from] serde_json::Error), #[error(transparent)] FromHexError(#[from] FromHexError), #[error("provided hash value is invalid: {0}")] InvalidHash(String), + #[error(transparent)] + Run(#[from] super::args::Error), } impl Cmd { pub async fn run(&self) -> Result<(), Error> { - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; let mut ledger_keys = vec![]; - self.insert_keys(&mut ledger_keys)?; - - match self.output { - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Xdr => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); - } - } - - Ok(()) + Ok(self.args.run(ledger_keys).await?) } fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 5b4e7bf3a4..8f1b6f97ad 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -2,6 +2,7 @@ use clap::Parser; use std::fmt::Debug; pub mod account; +pub mod args; pub mod claimable_balance; pub mod config; pub mod contract; @@ -55,14 +56,3 @@ impl Cmd { Ok(()) } } - -#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, clap::ValueEnum, Default)] -pub enum OutputFormat { - /// JSON output of the ledger entry with parsed XDRs (one line, not formatted) - #[default] - Json, - /// Formatted (multiline) JSON output of the ledger entry with parsed XDRs - JsonFormatted, - /// Original RPC output (containing XDRs) - Xdr, -} \ No newline at end of file diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs index 88a0e9f1e1..8031e23b72 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs @@ -1,73 +1,30 @@ -use crate::{ - config::{self, locator, network}, - rpc, - xdr::{Hash, LedgerKey, LedgerKeyContractCode}, -}; - +use super::args::Args; +use crate::xdr::{Hash, LedgerKey, LedgerKeyContractCode}; use clap::{command, Parser}; -use super::OutputFormat; #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { - #[command(flatten)] - pub network: network::Args, - - #[command(flatten)] - pub locator: locator::Args, - /// Get WASM bytecode by hash pub wasm_hashes: Vec, - /// Format of the output - #[arg(long, default_value = "json")] - pub output: OutputFormat, + #[command(flatten)] + pub args: Args, } #[derive(thiserror::Error, Debug)] pub enum Error { - #[error(transparent)] - Config(#[from] config::key::Error), - #[error(transparent)] - Locator(#[from] locator::Error), - #[error(transparent)] - Network(#[from] network::Error), - #[error(transparent)] - Rpc(#[from] rpc::Error), - #[error(transparent)] - Serde(#[from] serde_json::Error), - #[error(transparent)] - Spec(#[from] soroban_spec_tools::Error), - #[error(transparent)] - StellarXdr(#[from] stellar_xdr::curr::Error), #[error("provided hash value is invalid: {0}")] InvalidHash(String), + #[error(transparent)] + Run(#[from] super::args::Error), } impl Cmd { pub async fn run(&self) -> Result<(), Error> { - let network = self.network.get(&self.locator)?; - let client = network.rpc_client()?; let mut ledger_keys = vec![]; - self.insert_keys(&mut ledger_keys)?; - - match self.output { - OutputFormat::Json => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::Xdr => { - let resp = client.get_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string(&resp)?); - } - OutputFormat::JsonFormatted => { - let resp = client.get_full_ledger_entries(&ledger_keys).await?; - println!("{}", serde_json::to_string_pretty(&resp)?); - } - } - - Ok(()) + Ok(self.args.run(ledger_keys).await?) } fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs index 89cfabdb75..f99d61fa7b 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -22,4 +22,4 @@ impl Cmd { }; Ok(()) } -} \ No newline at end of file +} From b97eafbf6dab117365ec366b9dbc48f0bf2e850b Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 15:24:25 -0400 Subject: [PATCH 36/76] Cleanup --- .../src/commands/ledger/entry/fetch/config.rs | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs index 82eb57b539..f081bd8a56 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs @@ -38,16 +38,6 @@ fn config_setting_variants_to_ids() -> HashMap { #[derive(thiserror::Error, Debug)] pub enum Error { - // #[error(transparent)] - // Config(#[from] config::key::Error), - // #[error(transparent)] - // Locator(#[from] locator::Error), - // #[error(transparent)] - // Network(#[from] network::Error), - // #[error(transparent)] - // Rpc(#[from] rpc::Error), - // #[error(transparent)] - // Serde(#[from] serde_json::Error), #[error("provided config id is invalid: {0}")] InvalidConfigId(i32), #[error(transparent)] From 6e190782be67d001d70dfe39fd4152c58bd81197 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 14 May 2025 15:30:35 -0400 Subject: [PATCH 37/76] Update generated docs --- FULL_HELP_DOCS.md | 34 +++++++++++++++++----------------- 1 file changed, 17 insertions(+), 17 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 58d5852fc4..97e1073c1d 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -2753,11 +2753,6 @@ Fetch account entry by public key or alias. Additional account-related keys are * `-n`, `--network ` — Name of network to use from config * `--global` — Use global config * `--config-dir ` — Location of config directory, default is "." -* `--asset ` — Assets to get trustline info for -* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) -* `--offer ` — ID of an offer made on the Stellar DEX -* `--hide-account` — Hide the account ledger entry from the output -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 * `--output ` — Format of the output Default value: `json` @@ -2770,6 +2765,11 @@ Fetch account entry by public key or alias. Additional account-related keys are - `xdr`: Original RPC output (containing XDRs) +* `--asset ` — Assets to get trustline info for +* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) +* `--offer ` — ID of an offer made on the Stellar DEX +* `--hide-account` — Hide the account ledger entry from the output +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 @@ -2791,18 +2791,6 @@ Fetch contract ledger entry by address or alias and storage key * `-n`, `--network ` — Name of network to use from config * `--global` — Use global config * `--config-dir ` — Location of config directory, default is "." -* `--durability ` — Storage entry durability - - Default value: `persistent` - - Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) * `--output ` — Format of the output Default value: `json` @@ -2815,6 +2803,18 @@ Fetch contract ledger entry by address or alias and storage key - `xdr`: Original RPC output (containing XDRs) +* `--durability ` — Storage entry durability + + Default value: `persistent` + + Possible values: + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) From 5aea49eea23d12cffb77e1bcd7e5ea238e8b8471 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 20 May 2025 13:10:39 -0400 Subject: [PATCH 38/76] Add claimable balance test --- .../tests/it/integration/ledger/entry.rs | 158 ++++++++++++++++-- 1 file changed, 147 insertions(+), 11 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 0cd24cde5a..9bb60ae932 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -1,9 +1,21 @@ -use soroban_cli::xdr::{ - AccountId, AlphaNum4, AssetCode4, ConfigSettingId, ContractDataDurability, Hash, - LedgerEntryData, LedgerKey, LedgerKeyAccount, LedgerKeyConfigSetting, LedgerKeyContractCode, - LedgerKeyContractData, LedgerKeyData, LedgerKeyTrustLine, Limits, PublicKey, ScAddress, ScVal, - String64, StringM, TrustLineAsset, Uint256, WriteXdr, +use soroban_cli::{ + xdr::{ + self, + AccountId, AlphaNum4, AssetCode4, ConfigSettingId, ContractDataDurability, Hash, + LedgerEntryData, LedgerKey, LedgerKeyAccount, LedgerKeyConfigSetting, LedgerKeyContractCode, + LedgerKeyContractData, LedgerKeyData, LedgerKeyTrustLine, Limits, PublicKey, ScAddress, ScVal, + String64, StringM, TrustLineAsset, Uint256, WriteXdr,ClaimantV0, Claimant, Operation,ClaimPredicate, Asset, CreateClaimableBalanceOp, OperationBody, ClaimantType, VecM, Transaction, TransactionEnvelope, TransactionResult, TransactionResultResult, ClaimableBalanceId, OperationResultTr, OperationResult, CreateClaimableBalanceResult, LedgerKeyClaimableBalance + }, + tx::builder::{self, asset, TxExt}, + config::{ + self, + address::{self, UnresolvedMuxedAccount}, + locator, + data, network, secret, + }, }; + +use soroban_rpc::GetTransactionResponse; use soroban_rpc::FullLedgerEntries; use soroban_spec_tools::utils::padded_hex_from_str; use soroban_test::AssertExt; @@ -327,7 +339,7 @@ async fn ledger_entry_contract_data() { } // top level test -// todo: test --claimable-id, --pool-id, +// todo: test --pool-id, #[tokio::test] async fn ledger_entry_wasm_hash() { let sandbox = &TestEnv::new(); @@ -441,6 +453,47 @@ async fn ledger_entry_config_setting_id() { ); } +#[tokio::test] +async fn ledger_entry_claimable_balance() { + let sandbox = &TestEnv::new(); + // create a claimable balance + let sender_alias = "test"; + let sender = test_address(sandbox); + let claimant = new_account(sandbox, "claimant"); + let tx = claimable_balance_tx_env(&sender, &claimant); + let tx_xdr = tx.to_xdr_base64(Limits::none()).unwrap(); + let updated_tx = update_seq_number(sandbox, &tx_xdr); + let tx_output = sign_and_send(sandbox, &sender, sender_alias, &updated_tx).await; + let response: GetTransactionResponse = serde_json::from_str(&tx_output).expect("Failed to parse JSON"); + let id = extract_claimable_balance_id(response).unwrap(); + + // fetch the claimable-balance + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("claimable-balance") + .arg(id.to_string()) + .arg("--network") + .arg("local") + .assert() + .success() + .stdout_as_str(); + let parsed_output: FullLedgerEntries = + serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed_output.entries.is_empty()); + let expected_key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { + balance_id: ClaimableBalanceId::ClaimableBalanceIdTypeV0(id), + }); + assert_eq!(parsed_output.entries[0].key, expected_key); + assert!(matches!( + parsed_output.entries[0].val, + LedgerEntryData::ClaimableBalance { .. } + )); +} + + + // Helper Fns fn new_account(sandbox: &TestEnv, name: &str) -> String { sandbox.generate_account(name, None).assert().success(); @@ -514,17 +567,21 @@ async fn issue_asset(sandbox: &TestEnv, test: &str, asset: &str, limit: u64, ini } async fn expected_account_ledger_key(account_addr: &str) -> (AccountId, LedgerKey) { - let strkey = StrkeyPublicKeyEd25519::from_string(account_addr).unwrap().0; - - let uint256 = Uint256(strkey); - let pk = PublicKey::PublicKeyTypeEd25519(uint256); - let account_id = AccountId(pk); + let account_id = account_id(account_addr); let ledger_key = LedgerKey::Account(LedgerKeyAccount { account_id: account_id.clone(), }); (account_id, ledger_key) } +fn account_id(account_addr: &str) -> AccountId { + let strkey = StrkeyPublicKeyEd25519::from_string(account_addr).unwrap().0; + + let uint256 = Uint256(strkey); + let pk = PublicKey::PublicKeyTypeEd25519(uint256); + AccountId(pk) +} + async fn expected_contract_ledger_key(contract_id: &str, storage_key: &str) -> LedgerKey { let contract_bytes: [u8; 32] = Contract::from_string(contract_id).unwrap().0; let contract_id = Hash(contract_bytes); @@ -551,3 +608,82 @@ async fn add_account_data(sandbox: &TestEnv, account_alias: &str, key: &str, val .assert() .success(); } + +fn claimable_balance_tx_env(sender: &str, destination: &str) -> TransactionEnvelope{ + let destination_id = account_id(&destination); + let claimant = Claimant::ClaimantTypeV0( + ClaimantV0{ + destination: destination_id, + predicate: ClaimPredicate::Unconditional + } + ); + let claimants = VecM::try_from(vec![claimant]).unwrap(); + let create_op = Operation { + source_account: None, + body: OperationBody::CreateClaimableBalance(CreateClaimableBalanceOp { + asset: Asset::Native, + amount: 10_000_000, + claimants: claimants, + }), + }; + + let source: UnresolvedMuxedAccount = sender.parse().unwrap(); + let resolved_source = source.resolve_muxed_account_sync(&locator::Args::default(), None).unwrap(); + + xdr::Transaction::new_tx(resolved_source, 1000, 1, create_op).into() +} + +fn update_seq_number(sandbox: &TestEnv, tx_xdr: &str) -> String { + sandbox + .new_assert_cmd("tx") + .arg("update") + .arg("seq-num") + .arg("next") + .write_stdin(tx_xdr.as_bytes()) + .assert() + .success() + .stdout_as_str() +} + +async fn sign_and_send(sandbox: &TestEnv, account: &str, sign_with: &str, tx: &str) -> String { + let tx_signed = sandbox + .new_assert_cmd("tx") + .arg("sign") + .arg("--sign-with-key") + .arg(sign_with) + .write_stdin(tx.as_bytes()) + .assert() + .success() + .stdout_as_str(); + dbg!("{tx_signed}"); + + sandbox + .new_assert_cmd("tx") + .arg("send") + .write_stdin(tx_signed.as_bytes()) + .assert() + .success() + .stdout(predicates::str::contains("SUCCESS")) + .stdout_as_str() +} + +fn extract_claimable_balance_id(response: GetTransactionResponse) -> Option { + if let Some(result) = response.result { + if let TransactionResult{ + result: TransactionResultResult::TxSuccess(results), + .. + } = result + { + if let Some(OperationResult::OpInner( + OperationResultTr::CreateClaimableBalance(CreateClaimableBalanceResult::Success( + ClaimableBalanceId::ClaimableBalanceIdTypeV0(hash), + )), + )) + = results.first() + { + return Some(hash.clone()) + } + } + } + None +} \ No newline at end of file From 8a2fe1dafb771286fa63e467806975100a816ab9 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 20 May 2025 17:37:27 -0400 Subject: [PATCH 39/76] Add test for fetching liquidity pool --- .../tests/it/integration/ledger/entry.rs | 177 +++++++++++++----- 1 file changed, 134 insertions(+), 43 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 9bb60ae932..400d9d7539 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -4,16 +4,16 @@ use soroban_cli::{ AccountId, AlphaNum4, AssetCode4, ConfigSettingId, ContractDataDurability, Hash, LedgerEntryData, LedgerKey, LedgerKeyAccount, LedgerKeyConfigSetting, LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, LedgerKeyTrustLine, Limits, PublicKey, ScAddress, ScVal, - String64, StringM, TrustLineAsset, Uint256, WriteXdr,ClaimantV0, Claimant, Operation,ClaimPredicate, Asset, CreateClaimableBalanceOp, OperationBody, ClaimantType, VecM, Transaction, TransactionEnvelope, TransactionResult, TransactionResultResult, ClaimableBalanceId, OperationResultTr, OperationResult, CreateClaimableBalanceResult, LedgerKeyClaimableBalance + String64, StringM, TrustLineAsset, Uint256, WriteXdr,ClaimantV0, Claimant, Operation,ClaimPredicate, Asset, CreateClaimableBalanceOp, OperationBody, VecM, TransactionEnvelope, TransactionResult, TransactionResultResult, ClaimableBalanceId, OperationResultTr, OperationResult, CreateClaimableBalanceResult, LedgerKeyClaimableBalance,ChangeTrustOp, ChangeTrustAsset, LiquidityPoolParameters, LiquidityPoolConstantProductParameters, LedgerKeyLiquidityPool, PoolId }, - tx::builder::{self, asset, TxExt}, + tx::builder::TxExt, config::{ - self, - address::{self, UnresolvedMuxedAccount}, + address::UnresolvedMuxedAccount, locator, - data, network, secret, }, }; +use sha2::{Digest, Sha256}; + use soroban_rpc::GetTransactionResponse; use soroban_rpc::FullLedgerEntries; @@ -25,7 +25,7 @@ use stellar_strkey::{ed25519::PublicKey as StrkeyPublicKeyEd25519, Contract}; use crate::integration::util::{deploy_contract, test_address, DeployOptions, HELLO_WORLD}; // account data tests -// todo: test with--offer, +// todo: test with --offer, #[tokio::test] async fn ledger_entry_account_only_with_account_alias() { let sandbox = &TestEnv::new(); @@ -126,6 +126,7 @@ async fn ledger_entry_account_asset_usdc() { issue_asset( sandbox, &test_account_address, + &issuer_alias, asset, limit, initial_balance, @@ -148,7 +149,7 @@ async fn ledger_entry_account_asset_usdc() { let (account_id, expected_account_key) = expected_account_ledger_key(&test_account_address).await; - let (issuer_account_id, _) = expected_account_ledger_key(&issuer_address).await; + let issuer_account_id = get_account_id(&issuer_address); let trustline_asset = TrustLineAsset::CreditAlphanum4(AlphaNum4 { asset_code: AssetCode4(*b"usdc"), @@ -339,7 +340,6 @@ async fn ledger_entry_contract_data() { } // top level test -// todo: test --pool-id, #[tokio::test] async fn ledger_entry_wasm_hash() { let sandbox = &TestEnv::new(); @@ -460,10 +460,10 @@ async fn ledger_entry_claimable_balance() { let sender_alias = "test"; let sender = test_address(sandbox); let claimant = new_account(sandbox, "claimant"); - let tx = claimable_balance_tx_env(&sender, &claimant); - let tx_xdr = tx.to_xdr_base64(Limits::none()).unwrap(); + let tx_env = claimable_balance_tx_env(&sender, &claimant); + let tx_xdr = tx_env.to_xdr_base64(Limits::none()).unwrap(); let updated_tx = update_seq_number(sandbox, &tx_xdr); - let tx_output = sign_and_send(sandbox, &sender, sender_alias, &updated_tx).await; + let tx_output = sign_and_send(sandbox, sender_alias, &updated_tx).await; let response: GetTransactionResponse = serde_json::from_str(&tx_output).expect("Failed to parse JSON"); let id = extract_claimable_balance_id(response).unwrap(); @@ -492,7 +492,57 @@ async fn ledger_entry_claimable_balance() { )); } +#[tokio::test] +async fn ledger_entry_liquidity_pool() { + let sandbox = &TestEnv::new(); + let test_account_alias = "test"; + let test_account_address = test_address(sandbox); + // issue usdc + let issuer_alias = "test1"; + let issuer_address = new_account(sandbox, issuer_alias); + let asset = &format!("usdc:{issuer_address}"); + let limit = 100_000; + let initial_balance = 100; + issue_asset( + sandbox, + &test_account_address, + &issuer_alias, + asset, + limit, + initial_balance, + ) + .await; + + // create liquidity pool + let (tx_env, pool_id) = liquidity_pool_tx_env(&test_account_address, &issuer_address); + let tx_xdr = tx_env.to_xdr_base64(Limits::none()).unwrap(); + let updated_tx = update_seq_number(sandbox, &tx_xdr); + sign_and_send(sandbox, test_account_alias, &updated_tx).await; + // fetch the liquidity pool + let output = sandbox + .new_assert_cmd("ledger") + .arg("entry") + .arg("fetch") + .arg("liquidity-pool") + .arg(pool_id.to_string()) + .arg("--network") + .arg("local") + .assert() + .success() + .stdout_as_str(); + let parsed_output: FullLedgerEntries = + serde_json::from_str(&output).expect("Failed to parse JSON"); + assert!(!parsed_output.entries.is_empty()); + let expected_key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { + liquidity_pool_id: PoolId(Hash(pool_id.0)), + }); + assert_eq!(parsed_output.entries[0].key, expected_key); + assert!(matches!( + parsed_output.entries[0].val, + LedgerEntryData::LiquidityPool { .. } + )); +} // Helper Fns fn new_account(sandbox: &TestEnv, name: &str) -> String { @@ -507,9 +557,9 @@ fn new_account(sandbox: &TestEnv, name: &str) -> String { .stdout_as_str() } -async fn issue_asset(sandbox: &TestEnv, test: &str, asset: &str, limit: u64, initial_balance: u64) { +async fn issue_asset(sandbox: &TestEnv, test_addr: &str, issuer_alias: &str, asset: &str, limit: u64, initial_balance: u64) { let client = sandbox.network.rpc_client().unwrap(); - let test_before = client.get_account(test).await.unwrap(); + let test_before = client.get_account(test_addr).await.unwrap(); sandbox .new_assert_cmd("tx") .args([ @@ -524,57 +574,37 @@ async fn issue_asset(sandbox: &TestEnv, test: &str, asset: &str, limit: u64, ini .success() .stdout_as_str(); - sandbox - .new_assert_cmd("tx") - .args(["new", "set-options", "--set-required"]) - .assert() - .success(); - sandbox - .new_assert_cmd("tx") - .args([ - "new", - "set-trustline-flags", - "--asset", - asset, - "--trustor", - test, - "--set-authorize", - "--source", - "test1", - ]) - .assert() - .success(); - - let after = client.get_account(test).await.unwrap(); + let after = client.get_account(test_addr).await.unwrap(); assert_eq!(test_before.num_sub_entries + 1, after.num_sub_entries); - // Send a payment to the issuer + // Send asset to the test sandbox .new_assert_cmd("tx") .args([ "new", "payment", "--destination", - test, + test_addr, "--asset", asset, "--amount", initial_balance.to_string().as_str(), - "--source=test1", + "--source", + issuer_alias ]) .assert() .success(); } async fn expected_account_ledger_key(account_addr: &str) -> (AccountId, LedgerKey) { - let account_id = account_id(account_addr); + let account_id = get_account_id(account_addr); let ledger_key = LedgerKey::Account(LedgerKeyAccount { account_id: account_id.clone(), }); (account_id, ledger_key) } -fn account_id(account_addr: &str) -> AccountId { +fn get_account_id(account_addr: &str) -> AccountId { let strkey = StrkeyPublicKeyEd25519::from_string(account_addr).unwrap().0; let uint256 = Uint256(strkey); @@ -610,7 +640,7 @@ async fn add_account_data(sandbox: &TestEnv, account_alias: &str, key: &str, val } fn claimable_balance_tx_env(sender: &str, destination: &str) -> TransactionEnvelope{ - let destination_id = account_id(&destination); + let destination_id = get_account_id(&destination); let claimant = Claimant::ClaimantTypeV0( ClaimantV0{ destination: destination_id, @@ -633,6 +663,46 @@ fn claimable_balance_tx_env(sender: &str, destination: &str) -> TransactionEnvel xdr::Transaction::new_tx(resolved_source, 1000, 1, create_op).into() } +fn liquidity_pool_tx_env(test_account_address: &str, usdc_issuer_address: &str) -> (TransactionEnvelope, Uint256){ + let issuer_account_id = get_account_id(&usdc_issuer_address); + let usdc_asset = Asset::CreditAlphanum4(AlphaNum4 { + asset_code: AssetCode4(*b"usdc"), + issuer: issuer_account_id, + }); + + let asset_a = Asset::Native; + let asset_b = usdc_asset; + let fee = 30; + + let line = ChangeTrustAsset::PoolShare( + LiquidityPoolParameters::LiquidityPoolConstantProduct( + LiquidityPoolConstantProductParameters{ + asset_a: asset_a.clone(), + asset_b: asset_b.clone(), + fee + } + ) + ); + let op = Operation { + source_account: None, + body: OperationBody::ChangeTrust( + ChangeTrustOp { + line: line, + limit: i64::MAX + } + ) + }; + + let source: UnresolvedMuxedAccount = test_account_address.parse().unwrap(); + let resolved_source = source.resolve_muxed_account_sync(&locator::Args::default(), None).unwrap(); + + let tx = xdr::Transaction::new_tx(resolved_source, 1000, 1, op).into(); + + let pool_id = compute_pool_id(asset_a.clone(), asset_b.clone(), fee); + + (tx, pool_id) +} + fn update_seq_number(sandbox: &TestEnv, tx_xdr: &str) -> String { sandbox .new_assert_cmd("tx") @@ -645,7 +715,7 @@ fn update_seq_number(sandbox: &TestEnv, tx_xdr: &str) -> String { .stdout_as_str() } -async fn sign_and_send(sandbox: &TestEnv, account: &str, sign_with: &str, tx: &str) -> String { +async fn sign_and_send(sandbox: &TestEnv, sign_with: &str, tx: &str) -> String { let tx_signed = sandbox .new_assert_cmd("tx") .arg("sign") @@ -655,7 +725,6 @@ async fn sign_and_send(sandbox: &TestEnv, account: &str, sign_with: &str, tx: &s .assert() .success() .stdout_as_str(); - dbg!("{tx_signed}"); sandbox .new_assert_cmd("tx") @@ -686,4 +755,26 @@ fn extract_claimable_balance_id(response: GetTransactionResponse) -> Option Uint256 { + let (asset_a, asset_b) = if asset_a < asset_b { + (asset_a, asset_b) + } else { + (asset_b, asset_a) + }; + + let pool_params = LiquidityPoolParameters::LiquidityPoolConstantProduct( + LiquidityPoolConstantProductParameters { + asset_a, + asset_b, + fee, + }, + ); + + let mut hasher = Sha256::new(); + hasher.update(pool_params.to_xdr(Limits::none()).unwrap()); + let hash = hasher.finalize(); + + Uint256(hash.into()) } \ No newline at end of file From 114f70a9f9ebe0cf891db36e5b4dd2697085a1cf Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 22 May 2025 10:43:44 -0400 Subject: [PATCH 40/76] Fmt --- .../tests/it/integration/ledger/entry.rs | 112 ++++++++++-------- 1 file changed, 60 insertions(+), 52 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 400d9d7539..c9bd730e1c 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -1,22 +1,22 @@ +use sha2::{Digest, Sha256}; use soroban_cli::{ - xdr::{ - self, - AccountId, AlphaNum4, AssetCode4, ConfigSettingId, ContractDataDurability, Hash, - LedgerEntryData, LedgerKey, LedgerKeyAccount, LedgerKeyConfigSetting, LedgerKeyContractCode, - LedgerKeyContractData, LedgerKeyData, LedgerKeyTrustLine, Limits, PublicKey, ScAddress, ScVal, - String64, StringM, TrustLineAsset, Uint256, WriteXdr,ClaimantV0, Claimant, Operation,ClaimPredicate, Asset, CreateClaimableBalanceOp, OperationBody, VecM, TransactionEnvelope, TransactionResult, TransactionResultResult, ClaimableBalanceId, OperationResultTr, OperationResult, CreateClaimableBalanceResult, LedgerKeyClaimableBalance,ChangeTrustOp, ChangeTrustAsset, LiquidityPoolParameters, LiquidityPoolConstantProductParameters, LedgerKeyLiquidityPool, PoolId - }, + config::{address::UnresolvedMuxedAccount, locator}, tx::builder::TxExt, - config::{ - address::UnresolvedMuxedAccount, - locator, + xdr::{ + self, AccountId, AlphaNum4, Asset, AssetCode4, ChangeTrustAsset, ChangeTrustOp, + ClaimPredicate, ClaimableBalanceId, Claimant, ClaimantV0, ConfigSettingId, + ContractDataDurability, CreateClaimableBalanceOp, CreateClaimableBalanceResult, Hash, + LedgerEntryData, LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, + LedgerKeyConfigSetting, LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, + LedgerKeyLiquidityPool, LedgerKeyTrustLine, Limits, LiquidityPoolConstantProductParameters, + LiquidityPoolParameters, Operation, OperationBody, OperationResult, OperationResultTr, + PoolId, PublicKey, ScAddress, ScVal, String64, StringM, TransactionEnvelope, + TransactionResult, TransactionResultResult, TrustLineAsset, Uint256, VecM, WriteXdr, }, }; -use sha2::{Digest, Sha256}; - -use soroban_rpc::GetTransactionResponse; use soroban_rpc::FullLedgerEntries; +use soroban_rpc::GetTransactionResponse; use soroban_spec_tools::utils::padded_hex_from_str; use soroban_test::AssertExt; use soroban_test::TestEnv; @@ -464,7 +464,8 @@ async fn ledger_entry_claimable_balance() { let tx_xdr = tx_env.to_xdr_base64(Limits::none()).unwrap(); let updated_tx = update_seq_number(sandbox, &tx_xdr); let tx_output = sign_and_send(sandbox, sender_alias, &updated_tx).await; - let response: GetTransactionResponse = serde_json::from_str(&tx_output).expect("Failed to parse JSON"); + let response: GetTransactionResponse = + serde_json::from_str(&tx_output).expect("Failed to parse JSON"); let id = extract_claimable_balance_id(response).unwrap(); // fetch the claimable-balance @@ -485,7 +486,7 @@ async fn ledger_entry_claimable_balance() { let expected_key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { balance_id: ClaimableBalanceId::ClaimableBalanceIdTypeV0(id), }); - assert_eq!(parsed_output.entries[0].key, expected_key); + assert_eq!(parsed_output.entries[0].key, expected_key); assert!(matches!( parsed_output.entries[0].val, LedgerEntryData::ClaimableBalance { .. } @@ -537,7 +538,7 @@ async fn ledger_entry_liquidity_pool() { let expected_key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { liquidity_pool_id: PoolId(Hash(pool_id.0)), }); - assert_eq!(parsed_output.entries[0].key, expected_key); + assert_eq!(parsed_output.entries[0].key, expected_key); assert!(matches!( parsed_output.entries[0].val, LedgerEntryData::LiquidityPool { .. } @@ -557,7 +558,14 @@ fn new_account(sandbox: &TestEnv, name: &str) -> String { .stdout_as_str() } -async fn issue_asset(sandbox: &TestEnv, test_addr: &str, issuer_alias: &str, asset: &str, limit: u64, initial_balance: u64) { +async fn issue_asset( + sandbox: &TestEnv, + test_addr: &str, + issuer_alias: &str, + asset: &str, + limit: u64, + initial_balance: u64, +) { let client = sandbox.network.rpc_client().unwrap(); let test_before = client.get_account(test_addr).await.unwrap(); sandbox @@ -590,7 +598,7 @@ async fn issue_asset(sandbox: &TestEnv, test_addr: &str, issuer_alias: &str, ass "--amount", initial_balance.to_string().as_str(), "--source", - issuer_alias + issuer_alias, ]) .assert() .success(); @@ -639,14 +647,12 @@ async fn add_account_data(sandbox: &TestEnv, account_alias: &str, key: &str, val .success(); } -fn claimable_balance_tx_env(sender: &str, destination: &str) -> TransactionEnvelope{ +fn claimable_balance_tx_env(sender: &str, destination: &str) -> TransactionEnvelope { let destination_id = get_account_id(&destination); - let claimant = Claimant::ClaimantTypeV0( - ClaimantV0{ - destination: destination_id, - predicate: ClaimPredicate::Unconditional - } - ); + let claimant = Claimant::ClaimantTypeV0(ClaimantV0 { + destination: destination_id, + predicate: ClaimPredicate::Unconditional, + }); let claimants = VecM::try_from(vec![claimant]).unwrap(); let create_op = Operation { source_account: None, @@ -658,14 +664,19 @@ fn claimable_balance_tx_env(sender: &str, destination: &str) -> TransactionEnvel }; let source: UnresolvedMuxedAccount = sender.parse().unwrap(); - let resolved_source = source.resolve_muxed_account_sync(&locator::Args::default(), None).unwrap(); + let resolved_source = source + .resolve_muxed_account_sync(&locator::Args::default(), None) + .unwrap(); xdr::Transaction::new_tx(resolved_source, 1000, 1, create_op).into() } -fn liquidity_pool_tx_env(test_account_address: &str, usdc_issuer_address: &str) -> (TransactionEnvelope, Uint256){ +fn liquidity_pool_tx_env( + test_account_address: &str, + usdc_issuer_address: &str, +) -> (TransactionEnvelope, Uint256) { let issuer_account_id = get_account_id(&usdc_issuer_address); - let usdc_asset = Asset::CreditAlphanum4(AlphaNum4 { + let usdc_asset = Asset::CreditAlphanum4(AlphaNum4 { asset_code: AssetCode4(*b"usdc"), issuer: issuer_account_id, }); @@ -674,27 +685,25 @@ fn liquidity_pool_tx_env(test_account_address: &str, usdc_issuer_address: &str) let asset_b = usdc_asset; let fee = 30; - let line = ChangeTrustAsset::PoolShare( - LiquidityPoolParameters::LiquidityPoolConstantProduct( - LiquidityPoolConstantProductParameters{ - asset_a: asset_a.clone(), - asset_b: asset_b.clone(), - fee - } - ) - ); + let line = ChangeTrustAsset::PoolShare(LiquidityPoolParameters::LiquidityPoolConstantProduct( + LiquidityPoolConstantProductParameters { + asset_a: asset_a.clone(), + asset_b: asset_b.clone(), + fee, + }, + )); let op = Operation { source_account: None, - body: OperationBody::ChangeTrust( - ChangeTrustOp { + body: OperationBody::ChangeTrust(ChangeTrustOp { line: line, - limit: i64::MAX - } - ) + limit: i64::MAX, + }), }; let source: UnresolvedMuxedAccount = test_account_address.parse().unwrap(); - let resolved_source = source.resolve_muxed_account_sync(&locator::Args::default(), None).unwrap(); + let resolved_source = source + .resolve_muxed_account_sync(&locator::Args::default(), None) + .unwrap(); let tx = xdr::Transaction::new_tx(resolved_source, 1000, 1, op).into(); @@ -738,19 +747,18 @@ async fn sign_and_send(sandbox: &TestEnv, sign_with: &str, tx: &str) -> String { fn extract_claimable_balance_id(response: GetTransactionResponse) -> Option { if let Some(result) = response.result { - if let TransactionResult{ + if let TransactionResult { result: TransactionResultResult::TxSuccess(results), .. } = result { - if let Some(OperationResult::OpInner( - OperationResultTr::CreateClaimableBalance(CreateClaimableBalanceResult::Success( - ClaimableBalanceId::ClaimableBalanceIdTypeV0(hash), - )), - )) - = results.first() + if let Some(OperationResult::OpInner(OperationResultTr::CreateClaimableBalance( + CreateClaimableBalanceResult::Success( + ClaimableBalanceId::ClaimableBalanceIdTypeV0(hash), + ), + ))) = results.first() { - return Some(hash.clone()) + return Some(hash.clone()); } } } @@ -777,4 +785,4 @@ fn compute_pool_id(asset_a: Asset, asset_b: Asset, fee: i32) -> Uint256 { let hash = hasher.finalize(); Uint256(hash.into()) -} \ No newline at end of file +} From 742e2ff60d117b5ceb5c1fb661d52fc9835af591 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 12 Jun 2025 15:35:03 -0400 Subject: [PATCH 41/76] Update rust version --- Cargo.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Cargo.toml b/Cargo.toml index bff06b3930..21b17aa226 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -21,7 +21,7 @@ exclude = [ [workspace.package] version = "22.8.1" -rust-version = "1.84.0" +rust-version = "1.85.0" # Dependencies located in this repo: [workspace.dependencies.soroban-cli] From 2c2d5c38e5af5f1b7ab5af566b174b1e34002342 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 19 Jun 2025 14:08:31 -0400 Subject: [PATCH 42/76] Cargo fmt --- cmd/soroban-cli/src/commands/ledger/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/soroban-cli/src/commands/ledger/mod.rs b/cmd/soroban-cli/src/commands/ledger/mod.rs index 80e11b0e03..404bb6eb61 100644 --- a/cmd/soroban-cli/src/commands/ledger/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/mod.rs @@ -1,7 +1,7 @@ use crate::commands::global; use clap::Subcommand; -mod latest; pub mod entry; +mod latest; #[derive(Debug, Subcommand)] pub enum Cmd { From a048e3ef737c106c8a97a4863eb681e8ab6bd298 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 16 Jul 2025 11:26:38 -0400 Subject: [PATCH 43/76] Fix after merging main --- cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs index 8c25702812..4b98b81a56 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -4,7 +4,7 @@ use crate::{ config::{self, locator}, xdr::{ self, ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, - ScAddress, ScVal, + ScAddress, ScVal, ContractId }, }; use clap::{command, Parser}; @@ -56,7 +56,7 @@ impl Cmd { let contract_id = self .contract .resolve_contract_id(&self.args.locator, &network.network_passphrase)?; - let contract_address_arg = ScAddress::Contract(Hash(contract_id.0)); + let contract_address_arg = ScAddress::Contract(ContractId(Hash(contract_id.0))); if let Some(keys) = &self.key { for key in keys { From 0310346a53cb4cc98b1717c3855b120efac18dce Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 16 Jul 2025 14:31:30 -0400 Subject: [PATCH 44/76] Cargo fmt & clippy --- cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs | 4 ++-- cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs | 2 +- cmd/soroban-cli/src/commands/ledger/entry/mod.rs | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs index 4b98b81a56..7ddd0a90bc 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs @@ -3,8 +3,8 @@ use crate::{ commands::contract::Durability, config::{self, locator}, xdr::{ - self, ContractDataDurability, Hash, LedgerKey, LedgerKeyContractData, Limits, ReadXdr, - ScAddress, ScVal, ContractId + self, ContractDataDurability, ContractId, Hash, LedgerKey, LedgerKeyContractData, Limits, + ReadXdr, ScAddress, ScVal, }, }; use clap::{command, Parser}; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 8f1b6f97ad..c67e484ded 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -16,7 +16,7 @@ pub enum Cmd { Account(account::Cmd), /// Fetch contract ledger entry by address or alias and storage key. Contract(contract::Cmd), - /// Fetch the current network config by ConfigSettingId. + /// Fetch the current network config by `ConfigSettingId`. /// All config settings are returned if no id is provided. Config(config::Cmd), ///Fetch a claimable balance ledger entry by id diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs index f99d61fa7b..46e77cf230 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -4,7 +4,7 @@ pub mod fetch; #[derive(Debug, Parser)] pub enum Cmd { /// Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. - /// Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys + /// Read more about the RPC command here: #[command(subcommand)] Fetch(fetch::Cmd), } @@ -19,7 +19,7 @@ impl Cmd { pub async fn run(&self) -> Result<(), Error> { match self { Cmd::Fetch(cmd) => cmd.run().await?, - }; + } Ok(()) } } From 9303416d89edd772a855978fd7fd8412bae0d20e Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 23 Jul 2025 12:54:10 -0400 Subject: [PATCH 45/76] Cargo md gen --- FULL_HELP_DOCS.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 6677fd6811..daf53a5d55 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -2769,13 +2769,13 @@ Work with ledger entries ###### **Subcommands:** -* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys +* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: ## `stellar ledger entry fetch` -Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys +Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: **Usage:** `stellar ledger entry fetch ` @@ -2783,7 +2783,7 @@ Fetch ledger entries. This command supports all types of ledger entries supporte * `account` — Fetch account entry by public key or alias. Additional account-related keys are available with optional flags * `contract` — Fetch contract ledger entry by address or alias and storage key -* `config` — Fetch the current network config by ConfigSettingId. All config settings are returned if no id is provided +* `config` — Fetch the current network config by `ConfigSettingId`. All config settings are returned if no id is provided * `claimable-balance` — Fetch a claimable balance ledger entry by id * `liquidity-pool` — Fetch a liquidity pool ledger entry by id * `wasm` — Fetch WASM bytecode by hash @@ -2875,7 +2875,7 @@ Fetch contract ledger entry by address or alias and storage key ## `stellar ledger entry fetch config` -Fetch the current network config by ConfigSettingId. All config settings are returned if no id is provided +Fetch the current network config by `ConfigSettingId`. All config settings are returned if no id is provided **Usage:** `stellar ledger entry fetch config [OPTIONS] [CONFIG_SETTING_IDS]...` @@ -2894,8 +2894,11 @@ Fetch the current network config by ConfigSettingId. All config settings are ret 9 => ContractDataEntrySizeBytes 10 => StateArchival 11 => ContractExecutionLanes - 12 => BucketlistSizeWindow + 12 => LiveSorobanStateSizeWindow 13 => EvictionIterator + 14 => ContractParallelComputeV0 + 15 => ContractLedgerCostExtV0 + 16 => ScpTiming ###### **Options:** From a4e763de4d28d395360754220f24abcf814c3ab9 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 27 Aug 2025 10:23:56 -0400 Subject: [PATCH 46/76] Update restore to handle live_until_ledger_seq being an optional from rpc client --- cmd/soroban-cli/src/commands/contract/restore.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/soroban-cli/src/commands/contract/restore.rs b/cmd/soroban-cli/src/commands/contract/restore.rs index 3ee48d43bc..af0e24a894 100644 --- a/cmd/soroban-cli/src/commands/contract/restore.rs +++ b/cmd/soroban-cli/src/commands/contract/restore.rs @@ -227,7 +227,7 @@ impl NetworkRunnable for Cmd { if changes.is_empty() { print.infoln("No changes detected, transaction was a no-op."); let entry = client.get_full_ledger_entries(&entry_keys).await?; - let extension = entry.entries[0].live_until_ledger_seq; + let extension = entry.entries[0].live_until_ledger_seq.unwrap_or_default(); return Ok(TxnResult::Res(extension)); } From f82dfaad1ea68b0f3438ec8ccefcf00c388105f4 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 3 Sep 2025 16:06:25 -0400 Subject: [PATCH 47/76] Update generated docs --- FULL_HELP_DOCS.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index a938ca7bbd..0c8e46424c 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -3467,8 +3467,8 @@ Fetch account entry by public key or alias. Additional account-related keys are * `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `-n`, `--network ` — Name of network to use from config -* `--global` — Use global config -* `--config-dir ` — Location of config directory, default is "." +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings * `--output ` — Format of the output Default value: `json` @@ -3505,8 +3505,8 @@ Fetch contract ledger entry by address or alias and storage key * `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `-n`, `--network ` — Name of network to use from config -* `--global` — Use global config -* `--config-dir ` — Location of config directory, default is "." +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings * `--output ` — Format of the output Default value: `json` @@ -3567,8 +3567,8 @@ Fetch the current network config by `ConfigSettingId`. All config settings are r * `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `-n`, `--network ` — Name of network to use from config -* `--global` — Use global config -* `--config-dir ` — Location of config directory, default is "." +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings * `--output ` — Format of the output Default value: `json` @@ -3600,8 +3600,8 @@ Fetch a claimable balance ledger entry by id * `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `-n`, `--network ` — Name of network to use from config -* `--global` — Use global config -* `--config-dir ` — Location of config directory, default is "." +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings * `--output ` — Format of the output Default value: `json` @@ -3633,8 +3633,8 @@ Fetch a liquidity pool ledger entry by id * `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `-n`, `--network ` — Name of network to use from config -* `--global` — Use global config -* `--config-dir ` — Location of config directory, default is "." +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings * `--output ` — Format of the output Default value: `json` @@ -3666,8 +3666,8 @@ Fetch WASM bytecode by hash * `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider * `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server * `-n`, `--network ` — Name of network to use from config -* `--global` — Use global config -* `--config-dir ` — Location of config directory, default is "." +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings * `--output ` — Format of the output Default value: `json` From 30f2c9cfa0698ff1862c9366407b61a42b4b9ec2 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 3 Sep 2025 16:29:59 -0400 Subject: [PATCH 48/76] Fix integration test --- cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index c9bd730e1c..1aa8ac0c40 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -624,7 +624,7 @@ async fn expected_contract_ledger_key(contract_id: &str, storage_key: &str) -> L let contract_bytes: [u8; 32] = Contract::from_string(contract_id).unwrap().0; let contract_id = Hash(contract_bytes); LedgerKey::ContractData(LedgerKeyContractData { - contract: ScAddress::Contract(contract_id), + contract: ScAddress::Contract(contract_id.into()), key: ScVal::Symbol(storage_key.try_into().unwrap()), durability: ContractDataDurability::Persistent, }) From 742625602fb93a152515af051382898445404831 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 4 Sep 2025 10:41:59 -0400 Subject: [PATCH 49/76] Use rpc client main branch --- Cargo.lock | 2 +- Cargo.toml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 12db657638..e0626b6ba5 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4937,7 +4937,7 @@ dependencies = [ [[package]] name = "stellar-rpc-client" version = "23.0.0-rc.6" -source = "git+https://github.com/stellar/rs-stellar-rpc-client?branch=serde-le#058cb550473141df2d9744d7f0caa54f37a2708a" +source = "git+https://github.com/stellar/rs-stellar-rpc-client?branch=main#0070d9c5197c3079a14dcc2860f25737f8731650" dependencies = [ "clap", "hex", diff --git a/Cargo.toml b/Cargo.toml index c4997a3418..651eb3d740 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -75,7 +75,7 @@ version = "23.0.0-rc.3" package = "stellar-rpc-client" version = "23.0.0-rc.6" git = "https://github.com/stellar/rs-stellar-rpc-client" -branch = "serde-le" +branch = "main" # Dependencies from elsewhere shared by crates: [workspace.dependencies] From 8a21fe1d5c0595495191d7730451962d9a15514f Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 4 Sep 2025 11:43:16 -0400 Subject: [PATCH 50/76] Use rpc client v23 --- Cargo.lock | 7 ++++--- Cargo.toml | 4 +--- 2 files changed, 5 insertions(+), 6 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index e0626b6ba5..535a233d61 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4936,8 +4936,9 @@ dependencies = [ [[package]] name = "stellar-rpc-client" -version = "23.0.0-rc.6" -source = "git+https://github.com/stellar/rs-stellar-rpc-client?branch=main#0070d9c5197c3079a14dcc2860f25737f8731650" +version = "23.0.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a0f2413934c66624657094160198b01abe6dc6d0d2a3f9befbb21eeb8fd0b111" dependencies = [ "clap", "hex", @@ -6116,7 +6117,7 @@ version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" dependencies = [ - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] diff --git a/Cargo.toml b/Cargo.toml index 651eb3d740..57f2b77060 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -73,9 +73,7 @@ version = "23.0.0-rc.3" # Dependencies from the rs-stellar-rpc-client repo: [workspace.dependencies.soroban-rpc] package = "stellar-rpc-client" -version = "23.0.0-rc.6" -git = "https://github.com/stellar/rs-stellar-rpc-client" -branch = "main" +version = "23.0.0" # Dependencies from elsewhere shared by crates: [workspace.dependencies] From f666034de4fbff2b6c5ae3dca25bb7433ef4c8cc Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 8 Sep 2025 15:27:41 -0400 Subject: [PATCH 51/76] Update cargo.lock --- Cargo.lock | 2340 +++++++++++++++++++++++++++++++--------------------- 1 file changed, 1400 insertions(+), 940 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 0569fc6939..7cfdd20ad2 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -4,18 +4,18 @@ version = 4 [[package]] name = "addr2line" -version = "0.21.0" +version = "0.24.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8a30b2e23b9e17a9f90641c7ab1549cd9b44f296d3ccbf309d2863cfe398a0cb" +checksum = "dfbe277e56a376000877090da837660b4427aad530e3028d44e0bffe4f89a1c1" dependencies = [ "gimli", ] [[package]] -name = "adler" -version = "1.0.2" +name = "adler2" +version = "2.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f26201604c87b1e01bd3d98f8d5d9a8fcbb815e8cedb41ffccbeb4bf593a35fe" +checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa" [[package]] name = "aes" @@ -30,9 +30,9 @@ dependencies = [ [[package]] name = "ahash" -version = "0.8.11" +version = "0.8.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e89da841a80418a9b391ebaea17f5c112ffaaa96f621d2c285b5174da76b9011" +checksum = "5a15f179cd60c4584b8a8c596927aadc462e27f2ca70c04e0071964a73ba7a75" dependencies = [ "cfg-if", "once_cell", @@ -49,12 +49,6 @@ dependencies = [ "memchr", ] -[[package]] -name = "android-tzdata" -version = "0.1.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e999941b234f3131b00bc13c22d06e8c5ff726d1b6318ac7eb276997bbb4fef0" - [[package]] name = "android_system_properties" version = "0.1.5" @@ -66,9 +60,9 @@ dependencies = [ [[package]] name = "anstream" -version = "0.6.15" +version = "0.6.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "64e15c1ab1f89faffbf04a634d5e1962e9074f2741eef6d97f3c4e322426d526" +checksum = "3ae563653d1938f79b1ab1b5e668c87c76a9930414574a6583a7b7e11a8e6192" dependencies = [ "anstyle", "anstyle-parse", @@ -81,43 +75,44 @@ dependencies = [ [[package]] name = "anstyle" -version = "1.0.8" +version = "1.0.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1bec1de6f59aedf83baf9ff929c98f2ad654b97c9510f4e70cf6f661d49fd5b1" +checksum = "862ed96ca487e809f1c8e5a8447f6ee2cf102f846893800b20cebdf541fc6bbd" [[package]] name = "anstyle-parse" -version = "0.2.5" +version = "0.2.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "eb47de1e80c2b463c735db5b217a0ddc39d612e7ac9e2e96a5aed1f57616c1cb" +checksum = "4e7644824f0aa2c7b9384579234ef10eb7efb6a0deb83f9630a49594dd9c15c2" dependencies = [ "utf8parse", ] [[package]] name = "anstyle-query" -version = "1.1.1" +version = "1.1.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6d36fc52c7f6c869915e99412912f22093507da8d9e942ceaf66fe4b7c14422a" +checksum = "9e231f6134f61b71076a3eab506c379d4f36122f2af15a9ff04415ea4c3339e2" dependencies = [ - "windows-sys 0.52.0", + "windows-sys 0.60.2", ] [[package]] name = "anstyle-wincon" -version = "3.0.4" +version = "3.0.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5bf74e1b6e971609db8ca7a9ce79fd5768ab6ae46441c572e46cf596f59e57f8" +checksum = "3e0633414522a32ffaac8ac6cc8f748e090c5717661fddeea04219e2344f5f2a" dependencies = [ "anstyle", - "windows-sys 0.52.0", + "once_cell_polyfill", + "windows-sys 0.60.2", ] [[package]] name = "anyhow" -version = "1.0.86" +version = "1.0.99" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b3d1d046238990b9cf5bcde22a3fb3584ee5cf65fb2765f454ed428c7a0063da" +checksum = "b0674a1ddeecb70197781e945de4b3b8ffb61fa939a5597bcf48503737663100" [[package]] name = "arbitrary" @@ -248,9 +243,9 @@ dependencies = [ [[package]] name = "arrayref" -version = "0.3.8" +version = "0.3.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9d151e35f61089500b617991b791fc8bfd237ae50cd5950803758a179b41e67a" +checksum = "76a2e8124351fda1ef8aaaa3bbd7ebbcb486bbcd4225aca0aa0d84bb2db8fecb" [[package]] name = "ascii-canvas" @@ -273,9 +268,9 @@ dependencies = [ [[package]] name = "assert_cmd" -version = "2.0.16" +version = "2.0.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dc1835b7f27878de8525dc71410b5a31cdcc5f230aed5ba5df968e09c201b23d" +checksum = "2bd389a4b2970a01282ee455294913c0a43724daedcd1a24c3eb0ec1c1320b66" dependencies = [ "anstyle", "bstr", @@ -289,9 +284,9 @@ dependencies = [ [[package]] name = "assert_fs" -version = "1.1.2" +version = "1.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7efdb1fdb47602827a342857666feb372712cbc64b414172bd6b167a02927674" +checksum = "a652f6cb1f516886fcfee5e7a5c078b9ade62cfcb889524efe5a64d682dd27a9" dependencies = [ "anstyle", "doc-comment", @@ -318,7 +313,7 @@ version = "0.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "435a87a52755b8f27fcf321ac4f04b2802e337c8c4872923137471ec39c37532" dependencies = [ - "event-listener 5.3.1", + "event-listener 5.4.1", "event-listener-strategy", "futures-core", "pin-project-lite", @@ -337,9 +332,9 @@ dependencies = [ [[package]] name = "async-channel" -version = "2.3.1" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "89b47800b0be77592da0afd425cc03468052844aff33b84e33cc696f64e77b6a" +checksum = "924ed96dd52d1b75e9c1a3e6275715fd320f5f9439fb5a4a11fa51f4221158d2" dependencies = [ "concurrent-queue", "event-listener-strategy", @@ -349,27 +344,28 @@ dependencies = [ [[package]] name = "async-compression" -version = "0.4.12" +version = "0.4.30" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fec134f64e2bc57411226dfc4e52dec859ddfc7e711fc5e07b612584f000e4aa" +checksum = "977eb15ea9efd848bb8a4a1a2500347ed7f0bf794edf0dc3ddcf439f43d36b23" dependencies = [ - "flate2", + "compression-codecs", + "compression-core", "futures-core", - "memchr", "pin-project-lite", "tokio", ] [[package]] name = "async-executor" -version = "1.13.0" +version = "1.13.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d7ebdfa2ebdab6b1760375fa7d6f382b9f486eac35fc994625a00e89280bdbb7" +checksum = "497c00e0fd83a72a79a39fcbd8e3e2f055d6f6c7e025f3b3d91f4f8e76527fb8" dependencies = [ "async-task", "concurrent-queue", "fastrand", "futures-lite", + "pin-project-lite", "slab", ] @@ -379,7 +375,7 @@ version = "2.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "05b1b633a2115cd122d73b955eadd9916c18c8f510ec9cd1686404c60ad1c29c" dependencies = [ - "async-channel 2.3.1", + "async-channel 2.5.0", "async-executor", "async-io", "async-lock", @@ -390,9 +386,9 @@ dependencies = [ [[package]] name = "async-io" -version = "2.3.3" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d6baa8f0178795da0e71bc42c9e5d13261aac7ee549853162e66a241ba17964" +checksum = "19634d6336019ef220f09fd31168ce5c184b295cbf80345437cc36094ef223ca" dependencies = [ "async-lock", "cfg-if", @@ -401,49 +397,47 @@ dependencies = [ "futures-lite", "parking", "polling", - "rustix", + "rustix 1.0.8", "slab", - "tracing", - "windows-sys 0.52.0", + "windows-sys 0.60.2", ] [[package]] name = "async-lock" -version = "3.4.0" +version = "3.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff6e472cdea888a4bd64f342f09b3f50e1886d32afe8df3d663c01140b811b18" +checksum = "5fd03604047cee9b6ce9de9f70c6cd540a0520c813cbd49bae61f33ab80ed1dc" dependencies = [ - "event-listener 5.3.1", + "event-listener 5.4.1", "event-listener-strategy", "pin-project-lite", ] [[package]] name = "async-object-pool" -version = "0.1.4" +version = "0.1.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "aeb901c30ebc2fc4ab46395bbfbdba9542c16559d853645d75190c3056caf3bc" +checksum = "333c456b97c3f2d50604e8b2624253b7f787208cb72eb75e64b0ad11b221652c" dependencies = [ "async-std", ] [[package]] name = "async-process" -version = "2.3.0" +version = "2.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "63255f1dc2381611000436537bbedfe83183faa303a5a0edaf191edef06526bb" +checksum = "65daa13722ad51e6ab1a1b9c01299142bc75135b337923cfa10e79bbbd669f00" dependencies = [ - "async-channel 2.3.1", + "async-channel 2.5.0", "async-io", "async-lock", "async-signal", "async-task", "blocking", "cfg-if", - "event-listener 5.3.1", + "event-listener 5.4.1", "futures-lite", - "rustix", - "tracing", + "rustix 1.0.8", ] [[package]] @@ -459,9 +453,9 @@ dependencies = [ [[package]] name = "async-signal" -version = "0.2.9" +version = "0.2.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "dfb3634b73397aa844481f814fad23bbf07fdb0eabec10f2eb95e58944b1ec32" +checksum = "f567af260ef69e1d52c2b560ce0ea230763e6fbb9214a85d768760a920e3e3c1" dependencies = [ "async-io", "async-lock", @@ -469,17 +463,17 @@ dependencies = [ "cfg-if", "futures-core", "futures-io", - "rustix", + "rustix 1.0.8", "signal-hook-registry", "slab", - "windows-sys 0.52.0", + "windows-sys 0.60.2", ] [[package]] name = "async-std" -version = "1.13.0" +version = "1.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c634475f29802fde2b8f0b505b1bd00dfe4df7d4a000f0b36f7671197d5c3615" +checksum = "2c8e079a4ab67ae52b7403632e4618815d6db36d2a010cfe41b02c1b1578f93b" dependencies = [ "async-attributes", "async-channel 1.9.0", @@ -511,9 +505,9 @@ checksum = "8b75356056920673b02621b35afd0f7dda9306d03c79a30f5c56c44cf256e3de" [[package]] name = "async-trait" -version = "0.1.76" +version = "0.1.89" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "531b97fb4cd3dfdce92c35dedbfdc1f0b9d8091c8ca943d6dae340ef5012d514" +checksum = "9035ad2d096bed7955a320ee7e2230574d28fd3c3a0f186cbea1ff3c7eed5dbb" dependencies = [ "proc-macro2", "quote", @@ -528,23 +522,23 @@ checksum = "1505bd5d3d116872e7271a6d4e16d81d0c8570876c8de68093a09ac269d8aac0" [[package]] name = "autocfg" -version = "1.3.0" +version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0c4b4d0bd25bd0b74681c0ad21497610ce1b7c91b1022cd21c80c6fbdd9476b0" +checksum = "c08606f8c3cbf4ce6ec8e28fb0014a2c086708fe954eaa885384a6165172e7e8" [[package]] name = "backtrace" -version = "0.3.69" +version = "0.3.75" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2089b7e3f35b9dd2d0ed921ead4f6d318c27680d4a5bd167b3ee120edb105837" +checksum = "6806a6321ec58106fea15becdad98371e28d92ccbc7c8f1b3b6dd724fe8f1002" dependencies = [ "addr2line", - "cc", "cfg-if", "libc", "miniz_oxide", "object", "rustc-demangle", + "windows-targets 0.52.6", ] [[package]] @@ -573,9 +567,9 @@ checksum = "72b3254f16251a8381aa12e40e3c4d2f0199f8c6508fbecb9d91f575e0fbb8c6" [[package]] name = "base64ct" -version = "1.6.0" +version = "1.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8c3c1a368f70d6cf7302d78f8f7093da241fb8e8807c05cc9e51a125895a6d5b" +checksum = "55248b47b0caf0546f7988906588779981c43bb1bc9d0c44087278f80cdb44ba" [[package]] name = "basic-cookies" @@ -614,9 +608,9 @@ checksum = "349f9b6a179ed607305526ca489b34ad0a41aed5f7980fa90eb03160b69598fb" [[package]] name = "bitflags" -version = "2.6.0" +version = "2.9.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de" +checksum = "2261d10cca569e4643e526d8dc2e62e433cc8aba21ab764233731f8d369bf394" [[package]] name = "block-buffer" @@ -647,11 +641,11 @@ dependencies = [ [[package]] name = "blocking" -version = "1.6.1" +version = "1.6.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "703f41c54fc768e63e091340b424302bb1c29ef4aa0c7f10fe849dfb114d29ea" +checksum = "e83f8d02be6967315521be875afa792a316e28d57b5a2d401897e2a7921b7f21" dependencies = [ - "async-channel 2.3.1", + "async-channel 2.5.0", "async-task", "futures-io", "futures-lite", @@ -671,9 +665,9 @@ dependencies = [ "futures-util", "hex", "home", - "http 1.1.0", + "http 1.3.1", "http-body-util", - "hyper 1.4.1", + "hyper 1.7.0", "hyper-named-pipe", "hyper-rustls 0.26.0", "hyper-util", @@ -682,14 +676,14 @@ dependencies = [ "pin-project-lite", "rustls 0.22.4", "rustls-native-certs 0.7.3", - "rustls-pemfile 2.1.3", + "rustls-pemfile 2.2.0", "rustls-pki-types", "serde", "serde_derive", "serde_json", "serde_repr", "serde_urlencoded", - "thiserror", + "thiserror 1.0.69", "tokio", "tokio-util", "tower-service", @@ -710,9 +704,9 @@ dependencies = [ [[package]] name = "bstr" -version = "1.10.0" +version = "1.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "40723b8fb387abc38f4f4a37c09073622e41dd12327033091ef8950659e6dc0c" +checksum = "234113d19d0d7d613b40e86fb654acf958910802bcceab913a4f9e7cda03b1a4" dependencies = [ "memchr", "regex-automata", @@ -721,9 +715,9 @@ dependencies = [ [[package]] name = "bumpalo" -version = "3.16.0" +version = "3.19.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "79296716171880943b8470b5f8d03aa55eb2e645a4874bdbb28adb49162e012c" +checksum = "46c5e41b57b8bba42a04676d81cb89e9ee8e859a1a66f80a5a72e1cb76b34d43" [[package]] name = "byteorder" @@ -739,9 +733,9 @@ checksum = "1fd0f2584146f6f2ef48085050886acf353beff7305ebd1ae69500e27c67f64b" [[package]] name = "bytes" -version = "1.7.1" +version = "1.10.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8318a53db07bb3f8dca91a600466bdb3f2eaadeedfdbcf02e1accbad9271ba50" +checksum = "d71b6127be86fdcfddb610f7182ac57211d4b18a3e9c82eb2d17662f2227ad6a" [[package]] name = "bytes-lit" @@ -757,24 +751,24 @@ dependencies = [ [[package]] name = "bytesize" -version = "1.3.0" +version = "1.3.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a3e368af43e418a04d52505cf3dbc23dda4e3407ae2fa99fd0e4f308ce546acc" +checksum = "2e93abca9e28e0a1b9877922aacb20576e05d4679ffa78c3d6dc22a26a216659" [[package]] name = "camino" -version = "1.1.7" +version = "1.1.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e0ec6b951b160caa93cc0c7b209e5a3bff7aae9062213451ac99493cd844c239" +checksum = "dd0b03af37dad7a14518b7691d81acb0f8222604ad3d1b02f6b4bed5188c0cd5" dependencies = [ "serde", ] [[package]] name = "cargo-platform" -version = "0.1.6" +version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ceed8ef69d8518a5dda55c07425450b58a4e1946f4951eab6d7191ee86c2443d" +checksum = "e35af189006b9c0f00a064685c727031e3ed2d8020f7ba284d78cc2671bd36ea" dependencies = [ "serde", ] @@ -790,7 +784,7 @@ dependencies = [ "semver", "serde", "serde_json", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -804,10 +798,11 @@ dependencies = [ [[package]] name = "cc" -version = "1.2.16" +version = "1.2.36" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "be714c154be609ec7f5dad223a33bf1482fff90472de28f7362806e6d4832b8c" +checksum = "5252b3d2648e5eedbc1a6f501e3c795e07025c1e93bbf8bbdd6eef7f447a6d54" dependencies = [ + "find-msvc-tools", "jobserver", "libc", "shlex", @@ -815,9 +810,15 @@ dependencies = [ [[package]] name = "cfg-if" -version = "1.0.0" +version = "1.0.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2fd1289c04a9ea8cb22300a459a72a385d7c73d3259e2ed7dcb2af674838cfa9" + +[[package]] +name = "cfg_aliases" +version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "baf1de4339761588bc0619e3cbc0120ee582ebb74b53b4efbf79117bd2da40fd" +checksum = "613afe47fcd5fac7ccf1db93babcb082c5994d996f20b8b159f2ad1658eb5724" [[package]] name = "cfg_eval" @@ -832,17 +833,16 @@ dependencies = [ [[package]] name = "chrono" -version = "0.4.38" +version = "0.4.42" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a21f936df1771bf62b77f047b726c4625ff2e8aa607c01ec06e5a05bd8463401" +checksum = "145052bdd345b87320e369255277e3fb5152762ad123a901ef5c262dd38fe8d2" dependencies = [ - "android-tzdata", "iana-time-zone", "js-sys", "num-traits", "serde", "wasm-bindgen", - "windows-targets 0.52.6", + "windows-link 0.2.0", ] [[package]] @@ -857,9 +857,9 @@ dependencies = [ [[package]] name = "clap" -version = "4.5.14" +version = "4.5.47" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c937d4061031a6d0c8da4b9a4f98a172fc2976dfb1c19213a9cf7d0d3c837e36" +checksum = "7eac00902d9d136acd712710d71823fb8ac8004ca445a89e73a41d45aa712931" dependencies = [ "clap_builder", "clap_derive", @@ -876,9 +876,9 @@ dependencies = [ [[package]] name = "clap_builder" -version = "4.5.14" +version = "4.5.47" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "85379ba512b21a328adf887e85f7742d12e96eb31f3ef077df4ffc26b506ffed" +checksum = "2ad9bbf750e73b5884fb8a211a9424a1906c1e156724260fdae972f31d70e1d6" dependencies = [ "anstream", "anstyle", @@ -888,18 +888,18 @@ dependencies = [ [[package]] name = "clap_complete" -version = "4.5.13" +version = "4.5.57" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "aa3c596da3cf0983427b0df0dba359df9182c13bd5b519b585a482b0c351f4e8" +checksum = "4d9501bd3f5f09f7bbee01da9a511073ed30a80cd7a509f1214bb74eadea71ad" dependencies = [ "clap", ] [[package]] name = "clap_derive" -version = "4.5.13" +version = "4.5.47" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "501d359d5f3dcaf6ecdeee48833ae73ec6e42723a1e52419c79abf9507eec0a0" +checksum = "bbfd7eae0b0f1a6e63d4b13c9c478de77c2eb546fba158ad50b4203dc24b9f9c" dependencies = [ "heck 0.5.0", "proc-macro2", @@ -909,36 +909,53 @@ dependencies = [ [[package]] name = "clap_lex" -version = "0.7.2" +version = "0.7.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1462739cb27611015575c0c11df5df7601141071f07518d56fcc1be504cbec97" +checksum = "b94f61472cee1439c0b966b47e3aca9ae07e45d070759512cd390ea2bebc6675" [[package]] name = "codespan-reporting" -version = "0.11.1" +version = "0.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3538270d33cc669650c4b093848450d380def10c331d38c768e34cac80576e6e" +checksum = "fe6d2e5af09e8c8ad56c969f2157a3d4238cebc7c55f0a517728c38f7b200f81" dependencies = [ + "serde", "termcolor", - "unicode-width", + "unicode-width 0.2.1", ] [[package]] name = "colorchoice" -version = "1.0.2" +version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d3fd119d74b830634cea2a0f58bbd0d54540518a14397557951e79340abc28c0" +checksum = "b05b61dc5112cbb17e4b6cd61790d9845d13888356391624cbe7e41efeac1e75" [[package]] name = "colored" -version = "2.1.0" +version = "3.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cbf2150cce219b664a8a70df7a1f933836724b503f8a413af9365b4dcc4d90b8" +checksum = "fde0e0ec90c9dfb3b4b1a0891a7dcd0e2bffde2f7efed5fe7c9bb00e5bfb915e" dependencies = [ - "lazy_static", - "windows-sys 0.48.0", + "windows-sys 0.59.0", +] + +[[package]] +name = "compression-codecs" +version = "0.4.30" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "485abf41ac0c8047c07c87c72c8fb3eb5197f6e9d7ded615dfd1a00ae00a0f64" +dependencies = [ + "compression-core", + "flate2", + "memchr", ] +[[package]] +name = "compression-core" +version = "0.4.29" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e47641d3deaf41fb1538ac1f54735925e275eaf3bf4d55c81b137fba797e5cbb" + [[package]] name = "concurrent-queue" version = "2.5.0" @@ -964,17 +981,27 @@ dependencies = [ "libc", ] +[[package]] +name = "core-foundation" +version = "0.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b2a6cd9ae233e7f62ba4e9353e81a88df7fc8a5987b8d445b4d90c879bd156f6" +dependencies = [ + "core-foundation-sys", + "libc", +] + [[package]] name = "core-foundation-sys" -version = "0.8.6" +version = "0.8.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "06ea2b9bc92be3c2baa9334a323ebca2d6f074ff852cd1d7b11064035cd3868f" +checksum = "773648b94d0e5d620f64f280777445740e61fe701025087ec8b57f45c791888b" [[package]] name = "cpufeatures" -version = "0.2.12" +version = "0.2.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "53fe5e26ff1b7aef8bca9c6080520cfb8d9333c7568e1829cef191a9723e5504" +checksum = "59ed5838eebb26a2bb2e58f6d5b5316989ae9d08bab10e0e6d103e656d1b0280" dependencies = [ "libc", ] @@ -992,13 +1019,19 @@ dependencies = [ [[package]] name = "crc32fast" -version = "1.4.2" +version = "1.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a97769d94ddab943e4510d138150169a2758b5ef3eb191a9ee688de3e23ef7b3" +checksum = "9481c1c90cbf2ac953f07c8d4a58aa3945c425b7185c9154d67a65e4230da511" dependencies = [ "cfg-if", ] +[[package]] +name = "critical-section" +version = "1.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "790eea4361631c5e7d22598ecd5723ff611904e3344ce8720784c93e3d83d40b" + [[package]] name = "crossbeam-channel" version = "0.5.15" @@ -1010,9 +1043,9 @@ dependencies = [ [[package]] name = "crossbeam-deque" -version = "0.8.5" +version = "0.8.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "613f8cc01fe9cf1a3eb3d7f488fd2fa8388403e97039e2f73692932e291a770d" +checksum = "9dd111b7b7f7d55b72c0a6ae361660ee5853c9af73f70c3c2ef6858b950e2e51" dependencies = [ "crossbeam-epoch", "crossbeam-utils", @@ -1029,9 +1062,9 @@ dependencies = [ [[package]] name = "crossbeam-utils" -version = "0.8.20" +version = "0.8.21" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "22ec99545bb0ed0ea7bb9b8e1e9122ea386ff8a48c0922e43f36d45ab09e0e80" +checksum = "d0a5c400df2834b80a4c3327b3aad3a4c4cd4de0629063962b03235697506a28" [[package]] name = "crunchy" @@ -1073,9 +1106,9 @@ dependencies = [ [[package]] name = "csv" -version = "1.3.0" +version = "1.3.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ac574ff4d437a7b5ad237ef331c17ccca63c46479e5b5453eb8e10bb99a759fe" +checksum = "acdc4883a9c96732e4733212c01447ebd805833b7275a73ca3ee080fd77afdaf" dependencies = [ "csv-core", "itoa", @@ -1085,9 +1118,9 @@ dependencies = [ [[package]] name = "csv-core" -version = "0.1.11" +version = "0.1.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5efa2b3d7902f4b634a20cae3c9c4e6209dc4779feb6863329607560143efa70" +checksum = "7d02f3b0da4c6504f86e9cd789d8dbafab48c2321be74e9987593de5a894d93d" dependencies = [ "memchr", ] @@ -1131,53 +1164,71 @@ dependencies = [ [[package]] name = "cxx" -version = "1.0.112" +version = "1.0.179" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "58ab30434ea0ff6aa640a08dda5284026a366d47565496fd40b6cbfbdd7e31a2" +checksum = "85b04ade63e106c145cdcd3482932299c2dcd36b15f1d5c596c06edf365966fe" dependencies = [ "cc", + "cxxbridge-cmd", "cxxbridge-flags", "cxxbridge-macro", + "foldhash", "link-cplusplus", ] [[package]] name = "cxx-build" -version = "1.0.112" +version = "1.0.179" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b649d7dfae8268450d53d109388b337b9352c7cba1fc10db4a1bc23c3dc189fb" +checksum = "ba16a03d510b0e52be1952831ae1656e3ac9f6ac0c293a7b261670a0c7ff3b54" dependencies = [ "cc", "codespan-reporting", - "once_cell", + "indexmap 2.11.0", "proc-macro2", "quote", "scratch", "syn 2.0.106", ] +[[package]] +name = "cxxbridge-cmd" +version = "1.0.179" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1c3aefd0d58a2df90cd67fe2eccdf7fb6e6905e9886ae5feb2258ce0dec23063" +dependencies = [ + "clap", + "codespan-reporting", + "indexmap 2.11.0", + "proc-macro2", + "quote", + "syn 2.0.106", +] + [[package]] name = "cxxbridge-flags" -version = "1.0.112" +version = "1.0.179" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "42281b20eba5218c539295c667c18e2f50211bb11902419194c6ed1ae808e547" +checksum = "0b735d976ca632f9e94b9de9b0ab8283de65e2641e7ae9d5abc3e6b467ea6673" [[package]] name = "cxxbridge-macro" -version = "1.0.112" +version = "1.0.179" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b45506e3c66512b0a65d291a6b452128b7b1dd9841e20d1e151addbd2c00ea50" +checksum = "42fffb686dc0b7bab364ee41fcf5a04c295c7e7a5f07cd38155c1c3bda437666" dependencies = [ + "indexmap 2.11.0", "proc-macro2", "quote", + "rustversion", "syn 2.0.106", ] [[package]] name = "darling" -version = "0.20.10" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6f63b86c8a8826a49b8c21f08a2d07338eec8d900540f8630dc76284be802989" +checksum = "fc7f46116c46ff9ab3eb1597a45688b6715c6e628b5c133e288e709a29bcb4ee" dependencies = [ "darling_core", "darling_macro", @@ -1185,9 +1236,9 @@ dependencies = [ [[package]] name = "darling_core" -version = "0.20.10" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "95133861a8032aaea082871032f5815eb9e98cef03fa916ab4500513994df9e5" +checksum = "0d00b9596d185e565c2207a0b01f8bd1a135483d02d9b7b0a54b11da8d53412e" dependencies = [ "fnv", "ident_case", @@ -1199,9 +1250,9 @@ dependencies = [ [[package]] name = "darling_macro" -version = "0.20.10" +version = "0.20.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d336a2a514f6ccccaa3e09b02d41d35330c07ddf03a62165fcec10bb561c7806" +checksum = "fc34b93ccb385b40dc71c6fceac4b2ad23662c7eeb248cf10d529b7e055b6ead" dependencies = [ "darling_core", "quote", @@ -1210,44 +1261,44 @@ dependencies = [ [[package]] name = "data-encoding" -version = "2.6.0" +version = "2.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e8566979429cf69b49a5c740c60791108e86440e8be149bbea4fe54d2c32d6e2" +checksum = "2a2330da5de22e8a3cb63252ce2abb30116bf5265e89c0e01bc17015ce30a476" [[package]] name = "dbus" -version = "0.9.7" +version = "0.9.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1bb21987b9fb1613058ba3843121dd18b163b254d8a6e797e144cbac14d96d1b" +checksum = "190b6255e8ab55a7b568df5a883e9497edc3e4821c06396612048b430e5ad1e9" dependencies = [ "libc", "libdbus-sys", - "winapi", + "windows-sys 0.59.0", ] [[package]] name = "dbus-secret-service" -version = "4.0.3" +version = "4.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b42a16374481d92aed73ae45b1f120207d8e71d24fb89f357fadbd8f946fd84b" +checksum = "708b509edf7889e53d7efb0ffadd994cc6c2345ccb62f55cfd6b0682165e4fa6" dependencies = [ "aes", "block-padding", "cbc", "dbus", - "futures-util", + "fastrand", "hkdf", "num", "once_cell", - "rand 0.8.5", "sha2 0.10.9", + "zeroize", ] [[package]] name = "der" -version = "0.7.9" +version = "0.7.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f55bf8e7b65898637379c1b74eb1551107c8294ed26d855ceb9fd1a09cfc9bc0" +checksum = "e7c1832837b905bbfb5101e07cc24c8deddf52f93225eee6ead5f4d63d53ddcb" dependencies = [ "const-oid", "zeroize", @@ -1255,9 +1306,9 @@ dependencies = [ [[package]] name = "deranged" -version = "0.3.11" +version = "0.5.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b42b6fa04a440b495c8b04d0e71b707c585f83cb9cb28cf8cd0d976c315e31b4" +checksum = "d630bccd429a5bb5a64b5e94f693bfc48c9f8566418fda4c494cc94f911f87cc" dependencies = [ "powerfmt", "serde", @@ -1388,9 +1439,9 @@ checksum = "fea41bba32d969b513997752735605054bc0dfa92b4c56bf1189f2e174be7a10" [[package]] name = "docker_credential" -version = "1.3.1" +version = "1.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "31951f49556e34d90ed28342e1df7e1cb7a229c4cab0aecc627b5d91edd41d07" +checksum = "1d89dfcba45b4afad7450a99b39e751590463e45c04728cf555d36bb66940de8" dependencies = [ "base64 0.21.7", "serde", @@ -1411,9 +1462,9 @@ checksum = "75b325c5dbd37f80359721ad39aca5a29fb04c89279657cffdda8736d0c0b9d2" [[package]] name = "dyn-clone" -version = "1.0.17" +version = "1.0.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d6ef0072f8a535281e4876be788938b528e9a1d43900b82c2569af7da799125" +checksum = "d0881ea181b1df73ff77ffaaf9c7544ecc11e82fba9b5f27b262a3c73a332555" [[package]] name = "ecdsa" @@ -1440,9 +1491,9 @@ dependencies = [ [[package]] name = "ed25519-dalek" -version = "2.1.1" +version = "2.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4a3daa8e81a3963a60642bcc1f90a670680bd4a77535faa384e9d1c79d620871" +checksum = "70e796c081cee67dc755e1a36a0a172b897fab85fc3f6bc48307991f64e4eca9" dependencies = [ "curve25519-dalek", "ed25519", @@ -1455,9 +1506,9 @@ dependencies = [ [[package]] name = "either" -version = "1.13.0" +version = "1.15.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "60b1af1c220855b6ceac025d3f6ecdd2b7c4894bfe9cd9bda4fbb4bc7c0d4cf0" +checksum = "48c757948c5ede0e46177b7add2e67155f70e33c07fea8284df6576da70b3719" [[package]] name = "elliptic-curve" @@ -1494,9 +1545,9 @@ checksum = "34aa73646ffb006b8f5147f3dc182bd4bcb190227ce861fc4a4844bf8e3cb2c0" [[package]] name = "encoding_rs" -version = "0.8.34" +version = "0.8.35" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b45de904aa0b010bce2ab45264d0631681847fa7b6f2eaa7dab7619943bc4f59" +checksum = "75030f3c4f45dafd7586dd6780965a8c7e8e285a5ecb86713e63a79c5b2766f3" dependencies = [ "cfg-if", ] @@ -1542,9 +1593,9 @@ dependencies = [ [[package]] name = "env_filter" -version = "0.1.2" +version = "0.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4f2c92ceda6ceec50f43169f9ee8424fe2db276791afde7b2cd8bc084cb376ab" +checksum = "186e05a59d4c50738528153b83b0b0194d3a29507dfec16eccd4b342903397d0" dependencies = [ "log", "regex", @@ -1552,31 +1603,31 @@ dependencies = [ [[package]] name = "env_logger" -version = "0.11.5" +version = "0.11.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e13fa619b91fb2381732789fc5de83b45675e882f66623b7d8cb4f643017018d" +checksum = "13c863f0904021b108aa8b2f55046443e6b1ebde8fd4a15c399893aae4fa069f" dependencies = [ "anstream", "anstyle", "env_filter", - "humantime", + "jiff", "log", ] [[package]] name = "equivalent" -version = "1.0.1" +version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5443807d6dff69373d433ab9ef5378ad8df50ca6298caf15de6e52e24aaf54d5" +checksum = "877a4ace8713b0bcf2a4e7eec82529c029f1d0619886d18145fea96c3ffe5c0f" [[package]] name = "errno" -version = "0.3.9" +version = "0.3.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "534c5cf6194dfab3db3242765c03bbe257cf92f22b38f6bc0c58d59108a820ba" +checksum = "778e2ac28f6c47af28e4907f13ffd1e1ddbd400980a9abd7c8df189bf578a5ad" dependencies = [ "libc", - "windows-sys 0.52.0", + "windows-sys 0.60.2", ] [[package]] @@ -1587,9 +1638,9 @@ checksum = "2bfcf67fea2815c2fc3b90873fae90957be12ff417335dfadc7f52927feb03b2" [[package]] name = "ethnum" -version = "1.5.0" +version = "1.5.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b90ca2580b73ab6a1f724b76ca11ab632df820fd6040c336200d2c1df7b3c82c" +checksum = "ca81e6b4777c89fd810c25a4be2b1bd93ea034fbe58e6a75216a34c6b82c539b" [[package]] name = "event-listener" @@ -1599,9 +1650,9 @@ checksum = "0206175f82b8d6bf6652ff7d71a1e27fd2e4efde587fd368662814d6ec1d9ce0" [[package]] name = "event-listener" -version = "5.3.1" +version = "5.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6032be9bd27023a771701cc49f9f053c751055f71efb2e0ae5c15809093675ba" +checksum = "e13b66accf52311f30a0db42147dadea9850cb48cd070028831ae5f5d4b856ab" dependencies = [ "concurrent-queue", "parking", @@ -1610,25 +1661,25 @@ dependencies = [ [[package]] name = "event-listener-strategy" -version = "0.5.2" +version = "0.5.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0f214dc438f977e6d4e3500aaa277f5ad94ca83fbbd9b1a15713ce2344ccc5a1" +checksum = "8be9f3dfaaffdae2972880079a491a1a8bb7cbed0b8dd7a347f668b4150a3b93" dependencies = [ - "event-listener 5.3.1", + "event-listener 5.4.1", "pin-project-lite", ] [[package]] name = "fastrand" -version = "2.1.0" +version = "2.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9fc0510504f03c51ada170672ac806f1f105a88aa97a5281117e1ddc3368e51a" +checksum = "37909eebbb50d72f9059c3b6d82c0463f2ff062c9e95845c43a6c9c0355411be" [[package]] name = "ff" -version = "0.13.0" +version = "0.13.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ded41244b729663b1e574f1b4fb731469f69f79c17667b5d776b16cda0479449" +checksum = "c0b50bfb653653f9ca9095b427bed08ab8d75a137839d9ad64eb11810d5b6393" dependencies = [ "rand_core 0.6.4", "subtle", @@ -1640,6 +1691,12 @@ version = "0.2.9" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "28dea519a9695b9977216879a3ebfddf92f1c08c05d984f8996aecd6ecdc811d" +[[package]] +name = "find-msvc-tools" +version = "0.1.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7fd99930f64d146689264c637b5af2f0233a933bef0d8570e2526bf9e083192d" + [[package]] name = "fixedbitset" version = "0.4.2" @@ -1648,9 +1705,9 @@ checksum = "0ce7134b9999ecaf8bcd65542e436736ef32ddca1b3e06094cb6ec5755203b80" [[package]] name = "flate2" -version = "1.0.31" +version = "1.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7f211bbe8e69bbd0cfdea405084f128ae8b4aaa6b0b522fc8f2b009084797920" +checksum = "4a3d7db9596fecd151c5f638c0ee5d5bd487b6e0ea232e5dc96d5250f6f94b1d" dependencies = [ "crc32fast", "miniz_oxide", @@ -1658,9 +1715,9 @@ dependencies = [ [[package]] name = "float-cmp" -version = "0.9.0" +version = "0.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "98de4bbd547a563b716d8dfa9aad1cb19bfab00f4fa09a6a4ed21dbcf44ce9c4" +checksum = "b09cf3155332e944990140d967ff5eceb70df778b34f77d8075db46e4704e6d8" dependencies = [ "num-traits", ] @@ -1671,6 +1728,12 @@ version = "1.0.7" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3f9eec918d3f24069decb9af1554cad7c880e2da24a9afd88aca000531ab82c1" +[[package]] +name = "foldhash" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "77ce24cb58228fbb8aa041425bb1050850ac19177686ea6e0f41a70416f56fdb" + [[package]] name = "foreign-types" version = "0.3.2" @@ -1688,9 +1751,9 @@ checksum = "00b0228411908ca8685dba7fc2cdd70ec9990a6e753e89b6ac91a84c40fbaf4b" [[package]] name = "form_urlencoded" -version = "1.2.1" +version = "1.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e13624c2627564efccf4934284bdd98cbaa14e79b0b5a141218e507b3a823456" +checksum = "cb4cb245038516f5f85277875cdaa4f7d2c9a0fa0468de06ed190163b1581fcf" dependencies = [ "percent-encoding", ] @@ -1709,9 +1772,9 @@ checksum = "42703706b716c37f96a77aea830392ad231f44c9e9a67872fa5548707e11b11c" [[package]] name = "futures" -version = "0.3.30" +version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "645c6916888f6cb6350d2550b80fb63e734897a8498abe35cfb732b6487804b0" +checksum = "65bc07b1a8bc7c85c5f2e110c476c7389b4554ba72af57d8445ea63a576b0876" dependencies = [ "futures-channel", "futures-core", @@ -1740,9 +1803,9 @@ checksum = "05f29059c0c2090612e8d742178b0580d2dc940c837851ad723096f87af6663e" [[package]] name = "futures-executor" -version = "0.3.30" +version = "0.3.31" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a576fc72ae164fca6b9db127eaa9a9dda0d61316034f33a0a0d4eda41f02b01d" +checksum = "1e28d1d997f585e54aebc3f97d39e72338912123a67330d723fdbb564d646c9f" dependencies = [ "futures-core", "futures-task", @@ -1757,9 +1820,9 @@ checksum = "9e5c1b78ca4aae1ac06c48a526a655760685149f0d465d21f37abfe57ce075c6" [[package]] name = "futures-lite" -version = "2.3.0" +version = "2.6.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "52527eb5074e35e9339c6b4e8d12600c7128b68fb25dcb9fa9dec18f7c25f3a5" +checksum = "f78e10609fe0e0b3f4157ffab1876319b5b0db102a2c60dc4626306dc46b44ad" dependencies = [ "fastrand", "futures-core", @@ -1809,6 +1872,20 @@ dependencies = [ "slab", ] +[[package]] +name = "generator" +version = "0.8.7" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "605183a538e3e2a9c1038635cc5c2d194e2ee8fd0d1b66b8349fad7dbacce5a2" +dependencies = [ + "cc", + "cfg-if", + "libc", + "log", + "rustversion", + "windows", +] + [[package]] name = "generic-array" version = "0.14.7" @@ -1822,14 +1899,14 @@ dependencies = [ [[package]] name = "getrandom" -version = "0.2.11" +version = "0.2.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fe9006bed769170c11f845cf00c7c1e9092aeb3f268e007c3e760ac68008070f" +checksum = "335ff9f135e4384c8150d6f27c6daed433577f86b4750418338c01a1a2528592" dependencies = [ "cfg-if", "js-sys", "libc", - "wasi 0.11.0+wasi-snapshot-preview1", + "wasi 0.11.1+wasi-snapshot-preview1", "wasm-bindgen", ] @@ -1840,28 +1917,30 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "26145e563e54f2cadc477553f1ec5ee650b00862f0a58bcd12cbdc5f0ea2d2f4" dependencies = [ "cfg-if", + "js-sys", "libc", "r-efi", - "wasi 0.14.2+wasi-0.2.4", + "wasi 0.14.4+wasi-0.2.4", + "wasm-bindgen", ] [[package]] name = "gimli" -version = "0.28.1" +version = "0.31.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4271d37baee1b8c7e4b708028c57d816cf9d2434acb33a549475f78c181f6253" +checksum = "07e28edb80900c19c28f1072f2e8aeca7fa06b23cd4169cefe1af5aa3260783f" [[package]] name = "glob" -version = "0.3.1" +version = "0.3.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b" +checksum = "0cc23270f6e1808e30a928bdc84dea0b9b4136a8bc82338574f23baf47bbd280" [[package]] name = "globset" -version = "0.4.14" +version = "0.4.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "57da3b9b5b85bd66f31093f8c408b90a74431672542466497dcbdfdc02034be1" +checksum = "54a1028dfc5f5df5da8a56a73e6c153c9a9708ec57232470703592a3f18e49f5" dependencies = [ "aho-corasick", "bstr", @@ -1906,9 +1985,9 @@ dependencies = [ [[package]] name = "h2" -version = "0.3.26" +version = "0.3.27" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "81fe527a889e1532da5c525686d96d4c2e74cdd345badf8dfef9f6b39dd5f5e8" +checksum = "0beca50380b1fc32983fc1cb4587bfa4bb9e78fc259aad4a0032d2080309222d" dependencies = [ "bytes", "fnv", @@ -1916,7 +1995,7 @@ dependencies = [ "futures-sink", "futures-util", "http 0.2.12", - "indexmap 2.3.0", + "indexmap 2.11.0", "slab", "tokio", "tokio-util", @@ -1925,17 +2004,17 @@ dependencies = [ [[package]] name = "h2" -version = "0.4.6" +version = "0.4.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "524e8ac6999421f49a846c2d4411f337e53497d8ec55d67753beffa43c5d9205" +checksum = "f3c0b69cfcb4e1b9f1bf2f53f95f766e4661169728ec61cd3fe5a0166f2d1386" dependencies = [ "atomic-waker", "bytes", "fnv", "futures-core", "futures-sink", - "http 1.1.0", - "indexmap 2.3.0", + "http 1.3.1", + "indexmap 2.11.0", "slab", "tokio", "tokio-util", @@ -1959,9 +2038,9 @@ dependencies = [ [[package]] name = "hashbrown" -version = "0.14.5" +version = "0.15.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e5274423e17b7c9fc20b6e7e208532f9b19825d82dfd615708b70edd83df41f1" +checksum = "9229cfe53dfd69f0609a49f65461bd93001ea1ef889cd5529dd176593f5338a1" [[package]] name = "heck" @@ -1984,18 +2063,6 @@ version = "0.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "2304e00983f87ffb38b55b444b5e3b60a884b5d30c0fca7d82fe33449bbe55ea" -[[package]] -name = "hermit-abi" -version = "0.3.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d231dfb89cfffdbc30e7fc41579ed6066ad03abda9e567ccafae602b97ec5024" - -[[package]] -name = "hermit-abi" -version = "0.4.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fbf6a919d6cf397374f7dfeeea91d974c7c0a7221d0d0f4f20d859d329e53fcc" - [[package]] name = "hermit-abi" version = "0.5.2" @@ -2019,9 +2086,9 @@ checksum = "6fe2267d4ed49bc07b63801559be28c718ea06c4738b7a03c94df7386d2cde46" [[package]] name = "hickory-proto" -version = "0.24.3" +version = "0.25.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2ad3d6d98c648ed628df039541a5577bee1a7c83e9e16fe3dbedeea4cdfeb971" +checksum = "f8a6fe56c0038198998a6f217ca4e7ef3a5e51f46163bd6dd60b5c71ca6c6502" dependencies = [ "async-trait", "cfg-if", @@ -2033,8 +2100,9 @@ dependencies = [ "idna", "ipnet", "once_cell", - "rand 0.8.5", - "thiserror", + "rand 0.9.2", + "ring", + "thiserror 2.0.16", "tinyvec", "tokio", "tracing", @@ -2043,21 +2111,21 @@ dependencies = [ [[package]] name = "hickory-resolver" -version = "0.24.1" +version = "0.25.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "28757f23aa75c98f254cf0405e6d8c25b831b32921b050a66692427679b1f243" +checksum = "dc62a9a99b0bfb44d2ab95a7208ac952d31060efc16241c87eaf36406fecf87a" dependencies = [ "cfg-if", "futures-util", "hickory-proto", "ipconfig", - "lru-cache", + "moka", "once_cell", "parking_lot", - "rand 0.8.5", + "rand 0.9.2", "resolv-conf", "smallvec", - "thiserror", + "thiserror 2.0.16", "tokio", "tracing", ] @@ -2104,22 +2172,11 @@ dependencies = [ [[package]] name = "home" -version = "0.5.9" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e3d1354bf6b7235cb4a0576c2619fd4ed18183f689b12b006a0ee7329eeff9a5" -dependencies = [ - "windows-sys 0.52.0", -] - -[[package]] -name = "hostname" -version = "0.3.1" +version = "0.5.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3c731c3e10504cc8ed35cfe2f1db4c9274c3d35fa486e3b31df46f068ef3e867" +checksum = "589533453244b0995c858700322199b2becb13b627df2851f64a2775d024abcf" dependencies = [ - "libc", - "match_cfg", - "winapi", + "windows-sys 0.59.0", ] [[package]] @@ -2135,9 +2192,9 @@ dependencies = [ [[package]] name = "http" -version = "1.1.0" +version = "1.3.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "21b9ddb458710bc376481b842f5da65cdf31522de232c1ca8146abce2a358258" +checksum = "f4a85d31aea989eead29a3aaf9e1115a180df8282431156e533de47660892565" dependencies = [ "bytes", "fnv", @@ -2162,27 +2219,27 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "1efedce1fb8e6913f23e0c92de8e62cd5b772a67e7b3946df930a62566c93184" dependencies = [ "bytes", - "http 1.1.0", + "http 1.3.1", ] [[package]] name = "http-body-util" -version = "0.1.2" +version = "0.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "793429d76616a256bcb62c2a2ec2bed781c8307e797e2598c50010f2bee2544f" +checksum = "b021d93e26becf5dc7e1b75b1bed1fd93124b374ceb73f43d4d4eafec896a64a" dependencies = [ "bytes", - "futures-util", - "http 1.1.0", + "futures-core", + "http 1.3.1", "http-body 1.0.1", "pin-project-lite", ] [[package]] name = "httparse" -version = "1.9.4" +version = "1.10.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0fcc0b4a115bf80b728eb8ea024ad5bd707b615bfed49e0665b6e0f86fd082d9" +checksum = "6dbf3de79e51f3d586ab4cb9d5c3e2c14aa28ed23d180cf89b4df0454a69cc87" [[package]] name = "httpdate" @@ -2205,7 +2262,7 @@ dependencies = [ "crossbeam-utils", "form_urlencoded", "futures-util", - "hyper 0.14.30", + "hyper 0.14.32", "lazy_static", "levenshtein", "log", @@ -2220,28 +2277,28 @@ dependencies = [ [[package]] name = "humantime" -version = "2.1.0" +version = "2.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9a3a5bfb195931eeb336b2a7b4d761daec841b97f947d34394601737a7bba5e4" +checksum = "9b112acc8b3adf4b107a8ec20977da0273a8c386765a3ec0229bd500a1443f9f" [[package]] name = "hyper" -version = "0.14.30" +version = "0.14.32" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a152ddd61dfaec7273fe8419ab357f33aee0d914c5f4efbf0d96fa749eea5ec9" +checksum = "41dfc780fdec9373c01bae43289ea34c972e40ee3c9f6b3c8801a35f35586ce7" dependencies = [ "bytes", "futures-channel", "futures-core", "futures-util", - "h2 0.3.26", + "h2 0.3.27", "http 0.2.12", "http-body 0.4.6", "httparse", "httpdate", "itoa", "pin-project-lite", - "socket2", + "socket2 0.5.10", "tokio", "tower-service", "tracing", @@ -2250,20 +2307,22 @@ dependencies = [ [[package]] name = "hyper" -version = "1.4.1" +version = "1.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "50dfd22e0e76d0f662d429a5f80fcaf3855009297eab6a0a9f8543834744ba05" +checksum = "eb3aa54a13a0dfe7fbe3a59e0c76093041720fdc77b110cc0fc260fafb4dc51e" dependencies = [ + "atomic-waker", "bytes", "futures-channel", - "futures-util", - "h2 0.4.6", - "http 1.1.0", + "futures-core", + "h2 0.4.12", + "http 1.3.1", "http-body 1.0.1", "httparse", "httpdate", "itoa", "pin-project-lite", + "pin-utils", "smallvec", "tokio", "want", @@ -2276,7 +2335,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "73b7d8abf35697b81a825e386fc151e0d503e8cb5fcb93cc8669c376dfd6f278" dependencies = [ "hex", - "hyper 1.4.1", + "hyper 1.7.0", "hyper-util", "pin-project-lite", "tokio", @@ -2292,7 +2351,7 @@ checksum = "ec3efd23720e2049821a693cbc7e65ea87c72f1c58ff2f9522ff332b1491e590" dependencies = [ "futures-util", "http 0.2.12", - "hyper 0.14.30", + "hyper 0.14.32", "log", "rustls 0.21.12", "rustls-native-certs 0.6.3", @@ -2307,8 +2366,8 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a0bea761b46ae2b24eb4aef630d8d1c398157b6fc29e6350ecf090a0b70c952c" dependencies = [ "futures-util", - "http 1.1.0", - "hyper 1.4.1", + "http 1.3.1", + "hyper 1.7.0", "hyper-util", "log", "rustls 0.22.4", @@ -2321,19 +2380,18 @@ dependencies = [ [[package]] name = "hyper-rustls" -version = "0.27.3" +version = "0.27.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "08afdbb5c31130e3034af566421053ab03787c640246a446327f550d11bcb333" +checksum = "e3c93eb611681b207e1fe55d5a71ecf91572ec8a6705cdb6857f7d8d5242cf58" dependencies = [ - "futures-util", - "http 1.1.0", - "hyper 1.4.1", + "http 1.3.1", + "hyper 1.7.0", "hyper-util", - "rustls 0.23.12", - "rustls-native-certs 0.8.0", + "rustls 0.23.31", + "rustls-native-certs 0.8.1", "rustls-pki-types", "tokio", - "tokio-rustls 0.26.0", + "tokio-rustls 0.26.2", "tower-service", "webpki-roots", ] @@ -2346,7 +2404,7 @@ checksum = "70206fc6890eaca9fde8a0bf71caa2ddfc9fe045ac9e5c70df101a7dbde866e0" dependencies = [ "bytes", "http-body-util", - "hyper 1.4.1", + "hyper 1.7.0", "hyper-util", "native-tls", "tokio", @@ -2356,22 +2414,28 @@ dependencies = [ [[package]] name = "hyper-util" -version = "0.1.7" +version = "0.1.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cde7055719c54e36e95e8719f95883f22072a48ede39db7fc17a4e1d5281e9b9" +checksum = "8d9b05277c7e8da2c93a568989bb6207bef0112e8d17df7a6eda4a3cf143bc5e" dependencies = [ + "base64 0.22.1", "bytes", "futures-channel", + "futures-core", "futures-util", - "http 1.1.0", + "http 1.3.1", "http-body 1.0.1", - "hyper 1.4.1", + "hyper 1.7.0", + "ipnet", + "libc", + "percent-encoding", "pin-project-lite", - "socket2", + "socket2 0.6.0", + "system-configuration", "tokio", - "tower", "tower-service", "tracing", + "windows-registry", ] [[package]] @@ -2382,7 +2446,7 @@ checksum = "acf569d43fa9848e510358c07b80f4adf34084ddc28c6a4a651ee8474c070dcc" dependencies = [ "hex", "http-body-util", - "hyper 1.4.1", + "hyper 1.7.0", "hyper-util", "pin-project-lite", "tokio", @@ -2391,14 +2455,15 @@ dependencies = [ [[package]] name = "iana-time-zone" -version = "0.1.60" +version = "0.1.63" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e7ffbb5a1b541ea2561f8c41c087286cc091e21e556a4f09a8f6cbf17b69b141" +checksum = "b0c919e5debc312ad217002b8048a17b7d83f80703865bbfcfebb0458b0b27d8" dependencies = [ "android_system_properties", "core-foundation-sys", "iana-time-zone-haiku", "js-sys", + "log", "wasm-bindgen", "windows-core", ] @@ -2414,21 +2479,22 @@ dependencies = [ [[package]] name = "icu_collections" -version = "1.5.0" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "db2fa452206ebee18c4b5c2274dbf1de17008e874b4dc4f0aea9d01ca79e4526" +checksum = "200072f5d0e3614556f94a9930d5dc3e0662a652823904c3a75dc3b0af7fee47" dependencies = [ "displaydoc", + "potential_utf", "yoke", "zerofrom", "zerovec", ] [[package]] -name = "icu_locid" -version = "1.5.0" +name = "icu_locale_core" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "13acbb8371917fc971be86fc8057c41a64b521c184808a698c02acc242dbf637" +checksum = "0cde2700ccaed3872079a65fb1a78f6c0a36c91570f28755dda67bc8f7d9f00a" dependencies = [ "displaydoc", "litemap", @@ -2437,31 +2503,11 @@ dependencies = [ "zerovec", ] -[[package]] -name = "icu_locid_transform" -version = "1.5.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "01d11ac35de8e40fdeda00d9e1e9d92525f3f9d887cdd7aa81d727596788b54e" -dependencies = [ - "displaydoc", - "icu_locid", - "icu_locid_transform_data", - "icu_provider", - "tinystr", - "zerovec", -] - -[[package]] -name = "icu_locid_transform_data" -version = "1.5.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fdc8ff3388f852bede6b579ad4e978ab004f139284d7b28715f773507b946f6e" - [[package]] name = "icu_normalizer" -version = "1.5.0" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "19ce3e0da2ec68599d193c93d088142efd7f9c5d6fc9b803774855747dc6a84f" +checksum = "436880e8e18df4d7bbc06d58432329d6458cc84531f7ac5f024e93deadb37979" dependencies = [ "displaydoc", "icu_collections", @@ -2469,67 +2515,54 @@ dependencies = [ "icu_properties", "icu_provider", "smallvec", - "utf16_iter", - "utf8_iter", - "write16", "zerovec", ] [[package]] name = "icu_normalizer_data" -version = "1.5.0" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f8cafbf7aa791e9b22bec55a167906f9e1215fd475cd22adfcf660e03e989516" +checksum = "00210d6893afc98edb752b664b8890f0ef174c8adbb8d0be9710fa66fbbf72d3" [[package]] name = "icu_properties" -version = "1.5.1" +version = "2.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "93d6020766cfc6302c15dbbc9c8778c37e62c14427cb7f6e601d849e092aeef5" +checksum = "016c619c1eeb94efb86809b015c58f479963de65bdb6253345c1a1276f22e32b" dependencies = [ "displaydoc", "icu_collections", - "icu_locid_transform", + "icu_locale_core", "icu_properties_data", "icu_provider", - "tinystr", + "potential_utf", + "zerotrie", "zerovec", ] [[package]] name = "icu_properties_data" -version = "1.5.0" +version = "2.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "67a8effbc3dd3e4ba1afa8ad918d5684b8868b3b26500753effea8d2eed19569" +checksum = "298459143998310acd25ffe6810ed544932242d3f07083eee1084d83a71bd632" [[package]] name = "icu_provider" -version = "1.5.0" +version = "2.0.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6ed421c8a8ef78d3e2dbc98a973be2f3770cb42b606e3ab18d6237c4dfde68d9" +checksum = "03c80da27b5f4187909049ee2d72f276f0d9f99a42c306bd0131ecfe04d8e5af" dependencies = [ "displaydoc", - "icu_locid", - "icu_provider_macros", + "icu_locale_core", "stable_deref_trait", "tinystr", "writeable", "yoke", "zerofrom", + "zerotrie", "zerovec", ] -[[package]] -name = "icu_provider_macros" -version = "1.5.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1ec89e9337638ecdc08744df490b221a7399bf8d164eb52a665454e60e075ad6" -dependencies = [ - "proc-macro2", - "quote", - "syn 2.0.106", -] - [[package]] name = "ident_case" version = "1.0.1" @@ -2538,9 +2571,9 @@ checksum = "b9e0384b61958566e926dc50660321d12159025e767c18e043daf26b70104c39" [[package]] name = "idna" -version = "1.0.3" +version = "1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "686f825264d630750a544639377bae737628043f20d38bbc029e8f29ea968a7e" +checksum = "3b0875f23caa03898994f6ddc501886a45c7d3d62d04d2d90788d47be1b1e4de" dependencies = [ "idna_adapter", "smallvec", @@ -2549,9 +2582,9 @@ dependencies = [ [[package]] name = "idna_adapter" -version = "1.2.0" +version = "1.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "daca1df1c957320b2cf139ac61e7bd64fed304c5040df000a745aa1de3b4ef71" +checksum = "3acae9609540aa318d1bc588455225fb2085b9ed0c4f6bd0d9d5bcd86f1a0344" dependencies = [ "icu_normalizer", "icu_properties", @@ -2559,9 +2592,9 @@ dependencies = [ [[package]] name = "ignore" -version = "0.4.22" +version = "0.4.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b46810df39e66e925525d6e38ce1e7f6e1d208f72dc39757880fcb66e2c58af1" +checksum = "6d89fd380afde86567dfba715db065673989d6253f42b88179abd3eae47bda4b" dependencies = [ "crossbeam-deque", "globset", @@ -2606,12 +2639,12 @@ dependencies = [ [[package]] name = "indexmap" -version = "2.3.0" +version = "2.11.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "de3fc2e30ba82dd1b3911c8de1ffc143c74a914a14e99514d7637e3099df5ea0" +checksum = "f2481980430f9f78649238835720ddccc57e52df14ffce1c6f37391d61b563e9" dependencies = [ "equivalent", - "hashbrown 0.14.5", + "hashbrown 0.15.5", "serde", ] @@ -2631,13 +2664,24 @@ dependencies = [ "generic-array", ] +[[package]] +name = "io-uring" +version = "0.7.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "046fa2d4d00aea763528b4950358d0ead425372445dc8ff86312b3c69ff7727b" +dependencies = [ + "bitflags", + "cfg-if", + "libc", +] + [[package]] name = "ipconfig" version = "0.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b58db92f96b720de98181bbbe63c831e87005ab460c1bf306eb2622b4707997f" dependencies = [ - "socket2", + "socket2 0.5.10", "widestring", "windows-sys 0.48.0", "winreg", @@ -2645,9 +2689,19 @@ dependencies = [ [[package]] name = "ipnet" -version = "2.9.0" +version = "2.11.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "469fb0b9cefa57e3ef31275ee7cacb78f2fdca44e4765491884a2b119d4eb130" + +[[package]] +name = "iri-string" +version = "0.7.8" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8f518f335dce6725a761382244631d86cf0ccb2863413590b31338feb467f9c3" +checksum = "dbc5ebe9c3a1a7a5127f920a418f7585e9e758e911d0466ed004f393b0e380b2" +dependencies = [ + "memchr", + "serde", +] [[package]] name = "is-docker" @@ -2664,7 +2718,7 @@ version = "0.4.16" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e04d7f318608d35d4b61ddd75cbdaee86b023ebe2bd5a66ee0915f0bf93095a9" dependencies = [ - "hermit-abi 0.5.2", + "hermit-abi", "libc", "windows-sys 0.59.0", ] @@ -2705,78 +2759,104 @@ dependencies = [ [[package]] name = "itoa" -version = "1.0.11" +version = "1.0.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a5f13b858c8d314ee3e8f639011f7ccefe71f97f96e50151fb991f267928e2c" + +[[package]] +name = "jiff" +version = "0.2.15" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "be1f93b8b1eb69c77f24bbb0afdf66f54b632ee39af40ca21c4365a1d7347e49" +dependencies = [ + "jiff-static", + "log", + "portable-atomic", + "portable-atomic-util", + "serde", +] + +[[package]] +name = "jiff-static" +version = "0.2.15" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "49f1f14873335454500d59611f1cf4a4b0f786f9ac11f4312a78e4cf2566695b" +checksum = "03343451ff899767262ec32146f6d559dd759fdadf42ff0e227c7c48f72594b4" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] [[package]] name = "jobserver" -version = "0.1.32" +version = "0.1.34" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "48d1dbcbbeb6a7fec7e059840aa538bd62aaccf972c7346c4d9d2059312853d0" +checksum = "9afb3de4395d6b3e67a780b6de64b51c978ecf11cb9a462c66be7d4ca9039d33" dependencies = [ + "getrandom 0.3.3", "libc", ] [[package]] name = "js-sys" -version = "0.3.69" +version = "0.3.78" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "29c15563dc2726973df627357ce0c9ddddbea194836909d655df6a75d2cf296d" +checksum = "0c0b063578492ceec17683ef2f8c5e89121fbd0b172cbc280635ab7567db2738" dependencies = [ + "once_cell", "wasm-bindgen", ] [[package]] name = "jsonrpsee-core" -version = "0.20.3" +version = "0.20.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "da2327ba8df2fdbd5e897e2b5ed25ce7f299d345b9736b6828814c3dbd1fd47b" +checksum = "f24ea59b037b6b9b0e2ebe2c30a3e782b56bd7c76dcc5d6d70ba55d442af56e3" dependencies = [ "anyhow", "async-trait", "beef", "futures-util", - "hyper 0.14.30", + "hyper 0.14.32", "jsonrpsee-types", "serde", "serde_json", - "thiserror", + "thiserror 1.0.69", "tokio", "tracing", ] [[package]] name = "jsonrpsee-http-client" -version = "0.20.3" +version = "0.20.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5f80c17f62c7653ce767e3d7288b793dfec920f97067ceb189ebdd3570f2bc20" +checksum = "57c7b9f95208927653e7965a98525e7fc641781cab89f0e27c43fa2974405683" dependencies = [ "async-trait", - "hyper 0.14.30", + "hyper 0.14.32", "hyper-rustls 0.24.2", "jsonrpsee-core", "jsonrpsee-types", "serde", "serde_json", - "thiserror", + "thiserror 1.0.69", "tokio", - "tower", + "tower 0.4.13", "tracing", "url", ] [[package]] name = "jsonrpsee-types" -version = "0.20.3" +version = "0.20.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5be0be325642e850ed0bdff426674d2e66b2b7117c9be23a7caef68a2902b7d9" +checksum = "3264e339143fe37ed081953842ee67bfafa99e3b91559bdded6e4abd8fc8535e" dependencies = [ "anyhow", "beef", "serde", "serde_json", - "thiserror", + "thiserror 1.0.69", "tracing", ] @@ -2803,15 +2883,18 @@ dependencies = [ [[package]] name = "keyring" -version = "3.3.0" +version = "3.6.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5fa83d1ca02db069b5fbe94b23b584d588e989218310c9c15015bb5571ef1a94" +checksum = "eebcc3aff044e5944a8fbaf69eb277d11986064cba30c468730e8b9909fb551c" dependencies = [ "byteorder 1.5.0", "dbus-secret-service", + "log", "secret-service", - "security-framework", - "windows-sys 0.59.0", + "security-framework 2.11.1", + "security-framework 3.4.0", + "windows-sys 0.60.2", + "zeroize", ] [[package]] @@ -2900,7 +2983,7 @@ dependencies = [ "ledger-transport", "libc", "log", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -2911,67 +2994,68 @@ checksum = "db13adb97ab515a3691f56e4dbab09283d0b86cb45abd991d8634a9d6f501760" [[package]] name = "libc" -version = "0.2.155" +version = "0.2.175" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "97b3888a4aecf77e811145cadf6eef5901f4782c53886191b2f693f24761847c" +checksum = "6a82ae493e598baaea5209805c49bbf2ea7de956d50d7da0da1164f9c6d28543" [[package]] name = "libdbus-sys" -version = "0.2.5" +version = "0.2.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "06085512b750d640299b79be4bad3d2fa90a9c00b1fd9e1b46364f66f0485c72" +checksum = "5cbe856efeb50e4681f010e9aaa2bf0a644e10139e54cde10fc83a307c23bd9f" dependencies = [ "pkg-config", ] [[package]] name = "libm" -version = "0.2.8" +version = "0.2.15" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4ec2a862134d2a7d32d7983ddcdd1c4923530833c9f2ea1a44fc5fa473989058" +checksum = "f9fbbcab51052fe104eb5e5d351cf728d30a5be1fe14d9be8a3b097481fb97de" [[package]] name = "libredox" -version = "0.1.3" +version = "0.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c0ff37bd590ca25063e35af745c343cb7a0271906fb7b37e4813e8f79f00268d" +checksum = "391290121bad3d37fbddad76d8f5d1c1c314cfc646d143d7e07a3086ddff0ce3" dependencies = [ "bitflags", "libc", + "redox_syscall", ] [[package]] name = "link-cplusplus" -version = "1.0.9" +version = "1.0.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9d240c6f7e1ba3a28b0249f774e6a9dd0175054b52dfbb61b16eb8505c3785c9" +checksum = "7f78c730aaa7d0b9336a299029ea49f9ee53b0ed06e9202e8cb7db9bae7b8c82" dependencies = [ "cc", ] [[package]] -name = "linked-hash-map" -version = "0.5.6" +name = "linux-raw-sys" +version = "0.4.15" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0717cef1bc8b636c6e1c1bbdefc09e6322da8a9321966e8928ef80d20f7f770f" +checksum = "d26c52dbd32dccf2d10cac7725f8eae5296885fb5703b261f7d0a0739ec807ab" [[package]] name = "linux-raw-sys" -version = "0.4.14" +version = "0.9.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "78b3ae25bc7c8c38cec158d1f2757ee79e9b3740fbc7ccf0e59e4b08d793fa89" +checksum = "cd945864f07fe9f5371a27ad7b52a172b4b499999f1d97574c9fa68373937e12" [[package]] name = "litemap" -version = "0.7.4" +version = "0.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4ee93343901ab17bd981295f2cf0026d4ad018c7c31ba84549a4ddbb47a45104" +checksum = "241eaef5fd12c88705a01fc1066c48c4b36e0dd4377dcdc7ec3942cea7a69956" [[package]] name = "lock_api" -version = "0.4.12" +version = "0.4.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "07af8b9cdd281b7915f413fa73f29ebd5d55d0d3f0155584dade1ff18cea1b17" +checksum = "96936507f153605bddfcda068dd804796c84324ed2510809e5b2a624c81da765" dependencies = [ "autocfg", "scopeguard", @@ -2979,22 +3063,32 @@ dependencies = [ [[package]] name = "log" -version = "0.4.22" +version = "0.4.28" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a7a70ba024b9dc04c27ea2f0c0548feb474ec5c54bba33a7f72f873a39d07b24" +checksum = "34080505efa8e45a4b816c349525ebe327ceaa8559756f0356cba97ef3bf7432" dependencies = [ "value-bag", ] [[package]] -name = "lru-cache" -version = "0.1.2" +name = "loom" +version = "0.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "31e24f1ad8321ca0e8a1e0ac13f23cb668e6f5466c2c57319f6a5cf1cc8e3b1c" +checksum = "419e0dc8046cb947daa77eb95ae174acfbddb7673b4151f56d1eed8e93fbfaca" dependencies = [ - "linked-hash-map", + "cfg-if", + "generator", + "scoped-tls", + "tracing", + "tracing-subscriber", ] +[[package]] +name = "lru-slab" +version = "0.1.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "112b39cec0b298b6c1999fee3e31427f74f676e4cb9879ed1a121b43661a4154" + [[package]] name = "macro-string" version = "0.1.4" @@ -3015,12 +3109,6 @@ dependencies = [ "unicode-id", ] -[[package]] -name = "match_cfg" -version = "0.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ffbee8634e0d45d258acb448e7eaab3fce7a0a467395d4d9f228e3c1f01fb2e4" - [[package]] name = "matchers" version = "0.2.0" @@ -3032,9 +3120,9 @@ dependencies = [ [[package]] name = "memchr" -version = "2.7.4" +version = "2.7.5" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "78ca9ab1a0babb1e7d5695e3530886289c18cf2f87ec19a575a0abdce112e3a3" +checksum = "32a282da65faaf38286cf3be983213fcf1d2e2a58700e808f83f4ea9a4804bc0" [[package]] name = "memoffset" @@ -3053,42 +3141,41 @@ checksum = "6877bb514081ee2a7ff5ef9de3281f14a4dd4bceac4c09388074a6b5df8a139a" [[package]] name = "miniz_oxide" -version = "0.7.4" +version = "0.8.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b8a240ddb74feaf34a79a7add65a741f3167852fba007066dcac1ca548d89c08" +checksum = "1fa76a2c86f704bdb222d66965fb3d63269ce38518b83cb0575fca855ebb6316" dependencies = [ - "adler", + "adler2", ] [[package]] name = "mio" -version = "1.0.1" +version = "1.0.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4569e456d394deccd22ce1c1913e6ea0e54519f577285001215d33557431afe4" +checksum = "78bed444cc8a2160f01cbcf811ef18cac863ad68ae8ca62092e8db51d51c761c" dependencies = [ - "hermit-abi 0.3.9", "libc", - "wasi 0.11.0+wasi-snapshot-preview1", - "windows-sys 0.52.0", + "wasi 0.11.1+wasi-snapshot-preview1", + "windows-sys 0.59.0", ] [[package]] name = "mockito" -version = "1.5.0" +version = "1.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09b34bd91b9e5c5b06338d392463e1318d683cf82ec3d3af4014609be6e2108d" +checksum = "7760e0e418d9b7e5777c0374009ca4c93861b9066f18cb334a20ce50ab63aa48" dependencies = [ "assert-json-diff", "bytes", "colored", "futures-util", - "http 1.1.0", + "http 1.3.1", "http-body 1.0.1", "http-body-util", - "hyper 1.4.1", + "hyper 1.7.0", "hyper-util", "log", - "rand 0.8.5", + "rand 0.9.2", "regex", "serde_json", "serde_urlencoded", @@ -3096,11 +3183,30 @@ dependencies = [ "tokio", ] +[[package]] +name = "moka" +version = "0.12.10" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a9321642ca94a4282428e6ea4af8cc2ca4eac48ac7a6a4ea8f33f76d0ce70926" +dependencies = [ + "crossbeam-channel", + "crossbeam-epoch", + "crossbeam-utils", + "loom", + "parking_lot", + "portable-atomic", + "rustc_version", + "smallvec", + "tagptr", + "thiserror 1.0.69", + "uuid", +] + [[package]] name = "native-tls" -version = "0.2.12" +version = "0.2.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a8614eb2c83d59d1c8cc974dd3f920198647674a0a035e1af1fa58707e317466" +checksum = "87de3442987e9dbec73158d5c715e7ad9072fda936bb03d19d7fa10e00520f0e" dependencies = [ "libc", "log", @@ -3108,7 +3214,7 @@ dependencies = [ "openssl-probe", "openssl-sys", "schannel", - "security-framework", + "security-framework 2.11.1", "security-framework-sys", "tempfile", ] @@ -3121,12 +3227,13 @@ checksum = "650eef8c711430f1a879fdd01d4745a7deea475becfb90269c06775983bbf086" [[package]] name = "nix" -version = "0.27.1" +version = "0.29.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2eb04e9c688eff1c89d72b407f168cf79bb9e867a9d3323ed6c01519eb9cc053" +checksum = "71e2746dc3a24dd78b3cfcb7be93368c6de9963d30f43a6a73998a9cf4b17b46" dependencies = [ "bitflags", "cfg-if", + "cfg_aliases", "libc", "memoffset", ] @@ -3154,9 +3261,9 @@ dependencies = [ [[package]] name = "num" -version = "0.4.1" +version = "0.4.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b05180d69e3da0e530ba2a1dae5110317e49e3b7f3d41be227dc5f92e49ee7af" +checksum = "35bd024e8b2ff75562e5f34e7f4905839deb4b22955ef5e73d2fea1b9813cb23" dependencies = [ "num-bigint", "num-complex", @@ -3168,20 +3275,19 @@ dependencies = [ [[package]] name = "num-bigint" -version = "0.4.4" +version = "0.4.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "608e7659b5c3d7cba262d894801b9ec9d00de989e8a82bd4bef91d08da45cdc0" +checksum = "a5e44f723f1133c9deac646763579fdb3ac745e418f2a7af9cd0c431da1f20b9" dependencies = [ - "autocfg", "num-integer", "num-traits", ] [[package]] name = "num-complex" -version = "0.4.5" +version = "0.4.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "23c6602fda94a57c990fe0df199a035d83576b496aa29f4e634a8ac6004e68a6" +checksum = "73f88a1307638156682bada9d7604135552957b7818057dcef22705b4d509495" dependencies = [ "num-traits", ] @@ -3194,9 +3300,9 @@ checksum = "51d515d32fb182ee37cda2ccdcb92950d6a3c2893aa280e540671c2cd0f3b1d9" [[package]] name = "num-derive" -version = "0.4.1" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cfb77679af88f8b125209d354a202862602672222e7f2313fdd6dc349bad4712" +checksum = "ed3955f1a9c7c0c15e092f9c887db08b1fc683305fdf6eb6684f22555355e202" dependencies = [ "proc-macro2", "quote", @@ -3205,19 +3311,18 @@ dependencies = [ [[package]] name = "num-integer" -version = "0.1.45" +version = "0.1.46" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "225d3389fb3509a24c93f5c29eb6bde2586b98d9f016636dff58d7c6f7569cd9" +checksum = "7969661fd2958a5cb096e56c8e1ad0444ac2bbcd0061bd28660485a44879858f" dependencies = [ - "autocfg", "num-traits", ] [[package]] name = "num-iter" -version = "0.1.44" +version = "0.1.45" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d869c01cc0c455284163fd0092f1f93835385ccab5a98a0dcc497b2f8bf055a9" +checksum = "1429034a0490724d0075ebb2bc9e875d6503c3cf69e235a8941aa757d83ef5bf" dependencies = [ "autocfg", "num-integer", @@ -3226,11 +3331,10 @@ dependencies = [ [[package]] name = "num-rational" -version = "0.4.1" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0638a1c9d0a3c0914158145bc76cff373a75a627e6ecbfb71cbe6f453a5a19b0" +checksum = "f83d14da390562dca69fc84082e73e548e1ad308d24accdedd2720017cb37824" dependencies = [ - "autocfg", "num-bigint", "num-integer", "num-traits", @@ -3238,27 +3342,37 @@ dependencies = [ [[package]] name = "num-traits" -version = "0.2.17" +version = "0.2.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "39e3200413f237f41ab11ad6d161bc7239c84dcb631773ccd7de3dfe4b5c267c" +checksum = "071dfc062690e90b734c0b2273ce72ad0ffa95f0c74596bc250dcfd960262841" dependencies = [ "autocfg", ] [[package]] name = "object" -version = "0.32.2" +version = "0.36.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a6a622008b6e321afc04970976f62ee297fdbaa6f95318ca343e3eebb9648441" +checksum = "62948e14d923ea95ea2c7c86c71013138b66525b86bdc08d2dcc262bdb497b87" dependencies = [ "memchr", ] [[package]] name = "once_cell" -version = "1.19.0" +version = "1.21.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "42f5e15c9953c5e4ccceeb2e7382a716482c34515315f7b03532b8b4e8393d2d" +dependencies = [ + "critical-section", + "portable-atomic", +] + +[[package]] +name = "once_cell_polyfill" +version = "1.70.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3fdb12b2476b595f9358c5161aa467c2438859caa136dec86c26fdd2efe17b92" +checksum = "a4895175b425cb1f87721b59f0f286c2092bd4af812243672510e1ac53e2e0ad" [[package]] name = "opaque-debug" @@ -3268,9 +3382,9 @@ checksum = "c08d65885ee38876c4f86fa503fb49d7b507c2b62552df7c70b2fce627e06381" [[package]] name = "open" -version = "5.3.0" +version = "5.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "61a877bf6abd716642a53ef1b89fb498923a4afca5c754f9050b4d081c05c4b3" +checksum = "e2483562e62ea94312f3576a7aca397306df7990b8d89033e18766744377ef95" dependencies = [ "is-wsl", "libc", @@ -3279,9 +3393,9 @@ dependencies = [ [[package]] name = "openssl" -version = "0.10.72" +version = "0.10.73" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fedfea7d58a1f73118430a55da6a286e7b044961736ce96a16a17068ea25e5da" +checksum = "8505734d46c8ab1e19a1dce3aef597ad87dcb4c37e7188231769bd6bd51cebf8" dependencies = [ "bitflags", "cfg-if", @@ -3305,15 +3419,15 @@ dependencies = [ [[package]] name = "openssl-probe" -version = "0.1.5" +version = "0.1.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ff011a302c396a5197692431fc1948019154afc178baf7d8e37367442a4601cf" +checksum = "d05e27ee213611ffe7d6348b942e8f942b37114c00cc03cec254295a4a17852e" [[package]] name = "openssl-sys" -version = "0.9.107" +version = "0.9.109" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8288979acd84749c744a9014b4382d42b8f7b2592847b5afb2ed29e5d16ede07" +checksum = "90096e2e47630d78b7d1c20952dc621f957103f8bc2c8359ec81290d75238571" dependencies = [ "cc", "libc", @@ -3327,6 +3441,15 @@ version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "04744f49eae99ab78e0d5c0b603ab218f515ea8cfe5a456d7629ad883a3b6e7d" +[[package]] +name = "ordered-float" +version = "2.10.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "68f19d67e5a2795c94e73e0bb1cc1a7edeb2e28efd39e2e1c9b7a40c1108b11c" +dependencies = [ + "num-traits", +] + [[package]] name = "ordered-stream" version = "0.2.0" @@ -3351,15 +3474,15 @@ dependencies = [ [[package]] name = "parking" -version = "2.2.0" +version = "2.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bb813b8af86854136c6922af0598d719255ecb2179515e6e7730d468f05c9cae" +checksum = "f38d5652c16fde515bb1ecef450ab0f6a219d619a7274976324d5e377f7dceba" [[package]] name = "parking_lot" -version = "0.12.3" +version = "0.12.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f1bf18183cf54e8d6059647fc3063646a1801cf30896933ec2311622cc4b9a27" +checksum = "70d58bf43669b5795d1576d0641cfb6fbb2057bf629506267a92807158584a13" dependencies = [ "lock_api", "parking_lot_core", @@ -3367,9 +3490,9 @@ dependencies = [ [[package]] name = "parking_lot_core" -version = "0.9.10" +version = "0.9.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1e401f977ab385c9e4e3ab30627d6f26d00e2c73eef317493c4ec6d468726cf8" +checksum = "bc838d2a56b5b1a6c25f55575dfc605fabb63bb2365f6c2353ef9159aa69e4a5" dependencies = [ "cfg-if", "libc", @@ -3411,9 +3534,9 @@ checksum = "57c0d7b74b563b49d38dae00a0c37d4d6de9b432382b2892f0574ddcae73fd0a" [[package]] name = "pathdiff" -version = "0.2.1" +version = "0.2.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8835116a5c179084a830efb3adc117ab007512b535bc1a21c991d3b32a6b44dd" +checksum = "df94ce210e5bc13cb6651479fa48d14f601d9858cfe0467f43ae157023b938d3" [[package]] name = "pbkdf2" @@ -3426,9 +3549,9 @@ dependencies = [ [[package]] name = "percent-encoding" -version = "2.3.1" +version = "2.3.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e3148f5046208a5d56bcfc03053e3ca6334e51da8dfb19b6cdc8b306fae3283e" +checksum = "9b4f627cb1b25917193a259e49bdad08f671f8d9708acfd5fe0a8c1455d87220" [[package]] name = "petgraph" @@ -3437,14 +3560,14 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "b4c5cc86750666a3ed20bdaf5ca2a0344f9c67674cae0515bec2da16fbaa47db" dependencies = [ "fixedbitset", - "indexmap 2.3.0", + "indexmap 2.11.0", ] [[package]] name = "phf" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ade2d8b8f33c7333b51bcf0428d37e217e9f32192ae4772156f65063b8ce03dc" +checksum = "1fd6780a80ae0c52cc120a26a1a42c1ae51b247a253e4e06113d23d2c2edd078" dependencies = [ "phf_macros", "phf_shared", @@ -3452,9 +3575,9 @@ dependencies = [ [[package]] name = "phf_generator" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "48e4cc64c2ad9ebe670cb8fd69dd50ae301650392e81c05f9bfcb2d5bdbc24b0" +checksum = "3c80231409c20246a13fddb31776fb942c38553c51e871f8cbd687a4cfb5843d" dependencies = [ "phf_shared", "rand 0.8.5", @@ -3462,9 +3585,9 @@ dependencies = [ [[package]] name = "phf_macros" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3444646e286606587e49f3bcf1679b8cef1dc2c5ecc29ddacaffc305180d464b" +checksum = "f84ac04429c13a7ff43785d75ad27569f2951ce0ffd30a3321230db2fc727216" dependencies = [ "phf_generator", "phf_shared", @@ -3475,9 +3598,9 @@ dependencies = [ [[package]] name = "phf_shared" -version = "0.11.2" +version = "0.11.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "90fcb95eef784c2ac79119d1dd819e162b5da872ce6f3c3abe1e8ca1c082f72b" +checksum = "67eabc2ef2a60eb7faa00097bd1ffdb5bd28e62bf39990626a582201b7a754e5" dependencies = [ "siphasher", ] @@ -3490,18 +3613,18 @@ checksum = "5be167a7af36ee22fe3115051bc51f6e6c7054c9348e28deb4f49bd6f705a315" [[package]] name = "pin-project" -version = "1.1.5" +version = "1.1.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b6bf43b791c5b9e34c3d182969b4abb522f9343702850a2e57f460d00d09b4b3" +checksum = "677f1add503faace112b9f1373e43e9e054bfdd22ff1a63c1bc485eaec6a6a8a" dependencies = [ "pin-project-internal", ] [[package]] name = "pin-project-internal" -version = "1.1.5" +version = "1.1.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2f38a4412a78282e09a2cf38d195ea5420d15ba0602cb375210efbc877243965" +checksum = "6e918e4ff8c4549eb882f14b3a4bc8c8bc93de829416eacf579f1207a8fbf861" dependencies = [ "proc-macro2", "quote", @@ -3510,9 +3633,9 @@ dependencies = [ [[package]] name = "pin-project-lite" -version = "0.2.14" +version = "0.2.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bda66fc9667c18cb2758a2ac84d1167245054bcf85d5d1aaa6923f45801bdd02" +checksum = "3b3cff922bd51709b605d9ead9aa71031d81447142d828eb4a6eba76fe619f9b" [[package]] name = "pin-utils" @@ -3522,9 +3645,9 @@ checksum = "8b870d8c151b6f2fb93e84a13146138f05d02ed11c7e7c54f8826aaaf7c9f184" [[package]] name = "piper" -version = "0.2.3" +version = "0.2.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae1d5c74c9876f070d3e8fd503d748c7d974c3e48da8f41350fa5222ef9b4391" +checksum = "96c8c490f422ef9a4efd2cb5b42b76c8613d7e7dfc1caf667b8a3350a5acc066" dependencies = [ "atomic-waker", "fastrand", @@ -3543,23 +3666,46 @@ dependencies = [ [[package]] name = "pkg-config" -version = "0.3.30" +version = "0.3.32" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d231b230927b5e4ad203db57bbcbee2802f6bce620b1e4a9024a07d94e2907ec" +checksum = "7edddbd0b52d732b21ad9a5fab5c704c14cd949e5e9a1ec5929a24fded1b904c" [[package]] name = "polling" -version = "3.7.2" +version = "3.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a3ed00ed3fbf728b5816498ecd316d1716eecaced9c0c8d2c5a6740ca214985b" +checksum = "b5bd19146350fe804f7cb2669c851c03d69da628803dab0d98018142aaa5d829" dependencies = [ "cfg-if", "concurrent-queue", - "hermit-abi 0.4.0", + "hermit-abi", "pin-project-lite", - "rustix", - "tracing", - "windows-sys 0.52.0", + "rustix 1.0.8", + "windows-sys 0.60.2", +] + +[[package]] +name = "portable-atomic" +version = "1.11.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f84267b20a16ea918e43c6a88433c2d54fa145c92a811b5b047ccbe153674483" + +[[package]] +name = "portable-atomic-util" +version = "0.2.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d8a2f0d8d040d7848a709caf78912debcc3f33ee4b3cac47d73d1e1069e83507" +dependencies = [ + "portable-atomic", +] + +[[package]] +name = "potential_utf" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "84df19adbe5b5a0782edcab45899906947ab039ccf4573713735ee7de1e6b08a" +dependencies = [ + "zerovec", ] [[package]] @@ -3570,9 +3716,9 @@ checksum = "439ee305def115ba05938db6eb1644ff94165c5ab5e9420d1c1bcedbba909391" [[package]] name = "ppv-lite86" -version = "0.2.20" +version = "0.2.21" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "77957b295656769bb8ad2b6a6b09d897d94f05c41b069aede1fcdaa675eaea04" +checksum = "85eae3c4ed2f50dcfe72643da4befc30deadb458a9b590d720cde2f2b1e97da9" dependencies = [ "zerocopy", ] @@ -3585,9 +3731,9 @@ checksum = "925383efa346730478fb4838dbe9137d2a47675ad789c546d150a6e1dd4ab31c" [[package]] name = "predicates" -version = "3.1.2" +version = "3.1.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7e9086cc7640c29a356d1a29fd134380bee9d8f79a17410aa76e7ad295f42c97" +checksum = "a5d19ee57562043d37e82899fade9a22ebab7be9cef5026b07fda9cdd4293573" dependencies = [ "anstyle", "difflib", @@ -3599,15 +3745,15 @@ dependencies = [ [[package]] name = "predicates-core" -version = "1.0.8" +version = "1.0.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae8177bee8e75d6846599c6b9ff679ed51e882816914eec639944d7c9aa11931" +checksum = "727e462b119fe9c93fd0eb1429a5f7647394014cf3c04ab2c0350eeb09095ffa" [[package]] name = "predicates-tree" -version = "1.0.11" +version = "1.0.12" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "41b740d195ed3166cd147c8047ec98db0e22ec019eb8eeb76d343b795304fb13" +checksum = "72dd2d6d381dfb73a193c7fca536518d7caee39fc8503f74e7dc0be0531b425c" dependencies = [ "predicates-core", "termtree", @@ -3615,9 +3761,9 @@ dependencies = [ [[package]] name = "pretty_assertions" -version = "1.4.0" +version = "1.4.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "af7cee1a6c8a5b9208b3cb1061f10c0cb689087b3d8ce85fb9d2dd7a29b6ba66" +checksum = "3ae130e2f271fbc2ac3a40fb1d07180839cdbbe443c7a27e1e3c13c5cac0116d" dependencies = [ "diff", "yansi", @@ -3625,9 +3771,9 @@ dependencies = [ [[package]] name = "prettyplease" -version = "0.2.15" +version = "0.2.37" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ae005bd773ab59b4725093fd7df83fd7892f7d8eafb48dbd7de6e024e4215f9d" +checksum = "479ca8adacdd7ce8f1fb39ce9ecccbfe93a3f1344b3d0d97f20bc0196208f62b" dependencies = [ "proc-macro2", "syn 2.0.106", @@ -3644,7 +3790,7 @@ dependencies = [ "is-terminal", "lazy_static", "term", - "unicode-width", + "unicode-width 0.1.14", ] [[package]] @@ -3658,21 +3804,11 @@ dependencies = [ [[package]] name = "proc-macro-crate" -version = "1.3.1" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7f4c021e1093a56626774e81216a4ce732a735e5bad4868a03f3ed65ca0c3919" -dependencies = [ - "once_cell", - "toml_edit 0.19.15", -] - -[[package]] -name = "proc-macro-crate" -version = "3.2.0" +version = "3.3.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8ecf48c7ca261d60b74ab1a7b20da18bede46776b2e55535cb958eb595c5fa7b" +checksum = "edce586971a4dfaa28950c6f18ed55e0406c1ab88bbce2c6f6293a7aaba73d35" dependencies = [ - "toml_edit 0.22.20", + "toml_edit", ] [[package]] @@ -3684,65 +3820,66 @@ dependencies = [ "unicode-ident", ] -[[package]] -name = "quick-error" -version = "1.2.3" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1d01941d82fa2ab50be1e79e6714289dd7cde78eba4c074bc5a4374f650dfe0" - [[package]] name = "quinn" -version = "0.11.5" +version = "0.11.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8c7c5fdde3cdae7203427dc4f0a68fe0ed09833edc525a03456b153b79828684" +checksum = "b9e20a958963c291dc322d98411f541009df2ced7b5a4f2bd52337638cfccf20" dependencies = [ "bytes", + "cfg_aliases", "pin-project-lite", "quinn-proto", "quinn-udp", - "rustc-hash 2.0.0", - "rustls 0.23.12", - "socket2", - "thiserror", + "rustc-hash 2.1.1", + "rustls 0.23.31", + "socket2 0.6.0", + "thiserror 2.0.16", "tokio", "tracing", + "web-time", ] [[package]] name = "quinn-proto" -version = "0.11.8" +version = "0.11.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fadfaed2cd7f389d0161bb73eeb07b7b78f8691047a6f3e73caaeae55310a4a6" +checksum = "f1906b49b0c3bc04b5fe5d86a77925ae6524a19b816ae38ce1e426255f1d8a31" dependencies = [ "bytes", - "rand 0.8.5", + "getrandom 0.3.3", + "lru-slab", + "rand 0.9.2", "ring", - "rustc-hash 2.0.0", - "rustls 0.23.12", + "rustc-hash 2.1.1", + "rustls 0.23.31", + "rustls-pki-types", "slab", - "thiserror", + "thiserror 2.0.16", "tinyvec", "tracing", + "web-time", ] [[package]] name = "quinn-udp" -version = "0.5.4" +version = "0.5.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8bffec3605b73c6f1754535084a85229fa8a30f86014e6c81aeec4abb68b0285" +checksum = "addec6a0dcad8a8d96a771f815f0eaf55f9d1805756410b39f5fa81332574cbd" dependencies = [ + "cfg_aliases", "libc", "once_cell", - "socket2", + "socket2 0.6.0", "tracing", - "windows-sys 0.52.0", + "windows-sys 0.60.2", ] [[package]] name = "quote" -version = "1.0.37" +version = "1.0.40" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b5b9d34b8991d19d98081b46eacdd8eb58c6f2b201139f7c5f643cc155a633af" +checksum = "1885c039570dc00dcb4ff087a89e185fd56bae234ddc7f056a945bf36467248d" dependencies = [ "proc-macro2", ] @@ -3766,9 +3903,9 @@ dependencies = [ [[package]] name = "rand" -version = "0.9.1" +version = "0.9.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9fbfd9d094a40bf3ae768db9361049ace4c0e04a4fd6b359518bd7b73a73dd97" +checksum = "6db2770f06117d490610c7488547d543617b21bfa07796d7a12f6f1bd53850d1" dependencies = [ "rand_chacha 0.9.0", "rand_core 0.9.3", @@ -3800,7 +3937,7 @@ version = "0.6.4" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "ec0be4795e2f6a28069bec0b5ff3e2ac9bafc99e6a9a7dc3547996c5c816922c" dependencies = [ - "getrandom 0.2.11", + "getrandom 0.2.16", ] [[package]] @@ -3814,29 +3951,49 @@ dependencies = [ [[package]] name = "redox_syscall" -version = "0.5.3" +version = "0.5.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2a908a6e00f1fdd0dfd9c0eb08ce85126f6d8bbda50017e74bc4a4b7d4a926a4" +checksum = "5407465600fb0548f1442edf71dd20683c6ed326200ace4b1ef0763521bb3b77" dependencies = [ "bitflags", ] [[package]] name = "redox_users" -version = "0.4.5" +version = "0.4.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bd283d9651eeda4b2a83a43c1c91b266c40fd76ecd39a50a8c630ae69dc72891" +checksum = "ba009ff324d1fc1b900bd1fdb31564febe58a8ccc8a6fdbb93b543d33b13ca43" dependencies = [ - "getrandom 0.2.11", + "getrandom 0.2.16", "libredox", - "thiserror", + "thiserror 1.0.69", +] + +[[package]] +name = "ref-cast" +version = "1.0.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4a0ae411dbe946a674d89546582cea4ba2bb8defac896622d6496f14c23ba5cf" +dependencies = [ + "ref-cast-impl", +] + +[[package]] +name = "ref-cast-impl" +version = "1.0.24" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "1165225c21bff1f3bbce98f5a1f889949bc902d3575308cc7b0de30b4f6d27c7" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", ] [[package]] name = "regex" -version = "1.10.6" +version = "1.11.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4219d74c6b67a3654a9fbebc4b419e22126d13d2f3c4a07ee0cb61ff79a79619" +checksum = "23d7fd106d8c02486a8d64e778353d1cffe08ce79ac2e82f540c86d0facf6912" dependencies = [ "aho-corasick", "memchr", @@ -3846,9 +4003,9 @@ dependencies = [ [[package]] name = "regex-automata" -version = "0.4.7" +version = "0.4.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "38caf58cc5ef2fed281f89292ef23f6365465ed9a41b7a7754eb4e26496c92df" +checksum = "6b9458fa0bfeeac22b5ca447c63aaf45f28439a709ccd244698632f9aa6394d6" dependencies = [ "aho-corasick", "memchr", @@ -3857,15 +4014,15 @@ dependencies = [ [[package]] name = "regex-syntax" -version = "0.8.4" +version = "0.8.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7a66a03ae7c801facd77a29370b4faec201768915ac14a721ba36f20bc9c209b" +checksum = "caf4aa5b0f434c91fe5c7f1ecb6a5ece2130b02ad2a590589dda5146df959001" [[package]] name = "reqwest" -version = "0.12.7" +version = "0.12.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f8f4955649ef5c38cc7f9e8aa41761d48fb9677197daea9984dc54f56aad5e63" +checksum = "d429f34c8092b2d42c7c93cec323bb4adeb7c67698f70839adec842ec10c7ceb" dependencies = [ "base64 0.22.1", "bytes", @@ -3873,16 +4030,15 @@ dependencies = [ "futures-channel", "futures-core", "futures-util", - "h2 0.4.6", + "h2 0.4.12", "hickory-resolver", - "http 1.1.0", + "http 1.3.1", "http-body 1.0.1", "http-body-util", - "hyper 1.4.1", - "hyper-rustls 0.27.3", + "hyper 1.7.0", + "hyper-rustls 0.27.7", "hyper-tls", "hyper-util", - "ipnet", "js-sys", "log", "mime", @@ -3891,19 +4047,19 @@ dependencies = [ "percent-encoding", "pin-project-lite", "quinn", - "rustls 0.23.12", - "rustls-native-certs 0.7.3", - "rustls-pemfile 2.1.3", + "rustls 0.23.31", + "rustls-native-certs 0.8.1", "rustls-pki-types", "serde", "serde_json", "serde_urlencoded", "sync_wrapper", - "system-configuration", "tokio", "tokio-native-tls", - "tokio-rustls 0.26.0", + "tokio-rustls 0.26.2", "tokio-util", + "tower 0.5.2", + "tower-http", "tower-service", "url", "wasm-bindgen", @@ -3911,18 +4067,13 @@ dependencies = [ "wasm-streams", "web-sys", "webpki-roots", - "windows-registry", ] [[package]] name = "resolv-conf" -version = "0.7.0" +version = "0.7.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "52e44394d2086d010551b14b53b1f24e31647570cd1deb0379e2c21b329aba00" -dependencies = [ - "hostname", - "quick-error", -] +checksum = "95325155c684b1c89f7765e30bc1c42e4a6da51ca513615660cb8a62ef9a88e3" [[package]] name = "rfc6979" @@ -3936,13 +4087,13 @@ dependencies = [ [[package]] name = "ring" -version = "0.17.13" +version = "0.17.14" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "70ac5d832aa16abd7d1def883a8545280c20a60f523a370aa3a9617c2b8550ee" +checksum = "a4689e6c2294d81e88dc6261c768b63bc4fcdb852be6d1352498b114f61383b7" dependencies = [ "cc", "cfg-if", - "getrandom 0.2.11", + "getrandom 0.2.16", "libc", "untrusted", "windows-sys 0.52.0", @@ -3950,30 +4101,30 @@ dependencies = [ [[package]] name = "rpassword" -version = "7.3.1" +version = "7.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "80472be3c897911d0137b2d2b9055faf6eeac5b14e324073d83bc17b191d7e3f" +checksum = "66d4c8b64f049c6721ec8ccec37ddfc3d641c4a7fca57e8f2a89de509c73df39" dependencies = [ "libc", "rtoolbox", - "windows-sys 0.48.0", + "windows-sys 0.59.0", ] [[package]] name = "rtoolbox" -version = "0.0.2" +version = "0.0.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c247d24e63230cdb56463ae328478bd5eac8b8faa8c69461a77e8e323afac90e" +checksum = "a7cc970b249fbe527d6e02e0a227762c9108b2f49d81094fe357ffc6d14d7f6f" dependencies = [ "libc", - "windows-sys 0.48.0", + "windows-sys 0.52.0", ] [[package]] name = "rust-embed" -version = "8.5.0" +version = "8.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fa66af4a4fdd5e7ebc276f115e895611a34739a9c1c01028383d612d550953c0" +checksum = "025908b8682a26ba8d12f6f2d66b987584a4a87bc024abc5bbc12553a8cd178a" dependencies = [ "rust-embed-impl", "rust-embed-utils", @@ -3982,9 +4133,9 @@ dependencies = [ [[package]] name = "rust-embed-impl" -version = "8.5.0" +version = "8.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6125dbc8867951125eec87294137f4e9c2c96566e61bf72c45095a7c77761478" +checksum = "6065f1a4392b71819ec1ea1df1120673418bf386f50de1d6f54204d836d4349c" dependencies = [ "proc-macro2", "quote", @@ -3995,9 +4146,9 @@ dependencies = [ [[package]] name = "rust-embed-utils" -version = "8.5.0" +version = "8.7.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2e5347777e9aacb56039b0e1f28785929a8a3b709e87482e7442c72e7c12529d" +checksum = "f6cc0c81648b20b70c491ff8cce00c1c3b223bb8ed2b5d41f0e54c6c4c0a3594" dependencies = [ "sha2 0.10.9", "walkdir", @@ -4005,9 +4156,9 @@ dependencies = [ [[package]] name = "rustc-demangle" -version = "0.1.24" +version = "0.1.26" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "719b953e2095829ee67db738b3bfa9fa368c94900df327b3f07fe6e794d2fe1f" +checksum = "56f7d92ca342cea22a06f2121d944b4fd82af56988c270852495420f961d4ace" [[package]] name = "rustc-hash" @@ -4017,9 +4168,9 @@ checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2" [[package]] name = "rustc-hash" -version = "2.0.0" +version = "2.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "583034fd73374156e66797ed8e5b0d5690409c9226b22d87cb7f19821c05d152" +checksum = "357703d41365b4b27c590e3ed91eabb1b663f07c4c084095e60cbed4362dff0d" [[package]] name = "rustc_version" @@ -4032,15 +4183,28 @@ dependencies = [ [[package]] name = "rustix" -version = "0.38.34" +version = "0.38.44" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "70dc5ec042f7a43c4a73241207cecc9873a06d45debb38b329f8541d85c2730f" +checksum = "fdb5bc1ae2baa591800df16c9ca78619bf65c0488b41b96ccec5d11220d8c154" dependencies = [ "bitflags", "errno", "libc", - "linux-raw-sys", - "windows-sys 0.52.0", + "linux-raw-sys 0.4.15", + "windows-sys 0.59.0", +] + +[[package]] +name = "rustix" +version = "1.0.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "11181fbabf243db407ef8df94a6ce0b2f9a733bd8be4ad02b4eda9602296cac8" +dependencies = [ + "bitflags", + "errno", + "libc", + "linux-raw-sys 0.9.4", + "windows-sys 0.60.2", ] [[package]] @@ -4064,21 +4228,21 @@ dependencies = [ "log", "ring", "rustls-pki-types", - "rustls-webpki 0.102.6", + "rustls-webpki 0.102.8", "subtle", "zeroize", ] [[package]] name = "rustls" -version = "0.23.12" +version = "0.23.31" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c58f8c84392efc0a126acce10fa59ff7b3d2ac06ab451a33f2741989b806b044" +checksum = "c0ebcbd2f03de0fc1122ad9bb24b127a5a6cd51d72604a3f3c50ac459762b6cc" dependencies = [ "once_cell", "ring", "rustls-pki-types", - "rustls-webpki 0.102.6", + "rustls-webpki 0.103.4", "subtle", "zeroize", ] @@ -4092,7 +4256,7 @@ dependencies = [ "openssl-probe", "rustls-pemfile 1.0.4", "schannel", - "security-framework", + "security-framework 2.11.1", ] [[package]] @@ -4102,23 +4266,22 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e5bfb394eeed242e909609f56089eecfe5fda225042e8b171791b9c95f5931e5" dependencies = [ "openssl-probe", - "rustls-pemfile 2.1.3", + "rustls-pemfile 2.2.0", "rustls-pki-types", "schannel", - "security-framework", + "security-framework 2.11.1", ] [[package]] name = "rustls-native-certs" -version = "0.8.0" +version = "0.8.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fcaf18a4f2be7326cd874a5fa579fae794320a0f388d365dca7e480e55f83f8a" +checksum = "7fcff2dd52b58a8d98a70243663a0d234c4e2b79235637849d15913394a247d3" dependencies = [ "openssl-probe", - "rustls-pemfile 2.1.3", "rustls-pki-types", "schannel", - "security-framework", + "security-framework 3.4.0", ] [[package]] @@ -4132,19 +4295,22 @@ dependencies = [ [[package]] name = "rustls-pemfile" -version = "2.1.3" +version = "2.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "196fe16b00e106300d3e45ecfcb764fa292a535d7326a29a5875c579c7417425" +checksum = "dce314e5fee3f39953d46bb63bb8a46d40c2f8fb7cc5a3b6cab2bde9721d6e50" dependencies = [ - "base64 0.22.1", "rustls-pki-types", ] [[package]] name = "rustls-pki-types" -version = "1.8.0" +version = "1.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fc0a2ce646f8655401bb81e7927b812614bd5d91dbc968696be50603510fcaf0" +checksum = "229a4a4c221013e7e1f1a043678c5cc39fe5171437c88fb47151a21e6f5b5c79" +dependencies = [ + "web-time", + "zeroize", +] [[package]] name = "rustls-webpki" @@ -4158,9 +4324,20 @@ dependencies = [ [[package]] name = "rustls-webpki" -version = "0.102.6" +version = "0.102.8" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "64ca1bc8749bd4cf37b5ce386cc146580777b4e8572c7b97baf22c83f444bee9" +dependencies = [ + "ring", + "rustls-pki-types", + "untrusted", +] + +[[package]] +name = "rustls-webpki" +version = "0.103.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8e6b52d4fda176fd835fdc55a835d4a89b8499cad995885a21149d5ad62f852e" +checksum = "0a17884ae0c1b773f1ccd2bd4a8c72f16da897310a98b0e84bf349ad5ead92fc" dependencies = [ "ring", "rustls-pki-types", @@ -4169,15 +4346,15 @@ dependencies = [ [[package]] name = "rustversion" -version = "1.0.17" +version = "1.0.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "955d28af4278de8121b7ebeb796b6a45735dc01436d898801014aced2773a3d6" +checksum = "b39cdef0fa800fc44525c84ccb54a029961a8215f9619753635a9c0d2538d46d" [[package]] name = "ryu" -version = "1.0.18" +version = "1.0.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f3cb5ba0dc43242ce17de99c180e96db90b235b8a9fdc9543c96d2209116bd9f" +checksum = "28d3b2b1366ec20994f1fd18c3c594f05c5dd4bc44d8bb0c1c632c8d6829481f" [[package]] name = "same-file" @@ -4190,27 +4367,27 @@ dependencies = [ [[package]] name = "scc" -version = "2.3.3" +version = "2.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ea091f6cac2595aa38993f04f4ee692ed43757035c36e67c180b6828356385b1" +checksum = "46e6f046b7fef48e2660c57ed794263155d713de679057f2d0c169bfc6e756cc" dependencies = [ "sdd", ] [[package]] name = "schannel" -version = "0.1.23" +version = "0.1.27" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fbc91545643bcf3a0bbb6569265615222618bdf33ce4ffbbd13c4bbd4c093534" +checksum = "1f29ebaa345f945cec9fbbc532eb307f0fdad8161f281b6369539c8d84876b3d" dependencies = [ - "windows-sys 0.52.0", + "windows-sys 0.59.0", ] [[package]] name = "schemars" -version = "0.8.21" +version = "0.8.22" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09c024468a378b7e36765cd36702b7a90cc3cba11654f6685c8f233408e89e92" +checksum = "3fbf2ae1b8bc8e02df939598064d22402220cd5bbcca1c76f7d6a310974d5615" dependencies = [ "dyn-clone", "schemars_derive", @@ -4219,17 +4396,47 @@ dependencies = [ ] [[package]] -name = "schemars_derive" -version = "0.8.21" +name = "schemars" +version = "0.9.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b1eee588578aff73f856ab961cd2f79e36bc45d7ded33a7562adba4667aecc0e" +checksum = "4cd191f9397d57d581cddd31014772520aa448f65ef991055d7f61582c65165f" dependencies = [ - "proc-macro2", - "quote", - "serde_derive_internals", - "syn 2.0.106", -] - + "dyn-clone", + "ref-cast", + "serde", + "serde_json", +] + +[[package]] +name = "schemars" +version = "1.0.4" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "82d20c4491bc164fa2f6c5d44565947a52ad80b9505d8e36f8d54c27c739fcd0" +dependencies = [ + "dyn-clone", + "ref-cast", + "serde", + "serde_json", +] + +[[package]] +name = "schemars_derive" +version = "0.8.22" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "32e265784ad618884abaea0600a9adf15393368d840e0222d101a072f3f7534d" +dependencies = [ + "proc-macro2", + "quote", + "serde_derive_internals", + "syn 2.0.106", +] + +[[package]] +name = "scoped-tls" +version = "1.0.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e1cf6437eb19a8f4a6cc0f7dca544973b0b78843adbfeb3683d1a94a0024a294" + [[package]] name = "scopeguard" version = "1.2.0" @@ -4238,9 +4445,9 @@ checksum = "94143f37725109f92c262ed2cf5e59bce7498c01bcc1502d7b9afe439a4e9f49" [[package]] name = "scratch" -version = "1.0.7" +version = "1.0.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a3cf7c11c38cb994f3d40e8a8cde3bbd1f72a435e4c49e85d6553d8312306152" +checksum = "d68f2ec51b097e4c1a75b681a8bec621909b5e91f15bb7b840c4f2f7b01148b2" [[package]] name = "sct" @@ -4254,15 +4461,15 @@ dependencies = [ [[package]] name = "sdd" -version = "3.0.7" +version = "3.0.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b07779b9b918cc05650cb30f404d4d7835d26df37c235eded8a6832e2fb82cca" +checksum = "490dcfcbfef26be6800d11870ff2df8774fa6e86d047e3e8c8a76b25655e41ca" [[package]] name = "sec1" -version = "0.7.2" +version = "0.7.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f0aec48e813d6b90b15f0b8948af3c63483992dee44c03e9930b3eebdabe046e" +checksum = "d3e97a565f76233a6003f9f5c54be1d9c5bdfa3eccfb189469f11ec4901c47dc" dependencies = [ "base16ct", "der", @@ -4297,7 +4504,20 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "897b2245f0b511c87893af39b033e5ca9cce68824c4d7e7630b5a1d339658d02" dependencies = [ "bitflags", - "core-foundation", + "core-foundation 0.9.4", + "core-foundation-sys", + "libc", + "security-framework-sys", +] + +[[package]] +name = "security-framework" +version = "3.4.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "60b369d18893388b345804dc0007963c99b7d665ae71d275812d828c6f089640" +dependencies = [ + "bitflags", + "core-foundation 0.10.1", "core-foundation-sys", "libc", "security-framework-sys", @@ -4305,9 +4525,9 @@ dependencies = [ [[package]] name = "security-framework-sys" -version = "2.11.1" +version = "2.15.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "75da29fe9b9b08fe9d6b22b5b4bcbc75d8db3aa31e639aa56bb62e9d46bfceaf" +checksum = "cc1f0cbffaac4852523ce30d8bd3c5cdc873501d96ff467ca09b6767bb8cd5c0" dependencies = [ "core-foundation-sys", "libc", @@ -4315,9 +4535,9 @@ dependencies = [ [[package]] name = "semver" -version = "1.0.20" +version = "1.0.26" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "836fa6a3e1e547f9a2c4040802ec865b5d85f4014efe00555d7090a3dcaa1090" +checksum = "56e6fa9c48d24d85fb3de5ad847117517440f6beceb7798af16b4a87d616b8d0" dependencies = [ "serde", ] @@ -4330,35 +4550,46 @@ checksum = "cec6914e06f503f83e431e1762c82003c5233b1dffb6185e51e4c40dd1c26eaa" dependencies = [ "slipped10", "stellar-strkey 0.0.8", - "thiserror", + "thiserror 1.0.69", "tiny-bip39", ] [[package]] name = "serde" -version = "1.0.217" +version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "02fc4265df13d6fa1d00ecff087228cc0a2b5f3c0e87e258d8b94a156e984c70" +checksum = "5f0e2c6ed6606019b4e29e69dbaba95b11854410e5347d525002456dbbb786b6" dependencies = [ "serde_derive", ] [[package]] name = "serde-aux" -version = "4.5.0" +version = "4.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0d2e8bfba469d06512e11e3311d4d051a4a387a5b42d010404fecf3200321c95" +checksum = "207f67b28fe90fb596503a9bf0bf1ea5e831e21307658e177c5dfcdfc3ab8a0a" dependencies = [ "chrono", "serde", + "serde-value", "serde_json", ] +[[package]] +name = "serde-value" +version = "0.7.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f3a1a3341211875ef120e117ea7fd5228530ae7e7036a779fdc9117be6b3282c" +dependencies = [ + "ordered-float", + "serde", +] + [[package]] name = "serde_derive" -version = "1.0.217" +version = "1.0.219" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5a9bf7cf98d04a2b28aead066b7496853d4779c9cc183c440dbac457641e19a0" +checksum = "5b0276cf7f2c73365f7157c8123c21cd9a50fbbd844757af28ca1f5925fc2a00" dependencies = [ "proc-macro2", "quote", @@ -4367,9 +4598,9 @@ dependencies = [ [[package]] name = "serde_derive_internals" -version = "0.29.0" +version = "0.29.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "330f01ce65a3a5fe59a60c82f3c9a024b573b8a6e875bd233fe5f934e71d54e3" +checksum = "18d26a20a969b9e3fdf2fc2d9f21eda6c40e2de84c9408bb5d3b05d499aae711" dependencies = [ "proc-macro2", "quote", @@ -4378,9 +4609,9 @@ dependencies = [ [[package]] name = "serde_json" -version = "1.0.138" +version = "1.0.143" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d434192e7da787e94a6ea7e9670b26a036d0ca41e0b7efb2676dd32bae872949" +checksum = "d401abef1d108fbd9cbaebc3e46611f4b1021f714a0597a71f41ee463f5f4a5a" dependencies = [ "itoa", "memchr", @@ -4400,9 +4631,9 @@ dependencies = [ [[package]] name = "serde_repr" -version = "0.1.17" +version = "0.1.20" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3081f5ffbb02284dda55132aa26daecedd7372a42417bbbab6f14ab7d6bb9145" +checksum = "175ee3e80ae9982737ca543e96133087cbd9a485eecc3bc4de9c1a37b47ea59c" dependencies = [ "proc-macro2", "quote", @@ -4411,9 +4642,9 @@ dependencies = [ [[package]] name = "serde_spanned" -version = "0.6.7" +version = "0.6.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "eb5b1b31579f3811bf615c144393417496f152e12ac8b7663bf664f4a815306d" +checksum = "bf41e0cfaf7226dca15e8197172c295a782857fcb97fad1808a166870dee75a3" dependencies = [ "serde", ] @@ -4432,16 +4663,18 @@ dependencies = [ [[package]] name = "serde_with" -version = "3.12.0" +version = "3.14.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d6b6f7f2fcb69f747921f79f3926bd1e203fce4fef62c268dd3abfb6d86029aa" +checksum = "f2c45cd61fefa9db6f254525d46e392b852e0e61d9a1fd36e5bd183450a556d5" dependencies = [ "base64 0.22.1", "chrono", "hex", "indexmap 1.9.3", - "indexmap 2.3.0", - "schemars", + "indexmap 2.11.0", + "schemars 0.8.22", + "schemars 0.9.0", + "schemars 1.0.4", "serde", "serde_derive", "serde_json", @@ -4451,9 +4684,9 @@ dependencies = [ [[package]] name = "serde_with_macros" -version = "3.12.0" +version = "3.14.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8d00caa5193a3c8362ac2b73be6b9e768aa5a4b2f721d8f4b339600c3cb51f8e" +checksum = "de90945e6565ce0d9a25098082ed4ee4002e047cb59892c318d66821e14bb30f" dependencies = [ "darling", "proc-macro2", @@ -4463,9 +4696,9 @@ dependencies = [ [[package]] name = "serial_test" -version = "3.1.1" +version = "3.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4b4b487fe2acf240a021cf57c6b2b4903b1e78ca0ecd862a71b71d2a51fed77d" +checksum = "1b258109f244e1d6891bf1053a55d63a5cd4f8f4c30cf9a1280989f80e7a1fa9" dependencies = [ "futures", "log", @@ -4477,9 +4710,9 @@ dependencies = [ [[package]] name = "serial_test_derive" -version = "3.1.1" +version = "3.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "82fe9db325bcef1fbcde82e078a5cc4efdf787e96b3b9cf45b50b529f2083d67" +checksum = "5d69265a08751de7844521fd15003ae0a888e035773ba05695c5c759a6f89eef" dependencies = [ "proc-macro2", "quote", @@ -4560,18 +4793,18 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64" [[package]] name = "signal-hook-registry" -version = "1.4.2" +version = "1.4.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a9e9e0b4211b72e7b8b6e85c807d36c212bdb33ea8587f7569562a84df5465b1" +checksum = "b2a4719bff48cee6b39d12c020eeb490953ad2443b7055bd0b21fca26bd8c28b" dependencies = [ "libc", ] [[package]] name = "signature" -version = "2.1.0" +version = "2.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5e1788eed21689f9cf370582dfc467ef36ed9c707f073528ddafa8d83e3b8500" +checksum = "77549399552de45a898a580c1b41d445bf730df867cc44e6c0233bbc4b8329de" dependencies = [ "digest 0.10.7", "rand_core 0.6.4", @@ -4579,24 +4812,21 @@ dependencies = [ [[package]] name = "similar" -version = "2.6.0" +version = "2.7.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1de1d4f81173b03af4c0cbed3c898f6bff5b870e4a7f5d6f4057d62a7a4b686e" +checksum = "bbbb5d9659141646ae647b42fe094daf6c6192d1620870b449d9557f748b2daa" [[package]] name = "siphasher" -version = "0.3.11" +version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "38b58827f4464d87d377d175e90bf58eb00fd8716ff0a62f80356b5e61555d0d" +checksum = "56199f7ddabf13fe5074ce809e7d3f42b42ae711800501b5b16ea82ad029c39d" [[package]] name = "slab" -version = "0.4.9" +version = "0.4.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8f92a496fb766b417c996b9c5e57daf2f7ad3b0bebe1ccfca4856390e3d3bb67" -dependencies = [ - "autocfg", -] +checksum = "7a2ae44ef20feb57a68b23d846850f861394c2e02dc425a50098ae8c90267589" [[package]] name = "slipped10" @@ -4639,14 +4869,24 @@ dependencies = [ [[package]] name = "socket2" -version = "0.5.7" +version = "0.5.10" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ce305eb0b4296696835b71df73eb912e0f1ffd2556a501fcede6e0c50349191c" +checksum = "e22376abed350d73dd1cd119b57ffccad95b4e585a7cda43e286245ce23c0678" dependencies = [ "libc", "windows-sys 0.52.0", ] +[[package]] +name = "socket2" +version = "0.6.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "233504af464074f9d066d7b5416c5f9b894a5862a6506e306f7b816cdd6f1807" +dependencies = [ + "libc", + "windows-sys 0.59.0", +] + [[package]] name = "soroban-builtin-sdk-macros" version = "23.0.1" @@ -4734,11 +4974,11 @@ dependencies = [ "tempfile", "termcolor", "termcolor_output", - "thiserror", + "thiserror 1.0.69", "tokio", "tokio-util", "toml", - "toml_edit 0.22.20", + "toml_edit", "tracing", "tracing-appender", "tracing-subscriber", @@ -4797,7 +5037,7 @@ dependencies = [ "ed25519-dalek", "elliptic-curve", "generic-array", - "getrandom 0.2.11", + "getrandom 0.2.16", "hex-literal", "hmac 0.12.1", "k256", @@ -4848,7 +5088,7 @@ dependencies = [ "serde_with", "soroban-env-common", "soroban-env-host", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -4902,7 +5142,7 @@ checksum = "72526d30f8825b859afa7e0b94549dad05c58a6c928b0763620412744512d7e2" dependencies = [ "base64 0.22.1", "stellar-xdr", - "thiserror", + "thiserror 1.0.69", "wasmparser", ] @@ -4917,7 +5157,7 @@ dependencies = [ "sha2 0.9.9", "soroban-spec", "stellar-xdr", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -4933,7 +5173,7 @@ dependencies = [ "soroban-spec", "stellar-xdr", "syn 2.0.106", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -4948,7 +5188,7 @@ dependencies = [ "soroban-spec", "stellar-strkey 0.0.11", "stellar-xdr", - "thiserror", + "thiserror 1.0.69", "tokio", "wasmparser", "which", @@ -4971,7 +5211,7 @@ dependencies = [ "soroban-spec", "stellar-xdr", "temp-dir", - "thiserror", + "thiserror 1.0.69", "walkdir", ] @@ -5002,7 +5242,7 @@ dependencies = [ "stellar-strkey 0.0.11", "test-case", "testcontainers", - "thiserror", + "thiserror 1.0.69", "tokio", "toml", "tracing", @@ -5123,7 +5363,7 @@ dependencies = [ "stellar-xdr", "test-case", "testcontainers", - "thiserror", + "thiserror 1.0.69", "tokio", "tracing", ] @@ -5136,7 +5376,7 @@ checksum = "a0f2413934c66624657094160198b01abe6dc6d0d2a3f9befbb21eeb8fd0b111" dependencies = [ "clap", "hex", - "http 1.1.0", + "http 1.3.1", "itertools 0.10.5", "jsonrpsee-core", "jsonrpsee-http-client", @@ -5149,7 +5389,7 @@ dependencies = [ "stellar-xdr", "termcolor", "termcolor_output", - "thiserror", + "thiserror 1.0.69", "tokio", ] @@ -5161,7 +5401,7 @@ checksum = "12d2bf45e114117ea91d820a846fd1afbe3ba7d717988fee094ce8227a3bf8bd" dependencies = [ "base32", "crate-git-revision", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -5172,7 +5412,7 @@ checksum = "5e3aa3ed00e70082cb43febc1c2afa5056b9bb3e348bbb43d0cd0aa88a611144" dependencies = [ "crate-git-revision", "data-encoding", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -5209,14 +5449,14 @@ dependencies = [ "escape-bytes", "ethnum", "hex", - "rand 0.9.1", - "schemars", + "rand 0.9.2", + "schemars 0.8.22", "serde", "serde_json", "serde_with", "sha2 0.10.9", "stellar-strkey 0.0.13", - "thiserror", + "thiserror 1.0.69", ] [[package]] @@ -5327,18 +5567,18 @@ dependencies = [ [[package]] name = "sync_wrapper" -version = "1.0.1" +version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a7065abeca94b6a8a577f9bd45aa0867a2238b74e8eb67cf10d492bc39351394" +checksum = "0bf256ce5efdfa370213c1dabab5935a12e49f2c58d15e9eac2870d3b4f27263" dependencies = [ "futures-core", ] [[package]] name = "synstructure" -version = "0.13.1" +version = "0.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c8af7666ab7b6390ab78131fb5b0fce11d6b7a6951602017c35fa82800708971" +checksum = "728a70f3dbaf5bab7f0c4b1ac8d7ae5ea60a4b5549c8a5914361c99147a709d2" dependencies = [ "proc-macro2", "quote", @@ -5352,7 +5592,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3c879d448e9d986b661742763247d3693ed13609438cf3d006f51f5368a5ba6b" dependencies = [ "bitflags", - "core-foundation", + "core-foundation 0.9.4", "system-configuration-sys", ] @@ -5366,23 +5606,29 @@ dependencies = [ "libc", ] +[[package]] +name = "tagptr" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7b2093cf4c8eb1e67749a6762251bc9cd836b6fc171623bd0a9d324d37af2417" + [[package]] name = "temp-dir" -version = "0.1.13" +version = "0.1.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1f227968ec00f0e5322f9b8173c7a0cbcff6181a0a5b28e9892491c286277231" +checksum = "83176759e9416cf81ee66cb6508dbfe9c96f20b8b56265a39917551c23c70964" [[package]] name = "tempfile" -version = "3.12.0" +version = "3.21.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "04cbcdd0c794ebb0d4cf35e88edd2f7d2c4c3e9a5a6dab322839b321c6a87a64" +checksum = "15b61f8f20e3a6f7e0649d825294eaf317edce30f82cf6026e7e4cb9222a7d1e" dependencies = [ - "cfg-if", "fastrand", + "getrandom 0.3.3", "once_cell", - "rustix", - "windows-sys 0.59.0", + "rustix 1.0.8", + "windows-sys 0.60.2", ] [[package]] @@ -5423,9 +5669,9 @@ checksum = "f34dde0bb841eb3762b42bdff8db11bbdbc0a3bd7b32012955f5ce1d081f86c1" [[package]] name = "termtree" -version = "0.4.1" +version = "0.5.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3369f5ac52d5eb6ab48c6b4ffdc8efbcad6b89c765749064ba298f2c68a16a76" +checksum = "8f50febec83f5ee1df3015341d8bd429f2d1cc62bcba7ea2076759d315084683" [[package]] name = "test-case" @@ -5539,7 +5785,7 @@ dependencies = [ "serde", "serde_json", "serde_with", - "thiserror", + "thiserror 1.0.69", "tokio", "tokio-stream", "tokio-util", @@ -5548,18 +5794,38 @@ dependencies = [ [[package]] name = "thiserror" -version = "1.0.64" +version = "1.0.69" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b6aaf5339b578ea85b50e080feb250a3e8ae8cfcdff9a461c9ec2904bc923f52" +dependencies = [ + "thiserror-impl 1.0.69", +] + +[[package]] +name = "thiserror" +version = "2.0.16" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3467d614147380f2e4e374161426ff399c91084acd2363eaf549172b3d5e60c0" +dependencies = [ + "thiserror-impl 2.0.16", +] + +[[package]] +name = "thiserror-impl" +version = "1.0.69" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d50af8abc119fb8bb6dbabcfa89656f46f84aa0ac7688088608076ad2b459a84" +checksum = "4fee6c4efc90059e10f81e6d42c60a18f76588c3d74cb83a0b242a2b6c7504c1" dependencies = [ - "thiserror-impl", + "proc-macro2", + "quote", + "syn 2.0.106", ] [[package]] name = "thiserror-impl" -version = "1.0.64" +version = "2.0.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "08904e7672f5eb876eaaf87e0ce17857500934f4981c4a0ab2b4aa98baac7fc3" +checksum = "6c5e1be1c48b9172ee610da68fd9cd2770e7a4056cb3fc98710ee6906f0c7960" dependencies = [ "proc-macro2", "quote", @@ -5568,22 +5834,20 @@ dependencies = [ [[package]] name = "thread_local" -version = "1.1.8" +version = "1.1.9" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "8b9ef9bad013ada3808854ceac7b46812a6465ba368859a37e2100283d2d719c" +checksum = "f60246a4944f24f6e018aa17cdeffb7818b76356965d03b07d6a9886e8962185" dependencies = [ "cfg-if", - "once_cell", ] [[package]] name = "time" -version = "0.3.36" +version = "0.3.43" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5dfd88e563464686c916c7e46e623e520ddc6d79fa6641390f2e3fa86e83e885" +checksum = "83bde6f1ec10e72d583d91623c939f623002284ef622b87de38cfd546cbf2031" dependencies = [ "deranged", - "itoa", "num-conv", "powerfmt", "serde", @@ -5593,15 +5857,15 @@ dependencies = [ [[package]] name = "time-core" -version = "0.1.2" +version = "0.1.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "ef927ca75afb808a4d64dd374f00a2adf8d0fcff8e7b184af886c3c87ec4a3f3" +checksum = "40868e7c1d2f0b8d73e4a8c7f0ff63af4f6d19be117e90bd73eb1d62cf831c6b" [[package]] name = "time-macros" -version = "0.2.18" +version = "0.2.24" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3f252a68540fde3a3877aeea552b832b40ab9a69e318efd078774a01ddee1ccf" +checksum = "30cfb0125f12d9c277f35663a0a33f8c30190f4e4574868a330595412d34ebf3" dependencies = [ "num-conv", "time-core", @@ -5620,7 +5884,7 @@ dependencies = [ "rand 0.8.5", "rustc-hash 1.1.0", "sha2 0.10.9", - "thiserror", + "thiserror 1.0.69", "unicode-normalization", "wasm-bindgen", "zeroize", @@ -5637,9 +5901,9 @@ dependencies = [ [[package]] name = "tinystr" -version = "0.7.6" +version = "0.8.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9117f5d4db391c1cf6927e7bea3db74b9a1c1add8f7eda9ffd5364f40f57b82f" +checksum = "5d4f6d1145dcb577acf783d4e601bc1d76a13337bb54e6233add580b07344c8b" dependencies = [ "displaydoc", "zerovec", @@ -5647,9 +5911,9 @@ dependencies = [ [[package]] name = "tinyvec" -version = "1.8.0" +version = "1.10.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "445e881f4f6d382d5f27c034e25eb92edd7c784ceab92a0937db7f2e9471b938" +checksum = "bfa5fdc3bce6191a1dbc8c02d5c8bffcf557bafa17c124c5264a458f1b0613fa" dependencies = [ "tinyvec_macros", ] @@ -5662,27 +5926,29 @@ checksum = "1f3ccbac311fea05f86f61904b462b55fb3df8837a366dfc601a0161d0532f20" [[package]] name = "tokio" -version = "1.42.1" +version = "1.47.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2209a14885b74764cce87ffa777ffa1b8ce81a3f3166c6f886b83337fe7e077f" +checksum = "89e49afdadebb872d3145a5638b59eb0691ea23e46ca484037cfab3b76b95038" dependencies = [ "backtrace", "bytes", + "io-uring", "libc", "mio", "parking_lot", "pin-project-lite", "signal-hook-registry", - "socket2", + "slab", + "socket2 0.6.0", "tokio-macros", - "windows-sys 0.52.0", + "windows-sys 0.59.0", ] [[package]] name = "tokio-macros" -version = "2.4.0" +version = "2.5.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "693d596312e88961bc67d7f1f97af8a70227d9f90c31bba5806eec004978d752" +checksum = "6e06d43f1345a3bcd39f6a56dbb7dcab2ba47e68e8ac134855e7e2bdbaf8cab8" dependencies = [ "proc-macro2", "quote", @@ -5722,20 +5988,19 @@ dependencies = [ [[package]] name = "tokio-rustls" -version = "0.26.0" +version = "0.26.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0c7bc40d0e5a97695bb96e27995cd3a08538541b0a846f65bba7a359f36700d4" +checksum = "8e727b36a1a0e8b74c376ac2211e40c2c8af09fb4013c60d910495810f008e9b" dependencies = [ - "rustls 0.23.12", - "rustls-pki-types", + "rustls 0.23.31", "tokio", ] [[package]] name = "tokio-stream" -version = "0.1.16" +version = "0.1.17" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4f4e6ce100d0eb49a2734f8c0812bcd324cf357d21810932c5df6b96ef2b86f1" +checksum = "eca58d7bba4a75707817a2c44174253f9236b2d5fbd055602e9d5c07c139a047" dependencies = [ "futures-core", "pin-project-lite", @@ -5744,9 +6009,9 @@ dependencies = [ [[package]] name = "tokio-util" -version = "0.7.11" +version = "0.7.16" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9cf6b47b3771c49ac75ad09a6162f53ad4b8088b76ac60e8ec1455b31a189fe1" +checksum = "14307c986784f72ef81c89db7d9e28d6ac26d16213b109ea501696195e6e3ce5" dependencies = [ "bytes", "futures-core", @@ -5758,48 +6023,44 @@ dependencies = [ [[package]] name = "toml" -version = "0.8.19" +version = "0.8.23" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1ed1f98e3fdc28d6d910e6737ae6ab1a93bf1985935a1193e68f93eeb68d24e" +checksum = "dc1beb996b9d83529a9e75c17a1686767d148d70663143c7854d8b4a09ced362" dependencies = [ "serde", "serde_spanned", "toml_datetime", - "toml_edit 0.22.20", + "toml_edit", ] [[package]] name = "toml_datetime" -version = "0.6.8" +version = "0.6.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0dd7358ecb8fc2f8d014bf86f6f638ce72ba252a2c3a2572f2a795f1d23efb41" +checksum = "22cddaf88f4fbc13c51aebbf5f8eceb5c7c5a9da2ac40a13519eb5b0a0e8f11c" dependencies = [ "serde", ] [[package]] name = "toml_edit" -version = "0.19.15" +version = "0.22.27" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1b5bb770da30e5cbfde35a2d7b9b8a2c4b8ef89548a7a6aeab5c9a576e3e7421" +checksum = "41fe8c660ae4257887cf66394862d21dbca4a6ddd26f04a3560410406a2f819a" dependencies = [ - "indexmap 2.3.0", + "indexmap 2.11.0", + "serde", + "serde_spanned", "toml_datetime", - "winnow 0.5.40", + "toml_write", + "winnow", ] [[package]] -name = "toml_edit" -version = "0.22.20" +name = "toml_write" +version = "0.1.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "583c44c02ad26b0c3f3066fe629275e50627026c51ac2e595cca4c230ce1ce1d" -dependencies = [ - "indexmap 2.3.0", - "serde", - "serde_spanned", - "toml_datetime", - "winnow 0.6.18", -] +checksum = "5d99f8c9a7727884afe522e9bd5edbfc91a3312b36a77b5fb8926e4c31a41801" [[package]] name = "tower" @@ -5811,23 +6072,55 @@ dependencies = [ "futures-util", "pin-project", "pin-project-lite", - "tokio", "tower-layer", "tower-service", "tracing", ] +[[package]] +name = "tower" +version = "0.5.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d039ad9159c98b70ecfd540b2573b97f7f52c3e8d9f8ad57a24b916a536975f9" +dependencies = [ + "futures-core", + "futures-util", + "pin-project-lite", + "sync_wrapper", + "tokio", + "tower-layer", + "tower-service", +] + +[[package]] +name = "tower-http" +version = "0.6.6" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "adc82fd73de2a9722ac5da747f12383d2bfdb93591ee6c58486e0097890f05f2" +dependencies = [ + "bitflags", + "bytes", + "futures-util", + "http 1.3.1", + "http-body 1.0.1", + "iri-string", + "pin-project-lite", + "tower 0.5.2", + "tower-layer", + "tower-service", +] + [[package]] name = "tower-layer" -version = "0.3.2" +version = "0.3.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c20c8dbed6283a09604c3e69b4b7eeb54e298b8a600d4d5ecb5ad39de609f1d0" +checksum = "121c2a6cda46980bb0fcd1647ffaf6cd3fc79a013de288782836f6df9c48780e" [[package]] name = "tower-service" -version = "0.3.2" +version = "0.3.3" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b6bc1c9ce2b5135ac7f93c72918fc37feb872bdc6a5533a8b85eb4b86bfdae52" +checksum = "8df9b6e13f2d32c91b9bd719c00d1958837bc7dec474d94952798cc8e69eeec3" [[package]] name = "tracing" @@ -5848,7 +6141,7 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3566e8ce28cc0a3fe42519fc80e6b4c943cc4c8cef275620eb8dac2d3d4e06cf" dependencies = [ "crossbeam-channel", - "thiserror", + "thiserror 1.0.69", "time", "tracing-subscriber", ] @@ -5911,9 +6204,9 @@ checksum = "e421abadd41a4225275504ea4d6566923418b7f05506fbc9c0fe86ba7396114b" [[package]] name = "typenum" -version = "1.17.0" +version = "1.18.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "42ff0bf0c66b8238c6f3b578df37d0b7848e55df8577b3f74f92a69acceeb825" +checksum = "1dccffe3ce07af9386bfd29e80c0ab1a8205a2fc34e4bcd40364df902cfa8f3f" [[package]] name = "uds_windows" @@ -5928,12 +6221,11 @@ dependencies = [ [[package]] name = "ulid" -version = "1.1.3" +version = "1.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "04f903f293d11f31c0c29e4148f6dc0d033a7f80cebc0282bea147611667d289" +checksum = "470dbf6591da1b39d43c14523b2b469c86879a53e8b758c8e090a470fe7b1fbe" dependencies = [ - "getrandom 0.2.11", - "rand 0.8.5", + "rand 0.9.2", "serde", "web-time", ] @@ -5946,30 +6238,36 @@ checksum = "10103c57044730945224467c09f71a4db0071c123a0648cc3e818913bde6b561" [[package]] name = "unicode-ident" -version = "1.0.12" +version = "1.0.18" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "3354b9ac3fae1ff6755cb6db53683adb661634f67557942dea4facebec0fee4b" +checksum = "5a5f39404a5da50712a4c1eecf25e90dd62b613502b7e925fd4e4d19b5c96512" [[package]] name = "unicode-normalization" -version = "0.1.23" +version = "0.1.24" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a56d1686db2308d901306f92a263857ef59ea39678a5458e7cb17f01415101f5" +checksum = "5033c97c4262335cded6d6fc3e5c18ab755e1a3dc96376350f3d8e9f009ad956" dependencies = [ "tinyvec", ] [[package]] name = "unicode-segmentation" -version = "1.11.0" +version = "1.12.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d4c87d22b6e3f4a18d4d40ef354e97c90fcb14dd91d7dc0aa9d8a1172ebf7202" +checksum = "f6ccf251212114b54433ec949fd6a7841275f9ada20dddd2f29e9ceea4501493" [[package]] name = "unicode-width" -version = "0.1.13" +version = "0.1.14" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "7dd6e30e90baa6f72411720665d41d89b9a3d039dc45b8faea1ddd07f617f6af" + +[[package]] +name = "unicode-width" +version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "0336d538f7abc86d282a4189614dfaa90810dfc2c6f6427eaf88e16311dd225d" +checksum = "4a1a07cc7db3810833284e8d372ccdc6da29741639ecc70c9ec107df0fa6154c" [[package]] name = "unicode-xid" @@ -5985,9 +6283,9 @@ checksum = "8ecb6da28b8a351d773b68d5825ac39017e680750f980f3a1a85cd8dd28a47c1" [[package]] name = "url" -version = "2.5.4" +version = "2.5.7" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "32f8b686cadd1473f4bd0117a5d28d36b1ade384ea9b5069a1c40aefed7fda60" +checksum = "08bc136a29a3d1758e07a9cca267be308aeebf5cfd5a10f3f67ab2097683ef5b" dependencies = [ "form_urlencoded", "idna", @@ -5995,12 +6293,6 @@ dependencies = [ "serde", ] -[[package]] -name = "utf16_iter" -version = "1.0.5" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c8232dd3cdaed5356e0f716d285e4b40b932ac434100fe9b7e0e8e935b9e6246" - [[package]] name = "utf8_iter" version = "1.0.4" @@ -6013,17 +6305,28 @@ version = "0.2.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821" +[[package]] +name = "uuid" +version = "1.18.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2f87b8aa10b915a06587d0dec516c282ff295b475d94abf425d62b57710070a2" +dependencies = [ + "getrandom 0.3.3", + "js-sys", + "wasm-bindgen", +] + [[package]] name = "valuable" -version = "0.1.0" +version = "0.1.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "830b7e5d4d90034032940e4ace0d9a9a057e7a45cd94e6c007832e39edb82f6d" +checksum = "ba73ea9cf16a25df0c8caa16c51acb937d5712a8429db78a3ee29d5dcacd3a65" [[package]] name = "value-bag" -version = "1.9.0" +version = "1.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "5a84c137d37ab0142f0f2ddfe332651fdbf252e7b7dbb4e67b6c1f1b2e925101" +checksum = "943ce29a8a743eb10d6082545d861b24f9d1b160b7d741e0f2cdf726bec909c5" [[package]] name = "vcpkg" @@ -6039,9 +6342,9 @@ checksum = "0b928f33d975fc6ad9f86c8f283853ad26bdd5b10b7f1542aa2fa15e2289105a" [[package]] name = "wait-timeout" -version = "0.2.0" +version = "0.2.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9f200f5b12eb75f8c1ed65abd4b2db8a6e1b138a20de009dacee265a2498f3f6" +checksum = "09ac3b126d3914f9849036f826e054cbabdc8519970b8998ddaf3b5bd3c65f11" dependencies = [ "libc", ] @@ -6067,17 +6370,17 @@ dependencies = [ [[package]] name = "wasi" -version = "0.11.0+wasi-snapshot-preview1" +version = "0.11.1+wasi-snapshot-preview1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9c8d87e72b64a3b4db28d11ce29237c246188f4f51057d65a7eab63b7987e423" +checksum = "ccf3ec651a847eb01de73ccad15eb7d99f80485de043efb2f370cd654f4ea44b" [[package]] name = "wasi" -version = "0.14.2+wasi-0.2.4" +version = "0.14.4+wasi-0.2.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "9683f9a5a998d873c0d21fcbe3c083009670149a8fab228644b8bd36b2c48cb3" +checksum = "88a5f4a424faf49c3c2c344f166f0662341d470ea185e939657aaff130f0ec4a" dependencies = [ - "wit-bindgen-rt", + "wit-bindgen", ] [[package]] @@ -6088,23 +6391,25 @@ checksum = "b8dad83b4f25e74f184f64c43b150b91efe7647395b42289f38e50566d82855b" [[package]] name = "wasm-bindgen" -version = "0.2.92" +version = "0.2.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4be2531df63900aeb2bca0daaaddec08491ee64ceecbee5076636a3b026795a8" +checksum = "7e14915cadd45b529bb8d1f343c4ed0ac1de926144b746e2710f9cd05df6603b" dependencies = [ "cfg-if", + "once_cell", + "rustversion", "wasm-bindgen-macro", + "wasm-bindgen-shared", ] [[package]] name = "wasm-bindgen-backend" -version = "0.2.92" +version = "0.2.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "614d787b966d3989fa7bb98a654e369c762374fd3213d212cfc0251257e747da" +checksum = "e28d1ba982ca7923fd01448d5c30c6864d0a14109560296a162f80f305fb93bb" dependencies = [ "bumpalo", "log", - "once_cell", "proc-macro2", "quote", "syn 2.0.106", @@ -6113,21 +6418,22 @@ dependencies = [ [[package]] name = "wasm-bindgen-futures" -version = "0.4.42" +version = "0.4.51" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "76bc14366121efc8dbb487ab05bcc9d346b3b5ec0eaa76e46594cabbe51762c0" +checksum = "0ca85039a9b469b38336411d6d6ced91f3fc87109a2a27b0c197663f5144dffe" dependencies = [ "cfg-if", "js-sys", + "once_cell", "wasm-bindgen", "web-sys", ] [[package]] name = "wasm-bindgen-macro" -version = "0.2.92" +version = "0.2.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a1f8823de937b71b9460c0c34e25f3da88250760bec0ebac694b49997550d726" +checksum = "7c3d463ae3eff775b0c45df9da45d68837702ac35af998361e2c84e7c5ec1b0d" dependencies = [ "quote", "wasm-bindgen-macro-support", @@ -6135,9 +6441,9 @@ dependencies = [ [[package]] name = "wasm-bindgen-macro-support" -version = "0.2.92" +version = "0.2.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e94f17b526d0a461a191c78ea52bbce64071ed5c04c9ffe424dcb38f74171bb7" +checksum = "7bb4ce89b08211f923caf51d527662b75bdc9c9c7aab40f86dcb9fb85ac552aa" dependencies = [ "proc-macro2", "quote", @@ -6148,9 +6454,12 @@ dependencies = [ [[package]] name = "wasm-bindgen-shared" -version = "0.2.92" +version = "0.2.101" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "af190c94f2773fdb3729c55b007a722abb5384da03bc0986df4c289bf5567e96" +checksum = "f143854a3b13752c6950862c906306adb27c7e839f7414cec8fea35beab624c1" +dependencies = [ + "unicode-ident", +] [[package]] name = "wasm-gen" @@ -6173,7 +6482,7 @@ dependencies = [ "strum 0.24.1", "strum_macros 0.24.3", "tempfile", - "thiserror", + "thiserror 1.0.69", "wasm-opt-cxx-sys", "wasm-opt-sys", ] @@ -6204,9 +6513,9 @@ dependencies = [ [[package]] name = "wasm-streams" -version = "0.4.0" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b65dc4c90b63b118468cf747d8bf3566c1913ef60be765b5730ead9e0a3ba129" +checksum = "15053d8d85c7eccdbefef60f06769760a563c7f0a9d6902a13d35c7800b0ad65" dependencies = [ "futures-util", "js-sys", @@ -6239,7 +6548,7 @@ version = "0.116.1" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a58e28b80dd8340cb07b8242ae654756161f6fc8d0038123d679b7b99964fa50" dependencies = [ - "indexmap 2.3.0", + "indexmap 2.11.0", "semver", ] @@ -6254,9 +6563,9 @@ dependencies = [ [[package]] name = "web-sys" -version = "0.3.69" +version = "0.3.78" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "77afa9a11836342370f4817622a2f0f418b134426d91a82dfb48f532d2ec13ef" +checksum = "77e4b637749ff0d92b8fad63aa1f7cff3cbe125fd49c175cd6345e7272638b12" dependencies = [ "js-sys", "wasm-bindgen", @@ -6274,9 +6583,9 @@ dependencies = [ [[package]] name = "webpki-roots" -version = "0.26.3" +version = "1.0.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "bd7c23921eeb1713a4e851530e9b9756e4fb0e89978582942612524cf09f01cd" +checksum = "7e8983c3ab33d6fb807cfcdad2491c4ea8cbc8ed839181c7dfd9c67c83e261b2" dependencies = [ "rustls-pki-types", ] @@ -6291,25 +6600,25 @@ dependencies = [ "home", "once_cell", "regex", - "rustix", + "rustix 0.38.44", ] [[package]] name = "whoami" -version = "1.5.2" +version = "1.6.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "372d5b87f58ec45c384ba03563b03544dc5fadc3983e434b286913f5b4a9bb6d" +checksum = "5d4a4db5077702ca3015d3d02d74974948aba2ad9e12ab7df718ee64ccd7e97d" dependencies = [ - "redox_syscall", + "libredox", "wasite", "web-sys", ] [[package]] name = "widestring" -version = "1.1.0" +version = "1.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7219d36b6eac893fa81e84ebe06485e7dcbb616177469b142df14f1f4deb1311" +checksum = "dd7cf3379ca1aac9eea11fba24fd7e315d621f8dfe35c8d7d2be8b793726e07d" [[package]] name = "winapi" @@ -6329,11 +6638,11 @@ checksum = "ac3b87c63620426dd9b991e5ce0329eff545bccbbb34f3be09ff6fb6ab51b7b6" [[package]] name = "winapi-util" -version = "0.1.9" +version = "0.1.11" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cf221c93e13a30d793f7645a0e7762c55d169dbb0a49671918a2319d289b10bb" +checksum = "c2a7b1c03c876122aa43f3020e6c3c3ee5c05081c9a00739faf7503aeba10d22" dependencies = [ - "windows-sys 0.59.0", + "windows-sys 0.61.0", ] [[package]] @@ -6342,43 +6651,123 @@ version = "0.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "712e227841d057c1ee1cd2fb22fa7e5a5461ae8e48fa2ca79ec42cfc1931183f" +[[package]] +name = "windows" +version = "0.61.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9babd3a767a4c1aef6900409f85f5d53ce2544ccdfaa86dad48c91782c6d6893" +dependencies = [ + "windows-collections", + "windows-core", + "windows-future", + "windows-link 0.1.3", + "windows-numerics", +] + +[[package]] +name = "windows-collections" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3beeceb5e5cfd9eb1d76b381630e82c4241ccd0d27f1a39ed41b2760b255c5e8" +dependencies = [ + "windows-core", +] + [[package]] name = "windows-core" -version = "0.52.0" +version = "0.61.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "33ab640c8d7e35bf8ba19b884ba838ceb4fba93a4e8c65a9059d08afcfc683d9" +checksum = "c0fdd3ddb90610c7638aa2b3a3ab2904fb9e5cdbecc643ddb3647212781c4ae3" dependencies = [ - "windows-targets 0.52.6", + "windows-implement", + "windows-interface", + "windows-link 0.1.3", + "windows-result", + "windows-strings", ] [[package]] -name = "windows-registry" +name = "windows-future" +version = "0.2.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "fc6a41e98427b19fe4b73c550f060b59fa592d7d686537eebf9385621bfbad8e" +dependencies = [ + "windows-core", + "windows-link 0.1.3", + "windows-threading", +] + +[[package]] +name = "windows-implement" +version = "0.60.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "a47fddd13af08290e67f4acabf4b459f647552718f683a7b415d290ac744a836" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] + +[[package]] +name = "windows-interface" +version = "0.59.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "bd9211b69f8dcdfa817bfd14bf1c97c9188afa36f4750130fcdf3f400eca9fa8" +dependencies = [ + "proc-macro2", + "quote", + "syn 2.0.106", +] + +[[package]] +name = "windows-link" +version = "0.1.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5e6ad25900d524eaabdbbb96d20b4311e1e7ae1699af4fb28c17ae66c80d798a" + +[[package]] +name = "windows-link" +version = "0.2.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "45e46c0661abb7180e7b9c281db115305d49ca1709ab8242adf09666d2173c65" + +[[package]] +name = "windows-numerics" version = "0.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "e400001bb720a623c1c69032f8e3e4cf09984deec740f007dd2b03ec864804b0" +checksum = "9150af68066c4c5c07ddc0ce30421554771e528bde427614c61038bc2c92c2b1" dependencies = [ + "windows-core", + "windows-link 0.1.3", +] + +[[package]] +name = "windows-registry" +version = "0.5.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "5b8a9ed28765efc97bbc954883f4e6796c33a06546ebafacbabee9696967499e" +dependencies = [ + "windows-link 0.1.3", "windows-result", "windows-strings", - "windows-targets 0.52.6", ] [[package]] name = "windows-result" -version = "0.2.0" +version = "0.3.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1d1043d8214f791817bab27572aaa8af63732e11bf84aa21a45a78d6c317ae0e" +checksum = "56f42bd332cc6c8eac5af113fc0c1fd6a8fd2aa08a0119358686e5160d0586c6" dependencies = [ - "windows-targets 0.52.6", + "windows-link 0.1.3", ] [[package]] name = "windows-strings" -version = "0.1.0" +version = "0.4.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4cd9b125c486025df0eabcb585e62173c6c9eddcec5d117d3b6e8c30e2ee4d10" +checksum = "56e6c93f3a0c3b36176cb1327a4958a0353d5d166c2a35cb268ace15e91d3b57" dependencies = [ - "windows-result", - "windows-targets 0.52.6", + "windows-link 0.1.3", ] [[package]] @@ -6408,6 +6797,24 @@ dependencies = [ "windows-targets 0.52.6", ] +[[package]] +name = "windows-sys" +version = "0.60.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "f2f500e4d28234f72040990ec9d39e3a6b950f9f22d3dba18416c35882612bcb" +dependencies = [ + "windows-targets 0.53.3", +] + +[[package]] +name = "windows-sys" +version = "0.61.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "e201184e40b2ede64bc2ea34968b28e33622acdbbf37104f0e4a33f7abe657aa" +dependencies = [ + "windows-link 0.2.0", +] + [[package]] name = "windows-targets" version = "0.48.5" @@ -6432,13 +6839,39 @@ dependencies = [ "windows_aarch64_gnullvm 0.52.6", "windows_aarch64_msvc 0.52.6", "windows_i686_gnu 0.52.6", - "windows_i686_gnullvm", + "windows_i686_gnullvm 0.52.6", "windows_i686_msvc 0.52.6", "windows_x86_64_gnu 0.52.6", "windows_x86_64_gnullvm 0.52.6", "windows_x86_64_msvc 0.52.6", ] +[[package]] +name = "windows-targets" +version = "0.53.3" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "d5fe6031c4041849d7c496a8ded650796e7b6ecc19df1a431c1a363342e5dc91" +dependencies = [ + "windows-link 0.1.3", + "windows_aarch64_gnullvm 0.53.0", + "windows_aarch64_msvc 0.53.0", + "windows_i686_gnu 0.53.0", + "windows_i686_gnullvm 0.53.0", + "windows_i686_msvc 0.53.0", + "windows_x86_64_gnu 0.53.0", + "windows_x86_64_gnullvm 0.53.0", + "windows_x86_64_msvc 0.53.0", +] + +[[package]] +name = "windows-threading" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b66463ad2e0ea3bbf808b7f1d371311c80e115c0b71d60efc142cafbcfb057a6" +dependencies = [ + "windows-link 0.1.3", +] + [[package]] name = "windows_aarch64_gnullvm" version = "0.48.5" @@ -6451,6 +6884,12 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "32a4622180e7a0ec044bb555404c800bc9fd9ec262ec147edd5989ccd0c02cd3" +[[package]] +name = "windows_aarch64_gnullvm" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "86b8d5f90ddd19cb4a147a5fa63ca848db3df085e25fee3cc10b39b6eebae764" + [[package]] name = "windows_aarch64_msvc" version = "0.48.5" @@ -6463,6 +6902,12 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "09ec2a7bb152e2252b53fa7803150007879548bc709c039df7627cabbd05d469" +[[package]] +name = "windows_aarch64_msvc" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c7651a1f62a11b8cbd5e0d42526e55f2c99886c77e007179efff86c2b137e66c" + [[package]] name = "windows_i686_gnu" version = "0.48.5" @@ -6475,12 +6920,24 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "8e9b5ad5ab802e97eb8e295ac6720e509ee4c243f69d781394014ebfe8bbfa0b" +[[package]] +name = "windows_i686_gnu" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "c1dc67659d35f387f5f6c479dc4e28f1d4bb90ddd1a5d3da2e5d97b42d6272c3" + [[package]] name = "windows_i686_gnullvm" version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "0eee52d38c090b3caa76c563b86c3a4bd71ef1a819287c19d586d7334ae8ed66" +[[package]] +name = "windows_i686_gnullvm" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "9ce6ccbdedbf6d6354471319e781c0dfef054c81fbc7cf83f338a4296c0cae11" + [[package]] name = "windows_i686_msvc" version = "0.48.5" @@ -6493,6 +6950,12 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "240948bc05c5e7c6dabba28bf89d89ffce3e303022809e73deaefe4f6ec56c66" +[[package]] +name = "windows_i686_msvc" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "581fee95406bb13382d2f65cd4a908ca7b1e4c2f1917f143ba16efe98a589b5d" + [[package]] name = "windows_x86_64_gnu" version = "0.48.5" @@ -6505,6 +6968,12 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "147a5c80aabfbf0c7d901cb5895d1de30ef2907eb21fbbab29ca94c5b08b1a78" +[[package]] +name = "windows_x86_64_gnu" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2e55b5ac9ea33f2fc1716d1742db15574fd6fc8dadc51caab1c16a3d3b4190ba" + [[package]] name = "windows_x86_64_gnullvm" version = "0.48.5" @@ -6517,6 +6986,12 @@ version = "0.52.6" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "24d5b23dc417412679681396f2b49f3de8c1473deb516bd34410872eff51ed0d" +[[package]] +name = "windows_x86_64_gnullvm" +version = "0.53.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "0a6e035dd0599267ce1ee132e51c27dd29437f63325753051e71dd9e42406c57" + [[package]] name = "windows_x86_64_msvc" version = "0.48.5" @@ -6530,19 +7005,16 @@ source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "589f6da84c646204747d1270a2a5661ea66ed1cced2631d546fdfb155959f9ec" [[package]] -name = "winnow" -version = "0.5.40" +name = "windows_x86_64_msvc" +version = "0.53.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "f593a95398737aeed53e489c785df13f3618e41dbcd6718c6addbf1395aa6876" -dependencies = [ - "memchr", -] +checksum = "271414315aff87387382ec3d271b52d7ae78726f5d44ac98b4f4030c91880486" [[package]] name = "winnow" -version = "0.6.18" +version = "0.7.13" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "68a9bda4691f099d435ad181000724da8e5899daa10713c2d432552b9ccd3a6f" +checksum = "21a0236b59786fed61e2a80582dd500fe61f18b5dca67a4a067d0bc9039339cf" dependencies = [ "memchr", ] @@ -6558,25 +7030,16 @@ dependencies = [ ] [[package]] -name = "wit-bindgen-rt" -version = "0.39.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6f42320e61fe2cfd34354ecb597f86f413484a798ba44a8ca1165c58d42da6c1" -dependencies = [ - "bitflags", -] - -[[package]] -name = "write16" -version = "1.0.0" +name = "wit-bindgen" +version = "0.45.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "d1890f4022759daae28ed4fe62859b1236caebfc61ede2f63ed4e695f3f6d936" +checksum = "5c573471f125075647d03df72e026074b7203790d41351cd6edc96f46bcccd36" [[package]] name = "writeable" -version = "0.5.5" +version = "0.6.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1e9df38ee2d2c3c5948ea468a8406ff0db0b29ae1ffde1bcf20ef305bcc95c51" +checksum = "ea2f10b9bb0928dfb1b42b65e1f9e36f7f54dbdf08457afefb38afcdec4fa2bb" [[package]] name = "xdg-home" @@ -6590,15 +7053,15 @@ dependencies = [ [[package]] name = "yansi" -version = "0.5.1" +version = "1.0.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "09041cd90cf85f7f8b2df60c646f853b7f535ce68f85244eb6731cf89fa498ec" +checksum = "cfe53a6657fd280eaa890a3bc59152892ffa3e30101319d168b781ed6529b049" [[package]] name = "yoke" -version = "0.7.5" +version = "0.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "120e6aef9aa629e3d4f52dc8cc43a015c7724194c97dfaf45180d2daf2b77f40" +checksum = "5f41bb01b8226ef4bfd589436a297c53d118f65921786300e427be8d487695cc" dependencies = [ "serde", "stable_deref_trait", @@ -6608,9 +7071,9 @@ dependencies = [ [[package]] name = "yoke-derive" -version = "0.7.5" +version = "0.8.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "2380878cad4ac9aac1e2435f3eb4020e8374b5f13c296cb75b4620ff8e229154" +checksum = "38da3c9736e16c5d3c8c597a9aaa5d1fa565d0532ae05e27c24aa62fb32c0ab6" dependencies = [ "proc-macro2", "quote", @@ -6620,17 +7083,16 @@ dependencies = [ [[package]] name = "zbus" -version = "4.0.1" +version = "4.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "7b8e3d6ae3342792a6cc2340e4394334c7402f3d793b390d2c5494a4032b3030" +checksum = "bb97012beadd29e654708a0fdb4c84bc046f537aecfde2c3ee0a9e4b4d48c725" dependencies = [ "async-broadcast", "async-process", "async-recursion", "async-trait", - "derivative", "enumflags2", - "event-listener 5.3.1", + "event-listener 5.4.1", "futures-core", "futures-sink", "futures-util", @@ -6653,16 +7115,15 @@ dependencies = [ [[package]] name = "zbus_macros" -version = "4.0.1" +version = "4.4.0" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b7a3e850ff1e7217a3b7a07eba90d37fe9bb9e89a310f718afcde5885ca9b6d7" +checksum = "267db9407081e90bbfa46d841d3cbc60f59c0351838c4bc65199ecd79ab1983e" dependencies = [ - "proc-macro-crate 1.3.1", + "proc-macro-crate", "proc-macro2", "quote", - "regex", - "syn 1.0.109", - "zvariant_utils 1.1.0", + "syn 2.0.106", + "zvariant_utils", ] [[package]] @@ -6678,19 +7139,18 @@ dependencies = [ [[package]] name = "zerocopy" -version = "0.7.35" +version = "0.8.27" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "1b9b4fd18abc82b8136838da5d50bae7bdea537c574d8dc1a34ed098d6c166f0" +checksum = "0894878a5fa3edfd6da3f88c4805f4c8558e2b996227a3d864f47fe11e38282c" dependencies = [ - "byteorder 1.5.0", "zerocopy-derive", ] [[package]] name = "zerocopy-derive" -version = "0.7.35" +version = "0.8.27" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "fa4f8080344d4671fb4e831a13ad1e68092748387dfc4f55e356242fae12ce3e" +checksum = "88d2b8d9c68ad2b9e4340d7832716a4d21a22a1154777ad56ea55c51a9cf3831" dependencies = [ "proc-macro2", "quote", @@ -6699,18 +7159,18 @@ dependencies = [ [[package]] name = "zerofrom" -version = "0.1.5" +version = "0.1.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "cff3ee08c995dee1859d998dea82f7374f2826091dd9cd47def953cae446cd2e" +checksum = "50cc42e0333e05660c3587f3bf9d0478688e15d870fab3346451ce7f8c9fbea5" dependencies = [ "zerofrom-derive", ] [[package]] name = "zerofrom-derive" -version = "0.1.5" +version = "0.1.6" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "595eed982f7d355beb85837f651fa22e90b3c044842dc7f2c2842c086f295808" +checksum = "d71e5d6e06ab090c67b5e44993ec16b72dcbaabc526db883a360057678b48502" dependencies = [ "proc-macro2", "quote", @@ -6738,11 +7198,22 @@ dependencies = [ "syn 2.0.106", ] +[[package]] +name = "zerotrie" +version = "0.2.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "36f0bbd478583f79edad978b407914f61b2972f5af6fa089686016be8f9af595" +dependencies = [ + "displaydoc", + "yoke", + "zerofrom", +] + [[package]] name = "zerovec" -version = "0.10.4" +version = "0.11.4" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "aa2b893d79df23bfb12d5461018d408ea19dfafe76c2c7ef6d4eba614f8ff079" +checksum = "e7aa2bd55086f1ab526693ecbe444205da57e25f4489879da80635a46d90e73b" dependencies = [ "yoke", "zerofrom", @@ -6751,9 +7222,9 @@ dependencies = [ [[package]] name = "zerovec-derive" -version = "0.10.3" +version = "0.11.1" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "6eafa6dfb17584ea3e2bd6e76e0cc15ad7af12b09abdd1ca55961bed9b1063c6" +checksum = "5b96237efa0c878c64bd89c436f661be4e46b2f3eff1ebb976f7ef2321d2f58f" dependencies = [ "proc-macro2", "quote", @@ -6779,22 +7250,11 @@ version = "4.2.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "73e2ba546bda683a90652bac4a279bc146adad1386f25379cf73200d2002c449" dependencies = [ - "proc-macro-crate 3.2.0", + "proc-macro-crate", "proc-macro2", "quote", "syn 2.0.106", - "zvariant_utils 2.1.0", -] - -[[package]] -name = "zvariant_utils" -version = "1.1.0" -source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "00bedb16a193cc12451873fee2a1bc6550225acece0e36f333e68326c73c8172" -dependencies = [ - "proc-macro2", - "quote", - "syn 1.0.109", + "zvariant_utils", ] [[package]] From 1d52e421b0c00d38503c139c142ca77ec5153ca9 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 15 Sep 2025 18:13:48 -0400 Subject: [PATCH 52/76] Fix rpc link in doc comment to be valid mdx --- cmd/soroban-cli/src/commands/ledger/entry/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs index 46e77cf230..67e02d6118 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/mod.rs @@ -4,7 +4,7 @@ pub mod fetch; #[derive(Debug, Parser)] pub enum Cmd { /// Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. - /// Read more about the RPC command here: + /// Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) #[command(subcommand)] Fetch(fetch::Cmd), } From c273f839177d6636eca8995e2416989a7b1df93d Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 15 Sep 2025 18:22:12 -0400 Subject: [PATCH 53/76] Generated docs --- FULL_HELP_DOCS.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 2e648861e2..07b531264f 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -3715,13 +3715,13 @@ Work with ledger entries ###### **Subcommands:** -* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: +* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) ## `stellar ledger entry fetch` -Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: +Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) **Usage:** `stellar ledger entry fetch ` From 0eadc35345ba389aac74cded32fcf0b87204c5bb Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 7 Oct 2025 15:34:19 -0400 Subject: [PATCH 54/76] Update generated docs after merge --- FULL_HELP_DOCS.md | 3698 +++++++++++++++++++++++++-------------------- 1 file changed, 2018 insertions(+), 1680 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 032ded5fcf..c25aa54f5d 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -38,38 +38,41 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world + **Usage:** `stellar [OPTIONS] ` ###### **Subcommands:** -- `contract` — Tools for smart contract developers -- `doctor` — Diagnose and troubleshoot CLI and network issues -- `events` — Watch the network for contract events -- `env` — Prints the environment variables -- `keys` — Create and manage identities including keys and addresses -- `network` — Configure connection to networks -- `container` — Start local networks in containers -- `config` — Manage cli configuration -- `snapshot` — Download a snapshot of a ledger from an archive -- `tx` — Sign, Simulate, and Send transactions -- `xdr` — Decode and encode XDR -- `completion` — Print shell completion code for the specified shell -- `cache` — Cache for transactions and contract specs -- `version` — Print version information -- `plugin` — The subcommand for CLI plugins -- `ledger` — Fetch ledger information -- `fee-stats` — Fetch network feestats - -###### **Options:** - -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` -- `-q`, `--quiet` — Do not write logs to stderr including `INFO` -- `-v`, `--verbose` — Log DEBUG events -- `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events -- `--list` — List installed plugins. E.g. `stellar-hello` -- `--no-cache` — Do not cache your simulations and transactions +* `contract` — Tools for smart contract developers +* `doctor` — Diagnose and troubleshoot CLI and network issues +* `events` — Watch the network for contract events +* `env` — Prints the environment variables +* `keys` — Create and manage identities including keys and addresses +* `network` — Configure connection to networks +* `container` — Start local networks in containers +* `config` — Manage cli configuration +* `snapshot` — Download a snapshot of a ledger from an archive +* `tx` — Sign, Simulate, and Send transactions +* `xdr` — Decode and encode XDR +* `completion` — Print shell completion code for the specified shell +* `cache` — Cache for transactions and contract specs +* `version` — Print version information +* `plugin` — The subcommand for CLI plugins +* `ledger` — Fetch ledger information +* `fee-stats` — Fetch network feestats + +###### **Options:** + +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` +* `-q`, `--quiet` — Do not write logs to stderr including `INFO` +* `-v`, `--verbose` — Log DEBUG events +* `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events +* `--list` — List installed plugins. E.g. `stellar-hello` +* `--no-cache` — Do not cache your simulations and transactions + + ## `stellar contract` @@ -79,23 +82,25 @@ Tools for smart contract developers ###### **Subcommands:** -- `asset` — Utilities to deploy a Stellar Asset Contract or get its id -- `alias` — Utilities to manage contract aliases -- `bindings` — Generate code client bindings for a contract -- `build` — Build a contract from source -- `extend` — Extend the time to live ledger of a contract-data ledger entry -- `deploy` — Deploy a wasm contract -- `fetch` — Fetch a contract's Wasm binary -- `id` — Generate the contract id for a given contract or asset -- `info` — Access info about contracts -- `init` — Initialize a Soroban contract project -- `inspect` — (Deprecated in favor of `contract info` subcommand) Inspect a WASM file listing contract functions, meta, etc -- `upload` — Install a WASM file to the ledger without creating a contract instance -- `install` — (Deprecated in favor of `contract upload` subcommand) Install a WASM file to the ledger without creating a contract instance -- `invoke` — Invoke a contract function -- `optimize` — Optimize a WASM file -- `read` — Print the current value of a contract-data ledger entry -- `restore` — Restore an evicted value for a contract-data legder entry +* `asset` — Utilities to deploy a Stellar Asset Contract or get its id +* `alias` — Utilities to manage contract aliases +* `bindings` — Generate code client bindings for a contract +* `build` — Build a contract from source +* `extend` — Extend the time to live ledger of a contract-data ledger entry +* `deploy` — Deploy a wasm contract +* `fetch` — Fetch a contract's Wasm binary +* `id` — Generate the contract id for a given contract or asset +* `info` — Access info about contracts +* `init` — Initialize a Soroban contract project +* `inspect` — (Deprecated in favor of `contract info` subcommand) Inspect a WASM file listing contract functions, meta, etc +* `upload` — Install a WASM file to the ledger without creating a contract instance +* `install` — (Deprecated in favor of `contract upload` subcommand) Install a WASM file to the ledger without creating a contract instance +* `invoke` — Invoke a contract function +* `optimize` — Optimize a WASM file +* `read` — Print the current value of a contract-data ledger entry +* `restore` — Restore an evicted value for a contract-data legder entry + + ## `stellar contract asset` @@ -105,8 +110,10 @@ Utilities to deploy a Stellar Asset Contract or get its id ###### **Subcommands:** -- `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead -- `deploy` — Deploy builtin Soroban Asset Contract +* `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead +* `deploy` — Deploy builtin Soroban Asset Contract + + ## `stellar contract asset id` @@ -116,13 +123,15 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract asset deploy` @@ -132,26 +141,27 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract alias` @@ -161,10 +171,12 @@ Utilities to manage contract aliases ###### **Subcommands:** -- `remove` — Remove contract alias -- `add` — Add contract alias -- `show` — Show the contract id associated with a given alias -- `ls` — List all aliases +* `remove` — Remove contract alias +* `add` — Add contract alias +* `show` — Show the contract id associated with a given alias +* `ls` — List all aliases + + ## `stellar contract alias remove` @@ -174,16 +186,18 @@ Remove contract alias ###### **Arguments:** -- `` — The contract alias that will be removed +* `` — The contract alias that will be removed ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract alias add` @@ -193,18 +207,20 @@ Add contract alias ###### **Arguments:** -- `` — The contract alias that will be used +* `` — The contract alias that will be used ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--overwrite` — Overwrite the contract alias if it already exists -- `--id ` — The contract id that will be associated with the alias +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--overwrite` — Overwrite the contract alias if it already exists +* `--id ` — The contract id that will be associated with the alias + + ## `stellar contract alias show` @@ -214,16 +230,18 @@ Show the contract id associated with a given alias ###### **Arguments:** -- `` — The contract alias that will be displayed +* `` — The contract alias that will be displayed ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract alias ls` @@ -233,8 +251,10 @@ List all aliases ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract bindings` @@ -244,14 +264,16 @@ Generate code client bindings for a contract ###### **Subcommands:** -- `json` — Generate Json Bindings -- `rust` — Generate Rust bindings -- `typescript` — Generate a TypeScript / JavaScript package -- `python` — Generate Python bindings -- `java` — Generate Java bindings -- `flutter` — Generate Flutter bindings -- `swift` — Generate Swift bindings -- `php` — Generate PHP bindings +* `json` — Generate Json Bindings +* `rust` — Generate Rust bindings +* `typescript` — Generate a TypeScript / JavaScript package +* `python` — Generate Python bindings +* `java` — Generate Java bindings +* `flutter` — Generate Flutter bindings +* `swift` — Generate Swift bindings +* `php` — Generate PHP bindings + + ## `stellar contract bindings json` @@ -261,7 +283,9 @@ Generate Json Bindings ###### **Options:** -- `--wasm ` — Path to wasm binary +* `--wasm ` — Path to wasm binary + + ## `stellar contract bindings rust` @@ -271,7 +295,9 @@ Generate Rust bindings ###### **Options:** -- `--wasm ` — Path to wasm binary +* `--wasm ` — Path to wasm binary + + ## `stellar contract bindings typescript` @@ -281,17 +307,19 @@ Generate a TypeScript / JavaScript package ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output-dir ` — Where to place generated project -- `--overwrite` — Whether to overwrite output directory if it already exists +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output-dir ` — Where to place generated project +* `--overwrite` — Whether to overwrite output directory if it already exists + + ## `stellar contract bindings python` @@ -299,30 +327,40 @@ Generate Python bindings **Usage:** `stellar contract bindings python` + + ## `stellar contract bindings java` Generate Java bindings **Usage:** `stellar contract bindings java` + + ## `stellar contract bindings flutter` Generate Flutter bindings **Usage:** `stellar contract bindings flutter` + + ## `stellar contract bindings swift` Generate Swift bindings **Usage:** `stellar contract bindings swift` + + ## `stellar contract bindings php` Generate PHP bindings **Usage:** `stellar contract bindings php` + + ## `stellar contract build` Build a contract from source @@ -337,26 +375,25 @@ To view the commands that will be executed, without executing them, use the --pr ###### **Options:** -- `--manifest-path ` — Path to Cargo.toml -- `--package ` — Package to build - - If omitted, all packages that build for crate-type cdylib are built. +* `--manifest-path ` — Path to Cargo.toml +* `--package ` — Package to build -- `--profile ` — Build with the specified profile + If omitted, all packages that build for crate-type cdylib are built. +* `--profile ` — Build with the specified profile Default value: `release` +* `--features ` — Build with the list of features activated, space or comma separated +* `--all-features` — Build with the all features activated +* `--no-default-features` — Build with the default feature not activated +* `--out-dir ` — Directory to copy wasm files to -- `--features ` — Build with the list of features activated, space or comma separated -- `--all-features` — Build with the all features activated -- `--no-default-features` — Build with the default feature not activated -- `--out-dir ` — Directory to copy wasm files to + If provided, wasm files can be found in the cargo target directory, and the specified directory. - If provided, wasm files can be found in the cargo target directory, and the specified directory. + If ommitted, wasm files are written only to the cargo target directory. +* `--print-commands-only` — Print commands to build without executing them +* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) - If ommitted, wasm files are written only to the cargo target directory. -- `--print-commands-only` — Print commands to build without executing them -- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) ## `stellar contract extend` @@ -368,39 +405,42 @@ If no keys are specified the contract itself is extended. ###### **Options:** -- `--ledgers-to-extend ` — Number of ledgers to extend the entries -- `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--ledgers-to-extend ` — Number of ledgers to extend the entries +* `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary - -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract deploy` @@ -410,36 +450,36 @@ Deploy a wasm contract ###### **Arguments:** -- `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` +* `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Options:** -- `--wasm ` — WASM file to deploy -- `--wasm-hash ` — Hash of the already installed/deployed WASM file -- `--salt ` — Custom salt 32-byte salt for the token id -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--wasm ` — WASM file to deploy +* `--wasm-hash ` — Hash of the already installed/deployed WASM file +* `--salt ` — Custom salt 32-byte salt for the token id +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` +* `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation + -- `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract fetch` @@ -449,15 +489,17 @@ Fetch a contract's Wasm binary ###### **Options:** -- `--id ` — Contract ID to fetch -- `--wasm-hash ` — Wasm to fetch -- `-o`, `--out-file ` — Where to write output otherwise stdout is used -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--id ` — Contract ID to fetch +* `--wasm-hash ` — Wasm to fetch +* `-o`, `--out-file ` — Where to write output otherwise stdout is used +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract id` @@ -467,8 +509,10 @@ Generate the contract id for a given contract or asset ###### **Subcommands:** -- `asset` — Deploy builtin Soroban Asset Contract -- `wasm` — Deploy normal Wasm Contract +* `asset` — Deploy builtin Soroban Asset Contract +* `wasm` — Deploy normal Wasm Contract + + ## `stellar contract id asset` @@ -478,13 +522,15 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract id wasm` @@ -494,18 +540,20 @@ Deploy normal Wasm Contract ###### **Options:** -- `--salt ` — ID of the Soroban contract -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet +* `--salt ` — ID of the Soroban contract +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + + ## `stellar contract info` @@ -515,10 +563,12 @@ Access info about contracts ###### **Subcommands:** -- `interface` — Output the interface of a contract -- `meta` — Output the metadata stored in a contract -- `env-meta` — Output the env required metadata stored in a contract -- `build` — Output the contract build information, if available +* `interface` — Output the interface of a contract +* `meta` — Output the metadata stored in a contract +* `env-meta` — Output the env required metadata stored in a contract +* `build` — Output the contract build information, if available + + ## `stellar contract info interface` @@ -534,24 +584,31 @@ Outputs no data when no data is present in the contract. ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `rust` Possible values: - - `rust`: Rust code output of the contract interface - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `rust`: + Rust code output of the contract interface + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + + + ## `stellar contract info meta` @@ -567,24 +624,31 @@ Outputs no data when no data is present in the contract. ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of the meta info entry - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `text`: + Text output of the meta info entry + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + + + ## `stellar contract info env-meta` @@ -600,24 +664,31 @@ Outputs no data when no data is present in the contract. ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of the meta info entry - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `text`: + Text output of the meta info entry + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + + + ## `stellar contract info build` @@ -629,15 +700,17 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract init` @@ -649,15 +722,16 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Arguments:** -- `` +* `` ###### **Options:** -- `--name ` — An optional flag to specify a new contract's name. +* `--name ` — An optional flag to specify a new contract's name. Default value: `hello-world` +* `--overwrite` — Overwrite all existing files. + -- `--overwrite` — Overwrite all existing files. ## `stellar contract inspect` @@ -667,18 +741,23 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Options:** -- `--wasm ` — Path to wasm binary -- `--output ` — Output just XDR in base64 +* `--wasm ` — Path to wasm binary +* `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - - `xdr-base64`: XDR of array of contract spec entries - - `xdr-base64-array`: Array of xdr of contract spec entries - - `docs`: Pretty print of contract spec entries + - `xdr-base64`: + XDR of array of contract spec entries + - `xdr-base64-array`: + Array of xdr of contract spec entries + - `docs`: + Pretty print of contract spec entries + +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract upload` @@ -688,29 +767,30 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--wasm ` — Path to wasm binary -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--wasm ` — Path to wasm binary +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` + + ## `stellar contract install` (Deprecated in favor of `contract upload` subcommand) Install a WASM file to the ledger without creating a contract instance @@ -719,29 +799,30 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--wasm ` — Path to wasm binary -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--wasm ` — Path to wasm binary +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` + + ## `stellar contract invoke` Invoke a contract function @@ -754,38 +835,43 @@ stellar contract invoke ... -- --help ###### **Arguments:** -- `` — Function name as subcommand, then arguments for that function as `--arg-name value` +* `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Options:** -- `--id ` — Contract ID to invoke -- `--is-view` — View the result simulating and do not sign and submit transaction. Deprecated use `--send=no` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--id ` — Contract ID to invoke +* `--is-view` — View the result simulating and do not sign and submit transaction. Deprecated use `--send=no` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--send ` — Whether or not to send a transaction +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--send ` — Whether or not to send a transaction Default value: `default` Possible values: - - `default`: Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result - - `no`: Do not send transaction, return simulation result - - `yes`: Always send transaction + - `default`: + Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result + - `no`: + Do not send transaction, return simulation result + - `yes`: + Always send transaction + + + ## `stellar contract optimize` @@ -795,8 +881,10 @@ Optimize a WASM file ###### **Options:** -- `--wasm ` — Path to one or more wasm binaries -- `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) +* `--wasm ` — Path to one or more wasm binaries +* `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) + + ## `stellar contract read` @@ -806,34 +894,41 @@ Print the current value of a contract-data ledger entry ###### **Options:** -- `--output ` — Type of output to generate +* `--output ` — Type of output to generate Default value: `string` Possible values: - - `string`: String - - `json`: Json - - `xdr`: XDR + - `string`: + String + - `json`: + Json + - `xdr`: + XDR -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract restore` @@ -845,39 +940,42 @@ If no keys are specificed the contract itself is restored. ###### **Options:** -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary - -- `--ledgers-to-extend ` — Number of ledgers to extend the entry -- `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--ledgers-to-extend ` — Number of ledgers to extend the entry +* `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar doctor` @@ -887,8 +985,10 @@ Diagnose and troubleshoot CLI and network issues ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar events` @@ -898,49 +998,51 @@ Watch the network for contract events ###### **Options:** -- `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence -- `--cursor ` — The cursor corresponding to the start of the event range -- `--output ` — Output formatting options for event stream +* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence +* `--cursor ` — The cursor corresponding to the start of the event range +* `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - - `pretty`: Colorful, human-oriented console output - - `plain`: Human-oriented console output without colors - - `json`: JSON formatted console output + - `pretty`: + Colorful, human-oriented console output + - `plain`: + Human-oriented console output without colors + - `json`: + JSON formatted console output -- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) +* `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` +* `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. -- `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. - - Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. - -- `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. - - **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` + Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. +* `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. - **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` + **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` - Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). + **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` -- `--type ` — Specifies which type of contract events to display + Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). +* `--type ` — Specifies which type of contract events to display Default value: `all` Possible values: `all`, `contract`, `system` -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config - -## `stellar env` - -Prints the environment variables +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + + +## `stellar env` + +Prints the environment variables Prints to stdout in a format that can be used as .env file. Environment variables have precedence over defaults. @@ -952,14 +1054,16 @@ If there are no environment variables in use, prints the defaults. ###### **Arguments:** -- `` — Env variable name to get the value of. +* `` — Env variable name to get the value of. - E.g.: $ stellar env STELLAR_ACCOUNT + E.g.: $ stellar env STELLAR_ACCOUNT ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys` @@ -969,14 +1073,16 @@ Create and manage identities including keys and addresses ###### **Subcommands:** -- `add` — Add a new identity (keypair, ledger, OS specific secure store) -- `public-key` — Given an identity return its address (public key) -- `fund` — Fund an identity on a test network -- `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store -- `ls` — List identities -- `rm` — Remove an identity -- `secret` — Output an identity's secret key -- `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it +* `add` — Add a new identity (keypair, ledger, OS specific secure store) +* `public-key` — Given an identity return its address (public key) +* `fund` — Fund an identity on a test network +* `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store +* `ls` — List identities +* `rm` — Remove an identity +* `secret` — Output an identity's secret key +* `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it + + ## `stellar keys add` @@ -986,21 +1092,22 @@ Add a new identity (keypair, ledger, OS specific secure store) ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--secret-key` — (deprecated) Enter secret (S) key when prompted -- `--seed-phrase` — (deprecated) Enter key using 12-24 word seed phrase -- `--secure-store` — Save the new key in your OS's credential secure store. +* `--secret-key` — (deprecated) Enter secret (S) key when prompted +* `--seed-phrase` — (deprecated) Enter key using 12-24 word seed phrase +* `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + + This only supports seed phrases for now. +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. - This only supports seed phrases for now. -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. ## `stellar keys public-key` @@ -1012,13 +1119,15 @@ Given an identity return its address (public key) ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys fund` @@ -1028,17 +1137,19 @@ Fund an identity on a test network ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys generate` @@ -1048,28 +1159,28 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -- `-s`, `--as-secret` — Output the generated identity as a secret key -- `--secure-store` — Save the new key in your OS's credential secure store. - - On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. +* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +* `-s`, `--as-secret` — Output the generated identity as a secret key +* `--secure-store` — Save the new key in your OS's credential secure store. -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--fund` — Fund generated key pair + On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--fund` — Fund generated key pair Default value: `false` +* `--overwrite` — Overwrite existing identity if it already exists + -- `--overwrite` — Overwrite existing identity if it already exists ## `stellar keys ls` @@ -1079,9 +1190,11 @@ List identities ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-l`, `--long` + + ## `stellar keys rm` @@ -1091,12 +1204,14 @@ Remove an identity ###### **Arguments:** -- `` — Identity to remove +* `` — Identity to remove ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys secret` @@ -1106,14 +1221,16 @@ Output an identity's secret key ###### **Arguments:** -- `` — Name of identity to lookup, default is test identity +* `` — Name of identity to lookup, default is test identity ###### **Options:** -- `--phrase` — Output seed phrase instead of private key -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--phrase` — Output seed phrase instead of private key +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys use` @@ -1123,12 +1240,14 @@ Set the default identity that will be used on all commands. This allows you to s ###### **Arguments:** -- `` — Set the default network name +* `` — Set the default network name ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network` @@ -1138,13 +1257,15 @@ Configure connection to networks ###### **Subcommands:** -- `add` — Add a new network -- `rm` — Remove a network -- `ls` — List networks -- `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it -- `health` — Fetch the health of the configured RPC -- `info` — Checks the health of the configured RPC -- `settings` — Fetch the network's config settings +* `add` — Add a new network +* `rm` — Remove a network +* `ls` — List networks +* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +* `health` — Fetch the health of the configured RPC +* `info` — Checks the health of the configured RPC +* `settings` — Fetch the network's config settings + + ## `stellar network add` @@ -1154,15 +1275,17 @@ Add a new network ###### **Arguments:** -- `` — Name of network +* `` — Name of network ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network rm` @@ -1172,12 +1295,14 @@ Remove a network ###### **Arguments:** -- `` — Network to remove +* `` — Network to remove ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network ls` @@ -1187,9 +1312,11 @@ List networks ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` — Get more info about the networks +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-l`, `--long` — Get more info about the networks + + ## `stellar network use` @@ -1199,12 +1326,14 @@ Set the default network that will be used on all commands. This allows you to sk ###### **Arguments:** -- `` — Set the default network name +* `` — Set the default network name ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network health` @@ -1214,20 +1343,26 @@ Fetch the health of the configured RPC ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network health status - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network health status + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + ## `stellar network info` @@ -1237,20 +1372,26 @@ Checks the health of the configured RPC ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + ## `stellar network settings` @@ -1260,21 +1401,27 @@ Fetch the network's config settings ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network +* `--output ` — Format of the output Default value: `json` Possible values: - - `xdr`: XDR (`ConfigUpgradeSet` type) - - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `xdr`: + XDR (`ConfigUpgradeSet` type) + - `json`: + JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `json-formatted`: + JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type + + + ## `stellar container` @@ -1284,9 +1431,11 @@ Start local networks in containers ###### **Subcommands:** -- `logs` — Get logs from a running network container -- `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) -- `stop` — Stop a network container started with `stellar container start` +* `logs` — Get logs from a running network container +* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) +* `stop` — Stop a network container started with `stellar container start` + + ## `stellar container logs` @@ -1296,13 +1445,15 @@ Get logs from a running network container ###### **Arguments:** -- `` — Container to get logs from +* `` — Container to get logs from Default value: `local` ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `stellar container start` @@ -1318,21 +1469,23 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Arguments:** -- `` — Network to start. Default is `local` +* `` — Network to start. Default is `local` Possible values: `local`, `testnet`, `futurenet`, `pubnet` + ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -- `--name ` — Optional argument to specify the container name -- `-l`, `--limits ` — Optional argument to specify the limits for the local network only -- `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `--name ` — Optional argument to specify the container name +* `-l`, `--limits ` — Optional argument to specify the limits for the local network only +* `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping Default value: `8000:8000` +* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +* `--protocol-version ` — Optional argument to specify the protocol version for the local network only + -- `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network -- `--protocol-version ` — Optional argument to specify the protocol version for the local network only ## `stellar container stop` @@ -1342,13 +1495,15 @@ Stop a network container started with `stellar container start` ###### **Arguments:** -- `` — Container to stop +* `` — Container to stop Default value: `local` ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `stellar config` @@ -1358,8 +1513,10 @@ Manage cli configuration ###### **Subcommands:** -- `migrate` — Migrate the local configuration to the global directory -- `dir` — Show the global configuration directory +* `migrate` — Migrate the local configuration to the global directory +* `dir` — Show the global configuration directory + + ## `stellar config migrate` @@ -1369,8 +1526,10 @@ Migrate the local configuration to the global directory ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar config dir` @@ -1384,8 +1543,10 @@ The location will depend on how your system is configured. ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar snapshot` @@ -1395,7 +1556,9 @@ Download a snapshot of a ledger from an archive ###### **Subcommands:** -- `create` — Create a ledger snapshot using a history archive +* `create` — Create a ledger snapshot using a history archive + + ## `stellar snapshot create` @@ -1415,24 +1578,25 @@ Any invalid contract id passed as `--address` will be ignored. ###### **Options:** -- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger -- `--address
` — Account or contract address/alias to include in the snapshot -- `--wasm-hash ` — WASM hashes to include in the snapshot -- `--output ` — Format of the out file +* `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger +* `--address
` — Account or contract address/alias to include in the snapshot +* `--wasm-hash ` — WASM hashes to include in the snapshot +* `--output ` — Format of the out file Possible values: `json` -- `--out ` — Out path that the snapshot is written to +* `--out ` — Out path that the snapshot is written to Default value: `snapshot.json` +* `--archive-url ` — Archive URL +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + -- `--archive-url ` — Archive URL -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config ## `stellar tx` @@ -1442,17 +1606,19 @@ Sign, Simulate, and Send transactions ###### **Subcommands:** -- `update` — Update the transaction -- `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order -- `hash` — Calculate the hash of a transaction envelope -- `new` — Create a new transaction -- `operation` — Manipulate the operations in a transaction, including adding new operations -- `send` — Send a transaction envelope to the network -- `sign` — Sign a transaction envelope appending the signature to the envelope -- `simulate` — Simulate a transaction envelope from stdin -- `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -- `decode` — Decode a transaction envelope from XDR to JSON -- `encode` — Encode a transaction envelope from JSON to XDR +* `update` — Update the transaction +* `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order +* `hash` — Calculate the hash of a transaction envelope +* `new` — Create a new transaction +* `operation` — Manipulate the operations in a transaction, including adding new operations +* `send` — Send a transaction envelope to the network +* `sign` — Sign a transaction envelope appending the signature to the envelope +* `simulate` — Simulate a transaction envelope from stdin +* `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned +* `decode` — Decode a transaction envelope from XDR to JSON +* `encode` — Encode a transaction envelope from JSON to XDR + + ## `stellar tx update` @@ -1462,7 +1628,9 @@ Update the transaction ###### **Subcommands:** -- `sequence-number` — Edit the sequence number on a transaction +* `sequence-number` — Edit the sequence number on a transaction + + ## `stellar tx update sequence-number` @@ -1474,7 +1642,9 @@ Edit the sequence number on a transaction ###### **Subcommands:** -- `next` — Fetch the source account's seq-num and increment for the given tx +* `next` — Fetch the source account's seq-num and increment for the given tx + + ## `stellar tx update sequence-number next` @@ -1484,12 +1654,14 @@ Fetch the source account's seq-num and increment for the given tx ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar tx edit` @@ -1505,6 +1677,8 @@ $ stellar tx new manage-data --data-name hello --build-only | stellar tx edit **Usage:** `stellar tx edit` + + ## `stellar tx hash` Calculate the hash of a transaction envelope @@ -1513,14 +1687,16 @@ Calculate the hash of a transaction envelope ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx new` @@ -1530,28 +1706,30 @@ Create a new transaction ###### **Subcommands:** -- `account-merge` — Transfer XLM balance to another account and remove source account -- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -- `bump-sequence` — Bump sequence number to invalidate older transactions -- `change-trust` — Create, update, or delete a trustline -- `claim-claimable-balance` — Claim a claimable balance by its balance ID -- `clawback` — Clawback an asset from an account -- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -- `create-account` — Create and fund a new account -- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -- `end-sponsoring-future-reserves` — End sponsoring future reserves -- `liquidity-pool-deposit` — Deposit assets into a liquidity pool -- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -- `manage-buy-offer` — Create, update, or delete a buy offer -- `manage-data` — Set, modify, or delete account data entries -- `manage-sell-offer` — Create, update, or delete a sell offer -- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -- `payment` — Send asset to destination account -- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -- `set-options` — Set account options like flags, signers, and home domain -- `set-trustline-flags` — Configure authorization and trustline flags for an asset +* `account-merge` — Transfer XLM balance to another account and remove source account +* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +* `bump-sequence` — Bump sequence number to invalidate older transactions +* `change-trust` — Create, update, or delete a trustline +* `claim-claimable-balance` — Claim a claimable balance by its balance ID +* `clawback` — Clawback an asset from an account +* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +* `create-account` — Create and fund a new account +* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +* `end-sponsoring-future-reserves` — End sponsoring future reserves +* `liquidity-pool-deposit` — Deposit assets into a liquidity pool +* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +* `manage-buy-offer` — Create, update, or delete a buy offer +* `manage-data` — Set, modify, or delete account data entries +* `manage-sell-offer` — Create, update, or delete a sell offer +* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +* `payment` — Send asset to destination account +* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +* `set-options` — Set account options like flags, signers, and home domain +* `set-trustline-flags` — Configure authorization and trustline flags for an asset + + ## `stellar tx new account-merge` @@ -1561,25 +1739,26 @@ Transfer XLM balance to another account and remove source account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx new begin-sponsoring-future-reserves` @@ -1589,25 +1768,26 @@ Begin sponsoring future reserves for another account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--sponsored-id ` — Account that will be sponsored + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--sponsored-id ` — Account that will be sponsored ## `stellar tx new bump-sequence` @@ -1617,25 +1797,26 @@ Bump sequence number to invalidate older transactions ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--bump-to ` — Sequence number to bump to + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--bump-to ` — Sequence number to bump to ## `stellar tx new change-trust` @@ -1645,29 +1826,30 @@ Create, update, or delete a trustline ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--line ` +* `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` + + ## `stellar tx new claim-claimable-balance` Claim a claimable balance by its balance ID @@ -1676,25 +1858,26 @@ Claim a claimable balance by its balance ID ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx new clawback` @@ -1704,27 +1887,28 @@ Clawback an asset from an account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--from ` — Account to clawback assets from, e.g. `GBX...` -- `--asset ` — Asset to clawback -- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx new clawback-claimable-balance` @@ -1734,25 +1918,26 @@ Clawback a claimable balance by its balance ID ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx new create-account` @@ -1762,29 +1947,30 @@ Create and fund a new account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account Id to create, e.g. `GBX...` -- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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-claimable-balance` Create a claimable balance that can be claimed by specified accounts @@ -1793,33 +1979,34 @@ Create a claimable balance that can be claimed by specified accounts ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--asset ` — Asset to be held in the ClaimableBalanceEntry +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` +* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + + Examples: + + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` -- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - Examples: - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx new create-passive-sell-offer` @@ -1829,28 +2016,29 @@ Create a passive sell offer on the Stellar DEX ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx new end-sponsoring-future-reserves` @@ -1860,24 +2048,25 @@ End sponsoring future reserves ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx new liquidity-pool-deposit` @@ -1887,34 +2076,34 @@ Deposit assets into a liquidity pool ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--liquidity-pool-id ` — Liquidity pool ID to deposit to +* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--liquidity-pool-id ` — Liquidity pool ID to deposit to -- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` +* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` -- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` ## `stellar tx new liquidity-pool-withdraw` @@ -1924,28 +2113,29 @@ Withdraw assets from a liquidity pool ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--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 ## `stellar tx new manage-buy-offer` @@ -1955,32 +2145,33 @@ Create, update, or delete a buy offer ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx new manage-data` Set, modify, or delete account data entries @@ -1989,26 +2180,27 @@ Set, modify, or delete account data entries ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx new manage-sell-offer` @@ -2018,32 +2210,33 @@ Create, update, or delete a sell offer ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx new path-payment-strict-send` Send a payment with a different asset using path finding, specifying the send amount @@ -2052,30 +2245,31 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new path-payment-strict-receive` @@ -2085,30 +2279,31 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new payment` @@ -2118,30 +2313,30 @@ Send asset to destination account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account to send to, e.g. `GBX...` -- `--asset ` — Asset to send, default native, e.i. XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--destination ` — Account to send to, e.g. `GBX...` +* `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` +* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) + -- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx new revoke-sponsorship` @@ -2151,31 +2346,32 @@ Revoke sponsorship of a ledger entry or signer ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account-id ` — Account ID (required for all sponsorship types) +* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +* `--data-name ` — Data name for data entry sponsorship +* `--offer-id ` — Offer ID for offer sponsorship +* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--signer-key ` — Signer key for signer sponsorship + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account-id ` — Account ID (required for all sponsorship types) -- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -- `--data-name ` — Data name for data entry sponsorship -- `--offer-id ` — Offer ID for offer sponsorship -- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx new set-options` @@ -2185,40 +2381,41 @@ Set account options like flags, signers, and home domain ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--inflation-dest ` — Account of the inflation destination +* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +* `--signer ` — Add, update, or remove a signer from an account +* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +* `--clear-required` +* `--clear-revocable` +* `--clear-immutable` +* `--clear-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--inflation-dest ` — Account of the inflation destination -- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -- `--signer ` — Add, update, or remove a signer from an account -- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -- `--clear-required` -- `--clear-revocable` -- `--clear-immutable` -- `--clear-clawback-enabled` ## `stellar tx new set-trustline-flags` @@ -2228,32 +2425,33 @@ Configure authorization and trustline flags for an asset ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +* `--asset ` — Asset to set trustline flags for +* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +* `--clear-authorize` +* `--clear-authorize-to-maintain-liabilities` +* `--clear-trustline-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -- `--asset ` — Asset to set trustline flags for -- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -- `--clear-authorize` -- `--clear-authorize-to-maintain-liabilities` -- `--clear-trustline-clawback-enabled` ## `stellar tx operation` @@ -2265,7 +2463,9 @@ Manipulate the operations in a transaction, including adding new operations ###### **Subcommands:** -- `add` — Add Operation to a transaction +* `add` — Add Operation to a transaction + + ## `stellar tx operation add` @@ -2275,28 +2475,30 @@ Add Operation to a transaction ###### **Subcommands:** -- `account-merge` — Transfer XLM balance to another account and remove source account -- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -- `bump-sequence` — Bump sequence number to invalidate older transactions -- `change-trust` — Create, update, or delete a trustline -- `claim-claimable-balance` — Claim a claimable balance by its balance ID -- `clawback` — Clawback an asset from an account -- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -- `create-account` — Create and fund a new account -- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -- `end-sponsoring-future-reserves` — End sponsoring future reserves -- `liquidity-pool-deposit` — Deposit assets into a liquidity pool -- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -- `manage-buy-offer` — Create, update, or delete a buy offer -- `manage-data` — Set, modify, or delete account data entries -- `manage-sell-offer` — Create, update, or delete a sell offer -- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -- `payment` — Send asset to destination account -- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -- `set-options` — Set account options like flags, signers, and home domain -- `set-trustline-flags` — Configure authorization and trustline flags for an asset +* `account-merge` — Transfer XLM balance to another account and remove source account +* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +* `bump-sequence` — Bump sequence number to invalidate older transactions +* `change-trust` — Create, update, or delete a trustline +* `claim-claimable-balance` — Claim a claimable balance by its balance ID +* `clawback` — Clawback an asset from an account +* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +* `create-account` — Create and fund a new account +* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +* `end-sponsoring-future-reserves` — End sponsoring future reserves +* `liquidity-pool-deposit` — Deposit assets into a liquidity pool +* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +* `manage-buy-offer` — Create, update, or delete a buy offer +* `manage-data` — Set, modify, or delete account data entries +* `manage-sell-offer` — Create, update, or delete a sell offer +* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +* `payment` — Send asset to destination account +* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +* `set-options` — Set account options like flags, signers, and home domain +* `set-trustline-flags` — Configure authorization and trustline flags for an asset + + ## `stellar tx operation add account-merge` @@ -2306,30 +2508,31 @@ Transfer XLM balance to another account and remove source account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx operation add begin-sponsoring-future-reserves` @@ -2339,30 +2542,31 @@ Begin sponsoring future reserves for another account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--sponsored-id ` — Account that will be sponsored + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--sponsored-id ` — Account that will be sponsored ## `stellar tx operation add bump-sequence` @@ -2372,30 +2576,31 @@ Bump sequence number to invalidate older transactions ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--bump-to ` — Sequence number to bump to + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--bump-to ` — Sequence number to bump to ## `stellar tx operation add change-trust` @@ -2405,34 +2610,35 @@ Create, update, or delete a trustline ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--line ` +* `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` + + ## `stellar tx operation add claim-claimable-balance` Claim a claimable balance by its balance ID @@ -2441,30 +2647,31 @@ Claim a claimable balance by its balance ID ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx operation add clawback` @@ -2474,32 +2681,33 @@ Clawback an asset from an account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--from ` — Account to clawback assets from, e.g. `GBX...` -- `--asset ` — Asset to clawback -- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx operation add clawback-claimable-balance` @@ -2509,30 +2717,31 @@ Clawback a claimable balance by its balance ID ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx operation add create-account` @@ -2542,34 +2751,35 @@ Create and fund a new account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account Id to create, e.g. `GBX...` -- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--destination ` — Account Id to create, e.g. `GBX...` +* `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` + + ## `stellar tx operation add create-claimable-balance` Create a claimable balance that can be claimed by specified accounts @@ -2578,38 +2788,39 @@ Create a claimable balance that can be claimed by specified accounts ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--asset ` — Asset to be held in the ClaimableBalanceEntry +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` +* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + + Examples: + + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` -- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - Examples: - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx operation add create-passive-sell-offer` @@ -2619,33 +2830,34 @@ Create a passive sell offer on the Stellar DEX ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx operation add end-sponsoring-future-reserves` @@ -2655,29 +2867,30 @@ End sponsoring future reserves ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx operation add liquidity-pool-deposit` @@ -2687,39 +2900,39 @@ Deposit assets into a liquidity pool ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--liquidity-pool-id ` — Liquidity pool ID to deposit to +* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--liquidity-pool-id ` — Liquidity pool ID to deposit to -- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` +* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` -- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` ## `stellar tx operation add liquidity-pool-withdraw` @@ -2729,33 +2942,34 @@ Withdraw assets from a liquidity pool ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--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 ## `stellar tx operation add manage-buy-offer` @@ -2765,37 +2979,38 @@ Create, update, or delete a buy offer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx operation add manage-data` Set, modify, or delete account data entries @@ -2804,31 +3019,32 @@ Set, modify, or delete account data entries ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx operation add manage-sell-offer` @@ -2838,37 +3054,38 @@ Create, update, or delete a sell offer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx operation add path-payment-strict-receive` Send a payment with a different asset using path finding, specifying the receive amount @@ -2877,35 +3094,36 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add path-payment-strict-send` @@ -2915,35 +3133,36 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add payment` @@ -2953,35 +3172,35 @@ Send asset to destination account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account to send to, e.g. `GBX...` -- `--asset ` — Asset to send, default native, e.i. XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--destination ` — Account to send to, e.g. `GBX...` +* `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` +* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) + -- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx operation add revoke-sponsorship` @@ -2991,36 +3210,37 @@ Revoke sponsorship of a ledger entry or signer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account-id ` — Account ID (required for all sponsorship types) +* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +* `--data-name ` — Data name for data entry sponsorship +* `--offer-id ` — Offer ID for offer sponsorship +* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--signer-key ` — Signer key for signer sponsorship + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account-id ` — Account ID (required for all sponsorship types) -- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -- `--data-name ` — Data name for data entry sponsorship -- `--offer-id ` — Offer ID for offer sponsorship -- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx operation add set-options` @@ -3030,45 +3250,46 @@ Set account options like flags, signers, and home domain ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--inflation-dest ` — Account of the inflation destination +* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +* `--signer ` — Add, update, or remove a signer from an account +* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +* `--clear-required` +* `--clear-revocable` +* `--clear-immutable` +* `--clear-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--inflation-dest ` — Account of the inflation destination -- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -- `--signer ` — Add, update, or remove a signer from an account -- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -- `--clear-required` -- `--clear-revocable` -- `--clear-immutable` -- `--clear-clawback-enabled` ## `stellar tx operation add set-trustline-flags` @@ -3078,37 +3299,38 @@ Configure authorization and trustline flags for an asset ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +* `--asset ` — Asset to set trustline flags for +* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +* `--clear-authorize` +* `--clear-authorize-to-maintain-liabilities` +* `--clear-trustline-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -- `--asset ` — Asset to set trustline flags for -- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -- `--clear-authorize` -- `--clear-authorize-to-maintain-liabilities` -- `--clear-trustline-clawback-enabled` ## `stellar tx send` @@ -3118,16 +3340,18 @@ Send a transaction envelope to the network ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar tx sign` @@ -3137,20 +3361,22 @@ Sign a transaction envelope appending the signature to the envelope ###### **Arguments:** -- `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty ###### **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 -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar tx simulate` @@ -3160,49 +3386,58 @@ Simulate a transaction envelope from stdin ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + + ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -**Usage:** `stellar tx fetch [OPTIONS] fetch ` +**Usage:** `stellar tx fetch [OPTIONS] + fetch ` ###### **Subcommands:** -- `result` — Fetch the transaction result -- `meta` — Fetch the transaction meta -- `fee` — Fetch the transaction fee information +* `result` — Fetch the transaction result +* `meta` — Fetch the transaction meta +* `fee` — Fetch the transaction fee information ###### **Options:** -- `--hash ` — Hash of transaction to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--hash ` — Hash of transaction to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar tx fetch result` @@ -3212,19 +3447,25 @@ Fetch the transaction result ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--hash ` — Transaction hash to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar tx fetch meta` @@ -3234,19 +3475,25 @@ Fetch the transaction meta ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--hash ` — Transaction hash to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar tx fetch fee` @@ -3256,19 +3503,25 @@ Fetch the transaction fee information ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Output format for fee command +* `--hash ` — Transaction hash to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Output format for fee command Default value: `table` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `table`: Formatted in a table comparing fee types + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `table`: + Formatted in a table comparing fee types + + + ## `stellar tx decode` @@ -3278,22 +3531,25 @@ Decode a transaction envelope from XDR to JSON ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `single-base64` Possible values: `single-base64`, `single` -- `--output ` +* `--output ` Default value: `json` Possible values: `json`, `json-formatted` + + + ## `stellar tx encode` Encode a transaction envelope from JSON to XDR @@ -3302,22 +3558,25 @@ Encode a transaction envelope from JSON to XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `json` Possible values: `json` -- `--output ` +* `--output ` Default value: `single-base64` Possible values: `single-base64`, `single` + + + ## `stellar xdr` Decode and encode XDR @@ -3326,22 +3585,25 @@ Decode and encode XDR ###### **Subcommands:** -- `types` — View information about types -- `guess` — Guess the XDR type -- `decode` — Decode XDR -- `encode` — Encode XDR -- `compare` — Compare two XDR values with each other -- `generate` — Generate XDR values -- `version` — Print version information +* `types` — View information about types +* `guess` — Guess the XDR type +* `decode` — Decode XDR +* `encode` — Encode XDR +* `compare` — Compare two XDR values with each other +* `generate` — Generate XDR values +* `version` — Print version information ###### **Arguments:** -- `` — Channel of XDR to operate on +* `` — Channel of XDR to operate on Default value: `+curr` Possible values: `+curr`, `+next` + + + ## `stellar xdr types` View information about types @@ -3350,9 +3612,11 @@ View information about types ###### **Subcommands:** -- `list` — -- `schema` — -- `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory +* `list` — +* `schema` — +* `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory + + ## `stellar xdr types list` @@ -3360,25 +3624,31 @@ View information about types ###### **Options:** -- `--output ` +* `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` + + + ## `stellar xdr types schema` **Usage:** `stellar xdr types schema [OPTIONS] --type ` ###### **Options:** -- `--type ` — XDR type to decode -- `--output ` +* `--type ` — XDR type to decode +* `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` + + + ## `stellar xdr types schema-files` Generate JSON schema files for the XDR types, writing a file for each type to the out directory @@ -3387,13 +3657,16 @@ Generate JSON schema files for the XDR types, writing a file for each type to th ###### **Options:** -- `--out-dir ` -- `--output ` +* `--out-dir ` +* `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` + + + ## `stellar xdr guess` Guess the XDR type. @@ -3404,26 +3677,28 @@ Prints a list of types that the XDR values can be decoded into. ###### **Arguments:** -- `` — XDR or file containing XDR to decode, or stdin if empty +* `` — XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `list` Possible values: `list` -- `--certainty ` — Certainty as an arbitrary value +* `--certainty ` — Certainty as an arbitrary value Default value: `2` + + ## `stellar xdr decode` Decode XDR @@ -3432,23 +3707,26 @@ Decode XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--type ` — XDR type to decode -- `--input ` +* `--type ` — XDR type to decode +* `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `json` Possible values: `json`, `json-formatted`, `text`, `rust-debug`, `rust-debug-formatted` + + + ## `stellar xdr encode` Encode XDR @@ -3457,23 +3735,26 @@ Encode XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--type ` — XDR type to encode -- `--input ` +* `--type ` — XDR type to encode +* `--input ` Default value: `json` Possible values: `json` -- `--output ` +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream` + + + ## `stellar xdr compare` Compare two XDR values with each other @@ -3484,18 +3765,21 @@ Outputs: `-1` when the left XDR value is less than the right XDR value, `0` when ###### **Arguments:** -- `` — XDR file to decode and compare with the right value -- `` — XDR file to decode and compare with the left value +* `` — XDR file to decode and compare with the right value +* `` — XDR file to decode and compare with the left value ###### **Options:** -- `--type ` — XDR type of both inputs -- `--input ` +* `--type ` — XDR type of both inputs +* `--input ` Default value: `single-base64` Possible values: `single`, `single-base64` + + + ## `stellar xdr generate` Generate XDR values @@ -3504,8 +3788,10 @@ Generate XDR values ###### **Subcommands:** -- `default` — Generate default XDR values -- `arbitrary` — Generate arbitrary XDR values +* `default` — Generate default XDR values +* `arbitrary` — Generate arbitrary XDR values + + ## `stellar xdr generate default` @@ -3515,13 +3801,16 @@ Generate default XDR values ###### **Options:** -- `--type ` — XDR type to generate -- `--output ` +* `--type ` — XDR type to generate +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` + + + ## `stellar xdr generate arbitrary` Generate arbitrary XDR values @@ -3530,19 +3819,24 @@ Generate arbitrary XDR values ###### **Options:** -- `--type ` — XDR type to generate -- `--output ` +* `--type ` — XDR type to generate +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` + + + ## `stellar xdr version` Print version information **Usage:** `stellar xdr version` + + ## `stellar completion` Print shell completion code for the specified shell @@ -3553,14 +3847,18 @@ To enable autocomplete in the current bash shell, run: `source <(stellar complet To enable autocomplete permanently, run: `echo "source <(stellar completion --shell bash)" >> ~/.bashrc` + **Usage:** `stellar completion --shell ` ###### **Options:** -- `--shell ` — The shell type +* `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` + + + ## `stellar cache` Cache for transactions and contract specs @@ -3569,9 +3867,11 @@ Cache for transactions and contract specs ###### **Subcommands:** -- `clean` — Delete the cache -- `path` — Show the location of the cache -- `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) +* `clean` — Delete the cache +* `path` — Show the location of the cache +* `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) + + ## `stellar cache clean` @@ -3579,12 +3879,16 @@ Delete the cache **Usage:** `stellar cache clean` + + ## `stellar cache path` Show the location of the cache **Usage:** `stellar cache path` + + ## `stellar cache actionlog` Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) @@ -3593,8 +3897,10 @@ Access details about cached actions like transactions, and simulations. (Experim ###### **Subcommands:** -- `ls` — List cached actions (transactions, simulations) -- `read` — Read cached action +* `ls` — List cached actions (transactions, simulations) +* `read` — Read cached action + + ## `stellar cache actionlog ls` @@ -3604,9 +3910,11 @@ List cached actions (transactions, simulations) ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-l`, `--long` + + ## `stellar cache actionlog read` @@ -3616,7 +3924,9 @@ Read cached action ###### **Options:** -- `--id ` — ID of the cache entry +* `--id ` — ID of the cache entry + + ## `stellar version` @@ -3626,8 +3936,10 @@ Print version information ###### **Options:** -- `--only-version` — Print only the version -- `--only-version-major` — Print only the major version +* `--only-version` — Print only the version +* `--only-version-major` — Print only the major version + + ## `stellar plugin` @@ -3637,8 +3949,10 @@ The subcommand for CLI plugins ###### **Subcommands:** -- `search` — Search for CLI plugins using GitHub -- `ls` — List installed plugins +* `search` — Search for CLI plugins using GitHub +* `ls` — List installed plugins + + ## `stellar plugin search` @@ -3646,12 +3960,16 @@ Search for CLI plugins using GitHub **Usage:** `stellar plugin search` + + ## `stellar plugin ls` List installed plugins **Usage:** `stellar plugin ls` + + ## `stellar ledger` Fetch ledger information @@ -3935,18 +4253,24 @@ Get the latest ledger sequence and information from the network ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + ## `stellar ledger fetch` @@ -3954,34 +4278,41 @@ Get the latest ledger sequence and information from the network ###### **Arguments:** -- `` — Ledger Sequence to start fetch (inclusive) +* `` — Ledger Sequence to start fetch (inclusive) ###### **Options:** -- `--limit ` — Number of ledgers to fetch +* `--limit ` — Number of ledgers to fetch Default value: `1` - -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request -- `--xdr-format ` — Format of the xdr in the output +* `--xdr-format ` — Format of the xdr in the output Default value: `json` Possible values: - - `json`: XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields - - `xdr`: XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields + - `json`: + XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields + - `xdr`: + XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields + + + ## `stellar fee-stats` @@ -3991,15 +4322,22 @@ Fetch network feestats ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + + From 9d5c6f67c33004bfdd754a700c03de34694c8914 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 9 Oct 2025 12:49:37 -0400 Subject: [PATCH 55/76] Change wasm -> contract-code in stellar ledger entry fetch --- .../soroban-test/tests/it/integration/ledger/entry.rs | 4 ++-- .../ledger/entry/fetch/{wasm.rs => contract_code.rs} | 0 cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) rename cmd/soroban-cli/src/commands/ledger/entry/fetch/{wasm.rs => contract_code.rs} (100%) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 1aa8ac0c40..ba1c57c569 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -341,7 +341,7 @@ async fn ledger_entry_contract_data() { // top level test #[tokio::test] -async fn ledger_entry_wasm_hash() { +async fn ledger_entry_contract_code() { let sandbox = &TestEnv::new(); let test_account_alias = "test"; let wasm = HELLO_WORLD; @@ -370,7 +370,7 @@ async fn ledger_entry_wasm_hash() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") - .arg("wasm") + .arg("contract-code") .arg(&contract_wasm_hash) .arg("--network") .arg("testnet") diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_code.rs similarity index 100% rename from cmd/soroban-cli/src/commands/ledger/entry/fetch/wasm.rs rename to cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_code.rs diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index c67e484ded..aa6fd20bbb 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -7,7 +7,7 @@ pub mod claimable_balance; pub mod config; pub mod contract; pub mod liquidity_pool; -pub mod wasm; +pub mod contract_code; #[derive(Debug, Parser)] pub enum Cmd { @@ -24,7 +24,7 @@ pub enum Cmd { ///Fetch a liquidity pool ledger entry by id LiquidityPool(liquidity_pool::Cmd), /// Fetch WASM bytecode by hash - Wasm(wasm::Cmd), + ContractCode(contract_code::Cmd), } #[derive(thiserror::Error, Debug)] @@ -40,7 +40,7 @@ pub enum Error { #[error(transparent)] LiquidityPool(#[from] liquidity_pool::Error), #[error(transparent)] - Wasm(#[from] wasm::Error), + Wasm(#[from] contract_code::Error), } impl Cmd { @@ -51,7 +51,7 @@ impl Cmd { Cmd::Config(cmd) => cmd.run().await?, Cmd::ClaimableBalance(cmd) => cmd.run().await?, Cmd::LiquidityPool(cmd) => cmd.run().await?, - Cmd::Wasm(cmd) => cmd.run().await?, + Cmd::ContractCode(cmd) => cmd.run().await?, } Ok(()) } From 46e993e90b41ce1753a088e50f06767b1e0c6887 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 9 Oct 2025 15:32:28 -0400 Subject: [PATCH 56/76] Change contract -> contract_data for ledger entry fetch --- .../soroban-test/tests/it/integration/ledger/entry.rs | 4 ++-- .../ledger/entry/fetch/{contract.rs => contract_data.rs} | 0 cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs | 8 ++++---- 3 files changed, 6 insertions(+), 6 deletions(-) rename cmd/soroban-cli/src/commands/ledger/entry/fetch/{contract.rs => contract_data.rs} (100%) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index ba1c57c569..bfb3de4113 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -286,7 +286,7 @@ async fn ledger_entry_contract_data() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") - .arg("contract") + .arg("contract-data") .arg(&contract_id) .arg("--network") .arg("testnet") @@ -304,7 +304,7 @@ async fn ledger_entry_contract_data() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") - .arg("contract") + .arg("contract-data") .arg(&contract_id) .arg("--network") .arg("testnet") diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs similarity index 100% rename from cmd/soroban-cli/src/commands/ledger/entry/fetch/contract.rs rename to cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index aa6fd20bbb..22a5659747 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -5,7 +5,7 @@ pub mod account; pub mod args; pub mod claimable_balance; pub mod config; -pub mod contract; +pub mod contract_data; pub mod liquidity_pool; pub mod contract_code; @@ -15,7 +15,7 @@ pub enum Cmd { /// Additional account-related keys are available with optional flags. Account(account::Cmd), /// Fetch contract ledger entry by address or alias and storage key. - Contract(contract::Cmd), + ContractData(contract_data::Cmd), /// Fetch the current network config by `ConfigSettingId`. /// All config settings are returned if no id is provided. Config(config::Cmd), @@ -32,7 +32,7 @@ pub enum Error { #[error(transparent)] Account(#[from] account::Error), #[error(transparent)] - Contract(#[from] contract::Error), + ContractData(#[from] contract_data::Error), #[error(transparent)] Config(#[from] config::Error), #[error(transparent)] @@ -47,7 +47,7 @@ impl Cmd { pub async fn run(&self) -> Result<(), Error> { match self { Cmd::Account(cmd) => cmd.run().await?, - Cmd::Contract(cmd) => cmd.run().await?, + Cmd::ContractData(cmd) => cmd.run().await?, Cmd::Config(cmd) => cmd.run().await?, Cmd::ClaimableBalance(cmd) => cmd.run().await?, Cmd::LiquidityPool(cmd) => cmd.run().await?, From eb84eb11f879f3667cebf883ce82a410fc29f29f Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 9 Oct 2025 16:43:31 -0400 Subject: [PATCH 57/76] Move trustline to its own subcmd instead of nested under account --- .../tests/it/integration/ledger/entry.rs | 45 +------- .../commands/ledger/entry/fetch/account.rs | 53 +-------- .../src/commands/ledger/entry/fetch/mod.rs | 6 + .../commands/ledger/entry/fetch/trustline.rs | 104 ++++++++++++++++++ 4 files changed, 116 insertions(+), 92 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index bfb3de4113..af051fe775 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -82,39 +82,7 @@ async fn ledger_entry_account_only_with_account_addr() { } #[tokio::test] -async fn ledger_entry_account_asset_xlm() { - let sandbox = &TestEnv::new(); - let account_alias = "new_account"; - let new_account_addr = new_account(sandbox, account_alias); - let output = sandbox - .new_assert_cmd("ledger") - .arg("entry") - .arg("fetch") - .arg("account") - .arg(account_alias) - .arg("--network") - .arg("testnet") - .arg("--asset") - // though xlm does not have, nor need, a trustline, "xlm" is a valid argument to `--asset` - // this test is including it to make sure that the account ledger entry is still included in the output - .arg("xlm") - .assert() - .success() - .stdout_as_str(); - - let (_, expected_key) = expected_account_ledger_key(&new_account_addr).await; - - let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed.entries.is_empty()); - assert_eq!(parsed.entries[0].key, expected_key); - assert!(matches!( - parsed.entries[0].val, - LedgerEntryData::Account { .. } - )); -} - -#[tokio::test] -async fn ledger_entry_account_asset_usdc() { +async fn ledger_entry_trustline_asset_usdc() { let sandbox = &TestEnv::new(); let test_account_alias = "test"; let test_account_address = test_address(sandbox); @@ -137,7 +105,8 @@ async fn ledger_entry_account_asset_usdc() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") - .arg("account") + .arg("trustline") + .arg("--account") .arg(test_account_alias) .arg("--network") .arg("testnet") @@ -147,7 +116,7 @@ async fn ledger_entry_account_asset_usdc() { .success() .stdout_as_str(); - let (account_id, expected_account_key) = + let (account_id, _expected_account_key) = expected_account_ledger_key(&test_account_address).await; let issuer_account_id = get_account_id(&issuer_address); @@ -163,11 +132,7 @@ async fn ledger_entry_account_asset_usdc() { let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed.entries.is_empty()); - let account_entry = &parsed.entries[0]; - assert_eq!(account_entry.key, expected_account_key); - assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); - - let trustline_entry = &parsed.entries[1]; + let trustline_entry = &parsed.entries[0]; assert_eq!(trustline_entry.key, expected_trustline_key); assert!(matches!( trustline_entry.val, diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 3ff8352b38..5d7f49ba2a 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -5,13 +5,10 @@ use super::args::Args; use crate::{ commands::config::{self, locator}, xdr::{ - self, AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, - LedgerKeyAccount, LedgerKeyData, LedgerKeyOffer, LedgerKeyTrustLine, MuxedAccount, - PublicKey, String64, TrustLineAsset, Uint256, + self, LedgerKey, LedgerKeyAccount, LedgerKeyData, LedgerKeyOffer, MuxedAccount, String64, }, }; use clap::{command, Parser}; -use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; #[derive(Parser, Debug, Clone)] #[group(skip)] @@ -22,11 +19,6 @@ pub struct Cmd { #[command(flatten)] pub args: Args, - //Options - /// Assets to get trustline info for - #[arg(long)] - pub asset: Option>, - /// Fetch key-value data entries attached to an account (see manageDataOp) #[arg(long)] pub data_name: Option>, @@ -64,7 +56,6 @@ impl Cmd { pub async fn run(&self) -> Result<(), Error> { let mut ledger_keys = vec![]; self.insert_account_keys(&mut ledger_keys)?; - self.insert_asset_keys(&mut ledger_keys)?; self.insert_data_keys(&mut ledger_keys)?; self.insert_offer_keys(&mut ledger_keys)?; @@ -85,48 +76,6 @@ impl Cmd { Ok(()) } - fn insert_asset_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(asset) = &self.asset { - let acc = self.muxed_account(&self.account)?; - for asset in asset { - let asset = if asset.eq_ignore_ascii_case("XLM") { - TrustLineAsset::Native - } else if asset.contains(':') { - let mut parts = asset.split(':'); - let code = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; - let issuer = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; - if parts.next().is_some() { - Err(Error::InvalidAsset(asset.clone()))?; - } - let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; - let issuer = AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); - - match code.len() { - 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { - asset_code: AssetCode4(code.as_bytes().try_into()?), - issuer, - }), - 12 => TrustLineAsset::CreditAlphanum12(AlphaNum12 { - asset_code: AssetCode12(code.as_bytes().try_into()?), - issuer, - }), - _ => Err(Error::InvalidAsset(asset.clone()))?, - } - } else { - Err(Error::InvalidAsset(asset.clone()))? - }; - - let key = LedgerKey::Trustline(LedgerKeyTrustLine { - account_id: acc.clone().account_id(), - asset, - }); - - ledger_keys.push(key); - } - } - Ok(()) - } - fn insert_data_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { if let Some(data_name) = &self.data_name { let acc = self.muxed_account(&self.account)?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 22a5659747..0042fadfa7 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -8,6 +8,7 @@ pub mod config; pub mod contract_data; pub mod liquidity_pool; pub mod contract_code; +pub mod trustline; #[derive(Debug, Parser)] pub enum Cmd { @@ -25,6 +26,8 @@ pub enum Cmd { LiquidityPool(liquidity_pool::Cmd), /// Fetch WASM bytecode by hash ContractCode(contract_code::Cmd), + /// UPDATE + Trustline(trustline::Cmd), } #[derive(thiserror::Error, Debug)] @@ -41,6 +44,8 @@ pub enum Error { LiquidityPool(#[from] liquidity_pool::Error), #[error(transparent)] Wasm(#[from] contract_code::Error), + #[error(transparent)] + Trustline(#[from] trustline::Error), } impl Cmd { @@ -52,6 +57,7 @@ impl Cmd { Cmd::ClaimableBalance(cmd) => cmd.run().await?, Cmd::LiquidityPool(cmd) => cmd.run().await?, Cmd::ContractCode(cmd) => cmd.run().await?, + Cmd::Trustline(cmd) => cmd.run().await?, } Ok(()) } diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs new file mode 100644 index 0000000000..b8ba271e37 --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs @@ -0,0 +1,104 @@ +use std::array::TryFromSliceError; +use std::fmt::Debug; + +use super::args::Args; +use crate::{ + commands::config::{self, locator}, + xdr::{ AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, LedgerKeyTrustLine, MuxedAccount, PublicKey, TrustLineAsset, Uint256, + }, +}; +use clap::{command, Parser}; +use stellar_strkey::ed25519::PublicKey as Ed25519PublicKey; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub args: Args, + + /// Account alias or public key to lookup, default is test identity + #[arg(long)] + pub account: String, + + /// Assets to get trustline info for + #[arg(long)] + pub asset: Option>, + + /// If identity is a seed phrase use this hd path, default is 0 + #[arg(long)] + pub hd_path: Option, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error("provided asset is invalid: {0}")] + InvalidAsset(String), + #[error("provided data name is invalid: {0}")] + InvalidDataName(String), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + TryFromSliceError(#[from] TryFromSliceError), + #[error(transparent)] + Run(#[from] super::args::Error), +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let mut ledger_keys = vec![]; + self.insert_asset_keys(&mut ledger_keys)?; + Ok(self.args.run(ledger_keys).await?) + } + + fn insert_asset_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(asset) = &self.asset { + let acc = self.muxed_account(&self.account)?; + for asset in asset { + let asset = if asset.eq_ignore_ascii_case("XLM") { + TrustLineAsset::Native + } else if asset.contains(':') { + let mut parts = asset.split(':'); + let code = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; + let issuer = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; + if parts.next().is_some() { + Err(Error::InvalidAsset(asset.clone()))?; + } + let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; + let issuer = AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); + + match code.len() { + 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { + asset_code: AssetCode4(code.as_bytes().try_into()?), + issuer, + }), + 12 => TrustLineAsset::CreditAlphanum12(AlphaNum12 { + asset_code: AssetCode12(code.as_bytes().try_into()?), + issuer, + }), + _ => Err(Error::InvalidAsset(asset.clone()))?, + } + } else { + Err(Error::InvalidAsset(asset.clone()))? + }; + + let key = LedgerKey::Trustline(LedgerKeyTrustLine { + account_id: acc.clone().account_id(), + asset, + }); + + ledger_keys.push(key); + } + } + Ok(()) + } + + fn muxed_account(&self, account: &str) -> Result { + Ok(self + .args + .locator + .read_key(account)? + .muxed_account(self.hd_path)?) + } +} From a75dbe9607f11f7ca23897cbc8e13d720d63e812 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 9 Oct 2025 17:25:56 -0400 Subject: [PATCH 58/76] Move account data to its own subcmd instead of nested under accout --- .../tests/it/integration/ledger/entry.rs | 12 ++- .../commands/ledger/entry/fetch/account.rs | 22 +---- .../ledger/entry/fetch/account_data.rs | 81 +++++++++++++++++++ .../src/commands/ledger/entry/fetch/mod.rs | 6 ++ 4 files changed, 93 insertions(+), 28 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index af051fe775..ef04ddb711 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -152,7 +152,8 @@ async fn ledger_entry_account_data() { .new_assert_cmd("ledger") .arg("entry") .arg("fetch") - .arg("account") + .arg("data") + .arg("--account") .arg(account_alias) .arg("--network") .arg("testnet") @@ -165,13 +166,9 @@ async fn ledger_entry_account_data() { let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); assert!(!parsed.entries.is_empty()); - let (account_id, expected_account_key) = expected_account_ledger_key(&new_account_addr).await; - - let account_entry = &parsed.entries[0]; - assert_eq!(account_entry.key, expected_account_key); - assert!(matches!(account_entry.val, LedgerEntryData::Account { .. })); + let (account_id, _) = expected_account_ledger_key(&new_account_addr).await; - let data_entry = &parsed.entries[1]; + let data_entry = &parsed.entries[0]; let name_bounded_string = StringM::<64>::try_from(data_name).unwrap(); let expected_data_key = LedgerKey::Data(LedgerKeyData { account_id, @@ -181,6 +178,7 @@ async fn ledger_entry_account_data() { assert!(matches!(data_entry.val, LedgerEntryData::Data { .. })); } +#[ignore] #[tokio::test] async fn ledger_entries_hide_account() { let sandbox = &TestEnv::new(); diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 5d7f49ba2a..873321a82a 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -5,7 +5,7 @@ use super::args::Args; use crate::{ commands::config::{self, locator}, xdr::{ - self, LedgerKey, LedgerKeyAccount, LedgerKeyData, LedgerKeyOffer, MuxedAccount, String64, + LedgerKey, LedgerKeyAccount, LedgerKeyOffer, MuxedAccount }, }; use clap::{command, Parser}; @@ -56,7 +56,6 @@ impl Cmd { pub async fn run(&self) -> Result<(), Error> { let mut ledger_keys = vec![]; self.insert_account_keys(&mut ledger_keys)?; - self.insert_data_keys(&mut ledger_keys)?; self.insert_offer_keys(&mut ledger_keys)?; Ok(self.args.run(ledger_keys).await?) @@ -76,25 +75,6 @@ impl Cmd { Ok(()) } - fn insert_data_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(data_name) = &self.data_name { - let acc = self.muxed_account(&self.account)?; - for data_name in data_name { - let data_name: xdr::StringM<64> = data_name - .parse() - .map_err(|_| Error::InvalidDataName(data_name.clone()))?; - let data_name = String64(data_name); - let key = LedgerKey::Data(LedgerKeyData { - account_id: acc.clone().account_id(), - data_name, - }); - ledger_keys.push(key); - } - } - - Ok(()) - } - fn insert_offer_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { if let Some(offer) = &self.offer { let acc = self.muxed_account(&self.account)?; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs new file mode 100644 index 0000000000..cf12f8bdad --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs @@ -0,0 +1,81 @@ +use std::array::TryFromSliceError; +use std::fmt::Debug; + +use super::args::Args; +use crate::{ + commands::config::{self, locator}, + xdr::{ + self, LedgerKey, LedgerKeyData, MuxedAccount, String64, + }, +}; +use clap::{command, Parser}; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub args: Args, + + /// Account alias or public key to lookup, default is test identity + #[arg(long)] + pub account: String, + + /// Fetch key-value data entries attached to an account (see manageDataOp) + #[arg(long)] + pub data_name: Option>, + + /// If identity is a seed phrase use this hd path, default is 0 + #[arg(long)] + pub hd_path: Option, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error("provided asset is invalid: {0}")] + InvalidAsset(String), + #[error("provided data name is invalid: {0}")] + InvalidDataName(String), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + TryFromSliceError(#[from] TryFromSliceError), + #[error(transparent)] + Run(#[from] super::args::Error), +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let mut ledger_keys = vec![]; + self.insert_data_keys(&mut ledger_keys)?; + Ok(self.args.run(ledger_keys).await?) + } + + fn insert_data_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(data_name) = &self.data_name { + let acc = self.muxed_account(&self.account)?; + for data_name in data_name { + let data_name: xdr::StringM<64> = data_name + .parse() + .map_err(|_| Error::InvalidDataName(data_name.clone()))?; + let data_name = String64(data_name); + let key = LedgerKey::Data(LedgerKeyData { + account_id: acc.clone().account_id(), + data_name, + }); + ledger_keys.push(key); + } + } + + Ok(()) + } + + fn muxed_account(&self, account: &str) -> Result { + Ok(self + .args + .locator + .read_key(account)? + .muxed_account(self.hd_path)?) + } +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 0042fadfa7..0a8f69247f 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -9,6 +9,7 @@ pub mod contract_data; pub mod liquidity_pool; pub mod contract_code; pub mod trustline; +pub mod account_data; #[derive(Debug, Parser)] pub enum Cmd { @@ -28,6 +29,8 @@ pub enum Cmd { ContractCode(contract_code::Cmd), /// UPDATE Trustline(trustline::Cmd), + /// UPDATE + Data(account_data::Cmd), } #[derive(thiserror::Error, Debug)] @@ -46,6 +49,8 @@ pub enum Error { Wasm(#[from] contract_code::Error), #[error(transparent)] Trustline(#[from] trustline::Error), + #[error(transparent)] + Data(#[from] account_data::Error), } impl Cmd { @@ -58,6 +63,7 @@ impl Cmd { Cmd::LiquidityPool(cmd) => cmd.run().await?, Cmd::ContractCode(cmd) => cmd.run().await?, Cmd::Trustline(cmd) => cmd.run().await?, + Cmd::Data(cmd) => cmd.run().await?, } Ok(()) } From 95d1d865980de615132eec5f0aa89bace544519a Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 9 Oct 2025 17:54:13 -0400 Subject: [PATCH 59/76] Move offer to its own subcmd --- .../commands/ledger/entry/fetch/account.rs | 27 +------ .../src/commands/ledger/entry/fetch/mod.rs | 8 +- .../src/commands/ledger/entry/fetch/offer.rs | 78 +++++++++++++++++++ 3 files changed, 86 insertions(+), 27 deletions(-) create mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 873321a82a..f970f6a680 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -5,7 +5,7 @@ use super::args::Args; use crate::{ commands::config::{self, locator}, xdr::{ - LedgerKey, LedgerKeyAccount, LedgerKeyOffer, MuxedAccount + LedgerKey, LedgerKeyAccount, MuxedAccount }, }; use clap::{command, Parser}; @@ -19,14 +19,6 @@ pub struct Cmd { #[command(flatten)] pub args: Args, - /// Fetch key-value data entries attached to an account (see manageDataOp) - #[arg(long)] - pub data_name: Option>, - - /// ID of an offer made on the Stellar DEX - #[arg(long)] - pub offer: Option>, - /// Hide the account ledger entry from the output #[arg(long)] pub hide_account: bool, @@ -56,8 +48,6 @@ impl Cmd { pub async fn run(&self) -> Result<(), Error> { let mut ledger_keys = vec![]; self.insert_account_keys(&mut ledger_keys)?; - self.insert_offer_keys(&mut ledger_keys)?; - Ok(self.args.run(ledger_keys).await?) } @@ -75,21 +65,6 @@ impl Cmd { Ok(()) } - fn insert_offer_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(offer) = &self.offer { - let acc = self.muxed_account(&self.account)?; - for offer in offer { - let key = LedgerKey::Offer(LedgerKeyOffer { - seller_id: acc.clone().account_id(), - offer_id: *offer, - }); - ledger_keys.push(key); - } - } - - Ok(()) - } - fn muxed_account(&self, account: &str) -> Result { Ok(self .args diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 0a8f69247f..19065b70c3 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -10,6 +10,7 @@ pub mod liquidity_pool; pub mod contract_code; pub mod trustline; pub mod account_data; +pub mod offer; #[derive(Debug, Parser)] pub enum Cmd { @@ -29,8 +30,10 @@ pub enum Cmd { ContractCode(contract_code::Cmd), /// UPDATE Trustline(trustline::Cmd), - /// UPDATE + /// Fetch key-value data entries attached to an account (see manageDataOp) Data(account_data::Cmd), + /// UPDATE + Offer(offer::Cmd), } #[derive(thiserror::Error, Debug)] @@ -51,6 +54,8 @@ pub enum Error { Trustline(#[from] trustline::Error), #[error(transparent)] Data(#[from] account_data::Error), + #[error(transparent)] + Offer(#[from] offer::Error), } impl Cmd { @@ -64,6 +69,7 @@ impl Cmd { Cmd::ContractCode(cmd) => cmd.run().await?, Cmd::Trustline(cmd) => cmd.run().await?, Cmd::Data(cmd) => cmd.run().await?, + Cmd::Offer(cmd) => cmd.run().await?, } Ok(()) } diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs new file mode 100644 index 0000000000..6ae2211bad --- /dev/null +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs @@ -0,0 +1,78 @@ +use std::array::TryFromSliceError; +use std::fmt::Debug; + +use super::args::Args; +use crate::{ + commands::config::{self, locator}, + xdr::{ + LedgerKey, LedgerKeyOffer, MuxedAccount + }, +}; +use clap::{command, Parser}; + +#[derive(Parser, Debug, Clone)] +#[group(skip)] +pub struct Cmd { + #[command(flatten)] + pub args: Args, + + /// Account alias or public key to lookup, default is test identity + #[arg(long)] + pub account: String, + + /// ID of an offer made on the Stellar DEX + #[arg(long)] + pub offer: Option>, + + /// If identity is a seed phrase use this hd path, default is 0 + #[arg(long)] + pub hd_path: Option, +} + +#[derive(thiserror::Error, Debug)] +pub enum Error { + #[error(transparent)] + Config(#[from] config::key::Error), + #[error("provided asset is invalid: {0}")] + InvalidAsset(String), + #[error("provided data name is invalid: {0}")] + InvalidDataName(String), + #[error(transparent)] + Locator(#[from] locator::Error), + #[error(transparent)] + TryFromSliceError(#[from] TryFromSliceError), + #[error(transparent)] + Run(#[from] super::args::Error), +} + +impl Cmd { + pub async fn run(&self) -> Result<(), Error> { + let mut ledger_keys = vec![]; + self.insert_offer_keys(&mut ledger_keys)?; + + Ok(self.args.run(ledger_keys).await?) + } + + fn insert_offer_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { + if let Some(offer) = &self.offer { + let acc = self.muxed_account(&self.account)?; + for offer in offer { + let key = LedgerKey::Offer(LedgerKeyOffer { + seller_id: acc.clone().account_id(), + offer_id: *offer, + }); + ledger_keys.push(key); + } + } + + Ok(()) + } + + fn muxed_account(&self, account: &str) -> Result { + Ok(self + .args + .locator + .read_key(account)? + .muxed_account(self.hd_path)?) + } +} From 9035c51ecc47d69dbf3cf047cb7c2b89c17b18ea Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Thu, 9 Oct 2025 18:03:21 -0400 Subject: [PATCH 60/76] Clean up data, offer and trustline --- .../ledger/entry/fetch/account_data.rs | 32 ++++---- .../src/commands/ledger/entry/fetch/mod.rs | 2 +- .../src/commands/ledger/entry/fetch/offer.rs | 24 +++--- .../commands/ledger/entry/fetch/trustline.rs | 74 +++++++++---------- 4 files changed, 62 insertions(+), 70 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs index cf12f8bdad..ee95fa5049 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs @@ -4,9 +4,7 @@ use std::fmt::Debug; use super::args::Args; use crate::{ commands::config::{self, locator}, - xdr::{ - self, LedgerKey, LedgerKeyData, MuxedAccount, String64, - }, + xdr::{self, LedgerKey, LedgerKeyData, MuxedAccount, String64}, }; use clap::{command, Parser}; @@ -21,8 +19,8 @@ pub struct Cmd { pub account: String, /// Fetch key-value data entries attached to an account (see manageDataOp) - #[arg(long)] - pub data_name: Option>, + #[arg(long, required=true)] + pub data_name: Vec, /// If identity is a seed phrase use this hd path, default is 0 #[arg(long)] @@ -53,19 +51,17 @@ impl Cmd { } fn insert_data_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(data_name) = &self.data_name { - let acc = self.muxed_account(&self.account)?; - for data_name in data_name { - let data_name: xdr::StringM<64> = data_name - .parse() - .map_err(|_| Error::InvalidDataName(data_name.clone()))?; - let data_name = String64(data_name); - let key = LedgerKey::Data(LedgerKeyData { - account_id: acc.clone().account_id(), - data_name, - }); - ledger_keys.push(key); - } + let acc = self.muxed_account(&self.account)?; + for data_name in &self.data_name { + let data_name: xdr::StringM<64> = data_name + .parse() + .map_err(|_| Error::InvalidDataName(data_name.clone()))?; + let data_name = String64(data_name); + let key = LedgerKey::Data(LedgerKeyData { + account_id: acc.clone().account_id(), + data_name, + }); + ledger_keys.push(key); } Ok(()) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 19065b70c3..26b8947674 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -73,4 +73,4 @@ impl Cmd { } Ok(()) } -} +} \ No newline at end of file diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs index 6ae2211bad..c99beef2d9 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs @@ -4,9 +4,7 @@ use std::fmt::Debug; use super::args::Args; use crate::{ commands::config::{self, locator}, - xdr::{ - LedgerKey, LedgerKeyOffer, MuxedAccount - }, + xdr::{LedgerKey, LedgerKeyOffer, MuxedAccount}, }; use clap::{command, Parser}; @@ -21,8 +19,8 @@ pub struct Cmd { pub account: String, /// ID of an offer made on the Stellar DEX - #[arg(long)] - pub offer: Option>, + #[arg(long, required=true)] + pub offer: Vec, /// If identity is a seed phrase use this hd path, default is 0 #[arg(long)] @@ -54,15 +52,13 @@ impl Cmd { } fn insert_offer_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(offer) = &self.offer { - let acc = self.muxed_account(&self.account)?; - for offer in offer { - let key = LedgerKey::Offer(LedgerKeyOffer { - seller_id: acc.clone().account_id(), - offer_id: *offer, - }); - ledger_keys.push(key); - } + let acc = self.muxed_account(&self.account)?; + for offer in &self.offer { + let key = LedgerKey::Offer(LedgerKeyOffer { + seller_id: acc.clone().account_id(), + offer_id: *offer, + }); + ledger_keys.push(key); } Ok(()) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs index b8ba271e37..1731e48967 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs @@ -4,7 +4,9 @@ use std::fmt::Debug; use super::args::Args; use crate::{ commands::config::{self, locator}, - xdr::{ AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, LedgerKeyTrustLine, MuxedAccount, PublicKey, TrustLineAsset, Uint256, + xdr::{ + AccountId, AlphaNum12, AlphaNum4, AssetCode12, AssetCode4, LedgerKey, LedgerKeyTrustLine, + MuxedAccount, PublicKey, TrustLineAsset, Uint256, }, }; use clap::{command, Parser}; @@ -21,8 +23,8 @@ pub struct Cmd { pub account: String, /// Assets to get trustline info for - #[arg(long)] - pub asset: Option>, + #[arg(long, required=true)] + pub asset: Vec, /// If identity is a seed phrase use this hd path, default is 0 #[arg(long)] @@ -53,43 +55,41 @@ impl Cmd { } fn insert_asset_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(asset) = &self.asset { - let acc = self.muxed_account(&self.account)?; - for asset in asset { - let asset = if asset.eq_ignore_ascii_case("XLM") { - TrustLineAsset::Native - } else if asset.contains(':') { - let mut parts = asset.split(':'); - let code = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; - let issuer = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; - if parts.next().is_some() { - Err(Error::InvalidAsset(asset.clone()))?; - } - let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; - let issuer = AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); + let acc = self.muxed_account(&self.account)?; + for asset in &self.asset { + let asset = if asset.eq_ignore_ascii_case("XLM") { + TrustLineAsset::Native + } else if asset.contains(':') { + let mut parts = asset.split(':'); + let code = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; + let issuer = parts.next().ok_or(Error::InvalidAsset(asset.clone()))?; + if parts.next().is_some() { + Err(Error::InvalidAsset(asset.clone()))?; + } + let source_bytes = Ed25519PublicKey::from_string(issuer).unwrap().0; + let issuer = AccountId(PublicKey::PublicKeyTypeEd25519(Uint256(source_bytes))); - match code.len() { - 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { - asset_code: AssetCode4(code.as_bytes().try_into()?), - issuer, - }), - 12 => TrustLineAsset::CreditAlphanum12(AlphaNum12 { - asset_code: AssetCode12(code.as_bytes().try_into()?), - issuer, - }), - _ => Err(Error::InvalidAsset(asset.clone()))?, - } - } else { - Err(Error::InvalidAsset(asset.clone()))? - }; + match code.len() { + 4 => TrustLineAsset::CreditAlphanum4(AlphaNum4 { + asset_code: AssetCode4(code.as_bytes().try_into()?), + issuer, + }), + 12 => TrustLineAsset::CreditAlphanum12(AlphaNum12 { + asset_code: AssetCode12(code.as_bytes().try_into()?), + issuer, + }), + _ => Err(Error::InvalidAsset(asset.clone()))?, + } + } else { + Err(Error::InvalidAsset(asset.clone()))? + }; - let key = LedgerKey::Trustline(LedgerKeyTrustLine { - account_id: acc.clone().account_id(), - asset, - }); + let key = LedgerKey::Trustline(LedgerKeyTrustLine { + account_id: acc.clone().account_id(), + asset, + }); - ledger_keys.push(key); - } + ledger_keys.push(key); } Ok(()) } From f46507e6fe48cae0672316eb953bc0e50498e9fe Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 13 Oct 2025 13:41:34 -0400 Subject: [PATCH 61/76] Cleanup doc comments & regenerate docs --- FULL_HELP_DOCS.md | 118 ++++++++++++++++-- .../src/commands/ledger/entry/fetch/mod.rs | 5 +- 2 files changed, 109 insertions(+), 14 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index c25aa54f5d..1d3ad71821 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -4004,18 +4004,21 @@ Fetch ledger entries. This command supports all types of ledger entries supporte ###### **Subcommands:** -* `account` — Fetch account entry by public key or alias. Additional account-related keys are available with optional flags -* `contract` — Fetch contract ledger entry by address or alias and storage key +* `account` — Fetch account entry by public key or alias +* `contract-data` — Fetch contract ledger entry by address or alias and storage key * `config` — Fetch the current network config by `ConfigSettingId`. All config settings are returned if no id is provided * `claimable-balance` — Fetch a claimable balance ledger entry by id * `liquidity-pool` — Fetch a liquidity pool ledger entry by id -* `wasm` — Fetch WASM bytecode by hash +* `contract-code` — Fetch WASM bytecode by hash +* `trustline` — Fetch a trustline by account and asset +* `data` — Fetch key-value data entries attached to an account (see manageDataOp) +* `offer` — Fetch an offer by account and offer id ## `stellar ledger entry fetch account` -Fetch account entry by public key or alias. Additional account-related keys are available with optional flags +Fetch account entry by public key or alias **Usage:** `stellar ledger entry fetch account [OPTIONS] ` @@ -4043,19 +4046,16 @@ Fetch account entry by public key or alias. Additional account-related keys are - `xdr`: Original RPC output (containing XDRs) -* `--asset ` — Assets to get trustline info for -* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) -* `--offer ` — ID of an offer made on the Stellar DEX * `--hide-account` — Hide the account ledger entry from the output * `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -## `stellar ledger entry fetch contract` +## `stellar ledger entry fetch contract-data` Fetch contract ledger entry by address or alias and storage key -**Usage:** `stellar ledger entry fetch contract [OPTIONS] ` +**Usage:** `stellar ledger entry fetch contract-data [OPTIONS] ` ###### **Arguments:** @@ -4212,11 +4212,11 @@ Fetch a liquidity pool ledger entry by id -## `stellar ledger entry fetch wasm` +## `stellar ledger entry fetch contract-code` Fetch WASM bytecode by hash -**Usage:** `stellar ledger entry fetch wasm [OPTIONS] [WASM_HASHES]...` +**Usage:** `stellar ledger entry fetch contract-code [OPTIONS] [WASM_HASHES]...` ###### **Arguments:** @@ -4245,6 +4245,102 @@ Fetch WASM bytecode by hash +## `stellar ledger entry fetch trustline` + +Fetch a trustline by account and asset + +**Usage:** `stellar ledger entry fetch trustline [OPTIONS] --account --asset ` + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + +* `--account ` — Account alias or public key to lookup, default is test identity +* `--asset ` — Assets to get trustline info for +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + + + +## `stellar ledger entry fetch data` + +Fetch key-value data entries attached to an account (see manageDataOp) + +**Usage:** `stellar ledger entry fetch data [OPTIONS] --account --data-name ` + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + +* `--account ` — Account alias or public key to lookup, default is test identity +* `--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 + + + +## `stellar ledger entry fetch offer` + +Fetch an offer by account and offer id + +**Usage:** `stellar ledger entry fetch offer [OPTIONS] --account --offer ` + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output + + Default value: `json` + + Possible values: + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + +* `--account ` — Account alias or public key to lookup, default is test identity +* `--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 + + + ## `stellar ledger latest` Get the latest ledger sequence and information from the network diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 26b8947674..caa9b709e8 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -15,7 +15,6 @@ pub mod offer; #[derive(Debug, Parser)] pub enum Cmd { /// Fetch account entry by public key or alias. - /// Additional account-related keys are available with optional flags. Account(account::Cmd), /// Fetch contract ledger entry by address or alias and storage key. ContractData(contract_data::Cmd), @@ -28,11 +27,11 @@ pub enum Cmd { LiquidityPool(liquidity_pool::Cmd), /// Fetch WASM bytecode by hash ContractCode(contract_code::Cmd), - /// UPDATE + /// Fetch a trustline by account and asset Trustline(trustline::Cmd), /// Fetch key-value data entries attached to an account (see manageDataOp) Data(account_data::Cmd), - /// UPDATE + /// Fetch an offer by account and offer id Offer(offer::Cmd), } From 9c5157a51cecfe5f2e199ac84b03864c26c1b22a Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 13 Oct 2025 14:22:08 -0400 Subject: [PATCH 62/76] Cargo fmt --- .../src/commands/ledger/entry/fetch/account.rs | 4 +--- .../src/commands/ledger/entry/fetch/account_data.rs | 2 +- cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs | 8 ++++---- cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs | 2 +- .../src/commands/ledger/entry/fetch/trustline.rs | 2 +- 5 files changed, 8 insertions(+), 10 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index f970f6a680..54c52aa366 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -4,9 +4,7 @@ use std::fmt::Debug; use super::args::Args; use crate::{ commands::config::{self, locator}, - xdr::{ - LedgerKey, LedgerKeyAccount, MuxedAccount - }, + xdr::{LedgerKey, LedgerKeyAccount, MuxedAccount}, }; use clap::{command, Parser}; diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs index ee95fa5049..f6f73e0dfc 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs @@ -19,7 +19,7 @@ pub struct Cmd { pub account: String, /// Fetch key-value data entries attached to an account (see manageDataOp) - #[arg(long, required=true)] + #[arg(long, required = true)] pub data_name: Vec, /// If identity is a seed phrase use this hd path, default is 0 diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index caa9b709e8..480c8f6b21 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -2,15 +2,15 @@ use clap::Parser; use std::fmt::Debug; pub mod account; +pub mod account_data; pub mod args; pub mod claimable_balance; pub mod config; +pub mod contract_code; pub mod contract_data; pub mod liquidity_pool; -pub mod contract_code; -pub mod trustline; -pub mod account_data; pub mod offer; +pub mod trustline; #[derive(Debug, Parser)] pub enum Cmd { @@ -72,4 +72,4 @@ impl Cmd { } Ok(()) } -} \ No newline at end of file +} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs index c99beef2d9..c2af11f597 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs @@ -19,7 +19,7 @@ pub struct Cmd { pub account: String, /// ID of an offer made on the Stellar DEX - #[arg(long, required=true)] + #[arg(long, required = true)] pub offer: Vec, /// If identity is a seed phrase use this hd path, default is 0 diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs index 1731e48967..cbd56ecf3f 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs @@ -23,7 +23,7 @@ pub struct Cmd { pub account: String, /// Assets to get trustline info for - #[arg(long, required=true)] + #[arg(long, required = true)] pub asset: Vec, /// If identity is a seed phrase use this hd path, default is 0 From 0336bb80f6fe56c2070d5a2458d8f4772560e126 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 13 Oct 2025 15:55:05 -0400 Subject: [PATCH 63/76] Generated docs prettier updates --- FULL_HELP_DOCS.md | 4024 ++++++++++++++++++++------------------------- 1 file changed, 1806 insertions(+), 2218 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 0a849e60b7..7e3bf33b84 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -38,41 +38,38 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world - **Usage:** `stellar [OPTIONS] ` ###### **Subcommands:** -* `contract` — Tools for smart contract developers -* `doctor` — Diagnose and troubleshoot CLI and network issues -* `events` — Watch the network for contract events -* `env` — Prints the environment variables -* `keys` — Create and manage identities including keys and addresses -* `network` — Configure connection to networks -* `container` — Start local networks in containers -* `config` — Manage cli configuration -* `snapshot` — Download a snapshot of a ledger from an archive -* `tx` — Sign, Simulate, and Send transactions -* `xdr` — Decode and encode XDR -* `completion` — Print shell completion code for the specified shell -* `cache` — Cache for transactions and contract specs -* `version` — Print version information -* `plugin` — The subcommand for CLI plugins -* `ledger` — Fetch ledger information -* `fee-stats` — Fetch network feestats - -###### **Options:** - -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` -* `-q`, `--quiet` — Do not write logs to stderr including `INFO` -* `-v`, `--verbose` — Log DEBUG events -* `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events -* `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` -* `--no-cache` — Do not cache your simulations and transactions - - +- `contract` — Tools for smart contract developers +- `doctor` — Diagnose and troubleshoot CLI and network issues +- `events` — Watch the network for contract events +- `env` — Prints the environment variables +- `keys` — Create and manage identities including keys and addresses +- `network` — Configure connection to networks +- `container` — Start local networks in containers +- `config` — Manage cli configuration +- `snapshot` — Download a snapshot of a ledger from an archive +- `tx` — Sign, Simulate, and Send transactions +- `xdr` — Decode and encode XDR +- `completion` — Print shell completion code for the specified shell +- `cache` — Cache for transactions and contract specs +- `version` — Print version information +- `plugin` — The subcommand for CLI plugins +- `ledger` — Fetch ledger information +- `fee-stats` — Fetch network feestats + +###### **Options:** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` +- `-q`, `--quiet` — Do not write logs to stderr including `INFO` +- `-v`, `--verbose` — Log DEBUG events +- `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events +- `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` +- `--no-cache` — Do not cache your simulations and transactions ## `stellar contract` @@ -82,25 +79,23 @@ Tools for smart contract developers ###### **Subcommands:** -* `asset` — Utilities to deploy a Stellar Asset Contract or get its id -* `alias` — Utilities to manage contract aliases -* `bindings` — Generate code client bindings for a contract -* `build` — Build a contract from source -* `extend` — Extend the time to live ledger of a contract-data ledger entry -* `deploy` — Deploy a wasm contract -* `fetch` — Fetch a contract's Wasm binary -* `id` — Generate the contract id for a given contract or asset -* `info` — Access info about contracts -* `init` — Initialize a Soroban contract project -* `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc -* `upload` — Install a WASM file to the ledger without creating a contract instance -* `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance -* `invoke` — Invoke a contract function -* `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file -* `read` — Print the current value of a contract-data ledger entry -* `restore` — Restore an evicted value for a contract-data legder entry - - +- `asset` — Utilities to deploy a Stellar Asset Contract or get its id +- `alias` — Utilities to manage contract aliases +- `bindings` — Generate code client bindings for a contract +- `build` — Build a contract from source +- `extend` — Extend the time to live ledger of a contract-data ledger entry +- `deploy` — Deploy a wasm contract +- `fetch` — Fetch a contract's Wasm binary +- `id` — Generate the contract id for a given contract or asset +- `info` — Access info about contracts +- `init` — Initialize a Soroban contract project +- `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc +- `upload` — Install a WASM file to the ledger without creating a contract instance +- `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance +- `invoke` — Invoke a contract function +- `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file +- `read` — Print the current value of a contract-data ledger entry +- `restore` — Restore an evicted value for a contract-data legder entry ## `stellar contract asset` @@ -110,10 +105,8 @@ Utilities to deploy a Stellar Asset Contract or get its id ###### **Subcommands:** -* `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead -* `deploy` — Deploy builtin Soroban Asset Contract - - +- `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead +- `deploy` — Deploy builtin Soroban Asset Contract ## `stellar contract asset id` @@ -123,15 +116,13 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract asset deploy` @@ -141,27 +132,26 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract alias` @@ -171,12 +161,10 @@ Utilities to manage contract aliases ###### **Subcommands:** -* `remove` — Remove contract alias -* `add` — Add contract alias -* `show` — Show the contract id associated with a given alias -* `ls` — List all aliases - - +- `remove` — Remove contract alias +- `add` — Add contract alias +- `show` — Show the contract id associated with a given alias +- `ls` — List all aliases ## `stellar contract alias remove` @@ -186,18 +174,16 @@ Remove contract alias ###### **Arguments:** -* `` — The contract alias that will be removed +- `` — The contract alias that will be removed ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract alias add` @@ -207,20 +193,18 @@ Add contract alias ###### **Arguments:** -* `` — The contract alias that will be used +- `` — The contract alias that will be used ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--overwrite` — Overwrite the contract alias if it already exists -* `--id ` — The contract id that will be associated with the alias - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--overwrite` — Overwrite the contract alias if it already exists +- `--id ` — The contract id that will be associated with the alias ## `stellar contract alias show` @@ -230,18 +214,16 @@ Show the contract id associated with a given alias ###### **Arguments:** -* `` — The contract alias that will be displayed +- `` — The contract alias that will be displayed ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract alias ls` @@ -251,10 +233,8 @@ List all aliases ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract bindings` @@ -264,16 +244,14 @@ Generate code client bindings for a contract ###### **Subcommands:** -* `json` — Generate Json Bindings -* `rust` — Generate Rust bindings -* `typescript` — Generate a TypeScript / JavaScript package -* `python` — Generate Python bindings -* `java` — Generate Java bindings -* `flutter` — Generate Flutter bindings -* `swift` — Generate Swift bindings -* `php` — Generate PHP bindings - - +- `json` — Generate Json Bindings +- `rust` — Generate Rust bindings +- `typescript` — Generate a TypeScript / JavaScript package +- `python` — Generate Python bindings +- `java` — Generate Java bindings +- `flutter` — Generate Flutter bindings +- `swift` — Generate Swift bindings +- `php` — Generate PHP bindings ## `stellar contract bindings json` @@ -283,9 +261,7 @@ Generate Json Bindings ###### **Options:** -* `--wasm ` — Path to wasm binary - - +- `--wasm ` — Path to wasm binary ## `stellar contract bindings rust` @@ -295,9 +271,7 @@ Generate Rust bindings ###### **Options:** -* `--wasm ` — Path to wasm binary - - +- `--wasm ` — Path to wasm binary ## `stellar contract bindings typescript` @@ -307,19 +281,17 @@ Generate a TypeScript / JavaScript package ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output-dir ` — Where to place generated project -* `--overwrite` — Whether to overwrite output directory if it already exists - - +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output-dir ` — Where to place generated project +- `--overwrite` — Whether to overwrite output directory if it already exists ## `stellar contract bindings python` @@ -327,40 +299,30 @@ Generate Python bindings **Usage:** `stellar contract bindings python` - - ## `stellar contract bindings java` Generate Java bindings **Usage:** `stellar contract bindings java` - - ## `stellar contract bindings flutter` Generate Flutter bindings **Usage:** `stellar contract bindings flutter` - - ## `stellar contract bindings swift` Generate Swift bindings **Usage:** `stellar contract bindings swift` - - ## `stellar contract bindings php` Generate PHP bindings **Usage:** `stellar contract bindings php` - - ## `stellar contract build` Build a contract from source @@ -375,26 +337,27 @@ To view the commands that will be executed, without executing them, use the --pr ###### **Options:** -* `--manifest-path ` — Path to Cargo.toml -* `--package ` — Package to build +- `--manifest-path ` — Path to Cargo.toml +- `--package ` — Package to build + + If omitted, all packages that build for crate-type cdylib are built. - If omitted, all packages that build for crate-type cdylib are built. -* `--profile ` — Build with the specified profile +- `--profile ` — Build with the specified profile Default value: `release` -* `--features ` — Build with the list of features activated, space or comma separated -* `--all-features` — Build with the all features activated -* `--no-default-features` — Build with the default feature not activated -* `--out-dir ` — Directory to copy wasm files to - If provided, wasm files can be found in the cargo target directory, and the specified directory. +- `--features ` — Build with the list of features activated, space or comma separated +- `--all-features` — Build with the all features activated +- `--no-default-features` — Build with the default feature not activated +- `--out-dir ` — Directory to copy wasm files to - If ommitted, wasm files are written only to the cargo target directory. -* `--print-commands-only` — Print commands to build without executing them -* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) -* `--optimize` — Optimize the generated wasm + If provided, wasm files can be found in the cargo target directory, and the specified directory. + If ommitted, wasm files are written only to the cargo target directory. +- `--print-commands-only` — Print commands to build without executing them +- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +- `--optimize` — Optimize the generated wasm ## `stellar contract extend` @@ -406,42 +369,39 @@ If no keys are specified the contract itself is extended. ###### **Options:** -* `--ledgers-to-extend ` — Number of ledgers to extend the entries -* `--ttl-ledger-only` — Only print the new Time To Live ledger -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability +- `--ledgers-to-extend ` — Number of ledgers to extend the entries +- `--ttl-ledger-only` — Only print the new Time To Live ledger +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: Persistent + - `temporary`: Temporary + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract deploy` @@ -451,36 +411,36 @@ Deploy a wasm contract ###### **Arguments:** -* `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` +- `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Options:** -* `--wasm ` — WASM file to deploy -* `--wasm-hash ` — Hash of the already installed/deployed WASM file -* `--salt ` — Custom salt 32-byte salt for the token id -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--wasm ` — WASM file to deploy +- `--wasm-hash ` — Hash of the already installed/deployed WASM file +- `--salt ` — Custom salt 32-byte salt for the token id +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts - Default value: `false` -* `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + Default value: `false` +- `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract fetch` @@ -490,17 +450,15 @@ Fetch a contract's Wasm binary ###### **Options:** -* `--id ` — Contract ID to fetch -* `--wasm-hash ` — Wasm to fetch -* `-o`, `--out-file ` — Where to write output otherwise stdout is used -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--id ` — Contract ID to fetch +- `--wasm-hash ` — Wasm to fetch +- `-o`, `--out-file ` — Where to write output otherwise stdout is used +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract id` @@ -510,10 +468,8 @@ Generate the contract id for a given contract or asset ###### **Subcommands:** -* `asset` — Deploy builtin Soroban Asset Contract -* `wasm` — Deploy normal Wasm Contract - - +- `asset` — Deploy builtin Soroban Asset Contract +- `wasm` — Deploy normal Wasm Contract ## `stellar contract id asset` @@ -523,15 +479,13 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract id wasm` @@ -541,20 +495,18 @@ Deploy normal Wasm Contract ###### **Options:** -* `--salt ` — ID of the Soroban contract -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet - - +- `--salt ` — ID of the Soroban contract +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar contract info` @@ -564,12 +516,10 @@ Access info about contracts ###### **Subcommands:** -* `interface` — Output the interface of a contract -* `meta` — Output the metadata stored in a contract -* `env-meta` — Output the env required metadata stored in a contract -* `build` — Output the contract build information, if available - - +- `interface` — Output the interface of a contract +- `meta` — Output the metadata stored in a contract +- `env-meta` — Output the env required metadata stored in a contract +- `build` — Output the contract build information, if available ## `stellar contract info interface` @@ -585,31 +535,24 @@ Outputs no data when no data is present in the contract. ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `rust` Possible values: - - `rust`: - Rust code output of the contract interface - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - - - + - `rust`: Rust code output of the contract interface + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ## `stellar contract info meta` @@ -625,31 +568,24 @@ Outputs no data when no data is present in the contract. ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of the meta info entry - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - - - + - `text`: Text output of the meta info entry + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ## `stellar contract info env-meta` @@ -665,31 +601,24 @@ Outputs no data when no data is present in the contract. ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of the meta info entry - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - - - + - `text`: Text output of the meta info entry + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ## `stellar contract info build` @@ -701,17 +630,15 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract init` @@ -723,16 +650,15 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Arguments:** -* `` +- `` ###### **Options:** -* `--name ` — An optional flag to specify a new contract's name. +- `--name ` — An optional flag to specify a new contract's name. Default value: `hello-world` -* `--overwrite` — Overwrite all existing files. - +- `--overwrite` — Overwrite all existing files. ## `stellar contract inspect` @@ -742,23 +668,18 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Options:** -* `--wasm ` — Path to wasm binary -* `--output ` — Output just XDR in base64 +- `--wasm ` — Path to wasm binary +- `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - - `xdr-base64`: - XDR of array of contract spec entries - - `xdr-base64-array`: - Array of xdr of contract spec entries - - `docs`: - Pretty print of contract spec entries - -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - + - `xdr-base64`: XDR of array of contract spec entries + - `xdr-base64-array`: Array of xdr of contract spec entries + - `docs`: Pretty print of contract spec entries +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract upload` @@ -768,29 +689,28 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--wasm ` — Path to wasm binary -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts - - Default value: `false` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--wasm ` — Path to wasm binary +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + Default value: `false` ## `stellar contract install` @@ -800,29 +720,28 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--wasm ` — Path to wasm binary -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts - - Default value: `false` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--wasm ` — Path to wasm binary +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + Default value: `false` ## `stellar contract invoke` @@ -836,43 +755,38 @@ stellar contract invoke ... -- --help ###### **Arguments:** -* `` — Function name as subcommand, then arguments for that function as `--arg-name value` +- `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Options:** -* `--id ` — Contract ID to invoke -* `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--id ` — Contract ID to invoke +- `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--send ` — Whether or not to send a transaction + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--send ` — Whether or not to send a transaction Default value: `default` Possible values: - - `default`: - Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result - - `no`: - Do not send transaction, return simulation result - - `yes`: - Always send transaction - - - + - `default`: Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result + - `no`: Do not send transaction, return simulation result + - `yes`: Always send transaction ## `stellar contract optimize` @@ -882,10 +796,8 @@ stellar contract invoke ... -- --help ###### **Options:** -* `--wasm ` — Path to one or more wasm binaries -* `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) - - +- `--wasm ` — Path to one or more wasm binaries +- `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) ## `stellar contract read` @@ -895,41 +807,34 @@ Print the current value of a contract-data ledger entry ###### **Options:** -* `--output ` — Type of output to generate +- `--output ` — Type of output to generate Default value: `string` Possible values: - - `string`: - String - - `json`: - Json - - `xdr`: - XDR - -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability + - `string`: String + - `json`: Json + - `xdr`: XDR + +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - + - `persistent`: Persistent + - `temporary`: Temporary +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract restore` @@ -941,42 +846,39 @@ If no keys are specificed the contract itself is restored. ###### **Options:** -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--ledgers-to-extend ` — Number of ledgers to extend the entry -* `--ttl-ledger-only` — Only print the new Time To Live ledger -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: Persistent + - `temporary`: Temporary + +- `--ledgers-to-extend ` — Number of ledgers to extend the entry +- `--ttl-ledger-only` — Only print the new Time To Live ledger +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar doctor` @@ -986,10 +888,8 @@ Diagnose and troubleshoot CLI and network issues ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar events` @@ -999,47 +899,45 @@ Watch the network for contract events ###### **Options:** -* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence -* `--cursor ` — The cursor corresponding to the start of the event range -* `--output ` — Output formatting options for event stream +- `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence +- `--cursor ` — The cursor corresponding to the start of the event range +- `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - - `pretty`: - Colorful, human-oriented console output - - `plain`: - Human-oriented console output without colors - - `json`: - JSON formatted console output + - `pretty`: Colorful, human-oriented console output + - `plain`: Human-oriented console output without colors + - `json`: JSON formatted console output -* `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) +- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` -* `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. - Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. -* `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. +- `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. - **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` + Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. - **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` +- `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. - Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). -* `--type ` — Specifies which type of contract events to display + **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` - Default value: `all` + **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` - Possible values: `all`, `contract`, `system` + Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--type ` — Specifies which type of contract events to display + Default value: `all` + + Possible values: `all`, `contract`, `system` +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar env` @@ -1055,16 +953,14 @@ If there are no environment variables in use, prints the defaults. ###### **Arguments:** -* `` — Env variable name to get the value of. +- `` — Env variable name to get the value of. - E.g.: $ stellar env STELLAR_ACCOUNT + E.g.: $ stellar env STELLAR_ACCOUNT ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys` @@ -1074,16 +970,14 @@ Create and manage identities including keys and addresses ###### **Subcommands:** -* `add` — Add a new identity (keypair, ledger, OS specific secure store) -* `public-key` — Given an identity return its address (public key) -* `fund` — Fund an identity on a test network -* `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store -* `ls` — List identities -* `rm` — Remove an identity -* `secret` — Output an identity's secret key -* `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it - - +- `add` — Add a new identity (keypair, ledger, OS specific secure store) +- `public-key` — Given an identity return its address (public key) +- `fund` — Fund an identity on a test network +- `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store +- `ls` — List identities +- `rm` — Remove an identity +- `secret` — Output an identity's secret key +- `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it ## `stellar keys add` @@ -1093,22 +987,21 @@ Add a new identity (keypair, ledger, OS specific secure store) ###### **Arguments:** -* `` — Name of identity +- `` — Name of identity ###### **Options:** -* `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted -* `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase -* `--secure-store` — Save the new key in your OS's credential secure store. - - On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. +- `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted +- `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase +- `--secure-store` — Save the new key in your OS's credential secure store. - This only supports seed phrases for now. -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. + On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + This only supports seed phrases for now. +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. ## `stellar keys public-key` @@ -1120,15 +1013,13 @@ Given an identity return its address (public key) ###### **Arguments:** -* `` — Name of identity to lookup, default test identity used if not provided +- `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys fund` @@ -1138,19 +1029,17 @@ Fund an identity on a test network ###### **Arguments:** -* `` — Name of identity to lookup, default test identity used if not provided +- `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys generate` @@ -1160,28 +1049,28 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store ###### **Arguments:** -* `` — Name of identity +- `` — Name of identity ###### **Options:** -* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -* `-s`, `--as-secret` — Output the generated identity as a secret key -* `--secure-store` — Save the new key in your OS's credential secure store. +- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +- `-s`, `--as-secret` — Output the generated identity as a secret key +- `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--fund` — Fund generated key pair + On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - Default value: `false` -* `--overwrite` — Overwrite existing identity if it already exists +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--fund` — Fund generated key pair + Default value: `false` +- `--overwrite` — Overwrite existing identity if it already exists ## `stellar keys ls` @@ -1191,11 +1080,9 @@ List identities ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-l`, `--long` - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` ## `stellar keys rm` @@ -1205,14 +1092,12 @@ Remove an identity ###### **Arguments:** -* `` — Identity to remove +- `` — Identity to remove ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys secret` @@ -1222,16 +1107,14 @@ Output an identity's secret key ###### **Arguments:** -* `` — Name of identity to lookup, default is test identity +- `` — Name of identity to lookup, default is test identity ###### **Options:** -* `--phrase` — Output seed phrase instead of private key -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--phrase` — Output seed phrase instead of private key +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys use` @@ -1241,14 +1124,12 @@ Set the default identity that will be used on all commands. This allows you to s ###### **Arguments:** -* `` — Set the default network name +- `` — Set the default network name ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network` @@ -1258,15 +1139,13 @@ Configure connection to networks ###### **Subcommands:** -* `add` — Add a new network -* `rm` — Remove a network -* `ls` — List networks -* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it -* `health` — Fetch the health of the configured RPC -* `info` — Checks the health of the configured RPC -* `settings` — Fetch the network's config settings - - +- `add` — Add a new network +- `rm` — Remove a network +- `ls` — List networks +- `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +- `health` — Fetch the health of the configured RPC +- `info` — Checks the health of the configured RPC +- `settings` — Fetch the network's config settings ## `stellar network add` @@ -1276,17 +1155,15 @@ Add a new network ###### **Arguments:** -* `` — Name of network +- `` — Name of network ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network rm` @@ -1296,14 +1173,12 @@ Remove a network ###### **Arguments:** -* `` — Network to remove +- `` — Network to remove ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network ls` @@ -1313,11 +1188,9 @@ List networks ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-l`, `--long` — Get more info about the networks - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` — Get more info about the networks ## `stellar network use` @@ -1327,14 +1200,12 @@ Set the default network that will be used on all commands. This allows you to sk ###### **Arguments:** -* `` — Set the default network name +- `` — Set the default network name ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network health` @@ -1344,26 +1215,20 @@ Fetch the health of the configured RPC ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network health status - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - + - `text`: Text output of network health status + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ## `stellar network info` @@ -1373,26 +1238,20 @@ Checks the health of the configured RPC ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ## `stellar network settings` @@ -1402,27 +1261,21 @@ Fetch the network's config settings ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network +- `--output ` — Format of the output Default value: `json` Possible values: - - `xdr`: - XDR (`ConfigUpgradeSet` type) - - `json`: - JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - - `json-formatted`: - JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type - - - + - `xdr`: XDR (`ConfigUpgradeSet` type) + - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type ## `stellar container` @@ -1432,11 +1285,9 @@ Start local networks in containers ###### **Subcommands:** -* `logs` — Get logs from a running network container -* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) -* `stop` — Stop a network container started with `stellar container start` - - +- `logs` — Get logs from a running network container +- `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) +- `stop` — Stop a network container started with `stellar container start` ## `stellar container logs` @@ -1446,15 +1297,13 @@ Get logs from a running network container ###### **Arguments:** -* `` — Container to get logs from +- `` — Container to get logs from Default value: `local` ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock - - +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar container start` @@ -1470,23 +1319,21 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Arguments:** -* `` — Network to start. Default is `local` +- `` — Network to start. Default is `local` Possible values: `local`, `testnet`, `futurenet`, `pubnet` - ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -* `--name ` — Optional argument to specify the container name -* `-l`, `--limits ` — Optional argument to specify the limits for the local network only -* `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +- `--name ` — Optional argument to specify the container name +- `-l`, `--limits ` — Optional argument to specify the limits for the local network only +- `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping Default value: `8000:8000` -* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network -* `--protocol-version ` — Optional argument to specify the protocol version for the local network only - +- `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +- `--protocol-version ` — Optional argument to specify the protocol version for the local network only ## `stellar container stop` @@ -1496,15 +1343,13 @@ Stop a network container started with `stellar container start` ###### **Arguments:** -* `` — Container to stop +- `` — Container to stop Default value: `local` ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock - - +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar config` @@ -1514,10 +1359,8 @@ Manage cli configuration ###### **Subcommands:** -* `migrate` — Migrate the local configuration to the global directory -* `dir` — Show the global configuration directory - - +- `migrate` — Migrate the local configuration to the global directory +- `dir` — Show the global configuration directory ## `stellar config migrate` @@ -1527,10 +1370,8 @@ Migrate the local configuration to the global directory ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar config dir` @@ -1544,10 +1385,8 @@ The location will depend on how your system is configured. ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar snapshot` @@ -1557,9 +1396,7 @@ Download a snapshot of a ledger from an archive ###### **Subcommands:** -* `create` — Create a ledger snapshot using a history archive - - +- `create` — Create a ledger snapshot using a history archive ## `stellar snapshot create` @@ -1579,25 +1416,24 @@ Any invalid contract id passed as `--address` will be ignored. ###### **Options:** -* `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger -* `--address
` — Account or contract address/alias to include in the snapshot -* `--wasm-hash ` — WASM hashes to include in the snapshot -* `--output ` — Format of the out file +- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger +- `--address
` — Account or contract address/alias to include in the snapshot +- `--wasm-hash ` — WASM hashes to include in the snapshot +- `--output ` — Format of the out file Possible values: `json` -* `--out ` — Out path that the snapshot is written to +- `--out ` — Out path that the snapshot is written to Default value: `snapshot.json` -* `--archive-url ` — Archive URL -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - +- `--archive-url ` — Archive URL +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx` @@ -1607,19 +1443,17 @@ Sign, Simulate, and Send transactions ###### **Subcommands:** -* `update` — Update the transaction -* `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order -* `hash` — Calculate the hash of a transaction envelope -* `new` — Create a new transaction -* `operation` — Manipulate the operations in a transaction, including adding new operations -* `send` — Send a transaction envelope to the network -* `sign` — Sign a transaction envelope appending the signature to the envelope -* `simulate` — Simulate a transaction envelope from stdin -* `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -* `decode` — Decode a transaction envelope from XDR to JSON -* `encode` — Encode a transaction envelope from JSON to XDR - - +- `update` — Update the transaction +- `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order +- `hash` — Calculate the hash of a transaction envelope +- `new` — Create a new transaction +- `operation` — Manipulate the operations in a transaction, including adding new operations +- `send` — Send a transaction envelope to the network +- `sign` — Sign a transaction envelope appending the signature to the envelope +- `simulate` — Simulate a transaction envelope from stdin +- `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned +- `decode` — Decode a transaction envelope from XDR to JSON +- `encode` — Encode a transaction envelope from JSON to XDR ## `stellar tx update` @@ -1629,9 +1463,7 @@ Update the transaction ###### **Subcommands:** -* `sequence-number` — Edit the sequence number on a transaction - - +- `sequence-number` — Edit the sequence number on a transaction ## `stellar tx update sequence-number` @@ -1643,9 +1475,7 @@ Edit the sequence number on a transaction ###### **Subcommands:** -* `next` — Fetch the source account's seq-num and increment for the given tx - - +- `next` — Fetch the source account's seq-num and increment for the given tx ## `stellar tx update sequence-number next` @@ -1655,14 +1485,12 @@ Fetch the source account's seq-num and increment for the given tx ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar tx edit` @@ -1678,8 +1506,6 @@ $ stellar tx new manage-data --data-name hello --build-only | stellar tx edit **Usage:** `stellar tx edit` - - ## `stellar tx hash` Calculate the hash of a transaction envelope @@ -1688,16 +1514,14 @@ Calculate the hash of a transaction envelope ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx new` @@ -1707,30 +1531,28 @@ Create a new transaction ###### **Subcommands:** -* `account-merge` — Transfer XLM balance to another account and remove source account -* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -* `bump-sequence` — Bump sequence number to invalidate older transactions -* `change-trust` — Create, update, or delete a trustline -* `claim-claimable-balance` — Claim a claimable balance by its balance ID -* `clawback` — Clawback an asset from an account -* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -* `create-account` — Create and fund a new account -* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -* `end-sponsoring-future-reserves` — End sponsoring future reserves -* `liquidity-pool-deposit` — Deposit assets into a liquidity pool -* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -* `manage-buy-offer` — Create, update, or delete a buy offer -* `manage-data` — Set, modify, or delete account data entries -* `manage-sell-offer` — Create, update, or delete a sell offer -* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -* `payment` — Send asset to destination account -* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -* `set-options` — Set account options like flags, signers, and home domain -* `set-trustline-flags` — Configure authorization and trustline flags for an asset - - +- `account-merge` — Transfer XLM balance to another account and remove source account +- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +- `bump-sequence` — Bump sequence number to invalidate older transactions +- `change-trust` — Create, update, or delete a trustline +- `claim-claimable-balance` — Claim a claimable balance by its balance ID +- `clawback` — Clawback an asset from an account +- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +- `create-account` — Create and fund a new account +- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +- `end-sponsoring-future-reserves` — End sponsoring future reserves +- `liquidity-pool-deposit` — Deposit assets into a liquidity pool +- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +- `manage-buy-offer` — Create, update, or delete a buy offer +- `manage-data` — Set, modify, or delete account data entries +- `manage-sell-offer` — Create, update, or delete a sell offer +- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +- `payment` — Send asset to destination account +- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +- `set-options` — Set account options like flags, signers, and home domain +- `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx new account-merge` @@ -1740,26 +1562,25 @@ Transfer XLM balance to another account and remove source account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx new begin-sponsoring-future-reserves` @@ -1769,26 +1590,25 @@ Begin sponsoring future reserves for another account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--sponsored-id ` — Account that will be sponsored - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--sponsored-id ` — Account that will be sponsored ## `stellar tx new bump-sequence` @@ -1798,26 +1618,25 @@ Bump sequence number to invalidate older transactions ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--bump-to ` — Sequence number to bump to - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--bump-to ` — Sequence number to bump to ## `stellar tx new change-trust` @@ -1827,29 +1646,28 @@ Create, update, or delete a trustline ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--line ` -* `--limit ` — Limit for the trust line, 0 to remove the trust line - - Default value: `9223372036854775807` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line + Default value: `9223372036854775807` ## `stellar tx new claim-claimable-balance` @@ -1859,26 +1677,25 @@ Claim a claimable balance by its balance ID ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx new clawback` @@ -1888,28 +1705,27 @@ Clawback an asset from an account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--from ` — Account to clawback assets from, e.g. `GBX...` +- `--asset ` — Asset to clawback +- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx new clawback-claimable-balance` @@ -1919,26 +1735,25 @@ Clawback a claimable balance by its balance ID ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx new create-account` @@ -1948,29 +1763,28 @@ Create and fund a new account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--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-claimable-balance` @@ -1980,34 +1794,33 @@ Create a claimable balance that can be claimed by specified accounts ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--asset ` — Asset to be held in the ClaimableBalanceEntry - Default value: `native` -* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - - Examples: +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--asset ` — Asset to be held in the ClaimableBalanceEntry - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + Default value: `native` +- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + Examples: + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx new create-passive-sell-offer` @@ -2017,29 +1830,28 @@ Create a passive sell offer on the Stellar DEX ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx new end-sponsoring-future-reserves` @@ -2049,25 +1861,24 @@ End sponsoring future reserves ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx new liquidity-pool-deposit` @@ -2077,34 +1888,34 @@ Deposit assets into a liquidity pool ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--liquidity-pool-id ` — Liquidity pool ID to deposit to -* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` -* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--liquidity-pool-id ` — Liquidity pool ID to deposit to +- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` +- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` ## `stellar tx new liquidity-pool-withdraw` @@ -2114,29 +1925,28 @@ Withdraw assets from a liquidity pool ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--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 ## `stellar tx new manage-buy-offer` @@ -2146,32 +1956,31 @@ Create, update, or delete a buy offer ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx new manage-data` @@ -2181,27 +1990,26 @@ Set, modify, or delete account data entries ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx new manage-sell-offer` @@ -2211,32 +2019,31 @@ Create, update, or delete a sell offer ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx new path-payment-strict-send` @@ -2246,31 +2053,30 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new path-payment-strict-receive` @@ -2280,31 +2086,30 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new payment` @@ -2314,30 +2119,30 @@ Send asset to destination account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--destination ` — Account to send to, e.g. `GBX...` -* `--asset ` — Asset to send, default native, e.i. XLM - Default value: `native` -* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--destination ` — Account to send to, e.g. `GBX...` +- `--asset ` — Asset to send, default native, e.i. XLM + Default value: `native` +- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx new revoke-sponsorship` @@ -2347,32 +2152,31 @@ Revoke sponsorship of a ledger entry or signer ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account-id ` — Account ID (required for all sponsorship types) -* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -* `--data-name ` — Data name for data entry sponsorship -* `--offer-id ` — Offer ID for offer sponsorship -* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -* `--signer-key ` — Signer key for signer sponsorship - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account-id ` — Account ID (required for all sponsorship types) +- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +- `--data-name ` — Data name for data entry sponsorship +- `--offer-id ` — Offer ID for offer sponsorship +- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx new set-options` @@ -2382,41 +2186,40 @@ Set account options like flags, signers, and home domain ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--inflation-dest ` — Account of the inflation destination -* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -* `--signer ` — Add, update, or remove a signer from an account -* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -* `--clear-required` -* `--clear-revocable` -* `--clear-immutable` -* `--clear-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--inflation-dest ` — Account of the inflation destination +- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +- `--signer ` — Add, update, or remove a signer from an account +- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +- `--clear-required` +- `--clear-revocable` +- `--clear-immutable` +- `--clear-clawback-enabled` ## `stellar tx new set-trustline-flags` @@ -2426,33 +2229,32 @@ Configure authorization and trustline flags for an asset ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -* `--asset ` — Asset to set trustline flags for -* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -* `--clear-authorize` -* `--clear-authorize-to-maintain-liabilities` -* `--clear-trustline-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +- `--asset ` — Asset to set trustline flags for +- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +- `--clear-authorize` +- `--clear-authorize-to-maintain-liabilities` +- `--clear-trustline-clawback-enabled` ## `stellar tx operation` @@ -2464,9 +2266,7 @@ Manipulate the operations in a transaction, including adding new operations ###### **Subcommands:** -* `add` — Add Operation to a transaction - - +- `add` — Add Operation to a transaction ## `stellar tx operation add` @@ -2476,30 +2276,28 @@ Add Operation to a transaction ###### **Subcommands:** -* `account-merge` — Transfer XLM balance to another account and remove source account -* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -* `bump-sequence` — Bump sequence number to invalidate older transactions -* `change-trust` — Create, update, or delete a trustline -* `claim-claimable-balance` — Claim a claimable balance by its balance ID -* `clawback` — Clawback an asset from an account -* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -* `create-account` — Create and fund a new account -* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -* `end-sponsoring-future-reserves` — End sponsoring future reserves -* `liquidity-pool-deposit` — Deposit assets into a liquidity pool -* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -* `manage-buy-offer` — Create, update, or delete a buy offer -* `manage-data` — Set, modify, or delete account data entries -* `manage-sell-offer` — Create, update, or delete a sell offer -* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -* `payment` — Send asset to destination account -* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -* `set-options` — Set account options like flags, signers, and home domain -* `set-trustline-flags` — Configure authorization and trustline flags for an asset - - +- `account-merge` — Transfer XLM balance to another account and remove source account +- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +- `bump-sequence` — Bump sequence number to invalidate older transactions +- `change-trust` — Create, update, or delete a trustline +- `claim-claimable-balance` — Claim a claimable balance by its balance ID +- `clawback` — Clawback an asset from an account +- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +- `create-account` — Create and fund a new account +- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +- `end-sponsoring-future-reserves` — End sponsoring future reserves +- `liquidity-pool-deposit` — Deposit assets into a liquidity pool +- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +- `manage-buy-offer` — Create, update, or delete a buy offer +- `manage-data` — Set, modify, or delete account data entries +- `manage-sell-offer` — Create, update, or delete a sell offer +- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +- `payment` — Send asset to destination account +- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +- `set-options` — Set account options like flags, signers, and home domain +- `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx operation add account-merge` @@ -2509,31 +2307,30 @@ Transfer XLM balance to another account and remove source account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx operation add begin-sponsoring-future-reserves` @@ -2543,31 +2340,30 @@ Begin sponsoring future reserves for another account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--sponsored-id ` — Account that will be sponsored - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--sponsored-id ` — Account that will be sponsored ## `stellar tx operation add bump-sequence` @@ -2577,31 +2373,30 @@ Bump sequence number to invalidate older transactions ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--bump-to ` — Sequence number to bump to - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--bump-to ` — Sequence number to bump to ## `stellar tx operation add change-trust` @@ -2611,34 +2406,33 @@ Create, update, or delete a trustline ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--line ` -* `--limit ` — Limit for the trust line, 0 to remove the trust line - - Default value: `9223372036854775807` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line + Default value: `9223372036854775807` ## `stellar tx operation add claim-claimable-balance` @@ -2648,31 +2442,30 @@ Claim a claimable balance by its balance ID ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx operation add clawback` @@ -2682,33 +2475,32 @@ Clawback an asset from an account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--from ` — Account to clawback assets from, e.g. `GBX...` +- `--asset ` — Asset to clawback +- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx operation add clawback-claimable-balance` @@ -2718,31 +2510,30 @@ Clawback a claimable balance by its balance ID ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx operation add create-account` @@ -2752,34 +2543,33 @@ Create and fund a new account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--destination ` — Account Id to create, e.g. `GBX...` +- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM + Default value: `10_000_000` ## `stellar tx operation add create-claimable-balance` @@ -2789,39 +2579,38 @@ Create a claimable balance that can be claimed by specified accounts ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--asset ` — Asset to be held in the ClaimableBalanceEntry - - Default value: `native` -* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - Examples: +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--asset ` — Asset to be held in the ClaimableBalanceEntry - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + Default value: `native` +- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + Examples: + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx operation add create-passive-sell-offer` @@ -2831,34 +2620,33 @@ Create a passive sell offer on the Stellar DEX ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx operation add end-sponsoring-future-reserves` @@ -2868,30 +2656,29 @@ End sponsoring future reserves ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx operation add liquidity-pool-deposit` @@ -2901,39 +2688,39 @@ Deposit assets into a liquidity pool ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--liquidity-pool-id ` — Liquidity pool ID to deposit to -* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` -* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--liquidity-pool-id ` — Liquidity pool ID to deposit to +- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` +- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` ## `stellar tx operation add liquidity-pool-withdraw` @@ -2943,34 +2730,33 @@ Withdraw assets from a liquidity pool ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--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 ## `stellar tx operation add manage-buy-offer` @@ -2980,37 +2766,36 @@ Create, update, or delete a buy offer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx operation add manage-data` @@ -3020,32 +2805,31 @@ Set, modify, or delete account data entries ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx operation add manage-sell-offer` @@ -3055,37 +2839,36 @@ Create, update, or delete a sell offer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx operation add path-payment-strict-receive` @@ -3095,36 +2878,35 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add path-payment-strict-send` @@ -3134,36 +2916,35 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add payment` @@ -3173,35 +2954,35 @@ Send asset to destination account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--destination ` — Account to send to, e.g. `GBX...` -* `--asset ` — Asset to send, default native, e.i. XLM - Default value: `native` -* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--destination ` — Account to send to, e.g. `GBX...` +- `--asset ` — Asset to send, default native, e.i. XLM + Default value: `native` +- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx operation add revoke-sponsorship` @@ -3211,37 +2992,36 @@ Revoke sponsorship of a ledger entry or signer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account-id ` — Account ID (required for all sponsorship types) -* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -* `--data-name ` — Data name for data entry sponsorship -* `--offer-id ` — Offer ID for offer sponsorship -* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -* `--signer-key ` — Signer key for signer sponsorship - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account-id ` — Account ID (required for all sponsorship types) +- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +- `--data-name ` — Data name for data entry sponsorship +- `--offer-id ` — Offer ID for offer sponsorship +- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx operation add set-options` @@ -3251,46 +3031,45 @@ Set account options like flags, signers, and home domain ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--inflation-dest ` — Account of the inflation destination -* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -* `--signer ` — Add, update, or remove a signer from an account -* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -* `--clear-required` -* `--clear-revocable` -* `--clear-immutable` -* `--clear-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--inflation-dest ` — Account of the inflation destination +- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +- `--signer ` — Add, update, or remove a signer from an account +- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +- `--clear-required` +- `--clear-revocable` +- `--clear-immutable` +- `--clear-clawback-enabled` ## `stellar tx operation add set-trustline-flags` @@ -3300,38 +3079,37 @@ Configure authorization and trustline flags for an asset ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -* `--asset ` — Asset to set trustline flags for -* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -* `--clear-authorize` -* `--clear-authorize-to-maintain-liabilities` -* `--clear-trustline-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +- `--asset ` — Asset to set trustline flags for +- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +- `--clear-authorize` +- `--clear-authorize-to-maintain-liabilities` +- `--clear-trustline-clawback-enabled` ## `stellar tx send` @@ -3341,18 +3119,16 @@ Send a transaction envelope to the network ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar tx sign` @@ -3362,22 +3138,20 @@ Sign a transaction envelope appending the signature to the envelope ###### **Arguments:** -* `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty ###### **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 -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar tx simulate` @@ -3387,58 +3161,49 @@ Simulate a transaction envelope from stdin ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -**Usage:** `stellar tx fetch [OPTIONS] - fetch ` +**Usage:** `stellar tx fetch [OPTIONS] fetch ` ###### **Subcommands:** -* `result` — Fetch the transaction result -* `meta` — Fetch the transaction meta -* `fee` — Fetch the transaction fee information +- `result` — Fetch the transaction result +- `meta` — Fetch the transaction meta +- `fee` — Fetch the transaction fee information ###### **Options:** -* `--hash ` — Hash of transaction to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--hash ` — Hash of transaction to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar tx fetch result` @@ -3448,25 +3213,19 @@ Fetch the transaction result ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--hash ` — Transaction hash to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar tx fetch meta` @@ -3476,25 +3235,19 @@ Fetch the transaction meta ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--hash ` — Transaction hash to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar tx fetch fee` @@ -3504,25 +3257,19 @@ Fetch the transaction fee information ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Output format for fee command +- `--hash ` — Transaction hash to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Output format for fee command Default value: `table` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `table`: - Formatted in a table comparing fee types - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `table`: Formatted in a table comparing fee types ## `stellar tx decode` @@ -3532,25 +3279,22 @@ Decode a transaction envelope from XDR to JSON ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `single-base64` Possible values: `single-base64`, `single` -* `--output ` +- `--output ` Default value: `json` Possible values: `json`, `json-formatted` - - - ## `stellar tx encode` Encode a transaction envelope from JSON to XDR @@ -3559,25 +3303,22 @@ Encode a transaction envelope from JSON to XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `json` Possible values: `json` -* `--output ` +- `--output ` Default value: `single-base64` Possible values: `single-base64`, `single` - - - ## `stellar xdr` Decode and encode XDR @@ -3586,25 +3327,22 @@ Decode and encode XDR ###### **Subcommands:** -* `types` — View information about types -* `guess` — Guess the XDR type -* `decode` — Decode XDR -* `encode` — Encode XDR -* `compare` — Compare two XDR values with each other -* `generate` — Generate XDR values -* `version` — Print version information +- `types` — View information about types +- `guess` — Guess the XDR type +- `decode` — Decode XDR +- `encode` — Encode XDR +- `compare` — Compare two XDR values with each other +- `generate` — Generate XDR values +- `version` — Print version information ###### **Arguments:** -* `` — Channel of XDR to operate on +- `` — Channel of XDR to operate on Default value: `+curr` Possible values: `+curr`, `+next` - - - ## `stellar xdr types` View information about types @@ -3613,11 +3351,9 @@ View information about types ###### **Subcommands:** -* `list` — -* `schema` — -* `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory - - +- `list` — +- `schema` — +- `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory ## `stellar xdr types list` @@ -3625,31 +3361,25 @@ View information about types ###### **Options:** -* `--output ` +- `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` - - - ## `stellar xdr types schema` **Usage:** `stellar xdr types schema [OPTIONS] --type ` ###### **Options:** -* `--type ` — XDR type to decode -* `--output ` +- `--type ` — XDR type to decode +- `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` - - - ## `stellar xdr types schema-files` Generate JSON schema files for the XDR types, writing a file for each type to the out directory @@ -3658,16 +3388,13 @@ Generate JSON schema files for the XDR types, writing a file for each type to th ###### **Options:** -* `--out-dir ` -* `--output ` +- `--out-dir ` +- `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` - - - ## `stellar xdr guess` Guess the XDR type. @@ -3678,28 +3405,26 @@ Prints a list of types that the XDR values can be decoded into. ###### **Arguments:** -* `` — XDR or file containing XDR to decode, or stdin if empty +- `` — XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -* `--output ` +- `--output ` Default value: `list` Possible values: `list` -* `--certainty ` — Certainty as an arbitrary value +- `--certainty ` — Certainty as an arbitrary value Default value: `2` - - ## `stellar xdr decode` Decode XDR @@ -3708,26 +3433,23 @@ Decode XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--type ` — XDR type to decode -* `--input ` +- `--type ` — XDR type to decode +- `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -* `--output ` +- `--output ` Default value: `json` Possible values: `json`, `json-formatted`, `text`, `rust-debug`, `rust-debug-formatted` - - - ## `stellar xdr encode` Encode XDR @@ -3736,26 +3458,23 @@ Encode XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--type ` — XDR type to encode -* `--input ` +- `--type ` — XDR type to encode +- `--input ` Default value: `json` Possible values: `json` -* `--output ` +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream` - - - ## `stellar xdr compare` Compare two XDR values with each other @@ -3766,21 +3485,18 @@ Outputs: `-1` when the left XDR value is less than the right XDR value, `0` when ###### **Arguments:** -* `` — XDR file to decode and compare with the right value -* `` — XDR file to decode and compare with the left value +- `` — XDR file to decode and compare with the right value +- `` — XDR file to decode and compare with the left value ###### **Options:** -* `--type ` — XDR type of both inputs -* `--input ` +- `--type ` — XDR type of both inputs +- `--input ` Default value: `single-base64` Possible values: `single`, `single-base64` - - - ## `stellar xdr generate` Generate XDR values @@ -3789,10 +3505,8 @@ Generate XDR values ###### **Subcommands:** -* `default` — Generate default XDR values -* `arbitrary` — Generate arbitrary XDR values - - +- `default` — Generate default XDR values +- `arbitrary` — Generate arbitrary XDR values ## `stellar xdr generate default` @@ -3802,16 +3516,13 @@ Generate default XDR values ###### **Options:** -* `--type ` — XDR type to generate -* `--output ` +- `--type ` — XDR type to generate +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` - - - ## `stellar xdr generate arbitrary` Generate arbitrary XDR values @@ -3820,24 +3531,19 @@ Generate arbitrary XDR values ###### **Options:** -* `--type ` — XDR type to generate -* `--output ` +- `--type ` — XDR type to generate +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` - - - ## `stellar xdr version` Print version information **Usage:** `stellar xdr version` - - ## `stellar completion` Print shell completion code for the specified shell @@ -3848,18 +3554,14 @@ To enable autocomplete in the current bash shell, run: `source <(stellar complet To enable autocomplete permanently, run: `echo "source <(stellar completion --shell bash)" >> ~/.bashrc` - **Usage:** `stellar completion --shell ` ###### **Options:** -* `--shell ` — The shell type +- `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` - - - ## `stellar cache` Cache for transactions and contract specs @@ -3868,11 +3570,9 @@ Cache for transactions and contract specs ###### **Subcommands:** -* `clean` — Delete the cache -* `path` — Show the location of the cache -* `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) - - +- `clean` — Delete the cache +- `path` — Show the location of the cache +- `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) ## `stellar cache clean` @@ -3880,16 +3580,12 @@ Delete the cache **Usage:** `stellar cache clean` - - ## `stellar cache path` Show the location of the cache **Usage:** `stellar cache path` - - ## `stellar cache actionlog` Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) @@ -3898,10 +3594,8 @@ Access details about cached actions like transactions, and simulations. (Experim ###### **Subcommands:** -* `ls` — List cached actions (transactions, simulations) -* `read` — Read cached action - - +- `ls` — List cached actions (transactions, simulations) +- `read` — Read cached action ## `stellar cache actionlog ls` @@ -3911,11 +3605,9 @@ List cached actions (transactions, simulations) ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-l`, `--long` - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` ## `stellar cache actionlog read` @@ -3925,9 +3617,7 @@ Read cached action ###### **Options:** -* `--id ` — ID of the cache entry - - +- `--id ` — ID of the cache entry ## `stellar version` @@ -3937,10 +3627,8 @@ Print version information ###### **Options:** -* `--only-version` — Print only the version -* `--only-version-major` — Print only the major version - - +- `--only-version` — Print only the version +- `--only-version-major` — Print only the major version ## `stellar plugin` @@ -3950,10 +3638,8 @@ The subcommand for CLI plugins ###### **Subcommands:** -* `search` — Search for CLI plugins using GitHub -* `ls` — List installed plugins - - +- `search` — Search for CLI plugins using GitHub +- `ls` — List installed plugins ## `stellar plugin search` @@ -3961,16 +3647,12 @@ Search for CLI plugins using GitHub **Usage:** `stellar plugin search` - - ## `stellar plugin ls` List installed plugins **Usage:** `stellar plugin ls` - - ## `stellar ledger` Fetch ledger information @@ -3979,11 +3661,9 @@ Fetch ledger information ###### **Subcommands:** -* `entry` — Work with ledger entries -* `latest` — Get the latest ledger sequence and information from the network -* `fetch` — - - +- `entry` — Work with ledger entries +- `latest` — Get the latest ledger sequence and information from the network +- `fetch` — ## `stellar ledger entry` @@ -3993,9 +3673,7 @@ Work with ledger entries ###### **Subcommands:** -* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) - - +- `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) ## `stellar ledger entry fetch` @@ -4005,17 +3683,15 @@ Fetch ledger entries. This command supports all types of ledger entries supporte ###### **Subcommands:** -* `account` — Fetch account entry by public key or alias -* `contract-data` — Fetch contract ledger entry by address or alias and storage key -* `config` — Fetch the current network config by `ConfigSettingId`. All config settings are returned if no id is provided -* `claimable-balance` — Fetch a claimable balance ledger entry by id -* `liquidity-pool` — Fetch a liquidity pool ledger entry by id -* `contract-code` — Fetch WASM bytecode by hash -* `trustline` — Fetch a trustline by account and asset -* `data` — Fetch key-value data entries attached to an account (see manageDataOp) -* `offer` — Fetch an offer by account and offer id - - +- `account` — Fetch account entry by public key or alias +- `contract-data` — Fetch contract ledger entry by address or alias and storage key +- `config` — Fetch the current network config by `ConfigSettingId`. All config settings are returned if no id is provided +- `claimable-balance` — Fetch a claimable balance ledger entry by id +- `liquidity-pool` — Fetch a liquidity pool ledger entry by id +- `contract-code` — Fetch WASM bytecode by hash +- `trustline` — Fetch a trustline by account and asset +- `data` — Fetch key-value data entries attached to an account (see manageDataOp) +- `offer` — Fetch an offer by account and offer id ## `stellar ledger entry fetch account` @@ -4025,32 +3701,27 @@ Fetch account entry by public key or alias ###### **Arguments:** -* `` — Account alias or public key to lookup, default is test identity +- `` — Account alias or public key to lookup, default is test identity ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--hide-account` — Hide the account ledger entry from the output -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--hide-account` — Hide the account ledger entry from the output +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar ledger entry fetch contract-data` @@ -4060,42 +3731,35 @@ Fetch contract ledger entry by address or alias and storage key ###### **Arguments:** -* `` — Contract alias or address to fetch +- `` — Contract alias or address to fetch ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) -* `--durability ` — Storage entry durability +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) - + - `persistent`: Persistent + - `temporary`: Temporary +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) ## `stellar ledger entry fetch config` @@ -4105,47 +3769,24 @@ Fetch the current network config by `ConfigSettingId`. All config settings are r ###### **Arguments:** -* `` — Valid config setting IDs (Config Setting ID => Name): - 0 => ContractMaxSizeBytes - 1 => ContractComputeV0 - 2 => ContractLedgerCostV0 - 3 => ContractHistoricalDataV0 - 4 => ContractEventsV0 - 5 => ContractBandwidthV0 - 6 => ContractCostParamsCpuInstructions - 7 => ContractCostParamsMemoryBytes - 8 => ContractDataKeySizeBytes - 9 => ContractDataEntrySizeBytes - 10 => StateArchival - 11 => ContractExecutionLanes - 12 => LiveSorobanStateSizeWindow - 13 => EvictionIterator - 14 => ContractParallelComputeV0 - 15 => ContractLedgerCostExtV0 - 16 => ScpTiming - -###### **Options:** - -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output - - Default value: `json` +- `` — Valid config setting IDs (Config Setting ID => Name): 0 => ContractMaxSizeBytes 1 => ContractComputeV0 2 => ContractLedgerCostV0 3 => ContractHistoricalDataV0 4 => ContractEventsV0 5 => ContractBandwidthV0 6 => ContractCostParamsCpuInstructions 7 => ContractCostParamsMemoryBytes 8 => ContractDataKeySizeBytes 9 => ContractDataEntrySizeBytes 10 => StateArchival 11 => ContractExecutionLanes 12 => LiveSorobanStateSizeWindow 13 => EvictionIterator 14 => ContractParallelComputeV0 15 => ContractLedgerCostExtV0 16 => ScpTiming - Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) +###### **Options:** +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output + Default value: `json` + Possible values: + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar ledger entry fetch claimable-balance` @@ -4155,30 +3796,24 @@ Fetch a claimable balance ledger entry by id ###### **Arguments:** -* `` — Claimable Balance Ids to fetch an entry for +- `` — Claimable Balance Ids to fetch an entry for ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar ledger entry fetch liquidity-pool` @@ -4188,30 +3823,24 @@ Fetch a liquidity pool ledger entry by id ###### **Arguments:** -* `` — Liquidity pool ids +- `` — Liquidity pool ids ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar ledger entry fetch contract-code` @@ -4221,30 +3850,24 @@ Fetch WASM bytecode by hash ###### **Arguments:** -* `` — Get WASM bytecode by hash +- `` — Get WASM bytecode by hash ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar ledger entry fetch trustline` @@ -4254,29 +3877,24 @@ Fetch a trustline by account and asset ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--account ` — Account alias or public key to lookup, default is test identity -* `--asset ` — Assets to get trustline info for -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--account ` — Account alias or public key to lookup, default is test identity +- `--asset ` — Assets to get trustline info for +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar ledger entry fetch data` @@ -4286,29 +3904,24 @@ Fetch key-value data entries attached to an account (see manageDataOp) ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--account ` — Account alias or public key to lookup, default is test identity -* `--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 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--account ` — Account alias or public key to lookup, default is test identity +- `--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 ## `stellar ledger entry fetch offer` @@ -4318,29 +3931,24 @@ Fetch an offer by account and offer id ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--account ` — Account alias or public key to lookup, default is test identity -* `--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 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--account ` — Account alias or public key to lookup, default is test identity +- `--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 ## `stellar ledger latest` @@ -4350,24 +3958,18 @@ Get the latest ledger sequence and information from the network ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ## `stellar ledger fetch` @@ -4375,41 +3977,34 @@ Get the latest ledger sequence and information from the network ###### **Arguments:** -* `` — Ledger Sequence to start fetch (inclusive) +- `` — Ledger Sequence to start fetch (inclusive) ###### **Options:** -* `--limit ` — Number of ledgers to fetch +- `--limit ` — Number of ledgers to fetch Default value: `1` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request -* `--xdr-format ` — Format of the xdr in the output +- `--xdr-format ` — Format of the xdr in the output Default value: `json` Possible values: - - `json`: - XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields - - `xdr`: - XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields - - - + - `json`: XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields + - `xdr`: XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields ## `stellar fee-stats` @@ -4419,22 +4014,15 @@ Fetch network feestats ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request From 91fd142956d65a255d97519c26f3cc96e3effba1 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 13 Oct 2025 16:56:39 -0400 Subject: [PATCH 64/76] Update ContractCode doc comment --- cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 480c8f6b21..01871ff9d6 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -25,7 +25,7 @@ pub enum Cmd { ClaimableBalance(claimable_balance::Cmd), ///Fetch a liquidity pool ledger entry by id LiquidityPool(liquidity_pool::Cmd), - /// Fetch WASM bytecode by hash + /// Fetch a Contract's WASM bytecode by WASM hash ContractCode(contract_code::Cmd), /// Fetch a trustline by account and asset Trustline(trustline::Cmd), From 20aea626c3717ca8c0b43be2a4e3bc5c326a39e9 Mon Sep 17 00:00:00 2001 From: Elizabeth Engelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 10:11:16 -0400 Subject: [PATCH 65/76] Update account doc comments Co-authored-by: Leigh <351529+leighmcculloch@users.noreply.github.com> --- FULL_HELP_DOCS.md | 4026 +++++++++-------- .../commands/ledger/entry/fetch/account.rs | 2 +- .../ledger/entry/fetch/account_data.rs | 2 +- .../src/commands/ledger/entry/fetch/offer.rs | 2 +- .../commands/ledger/entry/fetch/trustline.rs | 2 +- 5 files changed, 2223 insertions(+), 1811 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 7e3bf33b84..28c731aacb 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -38,38 +38,41 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world + **Usage:** `stellar [OPTIONS] ` ###### **Subcommands:** -- `contract` — Tools for smart contract developers -- `doctor` — Diagnose and troubleshoot CLI and network issues -- `events` — Watch the network for contract events -- `env` — Prints the environment variables -- `keys` — Create and manage identities including keys and addresses -- `network` — Configure connection to networks -- `container` — Start local networks in containers -- `config` — Manage cli configuration -- `snapshot` — Download a snapshot of a ledger from an archive -- `tx` — Sign, Simulate, and Send transactions -- `xdr` — Decode and encode XDR -- `completion` — Print shell completion code for the specified shell -- `cache` — Cache for transactions and contract specs -- `version` — Print version information -- `plugin` — The subcommand for CLI plugins -- `ledger` — Fetch ledger information -- `fee-stats` — Fetch network feestats - -###### **Options:** - -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` -- `-q`, `--quiet` — Do not write logs to stderr including `INFO` -- `-v`, `--verbose` — Log DEBUG events -- `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events -- `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` -- `--no-cache` — Do not cache your simulations and transactions +* `contract` — Tools for smart contract developers +* `doctor` — Diagnose and troubleshoot CLI and network issues +* `events` — Watch the network for contract events +* `env` — Prints the environment variables +* `keys` — Create and manage identities including keys and addresses +* `network` — Configure connection to networks +* `container` — Start local networks in containers +* `config` — Manage cli configuration +* `snapshot` — Download a snapshot of a ledger from an archive +* `tx` — Sign, Simulate, and Send transactions +* `xdr` — Decode and encode XDR +* `completion` — Print shell completion code for the specified shell +* `cache` — Cache for transactions and contract specs +* `version` — Print version information +* `plugin` — The subcommand for CLI plugins +* `ledger` — Fetch ledger information +* `fee-stats` — Fetch network feestats + +###### **Options:** + +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` +* `-q`, `--quiet` — Do not write logs to stderr including `INFO` +* `-v`, `--verbose` — Log DEBUG events +* `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events +* `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` +* `--no-cache` — Do not cache your simulations and transactions + + ## `stellar contract` @@ -79,23 +82,25 @@ Tools for smart contract developers ###### **Subcommands:** -- `asset` — Utilities to deploy a Stellar Asset Contract or get its id -- `alias` — Utilities to manage contract aliases -- `bindings` — Generate code client bindings for a contract -- `build` — Build a contract from source -- `extend` — Extend the time to live ledger of a contract-data ledger entry -- `deploy` — Deploy a wasm contract -- `fetch` — Fetch a contract's Wasm binary -- `id` — Generate the contract id for a given contract or asset -- `info` — Access info about contracts -- `init` — Initialize a Soroban contract project -- `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc -- `upload` — Install a WASM file to the ledger without creating a contract instance -- `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance -- `invoke` — Invoke a contract function -- `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file -- `read` — Print the current value of a contract-data ledger entry -- `restore` — Restore an evicted value for a contract-data legder entry +* `asset` — Utilities to deploy a Stellar Asset Contract or get its id +* `alias` — Utilities to manage contract aliases +* `bindings` — Generate code client bindings for a contract +* `build` — Build a contract from source +* `extend` — Extend the time to live ledger of a contract-data ledger entry +* `deploy` — Deploy a wasm contract +* `fetch` — Fetch a contract's Wasm binary +* `id` — Generate the contract id for a given contract or asset +* `info` — Access info about contracts +* `init` — Initialize a Soroban contract project +* `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc +* `upload` — Install a WASM file to the ledger without creating a contract instance +* `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance +* `invoke` — Invoke a contract function +* `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file +* `read` — Print the current value of a contract-data ledger entry +* `restore` — Restore an evicted value for a contract-data legder entry + + ## `stellar contract asset` @@ -105,8 +110,10 @@ Utilities to deploy a Stellar Asset Contract or get its id ###### **Subcommands:** -- `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead -- `deploy` — Deploy builtin Soroban Asset Contract +* `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead +* `deploy` — Deploy builtin Soroban Asset Contract + + ## `stellar contract asset id` @@ -116,13 +123,15 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract asset deploy` @@ -132,26 +141,27 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract alias` @@ -161,10 +171,12 @@ Utilities to manage contract aliases ###### **Subcommands:** -- `remove` — Remove contract alias -- `add` — Add contract alias -- `show` — Show the contract id associated with a given alias -- `ls` — List all aliases +* `remove` — Remove contract alias +* `add` — Add contract alias +* `show` — Show the contract id associated with a given alias +* `ls` — List all aliases + + ## `stellar contract alias remove` @@ -174,16 +186,18 @@ Remove contract alias ###### **Arguments:** -- `` — The contract alias that will be removed +* `` — The contract alias that will be removed ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract alias add` @@ -193,18 +207,20 @@ Add contract alias ###### **Arguments:** -- `` — The contract alias that will be used +* `` — The contract alias that will be used ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--overwrite` — Overwrite the contract alias if it already exists -- `--id ` — The contract id that will be associated with the alias +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--overwrite` — Overwrite the contract alias if it already exists +* `--id ` — The contract id that will be associated with the alias + + ## `stellar contract alias show` @@ -214,16 +230,18 @@ Show the contract id associated with a given alias ###### **Arguments:** -- `` — The contract alias that will be displayed +* `` — The contract alias that will be displayed ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract alias ls` @@ -233,8 +251,10 @@ List all aliases ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract bindings` @@ -244,14 +264,16 @@ Generate code client bindings for a contract ###### **Subcommands:** -- `json` — Generate Json Bindings -- `rust` — Generate Rust bindings -- `typescript` — Generate a TypeScript / JavaScript package -- `python` — Generate Python bindings -- `java` — Generate Java bindings -- `flutter` — Generate Flutter bindings -- `swift` — Generate Swift bindings -- `php` — Generate PHP bindings +* `json` — Generate Json Bindings +* `rust` — Generate Rust bindings +* `typescript` — Generate a TypeScript / JavaScript package +* `python` — Generate Python bindings +* `java` — Generate Java bindings +* `flutter` — Generate Flutter bindings +* `swift` — Generate Swift bindings +* `php` — Generate PHP bindings + + ## `stellar contract bindings json` @@ -261,7 +283,9 @@ Generate Json Bindings ###### **Options:** -- `--wasm ` — Path to wasm binary +* `--wasm ` — Path to wasm binary + + ## `stellar contract bindings rust` @@ -271,7 +295,9 @@ Generate Rust bindings ###### **Options:** -- `--wasm ` — Path to wasm binary +* `--wasm ` — Path to wasm binary + + ## `stellar contract bindings typescript` @@ -281,17 +307,19 @@ Generate a TypeScript / JavaScript package ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output-dir ` — Where to place generated project -- `--overwrite` — Whether to overwrite output directory if it already exists +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output-dir ` — Where to place generated project +* `--overwrite` — Whether to overwrite output directory if it already exists + + ## `stellar contract bindings python` @@ -299,30 +327,40 @@ Generate Python bindings **Usage:** `stellar contract bindings python` + + ## `stellar contract bindings java` Generate Java bindings **Usage:** `stellar contract bindings java` + + ## `stellar contract bindings flutter` Generate Flutter bindings **Usage:** `stellar contract bindings flutter` + + ## `stellar contract bindings swift` Generate Swift bindings **Usage:** `stellar contract bindings swift` + + ## `stellar contract bindings php` Generate PHP bindings **Usage:** `stellar contract bindings php` + + ## `stellar contract build` Build a contract from source @@ -337,27 +375,26 @@ To view the commands that will be executed, without executing them, use the --pr ###### **Options:** -- `--manifest-path ` — Path to Cargo.toml -- `--package ` — Package to build - - If omitted, all packages that build for crate-type cdylib are built. +* `--manifest-path ` — Path to Cargo.toml +* `--package ` — Package to build -- `--profile ` — Build with the specified profile + If omitted, all packages that build for crate-type cdylib are built. +* `--profile ` — Build with the specified profile Default value: `release` +* `--features ` — Build with the list of features activated, space or comma separated +* `--all-features` — Build with the all features activated +* `--no-default-features` — Build with the default feature not activated +* `--out-dir ` — Directory to copy wasm files to -- `--features ` — Build with the list of features activated, space or comma separated -- `--all-features` — Build with the all features activated -- `--no-default-features` — Build with the default feature not activated -- `--out-dir ` — Directory to copy wasm files to + If provided, wasm files can be found in the cargo target directory, and the specified directory. - If provided, wasm files can be found in the cargo target directory, and the specified directory. + If ommitted, wasm files are written only to the cargo target directory. +* `--print-commands-only` — Print commands to build without executing them +* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +* `--optimize` — Optimize the generated wasm - If ommitted, wasm files are written only to the cargo target directory. -- `--print-commands-only` — Print commands to build without executing them -- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) -- `--optimize` — Optimize the generated wasm ## `stellar contract extend` @@ -369,39 +406,42 @@ If no keys are specified the contract itself is extended. ###### **Options:** -- `--ledgers-to-extend ` — Number of ledgers to extend the entries -- `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--ledgers-to-extend ` — Number of ledgers to extend the entries +* `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary - -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract deploy` @@ -411,36 +451,36 @@ Deploy a wasm contract ###### **Arguments:** -- `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` +* `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Options:** -- `--wasm ` — WASM file to deploy -- `--wasm-hash ` — Hash of the already installed/deployed WASM file -- `--salt ` — Custom salt 32-byte salt for the token id -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--wasm ` — WASM file to deploy +* `--wasm-hash ` — Hash of the already installed/deployed WASM file +* `--salt ` — Custom salt 32-byte salt for the token id +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` +* `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation + -- `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract fetch` @@ -450,15 +490,17 @@ Fetch a contract's Wasm binary ###### **Options:** -- `--id ` — Contract ID to fetch -- `--wasm-hash ` — Wasm to fetch -- `-o`, `--out-file ` — Where to write output otherwise stdout is used -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--id ` — Contract ID to fetch +* `--wasm-hash ` — Wasm to fetch +* `-o`, `--out-file ` — Where to write output otherwise stdout is used +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar contract id` @@ -468,8 +510,10 @@ Generate the contract id for a given contract or asset ###### **Subcommands:** -- `asset` — Deploy builtin Soroban Asset Contract -- `wasm` — Deploy normal Wasm Contract +* `asset` — Deploy builtin Soroban Asset Contract +* `wasm` — Deploy normal Wasm Contract + + ## `stellar contract id asset` @@ -479,13 +523,15 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract id wasm` @@ -495,18 +541,20 @@ Deploy normal Wasm Contract ###### **Options:** -- `--salt ` — ID of the Soroban contract -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet +* `--salt ` — ID of the Soroban contract +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + + ## `stellar contract info` @@ -516,10 +564,12 @@ Access info about contracts ###### **Subcommands:** -- `interface` — Output the interface of a contract -- `meta` — Output the metadata stored in a contract -- `env-meta` — Output the env required metadata stored in a contract -- `build` — Output the contract build information, if available +* `interface` — Output the interface of a contract +* `meta` — Output the metadata stored in a contract +* `env-meta` — Output the env required metadata stored in a contract +* `build` — Output the contract build information, if available + + ## `stellar contract info interface` @@ -535,24 +585,31 @@ Outputs no data when no data is present in the contract. ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `rust` Possible values: - - `rust`: Rust code output of the contract interface - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `rust`: + Rust code output of the contract interface + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + + + ## `stellar contract info meta` @@ -568,24 +625,31 @@ Outputs no data when no data is present in the contract. ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of the meta info entry - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `text`: + Text output of the meta info entry + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + + + ## `stellar contract info env-meta` @@ -601,24 +665,31 @@ Outputs no data when no data is present in the contract. ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of the meta info entry - - `xdr-base64`: XDR output of the info entry - - `json`: JSON output of the info entry (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the info entry + - `text`: + Text output of the meta info entry + - `xdr-base64`: + XDR output of the info entry + - `json`: + JSON output of the info entry (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the info entry + + + ## `stellar contract info build` @@ -630,15 +701,17 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma ###### **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` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +* `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +* `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar contract init` @@ -650,15 +723,16 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Arguments:** -- `` +* `` ###### **Options:** -- `--name ` — An optional flag to specify a new contract's name. +* `--name ` — An optional flag to specify a new contract's name. Default value: `hello-world` +* `--overwrite` — Overwrite all existing files. + -- `--overwrite` — Overwrite all existing files. ## `stellar contract inspect` @@ -668,18 +742,23 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Options:** -- `--wasm ` — Path to wasm binary -- `--output ` — Output just XDR in base64 +* `--wasm ` — Path to wasm binary +* `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - - `xdr-base64`: XDR of array of contract spec entries - - `xdr-base64-array`: Array of xdr of contract spec entries - - `docs`: Pretty print of contract spec entries + - `xdr-base64`: + XDR of array of contract spec entries + - `xdr-base64-array`: + Array of xdr of contract spec entries + - `docs`: + Pretty print of contract spec entries + +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract upload` @@ -689,29 +768,30 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--wasm ` — Path to wasm binary -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--wasm ` — Path to wasm binary +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` + + ## `stellar contract install` ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance @@ -720,29 +800,30 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--wasm ` — Path to wasm binary -- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--wasm ` — Path to wasm binary +* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts Default value: `false` + + ## `stellar contract invoke` Invoke a contract function @@ -755,38 +836,43 @@ stellar contract invoke ... -- --help ###### **Arguments:** -- `` — Function name as subcommand, then arguments for that function as `--arg-name value` +* `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Options:** -- `--id ` — Contract ID to invoke -- `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--id ` — Contract ID to invoke +* `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--send ` — Whether or not to send a transaction +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--send ` — Whether or not to send a transaction Default value: `default` Possible values: - - `default`: Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result - - `no`: Do not send transaction, return simulation result - - `yes`: Always send transaction + - `default`: + Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result + - `no`: + Do not send transaction, return simulation result + - `yes`: + Always send transaction + + + ## `stellar contract optimize` @@ -796,8 +882,10 @@ stellar contract invoke ... -- --help ###### **Options:** -- `--wasm ` — Path to one or more wasm binaries -- `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) +* `--wasm ` — Path to one or more wasm binaries +* `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) + + ## `stellar contract read` @@ -807,34 +895,41 @@ Print the current value of a contract-data ledger entry ###### **Options:** -- `--output ` — Type of output to generate +* `--output ` — Type of output to generate Default value: `string` Possible values: - - `string`: String - - `json`: Json - - `xdr`: XDR - -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability + - `string`: + String + - `json`: + Json + - `xdr`: + XDR + +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract restore` @@ -846,39 +941,42 @@ If no keys are specificed the contract itself is restored. ###### **Options:** -- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) -- `--wasm ` — Path to Wasm file of contract code to extend -- `--wasm-hash ` — Path to Wasm file of contract code to extend -- `--durability ` — Storage entry durability +* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) +* `--wasm ` — Path to Wasm file of contract code to extend +* `--wasm-hash ` — Path to Wasm file of contract code to extend +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary - -- `--ledgers-to-extend ` — Number of ledgers to extend the entry -- `--ttl-ledger-only` — Only print the new Time To Live ledger -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--ledgers-to-extend ` — Number of ledgers to extend the entry +* `--ttl-ledger-only` — Only print the new Time To Live ledger +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar doctor` @@ -888,8 +986,10 @@ Diagnose and troubleshoot CLI and network issues ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar events` @@ -899,45 +999,47 @@ Watch the network for contract events ###### **Options:** -- `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence -- `--cursor ` — The cursor corresponding to the start of the event range -- `--output ` — Output formatting options for event stream +* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence +* `--cursor ` — The cursor corresponding to the start of the event range +* `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - - `pretty`: Colorful, human-oriented console output - - `plain`: Human-oriented console output without colors - - `json`: JSON formatted console output + - `pretty`: + Colorful, human-oriented console output + - `plain`: + Human-oriented console output without colors + - `json`: + JSON formatted console output -- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) +* `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` +* `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. -- `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. + Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. +* `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. - Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. + **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` -- `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. + **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` - **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` - - **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` - - Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). - -- `--type ` — Specifies which type of contract events to display + Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). +* `--type ` — Specifies which type of contract events to display Default value: `all` Possible values: `all`, `contract`, `system` -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar env` @@ -953,14 +1055,16 @@ If there are no environment variables in use, prints the defaults. ###### **Arguments:** -- `` — Env variable name to get the value of. +* `` — Env variable name to get the value of. - E.g.: $ stellar env STELLAR_ACCOUNT + E.g.: $ stellar env STELLAR_ACCOUNT ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys` @@ -970,14 +1074,16 @@ Create and manage identities including keys and addresses ###### **Subcommands:** -- `add` — Add a new identity (keypair, ledger, OS specific secure store) -- `public-key` — Given an identity return its address (public key) -- `fund` — Fund an identity on a test network -- `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store -- `ls` — List identities -- `rm` — Remove an identity -- `secret` — Output an identity's secret key -- `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it +* `add` — Add a new identity (keypair, ledger, OS specific secure store) +* `public-key` — Given an identity return its address (public key) +* `fund` — Fund an identity on a test network +* `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store +* `ls` — List identities +* `rm` — Remove an identity +* `secret` — Output an identity's secret key +* `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it + + ## `stellar keys add` @@ -987,21 +1093,22 @@ Add a new identity (keypair, ledger, OS specific secure store) ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted -- `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase -- `--secure-store` — Save the new key in your OS's credential secure store. +* `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted +* `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase +* `--secure-store` — Save the new key in your OS's credential secure store. + + On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + This only supports seed phrases for now. +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. - This only supports seed phrases for now. -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. ## `stellar keys public-key` @@ -1013,13 +1120,15 @@ Given an identity return its address (public key) ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys fund` @@ -1029,17 +1138,19 @@ Fund an identity on a test network ###### **Arguments:** -- `` — Name of identity to lookup, default test identity used if not provided +* `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys generate` @@ -1049,28 +1160,28 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store ###### **Arguments:** -- `` — Name of identity +* `` — Name of identity ###### **Options:** -- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -- `-s`, `--as-secret` — Output the generated identity as a secret key -- `--secure-store` — Save the new key in your OS's credential secure store. +* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +* `-s`, `--as-secret` — Output the generated identity as a secret key +* `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--fund` — Fund generated key pair + On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--fund` — Fund generated key pair Default value: `false` +* `--overwrite` — Overwrite existing identity if it already exists + -- `--overwrite` — Overwrite existing identity if it already exists ## `stellar keys ls` @@ -1080,9 +1191,11 @@ List identities ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-l`, `--long` + + ## `stellar keys rm` @@ -1092,12 +1205,14 @@ Remove an identity ###### **Arguments:** -- `` — Identity to remove +* `` — Identity to remove ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys secret` @@ -1107,14 +1222,16 @@ Output an identity's secret key ###### **Arguments:** -- `` — Name of identity to lookup, default is test identity +* `` — Name of identity to lookup, default is test identity ###### **Options:** -- `--phrase` — Output seed phrase instead of private key -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--phrase` — Output seed phrase instead of private key +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar keys use` @@ -1124,12 +1241,14 @@ Set the default identity that will be used on all commands. This allows you to s ###### **Arguments:** -- `` — Set the default network name +* `` — Set the default network name ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network` @@ -1139,13 +1258,15 @@ Configure connection to networks ###### **Subcommands:** -- `add` — Add a new network -- `rm` — Remove a network -- `ls` — List networks -- `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it -- `health` — Fetch the health of the configured RPC -- `info` — Checks the health of the configured RPC -- `settings` — Fetch the network's config settings +* `add` — Add a new network +* `rm` — Remove a network +* `ls` — List networks +* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +* `health` — Fetch the health of the configured RPC +* `info` — Checks the health of the configured RPC +* `settings` — Fetch the network's config settings + + ## `stellar network add` @@ -1155,15 +1276,17 @@ Add a new network ###### **Arguments:** -- `` — Name of network +* `` — Name of network ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network rm` @@ -1173,12 +1296,14 @@ Remove a network ###### **Arguments:** -- `` — Network to remove +* `` — Network to remove ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network ls` @@ -1188,9 +1313,11 @@ List networks ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` — Get more info about the networks +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-l`, `--long` — Get more info about the networks + + ## `stellar network use` @@ -1200,12 +1327,14 @@ Set the default network that will be used on all commands. This allows you to sk ###### **Arguments:** -- `` — Set the default network name +* `` — Set the default network name ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar network health` @@ -1215,20 +1344,26 @@ Fetch the health of the configured RPC ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network health status - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network health status + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + ## `stellar network info` @@ -1238,20 +1373,26 @@ Checks the health of the configured RPC ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + ## `stellar network settings` @@ -1261,21 +1402,27 @@ Fetch the network's config settings ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network +* `--output ` — Format of the output Default value: `json` Possible values: - - `xdr`: XDR (`ConfigUpgradeSet` type) - - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `xdr`: + XDR (`ConfigUpgradeSet` type) + - `json`: + JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `json-formatted`: + JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type + + + ## `stellar container` @@ -1285,9 +1432,11 @@ Start local networks in containers ###### **Subcommands:** -- `logs` — Get logs from a running network container -- `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) -- `stop` — Stop a network container started with `stellar container start` +* `logs` — Get logs from a running network container +* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) +* `stop` — Stop a network container started with `stellar container start` + + ## `stellar container logs` @@ -1297,13 +1446,15 @@ Get logs from a running network container ###### **Arguments:** -- `` — Container to get logs from +* `` — Container to get logs from Default value: `local` ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `stellar container start` @@ -1319,21 +1470,23 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Arguments:** -- `` — Network to start. Default is `local` +* `` — Network to start. Default is `local` Possible values: `local`, `testnet`, `futurenet`, `pubnet` + ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -- `--name ` — Optional argument to specify the container name -- `-l`, `--limits ` — Optional argument to specify the limits for the local network only -- `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `--name ` — Optional argument to specify the container name +* `-l`, `--limits ` — Optional argument to specify the limits for the local network only +* `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping Default value: `8000:8000` +* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +* `--protocol-version ` — Optional argument to specify the protocol version for the local network only + -- `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network -- `--protocol-version ` — Optional argument to specify the protocol version for the local network only ## `stellar container stop` @@ -1343,13 +1496,15 @@ Stop a network container started with `stellar container start` ###### **Arguments:** -- `` — Container to stop +* `` — Container to stop Default value: `local` ###### **Options:** -- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock + + ## `stellar config` @@ -1359,8 +1514,10 @@ Manage cli configuration ###### **Subcommands:** -- `migrate` — Migrate the local configuration to the global directory -- `dir` — Show the global configuration directory +* `migrate` — Migrate the local configuration to the global directory +* `dir` — Show the global configuration directory + + ## `stellar config migrate` @@ -1370,8 +1527,10 @@ Migrate the local configuration to the global directory ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar config dir` @@ -1385,8 +1544,10 @@ The location will depend on how your system is configured. ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar snapshot` @@ -1396,7 +1557,9 @@ Download a snapshot of a ledger from an archive ###### **Subcommands:** -- `create` — Create a ledger snapshot using a history archive +* `create` — Create a ledger snapshot using a history archive + + ## `stellar snapshot create` @@ -1416,24 +1579,25 @@ Any invalid contract id passed as `--address` will be ignored. ###### **Options:** -- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger -- `--address
` — Account or contract address/alias to include in the snapshot -- `--wasm-hash ` — WASM hashes to include in the snapshot -- `--output ` — Format of the out file +* `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger +* `--address
` — Account or contract address/alias to include in the snapshot +* `--wasm-hash ` — WASM hashes to include in the snapshot +* `--output ` — Format of the out file Possible values: `json` -- `--out ` — Out path that the snapshot is written to +* `--out ` — Out path that the snapshot is written to Default value: `snapshot.json` +* `--archive-url ` — Archive URL +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + -- `--archive-url ` — Archive URL -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config ## `stellar tx` @@ -1443,17 +1607,19 @@ Sign, Simulate, and Send transactions ###### **Subcommands:** -- `update` — Update the transaction -- `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order -- `hash` — Calculate the hash of a transaction envelope -- `new` — Create a new transaction -- `operation` — Manipulate the operations in a transaction, including adding new operations -- `send` — Send a transaction envelope to the network -- `sign` — Sign a transaction envelope appending the signature to the envelope -- `simulate` — Simulate a transaction envelope from stdin -- `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -- `decode` — Decode a transaction envelope from XDR to JSON -- `encode` — Encode a transaction envelope from JSON to XDR +* `update` — Update the transaction +* `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order +* `hash` — Calculate the hash of a transaction envelope +* `new` — Create a new transaction +* `operation` — Manipulate the operations in a transaction, including adding new operations +* `send` — Send a transaction envelope to the network +* `sign` — Sign a transaction envelope appending the signature to the envelope +* `simulate` — Simulate a transaction envelope from stdin +* `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned +* `decode` — Decode a transaction envelope from XDR to JSON +* `encode` — Encode a transaction envelope from JSON to XDR + + ## `stellar tx update` @@ -1463,7 +1629,9 @@ Update the transaction ###### **Subcommands:** -- `sequence-number` — Edit the sequence number on a transaction +* `sequence-number` — Edit the sequence number on a transaction + + ## `stellar tx update sequence-number` @@ -1475,7 +1643,9 @@ Edit the sequence number on a transaction ###### **Subcommands:** -- `next` — Fetch the source account's seq-num and increment for the given tx +* `next` — Fetch the source account's seq-num and increment for the given tx + + ## `stellar tx update sequence-number next` @@ -1485,12 +1655,14 @@ Fetch the source account's seq-num and increment for the given tx ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar tx edit` @@ -1506,6 +1678,8 @@ $ stellar tx new manage-data --data-name hello --build-only | stellar tx edit **Usage:** `stellar tx edit` + + ## `stellar tx hash` Calculate the hash of a transaction envelope @@ -1514,14 +1688,16 @@ Calculate the hash of a transaction envelope ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config + + ## `stellar tx new` @@ -1531,28 +1707,30 @@ Create a new transaction ###### **Subcommands:** -- `account-merge` — Transfer XLM balance to another account and remove source account -- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -- `bump-sequence` — Bump sequence number to invalidate older transactions -- `change-trust` — Create, update, or delete a trustline -- `claim-claimable-balance` — Claim a claimable balance by its balance ID -- `clawback` — Clawback an asset from an account -- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -- `create-account` — Create and fund a new account -- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -- `end-sponsoring-future-reserves` — End sponsoring future reserves -- `liquidity-pool-deposit` — Deposit assets into a liquidity pool -- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -- `manage-buy-offer` — Create, update, or delete a buy offer -- `manage-data` — Set, modify, or delete account data entries -- `manage-sell-offer` — Create, update, or delete a sell offer -- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -- `payment` — Send asset to destination account -- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -- `set-options` — Set account options like flags, signers, and home domain -- `set-trustline-flags` — Configure authorization and trustline flags for an asset +* `account-merge` — Transfer XLM balance to another account and remove source account +* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +* `bump-sequence` — Bump sequence number to invalidate older transactions +* `change-trust` — Create, update, or delete a trustline +* `claim-claimable-balance` — Claim a claimable balance by its balance ID +* `clawback` — Clawback an asset from an account +* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +* `create-account` — Create and fund a new account +* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +* `end-sponsoring-future-reserves` — End sponsoring future reserves +* `liquidity-pool-deposit` — Deposit assets into a liquidity pool +* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +* `manage-buy-offer` — Create, update, or delete a buy offer +* `manage-data` — Set, modify, or delete account data entries +* `manage-sell-offer` — Create, update, or delete a sell offer +* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +* `payment` — Send asset to destination account +* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +* `set-options` — Set account options like flags, signers, and home domain +* `set-trustline-flags` — Configure authorization and trustline flags for an asset + + ## `stellar tx new account-merge` @@ -1562,25 +1740,26 @@ Transfer XLM balance to another account and remove source account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx new begin-sponsoring-future-reserves` @@ -1590,25 +1769,26 @@ Begin sponsoring future reserves for another account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--sponsored-id ` — Account that will be sponsored + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--sponsored-id ` — Account that will be sponsored ## `stellar tx new bump-sequence` @@ -1618,25 +1798,26 @@ Bump sequence number to invalidate older transactions ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--bump-to ` — Sequence number to bump to + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--bump-to ` — Sequence number to bump to ## `stellar tx new change-trust` @@ -1646,29 +1827,30 @@ Create, update, or delete a trustline ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--line ` +* `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` + + ## `stellar tx new claim-claimable-balance` Claim a claimable balance by its balance ID @@ -1677,25 +1859,26 @@ Claim a claimable balance by its balance ID ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx new clawback` @@ -1705,27 +1888,28 @@ Clawback an asset from an account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--from ` — Account to clawback assets from, e.g. `GBX...` -- `--asset ` — Asset to clawback -- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx new clawback-claimable-balance` @@ -1735,25 +1919,26 @@ Clawback a claimable balance by its balance ID ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx new create-account` @@ -1763,29 +1948,30 @@ Create and fund a new account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account Id to create, e.g. `GBX...` -- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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-claimable-balance` Create a claimable balance that can be claimed by specified accounts @@ -1794,33 +1980,34 @@ Create a claimable balance that can be claimed by specified accounts ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--asset ` — Asset to be held in the ClaimableBalanceEntry +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` +* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + + Examples: + + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` -- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - Examples: - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx new create-passive-sell-offer` @@ -1830,28 +2017,29 @@ Create a passive sell offer on the Stellar DEX ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx new end-sponsoring-future-reserves` @@ -1861,24 +2049,25 @@ End sponsoring future reserves ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx new liquidity-pool-deposit` @@ -1888,34 +2077,34 @@ Deposit assets into a liquidity pool ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--liquidity-pool-id ` — Liquidity pool ID to deposit to +* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--liquidity-pool-id ` — Liquidity pool ID to deposit to -- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` +* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` -- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` ## `stellar tx new liquidity-pool-withdraw` @@ -1925,28 +2114,29 @@ Withdraw assets from a liquidity pool ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--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 ## `stellar tx new manage-buy-offer` @@ -1956,32 +2146,33 @@ Create, update, or delete a buy offer ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx new manage-data` Set, modify, or delete account data entries @@ -1990,26 +2181,27 @@ Set, modify, or delete account data entries ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx new manage-sell-offer` @@ -2019,32 +2211,33 @@ Create, update, or delete a sell offer ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx new path-payment-strict-send` Send a payment with a different asset using path finding, specifying the send amount @@ -2053,30 +2246,31 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new path-payment-strict-receive` @@ -2086,30 +2280,31 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new payment` @@ -2119,30 +2314,30 @@ Send asset to destination account ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account to send to, e.g. `GBX...` -- `--asset ` — Asset to send, default native, e.i. XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--destination ` — Account to send to, e.g. `GBX...` +* `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` +* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) + -- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx new revoke-sponsorship` @@ -2152,31 +2347,32 @@ Revoke sponsorship of a ledger entry or signer ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account-id ` — Account ID (required for all sponsorship types) +* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +* `--data-name ` — Data name for data entry sponsorship +* `--offer-id ` — Offer ID for offer sponsorship +* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--signer-key ` — Signer key for signer sponsorship + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account-id ` — Account ID (required for all sponsorship types) -- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -- `--data-name ` — Data name for data entry sponsorship -- `--offer-id ` — Offer ID for offer sponsorship -- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx new set-options` @@ -2186,40 +2382,41 @@ Set account options like flags, signers, and home domain ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--inflation-dest ` — Account of the inflation destination +* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +* `--signer ` — Add, update, or remove a signer from an account +* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +* `--clear-required` +* `--clear-revocable` +* `--clear-immutable` +* `--clear-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--inflation-dest ` — Account of the inflation destination -- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -- `--signer ` — Add, update, or remove a signer from an account -- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -- `--clear-required` -- `--clear-revocable` -- `--clear-immutable` -- `--clear-clawback-enabled` ## `stellar tx new set-trustline-flags` @@ -2229,32 +2426,33 @@ Configure authorization and trustline flags for an asset ###### **Options:** -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +* `--asset ` — Asset to set trustline flags for +* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +* `--clear-authorize` +* `--clear-authorize-to-maintain-liabilities` +* `--clear-trustline-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -- `--asset ` — Asset to set trustline flags for -- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -- `--clear-authorize` -- `--clear-authorize-to-maintain-liabilities` -- `--clear-trustline-clawback-enabled` ## `stellar tx operation` @@ -2266,7 +2464,9 @@ Manipulate the operations in a transaction, including adding new operations ###### **Subcommands:** -- `add` — Add Operation to a transaction +* `add` — Add Operation to a transaction + + ## `stellar tx operation add` @@ -2276,28 +2476,30 @@ Add Operation to a transaction ###### **Subcommands:** -- `account-merge` — Transfer XLM balance to another account and remove source account -- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -- `bump-sequence` — Bump sequence number to invalidate older transactions -- `change-trust` — Create, update, or delete a trustline -- `claim-claimable-balance` — Claim a claimable balance by its balance ID -- `clawback` — Clawback an asset from an account -- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -- `create-account` — Create and fund a new account -- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -- `end-sponsoring-future-reserves` — End sponsoring future reserves -- `liquidity-pool-deposit` — Deposit assets into a liquidity pool -- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -- `manage-buy-offer` — Create, update, or delete a buy offer -- `manage-data` — Set, modify, or delete account data entries -- `manage-sell-offer` — Create, update, or delete a sell offer -- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -- `payment` — Send asset to destination account -- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -- `set-options` — Set account options like flags, signers, and home domain -- `set-trustline-flags` — Configure authorization and trustline flags for an asset +* `account-merge` — Transfer XLM balance to another account and remove source account +* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +* `bump-sequence` — Bump sequence number to invalidate older transactions +* `change-trust` — Create, update, or delete a trustline +* `claim-claimable-balance` — Claim a claimable balance by its balance ID +* `clawback` — Clawback an asset from an account +* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +* `create-account` — Create and fund a new account +* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +* `end-sponsoring-future-reserves` — End sponsoring future reserves +* `liquidity-pool-deposit` — Deposit assets into a liquidity pool +* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +* `manage-buy-offer` — Create, update, or delete a buy offer +* `manage-data` — Set, modify, or delete account data entries +* `manage-sell-offer` — Create, update, or delete a sell offer +* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +* `payment` — Send asset to destination account +* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +* `set-options` — Set account options like flags, signers, and home domain +* `set-trustline-flags` — Configure authorization and trustline flags for an asset + + ## `stellar tx operation add account-merge` @@ -2307,30 +2509,31 @@ Transfer XLM balance to another account and remove source account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx operation add begin-sponsoring-future-reserves` @@ -2340,30 +2543,31 @@ Begin sponsoring future reserves for another account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--sponsored-id ` — Account that will be sponsored + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--sponsored-id ` — Account that will be sponsored ## `stellar tx operation add bump-sequence` @@ -2373,30 +2577,31 @@ Bump sequence number to invalidate older transactions ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--bump-to ` — Sequence number to bump to + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--bump-to ` — Sequence number to bump to ## `stellar tx operation add change-trust` @@ -2406,34 +2611,35 @@ Create, update, or delete a trustline ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--line ` -- `--limit ` — Limit for the trust line, 0 to remove the trust line +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--line ` +* `--limit ` — Limit for the trust line, 0 to remove the trust line Default value: `9223372036854775807` + + ## `stellar tx operation add claim-claimable-balance` Claim a claimable balance by its balance ID @@ -2442,30 +2648,31 @@ Claim a claimable balance by its balance ID ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx operation add clawback` @@ -2475,32 +2682,33 @@ Clawback an asset from an account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--from ` — Account to clawback assets from, e.g. `GBX...` -- `--asset ` — Asset to clawback -- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx operation add clawback-claimable-balance` @@ -2510,30 +2718,31 @@ Clawback a claimable balance by its balance ID ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx operation add create-account` @@ -2543,34 +2752,35 @@ Create and fund a new account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account Id to create, e.g. `GBX...` -- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--destination ` — Account Id to create, e.g. `GBX...` +* `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM Default value: `10_000_000` + + ## `stellar tx operation add create-claimable-balance` Create a claimable balance that can be claimed by specified accounts @@ -2579,38 +2789,39 @@ Create a claimable balance that can be claimed by specified accounts ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--asset ` — Asset to be held in the ClaimableBalanceEntry +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--asset ` — Asset to be held in the ClaimableBalanceEntry Default value: `native` +* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + + Examples: + + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` -- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - Examples: - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx operation add create-passive-sell-offer` @@ -2620,33 +2831,34 @@ Create a passive sell offer on the Stellar DEX ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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) + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx operation add end-sponsoring-future-reserves` @@ -2656,29 +2868,30 @@ End sponsoring future reserves ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx operation add liquidity-pool-deposit` @@ -2688,39 +2901,39 @@ Deposit assets into a liquidity pool ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--liquidity-pool-id ` — Liquidity pool ID to deposit to +* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--liquidity-pool-id ` — Liquidity pool ID to deposit to -- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` +* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` -- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` ## `stellar tx operation add liquidity-pool-withdraw` @@ -2730,33 +2943,34 @@ Withdraw assets from a liquidity pool ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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 + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--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 ## `stellar tx operation add manage-buy-offer` @@ -2766,37 +2980,38 @@ Create, update, or delete a buy offer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx operation add manage-data` Set, modify, or delete account data entries @@ -2805,31 +3020,32 @@ Set, modify, or delete account data entries ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--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` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx operation add manage-sell-offer` @@ -2839,37 +3055,38 @@ Create, update, or delete a sell offer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--selling ` — Asset to sell -- `--buying ` — Asset to buy -- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--selling ` — Asset to sell +* `--buying ` — Asset to buy +* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer Default value: `0` + + ## `stellar tx operation add path-payment-strict-receive` Send a payment with a different asset using path finding, specifying the receive amount @@ -2878,35 +3095,36 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add path-payment-strict-send` @@ -2916,35 +3134,36 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--send-asset ` — Asset to send (pay with) +* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +* `--destination ` — Account that receives the payment +* `--dest-asset ` — Asset that the destination will receive +* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--send-asset ` — Asset to send (pay with) -- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -- `--destination ` — Account that receives the payment -- `--dest-asset ` — Asset that the destination will receive -- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add payment` @@ -2954,35 +3173,35 @@ Send asset to destination account ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` - -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--destination ` — Account to send to, e.g. `GBX...` -- `--asset ` — Asset to send, default native, e.i. XLM +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--destination ` — Account to send to, e.g. `GBX...` +* `--asset ` — Asset to send, default native, e.i. XLM Default value: `native` +* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) + -- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx operation add revoke-sponsorship` @@ -2992,36 +3211,37 @@ Revoke sponsorship of a ledger entry or signer ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--account-id ` — Account ID (required for all sponsorship types) +* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +* `--data-name ` — Data name for data entry sponsorship +* `--offer-id ` — Offer ID for offer sponsorship +* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +* `--signer-key ` — Signer key for signer sponsorship + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--account-id ` — Account ID (required for all sponsorship types) -- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -- `--data-name ` — Data name for data entry sponsorship -- `--offer-id ` — Offer ID for offer sponsorship -- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx operation add set-options` @@ -3031,45 +3251,46 @@ Set account options like flags, signers, and home domain ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--inflation-dest ` — Account of the inflation destination +* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +* `--signer ` — Add, update, or remove a signer from an account +* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +* `--clear-required` +* `--clear-revocable` +* `--clear-immutable` +* `--clear-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--inflation-dest ` — Account of the inflation destination -- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -- `--signer ` — Add, update, or remove a signer from an account -- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -- `--clear-required` -- `--clear-revocable` -- `--clear-immutable` -- `--clear-clawback-enabled` ## `stellar tx operation add set-trustline-flags` @@ -3079,37 +3300,38 @@ Configure authorization and trustline flags for an asset ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` +* `--cost` — Output the cost execution to stderr +* `--instructions ` — Number of instructions to simulate +* `--build-only` — Build the transaction and only write the base64 xdr to stdout +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +* `--asset ` — Asset to set trustline flags for +* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +* `--clear-authorize` +* `--clear-authorize-to-maintain-liabilities` +* `--clear-trustline-clawback-enabled` + -- `--cost` — Output the cost execution to stderr -- `--instructions ` — Number of instructions to simulate -- `--build-only` — Build the transaction and only write the base64 xdr to stdout -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet -- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -- `--asset ` — Asset to set trustline flags for -- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -- `--clear-authorize` -- `--clear-authorize-to-maintain-liabilities` -- `--clear-trustline-clawback-enabled` ## `stellar tx send` @@ -3119,16 +3341,18 @@ Send a transaction envelope to the network ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar tx sign` @@ -3138,20 +3362,22 @@ Sign a transaction envelope appending the signature to the envelope ###### **Arguments:** -- `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty ###### **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 -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings + + ## `stellar tx simulate` @@ -3161,49 +3387,58 @@ Simulate a transaction envelope from stdin ###### **Arguments:** -- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -- `--sign-with-lab` — Sign with https://lab.stellar.org -- `--sign-with-ledger` — Sign with a ledger wallet +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +* `--sign-with-lab` — Sign with https://lab.stellar.org +* `--sign-with-ledger` — Sign with a ledger wallet + + ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -**Usage:** `stellar tx fetch [OPTIONS] fetch ` +**Usage:** `stellar tx fetch [OPTIONS] + fetch ` ###### **Subcommands:** -- `result` — Fetch the transaction result -- `meta` — Fetch the transaction meta -- `fee` — Fetch the transaction fee information +* `result` — Fetch the transaction result +* `meta` — Fetch the transaction meta +* `fee` — Fetch the transaction fee information ###### **Options:** -- `--hash ` — Hash of transaction to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--hash ` — Hash of transaction to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar tx fetch result` @@ -3213,19 +3448,25 @@ Fetch the transaction result ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--hash ` — Transaction hash to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar tx fetch meta` @@ -3235,19 +3476,25 @@ Fetch the transaction meta ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--hash ` — Transaction hash to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar tx fetch fee` @@ -3257,19 +3504,25 @@ Fetch the transaction fee information ###### **Options:** -- `--hash ` — Transaction hash to fetch -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Output format for fee command +* `--hash ` — Transaction hash to fetch +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Output format for fee command Default value: `table` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `table`: Formatted in a table comparing fee types + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `table`: + Formatted in a table comparing fee types + + + ## `stellar tx decode` @@ -3279,22 +3532,25 @@ Decode a transaction envelope from XDR to JSON ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `single-base64` Possible values: `single-base64`, `single` -- `--output ` +* `--output ` Default value: `json` Possible values: `json`, `json-formatted` + + + ## `stellar tx encode` Encode a transaction envelope from JSON to XDR @@ -3303,22 +3559,25 @@ Encode a transaction envelope from JSON to XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `json` Possible values: `json` -- `--output ` +* `--output ` Default value: `single-base64` Possible values: `single-base64`, `single` + + + ## `stellar xdr` Decode and encode XDR @@ -3327,22 +3586,25 @@ Decode and encode XDR ###### **Subcommands:** -- `types` — View information about types -- `guess` — Guess the XDR type -- `decode` — Decode XDR -- `encode` — Encode XDR -- `compare` — Compare two XDR values with each other -- `generate` — Generate XDR values -- `version` — Print version information +* `types` — View information about types +* `guess` — Guess the XDR type +* `decode` — Decode XDR +* `encode` — Encode XDR +* `compare` — Compare two XDR values with each other +* `generate` — Generate XDR values +* `version` — Print version information ###### **Arguments:** -- `` — Channel of XDR to operate on +* `` — Channel of XDR to operate on Default value: `+curr` Possible values: `+curr`, `+next` + + + ## `stellar xdr types` View information about types @@ -3351,9 +3613,11 @@ View information about types ###### **Subcommands:** -- `list` — -- `schema` — -- `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory +* `list` — +* `schema` — +* `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory + + ## `stellar xdr types list` @@ -3361,25 +3625,31 @@ View information about types ###### **Options:** -- `--output ` +* `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` + + + ## `stellar xdr types schema` **Usage:** `stellar xdr types schema [OPTIONS] --type ` ###### **Options:** -- `--type ` — XDR type to decode -- `--output ` +* `--type ` — XDR type to decode +* `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` + + + ## `stellar xdr types schema-files` Generate JSON schema files for the XDR types, writing a file for each type to the out directory @@ -3388,13 +3658,16 @@ Generate JSON schema files for the XDR types, writing a file for each type to th ###### **Options:** -- `--out-dir ` -- `--output ` +* `--out-dir ` +* `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` + + + ## `stellar xdr guess` Guess the XDR type. @@ -3405,26 +3678,28 @@ Prints a list of types that the XDR values can be decoded into. ###### **Arguments:** -- `` — XDR or file containing XDR to decode, or stdin if empty +* `` — XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -- `--input ` +* `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `list` Possible values: `list` -- `--certainty ` — Certainty as an arbitrary value +* `--certainty ` — Certainty as an arbitrary value Default value: `2` + + ## `stellar xdr decode` Decode XDR @@ -3433,23 +3708,26 @@ Decode XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--type ` — XDR type to decode -- `--input ` +* `--type ` — XDR type to decode +* `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -- `--output ` +* `--output ` Default value: `json` Possible values: `json`, `json-formatted`, `text`, `rust-debug`, `rust-debug-formatted` + + + ## `stellar xdr encode` Encode XDR @@ -3458,23 +3736,26 @@ Encode XDR ###### **Arguments:** -- `` — XDR or files containing XDR to decode, or stdin if empty +* `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -- `--type ` — XDR type to encode -- `--input ` +* `--type ` — XDR type to encode +* `--input ` Default value: `json` Possible values: `json` -- `--output ` +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream` + + + ## `stellar xdr compare` Compare two XDR values with each other @@ -3485,18 +3766,21 @@ Outputs: `-1` when the left XDR value is less than the right XDR value, `0` when ###### **Arguments:** -- `` — XDR file to decode and compare with the right value -- `` — XDR file to decode and compare with the left value +* `` — XDR file to decode and compare with the right value +* `` — XDR file to decode and compare with the left value ###### **Options:** -- `--type ` — XDR type of both inputs -- `--input ` +* `--type ` — XDR type of both inputs +* `--input ` Default value: `single-base64` Possible values: `single`, `single-base64` + + + ## `stellar xdr generate` Generate XDR values @@ -3505,8 +3789,10 @@ Generate XDR values ###### **Subcommands:** -- `default` — Generate default XDR values -- `arbitrary` — Generate arbitrary XDR values +* `default` — Generate default XDR values +* `arbitrary` — Generate arbitrary XDR values + + ## `stellar xdr generate default` @@ -3516,13 +3802,16 @@ Generate default XDR values ###### **Options:** -- `--type ` — XDR type to generate -- `--output ` +* `--type ` — XDR type to generate +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` + + + ## `stellar xdr generate arbitrary` Generate arbitrary XDR values @@ -3531,19 +3820,24 @@ Generate arbitrary XDR values ###### **Options:** -- `--type ` — XDR type to generate -- `--output ` +* `--type ` — XDR type to generate +* `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` + + + ## `stellar xdr version` Print version information **Usage:** `stellar xdr version` + + ## `stellar completion` Print shell completion code for the specified shell @@ -3554,14 +3848,18 @@ To enable autocomplete in the current bash shell, run: `source <(stellar complet To enable autocomplete permanently, run: `echo "source <(stellar completion --shell bash)" >> ~/.bashrc` + **Usage:** `stellar completion --shell ` ###### **Options:** -- `--shell ` — The shell type +* `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` + + + ## `stellar cache` Cache for transactions and contract specs @@ -3570,9 +3868,11 @@ Cache for transactions and contract specs ###### **Subcommands:** -- `clean` — Delete the cache -- `path` — Show the location of the cache -- `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) +* `clean` — Delete the cache +* `path` — Show the location of the cache +* `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) + + ## `stellar cache clean` @@ -3580,12 +3880,16 @@ Delete the cache **Usage:** `stellar cache clean` + + ## `stellar cache path` Show the location of the cache **Usage:** `stellar cache path` + + ## `stellar cache actionlog` Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) @@ -3594,8 +3898,10 @@ Access details about cached actions like transactions, and simulations. (Experim ###### **Subcommands:** -- `ls` — List cached actions (transactions, simulations) -- `read` — Read cached action +* `ls` — List cached actions (transactions, simulations) +* `read` — Read cached action + + ## `stellar cache actionlog ls` @@ -3605,9 +3911,11 @@ List cached actions (transactions, simulations) ###### **Options:** -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `-l`, `--long` +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `-l`, `--long` + + ## `stellar cache actionlog read` @@ -3617,7 +3925,9 @@ Read cached action ###### **Options:** -- `--id ` — ID of the cache entry +* `--id ` — ID of the cache entry + + ## `stellar version` @@ -3627,8 +3937,10 @@ Print version information ###### **Options:** -- `--only-version` — Print only the version -- `--only-version-major` — Print only the major version +* `--only-version` — Print only the version +* `--only-version-major` — Print only the major version + + ## `stellar plugin` @@ -3638,8 +3950,10 @@ The subcommand for CLI plugins ###### **Subcommands:** -- `search` — Search for CLI plugins using GitHub -- `ls` — List installed plugins +* `search` — Search for CLI plugins using GitHub +* `ls` — List installed plugins + + ## `stellar plugin search` @@ -3647,12 +3961,16 @@ Search for CLI plugins using GitHub **Usage:** `stellar plugin search` + + ## `stellar plugin ls` List installed plugins **Usage:** `stellar plugin ls` + + ## `stellar ledger` Fetch ledger information @@ -3661,9 +3979,11 @@ Fetch ledger information ###### **Subcommands:** -- `entry` — Work with ledger entries -- `latest` — Get the latest ledger sequence and information from the network -- `fetch` — +* `entry` — Work with ledger entries +* `latest` — Get the latest ledger sequence and information from the network +* `fetch` — + + ## `stellar ledger entry` @@ -3673,7 +3993,9 @@ Work with ledger entries ###### **Subcommands:** -- `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) +* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) + + ## `stellar ledger entry fetch` @@ -3683,15 +4005,17 @@ Fetch ledger entries. This command supports all types of ledger entries supporte ###### **Subcommands:** -- `account` — Fetch account entry by public key or alias -- `contract-data` — Fetch contract ledger entry by address or alias and storage key -- `config` — Fetch the current network config by `ConfigSettingId`. All config settings are returned if no id is provided -- `claimable-balance` — Fetch a claimable balance ledger entry by id -- `liquidity-pool` — Fetch a liquidity pool ledger entry by id -- `contract-code` — Fetch WASM bytecode by hash -- `trustline` — Fetch a trustline by account and asset -- `data` — Fetch key-value data entries attached to an account (see manageDataOp) -- `offer` — Fetch an offer by account and offer id +* `account` — Fetch account entry by public key or alias +* `contract-data` — Fetch contract ledger entry by address or alias and storage key +* `config` — Fetch the current network config by `ConfigSettingId`. All config settings are returned if no id is provided +* `claimable-balance` — Fetch a claimable balance ledger entry by id +* `liquidity-pool` — Fetch a liquidity pool ledger entry by id +* `contract-code` — Fetch a Contract's WASM bytecode by WASM hash +* `trustline` — Fetch a trustline by account and asset +* `data` — Fetch key-value data entries attached to an account (see manageDataOp) +* `offer` — Fetch an offer by account and offer id + + ## `stellar ledger entry fetch account` @@ -3701,27 +4025,32 @@ Fetch account entry by public key or alias ###### **Arguments:** -- `` — Account alias or public key to lookup, default is test identity +* `` — Account alias or address to lookup ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + +* `--hide-account` — Hide the account ledger entry from the output +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + -- `--hide-account` — Hide the account ledger entry from the output -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar ledger entry fetch contract-data` @@ -3731,35 +4060,42 @@ Fetch contract ledger entry by address or alias and storage key ###### **Arguments:** -- `` — Contract alias or address to fetch +* `` — Contract alias or address to fetch ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) -- `--durability ` — Storage entry durability +* `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: Persistent - - `temporary`: Temporary + - `persistent`: + Persistent + - `temporary`: + Temporary + +* `--key ` — Storage key (symbols only) +* `--key-xdr ` — Storage key (base64-encoded XDR) + -- `--key ` — Storage key (symbols only) -- `--key-xdr ` — Storage key (base64-encoded XDR) ## `stellar ledger entry fetch config` @@ -3769,24 +4105,47 @@ Fetch the current network config by `ConfigSettingId`. All config settings are r ###### **Arguments:** -- `` — Valid config setting IDs (Config Setting ID => Name): 0 => ContractMaxSizeBytes 1 => ContractComputeV0 2 => ContractLedgerCostV0 3 => ContractHistoricalDataV0 4 => ContractEventsV0 5 => ContractBandwidthV0 6 => ContractCostParamsCpuInstructions 7 => ContractCostParamsMemoryBytes 8 => ContractDataKeySizeBytes 9 => ContractDataEntrySizeBytes 10 => StateArchival 11 => ContractExecutionLanes 12 => LiveSorobanStateSizeWindow 13 => EvictionIterator 14 => ContractParallelComputeV0 15 => ContractLedgerCostExtV0 16 => ScpTiming - -###### **Options:** - -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `` — Valid config setting IDs (Config Setting ID => Name): + 0 => ContractMaxSizeBytes + 1 => ContractComputeV0 + 2 => ContractLedgerCostV0 + 3 => ContractHistoricalDataV0 + 4 => ContractEventsV0 + 5 => ContractBandwidthV0 + 6 => ContractCostParamsCpuInstructions + 7 => ContractCostParamsMemoryBytes + 8 => ContractDataKeySizeBytes + 9 => ContractDataEntrySizeBytes + 10 => StateArchival + 11 => ContractExecutionLanes + 12 => LiveSorobanStateSizeWindow + 13 => EvictionIterator + 14 => ContractParallelComputeV0 + 15 => ContractLedgerCostExtV0 + 16 => ScpTiming + +###### **Options:** + +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar ledger entry fetch claimable-balance` @@ -3796,24 +4155,30 @@ Fetch a claimable balance ledger entry by id ###### **Arguments:** -- `` — Claimable Balance Ids to fetch an entry for +* `` — Claimable Balance Ids to fetch an entry for ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar ledger entry fetch liquidity-pool` @@ -3823,51 +4188,63 @@ Fetch a liquidity pool ledger entry by id ###### **Arguments:** -- `` — Liquidity pool ids +* `` — Liquidity pool ids ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar ledger entry fetch contract-code` -Fetch WASM bytecode by hash +Fetch a Contract's WASM bytecode by WASM hash **Usage:** `stellar ledger entry fetch contract-code [OPTIONS] [WASM_HASHES]...` ###### **Arguments:** -- `` — Get WASM bytecode by hash +* `` — Get WASM bytecode by hash ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + + + ## `stellar ledger entry fetch trustline` @@ -3877,24 +4254,29 @@ Fetch a trustline by account and asset ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + +* `--account ` — Account alias or address to lookup +* `--asset ` — Assets to get trustline info for +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + -- `--account ` — Account alias or public key to lookup, default is test identity -- `--asset ` — Assets to get trustline info for -- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar ledger entry fetch data` @@ -3904,24 +4286,29 @@ Fetch key-value data entries attached to an account (see manageDataOp) ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + +* `--account ` — Account alias or address to lookup +* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + -- `--account ` — Account alias or public key to lookup, default is test identity -- `--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 ## `stellar ledger entry fetch offer` @@ -3931,24 +4318,29 @@ Fetch an offer by account and offer id ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--global` — ⚠️ Deprecated: global config is always on -- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--global` — ⚠️ Deprecated: global config is always on +* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +* `--output ` — Format of the output Default value: `json` Possible values: - - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: Original RPC output (containing XDRs) + - `json`: + JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: + Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: + Original RPC output (containing XDRs) + +* `--account ` — Account alias or address to lookup +* `--offer ` — ID of an offer made on the Stellar DEX +* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 + -- `--account ` — Account alias or public key to lookup, default is test identity -- `--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 ## `stellar ledger latest` @@ -3958,18 +4350,24 @@ Get the latest ledger sequence and information from the network ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + ## `stellar ledger fetch` @@ -3977,34 +4375,41 @@ Get the latest ledger sequence and information from the network ###### **Arguments:** -- `` — Ledger Sequence to start fetch (inclusive) +* `` — Ledger Sequence to start fetch (inclusive) ###### **Options:** -- `--limit ` — Number of ledgers to fetch +* `--limit ` — Number of ledgers to fetch Default value: `1` - -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request -- `--xdr-format ` — Format of the xdr in the output +* `--xdr-format ` — Format of the xdr in the output Default value: `json` Possible values: - - `json`: XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields - - `xdr`: XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields + - `json`: + XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields + - `xdr`: + XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields + + + ## `stellar fee-stats` @@ -4014,15 +4419,22 @@ Fetch network feestats ###### **Options:** -- `--rpc-url ` — RPC server endpoint -- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -- `-n`, `--network ` — Name of network to use from config -- `--output ` — Format of the output +* `--rpc-url ` — RPC server endpoint +* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +* `-n`, `--network ` — Name of network to use from config +* `--output ` — Format of the output Default value: `text` Possible values: - - `text`: Text output of network info - - `json`: JSON result of the RPC request - - `json-formatted`: Formatted (multiline) JSON output of the RPC request + - `text`: + Text output of network info + - `json`: + JSON result of the RPC request + - `json-formatted`: + Formatted (multiline) JSON output of the RPC request + + + + diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 54c52aa366..aca97b1127 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -11,7 +11,7 @@ use clap::{command, Parser}; #[derive(Parser, Debug, Clone)] #[group(skip)] pub struct Cmd { - /// Account alias or public key to lookup, default is test identity + /// Account alias or address to lookup pub account: String, #[command(flatten)] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs index f6f73e0dfc..ee99a7430e 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account_data.rs @@ -14,7 +14,7 @@ pub struct Cmd { #[command(flatten)] pub args: Args, - /// Account alias or public key to lookup, default is test identity + /// Account alias or address to lookup #[arg(long)] pub account: String, diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs index c2af11f597..1c2dcc2bb0 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/offer.rs @@ -14,7 +14,7 @@ pub struct Cmd { #[command(flatten)] pub args: Args, - /// Account alias or public key to lookup, default is test identity + /// Account alias or address to lookup #[arg(long)] pub account: String, diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs index cbd56ecf3f..6b780e6f95 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs @@ -18,7 +18,7 @@ pub struct Cmd { #[command(flatten)] pub args: Args, - /// Account alias or public key to lookup, default is test identity + /// Account alias or address to lookup #[arg(long)] pub account: String, From 8d3bfafbfd881ecfc59c1f93e262d29b93246c14 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 10:23:34 -0400 Subject: [PATCH 66/76] Address PR feedback --- cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs | 7 ------- 1 file changed, 7 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index aca97b1127..3e9a7b6033 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -17,10 +17,6 @@ pub struct Cmd { #[command(flatten)] pub args: Args, - /// Hide the account ledger entry from the output - #[arg(long)] - pub hide_account: bool, - /// If identity is a seed phrase use this hd path, default is 0 #[arg(long)] pub hd_path: Option, @@ -50,9 +46,6 @@ impl Cmd { } fn insert_account_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if self.hide_account { - return Ok(()); - } let acc = self.muxed_account(&self.account)?; let key = LedgerKey::Account(LedgerKeyAccount { account_id: acc.account_id(), From f3de375d758623a4b8a2916f72f8752343b075cf Mon Sep 17 00:00:00 2001 From: Elizabeth Engelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 10:30:16 -0400 Subject: [PATCH 67/76] Update cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs Co-authored-by: Leigh <351529+leighmcculloch@users.noreply.github.com> --- cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs index 6b780e6f95..2cf08ecb92 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/trustline.rs @@ -26,7 +26,7 @@ pub struct Cmd { #[arg(long, required = true)] pub asset: Vec, - /// If identity is a seed phrase use this hd path, default is 0 + /// If account is a seed phrase use this hd path, default is 0 #[arg(long)] pub hd_path: Option, } From 181f0533d6757524f8ea980ea71f82da7190eb1d Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 12:27:15 -0400 Subject: [PATCH 68/76] Make contract a named arg for ledger entry fetch contract-data --- cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs | 1 + 1 file changed, 1 insertion(+) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs index 7ddd0a90bc..83445c0fca 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs @@ -13,6 +13,7 @@ use clap::{command, Parser}; #[group(skip)] pub struct Cmd { /// Contract alias or address to fetch + #[arg(long)] pub contract: config::UnresolvedContract, #[command(flatten)] From 23b34dd8395383e0a1ea8c1b69e3408d048c94be Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 12:27:44 -0400 Subject: [PATCH 69/76] Add a required_unless_present attribute on key and key-xdr for contract data --- .../src/commands/ledger/entry/fetch/contract_data.rs | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs index 83445c0fca..1a52d66fb9 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs @@ -25,14 +25,15 @@ pub struct Cmd { pub durability: Durability, /// Storage key (symbols only) - #[arg(long = "key")] + #[arg(long = "key", required_unless_present = "key_xdr")] pub key: Option>, /// Storage key (base64-encoded XDR) - #[arg(long = "key-xdr")] + #[arg(long = "key-xdr", required_unless_present = "key")] pub key_xdr: Option>, } + #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] From 8eb148ee164be1d74fc801378a48b4b9963258e1 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 13:00:27 -0400 Subject: [PATCH 70/76] Make all args named args in ledger entry fetch --- .../src/commands/ledger/entry/fetch/account.rs | 1 + .../src/commands/ledger/entry/fetch/claimable_balance.rs | 5 +++-- .../src/commands/ledger/entry/fetch/contract_code.rs | 9 +++++---- .../src/commands/ledger/entry/fetch/contract_data.rs | 1 - .../src/commands/ledger/entry/fetch/liquidity_pool.rs | 5 +++-- 5 files changed, 12 insertions(+), 9 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs index 3e9a7b6033..ae1e322dc9 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/account.rs @@ -12,6 +12,7 @@ use clap::{command, Parser}; #[group(skip)] pub struct Cmd { /// Account alias or address to lookup + #[arg(long)] pub account: String, #[command(flatten)] diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs index 0e8fb44caf..73781951be 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs @@ -10,7 +10,8 @@ use soroban_spec_tools::utils::padded_hex_from_str; #[group(skip)] pub struct Cmd { /// Claimable Balance Ids to fetch an entry for - pub ids: Vec, + #[arg(long)] + pub id: Vec, #[command(flatten)] pub args: Args, @@ -34,7 +35,7 @@ impl Cmd { } fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - for x in &self.ids { + for x in &self.id { let padded_hex = padded_hex_from_str(x, 32)?; let hash_bytes: [u8; 32] = padded_hex .try_into() diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_code.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_code.rs index 8031e23b72..bf2eb097ce 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_code.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_code.rs @@ -6,7 +6,8 @@ use clap::{command, Parser}; #[group(skip)] pub struct Cmd { /// Get WASM bytecode by hash - pub wasm_hashes: Vec, + #[arg(long)] + pub wasm_hash: Vec, #[command(flatten)] pub args: Args, @@ -28,10 +29,10 @@ impl Cmd { } fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - for wasm_hash in &self.wasm_hashes { + for hash in &self.wasm_hash { let hash = Hash( - soroban_spec_tools::utils::contract_id_from_str(wasm_hash) - .map_err(|_| Error::InvalidHash(wasm_hash.clone()))?, + soroban_spec_tools::utils::contract_id_from_str(hash) + .map_err(|_| Error::InvalidHash(hash.clone()))?, ); let key = LedgerKey::ContractCode(LedgerKeyContractCode { hash }); ledger_keys.push(key); diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs index 1a52d66fb9..03935b8f63 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs @@ -19,7 +19,6 @@ pub struct Cmd { #[command(flatten)] pub args: Args, - //Options /// Storage entry durability #[arg(long, value_enum, default_value = "persistent")] pub durability: Durability, diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs index e6ccd5696e..fdf308daf1 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs @@ -9,7 +9,8 @@ use std::fmt::Debug; #[group(skip)] pub struct Cmd { /// Liquidity pool ids - pub ids: Vec, + #[arg(long)] + pub id: Vec, #[command(flatten)] pub args: Args, @@ -33,7 +34,7 @@ impl Cmd { } fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - for x in &self.ids { + for x in &self.id { let padded_hex = padded_hex_from_str(x, 32)?; let hash_bytes: [u8; 32] = padded_hex .try_into() From d769cbe2437f48ab6dbc4fafc180e28200bd1a0c Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 13:00:35 -0400 Subject: [PATCH 71/76] Clean up integration tests --- .../tests/it/integration/ledger/entry.rs | 51 ++++--------------- 1 file changed, 9 insertions(+), 42 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index ef04ddb711..7d0fa50baa 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -27,7 +27,7 @@ use crate::integration::util::{deploy_contract, test_address, DeployOptions, HEL // account data tests // todo: test with --offer, #[tokio::test] -async fn ledger_entry_account_only_with_account_alias() { +async fn ledger_entry_account_with_alias() { let sandbox = &TestEnv::new(); let account_alias = "new_account"; let new_account_addr = new_account(sandbox, account_alias); @@ -36,6 +36,7 @@ async fn ledger_entry_account_only_with_account_alias() { .arg("entry") .arg("fetch") .arg("account") + .arg("--account") .arg(account_alias) .arg("--network") .arg("testnet") @@ -55,7 +56,7 @@ async fn ledger_entry_account_only_with_account_alias() { } #[tokio::test] -async fn ledger_entry_account_only_with_account_addr() { +async fn ledger_entry_account_with_account_addr() { let sandbox = &TestEnv::new(); let new_account_addr = new_account(sandbox, "new_account"); let output = sandbox @@ -63,6 +64,7 @@ async fn ledger_entry_account_only_with_account_addr() { .arg("entry") .arg("fetch") .arg("account") + .arg("--account") .arg(&new_account_addr) .arg("--network") .arg("testnet") @@ -178,46 +180,6 @@ async fn ledger_entry_account_data() { assert!(matches!(data_entry.val, LedgerEntryData::Data { .. })); } -#[ignore] -#[tokio::test] -async fn ledger_entries_hide_account() { - let sandbox = &TestEnv::new(); - let account_alias = "new_account"; - let new_account_addr = new_account(sandbox, account_alias); - let data_name = "test_data_key"; - add_account_data(sandbox, account_alias, data_name, "abcdef").await; - - let output = sandbox - .new_assert_cmd("ledger") - .arg("entry") - .arg("fetch") - .arg("account") - .arg(account_alias) - .arg("--network") - .arg("testnet") - .arg("--hide-account") - .arg("--data-name") - .arg(data_name) - .assert() - .success() - .stdout_as_str(); - - let parsed: FullLedgerEntries = serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed.entries.is_empty()); - assert_eq!(parsed.entries.len(), 1); - - let (account_id, _) = expected_account_ledger_key(&new_account_addr).await; - - let data_entry = &parsed.entries[0]; - let name_bounded_string = StringM::<64>::try_from(data_name).unwrap(); - let expected_data_key = LedgerKey::Data(LedgerKeyData { - account_id, - data_name: String64::from(name_bounded_string), - }); - assert_eq!(data_entry.key, expected_data_key); - assert!(matches!(data_entry.val, LedgerEntryData::Data { .. })); -} - // contract data tests #[tokio::test] async fn ledger_entry_contract_data() { @@ -250,6 +212,7 @@ async fn ledger_entry_contract_data() { .arg("entry") .arg("fetch") .arg("contract-data") + .arg("--contract") .arg(&contract_id) .arg("--network") .arg("testnet") @@ -268,6 +231,7 @@ async fn ledger_entry_contract_data() { .arg("entry") .arg("fetch") .arg("contract-data") + .arg("--contract") .arg(&contract_id) .arg("--network") .arg("testnet") @@ -334,6 +298,7 @@ async fn ledger_entry_contract_code() { .arg("entry") .arg("fetch") .arg("contract-code") + .arg("--wasm-hash") .arg(&contract_wasm_hash) .arg("--network") .arg("testnet") @@ -437,6 +402,7 @@ async fn ledger_entry_claimable_balance() { .arg("entry") .arg("fetch") .arg("claimable-balance") + .arg("--id") .arg(id.to_string()) .arg("--network") .arg("local") @@ -489,6 +455,7 @@ async fn ledger_entry_liquidity_pool() { .arg("entry") .arg("fetch") .arg("liquidity-pool") + .arg("--id") .arg(pool_id.to_string()) .arg("--network") .arg("local") From 51213fd5475edfdead0cc8d692567b7d48cbcd99 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Tue, 14 Oct 2025 13:03:55 -0400 Subject: [PATCH 72/76] Remove ledger entry config in favor of existing network settings command --- .../tests/it/integration/ledger/entry.rs | 57 -------------- .../src/commands/ledger/entry/fetch/config.rs | 75 ------------------- .../src/commands/ledger/entry/fetch/mod.rs | 7 -- 3 files changed, 139 deletions(-) delete mode 100644 cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 7d0fa50baa..9f62b835c9 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -324,63 +324,6 @@ async fn ledger_entry_contract_code() { )); } -#[tokio::test] -async fn ledger_entry_config_setting_id() { - let sandbox = &TestEnv::new(); - // for individual ids - let output = sandbox - .new_assert_cmd("ledger") - .arg("entry") - .arg("fetch") - .arg("config") - .arg((ConfigSettingId::ContractMaxSizeBytes as i32).to_string()) - .arg((ConfigSettingId::ContractDataEntrySizeBytes as i32).to_string()) - .arg("--network") - .arg("testnet") - .assert() - .success() - .stdout_as_str(); - let parsed_output: FullLedgerEntries = - serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed_output.entries.is_empty()); - - let expected_key_1 = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { - config_setting_id: ConfigSettingId::ContractMaxSizeBytes, - }); - let expected_key_2 = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { - config_setting_id: ConfigSettingId::ContractDataEntrySizeBytes, - }); - assert_eq!(parsed_output.entries[0].key, expected_key_1); - assert_eq!(parsed_output.entries[1].key, expected_key_2); - assert!(matches!( - parsed_output.entries[0].val, - LedgerEntryData::ConfigSetting { .. } - )); - assert!(matches!( - parsed_output.entries[1].val, - LedgerEntryData::ConfigSetting { .. } - )); - - // for all ids - let output = sandbox - .new_assert_cmd("ledger") - .arg("entry") - .arg("fetch") - .arg("config") - .arg("--network") - .arg("testnet") - .assert() - .success() - .stdout_as_str(); - let parsed_output: FullLedgerEntries = - serde_json::from_str(&output).expect("Failed to parse JSON"); - assert!(!parsed_output.entries.is_empty()); - assert_eq!( - parsed_output.entries.len(), - ConfigSettingId::variants().len() - ); -} - #[tokio::test] async fn ledger_entry_claimable_balance() { let sandbox = &TestEnv::new(); diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs deleted file mode 100644 index f081bd8a56..0000000000 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/config.rs +++ /dev/null @@ -1,75 +0,0 @@ -use super::args::Args; -use crate::xdr::{ConfigSettingId, LedgerKey, LedgerKeyConfigSetting}; -use clap::{command, Parser}; -use std::collections::HashMap; -use std::fmt::Debug; - -#[derive(Parser, Debug, Clone)] -#[group(skip)] -pub struct Cmd { - /// Defines the network configuration to fetch - #[arg(long_help = long_help() )] - pub config_setting_ids: Option>, - - #[command(flatten)] - pub args: Args, -} - -fn long_help() -> String { - let mut config_settings = ConfigSettingId::variants(); - config_settings.sort_by_key(|v| *v as i32); - - let config_setting_strings: Vec = config_settings - .iter() - .map(|v| format!("{} => {:?}", *v as i32, v)) - .collect(); - - let setting_options = config_setting_strings.join("\n"); - - format!("Valid config setting IDs (Config Setting ID => Name):\n{setting_options}",) -} - -fn config_setting_variants_to_ids() -> HashMap { - ConfigSettingId::variants() - .iter() - .map(|v| (*v, *v as i32)) - .collect() -} - -#[derive(thiserror::Error, Debug)] -pub enum Error { - #[error("provided config id is invalid: {0}")] - InvalidConfigId(i32), - #[error(transparent)] - Run(#[from] super::args::Error), -} - -impl Cmd { - pub async fn run(&self) -> Result<(), Error> { - let mut ledger_keys = vec![]; - self.insert_keys(&mut ledger_keys)?; - Ok(self.args.run(ledger_keys).await?) - } - - fn insert_keys(&self, ledger_keys: &mut Vec) -> Result<(), Error> { - if let Some(config_setting_id) = &self.config_setting_ids { - for x in config_setting_id { - let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { - config_setting_id: ConfigSettingId::try_from(*x) - .map_err(|_| Error::InvalidConfigId(*x))?, - }); - ledger_keys.push(key); - } - } else { - for (_, d) in config_setting_variants_to_ids() { - let key = LedgerKey::ConfigSetting(LedgerKeyConfigSetting { - config_setting_id: ConfigSettingId::try_from(d) - .map_err(|_| Error::InvalidConfigId(d))?, - }); - ledger_keys.push(key); - } - } - - Ok(()) - } -} diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs index 01871ff9d6..02beca3d15 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/mod.rs @@ -5,7 +5,6 @@ pub mod account; pub mod account_data; pub mod args; pub mod claimable_balance; -pub mod config; pub mod contract_code; pub mod contract_data; pub mod liquidity_pool; @@ -18,9 +17,6 @@ pub enum Cmd { Account(account::Cmd), /// Fetch contract ledger entry by address or alias and storage key. ContractData(contract_data::Cmd), - /// Fetch the current network config by `ConfigSettingId`. - /// All config settings are returned if no id is provided. - Config(config::Cmd), ///Fetch a claimable balance ledger entry by id ClaimableBalance(claimable_balance::Cmd), ///Fetch a liquidity pool ledger entry by id @@ -42,8 +38,6 @@ pub enum Error { #[error(transparent)] ContractData(#[from] contract_data::Error), #[error(transparent)] - Config(#[from] config::Error), - #[error(transparent)] ClaimableBalance(#[from] claimable_balance::Error), #[error(transparent)] LiquidityPool(#[from] liquidity_pool::Error), @@ -62,7 +56,6 @@ impl Cmd { match self { Cmd::Account(cmd) => cmd.run().await?, Cmd::ContractData(cmd) => cmd.run().await?, - Cmd::Config(cmd) => cmd.run().await?, Cmd::ClaimableBalance(cmd) => cmd.run().await?, Cmd::LiquidityPool(cmd) => cmd.run().await?, Cmd::ContractCode(cmd) => cmd.run().await?, From 57cbd0bda793cc01825e0e6279558c03b49dbe69 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 15 Oct 2025 12:54:56 -0400 Subject: [PATCH 73/76] Fix code issues in gen docs --- FULL_HELP_DOCS.md | 4075 ++++++++++++++++++++------------------------- 1 file changed, 1843 insertions(+), 2232 deletions(-) diff --git a/FULL_HELP_DOCS.md b/FULL_HELP_DOCS.md index 178eec6083..d72f74f09b 100644 --- a/FULL_HELP_DOCS.md +++ b/FULL_HELP_DOCS.md @@ -38,41 +38,38 @@ Anything after the `--` double dash (the "slop") is parsed as arguments to the c stellar contract invoke --id CCR6QKTWZQYW6YUJ7UP7XXZRLWQPFRV6SWBLQS4ZQOSAF4BOUD77OTE2 --source alice --network testnet -- hello --to world - **Usage:** `stellar [OPTIONS] ` ###### **Subcommands:** -* `contract` — Tools for smart contract developers -* `doctor` — Diagnose and troubleshoot CLI and network issues -* `events` — Watch the network for contract events -* `env` — Prints the environment variables -* `keys` — Create and manage identities including keys and addresses -* `network` — Configure connection to networks -* `container` — Start local networks in containers -* `config` — Manage cli configuration -* `snapshot` — Download a snapshot of a ledger from an archive -* `tx` — Sign, Simulate, and Send transactions -* `xdr` — Decode and encode XDR -* `completion` — Print shell completion code for the specified shell -* `cache` — Cache for transactions and contract specs -* `version` — Print version information -* `plugin` — The subcommand for CLI plugins -* `ledger` — Fetch ledger information -* `fee-stats` — Fetch network feestats - -###### **Options:** - -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` -* `-q`, `--quiet` — Do not write logs to stderr including `INFO` -* `-v`, `--verbose` — Log DEBUG events -* `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events -* `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` -* `--no-cache` — Do not cache your simulations and transactions - - +- `contract` — Tools for smart contract developers +- `doctor` — Diagnose and troubleshoot CLI and network issues +- `events` — Watch the network for contract events +- `env` — Prints the environment variables +- `keys` — Create and manage identities including keys and addresses +- `network` — Configure connection to networks +- `container` — Start local networks in containers +- `config` — Manage cli configuration +- `snapshot` — Download a snapshot of a ledger from an archive +- `tx` — Sign, Simulate, and Send transactions +- `xdr` — Decode and encode XDR +- `completion` — Print shell completion code for the specified shell +- `cache` — Cache for transactions and contract specs +- `version` — Print version information +- `plugin` — The subcommand for CLI plugins +- `ledger` — Fetch ledger information +- `fee-stats` — Fetch network feestats + +###### **Options:** + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-f`, `--filter-logs ` — Filter logs output. To turn on `stellar_cli::log::footprint=debug` or off `=off`. Can also use env var `RUST_LOG` +- `-q`, `--quiet` — Do not write logs to stderr including `INFO` +- `-v`, `--verbose` — Log DEBUG events +- `--very-verbose` [alias: `vv`] — Log DEBUG and TRACE events +- `--list` — ⚠️ Deprecated, use `stellar plugin ls`. List installed plugins. E.g. `stellar-hello` +- `--no-cache` — Do not cache your simulations and transactions ## `stellar contract` @@ -82,25 +79,23 @@ Tools for smart contract developers ###### **Subcommands:** -* `asset` — Utilities to deploy a Stellar Asset Contract or get its id -* `alias` — Utilities to manage contract aliases -* `bindings` — Generate code client bindings for a contract -* `build` — Build a contract from source -* `extend` — Extend the time to live ledger of a contract-data ledger entry -* `deploy` — Deploy a wasm contract -* `fetch` — Fetch a contract's Wasm binary -* `id` — Generate the contract id for a given contract or asset -* `info` — Access info about contracts -* `init` — Initialize a Soroban contract project -* `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc -* `upload` — Install a WASM file to the ledger without creating a contract instance -* `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance -* `invoke` — Invoke a contract function -* `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file -* `read` — Print the current value of a contract-data ledger entry -* `restore` — Restore an evicted value for a contract-data legder entry - - +- `asset` — Utilities to deploy a Stellar Asset Contract or get its id +- `alias` — Utilities to manage contract aliases +- `bindings` — Generate code client bindings for a contract +- `build` — Build a contract from source +- `extend` — Extend the time to live ledger of a contract-data ledger entry +- `deploy` — Deploy a wasm contract +- `fetch` — Fetch a contract's Wasm binary +- `id` — Generate the contract id for a given contract or asset +- `info` — Access info about contracts +- `init` — Initialize a Soroban contract project +- `inspect` — ⚠️ Deprecated, use `contract info`. Inspect a WASM file listing contract functions, meta, etc +- `upload` — Install a WASM file to the ledger without creating a contract instance +- `install` — ⚠️ Deprecated, use `contract upload`. Install a WASM file to the ledger without creating a contract instance +- `invoke` — Invoke a contract function +- `optimize` — ⚠️ Deprecated, use `build --optimize`. Optimize a WASM file +- `read` — Print the current value of a contract-data ledger entry +- `restore` — Restore an evicted value for a contract-data legder entry ## `stellar contract asset` @@ -110,10 +105,8 @@ Utilities to deploy a Stellar Asset Contract or get its id ###### **Subcommands:** -* `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead -* `deploy` — Deploy builtin Soroban Asset Contract - - +- `id` — Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id asset` instead +- `deploy` — Deploy builtin Soroban Asset Contract ## `stellar contract asset id` @@ -123,15 +116,13 @@ Get Id of builtin Soroban Asset Contract. Deprecated, use `stellar contract id a ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract asset deploy` @@ -141,28 +132,27 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "USDC:G...5" +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--alias ` — The alias that will be used to save the assets's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract alias` @@ -172,12 +162,10 @@ Utilities to manage contract aliases ###### **Subcommands:** -* `remove` — Remove contract alias -* `add` — Add contract alias -* `show` — Show the contract id associated with a given alias -* `ls` — List all aliases - - +- `remove` — Remove contract alias +- `add` — Add contract alias +- `show` — Show the contract id associated with a given alias +- `ls` — List all aliases ## `stellar contract alias remove` @@ -187,18 +175,16 @@ Remove contract alias ###### **Arguments:** -* `` — The contract alias that will be removed +- `` — The contract alias that will be removed ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract alias add` @@ -208,20 +194,18 @@ Add contract alias ###### **Arguments:** -* `` — The contract alias that will be used +- `` — The contract alias that will be used ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--overwrite` — Overwrite the contract alias if it already exists -* `--id ` — The contract id that will be associated with the alias - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--overwrite` — Overwrite the contract alias if it already exists +- `--id ` — The contract id that will be associated with the alias ## `stellar contract alias show` @@ -231,18 +215,16 @@ Show the contract id associated with a given alias ###### **Arguments:** -* `` — The contract alias that will be displayed +- `` — The contract alias that will be displayed ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract alias ls` @@ -252,10 +234,8 @@ List all aliases ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract bindings` @@ -265,16 +245,14 @@ Generate code client bindings for a contract ###### **Subcommands:** -* `json` — Generate Json Bindings -* `rust` — Generate Rust bindings -* `typescript` — Generate a TypeScript / JavaScript package -* `python` — Generate Python bindings -* `java` — Generate Java bindings -* `flutter` — Generate Flutter bindings -* `swift` — Generate Swift bindings -* `php` — Generate PHP bindings - - +- `json` — Generate Json Bindings +- `rust` — Generate Rust bindings +- `typescript` — Generate a TypeScript / JavaScript package +- `python` — Generate Python bindings +- `java` — Generate Java bindings +- `flutter` — Generate Flutter bindings +- `swift` — Generate Swift bindings +- `php` — Generate PHP bindings ## `stellar contract bindings json` @@ -284,9 +262,7 @@ Generate Json Bindings ###### **Options:** -* `--wasm ` — Path to wasm binary - - +- `--wasm ` — Path to wasm binary ## `stellar contract bindings rust` @@ -296,9 +272,7 @@ Generate Rust bindings ###### **Options:** -* `--wasm ` — Path to wasm binary - - +- `--wasm ` — Path to wasm binary ## `stellar contract bindings typescript` @@ -308,19 +282,17 @@ Generate a TypeScript / JavaScript package ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output-dir ` — Where to place generated project -* `--overwrite` — Whether to overwrite output directory if it already exists - - +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output-dir ` — Where to place generated project +- `--overwrite` — Whether to overwrite output directory if it already exists ## `stellar contract bindings python` @@ -328,40 +300,30 @@ Generate Python bindings **Usage:** `stellar contract bindings python` - - ## `stellar contract bindings java` Generate Java bindings **Usage:** `stellar contract bindings java` - - ## `stellar contract bindings flutter` Generate Flutter bindings **Usage:** `stellar contract bindings flutter` - - ## `stellar contract bindings swift` Generate Swift bindings **Usage:** `stellar contract bindings swift` - - ## `stellar contract bindings php` Generate PHP bindings **Usage:** `stellar contract bindings php` - - ## `stellar contract build` Build a contract from source @@ -376,26 +338,27 @@ To view the commands that will be executed, without executing them, use the --pr ###### **Options:** -* `--manifest-path ` — Path to Cargo.toml -* `--package ` — Package to build +- `--manifest-path ` — Path to Cargo.toml +- `--package ` — Package to build + + If omitted, all packages that build for crate-type cdylib are built. - If omitted, all packages that build for crate-type cdylib are built. -* `--profile ` — Build with the specified profile +- `--profile ` — Build with the specified profile Default value: `release` -* `--features ` — Build with the list of features activated, space or comma separated -* `--all-features` — Build with the all features activated -* `--no-default-features` — Build with the default feature not activated -* `--out-dir ` — Directory to copy wasm files to - If provided, wasm files can be found in the cargo target directory, and the specified directory. +- `--features ` — Build with the list of features activated, space or comma separated +- `--all-features` — Build with the all features activated +- `--no-default-features` — Build with the default feature not activated +- `--out-dir ` — Directory to copy wasm files to - If ommitted, wasm files are written only to the cargo target directory. -* `--print-commands-only` — Print commands to build without executing them -* `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) -* `--optimize` — Optimize the generated wasm + If provided, wasm files can be found in the cargo target directory, and the specified directory. + If ommitted, wasm files are written only to the cargo target directory. +- `--print-commands-only` — Print commands to build without executing them +- `--meta ` — Add key-value to contract meta (adds the meta to the `contractmetav0` custom section) +- `--optimize` — Optimize the generated wasm ## `stellar contract extend` @@ -407,43 +370,40 @@ If no keys are specified the contract itself is extended. ###### **Options:** -* `--ledgers-to-extend ` — Number of ledgers to extend the entries -* `--ttl-ledger-only` — Only print the new Time To Live ledger -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability +- `--ledgers-to-extend ` — Number of ledgers to extend the entries +- `--ttl-ledger-only` — Only print the new Time To Live ledger +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: Persistent + - `temporary`: Temporary + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar contract deploy` @@ -453,37 +413,37 @@ Deploy a wasm contract ###### **Arguments:** -* `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` +- `` — If provided, will be passed to the contract's `__constructor` function with provided arguments for that function as `--arg-name value` ###### **Options:** -* `--wasm ` — WASM file to deploy -* `--wasm-hash ` — Hash of the already installed/deployed WASM file -* `--salt ` — Custom salt 32-byte salt for the token id -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--wasm ` — WASM file to deploy +- `--wasm-hash ` — Hash of the already installed/deployed WASM file +- `--salt ` — Custom salt 32-byte salt for the token id +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `-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 +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + Default value: `false` +- `--alias ` — The alias that will be used to save the contract's id. Whenever used, `--alias` will always overwrite the existing contract id configuration without asking for confirmation ## `stellar contract fetch` @@ -493,17 +453,15 @@ Fetch a contract's Wasm binary ###### **Options:** -* `--id ` — Contract ID to fetch -* `--wasm-hash ` — Wasm to fetch -* `-o`, `--out-file ` — Where to write output otherwise stdout is used -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--id ` — Contract ID to fetch +- `--wasm-hash ` — Wasm to fetch +- `-o`, `--out-file ` — Where to write output otherwise stdout is used +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar contract id` @@ -513,10 +471,8 @@ Generate the contract id for a given contract or asset ###### **Subcommands:** -* `asset` — Deploy builtin Soroban Asset Contract -* `wasm` — Deploy normal Wasm Contract - - +- `asset` — Deploy builtin Soroban Asset Contract +- `wasm` — Deploy normal Wasm Contract ## `stellar contract id asset` @@ -526,15 +482,13 @@ Deploy builtin Soroban Asset Contract ###### **Options:** -* `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--asset ` — ID of the Stellar classic asset to wrap, e.g. "native", "USDC:G...5", "USDC:alias" +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract id wasm` @@ -544,20 +498,18 @@ Deploy normal Wasm Contract ###### **Options:** -* `--salt ` — ID of the Soroban contract -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet - - +- `--salt ` — ID of the Soroban contract +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar contract info` @@ -567,12 +519,10 @@ Access info about contracts ###### **Subcommands:** -* `interface` — Output the interface of a contract -* `meta` — Output the metadata stored in a contract -* `env-meta` — Output the env required metadata stored in a contract -* `build` — Output the contract build information, if available - - +- `interface` — Output the interface of a contract +- `meta` — Output the metadata stored in a contract +- `env-meta` — Output the env required metadata stored in a contract +- `build` — Output the contract build information, if available ## `stellar contract info interface` @@ -588,31 +538,24 @@ Outputs no data when no data is present in the contract. ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `rust` Possible values: - - `rust`: - Rust code output of the contract interface - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - - - + - `rust`: Rust code output of the contract interface + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ## `stellar contract info meta` @@ -628,31 +571,24 @@ Outputs no data when no data is present in the contract. ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of the meta info entry - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - - - + - `text`: Text output of the meta info entry + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ## `stellar contract info env-meta` @@ -668,31 +604,24 @@ Outputs no data when no data is present in the contract. ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of the meta info entry - - `xdr-base64`: - XDR output of the info entry - - `json`: - JSON output of the info entry (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the info entry - - - + - `text`: Text output of the meta info entry + - `xdr-base64`: XDR output of the info entry + - `json`: JSON output of the info entry (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the info entry ## `stellar contract info build` @@ -704,17 +633,15 @@ If the contract has a meta entry like `source_repo=github:user/repo`, this comma ###### **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` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--wasm ` — Wasm file path on local filesystem. Provide this OR `--wasm-hash` OR `--contract-id` +- `--wasm-hash ` — Hash of Wasm blob on a network. Provide this OR `--wasm` OR `--contract-id` +- `--contract-id ` [alias: `id`] — Contract ID/alias on a network. Provide this OR `--wasm-hash` OR `--wasm` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract init` @@ -726,16 +653,15 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Arguments:** -* `` +- `` ###### **Options:** -* `--name ` — An optional flag to specify a new contract's name. +- `--name ` — An optional flag to specify a new contract's name. Default value: `hello-world` -* `--overwrite` — Overwrite all existing files. - +- `--overwrite` — Overwrite all existing files. ## `stellar contract inspect` @@ -745,23 +671,18 @@ This command will create a Cargo workspace project and add a sample Stellar cont ###### **Options:** -* `--wasm ` — Path to wasm binary -* `--output ` — Output just XDR in base64 +- `--wasm ` — Path to wasm binary +- `--output ` — Output just XDR in base64 Default value: `docs` Possible values: - - `xdr-base64`: - XDR of array of contract spec entries - - `xdr-base64-array`: - Array of xdr of contract spec entries - - `docs`: - Pretty print of contract spec entries - -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - + - `xdr-base64`: XDR of array of contract spec entries + - `xdr-base64-array`: Array of xdr of contract spec entries + - `docs`: Pretty print of contract spec entries +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract upload` @@ -771,30 +692,29 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--wasm ` — Path to wasm binary -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts - - Default value: `false` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--wasm ` — Path to wasm binary +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + Default value: `false` ## `stellar contract install` @@ -804,30 +724,29 @@ Install a WASM file to the ledger without creating a contract instance ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--wasm ` — Path to wasm binary -* `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts - - Default value: `false` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--wasm ` — Path to wasm binary +- `-i`, `--ignore-checks` — Whether to ignore safety checks when deploying contracts + Default value: `false` ## `stellar contract invoke` @@ -841,44 +760,39 @@ stellar contract invoke ... -- --help ###### **Arguments:** -* `` — Function name as subcommand, then arguments for that function as `--arg-name value` +- `` — Function name as subcommand, then arguments for that function as `--arg-name value` ###### **Options:** -* `--id ` — Contract ID to invoke -* `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--id ` — Contract ID to invoke +- `--is-view` — ⚠️ Deprecated, use `--send=no`. View the result simulating and do not sign and submit transaction +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--send ` — Whether or not to send a transaction + +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--send ` — Whether or not to send a transaction Default value: `default` Possible values: - - `default`: - Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result - - `no`: - Do not send transaction, return simulation result - - `yes`: - Always send transaction - - - + - `default`: Send transaction if simulation indicates there are ledger writes, published events, or auth required, otherwise return simulation result + - `no`: Do not send transaction, return simulation result + - `yes`: Always send transaction ## `stellar contract optimize` @@ -888,10 +802,8 @@ stellar contract invoke ... -- --help ###### **Options:** -* `--wasm ` — Path to one or more wasm binaries -* `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) - - +- `--wasm ` — Path to one or more wasm binaries +- `--wasm-out ` — Path to write the optimized WASM file to (defaults to same location as --wasm with .optimized.wasm suffix) ## `stellar contract read` @@ -901,41 +813,34 @@ Print the current value of a contract-data ledger entry ###### **Options:** -* `--output ` — Type of output to generate +- `--output ` — Type of output to generate Default value: `string` Possible values: - - `string`: - String - - `json`: - Json - - `xdr`: - XDR - -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability + - `string`: String + - `json`: Json + - `xdr`: XDR + +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - + - `persistent`: Persistent + - `temporary`: Temporary +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar contract restore` @@ -947,43 +852,40 @@ If no keys are specificed the contract itself is restored. ###### **Options:** -* `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) -* `--wasm ` — Path to Wasm file of contract code to extend -* `--wasm-hash ` — Path to Wasm file of contract code to extend -* `--durability ` — Storage entry durability +- `--id ` — Contract ID to which owns the data entries. If no keys provided the Contract's instance will be extended +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) +- `--wasm ` — Path to Wasm file of contract code to extend +- `--wasm-hash ` — Path to Wasm file of contract code to extend +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--ledgers-to-extend ` — Number of ledgers to extend the entry -* `--ttl-ledger-only` — Only print the new Time To Live ledger -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm + - `persistent`: Persistent + - `temporary`: Temporary + +- `--ledgers-to-extend ` — Number of ledgers to extend the entry +- `--ttl-ledger-only` — Only print the new Time To Live ledger +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout ## `stellar doctor` @@ -993,10 +895,8 @@ Diagnose and troubleshoot CLI and network issues ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar events` @@ -1006,47 +906,45 @@ Watch the network for contract events ###### **Options:** -* `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence -* `--cursor ` — The cursor corresponding to the start of the event range -* `--output ` — Output formatting options for event stream +- `--start-ledger ` — The first ledger sequence number in the range to pull events https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/ledger-headers#ledger-sequence +- `--cursor ` — The cursor corresponding to the start of the event range +- `--output ` — Output formatting options for event stream Default value: `pretty` Possible values: - - `pretty`: - Colorful, human-oriented console output - - `plain`: - Human-oriented console output without colors - - `json`: - JSON formatted console output + - `pretty`: Colorful, human-oriented console output + - `plain`: Human-oriented console output without colors + - `json`: JSON formatted console output -* `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) +- `-c`, `--count ` — The maximum number of events to display (defer to the server-defined limit) Default value: `10` -* `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. - Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. -* `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. +- `--id ` — A set of (up to 5) contract IDs to filter events on. This parameter can be passed multiple times, e.g. `--id C123.. --id C456..`, or passed with multiple parameters, e.g. `--id C123 C456`. - **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` + Though the specification supports multiple filter objects (i.e. combinations of type, IDs, and topics), only one set can be specified on the command-line today, though that set can have multiple IDs/topics. - **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` +- `--topic ` — A set of (up to 4) topic filters to filter event topics on. A single topic filter can contain 1-4 different segment filters, separated by commas, with an asterisk (`*` character) indicating a wildcard segment. - Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). -* `--type ` — Specifies which type of contract events to display + **Example:** topic filter with two segments: `--topic "AAAABQAAAAdDT1VOVEVSAA==,*"` - Default value: `all` + **Example:** two topic filters with one and two segments each: `--topic "AAAABQAAAAdDT1VOVEVSAA==" --topic '*,*'` - Possible values: `all`, `contract`, `system` + Note that all of these topic filters are combined with the contract IDs into a single filter (i.e. combination of type, IDs, and topics). -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config +- `--type ` — Specifies which type of contract events to display + Default value: `all` + Possible values: `all`, `contract`, `system` + +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar env` @@ -1062,16 +960,14 @@ If there are no environment variables in use, prints the defaults. ###### **Arguments:** -* `` — Env variable name to get the value of. +- `` — Env variable name to get the value of. - E.g.: $ stellar env STELLAR_ACCOUNT + E.g.: $ stellar env STELLAR_ACCOUNT ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys` @@ -1081,16 +977,14 @@ Create and manage identities including keys and addresses ###### **Subcommands:** -* `add` — Add a new identity (keypair, ledger, OS specific secure store) -* `public-key` — Given an identity return its address (public key) -* `fund` — Fund an identity on a test network -* `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store -* `ls` — List identities -* `rm` — Remove an identity -* `secret` — Output an identity's secret key -* `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it - - +- `add` — Add a new identity (keypair, ledger, OS specific secure store) +- `public-key` — Given an identity return its address (public key) +- `fund` — Fund an identity on a test network +- `generate` — Generate a new identity using a 24-word seed phrase The seed phrase can be stored in a config file (default) or in an OS-specific secure store +- `ls` — List identities +- `rm` — Remove an identity +- `secret` — Output an identity's secret key +- `use` — Set the default identity that will be used on all commands. This allows you to skip `--source-account` or setting a environment variable, while reusing this value in all commands that require it ## `stellar keys add` @@ -1100,23 +994,22 @@ Add a new identity (keypair, ledger, OS specific secure store) ###### **Arguments:** -* `` — Name of identity +- `` — Name of identity ###### **Options:** -* `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted -* `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase -* `--secure-store` — Save the new key in your OS's credential secure store. - - On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. +- `--secret-key` — ⚠️ Deprecated, use `--secure-store`. Enter secret (S) key when prompted +- `--seed-phrase` — ⚠️ Deprecated, use `--secure-store`. Enter key using 12-24 word seed phrase +- `--secure-store` — Save the new key in your OS's credential secure store. - This only supports seed phrases for now. -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. -* `--overwrite` — Overwrite existing identity if it already exists + On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. + This only supports seed phrases for now. +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--public-key ` — Add a public key, ed25519, or muxed account, e.g. G1.., M2.. +- `--overwrite` — Overwrite existing identity if it already exists ## `stellar keys public-key` @@ -1128,15 +1021,13 @@ Given an identity return its address (public key) ###### **Arguments:** -* `` — Name of identity to lookup, default test identity used if not provided +- `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys fund` @@ -1146,19 +1037,17 @@ Fund an identity on a test network ###### **Arguments:** -* `` — Name of identity to lookup, default test identity used if not provided +- `` — Name of identity to lookup, default test identity used if not provided ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys generate` @@ -1168,28 +1057,28 @@ Generate a new identity using a 24-word seed phrase The seed phrase can be store ###### **Arguments:** -* `` — Name of identity +- `` — Name of identity ###### **Options:** -* `--seed ` — Optional seed to use when generating seed phrase. Random otherwise -* `-s`, `--as-secret` — Output the generated identity as a secret key -* `--secure-store` — Save the new key in your OS's credential secure store. +- `--seed ` — Optional seed to use when generating seed phrase. Random otherwise +- `-s`, `--as-secret` — Output the generated identity as a secret key +- `--secure-store` — Save the new key in your OS's credential secure store. - On Mac this uses Keychain, on Windows it is Secure Store Service, and on *nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--fund` — Fund generated key pair + On Mac this uses Keychain, on Windows it is Secure Store Service, and on \*nix platforms it uses a combination of the kernel keyutils and DBus-based Secret Service. - Default value: `false` -* `--overwrite` — Overwrite existing identity if it already exists +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--hd-path ` — When generating a secret key, which `hd_path` should be used from the original `seed_phrase` +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--fund` — Fund generated key pair + Default value: `false` +- `--overwrite` — Overwrite existing identity if it already exists ## `stellar keys ls` @@ -1199,11 +1088,9 @@ List identities ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-l`, `--long` - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` ## `stellar keys rm` @@ -1213,14 +1100,12 @@ Remove an identity ###### **Arguments:** -* `` — Identity to remove +- `` — Identity to remove ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys secret` @@ -1230,16 +1115,14 @@ Output an identity's secret key ###### **Arguments:** -* `` — Name of identity to lookup, default is test identity +- `` — Name of identity to lookup, default is test identity ###### **Options:** -* `--phrase` — Output seed phrase instead of private key -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--phrase` — Output seed phrase instead of private key +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar keys use` @@ -1249,14 +1132,12 @@ Set the default identity that will be used on all commands. This allows you to s ###### **Arguments:** -* `` — Set the default network name +- `` — Set the default network name ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network` @@ -1266,15 +1147,13 @@ Configure connection to networks ###### **Subcommands:** -* `add` — Add a new network -* `rm` — Remove a network -* `ls` — List networks -* `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it -* `health` — Fetch the health of the configured RPC -* `info` — Checks the health of the configured RPC -* `settings` — Fetch the network's config settings - - +- `add` — Add a new network +- `rm` — Remove a network +- `ls` — List networks +- `use` — Set the default network that will be used on all commands. This allows you to skip `--network` or setting a environment variable, while reusing this value in all commands that require it +- `health` — Fetch the health of the configured RPC +- `info` — Checks the health of the configured RPC +- `settings` — Fetch the network's config settings ## `stellar network add` @@ -1284,17 +1163,15 @@ Add a new network ###### **Arguments:** -* `` — Name of network +- `` — Name of network ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — Optional header (e.g. API Key) to include in requests to the RPC +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network rm` @@ -1304,14 +1181,12 @@ Remove a network ###### **Arguments:** -* `` — Network to remove +- `` — Network to remove ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network ls` @@ -1321,11 +1196,9 @@ List networks ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-l`, `--long` — Get more info about the networks - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` — Get more info about the networks ## `stellar network use` @@ -1335,14 +1208,12 @@ Set the default network that will be used on all commands. This allows you to sk ###### **Arguments:** -* `` — Set the default network name +- `` — Set the default network name ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar network health` @@ -1352,26 +1223,20 @@ Fetch the health of the configured RPC ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network health status - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - + - `text`: Text output of network health status + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ## `stellar network info` @@ -1381,26 +1246,20 @@ Checks the health of the configured RPC ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ## `stellar network settings` @@ -1410,27 +1269,21 @@ Fetch the network's config settings ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--internal` — Include internal config settings that are not upgradeable and are internally maintained by the network +- `--output ` — Format of the output Default value: `json` Possible values: - - `xdr`: - XDR (`ConfigUpgradeSet` type) - - `json`: - JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type - - `json-formatted`: - JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type - - - + - `xdr`: XDR (`ConfigUpgradeSet` type) + - `json`: JSON, XDR-JSON of the `ConfigUpgradeSet` XDR type + - `json-formatted`: JSON formatted, XDR-JSON of the `ConfigUpgradeSet` XDR type ## `stellar container` @@ -1440,11 +1293,9 @@ Start local networks in containers ###### **Subcommands:** -* `logs` — Get logs from a running network container -* `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) -* `stop` — Stop a network container started with `stellar container start` - - +- `logs` — Get logs from a running network container +- `start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet) +- `stop` — Stop a network container started with `stellar container start` ## `stellar container logs` @@ -1454,15 +1305,13 @@ Get logs from a running network container ###### **Arguments:** -* `` — Container to get logs from +- `` — Container to get logs from Default value: `local` ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock - - +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar container start` @@ -1478,23 +1327,21 @@ By default, when starting a testnet container, without any optional arguments, i ###### **Arguments:** -* `` — Network to start. Default is `local` +- `` — Network to start. Default is `local` Possible values: `local`, `testnet`, `futurenet`, `pubnet` - ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock -* `--name ` — Optional argument to specify the container name -* `-l`, `--limits ` — Optional argument to specify the limits for the local network only -* `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock +- `--name ` — Optional argument to specify the container name +- `-l`, `--limits ` — Optional argument to specify the limits for the local network only +- `-p`, `--ports-mapping ` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping Default value: `8000:8000` -* `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network -* `--protocol-version ` — Optional argument to specify the protocol version for the local network only - +- `-t`, `--image-tag-override ` — Optional argument to override the default docker image tag for the given network +- `--protocol-version ` — Optional argument to specify the protocol version for the local network only ## `stellar container stop` @@ -1504,15 +1351,13 @@ Stop a network container started with `stellar container start` ###### **Arguments:** -* `` — Container to stop +- `` — Container to stop Default value: `local` ###### **Options:** -* `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock - - +- `-d`, `--docker-host ` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock ## `stellar config` @@ -1522,10 +1367,8 @@ Manage cli configuration ###### **Subcommands:** -* `migrate` — Migrate the local configuration to the global directory -* `dir` — Show the global configuration directory - - +- `migrate` — Migrate the local configuration to the global directory +- `dir` — Show the global configuration directory ## `stellar config migrate` @@ -1535,10 +1378,8 @@ Migrate the local configuration to the global directory ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar config dir` @@ -1552,10 +1393,8 @@ The location will depend on how your system is configured. ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar snapshot` @@ -1565,9 +1404,7 @@ Download a snapshot of a ledger from an archive ###### **Subcommands:** -* `create` — Create a ledger snapshot using a history archive - - +- `create` — Create a ledger snapshot using a history archive ## `stellar snapshot create` @@ -1587,25 +1424,24 @@ Any invalid contract id passed as `--address` will be ignored. ###### **Options:** -* `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger -* `--address
` — Account or contract address/alias to include in the snapshot -* `--wasm-hash ` — WASM hashes to include in the snapshot -* `--output ` — Format of the out file +- `--ledger ` — The ledger sequence number to snapshot. Defaults to latest history archived ledger +- `--address
` — Account or contract address/alias to include in the snapshot +- `--wasm-hash ` — WASM hashes to include in the snapshot +- `--output ` — Format of the out file Possible values: `json` -* `--out ` — Out path that the snapshot is written to +- `--out ` — Out path that the snapshot is written to Default value: `snapshot.json` -* `--archive-url ` — Archive URL -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - +- `--archive-url ` — Archive URL +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx` @@ -1615,19 +1451,17 @@ Sign, Simulate, and Send transactions ###### **Subcommands:** -* `update` — Update the transaction -* `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order -* `hash` — Calculate the hash of a transaction envelope -* `new` — Create a new transaction -* `operation` — Manipulate the operations in a transaction, including adding new operations -* `send` — Send a transaction envelope to the network -* `sign` — Sign a transaction envelope appending the signature to the envelope -* `simulate` — Simulate a transaction envelope from stdin -* `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -* `decode` — Decode a transaction envelope from XDR to JSON -* `encode` — Encode a transaction envelope from JSON to XDR - - +- `update` — Update the transaction +- `edit` — Edit a transaction envelope from stdin. This command respects the environment variables `STELLAR_EDITOR`, `EDITOR` and `VISUAL`, in that order +- `hash` — Calculate the hash of a transaction envelope +- `new` — Create a new transaction +- `operation` — Manipulate the operations in a transaction, including adding new operations +- `send` — Send a transaction envelope to the network +- `sign` — Sign a transaction envelope appending the signature to the envelope +- `simulate` — Simulate a transaction envelope from stdin +- `fetch` — Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned +- `decode` — Decode a transaction envelope from XDR to JSON +- `encode` — Encode a transaction envelope from JSON to XDR ## `stellar tx update` @@ -1637,9 +1471,7 @@ Update the transaction ###### **Subcommands:** -* `sequence-number` — Edit the sequence number on a transaction - - +- `sequence-number` — Edit the sequence number on a transaction ## `stellar tx update sequence-number` @@ -1651,9 +1483,7 @@ Edit the sequence number on a transaction ###### **Subcommands:** -* `next` — Fetch the source account's seq-num and increment for the given tx - - +- `next` — Fetch the source account's seq-num and increment for the given tx ## `stellar tx update sequence-number next` @@ -1663,14 +1493,12 @@ Fetch the source account's seq-num and increment for the given tx ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar tx edit` @@ -1686,8 +1514,6 @@ $ stellar tx new manage-data --data-name hello --build-only | stellar tx edit **Usage:** `stellar tx edit` - - ## `stellar tx hash` Calculate the hash of a transaction envelope @@ -1696,16 +1522,14 @@ Calculate the hash of a transaction envelope ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config ## `stellar tx new` @@ -1715,30 +1539,28 @@ Create a new transaction ###### **Subcommands:** -* `account-merge` — Transfer XLM balance to another account and remove source account -* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -* `bump-sequence` — Bump sequence number to invalidate older transactions -* `change-trust` — Create, update, or delete a trustline -* `claim-claimable-balance` — Claim a claimable balance by its balance ID -* `clawback` — Clawback an asset from an account -* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -* `create-account` — Create and fund a new account -* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -* `end-sponsoring-future-reserves` — End sponsoring future reserves -* `liquidity-pool-deposit` — Deposit assets into a liquidity pool -* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -* `manage-buy-offer` — Create, update, or delete a buy offer -* `manage-data` — Set, modify, or delete account data entries -* `manage-sell-offer` — Create, update, or delete a sell offer -* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -* `payment` — Send asset to destination account -* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -* `set-options` — Set account options like flags, signers, and home domain -* `set-trustline-flags` — Configure authorization and trustline flags for an asset - - +- `account-merge` — Transfer XLM balance to another account and remove source account +- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +- `bump-sequence` — Bump sequence number to invalidate older transactions +- `change-trust` — Create, update, or delete a trustline +- `claim-claimable-balance` — Claim a claimable balance by its balance ID +- `clawback` — Clawback an asset from an account +- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +- `create-account` — Create and fund a new account +- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +- `end-sponsoring-future-reserves` — End sponsoring future reserves +- `liquidity-pool-deposit` — Deposit assets into a liquidity pool +- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +- `manage-buy-offer` — Create, update, or delete a buy offer +- `manage-data` — Set, modify, or delete account data entries +- `manage-sell-offer` — Create, update, or delete a sell offer +- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +- `payment` — Send asset to destination account +- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +- `set-options` — Set account options like flags, signers, and home domain +- `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx new account-merge` @@ -1748,27 +1570,26 @@ Transfer XLM balance to another account and remove source account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx new begin-sponsoring-future-reserves` @@ -1778,27 +1599,26 @@ Begin sponsoring future reserves for another account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--sponsored-id ` — Account that will be sponsored - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--sponsored-id ` — Account that will be sponsored ## `stellar tx new bump-sequence` @@ -1808,27 +1628,26 @@ Bump sequence number to invalidate older transactions ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--bump-to ` — Sequence number to bump to - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--bump-to ` — Sequence number to bump to ## `stellar tx new change-trust` @@ -1838,30 +1657,29 @@ Create, update, or delete a trustline ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--line ` -* `--limit ` — Limit for the trust line, 0 to remove the trust line - - Default value: `9223372036854775807` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line + Default value: `9223372036854775807` ## `stellar tx new claim-claimable-balance` @@ -1871,27 +1689,26 @@ Claim a claimable balance by its balance ID ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx new clawback` @@ -1901,29 +1718,28 @@ Clawback an asset from an account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--from ` — Account to clawback assets from, e.g. `GBX...` +- `--asset ` — Asset to clawback +- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx new clawback-claimable-balance` @@ -1933,27 +1749,26 @@ Clawback a claimable balance by its balance ID ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx new create-account` @@ -1963,30 +1778,29 @@ Create and fund a new account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--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-claimable-balance` @@ -1996,35 +1810,34 @@ Create a claimable balance that can be claimed by specified accounts ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--asset ` — Asset to be held in the ClaimableBalanceEntry - Default value: `native` -* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - - Examples: +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--asset ` — Asset to be held in the ClaimableBalanceEntry - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + Default value: `native` +- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + Examples: + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx new create-passive-sell-offer` @@ -2034,30 +1847,29 @@ Create a passive sell offer on the Stellar DEX ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx new end-sponsoring-future-reserves` @@ -2067,26 +1879,25 @@ End sponsoring future reserves ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx new liquidity-pool-deposit` @@ -2096,35 +1907,35 @@ Deposit assets into a liquidity pool ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--liquidity-pool-id ` — Liquidity pool ID to deposit to -* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` -* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--liquidity-pool-id ` — Liquidity pool ID to deposit to +- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` +- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` ## `stellar tx new liquidity-pool-withdraw` @@ -2134,30 +1945,29 @@ Withdraw assets from a liquidity pool ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--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 ## `stellar tx new manage-buy-offer` @@ -2167,33 +1977,32 @@ Create, update, or delete a buy offer ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx new manage-data` @@ -2203,28 +2012,27 @@ Set, modify, or delete account data entries ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx new manage-sell-offer` @@ -2234,33 +2042,32 @@ Create, update, or delete a sell offer ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx new path-payment-strict-send` @@ -2270,32 +2077,31 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new path-payment-strict-receive` @@ -2305,32 +2111,31 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx new payment` @@ -2340,31 +2145,31 @@ Send asset to destination account ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--destination ` — Account to send to, e.g. `GBX...` -* `--asset ` — Asset to send, default native, e.i. XLM - Default value: `native` -* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--destination ` — Account to send to, e.g. `GBX...` +- `--asset ` — Asset to send, default native, e.i. XLM + Default value: `native` +- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx new revoke-sponsorship` @@ -2374,33 +2179,32 @@ Revoke sponsorship of a ledger entry or signer ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account-id ` — Account ID (required for all sponsorship types) -* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -* `--data-name ` — Data name for data entry sponsorship -* `--offer-id ` — Offer ID for offer sponsorship -* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -* `--signer-key ` — Signer key for signer sponsorship - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account-id ` — Account ID (required for all sponsorship types) +- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +- `--data-name ` — Data name for data entry sponsorship +- `--offer-id ` — Offer ID for offer sponsorship +- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx new set-options` @@ -2410,42 +2214,41 @@ Set account options like flags, signers, and home domain ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--inflation-dest ` — Account of the inflation destination -* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -* `--signer ` — Add, update, or remove a signer from an account -* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -* `--clear-required` -* `--clear-revocable` -* `--clear-immutable` -* `--clear-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--inflation-dest ` — Account of the inflation destination +- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +- `--signer ` — Add, update, or remove a signer from an account +- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +- `--clear-required` +- `--clear-revocable` +- `--clear-immutable` +- `--clear-clawback-enabled` ## `stellar tx new set-trustline-flags` @@ -2455,34 +2258,33 @@ Configure authorization and trustline flags for an asset ###### **Options:** -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -* `--asset ` — Asset to set trustline flags for -* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -* `--clear-authorize` -* `--clear-authorize-to-maintain-liabilities` -* `--clear-trustline-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +- `--asset ` — Asset to set trustline flags for +- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +- `--clear-authorize` +- `--clear-authorize-to-maintain-liabilities` +- `--clear-trustline-clawback-enabled` ## `stellar tx operation` @@ -2494,9 +2296,7 @@ Manipulate the operations in a transaction, including adding new operations ###### **Subcommands:** -* `add` — Add Operation to a transaction - - +- `add` — Add Operation to a transaction ## `stellar tx operation add` @@ -2506,30 +2306,28 @@ Add Operation to a transaction ###### **Subcommands:** -* `account-merge` — Transfer XLM balance to another account and remove source account -* `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account -* `bump-sequence` — Bump sequence number to invalidate older transactions -* `change-trust` — Create, update, or delete a trustline -* `claim-claimable-balance` — Claim a claimable balance by its balance ID -* `clawback` — Clawback an asset from an account -* `clawback-claimable-balance` — Clawback a claimable balance by its balance ID -* `create-account` — Create and fund a new account -* `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts -* `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX -* `end-sponsoring-future-reserves` — End sponsoring future reserves -* `liquidity-pool-deposit` — Deposit assets into a liquidity pool -* `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool -* `manage-buy-offer` — Create, update, or delete a buy offer -* `manage-data` — Set, modify, or delete account data entries -* `manage-sell-offer` — Create, update, or delete a sell offer -* `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount -* `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount -* `payment` — Send asset to destination account -* `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer -* `set-options` — Set account options like flags, signers, and home domain -* `set-trustline-flags` — Configure authorization and trustline flags for an asset - - +- `account-merge` — Transfer XLM balance to another account and remove source account +- `begin-sponsoring-future-reserves` — Begin sponsoring future reserves for another account +- `bump-sequence` — Bump sequence number to invalidate older transactions +- `change-trust` — Create, update, or delete a trustline +- `claim-claimable-balance` — Claim a claimable balance by its balance ID +- `clawback` — Clawback an asset from an account +- `clawback-claimable-balance` — Clawback a claimable balance by its balance ID +- `create-account` — Create and fund a new account +- `create-claimable-balance` — Create a claimable balance that can be claimed by specified accounts +- `create-passive-sell-offer` — Create a passive sell offer on the Stellar DEX +- `end-sponsoring-future-reserves` — End sponsoring future reserves +- `liquidity-pool-deposit` — Deposit assets into a liquidity pool +- `liquidity-pool-withdraw` — Withdraw assets from a liquidity pool +- `manage-buy-offer` — Create, update, or delete a buy offer +- `manage-data` — Set, modify, or delete account data entries +- `manage-sell-offer` — Create, update, or delete a sell offer +- `path-payment-strict-receive` — Send a payment with a different asset using path finding, specifying the receive amount +- `path-payment-strict-send` — Send a payment with a different asset using path finding, specifying the send amount +- `payment` — Send asset to destination account +- `revoke-sponsorship` — Revoke sponsorship of a ledger entry or signer +- `set-options` — Set account options like flags, signers, and home domain +- `set-trustline-flags` — Configure authorization and trustline flags for an asset ## `stellar tx operation add account-merge` @@ -2539,32 +2337,31 @@ Transfer XLM balance to another account and remove source account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account ` — Muxed Account to merge with, e.g. `GBX...`, 'MBX...' ## `stellar tx operation add begin-sponsoring-future-reserves` @@ -2574,32 +2371,31 @@ Begin sponsoring future reserves for another account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--sponsored-id ` — Account that will be sponsored - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--sponsored-id ` — Account that will be sponsored ## `stellar tx operation add bump-sequence` @@ -2609,32 +2405,31 @@ Bump sequence number to invalidate older transactions ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--bump-to ` — Sequence number to bump to - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--bump-to ` — Sequence number to bump to ## `stellar tx operation add change-trust` @@ -2644,35 +2439,34 @@ Create, update, or delete a trustline ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--line ` -* `--limit ` — Limit for the trust line, 0 to remove the trust line - - Default value: `9223372036854775807` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--line ` +- `--limit ` — Limit for the trust line, 0 to remove the trust line + Default value: `9223372036854775807` ## `stellar tx operation add claim-claimable-balance` @@ -2682,32 +2476,31 @@ Claim a claimable balance by its balance ID ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to claim (64-character hex string) ## `stellar tx operation add clawback` @@ -2717,34 +2510,33 @@ Clawback an asset from an account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--from ` — Account to clawback assets from, e.g. `GBX...` -* `--asset ` — Asset to clawback -* `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--from ` — Account to clawback assets from, e.g. `GBX...` +- `--asset ` — Asset to clawback +- `--amount ` — Amount of the asset to clawback, in stroops. 1 stroop = 0.0000001 of the asset ## `stellar tx operation add clawback-claimable-balance` @@ -2754,32 +2546,31 @@ Clawback a claimable balance by its balance ID ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--balance-id ` — Balance ID of the claimable balance to clawback. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA ## `stellar tx operation add create-account` @@ -2789,35 +2580,34 @@ Create and fund a new account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--destination ` — Account Id to create, e.g. `GBX...` -* `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM - - Default value: `10_000_000` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--destination ` — Account Id to create, e.g. `GBX...` +- `--starting-balance ` — Initial balance in stroops of the account, default 1 XLM + Default value: `10_000_000` ## `stellar tx operation add create-claimable-balance` @@ -2827,40 +2617,39 @@ Create a claimable balance that can be claimed by specified accounts ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--asset ` — Asset to be held in the ClaimableBalanceEntry - Default value: `native` -* `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset -* `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. - - Examples: +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--asset ` — Asset to be held in the ClaimableBalanceEntry - - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` + Default value: `native` +- `--amount ` — Amount of asset to store in the entry, in stroops. 1 stroop = 0.0000001 of the asset +- `--claimant ` — Claimants of the claimable balance. Format: account_id or account_id:predicate_json Can be specified multiple times for multiple claimants. + Examples: + - `--claimant alice (unconditional)` - `--claimant 'bob:{"before_absolute_time":"1735689599"}'` - `--claimant 'charlie:{"and":[{"before_absolute_time":"1735689599"},{"before_relative_time":"3600"}]}'` ## `stellar tx operation add create-passive-sell-offer` @@ -2870,35 +2659,34 @@ Create a passive sell offer on the Stellar DEX ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) ## `stellar tx operation add end-sponsoring-future-reserves` @@ -2908,31 +2696,30 @@ End sponsoring future reserves ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet ## `stellar tx operation add liquidity-pool-deposit` @@ -2942,40 +2729,40 @@ Deposit assets into a liquidity pool ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--liquidity-pool-id ` — Liquidity pool ID to deposit to -* `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops -* `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops -* `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) - Default value: `1:1` -* `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--liquidity-pool-id ` — Liquidity pool ID to deposit to +- `--max-amount-a ` — Maximum amount of the first asset to deposit, in stroops +- `--max-amount-b ` — Maximum amount of the second asset to deposit, in stroops +- `--min-price ` — Minimum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) Default value: `1:1` +- `--max-price ` — Maximum price for the first asset in terms of the second asset as "numerator:denominator" (e.g., "1:2" means 0.5) + Default value: `1:1` ## `stellar tx operation add liquidity-pool-withdraw` @@ -2985,35 +2772,34 @@ Withdraw assets from a liquidity pool ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--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 - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--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 ## `stellar tx operation add manage-buy-offer` @@ -3023,38 +2809,37 @@ Create, update, or delete a buy offer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of buying asset to purchase, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of buying asset in terms of selling asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx operation add manage-data` @@ -3064,33 +2849,32 @@ Set, modify, or delete account data entries ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified -* `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--data-name ` — String up to 64 bytes long. If this is a new Name it will add the given name/value pair to the account. If this Name is already present then the associated value will be modified +- `--data-value ` — Up to 64 bytes long hex string If not present then the existing Name will be deleted. If present then this value will be set in the `DataEntry` ## `stellar tx operation add manage-sell-offer` @@ -3100,38 +2884,37 @@ Create, update, or delete a sell offer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--selling ` — Asset to sell -* `--buying ` — Asset to buy -* `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer -* `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) -* `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer - - Default value: `0` +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--selling ` — Asset to sell +- `--buying ` — Asset to buy +- `--amount ` — Amount of selling asset to offer, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops). Use `0` to remove the offer +- `--price ` — Price of 1 unit of selling asset in terms of buying asset as "numerator:denominator" (e.g., "1:2" means 0.5) +- `--offer-id ` — Offer ID. If 0, will create new offer. Otherwise, will update existing offer + Default value: `0` ## `stellar tx operation add path-payment-strict-receive` @@ -3141,37 +2924,36 @@ Send a payment with a different asset using path finding, specifying the receive ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-max ` — Maximum amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-amount ` — Exact amount of destination asset that the destination account will receive, in stroops. 1 stroop = 0.0000001 of the asset +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add path-payment-strict-send` @@ -3181,37 +2963,36 @@ Send a payment with a different asset using path finding, specifying the send am ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--send-asset ` — Asset to send (pay with) -* `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) -* `--destination ` — Account that receives the payment -* `--dest-asset ` — Asset that the destination will receive -* `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met -* `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--send-asset ` — Asset to send (pay with) +- `--send-amount ` — Amount of send asset to deduct from sender's account, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--destination ` — Account that receives the payment +- `--dest-asset ` — Asset that the destination will receive +- `--dest-min ` — Minimum amount of destination asset that the destination account can receive. The operation will fail if this amount cannot be met +- `--path ` — List of intermediate assets for the payment path, comma-separated (up to 5 assets). Each asset should be in the format 'code:issuer' or 'native' for XLM ## `stellar tx operation add payment` @@ -3221,36 +3002,36 @@ Send asset to destination account ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--destination ` — Account to send to, e.g. `GBX...` -* `--asset ` — Asset to send, default native, e.i. XLM - Default value: `native` -* `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--destination ` — Account to send to, e.g. `GBX...` +- `--asset ` — Asset to send, default native, e.i. XLM + Default value: `native` +- `--amount ` — Amount of the aforementioned asset to send, in stroops. 1 stroop = 0.0000001 of the asset (e.g. 1 XLM = `10_000_000` stroops) ## `stellar tx operation add revoke-sponsorship` @@ -3260,38 +3041,37 @@ Revoke sponsorship of a ledger entry or signer ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--account-id ` — Account ID (required for all sponsorship types) -* `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) -* `--data-name ` — Data name for data entry sponsorship -* `--offer-id ` — Offer ID for offer sponsorship -* `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA -* `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA -* `--signer-key ` — Signer key for signer sponsorship - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--account-id ` — Account ID (required for all sponsorship types) +- `--asset ` — Asset for trustline sponsorship (format: CODE:ISSUER) +- `--data-name ` — Data name for data entry sponsorship +- `--offer-id ` — Offer ID for offer sponsorship +- `--liquidity-pool-id ` — Pool ID for liquidity pool sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): LAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA +- `--claimable-balance-id ` — Claimable balance ID for claimable balance sponsorship. Accepts multiple formats: - API format with type prefix (72 chars): 000000006f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Direct hash format (64 chars): 6f2179b31311fa8064760b48942c8e166702ba0b8fbe7358c4fd570421840461 - Address format (base32): BAAMLBZI42AD52HKGIZOU7WFVZM6BPEJCLPL44QU2AT6TY3P57I5QDNYIA +- `--signer-key ` — Signer key for signer sponsorship ## `stellar tx operation add set-options` @@ -3301,47 +3081,46 @@ Set account options like flags, signers, and home domain ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--inflation-dest ` — Account of the inflation destination -* `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled -* `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig -* `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation -* `--signer ` — Add, update, or remove a signer from an account -* `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 -* `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 -* `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 -* `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 -* `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 -* `--clear-required` -* `--clear-revocable` -* `--clear-immutable` -* `--clear-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--inflation-dest ` — Account of the inflation destination +- `--master-weight ` — A number from 0-255 (inclusive) representing the weight of the master key. If the weight of the master key is updated to 0, it is effectively disabled +- `--low-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a low threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--med-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a medium threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--high-threshold ` — A number from 0-255 (inclusive) representing the threshold this account sets on all operations it performs that have a high threshold. https://developers.stellar.org/docs/learn/encyclopedia/security/signatures-multisig#multisig +- `--home-domain ` — Sets the home domain of an account. See https://developers.stellar.org/docs/learn/encyclopedia/network-configuration/federation +- `--signer ` — Add, update, or remove a signer from an account +- `--signer-weight ` — Signer weight is a number from 0-255 (inclusive). The signer is deleted if the weight is 0 +- `--set-required` — When enabled, an issuer must approve an account before that account can hold its asset. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-required-0x1 +- `--set-revocable` — When enabled, an issuer can revoke an existing trustline's authorization, thereby freezing the asset held by an account. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-revocable-0x2 +- `--set-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. https://developers.stellar.org/docs/tokens/control-asset-access#clawback-enabled-0x8 +- `--set-immutable` — With this setting, none of the other authorization flags (`AUTH_REQUIRED_FLAG`, `AUTH_REVOCABLE_FLAG`) can be set, and the issuing account can't be merged. https://developers.stellar.org/docs/tokens/control-asset-access#authorization-immutable-0x4 +- `--clear-required` +- `--clear-revocable` +- `--clear-immutable` +- `--clear-clawback-enabled` ## `stellar tx operation add set-trustline-flags` @@ -3351,39 +3130,38 @@ Configure authorization and trustline flags for an asset ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--operation-source-account ` [alias: `op-source`] — Source account used for the operation -* `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm +- `--operation-source-account ` [alias: `op-source`] — Source account used for the operation +- `--fee ` — fee amount for transaction, in stroops. 1 stroop = 0.0000001 xlm Default value: `100` -* `--cost` — Output the cost execution to stderr -* `--instructions ` — Number of instructions to simulate -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation -* `--build-only` — Build the transaction and only write the base64 xdr to stdout -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` -* `--asset ` — Asset to set trustline flags for -* `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders -* `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset -* `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks -* `--clear-authorize` -* `--clear-authorize-to-maintain-liabilities` -* `--clear-trustline-clawback-enabled` - +- `--cost` — Output the cost execution to stderr +- `--instructions ` — Number of instructions to simulate +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation +- `--build-only` — Build the transaction and only write the base64 xdr to stdout +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--trustor ` — Account to set trustline flags for, e.g. `GBX...`, or alias, or muxed account, `M123...`` +- `--asset ` — Asset to set trustline flags for +- `--set-authorize` — Signifies complete authorization allowing an account to transact freely with the asset to make and receive payments and place orders +- `--set-authorize-to-maintain-liabilities` — Denotes limited authorization that allows an account to maintain current orders but not to otherwise transact with the asset +- `--set-trustline-clawback-enabled` — Enables the issuing account to take back (burning) all of the asset. See our section on Clawbacks: https://developers.stellar.org/docs/learn/encyclopedia/transactions-specialized/clawbacks +- `--clear-authorize` +- `--clear-authorize-to-maintain-liabilities` +- `--clear-trustline-clawback-enabled` ## `stellar tx send` @@ -3393,18 +3171,16 @@ Send a transaction envelope to the network ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar tx sign` @@ -3414,22 +3190,20 @@ Sign a transaction envelope appending the signature to the envelope ###### **Arguments:** -* `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR, or file containing XDR to decode, or stdin if empty ###### **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 -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings - - +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings ## `stellar tx simulate` @@ -3439,59 +3213,50 @@ Simulate a transaction envelope from stdin ###### **Arguments:** -* `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty +- `` — Base-64 transaction envelope XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path -* `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` -* `--sign-with-lab` — Sign with https://lab.stellar.org -* `--sign-with-ledger` — Sign with a ledger wallet -* `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation - - +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `-s`, `--source-account ` [alias: `source`] — Account that where transaction originates from. Alias `source`. Can be an identity (--source alice), a public key (--source GDKW...), a muxed account (--source MDA…), a secret key (--source SC36…), or a seed phrase (--source "kite urban…"). If `--build-only` or `--sim-only` flags were NOT provided, this key will also be used to sign the final transaction. In that case, trying to sign with public key will fail +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--sign-with-key ` — Sign with a local key or key saved in OS secure storage. Can be an identity (--sign-with-key alice), a secret key (--sign-with-key SC36…), or a seed phrase (--sign-with-key "kite urban…"). If using seed phrase, `--hd-path` defaults to the `0` path +- `--hd-path ` — If using a seed phrase to sign, sets which hierarchical deterministic path to use, e.g. `m/44'/148'/{hd_path}`. Example: `--hd-path 1`. Default: `0` +- `--sign-with-lab` — Sign with https://lab.stellar.org +- `--sign-with-ledger` — Sign with a ledger wallet +- `--instruction-leeway ` — Allow this many extra instructions when budgeting resources during transaction simulation ## `stellar tx fetch` Fetch a transaction from the network by hash If no subcommand is passed in, the transaction envelope will be returned -**Usage:** `stellar tx fetch [OPTIONS] - fetch ` +**Usage:** `stellar tx fetch [OPTIONS] fetch ` ###### **Subcommands:** -* `result` — Fetch the transaction result -* `meta` — Fetch the transaction meta -* `fee` — Fetch the transaction fee information +- `result` — Fetch the transaction result +- `meta` — Fetch the transaction meta +- `fee` — Fetch the transaction fee information ###### **Options:** -* `--hash ` — Hash of transaction to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--hash ` — Hash of transaction to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar tx fetch result` @@ -3501,25 +3266,19 @@ Fetch the transaction result ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--hash ` — Transaction hash to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar tx fetch meta` @@ -3529,25 +3288,19 @@ Fetch the transaction meta ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--hash ` — Transaction hash to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar tx fetch fee` @@ -3557,25 +3310,19 @@ Fetch the transaction fee information ###### **Options:** -* `--hash ` — Transaction hash to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Output format for fee command +- `--hash ` — Transaction hash to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Output format for fee command Default value: `table` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `table`: - Formatted in a table comparing fee types - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `table`: Formatted in a table comparing fee types ## `stellar tx decode` @@ -3585,25 +3332,22 @@ Decode a transaction envelope from XDR to JSON ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `single-base64` Possible values: `single-base64`, `single` -* `--output ` +- `--output ` Default value: `json` Possible values: `json`, `json-formatted` - - - ## `stellar tx encode` Encode a transaction envelope from JSON to XDR @@ -3612,25 +3356,22 @@ Encode a transaction envelope from JSON to XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `json` Possible values: `json` -* `--output ` +- `--output ` Default value: `single-base64` Possible values: `single-base64`, `single` - - - ## `stellar xdr` Decode and encode XDR @@ -3639,25 +3380,22 @@ Decode and encode XDR ###### **Subcommands:** -* `types` — View information about types -* `guess` — Guess the XDR type -* `decode` — Decode XDR -* `encode` — Encode XDR -* `compare` — Compare two XDR values with each other -* `generate` — Generate XDR values -* `version` — Print version information +- `types` — View information about types +- `guess` — Guess the XDR type +- `decode` — Decode XDR +- `encode` — Encode XDR +- `compare` — Compare two XDR values with each other +- `generate` — Generate XDR values +- `version` — Print version information ###### **Arguments:** -* `` — Channel of XDR to operate on +- `` — Channel of XDR to operate on Default value: `+curr` Possible values: `+curr`, `+next` - - - ## `stellar xdr types` View information about types @@ -3666,11 +3404,9 @@ View information about types ###### **Subcommands:** -* `list` — -* `schema` — -* `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory - - +- `list` — +- `schema` — +- `schema-files` — Generate JSON schema files for the XDR types, writing a file for each type to the out directory ## `stellar xdr types list` @@ -3678,31 +3414,25 @@ View information about types ###### **Options:** -* `--output ` +- `--output ` Default value: `plain` Possible values: `plain`, `json`, `json-formatted` - - - ## `stellar xdr types schema` **Usage:** `stellar xdr types schema [OPTIONS] --type ` ###### **Options:** -* `--type ` — XDR type to decode -* `--output ` +- `--type ` — XDR type to decode +- `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` - - - ## `stellar xdr types schema-files` Generate JSON schema files for the XDR types, writing a file for each type to the out directory @@ -3711,16 +3441,13 @@ Generate JSON schema files for the XDR types, writing a file for each type to th ###### **Options:** -* `--out-dir ` -* `--output ` +- `--out-dir ` +- `--output ` Default value: `json-schema-draft201909` Possible values: `json-schema-draft201909` - - - ## `stellar xdr guess` Guess the XDR type. @@ -3731,28 +3458,26 @@ Prints a list of types that the XDR values can be decoded into. ###### **Arguments:** -* `` — XDR or file containing XDR to decode, or stdin if empty +- `` — XDR or file containing XDR to decode, or stdin if empty ###### **Options:** -* `--input ` +- `--input ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -* `--output ` +- `--output ` Default value: `list` Possible values: `list` -* `--certainty ` — Certainty as an arbitrary value +- `--certainty ` — Certainty as an arbitrary value Default value: `2` - - ## `stellar xdr decode` Decode XDR @@ -3761,26 +3486,23 @@ Decode XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--type ` — XDR type to decode -* `--input ` +- `--type ` — XDR type to decode +- `--input ` Default value: `stream-base64` Possible values: `single`, `single-base64`, `stream`, `stream-base64`, `stream-framed` -* `--output ` +- `--output ` Default value: `json` Possible values: `json`, `json-formatted`, `text`, `rust-debug`, `rust-debug-formatted` - - - ## `stellar xdr encode` Encode XDR @@ -3789,26 +3511,23 @@ Encode XDR ###### **Arguments:** -* `` — XDR or files containing XDR to decode, or stdin if empty +- `` — XDR or files containing XDR to decode, or stdin if empty ###### **Options:** -* `--type ` — XDR type to encode -* `--input ` +- `--type ` — XDR type to encode +- `--input ` Default value: `json` Possible values: `json` -* `--output ` +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `stream` - - - ## `stellar xdr compare` Compare two XDR values with each other @@ -3819,21 +3538,18 @@ Outputs: `-1` when the left XDR value is less than the right XDR value, `0` when ###### **Arguments:** -* `` — XDR file to decode and compare with the right value -* `` — XDR file to decode and compare with the left value +- `` — XDR file to decode and compare with the right value +- `` — XDR file to decode and compare with the left value ###### **Options:** -* `--type ` — XDR type of both inputs -* `--input ` +- `--type ` — XDR type of both inputs +- `--input ` Default value: `single-base64` Possible values: `single`, `single-base64` - - - ## `stellar xdr generate` Generate XDR values @@ -3842,10 +3558,8 @@ Generate XDR values ###### **Subcommands:** -* `default` — Generate default XDR values -* `arbitrary` — Generate arbitrary XDR values - - +- `default` — Generate default XDR values +- `arbitrary` — Generate arbitrary XDR values ## `stellar xdr generate default` @@ -3855,16 +3569,13 @@ Generate default XDR values ###### **Options:** -* `--type ` — XDR type to generate -* `--output ` +- `--type ` — XDR type to generate +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` - - - ## `stellar xdr generate arbitrary` Generate arbitrary XDR values @@ -3873,24 +3584,19 @@ Generate arbitrary XDR values ###### **Options:** -* `--type ` — XDR type to generate -* `--output ` +- `--type ` — XDR type to generate +- `--output ` Default value: `single-base64` Possible values: `single`, `single-base64`, `json`, `json-formatted`, `text` - - - ## `stellar xdr version` Print version information **Usage:** `stellar xdr version` - - ## `stellar completion` Print shell completion code for the specified shell @@ -3901,18 +3607,14 @@ To enable autocomplete in the current bash shell, run: `source <(stellar complet To enable autocomplete permanently, run: `echo "source <(stellar completion --shell bash)" >> ~/.bashrc` - **Usage:** `stellar completion --shell ` ###### **Options:** -* `--shell ` — The shell type +- `--shell ` — The shell type Possible values: `bash`, `elvish`, `fish`, `powershell`, `zsh` - - - ## `stellar cache` Cache for transactions and contract specs @@ -3921,11 +3623,9 @@ Cache for transactions and contract specs ###### **Subcommands:** -* `clean` — Delete the cache -* `path` — Show the location of the cache -* `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) - - +- `clean` — Delete the cache +- `path` — Show the location of the cache +- `actionlog` — Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) ## `stellar cache clean` @@ -3933,16 +3633,12 @@ Delete the cache **Usage:** `stellar cache clean` - - ## `stellar cache path` Show the location of the cache **Usage:** `stellar cache path` - - ## `stellar cache actionlog` Access details about cached actions like transactions, and simulations. (Experimental. May see breaking changes at any time.) @@ -3951,10 +3647,8 @@ Access details about cached actions like transactions, and simulations. (Experim ###### **Subcommands:** -* `ls` — List cached actions (transactions, simulations) -* `read` — Read cached action - - +- `ls` — List cached actions (transactions, simulations) +- `read` — Read cached action ## `stellar cache actionlog ls` @@ -3964,11 +3658,9 @@ List cached actions (transactions, simulations) ###### **Options:** -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `-l`, `--long` - - +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `-l`, `--long` ## `stellar cache actionlog read` @@ -3978,9 +3670,7 @@ Read cached action ###### **Options:** -* `--id ` — ID of the cache entry - - +- `--id ` — ID of the cache entry ## `stellar version` @@ -3990,10 +3680,8 @@ Print version information ###### **Options:** -* `--only-version` — Print only the version -* `--only-version-major` — Print only the major version - - +- `--only-version` — Print only the version +- `--only-version-major` — Print only the major version ## `stellar plugin` @@ -4003,10 +3691,8 @@ The subcommand for CLI plugins ###### **Subcommands:** -* `search` — Search for CLI plugins using GitHub -* `ls` — List installed plugins - - +- `search` — Search for CLI plugins using GitHub +- `ls` — List installed plugins ## `stellar plugin search` @@ -4014,16 +3700,12 @@ Search for CLI plugins using GitHub **Usage:** `stellar plugin search` - - ## `stellar plugin ls` List installed plugins **Usage:** `stellar plugin ls` - - ## `stellar ledger` Fetch ledger information @@ -4032,11 +3714,9 @@ Fetch ledger information ###### **Subcommands:** -* `entry` — Work with ledger entries -* `latest` — Get the latest ledger sequence and information from the network -* `fetch` — - - +- `entry` — Work with ledger entries +- `latest` — Get the latest ledger sequence and information from the network +- `fetch` — ## `stellar ledger entry` @@ -4046,9 +3726,7 @@ Work with ledger entries ###### **Subcommands:** -* `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) - - +- `fetch` — Fetch ledger entries. This command supports all types of ledger entries supported by the RPC. Read more about the RPC command here: [https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys](https://developers.stellar.org/docs/data/apis/rpc/api-reference/methods/getLedgerEntries#types-of-ledgerkeys) ## `stellar ledger entry fetch` @@ -4058,16 +3736,14 @@ Fetch ledger entries. This command supports all types of ledger entries supporte ###### **Subcommands:** -* `account` — Fetch account entry by public key or alias -* `contract-data` — Fetch contract ledger entry by address or alias and storage key -* `claimable-balance` — Fetch a claimable balance ledger entry by id -* `liquidity-pool` — Fetch a liquidity pool ledger entry by id -* `contract-code` — Fetch a Contract's WASM bytecode by WASM hash -* `trustline` — Fetch a trustline by account and asset -* `data` — Fetch key-value data entries attached to an account (see manageDataOp) -* `offer` — Fetch an offer by account and offer id - - +- `account` — Fetch account entry by public key or alias +- `contract-data` — Fetch contract ledger entry by address or alias and storage key +- `claimable-balance` — Fetch a claimable balance ledger entry by id +- `liquidity-pool` — Fetch a liquidity pool ledger entry by id +- `contract-code` — Fetch a Contract's WASM bytecode by WASM hash +- `trustline` — Fetch a trustline by account and asset +- `data` — Fetch key-value data entries attached to an account (see manageDataOp) +- `offer` — Fetch an offer by account and offer id ## `stellar ledger entry fetch account` @@ -4077,28 +3753,23 @@ Fetch account entry by public key or alias ###### **Options:** -* `--account ` — Account alias or address to lookup -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--account ` — Account alias or address to lookup +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar ledger entry fetch contract-data` @@ -4108,39 +3779,32 @@ Fetch contract ledger entry by address or alias and storage key ###### **Options:** -* `--contract ` — Contract alias or address to fetch -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--contract ` — Contract alias or address to fetch +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) -* `--durability ` — Storage entry durability +- `--durability ` — Storage entry durability Default value: `persistent` Possible values: - - `persistent`: - Persistent - - `temporary`: - Temporary - -* `--key ` — Storage key (symbols only) -* `--key-xdr ` — Storage key (base64-encoded XDR) - + - `persistent`: Persistent + - `temporary`: Temporary +- `--key ` — Storage key (symbols only) +- `--key-xdr ` — Storage key (base64-encoded XDR) ## `stellar ledger entry fetch claimable-balance` @@ -4150,27 +3814,21 @@ Fetch a claimable balance ledger entry by id ###### **Options:** -* `--id ` — Claimable Balance Ids to fetch an entry for -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--id ` — Claimable Balance Ids to fetch an entry for +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar ledger entry fetch liquidity-pool` @@ -4180,27 +3838,21 @@ Fetch a liquidity pool ledger entry by id ###### **Options:** -* `--id ` — Liquidity pool ids -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--id ` — Liquidity pool ids +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar ledger entry fetch contract-code` @@ -4210,27 +3862,21 @@ Fetch a Contract's WASM bytecode by WASM hash ###### **Options:** -* `--wasm-hash ` — Get WASM bytecode by hash -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--wasm-hash ` — Get WASM bytecode by hash +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - - - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) ## `stellar ledger entry fetch trustline` @@ -4240,29 +3886,24 @@ Fetch a trustline by account and asset ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--account ` — Account alias or address to lookup -* `--asset ` — Assets to get trustline info for -* `--hd-path ` — If account is a seed phrase use this hd path, default is 0 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--account ` — Account alias or address to lookup +- `--asset ` — Assets to get trustline info for +- `--hd-path ` — If account is a seed phrase use this hd path, default is 0 ## `stellar ledger entry fetch data` @@ -4272,29 +3913,24 @@ Fetch key-value data entries attached to an account (see manageDataOp) ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--account ` — Account alias or address to lookup -* `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--account ` — Account alias or address to lookup +- `--data-name ` — Fetch key-value data entries attached to an account (see manageDataOp) +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar ledger entry fetch offer` @@ -4304,29 +3940,24 @@ Fetch an offer by account and offer id ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--global` — ⚠️ Deprecated: global config is always on -* `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--global` — ⚠️ Deprecated: global config is always on +- `--config-dir ` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings +- `--output ` — Format of the output Default value: `json` Possible values: - - `json`: - JSON output of the ledger entry with parsed XDRs (one line, not formatted) - - `json-formatted`: - Formatted (multiline) JSON output of the ledger entry with parsed XDRs - - `xdr`: - Original RPC output (containing XDRs) - -* `--account ` — Account alias or address to lookup -* `--offer ` — ID of an offer made on the Stellar DEX -* `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 - + - `json`: JSON output of the ledger entry with parsed XDRs (one line, not formatted) + - `json-formatted`: Formatted (multiline) JSON output of the ledger entry with parsed XDRs + - `xdr`: Original RPC output (containing XDRs) +- `--account ` — Account alias or address to lookup +- `--offer ` — ID of an offer made on the Stellar DEX +- `--hd-path ` — If identity is a seed phrase use this hd path, default is 0 ## `stellar ledger latest` @@ -4336,24 +3967,18 @@ Get the latest ledger sequence and information from the network ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request ## `stellar ledger fetch` @@ -4361,41 +3986,34 @@ Get the latest ledger sequence and information from the network ###### **Arguments:** -* `` — Ledger Sequence to start fetch (inclusive) +- `` — Ledger Sequence to start fetch (inclusive) ###### **Options:** -* `--limit ` — Number of ledgers to fetch +- `--limit ` — Number of ledgers to fetch Default value: `1` -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output + +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request -* `--xdr-format ` — Format of the xdr in the output +- `--xdr-format ` — Format of the xdr in the output Default value: `json` Possible values: - - `json`: - XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields - - `xdr`: - XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields - - - + - `json`: XDR fields will be fetched as json and accessible via the headerJson and metadataJson fields + - `xdr`: XDR fields will be fetched as xdr and accessible via the headerXdr and metadataXdr fields ## `stellar fee-stats` @@ -4405,22 +4023,15 @@ Fetch network feestats ###### **Options:** -* `--rpc-url ` — RPC server endpoint -* `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider -* `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server -* `-n`, `--network ` — Name of network to use from config -* `--output ` — Format of the output +- `--rpc-url ` — RPC server endpoint +- `--rpc-header ` — RPC Header(s) to include in requests to the RPC provider +- `--network-passphrase ` — Network passphrase to sign the transaction sent to the rpc server +- `-n`, `--network ` — Name of network to use from config +- `--output ` — Format of the output Default value: `text` Possible values: - - `text`: - Text output of network info - - `json`: - JSON result of the RPC request - - `json-formatted`: - Formatted (multiline) JSON output of the RPC request - - - - + - `text`: Text output of network info + - `json`: JSON result of the RPC request + - `json-formatted`: Formatted (multiline) JSON output of the RPC request From 530a3fac8db839c280243aa8f28635c2c5958e5c Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 15 Oct 2025 13:17:05 -0400 Subject: [PATCH 74/76] Fmt --- cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs | 1 - 1 file changed, 1 deletion(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs index 03935b8f63..8c6102dee9 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/contract_data.rs @@ -32,7 +32,6 @@ pub struct Cmd { pub key_xdr: Option>, } - #[derive(thiserror::Error, Debug)] pub enum Error { #[error(transparent)] From 4d4ea4f967783f981574bcd842dfee6d064093a3 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Wed, 15 Oct 2025 13:18:12 -0400 Subject: [PATCH 75/76] Remove unused imports --- .../tests/it/integration/ledger/entry.rs | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs index 9f62b835c9..7e5589be89 100644 --- a/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs +++ b/cmd/crates/soroban-test/tests/it/integration/ledger/entry.rs @@ -4,14 +4,14 @@ use soroban_cli::{ tx::builder::TxExt, xdr::{ self, AccountId, AlphaNum4, Asset, AssetCode4, ChangeTrustAsset, ChangeTrustOp, - ClaimPredicate, ClaimableBalanceId, Claimant, ClaimantV0, ConfigSettingId, - ContractDataDurability, CreateClaimableBalanceOp, CreateClaimableBalanceResult, Hash, - LedgerEntryData, LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, - LedgerKeyConfigSetting, LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, - LedgerKeyLiquidityPool, LedgerKeyTrustLine, Limits, LiquidityPoolConstantProductParameters, - LiquidityPoolParameters, Operation, OperationBody, OperationResult, OperationResultTr, - PoolId, PublicKey, ScAddress, ScVal, String64, StringM, TransactionEnvelope, - TransactionResult, TransactionResultResult, TrustLineAsset, Uint256, VecM, WriteXdr, + ClaimPredicate, ClaimableBalanceId, Claimant, ClaimantV0, ContractDataDurability, + CreateClaimableBalanceOp, CreateClaimableBalanceResult, Hash, LedgerEntryData, LedgerKey, + LedgerKeyAccount, LedgerKeyClaimableBalance, LedgerKeyContractCode, LedgerKeyContractData, + LedgerKeyData, LedgerKeyLiquidityPool, LedgerKeyTrustLine, Limits, + LiquidityPoolConstantProductParameters, LiquidityPoolParameters, Operation, OperationBody, + OperationResult, OperationResultTr, PoolId, PublicKey, ScAddress, ScVal, String64, StringM, + TransactionEnvelope, TransactionResult, TransactionResultResult, TrustLineAsset, Uint256, + VecM, WriteXdr, }, }; From ec9e56ab5c583ed35eeb9df7ec88cea081a1a477 Mon Sep 17 00:00:00 2001 From: elizabethengelman <4752801+elizabethengelman@users.noreply.github.com> Date: Mon, 3 Nov 2025 09:25:36 -0500 Subject: [PATCH 76/76] to_string -> clone --- .../src/commands/ledger/entry/fetch/claimable_balance.rs | 2 +- .../src/commands/ledger/entry/fetch/liquidity_pool.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs index 73781951be..2aefd9ef18 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/claimable_balance.rs @@ -39,7 +39,7 @@ impl Cmd { let padded_hex = padded_hex_from_str(x, 32)?; let hash_bytes: [u8; 32] = padded_hex .try_into() - .map_err(|_| Error::InvalidHash(x.to_string()))?; + .map_err(|_| Error::InvalidHash(x.clone()))?; let hash = Hash(hash_bytes); let key = LedgerKey::ClaimableBalance(LedgerKeyClaimableBalance { balance_id: ClaimableBalanceIdTypeV0(hash), diff --git a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs index fdf308daf1..631823c8b4 100644 --- a/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs +++ b/cmd/soroban-cli/src/commands/ledger/entry/fetch/liquidity_pool.rs @@ -38,7 +38,7 @@ impl Cmd { let padded_hex = padded_hex_from_str(x, 32)?; let hash_bytes: [u8; 32] = padded_hex .try_into() - .map_err(|_| Error::InvalidHash(x.to_string()))?; + .map_err(|_| Error::InvalidHash(x.clone()))?; let hash = Hash(hash_bytes); let key = LedgerKey::LiquidityPool(LedgerKeyLiquidityPool { liquidity_pool_id: PoolId(hash),