Dev

.github/workflows/release.yml

@@ -67,17 +67,23 @@ jobs:
           cargo build --target $TARGET --profile $RUST_PROFILE --bins
           mv $OUT_DIR/${{ env.RUST_PROFILE }}/simplex simplex
 
-      - name: Download nextest, elementsd and electrs
+      - name: Download nextest, simfmt, elementsd and electrs
         env:
           NEXTEST_VERSION: "0.9.137"
           ELEMENTSD_VERSION: "23.3.1"
+          SIMFMT_VERSION: "0.0.2"
           ELEMENTSD_TARGET: ${{ matrix.elementsd_target }}
           ELECTRS_TARGET: ${{ matrix.electrs_target }}
           NEXTEST_TARGET: ${{ matrix.nextest_target }}
+          SIMFMT_TARGET: ${{ matrix.target }}
         run: |
+          #!/usr/bin/env bash
+          set -eo pipefail
+
           ELEMENTSD_FILENAME="elements-${ELEMENTSD_VERSION}-${ELEMENTSD_TARGET}.tar.gz"
           ELECTRS_FILENAME="electrs_${ELECTRS_TARGET}_esplora_027e38d3ebc2f85b28ae76f8f3448438ee4fc7b1_liquid.zip"
           NEXTEST_FILENAME="cargo-nextest-${NEXTEST_VERSION}-${NEXTEST_TARGET}.tar.gz"
+          SIMFMT_FILENAME="simfmt-v${SIMFMT_VERSION}-${SIMFMT_TARGET}.tar.gz"
 
           curl -Ls "https://github.com/ElementsProject/elements/releases/download/elements-${ELEMENTSD_VERSION}/${ELEMENTSD_FILENAME}" -o ${ELEMENTSD_FILENAME}
           tar -xzf ${ELEMENTSD_FILENAME} && rm ${ELEMENTSD_FILENAME}
@@ -90,6 +96,9 @@ jobs:
           curl -Ls "https://github.com/nextest-rs/nextest/releases/download/cargo-nextest-${NEXTEST_VERSION}/${NEXTEST_FILENAME}" -o ${NEXTEST_FILENAME}
           tar -xzf ${NEXTEST_FILENAME} && rm ${NEXTEST_FILENAME}
           mv cargo-nextest smplx-nextest
+
+          curl -fLsS "https://github.com/BlockstreamResearch/simfmt/releases/download/v${SIMFMT_VERSION}/${SIMFMT_FILENAME}" -o "${SIMFMT_FILENAME}"
+          tar -xzf "${SIMFMT_FILENAME}" && rm "${SIMFMT_FILENAME}"
 
       - name: Sign elementsd binary
         run: |
@@ -106,6 +115,7 @@ jobs:
             elementsd
             electrs
             smplx-nextest
+            simfmt
 
       - name: Record attestation URL
         env:
@@ -116,7 +126,7 @@ jobs:
       - name: Archive binaries
         env:
           ARCHIVE: simplex-${{ github.event.inputs.tag || github.ref_name }}-${{ matrix.archive }}
-        run: tar czf ${ARCHIVE} simplex elementsd electrs smplx-nextest
+        run: tar czf ${ARCHIVE} simplex elementsd electrs smplx-nextest simfmt
 
       - name: Upload build artifacts
         uses: actions/upload-artifact@v6
@@ -163,11 +173,14 @@ jobs:
       contents: read
       id-token: write
     concurrency:
-      group: publish-core-${{ github.ref }}
+      group: publish-core-${{ github.event.inputs.tag || github.ref }}
       cancel-in-progress: false
     steps:
       - name: Checkout
         uses: actions/checkout@v6
+        with:
+          persist-credentials: false
+          ref: ${{ github.event.inputs.tag || github.ref }}
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@stable

CHANGELOG.md

@@ -1,5 +1,68 @@
 # Changelog
 
