channels_sv2 8.0.0

Sv2 Channel Primitives
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

//! # Chain Tip
use binary_sv2::U256Owned;
use mining_sv2::{
    SetNewPrevHash as SetNewPrevHashMp, SetNewPrevHashOwned as SetNewPrevHashMpOwned,
};
use template_distribution_sv2::{
    SetNewPrevHash as SetNewPrevHashTdp, SetNewPrevHashOwned as SetNewPrevHashTdpOwned,
};

/// An abstraction over the chain tip, carrying information from `SetNewPrevHash` messages.
///
/// Used for:
/// - creating non-future jobs
/// - validating shares.
///
/// Only `prev_hash`, `nbits` and the minimum `nTime` are carried. The Template Distribution
/// `SetNewPrevHash.target`, which a Template Provider may set below the target `nbits` encodes
/// (weak-block propagation), is deliberately not: `channels_sv2` currently does not support
/// weak-block propagation, so the block-validity threshold is the one `nbits` encodes, and share
/// validation classifies `BlockFound` against that alone.
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ChainTip {
    prev_hash: U256Owned,
    nbits: u32,
    min_ntime: u32,
}

impl ChainTip {
    /// Constructs a new `ChainTip` instance.
    pub fn new(prev_hash: U256Owned, nbits: u32, min_ntime: u32) -> Self {
        Self {
            prev_hash,
            nbits,
            min_ntime,
        }
    }

    /// Retrieves the hash of the previous block
    pub fn prev_hash(&self) -> U256Owned {
        self.prev_hash.clone()
    }

    /// Retrieves the network difficulty for the current block
    pub fn nbits(&self) -> u32 {
        self.nbits
    }

    /// Retrieves the smallest nTime value available for hashing
    pub fn min_ntime(&self) -> u32 {
        self.min_ntime
    }
}

/// Converts a Template Distribution `SetNewPrevHash`, dropping its `target` (see [`ChainTip`]).
impl From<SetNewPrevHashTdpOwned> for ChainTip {
    fn from(set_new_prev_hash: SetNewPrevHashTdpOwned) -> Self {
        Self::new(
            set_new_prev_hash.prev_hash,
            set_new_prev_hash.n_bits,
            set_new_prev_hash.header_timestamp,
        )
    }
}

impl From<SetNewPrevHashMpOwned> for ChainTip {
    fn from(set_new_prev_hash: SetNewPrevHashMpOwned) -> Self {
        Self::new(
            set_new_prev_hash.prev_hash,
            set_new_prev_hash.nbits,
            set_new_prev_hash.min_ntime,
        )
    }
}

/// Converts a Template Distribution `SetNewPrevHash`, dropping its `target` (see [`ChainTip`]).
impl From<SetNewPrevHashTdp<'_>> for ChainTip {
    fn from(set_new_prev_hash: SetNewPrevHashTdp) -> Self {
        let set_new_prev_hash_static = set_new_prev_hash.into_owned();
        let prev_hash = set_new_prev_hash_static.prev_hash;
        let nbits = set_new_prev_hash_static.n_bits;
        let min_ntime = set_new_prev_hash_static.header_timestamp;
        Self::new(prev_hash, nbits, min_ntime)
    }
}

impl From<SetNewPrevHashMp<'_>> for ChainTip {
    fn from(set_new_prev_hash: SetNewPrevHashMp) -> Self {
        let set_new_prev_hash_static = set_new_prev_hash.into_owned();
        let prev_hash = set_new_prev_hash_static.prev_hash;
        let nbits = set_new_prev_hash_static.nbits;
        let min_ntime = set_new_prev_hash_static.min_ntime;
        Self::new(prev_hash, nbits, min_ntime)
    }
}