cory-core 0.1.1

Core domain logic for Cory: Bitcoin RPC adapter, ancestry graph builder, labels, and caching.
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

//! Shared test helpers for `cory-core` unit tests.
//!
//! Consolidates builder functions for test transaction types (`make_raw_tx`,
//! `simple_output`, etc.) and domain types (`make_input`, `make_output`,
//! `make_tx_node`) so that tests across modules share a single source of
//! truth for dummy data construction.

use bitcoin::hashes::Hash;
use bitcoin::{Amount, Txid};

use crate::types::{BlockHeight, ScriptType, TxInput, TxNode, TxOutput};

// ==============================================================================
// Txid Helpers
// ==============================================================================

/// Create a deterministic `Txid` from a single distinguishing byte.
/// Useful for building small test graphs where txids only need to be unique.
pub fn txid_from_byte(b: u8) -> Txid {
    let mut bytes = [0u8; 32];
    bytes[0] = b;
    Txid::from_byte_array(bytes)
}

// ==============================================================================
// Transaction Builders
// ==============================================================================

/// Build a minimal `TxNode` with sane defaults for graph/RPC test use.
/// Override individual fields after construction when needed.
pub fn make_raw_tx(txid: Txid, inputs: Vec<TxInput>, outputs: Vec<TxOutput>) -> TxNode {
    TxNode {
        txid,
        version: 2,
        locktime: 0,
        size: 250,
        vsize: 140,
        weight: 560,
        block_hash: None,
        block_height: Some(BlockHeight(100)),
        inputs,
        outputs,
    }
}

/// A coinbase input (no prevout).
pub fn coinbase_input() -> TxInput {
    TxInput {
        prevout: None,
        sequence: 0xFFFFFFFF,
        value: None,
        script_type: None,
    }
}

/// A spending input referencing `funding_txid:vout`.
pub fn spending_input(funding_txid: Txid, vout: u32) -> TxInput {
    TxInput {
        prevout: Some(bitcoin::OutPoint::new(funding_txid, vout)),
        sequence: 0xFFFFFFFE,
        value: None,
        script_type: None,
    }
}

/// A minimal valid P2WPKH output with the given satoshi value.
pub fn simple_output(sats: u64) -> TxOutput {
    // Minimal valid P2WPKH scriptPubKey: OP_0 PUSH20 <20-byte-hash>.
    let script_bytes = [
        0x00, 0x14, // OP_0, PUSH20
        0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
        0x10, 0x11, 0x12, 0x13, 0x14,
    ];
    TxOutput {
        value: Amount::from_sat(sats),
        script_pub_key: bitcoin::ScriptBuf::from_bytes(script_bytes.to_vec()),
        script_type: ScriptType::P2wpkh,
    }
}

// ==============================================================================
// Domain Type Builders (TxNode, TxInput, TxOutput)
// ==============================================================================

/// Build a `TxInput` for domain-level tests. `value` is in satoshis.
pub fn make_input(value: Option<u64>, sequence: u32) -> TxInput {
    TxInput {
        prevout: Some(bitcoin::OutPoint::new(Txid::from_byte_array([0u8; 32]), 0)),
        sequence,
        value: value.map(Amount::from_sat),
        script_type: Some(ScriptType::P2wpkh),
    }
}

/// Build a `TxOutput` with a P2WPKH script for domain-level tests.
pub fn make_output(sats: u64) -> TxOutput {
    let script_bytes = [
        0x00, 0x14, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d,
        0x0e, 0x0f, 0x10, 0x11, 0x12, 0x13, 0x14,
    ];
    TxOutput {
        value: Amount::from_sat(sats),
        script_pub_key: bitcoin::ScriptBuf::from_bytes(script_bytes.to_vec()),
        script_type: ScriptType::P2wpkh,
    }
}

/// Build a `TxNode` with the given inputs, outputs, and vsize.
pub fn make_tx_node(inputs: Vec<TxInput>, outputs: Vec<TxOutput>, vsize: u64) -> TxNode {
    TxNode {
        txid: Txid::from_byte_array([0u8; 32]),
        version: 2,
        locktime: 0,
        size: vsize,
        vsize,
        weight: vsize * 4,
        block_hash: None,
        block_height: Some(BlockHeight(100)),
        inputs,
        outputs,
    }
}