Merge branch 'main' into feat/data_logging

.github/workflows/rust.yml

@@ -26,6 +26,14 @@ jobs:
     - run: rustup update
     - run: cargo fmt --all --check
 
+  check-generated-examples-list:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - run: make generate-examples-list
+    - name: Check no diffs exist
+      run: git add -N . && git diff HEAD --exit-code
+
   build-and-test:
     strategy:
       fail-fast: false

Makefile

@@ -41,6 +41,11 @@ build-test-wasms:
 
 build-test: build-test-wasms install
 
+generate-examples-list:
+	curl -sSL https://api.github.com/repos/stellar/soroban-examples/git/trees/main \
+		| jq -r '.tree[] | select(.type != "blob" and .path != "hello_world" and (.path | startswith(".") | not)) | .path' \
+		> cmd/soroban-cli/example_contracts.list
+
 test: build-test
 	cargo test
 

cmd/soroban-cli/build.rs

@@ -1,124 +1,3 @@
 fn main() {
     crate_git_revision::init();
-    build_helper::set_example_contracts();
-}
-
-mod build_helper {
-    use std::{
-        fs::{metadata, File, Metadata},
-        io::{self, Write},
-        path::{Path, PathBuf},
-    };
-
-    const GITHUB_API_URL: &str =
-        "https://api.github.com/repos/stellar/soroban-examples/git/trees/main?recursive=1";
-
-    pub fn set_example_contracts() {
-        let example_contracts = get_example_contracts().unwrap();
-        let w = &mut std::io::stdout();
-        set_example_contracts_env_var(w, &example_contracts).unwrap();
-    }
-
-    #[derive(serde::Deserialize, Debug)]
-    struct RepoPath {
-        path: String,
-        #[serde(rename = "type")]
-        type_field: String,
-    }
-
-    #[derive(serde::Deserialize, Debug)]
-    struct ReqBody {
-        tree: Vec<RepoPath>,
-    }
-
-    #[derive(thiserror::Error, Debug)]
-    pub enum Error {
-        #[error("Failed to complete get request")]
-        UreqError(#[from] Box<ureq::Error>),
-
-        #[error("Io error: {0}")]
-        IoError(#[from] std::io::Error),
-    }
-
-    fn get_example_contracts() -> Result<String, Error> {
-        if file_exists(&cached_example_contracts_file_path()) {
-            let example_contracts = std::fs::read_to_string(cached_example_contracts_file_path())?;
-            return Ok(example_contracts);
-        }
-
-        Ok(fetch_and_cache_example_contracts())
-    }
-
-    fn fetch_and_cache_example_contracts() -> String {
-        let example_contracts = fetch_example_contracts().unwrap().join(",");
-        let cached_example_contracts = target_dir().join("example_contracts.txt");
-
-        if let Err(err) = write_cache(&cached_example_contracts, &example_contracts) {
-            eprintln!("Error writing cache: {err}");
-        }
-
-        example_contracts
-    }
-
-    fn fetch_example_contracts() -> Result<Vec<String>, Error> {
-        let body: ReqBody = ureq::get(GITHUB_API_URL)
-            .call()
-            .map_err(Box::new)?
-            .into_json()?;
-        let mut valid_examples = Vec::new();
-        for item in body.tree {
-            if item.type_field == "blob"
-                || item.path.starts_with('.')
-                || item.path.contains('/')
-                || item.path == "hello_world"
-            {
-                continue;
-            }
-
-            valid_examples.push(item.path);
-        }
-
-        Ok(valid_examples)
-    }
-
-    fn set_example_contracts_env_var(
-        w: &mut impl std::io::Write,
-        example_contracts: &str,
-    ) -> std::io::Result<()> {
-        writeln!(w, "cargo:rustc-env=EXAMPLE_CONTRACTS={example_contracts}")?;
-        Ok(())
-    }
-
-    fn cached_example_contracts_file_path() -> PathBuf {
-        target_dir().join("example_contracts.txt")
-    }
-
-    fn target_dir() -> PathBuf {
-        project_root().join("target")
-    }
-
-    fn project_root() -> PathBuf {
-        Path::new(&env!("CARGO_MANIFEST_DIR"))
-            .ancestors()
-            .nth(2)
-            .unwrap()
-            .to_path_buf()
-    }
-
-    fn write_cache(cache_file_path: &Path, data: &str) -> io::Result<()> {
-        // Create or open the cache file
-        let mut file = File::create(cache_file_path)?;
-
-        // Write the data to the cache file
-        file.write_all(data.as_bytes())?;
-
-        Ok(())
-    }
-
-    fn file_exists(file_path: &Path) -> bool {
-        metadata(file_path)
-            .as_ref()
-            .map(Metadata::is_file)
-            .unwrap_or(false)
-    }
 }

cmd/soroban-cli/example_contracts.list

@@ -0,0 +1,23 @@
+account
+alloc
+atomic_multiswap
+atomic_swap
+auth
+cross_contract
+custom_types
+deep_contract_auth
+deployer
+errors
+eth_abi
+events
+fuzzing
+increment
+liquidity_pool
+logging
+mint-lock
+simple_account
+single_offer
+timelock
+token
+upgradeable_contract
+workspace

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

@@ -50,7 +50,9 @@ pub struct Cmd {
 }
 
 fn possible_example_values() -> ValueParser {
-    let example_contracts = env!("EXAMPLE_CONTRACTS").split(',').collect::<Vec<&str>>();
+    let example_contracts = include_str!("../../../example_contracts.list")
+        .lines()
+        .collect::<Vec<&str>>();
     let parser = PossibleValuesParser::new(example_contracts.iter().map(PossibleValue::new));
     parser.into()
 }