Merge branch 'main' into ledger-entry-get

Author: elizabethengelman

.github/copilot-instructions.md

@@ -24,6 +24,7 @@ Stellar CLI is a Rust-based command-line tool for interacting with the Stellar n
 
 - Test main soroban-cli library: `cargo test --package soroban-cli --lib` -- takes 52 seconds. NEVER CANCEL.
 - Test individual crates: `cargo test --package <crate-name>` -- typically takes 40 seconds per crate.
+- Test soroban-test integration tests: `cargo test --features it --test it -- integration` -- tests the commands of the cli and is where the bulk of the tests live for this repository. All new commands and changes to commands should include updates or additions to tests in soroban-test.
 - **WARNING**: Full test suite via `make test` requires building WebAssembly test fixtures and consumes significant memory and disk space. It may fail with "No space left on device" in constrained environments.
 
 ### CLI Usage and Validation

.github/workflows/action.yml

@@ -0,0 +1,23 @@
+---
+name: Action
+
+on:
+  pull_request:
+
+concurrency:
+  group:
+    ${{ github.workflow }}-${{ github.ref_protected == 'true' && github.sha ||
+    github.ref }}-{{ github.event_name	}}
+  cancel-in-progress: true
+
+jobs:
+  action:
+    strategy:
+      matrix:
+        image: [macos-13, ubuntu-latest, windows-latest]
+    runs-on: ${{ matrix.image }}
+
+    steps:
+      - uses: stellar/stellar-cli@main
+        with:
+          version: v23.1.4

Cargo.lock

@@ -73,7 +73,7 @@ version = "23.0.1"
 # Dependencies from the rs-stellar-rpc-client repo:
 [workspace.dependencies.soroban-rpc]
 package = "stellar-rpc-client"
-version = "23.1.0"
+version = "23.2.0"
 
 # Dependencies from elsewhere shared by crates:
 [workspace.dependencies]

Cargo.toml

