bitcoin_core_sv2 0.4.0

A library to get Stratum V2 Template Distribution Protocol from Bitcoin Core over IPC
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

//! Version-agnostic API for Bitcoin Core IPC integrations.

pub mod job_declaration_protocol;
pub mod template_distribution_protocol;

use std::fmt;

/// Supported Bitcoin Core IPC schema families.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum BitcoinCoreVersion {
    V30X,
    V31X,
}

impl BitcoinCoreVersion {
    pub const fn as_major(self) -> u8 {
        match self {
            Self::V30X => 30,
            Self::V31X => 31,
        }
    }
}

impl TryFrom<u8> for BitcoinCoreVersion {
    type Error = u8;

    fn try_from(value: u8) -> Result<Self, Self::Error> {
        match value {
            30 => Ok(Self::V30X),
            31 => Ok(Self::V31X),
            _ => Err(value),
        }
    }
}

/// Protocol family associated with a Bitcoin Core Sv2 runtime initialization error.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum BitcoinCoreSv2Protocol {
    TDP,
    JDP,
}

impl BitcoinCoreSv2Protocol {
    const fn as_str(self) -> &'static str {
        match self {
            Self::TDP => "TDP",
            Self::JDP => "JDP",
        }
    }
}

/// Error returned when selecting and initializing a versioned Bitcoin Core IPC runtime fails.
#[derive(Debug)]
pub struct BitcoinCoreSv2Error {
    version: BitcoinCoreVersion,
    protocol: BitcoinCoreSv2Protocol,
    details: String,
}

impl BitcoinCoreSv2Error {
    pub(crate) fn from_debug<E>(
        version: BitcoinCoreVersion,
        protocol: BitcoinCoreSv2Protocol,
        error: E,
    ) -> Self
    where
        E: fmt::Debug,
    {
        Self {
            version,
            protocol,
            details: format!("{error:?}"),
        }
    }
}

impl fmt::Display for BitcoinCoreSv2Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "failed to initialize bitcoin_core_sv2 {} for v{}: {}",
            self.protocol.as_str(),
            self.version.as_major(),
            self.details
        )
    }
}

impl std::error::Error for BitcoinCoreSv2Error {}