Merge branch 'StructuredScript'

Author: lucidLuckylee

.github/workflows/rust.yml

@@ -1,2 +1,2 @@
-/target
-Cargo.lock
+**/target
+**/Cargo.lock

.gitignore

@@ -1,46 +1,17 @@
+[workspace]
+members = ["macro"]
+
 [package]
 name = "bitcoin-script"
-version = "0.2.0"
-authors = ["Matt Bell <[email protected]>", "Lukas George [email protected]"]
+version = "0.3.0"
+authors = ["Lukas George <[email protected]>"]
 edition = "2021"
 description = "Inline Bitcoin scripts"
 license = "MIT"
 repository = "https://github.com/BitVM/rust-bitcoin-script"
 
-[lib]
-proc-macro = true
-
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
-# bitcoin = "0.31.1"
-bitcoin = { git = "https://github.com/rust-bitcoin/rust-bitcoin", branch = "bitvm" }
-quote = "1.0.23"
-proc-macro-error = "1.0.4"
-lazy_static = "1.4.0"
-hex = "0.4.3"
-proc-macro2 = "1.0.51"
-
-[patch.crates-io.base58check]
-git = "https://github.com/rust-bitcoin/rust-bitcoin"
-branch = "bitvm"
-
-[patch.crates-io.bitcoin]
-git = "https://github.com/rust-bitcoin/rust-bitcoin"
-branch = "bitvm"
-
-[patch.crates-io.bitcoin_hashes]
-git = "https://github.com/rust-bitcoin/rust-bitcoin"
-branch = "bitvm"
-
-[patch.crates-io.bitcoin-internals]
-git = "https://github.com/rust-bitcoin/rust-bitcoin"
-branch = "bitvm"
-
-[patch.crates-io.bitcoin-io]
-git = "https://github.com/rust-bitcoin/rust-bitcoin"
-branch = "bitvm"
-
-[patch.crates-io.bitcoin-units]
-git = "https://github.com/rust-bitcoin/rust-bitcoin"
-branch = "bitvm"
+bitcoin = { version = "0.32.5", features = ["rand-std"] }
+lazy_static = "1.5.0"
+script-macro = { path = "./macro" }
+stdext = "0.3.3"

Cargo.toml

@@ -1,22 +1,14 @@
-# bitcoin-script
+# Bitvm Bitcoin Script
 
-[![Rust](https://github.com/mappum/rust-bitcoin-script/workflows/Rust/badge.svg)](https://github.com/mappum/rust-bitcoin-script/actions?query=workflow%3ARust)
-[![crates.io](https://img.shields.io/crates/v/bitcoin-script.svg)](https://crates.io/crates/bitcoin-script)
-[![docs.rs](https://docs.rs/bitcoin-script/badge.svg)](https://docs.rs/bitcoin-script)
-
-**Bitcoin scripts inline in Rust.**
-
----
+Utilities used in the official [BitVM](https://github.com/BitVM/BitVM) implementation to generate Bitcoin Script. Heavily inspired by [rust-bitcoin-script's inline macro](https://github.com/mappum/rust-bitcoin-script).
 
 ## Usage
 
-This crate exports a `script!` macro which can be used to build Bitcoin scripts. The macro returns the [`Script`](https://docs.rs/bitcoin/latest/bitcoin/struct.ScriptBuf.html) type from the [`bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) crate.
+This crate exports a `script!` macro which can be used to build structured Bitcoin scripts and compiled to the [`Script`](https://docs.rs/bitcoin/latest/bitcoin/struct.ScriptBuf.html) type from the [`bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) crate.
 
 **Example:**
 
 ```rust
-#![feature(proc_macro_hygiene)]
-
 use bitcoin_script::bitcoin_script;
 
 let htlc_script = script! {
@@ -28,6 +20,8 @@ let htlc_script = script! {
     OP_EQUALVERIFY
     OP_CHECKSIG
 };
+
+let script_buf = htlc_script.compile();
 ```
 
 ### Syntax
@@ -77,6 +71,7 @@ Rust expressions of the following types are supported:
 - [`bitcoin::PublicKey`](https://docs.rs/bitcoin/latest/bitcoin/struct.PublicKey.html)
 - [`bitcoin::XOnlyPublicKey`](https://docs.rs/bitcoin/latest/bitcoin/struct.XOnlyPublicKey.html)
 - [`bitcoin::ScriptBuf`](https://docs.rs/bitcoin/latest/bitcoin/struct.ScriptBuf.html)
+- `StructuredScript`
 
 ```rust
 let bytes = vec![1, 2, 3];
@@ -90,5 +85,22 @@ let script = script! {
 };
 ```
 
-### Optimality
-Obsolete Opcodes are automatically removed when using the `optimal_opcodes` branch. E.g. a sequence of `OP_0 OP_ROLL` will be optimized away.
+#### Conditional Scipt Generation
+
+For-loops and if-else-statements are supported inside the script and will be unrolled when the scripts are generated.
+
+```rust
+let loop_count = 10;
+
+let script = script! {
+    for i in 0..loop_count {
+        if i % 2 == 0 {
+            OP_ADD
+        } else {
+            OP_DUP
+            OP_ADD
+        }
+    }
+};
+
+```

README.md

@@ -0,0 +1,18 @@
+[package]
+name = "script-macro"
+version = "0.3.0"
+authors = ["Lukas George [email protected]"]
+edition = "2021"
+description = "Inline Bitcoin scripts proc_macro"
+license = "MIT"
+
+[lib]
+proc-macro = true
+
+[dependencies]
+bitcoin = "0.32.5"
+quote = "1.0.23"
+proc-macro-error = "1.0.4"
+lazy_static = "1.4.0"
+hex = "0.4.3"
+proc-macro2 = "1.0.51"

macro/Cargo.toml

@@ -4,7 +4,7 @@ use proc_macro2::{Ident, Span, TokenStream};
 use quote::{quote, quote_spanned};
 
 pub fn generate(syntax: Vec<(Syntax, Span)>) -> TokenStream {
-    let mut tokens = quote!(pushable::Builder::new());
+    let mut tokens = quote!(::bitcoin_script::Script::new(::bitcoin_script::function_name!()));
 
     for (item, span) in syntax {
         let push = match item {
@@ -15,8 +15,7 @@ pub fn generate(syntax: Vec<(Syntax, Span)>) -> TokenStream {
         };
         tokens.extend(push);
     }
-
-    tokens.extend(quote!(.0.into_script()));
+    // tokens.extend(quote! {.analyze_stack()}); // for debug
     tokens
 }
 

src/generate.rs renamed to macro/src/generate.rs

@@ -0,0 +1,15 @@
+mod generate;
+mod parse;
+
+use generate::generate;
+use parse::parse;
+use proc_macro::TokenStream;
+use proc_macro_error::{proc_macro_error, set_dummy};
+use quote::quote;
+
+#[proc_macro]
+#[proc_macro_error]
+pub fn script(tokens: TokenStream) -> TokenStream {
+    set_dummy(quote!((::bitcoin::Script::new())));
+    generate(parse(tokens.into())).into()
+}