Merge branch 'script_macro'

Author: lucidLuckylee

Cargo.toml

@@ -1,11 +1,11 @@
 [package]
 name = "bitcoin-script"
-version = "0.1.3"
-authors = ["Matt Bell <[email protected]>"]
-edition = "2018"
+version = "0.2.0"
+authors = ["Matt Bell <[email protected]>", "Lukas George [email protected]"]
+edition = "2021"
 description = "Inline Bitcoin scripts"
 license = "MIT"
-repository = "https://github.com/mappum/rust-bitcoin-script"
+repository = "https://github.com/BitVM/rust-bitcoin-script"
 
 [lib]
 proc-macro = true
@@ -20,3 +20,27 @@ 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"

README.md

@@ -10,7 +10,7 @@
 
 ## Usage
 
-This crate exports a `bitcoin_script!` macro which can be used to build Bitcoin scripts. The macro returns the [`Script`](https://docs.rs/bitcoin/0.23.0/bitcoin/blockdata/script/struct.Script.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 Bitcoin scripts. The macro returns the [`Script`](https://docs.rs/bitcoin/0.23.0/bitcoin/blockdata/script/struct.Script.html) type from the [`bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin) crate.
 
 **Example:**
 
@@ -19,7 +19,7 @@ This crate exports a `bitcoin_script!` macro which can be used to build Bitcoin
 
 use bitcoin_script::bitcoin_script;
 
-let htlc_script = bitcoin_script! {
+let htlc_script = script! {
     OP_IF
         OP_SHA256 <digest> OP_EQUALVERIFY OP_DUP OP_SHA256 <seller_pubkey_hash>
     OP_ELSE
@@ -43,7 +43,7 @@ Whitespace is ignored - scripts can be formatted in the author's preferred style
 All normal opcodes are available, in the form `OP_X`.
 
 ```rust
-let script = bitcoin_script!(OP_CHECKSIG OP_VERIFY);
+let script = script!(OP_CHECKSIG OP_VERIFY);
 ```
 
 #### Integer Literals
@@ -55,15 +55,15 @@ For example:
 - `255` will resolve to a length-delimited varint: `0x02ff00` (note the extra zero byte, due to the way Bitcoin scripts use the most-significant bit to represent the sign)`
 
 ```rust
-let script = bitcoin_script!(123 -456 999999);
+let script = script!(123 -456 999999);
 ```
 
 #### Hex Literals
 
 Hex strings can be specified, prefixed with `0x`.
 
 ```rust
-let script = bitcoin_script!(
+let script = script!(
     0x0102030405060708090a0b0c0d0e0f OP_HASH160
 );
 ```
@@ -81,7 +81,7 @@ Rust expressions of the following types are supported:
 ```rust
 let bytes = vec![1, 2, 3];
 
-let script = bitcoin_script! {
+let script = script! {
     <bytes> OP_CHECKSIGVERIFY
 
     <2016 * 5> OP_CSV

src/generate.rs

@@ -51,7 +51,7 @@ fn generate_escape(builder: TokenStream, expression: TokenStream, span: Span) ->
                 #[allow(clippy::all)]
 
                 use ::bitcoin::blockdata::script::Builder;
-                fn push(builder: Builder, value: impl pushable::Pushable) -> Builder {
+                fn push<T: pushable::Pushable>(builder: Builder, value: T) -> Builder {
                     value.bitcoin_script_push(builder)
                 }
                 push(builder, value)

src/lib.rs

@@ -8,7 +8,7 @@
 //!
 //! ## Usage
 //!
-//! This crate exports a `bitcoin_script!` macro which can be used to build
+//! This crate exports a `script!` macro which can be used to build
 //! Bitcoin scripts. The macro returns the
 //! [`Script`](https://docs.rs/bitcoin/0.23.0/bitcoin/blockdata/script/struct.Script.html)
 //! type from the [`bitcoin`](https://github.com/rust-bitcoin/rust-bitcoin)
@@ -19,14 +19,14 @@
 //! ```rust
 //! #![feature(proc_macro_hygiene)]
 //!
-//! use bitcoin_script::{bitcoin_script, define_pushable};
+//! use bitcoin_script::{script, define_pushable};
 //!
 //! define_pushable!();
 //! # let digest = 0;
 //! # let seller_pubkey_hash = 0;
 //! # let buyer_pubkey_hash = 0;
 //!
-//! let htlc_script = bitcoin_script! {
+//! let htlc_script = script! {
 //!     OP_IF
 //!         OP_SHA256 <digest> OP_EQUALVERIFY OP_DUP OP_SHA256 <seller_pubkey_hash>
 //!     OP_ELSE
@@ -59,8 +59,8 @@
 //!
 //! ```rust
 //! # #![feature(proc_macro_hygiene)]
-//! # use bitcoin_script::bitcoin_script;
-//! let script = bitcoin_script!(OP_CHECKSIG OP_VERIFY);
+//! # use bitcoin_script::script;
+//! let script = script!(OP_CHECKSIG OP_VERIFY);
 //! ```
 //!
 //! #### Integer Literals
@@ -73,8 +73,8 @@
 //!
 //! ```rust
 //! # #![feature(proc_macro_hygiene)]
-//! # use bitcoin_script::bitcoin_script;
-//! let script = bitcoin_script!(123 -456 999999);
+//! # use bitcoin_script::script;
+//! let script = script!(123 -456 999999);
 //! ```
 //!
 //! #### Hex Literals
@@ -83,8 +83,8 @@
 //!
 //! ```rust
 //! # #![feature(proc_macro_hygiene)]
-//! # use bitcoin_script::bitcoin_script;
-//! let script = bitcoin_script!(
+//! # use bitcoin_script::script;
+//! let script = script!(
 //!     0x0102030405060708090a0b0c0d0e0f OP_HASH160
 //! );
 //! ```
@@ -104,11 +104,11 @@
 //!
 //! ```rust
 //! # #![feature(proc_macro_hygiene)]
-//! # use bitcoin_script::{bitcoin_script, define_pushable};
+//! # use bitcoin_script::{script, define_pushable};
 //! define_pushable!();
 //! let bytes = vec![1, 2, 3];
 //!
-//! let script = bitcoin_script! {
+//! let script = script! {
 //!     <bytes> OP_CHECKSIGVERIFY
 //!
 //!     <2016 * 5> OP_CSV
@@ -128,7 +128,7 @@ use quote::quote;
 
 #[proc_macro]
 #[proc_macro_error]
-pub fn bitcoin_script(tokens: TokenStream) -> TokenStream {
+pub fn script(tokens: TokenStream) -> TokenStream {
     set_dummy(quote!((::bitcoin::Script::new())));
     generate(parse(tokens.into())).into()
 }
@@ -188,7 +188,10 @@ pub fn define_pushable(_: TokenStream) -> TokenStream {
             }
             impl NotU8Pushable for ::bitcoin::ScriptBuf {
                 fn bitcoin_script_push(self, builder: Builder) -> Builder {
-                    Builder::from([builder.into_bytes(), self.into_bytes()].concat())
+                    let mut script_vec = vec![];
+                    script_vec.extend_from_slice(builder.as_bytes());
+                    script_vec.extend_from_slice(self.as_bytes());
+                    Builder::from(script_vec)
                 }
             }
             impl<T: NotU8Pushable> NotU8Pushable for Vec<T> {

src/parse.rs

@@ -1,10 +1,10 @@
-use bitcoin::blockdata::opcodes::Opcode;
+use bitcoin::{blockdata::opcodes::Opcode, opcodes::all::OP_RESERVED};
 use proc_macro2::{
-    Delimiter,
-    Span, TokenStream,
+    Delimiter, Span, TokenStream,
     TokenTree::{self, *},
 };
 use quote::quote;
+use std::iter::Peekable;
 use std::str::FromStr;
 
 #[derive(Debug)]
@@ -41,14 +41,20 @@ macro_rules! abort {
 }
 
 pub fn parse(tokens: TokenStream) -> Vec<(Syntax, Span)> {
-    let mut tokens = tokens.into_iter();
+    let mut tokens = tokens.into_iter().peekable();
     let mut syntax = Vec::with_capacity(64);
 
     while let Some(token) = tokens.next() {
         let token_str = token.to_string();
         syntax.push(match (&token, token_str.as_ref()) {
             // Wrap for loops such that they return a Vec<ScriptBuf>
             (Ident(_), ident_str) if ident_str == "for" => parse_for_loop(token, &mut tokens),
+            // Wrap if-else statements such that they return a Vec<ScriptBuf>
+            (Ident(_), ident_str) if ident_str == "if" => parse_if(token, &mut tokens),
+            // Replace DEBUG with OP_RESERVED
+            (Ident(_), ident_str) if ident_str == "DEBUG" => {
+                (Syntax::Opcode(OP_RESERVED), token.span())
+            }
 
             // identifier, look up opcode
             (Ident(_), _) => {
@@ -85,10 +91,52 @@ pub fn parse(tokens: TokenStream) -> Vec<(Syntax, Span)> {
             _ => abort!(token.span(), "unexpected token"),
         });
     }
-
     syntax
 }
 
+fn parse_if<T>(token: TokenTree, tokens: &mut Peekable<T>) -> (Syntax, Span)
+where
+    T: Iterator<Item = TokenTree>,
+{
+    // Use a Vec here to get rid of warnings when the variable is overwritten
+    let mut escape = quote! {
+        let mut script_var = vec![];
+    };
+    escape.extend(std::iter::once(token.clone()));
+
+    while let Some(if_token) = tokens.next() {
+        match if_token {
+            Group(block) if block.delimiter() == Delimiter::Brace => {
+                let inner_block = block.stream();
+                escape.extend(quote! {
+                    {
+                        script_var.extend_from_slice(script! {
+                            #inner_block
+                        }.as_bytes());
+                    }
+                });
+
+                match tokens.peek() {
+                    Some(else_token) if else_token.to_string().as_str() == "else" => continue,
+                    _ => break,
+                }
+            }
+            _ => {
+                escape.extend(std::iter::once(if_token));
+                continue;
+            }
+        };
+    }
+    escape = quote! {
+        {
+            #escape;
+            bitcoin::script::ScriptBuf::from(script_var)
+        }
+    }
+    .into();
+    (Syntax::Escape(escape), token.span())
+}
+
 fn parse_for_loop<T>(token: TokenTree, tokens: &mut T) -> (Syntax, Span)
 where
     T: Iterator<Item = TokenTree>,
@@ -104,11 +152,11 @@ where
                 let inner_block = block.stream();
                 escape.extend(quote! {
                     {
-                    script_var.push(bitcoin_script !{
-                        #inner_block
-                    });
+                        script_var.extend_from_slice(script !{
+                            #inner_block
+                        }.as_bytes());
                     }
-                    script_var
+                    bitcoin::script::ScriptBuf::from(script_var)
                 });
                 break;
             }
@@ -119,7 +167,7 @@ where
         };
     }
 
-    (Syntax::Escape(quote!{ { #escape }}.into()), token.span())
+    (Syntax::Escape(quote! { { #escape } }.into()), token.span())
 }
 
 fn parse_escape<T>(token: TokenTree, tokens: &mut T) -> (Syntax, Span)