+## [0.2.0]
+
+- Added `simplex fmt` to format SimplicityHL sources with `simfmt`, which `simplexup` now installs.
+- Rewrote fuzz testing to a much more versatile and smart suite.
+- Made every command find `Simplex.toml` in the current directory or any of its ancestors.
+
+### fuzz
+
+- Replaced the single-program fuzz engine with `Scenario`, a transaction template where each program `spends` inputs and `locks` outputs.
+- Added `bind_arguments` and `bind_witness` to derive values from the case, and `requires_witness` for values the fuzzer also violates to check that the contract rejects them.
+- Added `spec` to state when a case must be accepted, rejected or either, read from `FuzzCase`.
+- Added transaction `Mutations` of amounts, assets, timelocks and layout, applied to the template's targeted inputs and outputs.
+- Added lock and authorization smart checks that redirect locked outputs and replay signatures from a wrong key.
+- Added `spending_path` and `storage_capacity` to the program builder, and `random_strategy` and `custom_strategy` to replace the guided default.
+- Added a run summary of verdicts, rejections, spec predictions, violations, mutations and smart checks.
+- Removed `FuzzableProgram`, `FuzzTransaction`, `ArgsStrategyBuilder`, `ProgramCheck` and `FuzzError`.
+
+### sdk
+
+- Replaced `RequiredSignature` arguments with `Option<NativeSignature>` for native inputs and `Option<ProgramSignature>` for program inputs, built as `ProgramSignature::new(name).at_path(path).tagged(tag)`.
+- Made `Signer` sign only inputs that request a native signature and refuse a key that doesn't own a P2WPKH input.
+- Made `Signer` derive its keys and addresses once, and reuse one sighash cache per transaction.
+- Reduced how often coin selection signs the transaction.
+- Fixed coin selection: skip UTXOs listed twice, skip confidential UTXOs for an explicit change target, and keep blinded change that would reveal a blinded amount.
+- Fixed fees: report the whole leftover as the fee when change is dropped, and fold explicit change below the 22 sat dust threshold into the fee.
+- Made a set locktime enforced by default, by giving inputs without a sequence `ENABLE_LOCKTIME_NO_RBF`.
+- Made per-input `sequence` and `locktime` optional, so an explicit `Sequence::MAX` or `LockTime::ZERO` is kept.
+- Made `get_utxos` skip outputs the wallet can't unblind, instead of failing.
+- Replaced panics with errors for unknown input amounts, amount overflows, invalid fee rates, duplicate inputs, empty issuances, unblinded reissuance tokens, inputs without a witness UTXO and invalid derivation paths.
+- Fixed token-only issuance by encoding a zero asset amount as null.
+- Added `FinalTransaction::sequence` and `locktime` getters.
+- Added `Program::set_storage`, `get_arguments` and `MAX_STORAGE_SLOTS`, and capped storage at 128 slots.
+- Made `SimplexProvider::broadcast_transaction` wait until Esplora indexes the transaction.
+- Cached the program's CMR, witness types and taproot spend info.
+
+### build
+
+- Refused a dependency `src_dir` that resolves outside its package.
+- Refused an `out_dir` that holds the project or its `src_dir`, in both `build` and `clean`.
+- Refused source directories that aren't Rust identifiers, before writing any artifact.
+- Warned about `.simf` files that don't parse, instead of skipping them silently.
+
+### install
+
+- Resolved tags and branches by their full ref.
+- Made git dependency directory names unambiguous.
+- Made installs atomic, and reported an incomplete dependency instead of treating it as installed.
+
+### init
+
+- Made `simplex init` optimize dependencies in dev builds, which speeds up tests.
+
+### wasm
+
+- Rejected issuances of zero, reissuance tokens with a zero blinding factor, derivation paths other than `m/n`, and more than 128 extra leaves.
+
+### simplexup
+
+- Verified binaries before installing them and refused versions whose install didn't complete.
+- Verified the attestation's signer with `gh` when the GitHub CLI is installed and logged in.
+- Installed `--commit` builds as their own version.
+- Made `--use` switch every binary to the chosen version.
+
 ## [0.1.1]
 
 - Fixed broken dependencies.

Cargo.toml

@@ -8,13 +8,13 @@ license = "MIT"
 edition = "2024"
 
 [workspace.dependencies]
-smplx-macros = { path = "./crates/macros", version = "=0.1.1" }
-smplx-build = { path = "./crates/build", version = "=0.1.1" }
-smplx-test = { path = "./crates/test", version = "=0.1.1" }
-smplx-regtest = { path = "./crates/regtest", version = "=0.1.1" }
-smplx-sdk = { path = "./crates/sdk", version = "=0.1.1", default-features = false }
-smplx-std = { path = "./crates/simplex", version = "=0.1.1" }
-smplx-wasm = { path = "./crates/wasm", version = "=0.1.1" }
+smplx-macros = { path = "./crates/macros", version = "=0.2.0" }
+smplx-build = { path = "./crates/build", version = "=0.2.0" }
+smplx-test = { path = "./crates/test", version = "=0.2.0" }
+smplx-regtest = { path = "./crates/regtest", version = "=0.2.0" }
+smplx-sdk = { path = "./crates/sdk", version = "=0.2.0", default-features = false }
+smplx-std = { path = "./crates/simplex", version = "=0.2.0" }
+smplx-wasm = { path = "./crates/wasm", version = "=0.2.0" }
 
 rand_core = { version = "=0.10.1" }
 rand = { version = "=0.10.3" }

README.md

@@ -130,6 +130,7 @@ Simplex CLI provides the following commands:
 - `simplex regtest` - Spins up local Electrs + Elements nodes.
 - `simplex test` - Runs Simplex tests. Provide a `--fuzz` flag to run Simplex fuzz tests.
 - `simplex clean` - Cleans up generated artifacts and installed dependencies.