@@ -163,6 +163,13 @@ fn build_with_metadata_rewrite() {
         .success();
 
     let entries = get_entries(&dir_path, &outdir);
+
+    // Filter out CLI version for comparison
+    let filtered_entries: Vec<_> = entries
+        .into_iter()
+        .filter(|entry| !matches!(entry, ScMetaEntry::ScMetaV0(ScMetaV0 { key, .. }) if key.to_string() == "cliver"))
+        .collect();
+
     let expected_entries = vec![
         ScMetaEntry::ScMetaV0(ScMetaV0 {
             key: "Description".try_into().unwrap(),
@@ -174,7 +181,7 @@ fn build_with_metadata_rewrite() {
         }),
     ];
 
-    assert_eq!(entries, expected_entries);
+    assert_eq!(filtered_entries, expected_entries);
 }
 
 #[test]
@@ -212,6 +219,20 @@ fn build_with_metadata_diff_dir() {
         .success();
 
     let entries_dir1 = get_entries(&dir_path, &outdir1);
+
+    let entries_dir2 = get_entries(&dir_path, &outdir2);
+
+    // Filter out CLI version for comparison
+    let filtered_entries_dir1: Vec<_> = entries_dir1
+        .into_iter()
+        .filter(|entry| !matches!(entry, ScMetaEntry::ScMetaV0(ScMetaV0 { key, .. }) if key.to_string() == "cliver"))
+        .collect();
+
+    let filtered_entries_dir2: Vec<_> = entries_dir2
+        .into_iter()
+        .filter(|entry| !matches!(entry, ScMetaEntry::ScMetaV0(ScMetaV0 { key, .. }) if key.to_string() == "cliver"))
+        .collect();
+
     let expected_entries_dir1 = vec![
         ScMetaEntry::ScMetaV0(ScMetaV0 {
             key: "Description".try_into().unwrap(),
@@ -223,7 +244,6 @@ fn build_with_metadata_diff_dir() {
         }),
     ];
 
-    let entries_dir2 = get_entries(&dir_path, &outdir2);
     let expected_entries_dir2 = vec![
         ScMetaEntry::ScMetaV0(ScMetaV0 {
             key: "Description".try_into().unwrap(),
@@ -235,8 +255,8 @@ fn build_with_metadata_diff_dir() {
         }),
     ];
 
-    assert_eq!(entries_dir1, expected_entries_dir1);
-    assert_eq!(entries_dir2, expected_entries_dir2);
+    assert_eq!(filtered_entries_dir1, expected_entries_dir1);
+    assert_eq!(filtered_entries_dir2, expected_entries_dir2);
 }
 
 fn get_entries(fixture_path: &Path, outdir: &Path) -> Vec<ScMetaEntry> {
@@ -380,3 +400,44 @@ fn remap_absolute_paths() {
     assert!(!remap_has_abs_paths);
     assert!(noremap_has_abs_paths);
 }
+
+#[test]
+fn build_always_injects_cli_version() {
+    let sandbox = TestEnv::default();
+    let outdir = sandbox.dir().join("out");
+    let cargo_dir = std::path::PathBuf::from(env!("CARGO_MANIFEST_DIR"));
+    let fixture_path = cargo_dir.join("tests/fixtures/workspace/contracts/add");
+    let temp = TempDir::new().unwrap();
+    let dir_path = temp.path();
+    fs_extra::dir::copy(fixture_path, dir_path, &CopyOptions::new()).unwrap();
+    let dir_path = dir_path.join("add");
+
+    // Build contract without any metadata args
+    sandbox
+        .new_assert_cmd("contract")
+        .current_dir(&dir_path)
+        .arg("build")
+        .arg("--out-dir")
+        .arg(&outdir)
+        .assert()
+        .success();
+
+    let entries = get_entries(&dir_path, &outdir);
+
+    // Verify that CLI version is present
+    let cli_version_entry = entries
+        .iter()
+        .find(|entry| matches!(entry, ScMetaEntry::ScMetaV0(ScMetaV0 { key, .. }) if key.to_string() == "cliver"))
+        .expect("CLI version metadata entry should be present");
+
+    let ScMetaEntry::ScMetaV0(ScMetaV0 { val, .. }) = cli_version_entry;
+    let version_string = val.to_string();
+    assert!(
+        version_string.contains('#'),
+        "CLI version should be in format 'version#git'"
+    );
+    assert!(
+        !version_string.is_empty(),
+        "CLI version should not be empty"
+    );
+}

cmd/crates/soroban-test/tests/it/build.rs

@@ -29,7 +29,7 @@ pub async fn simulate_and_assemble_transaction(
     );
 
     let sim_res = client
-        .simulate_transaction_envelope(&envelope, None, resource_config)
+        .next_simulate_transaction_envelope(&envelope, None, resource_config)
         .await?;
     tracing::trace!("{sim_res:#?}");
 

cmd/soroban-cli/src/assembled.rs

@@ -18,7 +18,7 @@ use std::{
 use stellar_xdr::curr::{Limited, Limits, ScMetaEntry, ScMetaV0, StringM, WriteXdr};
 
 use crate::{
-    commands::{contract::optimize, global},
+    commands::{contract::optimize, global, version},
     print::Print,
     wasm,
 };
@@ -245,7 +245,7 @@ impl Cmd {
                     .join(&self.profile)
                     .join(&file);
 
-                self.handle_contract_metadata_args(&target_file_path)?;
+                self.inject_meta(&target_file_path)?;
 
                 let final_path = if let Some(out_dir) = &self.out_dir {
                     fs::create_dir_all(out_dir).map_err(Error::CreatingOutDir)?;
@@ -343,11 +343,7 @@ impl Cmd {
         cmd.exec()
     }
 
-    fn handle_contract_metadata_args(&self, target_file_path: &PathBuf) -> Result<(), Error> {
-        if self.meta.is_empty() {
-            return Ok(());
-        }
-
+    fn inject_meta(&self, target_file_path: &PathBuf) -> Result<(), Error> {
         let mut wasm_bytes = fs::read(target_file_path).map_err(Error::ReadingWasmFile)?;
         let xdr = self.encoded_new_meta()?;
         wasm_gen::write_custom_section(&mut wasm_bytes, META_CUSTOM_SECTION_NAME, &xdr);
@@ -360,6 +356,15 @@ impl Cmd {
 
     fn encoded_new_meta(&self) -> Result<Vec<u8>, Error> {
         let mut new_meta: Vec<ScMetaEntry> = Vec::new();
+
+        // Always inject CLI version
+        let cli_meta_entry = ScMetaEntry::ScMetaV0(ScMetaV0 {
+            key: "cliver".to_string().try_into().unwrap(),
+            val: version::one_line().clone().try_into().unwrap(),
+        });
+        new_meta.push(cli_meta_entry);
+
+        // Add args provided meta
         for (k, v) in self.meta.clone() {
             let key: StringM = k
                 .clone()

cmd/soroban-cli/src/commands/contract/build.rs

@@ -10,6 +10,7 @@ use clap::{arg, command, Parser};
 use std::convert::Infallible;
 use std::{array::TryFromSliceError, fmt::Debug, num::ParseIntError};
 
+use crate::commands::tx::fetch;
 use crate::{
     assembled::simulate_and_assemble_transaction,
     commands::{
@@ -29,24 +30,39 @@ use crate::commands::contract::deploy::utils::alias_validator;
 pub enum Error {
     #[error("error parsing int: {0}")]
     ParseIntError(#[from] ParseIntError),
+
     #[error(transparent)]
     Client(#[from] SorobanRpcError),
+
     #[error("internal conversion error: {0}")]
     TryFromSliceError(#[from] TryFromSliceError),
+
     #[error("xdr processing error: {0}")]
     Xdr(#[from] XdrError),
+
     #[error(transparent)]
     Config(#[from] config::Error),
+
     #[error(transparent)]
     Data(#[from] data::Error),
+
     #[error(transparent)]
     Network(#[from] network::Error),
+
     #[error(transparent)]
     Builder(#[from] builder::Error),
+
     #[error(transparent)]
     Asset(#[from] builder::asset::Error),
+
     #[error(transparent)]
     Locator(#[from] locator::Error),
+
+    #[error(transparent)]
+    Fee(#[from] fetch::fee::Error),
+
+    #[error(transparent)]
+    Fetch(#[from] fetch::Error),
 }
 
 impl From<Infallible> for Error {
@@ -152,16 +168,19 @@ impl NetworkRunnable for Cmd {
             return Ok(TxnResult::Txn(Box::new(tx)));
         }
 
-        let txn =
+        let assembled =
             simulate_and_assemble_transaction(&client, &tx, self.fee.resource_config()).await?;
-        let txn = self.fee.apply_to_assembled_txn(txn).transaction().clone();
+        let assembled = self.fee.apply_to_assembled_txn(assembled);
+
+        let txn = assembled.transaction().clone();
         let get_txn_resp = client
             .send_transaction_polling(&self.config.sign(txn).await?)
-            .await?
-            .try_into()?;
+            .await?;
+
+        self.fee.print_cost_info(&get_txn_resp)?;
 
         if args.is_none_or(|a| !a.no_cache) {
-            data::write(get_txn_resp, &network.rpc_uri()?)?;
+            data::write(get_txn_resp.clone().try_into()?, &network.rpc_uri()?)?;
         }
 
         Ok(TxnResult::Res(stellar_strkey::Contract(contract_id.0)))