Merge pull request #10 from uncomputable/2025-03-cleanup

Author: lucidLuckylee

Cargo.toml

@@ -3,17 +3,21 @@ members = ["macro"]
 
 [package]
 name = "bitcoin-script"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["Lukas George <[email protected]>"]
 edition = "2021"
 description = "Inline Bitcoin scripts"
 license = "MIT"
 repository = "https://github.com/BitVM/rust-bitcoin-script"
 
+[features]
+serde = ["dep:serde", "bitcoin/serde"]
+
 [dependencies]
-bitcoin = { version = "0.32.5", features = ["rand-std", "serde"] }
-lazy_static = "1.5.0"
+bitcoin = { version = "0.32.5" }
 script-macro = { path = "./macro" }
 stdext = "0.3.3"
-serde = { version = "1", features = ["derive"] }
+serde = { version = "1", features = ["derive"], optional = true }
+
+[dev-dependencies]
 bincode = "1.3.3"

macro/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "script-macro"
-version = "0.3.0"
+version = "0.4.0"
 authors = ["Lukas George [email protected]"]
 edition = "2021"
 description = "Inline Bitcoin scripts proc_macro"
@@ -13,6 +13,4 @@ proc-macro = true
 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/src/generate.rs

@@ -4,7 +4,9 @@ use proc_macro2::{Ident, Span, TokenStream};
 use quote::{quote, quote_spanned};
 
 pub fn generate(syntax: Vec<(Syntax, Span)>) -> TokenStream {
-    let mut tokens = quote!(::bitcoin_script::Script::new(::bitcoin_script::function_name!()));
+    let mut tokens = quote!(::bitcoin_script::Script::new(
+        ::bitcoin_script::function_name!()
+    ));
 
     for (item, span) in syntax {
         let push = match item {

macro/src/parse.rs

@@ -1,3 +1,4 @@
+use bitcoin::hex::FromHex;
 use bitcoin::{
     blockdata::opcodes::Opcode,
     opcodes::{all::*, OP_0, OP_FALSE, OP_NOP2, OP_NOP3, OP_TRUE},
@@ -354,9 +355,7 @@ pub fn parse(tokens: TokenStream) -> Vec<(Syntax, Span)> {
             // Wrap if-else statements such that they return a Vec<ScriptBuf>
             (Ident(_), "if") => parse_if(token, &mut tokens),
             // Replace DEBUG with OP_RESERVED
-            (Ident(_), "DEBUG") => {
-                (Syntax::Opcode(OP_RESERVED), token.span())
-            }
+            (Ident(_), "DEBUG") => (Syntax::Opcode(OP_RESERVED), token.span()),
 
             // identifier, look up opcode
             (Ident(_), _) => match parse_opcode(&token_str) {
@@ -541,7 +540,7 @@ fn parse_data(token: TokenTree) -> (Syntax, Span) {
 
 fn parse_bytes(token: TokenTree) -> (Syntax, Span) {
     let hex_bytes = &token.to_string()[2..];
-    let bytes = hex::decode(hex_bytes).unwrap_or_else(|err| {
+    let bytes = Vec::<u8>::from_hex(hex_bytes).unwrap_or_else(|err| {
         emit_error!(token.span(), "invalid hex literal ({})", err);
     });
     (Syntax::Bytes(bytes), token.span())

src/builder.rs

@@ -3,12 +3,15 @@ use bitcoin::blockdata::script::{Instruction, PushBytes, PushBytesBuf, ScriptBuf
 use bitcoin::opcodes::{OP_0, OP_TRUE};
 use bitcoin::script::write_scriptint;
 use bitcoin::Witness;
-use serde::{Deserialize, Serialize};
 use std::collections::HashMap;
 use std::convert::TryFrom;
 use std::hash::{DefaultHasher, Hash, Hasher};
 
-#[derive(Clone, Debug, Hash, Serialize, Deserialize, PartialEq)]
+#[cfg(feature = "serde")]
+use serde::{Deserialize, Serialize};
+
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[derive(Clone, Debug, Hash, PartialEq)]
 pub enum Block {
     Call(u64),
     Script(ScriptBuf),
@@ -21,7 +24,8 @@ impl Block {
     }
 }
 
-#[derive(Clone, Debug, Serialize, Deserialize, PartialEq)]
+#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))]
+#[derive(Clone, Debug, PartialEq)]
 pub struct StructuredScript {
     size: usize,
     pub debug_identifier: String,
@@ -43,15 +47,18 @@ fn calculate_hash<T: Hash>(t: &T) -> u64 {
 
 impl StructuredScript {
     pub fn new(debug_info: &str) -> Self {
-        let blocks = Vec::new();
         StructuredScript {
             size: 0,
             debug_identifier: debug_info.to_string(),
-            blocks,
+            blocks: Vec::new(),
             script_map: HashMap::new(),
         }
     }
 
+    pub fn is_empty(&self) -> bool {
+        self.size == 0
+    }
+
     pub fn len(&self) -> usize {
         self.size
     }
@@ -63,7 +70,7 @@ impl StructuredScript {
     pub fn get_structured_script(&self, id: &u64) -> &StructuredScript {
         self.script_map
             .get(id)
-            .expect(&format!("script id: {} not found in script_map.", id))
+            .unwrap_or_else(|| panic!("script id: {} not found in script_map.", id))
     }
 
     // Return the debug information of the Opcode at position
@@ -133,10 +140,10 @@ impl StructuredScript {
     }
 
     pub fn push_env_script(mut self, mut data: StructuredScript) -> StructuredScript {
-        if data.len() == 0 {
+        if data.is_empty() {
             return self;
         }
-        if self.len() == 0 {
+        if self.is_empty() {
             return data;
         }
 
@@ -342,8 +349,7 @@ impl NotU8Pushable for u32 {
 }
 impl NotU8Pushable for usize {
     fn bitcoin_script_push(self, builder: StructuredScript) -> StructuredScript {
-        builder
-            .push_int(i64::try_from(self).unwrap_or_else(|_| panic!("Usize does not fit in i64")))
+        builder.push_int(i64::try_from(self).expect("Usize does not fit in i64"))
     }
 }
 impl NotU8Pushable for Vec<u8> {

tests/test.rs

@@ -304,6 +304,7 @@ fn test_push_witness() {
     );
 }
 
+#[cfg(feature = "serde")]
 #[test]
 fn test_serialization() {
     let script = script! {