Merge #310: Release 0.6.0 of simplicity-lang and simplicity-sys

2d45fda bump version of simplicity-lang to 0.6.0 (Andrew Poelstra)
b36efa2 bump version of simplicity-sys to 0.6.0 (Andrew Poelstra)
196a39d clean up README example; add some top-level docs to library (Andrew Poelstra)

Pull request description:

  Cut a new release with the FFI fixes and ghostcell stuff.


ACKs for top commit:
  canndrew:
    ACK 2d45fda


Tree-SHA512: 2c6b23b0a8556f36bcc97aa9ec59de780347ce72debb032896000782d2a778aa590382e2a55373fbf45d1ec0b863e9a457c87e4fbea85759a4178c8dde375e9f

Author: apoelstra

CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.6.0 - 2025-09-17
+
+* Improve FFI API and fix soundness issues [#307](https://github.com/BlockstreamResearch/rust-simplicity/pull/288)
+* Decrease MSRV to 1.74.0, matching rust-bitcoin [#308](https://github.com/BlockstreamResearch/rust-simplicity/pull/308)
+* Use `ghost_cell` within `types::Context`, requiring users to construct programs within a single Rust lexical scope [#305](https://github.com/BlockstreamResearch/rust-simplicity/pull/305)
+
 # 0.5.0 - 2025-07-29
 
 * Add generic `CaseTracker` in bit machine for debugging [#288](https://github.com/BlockstreamResearch/rust-simplicity/pull/288)

Cargo-recent.lock

@@ -425,7 +425,7 @@ checksum = "0fda2ff0d084019ba4d7c6f371c95d8fd75ce3524c3cb8fb653a3023f6323e64"
 name = "simpcli"
 version = "0.3.0"
 dependencies = [
- "simplicity-lang 0.5.0",
+ "simplicity-lang 0.6.0",
 ]
 
 [[package]]
@@ -435,7 +435,7 @@ dependencies = [
  "base64 0.22.1",
  "libfuzzer-sys",
  "simplicity-lang 0.3.1",
- "simplicity-lang 0.5.0",
+ "simplicity-lang 0.6.0",
 ]
 
 [[package]]
@@ -455,7 +455,7 @@ dependencies = [
 
 [[package]]
 name = "simplicity-lang"
-version = "0.5.0"
+version = "0.6.0"
 dependencies = [
  "bitcoin",
  "bitcoin_hashes",
@@ -467,7 +467,7 @@ dependencies = [
  "miniscript",
  "santiago",
  "serde",
- "simplicity-sys 0.5.0",
+ "simplicity-sys 0.6.0",
 ]
 
 [[package]]
@@ -482,7 +482,7 @@ dependencies = [
 
 [[package]]
 name = "simplicity-sys"
-version = "0.5.0"
+version = "0.6.0"
 dependencies = [
  "bitcoin_hashes",
  "cc",

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "simplicity-lang"
-version = "0.5.0"
+version = "0.6.0"
 authors = ["Andrew Poelstra <apoelstra@wpsoftware.net>"]
 license = "CC0-1.0"
 homepage = "https://github.com/BlockstreamResearch/rust-simplicity/"
@@ -30,14 +30,14 @@ ghost-cell = { version = "0.2.6", default-features = false }
 hashes = { package = "bitcoin_hashes", version = "0.14" }
 hex = { package = "hex-conservative", version = "0.2.1" }
 santiago = "1.3"
-simplicity-sys = { version = "0.5.0", path = "./simplicity-sys" }
+simplicity-sys = { version = "0.6.0", path = "./simplicity-sys" }
 serde = { version = "1.0.103", features = ["derive"], optional = true }
 
 [target.wasm32-unknown-unknown.dependencies]
 getrandom = { version = "0.2", features = ["js"] }
 
 [dev-dependencies]
-simplicity-sys = { version = "0.5.0", path = "./simplicity-sys", features = [
+simplicity-sys = { version = "0.6.0", path = "./simplicity-sys", features = [
     "test-utils",
 ] }
 

README.md

@@ -58,17 +58,19 @@ simplicity-lang = "0.5"
 ```rust
 use simplicity::node::CoreConstructible;
 use simplicity::types::Context;
-use simplicity::{ConstructNode, Core};
+use simplicity::{ConstructNode, jet::Core};
 use std::sync::Arc;
 
 // Create a trivial Simplicity program
-let ctx = Context::new();
-let program = Arc::<ConstructNode<Core>>::unit(&ctx);
+let program = Context::with_context(|ctx| {
+    let construct = Arc::<ConstructNode<Core>>::unit(&ctx);
+    construct.finalize_types().unwrap()
+});
 
 // Encode the program to bytes
-let encoded = simplicity::bit_encoding::write_to_vec(|w| {
+let encoded: Vec<u8> = simplicity::write_to_vec(|w| {
     program.encode_without_witness(w)
-}).unwrap();
+});
 ```
 
 ## Relationship to libsimplicity

fuzz/Cargo.toml

@@ -16,7 +16,7 @@ path = "fuzz_lib/lib.rs"
 libfuzzer-sys = "0.4"
 # We shouldn't need an explicit version on the next line, but Andrew's tools
 # choke on it otherwise. See https://github.com/nix-community/crate2nix/issues/373
-simplicity-lang = { path = "..", features = ["test-utils"], version = "0.5.0" }
+simplicity-lang = { path = "..", features = ["test-utils"], version = "0.6.0" }
 old_simplicity = { package = "simplicity-lang", version = "0.3.1", default-features = false }
 
 [dev-dependencies]

fuzz/generate-files.sh

@@ -27,7 +27,7 @@ path = "fuzz_lib/lib.rs"
 libfuzzer-sys = "0.4"
 # We shouldn't need an explicit version on the next line, but Andrew's tools
 # choke on it otherwise. See https://github.com/nix-community/crate2nix/issues/373
-simplicity-lang = { path = "..", features = ["test-utils"], version = "0.4.0" }
+simplicity-lang = { path = "..", features = ["test-utils"], version = "0.6.0" }
 old_simplicity = { package = "simplicity-lang", version = "0.3.1", default-features = false }
 
 [dev-dependencies]

simpcli/Cargo.toml

@@ -7,7 +7,7 @@ edition = "2018"
 
 [dependencies]
 # todo add lexopt for command line parsing
-simplicity-lang = { version = "0.5", path = "..", features = [ "base64", "serde", "elements" ] }
+simplicity-lang = { version = "0.6.0", path = "..", features = [ "base64", "serde", "elements" ] }
 
 [[bin]]
 name = "simpcli"

simplicity-sys/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "simplicity-sys"
-version = "0.5.0"
+version = "0.6.0"
 license = "CC0-1.0"
 homepage = "https://github.com/BlockstreamResearch/rust-simplicity/"
 repository = "https://github.com/BlockstreamResearch/rust-simplicity/"
@@ -9,7 +9,7 @@ description = "FFI bindings to libsimplicity"
 edition = "2021"
 rust-version = "1.74.0"
 build = "build.rs"
-links = "rustsimplicity_0_5"
+links = "rustsimplicity_0_6"
 
 [build-dependencies]
 cc = "1.0.83"

simplicity-sys/depend/env.c

@@ -11,23 +11,23 @@ typedef rawElementsInput rawInput;
 typedef rawElementsTransaction rawTransaction;
 typedef rawElementsTapEnv rawTapEnv;
 
-const size_t rustsimplicity_0_5_c_sizeof_rawElementsBuffer = sizeof(rawElementsBuffer);
-const size_t rustsimplicity_0_5_c_sizeof_rawElementsOutput = sizeof(rawElementsOutput);
-const size_t rustsimplicity_0_5_c_sizeof_rawElementsInput = sizeof(rawElementsInput);
-const size_t rustsimplicity_0_5_c_sizeof_rawElementsTransaction = sizeof(rawElementsTransaction);
-const size_t rustsimplicity_0_5_c_sizeof_rawElementsTapEnv = sizeof(rawElementsTapEnv);
-const size_t rustsimplicity_0_5_c_sizeof_txEnv = sizeof(txEnv);
+const size_t rustsimplicity_0_6_c_sizeof_rawElementsBuffer = sizeof(rawElementsBuffer);
+const size_t rustsimplicity_0_6_c_sizeof_rawElementsOutput = sizeof(rawElementsOutput);
+const size_t rustsimplicity_0_6_c_sizeof_rawElementsInput = sizeof(rawElementsInput);
+const size_t rustsimplicity_0_6_c_sizeof_rawElementsTransaction = sizeof(rawElementsTransaction);
+const size_t rustsimplicity_0_6_c_sizeof_rawElementsTapEnv = sizeof(rawElementsTapEnv);
+const size_t rustsimplicity_0_6_c_sizeof_txEnv = sizeof(txEnv);
 
-const size_t rustsimplicity_0_5_c_alignof_rawElementsBuffer = alignof(rawElementsBuffer);
-const size_t rustsimplicity_0_5_c_alignof_rawElementsOutput = alignof(rawElementsOutput);
-const size_t rustsimplicity_0_5_c_alignof_rawElementsInput = alignof(rawElementsInput);
-const size_t rustsimplicity_0_5_c_alignof_rawElementsTransaction = alignof(rawElementsTransaction);
-const size_t rustsimplicity_0_5_c_alignof_rawElementsTapEnv = alignof(rawElementsTapEnv);
-const size_t rustsimplicity_0_5_c_alignof_txEnv = alignof(txEnv);
+const size_t rustsimplicity_0_6_c_alignof_rawElementsBuffer = alignof(rawElementsBuffer);
+const size_t rustsimplicity_0_6_c_alignof_rawElementsOutput = alignof(rawElementsOutput);
+const size_t rustsimplicity_0_6_c_alignof_rawElementsInput = alignof(rawElementsInput);
+const size_t rustsimplicity_0_6_c_alignof_rawElementsTransaction = alignof(rawElementsTransaction);
+const size_t rustsimplicity_0_6_c_alignof_rawElementsTapEnv = alignof(rawElementsTapEnv);
+const size_t rustsimplicity_0_6_c_alignof_txEnv = alignof(txEnv);
 
-void rustsimplicity_0_5_c_set_txEnv(txEnv *result, const elementsTransaction *tx, const elementsTapEnv *taproot, const unsigned char *genesisHash, unsigned int ix)
+void rustsimplicity_0_6_c_set_txEnv(txEnv *result, const elementsTransaction *tx, const elementsTapEnv *taproot, const unsigned char *genesisHash, unsigned int ix)
 {
     sha256_midstate genesis;
     sha256_toMidstate(genesis.s, genesisHash);
-    *result = rustsimplicity_0_5_elements_build_txEnv(tx, taproot, &genesis, ix);
+    *result = rustsimplicity_0_6_elements_build_txEnv(tx, taproot, &genesis, ix);
 }

simplicity-sys/depend/simplicity/bitstream.c

@@ -10,7 +10,7 @@
  *
  * Precondition: NULL != stream
  */
-simplicity_err rustsimplicity_0_5_closeBitstream(bitstream* stream) {
+simplicity_err rustsimplicity_0_6_closeBitstream(bitstream* stream) {
   if (1 < stream->len) return SIMPLICITY_ERR_BITSTREAM_TRAILING_BYTES;        /* If there is more than one byte remaining. */
   if (1 == stream->len) {
     if (0 == stream->offset) return SIMPLICITY_ERR_BITSTREAM_TRAILING_BYTES;  /* If there is one byte remaining */
@@ -30,8 +30,8 @@ simplicity_err rustsimplicity_0_5_closeBitstream(bitstream* stream) {
  * Precondition: 0 <= n < 32
  *               NULL != stream
  */
-int32_t rustsimplicity_0_5_readNBits(int n, bitstream* stream) {
-  rustsimplicity_0_5_assert(0 <= n && n < 32);
+int32_t rustsimplicity_0_6_readNBits(int n, bitstream* stream) {
+  rustsimplicity_0_6_assert(0 <= n && n < 32);
 
   uint32_t result = 0;
   while (CHAR_BIT <= stream->offset + n) {
@@ -109,7 +109,7 @@ static int32_t decodeUpto3Bits(int32_t* result, bitstream* stream) {
   } else {
     int32_t n = decodeUpto3(stream);
     if (0 <= n) {
-      *result = rustsimplicity_0_5_readNBits(n, stream);
+      *result = rustsimplicity_0_6_readNBits(n, stream);
       if (*result < 0) return *result;
     }
     return n;
@@ -153,7 +153,7 @@ static int32_t decodeUpto15Bits(int32_t* result, bitstream* stream) {
   } else {
     int32_t n = decodeUpto15(stream);
     if (0 <= n) {
-      *result = rustsimplicity_0_5_readNBits(n, stream);
+      *result = rustsimplicity_0_6_readNBits(n, stream);
       if (*result < 0) return *result;
     }
     return n;
@@ -184,7 +184,7 @@ static int32_t decodeUpto65535(bitstream* stream) {
  *
  * Precondition: NULL != stream
  */
-int32_t rustsimplicity_0_5_decodeUptoMaxInt(bitstream* stream) {
+int32_t rustsimplicity_0_6_decodeUptoMaxInt(bitstream* stream) {
   int32_t bit = read1Bit(stream);
   if (bit < 0) return bit;
   if (0 == bit) {
@@ -194,7 +194,7 @@ int32_t rustsimplicity_0_5_decodeUptoMaxInt(bitstream* stream) {
     if (n < 0) return n;
     if (30 < n) return SIMPLICITY_ERR_DATA_OUT_OF_RANGE;
     {
-      int32_t result = rustsimplicity_0_5_readNBits(n, stream);
+      int32_t result = rustsimplicity_0_6_readNBits(n, stream);
       if (result < 0) return result;
       return ((1 << n) | result);
     }
@@ -211,9 +211,9 @@ int32_t rustsimplicity_0_5_decodeUptoMaxInt(bitstream* stream) {
  *               n <= 2^31
  *               NULL != stream
  */
-simplicity_err rustsimplicity_0_5_readBitstring(bitstring* result, size_t n, bitstream* stream) {
+simplicity_err rustsimplicity_0_6_readBitstring(bitstring* result, size_t n, bitstream* stream) {
   static_assert(0x80000000u + 2*(CHAR_BIT - 1) <= SIZE_MAX, "size_t needs to be at least 32-bits");
-  rustsimplicity_0_5_assert(n <= 0x80000000u);
+  rustsimplicity_0_6_assert(n <= 0x80000000u);
   size_t total_offset = n + stream->offset;
   /* |= stream->len * CHAR_BIT < total_offset iff stream->len < (total_offset + (CHAR_BIT - 1)) / CHAR_BIT */
   if (stream->len < (total_offset + (CHAR_BIT - 1)) / CHAR_BIT) return SIMPLICITY_ERR_BITSTREAM_EOF;