brk_types 0.3.0-beta.2

Structs used throughout BRK
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

use bitcoin::hex::DisplayHex;
use schemars::JsonSchema;
use serde::{Deserialize, Serialize};

use crate::{AddrBytes, OutputType};

/// Address validation result
#[derive(Debug, Clone, Serialize, Deserialize, JsonSchema)]
pub struct AddrValidation {
    /// Whether the address is valid
    #[schemars(example = true)]
    pub isvalid: bool,

    /// The validated address
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "address")]
    pub addr: Option<String>,

    /// The scriptPubKey in hex
    #[serde(skip_serializing_if = "Option::is_none")]
    #[serde(rename = "scriptPubKey")]
    pub script_pub_key: Option<String>,

    /// Whether this is a script address (P2SH)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub isscript: Option<bool>,

    /// Whether this is a witness address
    #[serde(skip_serializing_if = "Option::is_none")]
    pub iswitness: Option<bool>,

    /// Witness version (0 for P2WPKH/P2WSH, 1 for P2TR)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub witness_version: Option<u8>,

    /// Witness program in hex
    #[serde(skip_serializing_if = "Option::is_none")]
    pub witness_program: Option<String>,

    /// Error locations (empty array for most errors)
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error_locations: Option<Vec<usize>>,

    /// Error message for invalid addresses
    #[serde(skip_serializing_if = "Option::is_none")]
    pub error: Option<String>,
}

impl AddrValidation {
    /// Returns an invalid validation result with error detail
    pub fn invalid(error: String) -> Self {
        Self {
            isvalid: false,
            addr: None,
            script_pub_key: None,
            isscript: None,
            iswitness: None,
            witness_version: None,
            witness_program: None,
            error_locations: Some(vec![]),
            error: Some(error),
        }
    }

    /// Validate a Bitcoin address string and return details
    pub fn from_addr(addr: &str) -> Self {
        let script = match AddrBytes::addr_to_script(addr) {
            Ok(s) => s,
            Err(e) => return Self::invalid(e.to_string()),
        };

        let output_type = OutputType::from(&script);
        let script_hex = script.as_bytes().to_lower_hex_string();

        let is_script = matches!(output_type, OutputType::P2SH | OutputType::P2TR);
        let is_witness = matches!(
            output_type,
            OutputType::P2WPKH | OutputType::P2WSH | OutputType::P2TR | OutputType::P2A
        );

        let (witness_version, witness_program) = if is_witness {
            let version = script.witness_version().map(|v| v.to_num());
            let program = if script.len() > 2 {
                Some(script.as_bytes()[2..].to_lower_hex_string())
            } else {
                None
            };
            (version, program)
        } else {
            (None, None)
        };

        Self {
            isvalid: true,
            addr: Some(addr.to_string()),
            script_pub_key: Some(script_hex),
            isscript: Some(is_script),
            iswitness: Some(is_witness),
            witness_version,
            witness_program,
            error_locations: None,
            error: None,
        }
    }
}