Fetch snapshot values dynamically rather than hardcoding them.

FULL_HELP_DOCS.md

@@ -1587,13 +1587,13 @@ Any invalid contract id passed as `--address` will be ignored.
 * `--out <OUT>` — Out path that the snapshot is written to
 
   Default value: `snapshot.json`
+* `--archive-url <ARCHIVE_URL>` — Archive URL
 * `--global` — ⚠️ Deprecated: global config is always on
 * `--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
 * `--rpc-url <RPC_URL>` — RPC server endpoint
 * `--rpc-header <RPC_HEADERS>` — RPC Header(s) to include in requests to the RPC provider
 * `--network-passphrase <NETWORK_PASSPHRASE>` — Network passphrase to sign the transaction sent to the rpc server
 * `-n`, `--network <NETWORK>` — Name of network to use from config
-* `--archive-url <ARCHIVE_URL>` — Archive URL
 
 
 

cmd/soroban-cli/src/commands/mod.rs

@@ -26,6 +26,7 @@ pub mod version;
 pub mod txn_result;
 
 pub const HEADING_RPC: &str = "Options (RPC)";
+pub const HEADING_ARCHIVE: &str = "Options (Archive)";
 pub const HEADING_GLOBAL: &str = "Options (Global)";
 const ABOUT: &str =
     "Work seamlessly with Stellar accounts, contracts, and assets from the command line.

cmd/soroban-cli/src/commands/snapshot/create.rs

@@ -16,19 +16,19 @@ use std::{
 };
 use stellar_xdr::curr::{
     self as xdr, AccountId, Asset, BucketEntry, ConfigSettingEntry, ConfigSettingId,
-    ContractExecutable, Frame, Hash, LedgerEntry, LedgerEntryData, LedgerKey, LedgerKeyAccount,
-    LedgerKeyClaimableBalance, LedgerKeyConfigSetting, LedgerKeyContractCode,
-    LedgerKeyContractData, LedgerKeyData, LedgerKeyLiquidityPool, LedgerKeyOffer,
-    LedgerKeyTrustLine, LedgerKeyTtl, Limited, Limits, ReadXdr, ScAddress, ScContractInstance,
-    ScVal,
+    ContractExecutable, Frame, Hash, LedgerEntry, LedgerEntryData, LedgerHeaderHistoryEntry,
+    LedgerKey, LedgerKeyAccount, LedgerKeyClaimableBalance, LedgerKeyConfigSetting,
+    LedgerKeyContractCode, LedgerKeyContractData, LedgerKeyData, LedgerKeyLiquidityPool,
+    LedgerKeyOffer, LedgerKeyTrustLine, LedgerKeyTtl, Limited, Limits, ReadXdr, ScAddress,
+    ScContractInstance, ScVal,
 };
 use tokio::fs::OpenOptions;
 use tokio::io::BufReader;
 use tokio_util::io::StreamReader;
 use url::Url;
 
 use crate::{
-    commands::{config::data, global, HEADING_RPC},
+    commands::{config::data, global, HEADING_ARCHIVE},
     config::{self, locator, network::passphrase},
     print,
     tx::builder,
@@ -73,25 +73,32 @@ pub struct Cmd {
     /// The ledger sequence number to snapshot. Defaults to latest history archived ledger.
     #[arg(long)]
     ledger: Option<u32>,
+
     /// Account or contract address/alias to include in the snapshot.
     #[arg(long = "address", help_heading = "Filter Options")]
     address: Vec<String>,
+
     /// WASM hashes to include in the snapshot.
     #[arg(long = "wasm-hash", help_heading = "Filter Options")]
     wasm_hashes: Vec<Hash>,
+
     /// Format of the out file.
     #[arg(long)]
     output: Output,
+
     /// Out path that the snapshot is written to.
     #[arg(long, default_value=default_out_path().into_os_string())]
     out: PathBuf,
+
+    /// Archive URL
+    #[arg(long, help_heading = HEADING_ARCHIVE, env = "STELLAR_ARCHIVE_URL")]
+    archive_url: Option<Url>,
+
     #[command(flatten)]
     locator: locator::Args,
+
     #[command(flatten)]
     network: config::network::Args,
-    /// Archive URL
-    #[arg(long, help_heading = HEADING_RPC, env = "STELLAR_ARCHIVE_URL")]
-    archive_url: Option<Url>,
 }
 
 #[derive(thiserror::Error, Debug)]
@@ -140,6 +147,10 @@ pub enum Error {
     ParseAssetName(String),
     #[error(transparent)]
     Asset(#[from] builder::asset::Error),
+    #[error("ledger not found in archive")]
+    LedgerNotFound,
+    #[error("xdr parsing error: {0}")]
+    Xdr(#[from] xdr::Error),
 }
 
 /// Checkpoint frequency is usually 64 ledgers, but in local test nets it'll
@@ -165,6 +176,21 @@ impl Cmd {
         print.infoln(format!("Network Passphrase: {network_passphrase}"));
         print.infoln(format!("Network id: {}", hex::encode(network_id)));
 
+        // Get ledger close time and base reserve from archive
+        let (ledger_close_time, base_reserve) =
+            match get_ledger_metadata_from_archive(&print, &archive_url, ledger).await {
+                Ok((close_time, reserve)) => {
+                    print.infoln(format!("Ledger Close Time: {close_time}"));
+                    print.infoln(format!("Base Reserve: {reserve}"));
+                    (close_time, reserve)
+                }
+                Err(e) => {
+                    print.warnln(format!("Failed to get ledger metadata from archive: {e}"));
+                    print.infoln("Using default values: close_time=0, base_reserve=1");
+                    (0u64, 1u32) // Default values
+                }
+            };
+
         // Prepare a flat list of buckets to read. They'll be ordered by their
         // level so that they can iterated higher level to lower level.
         let buckets = history
@@ -182,12 +208,11 @@ impl Cmd {
         // The snapshot is what will be written to file at the end. Fields will
         // be updated while parsing the history archive.
         let mut snapshot = LedgerSnapshot {
-            // TODO: Update more of the fields.
             protocol_version: 0,
             sequence_number: ledger,
-            timestamp: 0,
+            timestamp: ledger_close_time,
             network_id: network_id.into(),
-            base_reserve: 1,
+            base_reserve,
             min_persistent_entry_ttl: 0,
             min_temp_entry_ttl: 0,
             max_entry_ttl: 0,
@@ -284,29 +309,47 @@ impl Cmd {
                             continue;
                         }
                     };
+
                     if seen.contains(&key) {
                         continue;
                     }
+
                     let keep = match &key {
                         LedgerKey::Account(k) => current.account_ids.contains(&k.account_id),
                         LedgerKey::Trustline(k) => current.account_ids.contains(&k.account_id),
                         LedgerKey::ContractData(k) => current.contract_ids.contains(&k.contract),
                         LedgerKey::ContractCode(e) => current.wasm_hashes.contains(&e.hash),
+                        LedgerKey::ConfigSetting(_) => true,
                         _ => false,
                     };
+
                     if !keep {
                         continue;
                     }
+
                     seen.insert(key.clone());
-                    let Some(val) = val else { continue };
+
+                    let Some(val) = val else {
+                        continue;
+                    };
+
                     match &val.data {
+                        LedgerEntryData::ConfigSetting(ConfigSettingEntry::StateArchival(
+                            state_archival,
+                        )) => {
+                            snapshot.min_persistent_entry_ttl = state_archival.min_persistent_ttl;
+                            snapshot.min_temp_entry_ttl = state_archival.min_temporary_ttl;
+                            snapshot.max_entry_ttl = state_archival.max_entry_ttl;
+                            false
+                        }
+
                         LedgerEntryData::ContractData(e) => {
                             // If a contract instance references contract
                             // executable stored in another ledger entry, add
                             // that ledger entry to the filter so that Wasm for
                             // any filtered contract is collected too in the
                             // second pass.
-                            if keep && e.key == ScVal::LedgerKeyContractInstance {
+                            if e.key == ScVal::LedgerKeyContractInstance {
                                 match &e.val {
                                     ScVal::ContractInstance(ScContractInstance {
                                         executable: ContractExecutable::Wasm(hash),
@@ -429,7 +472,6 @@ impl Cmd {
 
     // Resolve an account address to an account id. The address can be a
     // G-address or a key name (as in `stellar keys address NAME`).
-
     async fn resolve_account(&self, address: &str) -> Option<AccountId> {
         let address: UnresolvedMuxedAccount = address.parse().ok()?;
         Some(AccountId(xdr::PublicKey::PublicKeyTypeEd25519(
@@ -470,6 +512,14 @@ impl Cmd {
     }
 }
 
+fn ledger_to_path_components(ledger: u32) -> (String, String, String, String) {
+    let ledger_hex = format!("{ledger:08x}");
+    let ledger_hex_0 = ledger_hex[0..=1].to_string();
+    let ledger_hex_1 = ledger_hex[2..=3].to_string();
+    let ledger_hex_2 = ledger_hex[4..=5].to_string();
+    (ledger_hex, ledger_hex_0, ledger_hex_1, ledger_hex_2)
+}
+
 async fn get_history(
     print: &print::Print,
     archive_url: &Url,
@@ -478,17 +528,15 @@ async fn get_history(
     let archive_url = archive_url.to_string();
     let archive_url = archive_url.strip_suffix('/').unwrap_or(&archive_url);
     let history_url = if let Some(ledger) = ledger {
-        let ledger_hex = format!("{ledger:08x}");
-        let ledger_hex_0 = &ledger_hex[0..=1];
-        let ledger_hex_1 = &ledger_hex[2..=3];
-        let ledger_hex_2 = &ledger_hex[4..=5];
+        let (ledger_hex, ledger_hex_0, ledger_hex_1, ledger_hex_2) =
+            ledger_to_path_components(ledger);
         format!("{archive_url}/history/{ledger_hex_0}/{ledger_hex_1}/{ledger_hex_2}/history-{ledger_hex}.json")
     } else {
         format!("{archive_url}/.well-known/stellar-history.json")
     };
     let history_url = Url::from_str(&history_url).unwrap();
 
-    print.globe(format!("Downloading history {history_url}"));
+    print.globeln(format!("Downloading history {history_url}"));
 
     let response = http::client()
         .get(history_url.as_str())
@@ -502,7 +550,6 @@ async fn get_history(
             let ledger_offset = (ledger + 1) % CHECKPOINT_FREQUENCY;
 
             if ledger_offset != 0 {
-                print.println("");
                 print.errorln(format!(
                     "Ledger {ledger} may not be a checkpoint ledger, try {} or {}",
                     ledger - ledger_offset,
@@ -518,12 +565,88 @@ async fn get_history(
         .await
         .map_err(Error::ReadHistoryHttpStream)?;
 
-    print.clear_line();
+    print.clear_previous_line();
     print.globeln(format!("Downloaded history {}", &history_url));
 
     serde_json::from_slice::<History>(&body).map_err(Error::JsonDecodingHistory)
 }
 
+async fn get_ledger_metadata_from_archive(
+    print: &print::Print,
+    archive_url: &Url,
+    ledger: u32,
+) -> Result<(u64, u32), Error> {
+    let archive_url = archive_url.to_string();
+    let archive_url = archive_url.strip_suffix('/').unwrap_or(&archive_url);
+
+    // Calculate the path to the ledger header file
+    let (ledger_hex, ledger_hex_0, ledger_hex_1, ledger_hex_2) = ledger_to_path_components(ledger);
+    let ledger_url = format!(
+        "{archive_url}/ledger/{ledger_hex_0}/{ledger_hex_1}/{ledger_hex_2}/ledger-{ledger_hex}.xdr.gz"
+    );
+
+    print.globeln(format!("Downloading ledger headers {ledger_url}"));
+
+    let ledger_url = Url::from_str(&ledger_url).map_err(Error::ParsingBucketUrl)?;
+    let response = http::client()
+        .get(ledger_url.as_str())
+        .send()
+        .await
+        .map_err(Error::DownloadingHistory)?;
+
+    if !response.status().is_success() {
+        return Err(Error::DownloadingHistoryGotStatusCode(response.status()));
+    }
+
+    // Cache the ledger file to disk like bucket files
+    let ledger_dir = data::bucket_dir().map_err(Error::GetBucketDir)?;
+    let cache_path = ledger_dir.join(format!("ledger-{ledger_hex}.xdr"));
+    let dl_path = cache_path.with_extension("dl");
+
+    let stream = response
+        .bytes_stream()
+        .map(|result| result.map_err(std::io::Error::other));
+    let stream_reader = StreamReader::new(stream);
+    let buf_reader = BufReader::new(stream_reader);
+    let mut decoder = GzipDecoder::new(buf_reader);
+
+    let mut file = OpenOptions::new()
+        .create(true)
+        .truncate(true)
+        .write(true)
+        .open(&dl_path)
+        .await
+        .map_err(Error::WriteOpeningCachedBucket)?;
+
+    tokio::io::copy(&mut decoder, &mut file)
+        .await
+        .map_err(Error::StreamingBucket)?;
+
+    fs::rename(&dl_path, &cache_path).map_err(Error::RenameDownloadFile)?;
+
+    print.clear_previous_line();
+    print.globeln(format!("Downloaded ledger headers for ledger {ledger}"));
+
+    // Now read the cached file
+    let file = std::fs::File::open(&cache_path).map_err(Error::ReadOpeningCachedBucket)?;
+    let limited = &mut Limited::new(file, Limits::none());
+
+    // Find the specific ledger header entry we need
+    let entries = Frame::<LedgerHeaderHistoryEntry>::read_xdr_iter(limited);
+    for entry in entries {
+        let Frame(header_entry) = entry.map_err(Error::Xdr)?;
+
+        if header_entry.header.ledger_seq == ledger {
+            let close_time = header_entry.header.scp_value.close_time.0;
+            let base_reserve = header_entry.header.base_reserve;
+
+            return Ok((close_time, base_reserve));
+        }
+    }
+
+    Err(Error::LedgerNotFound)
+}
+
 async fn cache_bucket(
     print: &print::Print,
     archive_url: &Url,
@@ -539,7 +662,7 @@ async fn cache_bucket(
         let bucket_url =
             format!("{archive_url}/bucket/{bucket_0}/{bucket_1}/{bucket_2}/bucket-{bucket}.xdr.gz");
 
-        print.globe(format!("Downloading bucket {bucket_index} {bucket}…"));
+        print.globeln(format!("Downloading bucket {bucket_index} {bucket}…"));
 
         let bucket_url = Url::from_str(&bucket_url).map_err(Error::ParsingBucketUrl)?;
 
@@ -555,15 +678,13 @@ async fn cache_bucket(
         }
 
         if let Some(len) = response.content_length() {
-            print.clear_line();
-            print.globe(format!(
+            print.clear_previous_line();
+            print.globeln(format!(
                 "Downloaded bucket {bucket_index} {bucket} ({})",
                 ByteSize(len)
             ));
         }
 
-        print.println("");
-
         let stream = response
             .bytes_stream()
             .map(|result| result.map_err(std::io::Error::other));

cmd/soroban-cli/src/print.rs

@@ -1,3 +1,4 @@
+use std::io::{self, Write};
 use std::{env, fmt::Display};
 
 use crate::xdr::{Error as XdrError, Transaction};
@@ -38,6 +39,18 @@ impl Print {
         }
     }
 
+    pub fn clear_previous_line(&self) {
+        if !self.quiet {
+            if cfg!(windows) {
+                eprint!("\x1b[2A\r\x1b[2K");
+            } else {
+                eprint!("\x1b[1A\x1b[2K\r");
+            }
+
+            io::stderr().flush().unwrap();
+        }
+    }
+
     // Some terminals like vscode's and macOS' default terminal will not render
     // the subsequent space if the emoji codepoints size is 2; in this case,
     // we need an additional space.