rustywallet-taproot 0.1.0

Taproot (BIP340/341/342) implementation for Bitcoin wallet development
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156

//! # rustywallet-taproot
//!
//! Full Taproot support implementing BIP340 (Schnorr), BIP341 (Taproot), and BIP342 (Tapscript).
//!
//! ## Features
//!
//! - Schnorr signatures (BIP340)
//! - X-only public keys
//! - Key tweaking for Taproot
//! - Tap tree (MAST) construction
//! - Control block generation
//! - P2TR address generation
//! - BIP341 signature hash
//!
//! ## Example
//!
//! ```rust
//! use rustywallet_taproot::{XOnlyPublicKey, TaprootOutput, Network};
//! use secp256k1::{Secp256k1, SecretKey};
//!
//! // Generate a key pair
//! let secp = Secp256k1::new();
//! let secret = [1u8; 32];
//! let sk = SecretKey::from_slice(&secret).unwrap();
//! let pk = sk.public_key(&secp);
//! let (xonly, _) = pk.x_only_public_key();
//! let internal_key = XOnlyPublicKey::from_inner(xonly);
//!
//! // Create a key-path only Taproot output
//! let output = TaprootOutput::key_path_only(internal_key).unwrap();
//!
//! // Get the P2TR address
//! let address = output.address(Network::Mainnet).unwrap();
//! assert!(address.starts_with("bc1p"));
//! ```
//!
//! ## Script Path Example
//!
//! ```rust
//! use rustywallet_taproot::{XOnlyPublicKey, TaprootOutput, TapTreeBuilder, Network};
//! use secp256k1::{Secp256k1, SecretKey};
//!
//! let secp = Secp256k1::new();
//! let secret = [1u8; 32];
//! let sk = SecretKey::from_slice(&secret).unwrap();
//! let pk = sk.public_key(&secp);
//! let (xonly, _) = pk.x_only_public_key();
//! let internal_key = XOnlyPublicKey::from_inner(xonly);
//!
//! // Build a tap tree with two scripts
//! let tree = TapTreeBuilder::new()
//!     .add_leaf(1, vec![0x51]) // OP_1
//!     .add_leaf(1, vec![0x52]) // OP_2
//!     .build()
//!     .unwrap();
//!
//! // Create output with script tree
//! let output = TaprootOutput::with_script_tree(internal_key, &tree).unwrap();
//! let address = output.address(Network::Mainnet).unwrap();
//! ```

pub mod control_block;
pub mod error;
pub mod schnorr;
pub mod sighash;
pub mod tagged_hash;
pub mod taproot;
pub mod taptree;
pub mod tweak;
pub mod xonly;

// Re-exports
pub use control_block::ControlBlock;
pub use error::TaprootError;
pub use schnorr::SchnorrSignature;
pub use sighash::{taproot_key_path_sighash, taproot_script_path_sighash, TaprootSighashType};
pub use tagged_hash::{tagged_hash, TapLeafHash, TapNodeHash, TapTweakHash};
pub use taproot::{create_address, is_p2tr_address, parse_address, Network, TaprootOutput};
pub use taptree::{LeafVersion, TapLeaf, TapNode, TapTree, TapTreeBuilder};
pub use tweak::{compute_output_key, compute_tweak, tweak_private_key, tweak_public_key};
pub use xonly::{Parity, XOnlyPublicKey};

/// Prelude module for convenient imports
pub mod prelude {
    pub use crate::control_block::ControlBlock;
    pub use crate::error::TaprootError;
    pub use crate::schnorr::SchnorrSignature;
    pub use crate::sighash::TaprootSighashType;
    pub use crate::tagged_hash::{TapLeafHash, TapNodeHash, TapTweakHash};
    pub use crate::taproot::{Network, TaprootOutput};
    pub use crate::taptree::{LeafVersion, TapLeaf, TapTree, TapTreeBuilder};
    pub use crate::xonly::{Parity, XOnlyPublicKey};
}

#[cfg(test)]
mod tests {
    use super::*;
    use secp256k1::{Secp256k1, SecretKey};

    fn get_test_keypair() -> ([u8; 32], XOnlyPublicKey) {
        let secp = Secp256k1::new();
        let secret = [1u8; 32];
        let sk = SecretKey::from_slice(&secret).unwrap();
        let pk = sk.public_key(&secp);
        let (xonly, _) = pk.x_only_public_key();
        (secret, XOnlyPublicKey::from_inner(xonly))
    }

    #[test]
    fn test_key_path_workflow() {
        let (secret, internal_key) = get_test_keypair();

        // Create output
        let output = TaprootOutput::key_path_only(internal_key).unwrap();

        // Get address
        let address = output.address(Network::Mainnet).unwrap();
        assert!(address.starts_with("bc1p"));

        // Parse address back
        let parsed = parse_address(&address).unwrap();
        assert_eq!(output.output_key, parsed);
    }

    #[test]
    fn test_script_path_workflow() {
        let (_, internal_key) = get_test_keypair();

        // Build tree
        let tree = TapTreeBuilder::new()
            .add_leaf(1, vec![0x51])
            .add_leaf(1, vec![0x52])
            .build()
            .unwrap();

        // Create output
        let output = TaprootOutput::with_script_tree(internal_key, &tree).unwrap();
        assert!(!output.is_key_path_only());

        // Get control block for first leaf
        let leaf = TapLeaf::new(vec![0x51]);
        let cb = ControlBlock::for_leaf(&tree, &leaf, internal_key, output.parity).unwrap();

        // Verify control block
        assert!(cb.verify(&output.output_key, &leaf.script).unwrap());
    }

    #[test]
    fn test_schnorr_signing() {
        let (secret, pubkey) = get_test_keypair();
        let message = [0x42u8; 32];

        let sig = SchnorrSignature::sign(&message, &secret).unwrap();
        assert!(sig.verify(&message, &pubkey));
    }
}