Merge branch 'BlockstreamResearch-master'

Author: imaginator

CHANGELOG.md

@@ -1,3 +1,4 @@
-# 0.1.0 - 2025-04-10
+# 0.2.0 - 2025-07-29
 
+* Renamed from [Simfony](https://crates.io/crates/simfony)
 * Initial release. Not recommended for production use.

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "simplicityhl"
-version = "0.1.0"
+version = "0.2.0"
 authors = ["sanket1729 <sanket1729@gmail.com>"]
 license = "CC0-1.0"
 homepage = "https://github.com/BlockstreamResearch/SimplicityHL"
@@ -26,7 +26,7 @@ pest = "2.1.3"
 pest_derive = "2.7.1"
 serde = { version = "1.0.188", features = ["derive"], optional = true }
 serde_json = { version = "1.0.105", optional = true }
-simplicity-lang = { version = "0.4.0" }
+simplicity-lang = { version = "0.5.0" }
 miniscript = "12.3.1"
 either = "1.12.0"
 itertools = "0.13.0"

Cargo.toml

@@ -29,11 +29,11 @@ Simplicity introduces a groundbreaking low-level programming language and machin
 The distinguishing aspects that set Simplicity apart from conventional programming languages are:
 
 - **Distinct Programming Paradigm**: Simplicity's programming model requires a paradigm shift from conventional programming. It hinges on reasoning about programs in a functional sense with a focus on combinators. This intricacy surpasses even popular functional languages like Haskell, with its own unique challenges.
-- **Exceptional Low-Level Nature**: Unlike high-level languages such as JavaScript or Python, Simplicity operates at an extremely low level, resembling assembly languages. This design choice enables easier reasoning about the formal semantics of programs, but is really work on directly.
+- **Exceptional Low-Level Nature**: Unlike high-level languages such as JavaScript or Python, Simplicity operates at an extremely low level, resembling assembly languages. This design choice enables easier reasoning about the formal semantics of programs, but is rarely worked on directly.
 
 ## SimplicityHL
 
-SimplicityHL is a high-level language that compiles to Simplicity. It maps programming concepts from Simplicity onto programming concepts that developers are more familar with. In particular, Rust is a popular language whose functional aspects fit Simplicity well. SimplicityHL aims to closely resemble Rust.
+SimplicityHL is a high-level language that compiles to Simplicity. It maps programming concepts from Simplicity onto programming concepts that developers are more familiar with. In particular, Rust is a popular language whose functional aspects fit Simplicity well. SimplicityHL aims to closely resemble Rust.
 
 Just how Rust is compiled to assembly language, SimplicityHL is compiled to Simplicity. Just how writing Rust doesn't necessarily produce the most efficient assembly, writing SimplicityHL doesn't necessarily produce the most efficient Simplicity code. The compilers try to optimize the target code they produce, but manually written target code can be more efficient. On the other hand, a compiled language is much easier to read, write and reason about. Assembly is meant to be consumed by machines while Rust is meant to be consumed by humans. Simplicity is meant to be consumed by Bitcoin full nodes while SimplicityHL is meant to be consumed by Bitcoin developers.
 

README.md

@@ -1,3 +1,5 @@
 msrv = "1.78.0"
 # We have an error type, `RichError`, of size 144. This is pushing it but probably fine.
 large-error-threshold = 145
+
+doc-valid-idents = [ "SimplicityHL" ]

clippy.toml

@@ -22,7 +22,7 @@ During the translation, we can ignore the source type of Simplicity expressions
 
 Target types are handled by contexts.
 
-We obtain context Ctx(Ξ) from environment Ξ by mapping each variable `a` from Ξ to the target type of Ξ(`x`):
+We obtain context Ctx(Ξ) from environment Ξ by mapping each variable `x` from Ξ to the target type of Ξ(`x`):
 
 Ctx(Ξ)(`x`) = B if Ξ(`x`) = a: A → B
 
@@ -37,7 +37,7 @@ As we translate `s` to Simplicity, we need an environment that maps the variable
 
 If `p` is just a variable `p = a`, then the environment is simply [`a` ↦ iden: A → A].
 
-If `p` is a product of two variables `p = (a, b)`, then the environment is [`a` ↦ take iden: A × B → A, `b` ↦ drop iden: A × B → B.
+If `p` is a product of two variables `p = (a, b)`, then the environment is [`a` ↦ take iden: A × B → A, `b` ↦ drop iden: A × B → B].
 
 "take" and "drop" are added as we go deeper in the product hierarchy. The pattern `_` is ignored.
 

doc/environment.md

@@ -78,7 +78,7 @@ Then ⟦`b; c`⟧Ξ = comp (pair ⟦`b`⟧Ξ ⟦`c`⟧Ξ) (drop iden): A → C
 
 If Ctx(Ξ) ⊩ `b`: B
 
-If Product(PEnv(B, `p`), Ξ) ⊩ c: C
+If Product(PEnv(B, `p`), Ξ) ⊩ `c`: C
 
 Then ⟦`let p: B = b; c`⟧Ξ = comp (pair ⟦`b`⟧Ξ iden) ⟦`c`⟧Product(PEnv(B, `p`), Ξ): A → C
 
@@ -90,7 +90,7 @@ If Product(PEnv(B, `x`), Ξ) ⊩ `b`: D
 
 If Product(PEnv(C, `y`), Ξ) ⊩ `c`: D
 
-Then ⟦`match a { Left(x) => a, Right(y) => b, }`⟧Ξ = comp (pair ⟦a⟧Ξ iden) (case ⟦b⟧Product(PEnv(B, `x`), Ξ) ⟦c⟧Product(PEnv(C, `y`), Ξ)): A → D
+Then ⟦`match a { Left(x) => b, Right(y) => c, }`⟧Ξ = comp (pair ⟦`a`⟧Ξ iden) (case ⟦`b`⟧Product(PEnv(B, `x`), Ξ) ⟦`c`⟧Product(PEnv(C, `y`), Ξ)): A → D
 
 ## Left unwrap
 

doc/translation.md

@@ -405,7 +405,7 @@ mod tests {
     impl TestCase<SatisfiedProgram> {
         #[allow(dead_code)]
         pub fn print_encoding(self) -> Self {
-            let (program_bytes, witness_bytes) = self.program.redeem().encode_to_vec();
+            let (program_bytes, witness_bytes) = self.program.redeem().to_vec_with_witness();
             println!(
                 "Program:\n{}",
                 Base64Display::new(&program_bytes, &STANDARD)

src/lib.rs

@@ -79,7 +79,7 @@ fn run() -> Result<(), String> {
 
     if let Some(witness) = witness_opt {
         let satisfied = compiled.satisfy(witness)?;
-        let (program_bytes, witness_bytes) = satisfied.redeem().encode_to_vec();
+        let (program_bytes, witness_bytes) = satisfied.redeem().to_vec_with_witness();
         println!(
             "Program:\n{}",
             Base64Display::new(&program_bytes, &STANDARD)
@@ -89,7 +89,7 @@ fn run() -> Result<(), String> {
             Base64Display::new(&witness_bytes, &STANDARD)
         );
     } else {
-        let program_bytes = compiled.commit().encode_to_vec();
+        let program_bytes = compiled.commit().to_vec_without_witness();
         println!(
             "Program:\n{}",
             Base64Display::new(&program_bytes, &STANDARD)