+- `simplex fmt` - Formats SimplicityHL files according to the specified `simfmt.toml` or default [configuration](https://github.com/BlockstreamResearch/simfmt/blob/master/simfmt.toml).  
 
 To view the available options, run the help command:
 
@@ -150,11 +151,12 @@ We are open to any mind-blowing ideas! Please take a look at our [contributing g
 - [x] SimplicityHL storage compatibility.
 - [x] SimplicityHL dependencies management.
 - [x] Fuzz testing for SimplicityHL contracts.
-- [ ] SDK support for confidential assets, taproot signer, and custom witness signatures.
+- [x] Browser compatibility.
+- [ ] SDK support for taproot signer and custom descriptors.
 - [ ] SimplicityHL contracts static analyzer.
+- [ ] Test coverage reporting.
 - [ ] Local regtest 10x speedup.
 - [ ] Regtest cheat codes.
-- [ ] Browser compatibility.
 - [ ] Comprehensive documentation.
 
 Check out the full roadmap [here](https://github.com/orgs/BlockstreamResearch/projects/3).

crates/build/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "smplx-build"
-version = "0.1.1"
+version = "0.2.0"
 description = "Simplex build command internal implementation"
 license.workspace = true
 edition.workspace = true

crates/build/src/collector.rs

@@ -82,6 +82,15 @@ impl DepCollector {
             let loaded_simf_dir = CanonPath::canonicalize(&loaded_context.as_path().join(loaded_src_dir))
                 .map_err(BuildError::PathCanonicalization)?;
 
+            // A dependency may only define import contexts inside its own package.
+            if !loaded_simf_dir.starts_with(&loaded_context) {
+                return Err(BuildError::DependencySourceOutsidePackage {
+                    dep_name: dep_name.clone(),
+                    package_root: loaded_context.as_path().to_path_buf(),
+                    source_dir: loaded_simf_dir.as_path().to_path_buf(),
+                });
+            }
+
             self.builder
                 .add_dependency(simf_dir.clone(), dep_name.clone(), loaded_simf_dir.clone());
 

crates/build/src/error.rs

@@ -86,6 +86,12 @@ pub enum BuildError {
     #[error("Invalid generation path: '{0}'")]
     GenerationPath(String),
 
+    #[error("out_dir '{0}' holds the project or its src_dir")]
+    OutDirHoldsSources(PathBuf),
+
+    #[error("Directory '{name}' in '{path}' must be a Rust identifier to become a module of the bindings")]
+    InvalidModuleName { name: String, path: PathBuf },
+
     #[error("Failed to extract content from path, err: '{0}'")]
     FailedToExtractContent(io::Error),
 
@@ -112,6 +118,15 @@ pub enum BuildError {
     #[error("Failed to build dependency map: {0}")]
     DependencyMap(String),
 
+    #[error(
+        "Dependency '{dep_name}' src_dir resolves outside its package: '{source_dir}' (package root: '{package_root}')"
+    )]
+    DependencySourceOutsidePackage {
+        dep_name: String,
+        package_root: PathBuf,
+        source_dir: PathBuf,
+    },
+
     #[error("Failed to flatten program: {0}")]
     Flattening(String),
 

crates/build/src/generator.rs

@@ -82,6 +82,10 @@ impl ArtifactsGenerator {
         let simf_out_dir = out_dir.join(pathdiff);
         let mut metadata = Metadata::default();
 
+        for simf in simfs {
+            Self::check_module_names(simf.as_ref(), base_dir)?;
+        }
+
         let artifacts = simfs
             .iter()
             .map(|s| Self::process_simf(s.as_ref(), base_dir, validated_deps, &simf_out_dir, &mut metadata))
@@ -177,6 +181,29 @@ impl ArtifactsGenerator {
         })
     }
 
+    /// Every directory between `base_dir` and `source` becomes a module of the bindings.
+    fn check_module_names(source: &Path, base_dir: &Path) -> Result<(), BuildError> {
+        let relative_path = source
+            .strip_prefix(base_dir)
+            .map_err(BuildError::NoBasePathForGeneration)?;
+
+        for dir in relative_path.parent().into_iter().flat_map(Path::components) {
+            let Component::Normal(name) = dir else {
+                continue;
+            };
+            let name = name.to_string_lossy();
+
+            if syn::parse_str::<syn::Ident>(&name).is_err() {
+                return Err(BuildError::InvalidModuleName {
+                    name: name.into_owned(),
+                    path: source.to_path_buf(),
+                });
+            }
+        }
+
+        Ok(())
+    }
+
     /// Arranges a flat list of artifacts into a tree mirroring the source directory layout.
     fn build_tree(artifacts: Vec<SimfArtifact>) -> Result<TreeNode, BuildError> {
         let mut root = TreeNode::default();
@@ -391,3 +418,29 @@ impl ArtifactsGenerator {
         Ok(code)
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use super::*;
+
+    #[test]
+    fn directories_must_be_rust_identifiers() {
+        let base = Path::new("/project/simf");
+
+        for valid in ["vault.simf", "vaults/vault.simf", "vaults/_2024/vault.simf"] {
+            assert!(
+                ArtifactsGenerator::check_module_names(&base.join(valid), base).is_ok(),
+                "{valid}"
+            );
+        }
+        for invalid in ["my-contracts/vault.simf", "2024/vault.simf", "mod/vault.simf"] {
+            assert!(
+                matches!(
+                    ArtifactsGenerator::check_module_names(&base.join(invalid), base),
+                    Err(BuildError::InvalidModuleName { .. })
+                ),
+                "{invalid}"
+            );
+        }
+    }
+}