bindex 0.0.19

Bitcoin indexing library in Rust
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

use crate::{
    index::{self, IndexedHeader},
    Location,
};

use bitcoin::{hashes::Hash, BlockHash};

#[derive(thiserror::Error, Debug)]
pub enum Reorg {
    #[error("missing block={0} at height={1}")]
    Missing(bitcoin::BlockHash, usize),

    #[error("stale block={0} at height={1}")]
    Stale(bitcoin::BlockHash, usize),
}

pub struct Headers {
    rows: Vec<index::IndexedHeader>,
}

impl Headers {
    /// Build a chain from a list of headers (sorted by height).
    pub fn new(rows: Vec<index::IndexedHeader>) -> Self {
        let mut block_hash = bitcoin::BlockHash::all_zeros();
        for row in &rows {
            assert_eq!(row.header().prev_blockhash, block_hash);
            block_hash = row.hash();
        }
        Self { rows }
    }

    /// Return tip block hash (or `all_zeros` if no blocks).
    pub fn tip_hash(&self) -> bitcoin::BlockHash {
        self.rows
            .last()
            .map(index::IndexedHeader::hash)
            .unwrap_or_else(bitcoin::BlockHash::all_zeros)
    }

    /// Chain height (the genesis block is exluded)
    pub fn tip_height(&self) -> Option<usize> {
        self.rows.len().checked_sub(1)
    }

    /// Add new tip.
    pub fn add(&mut self, tip: index::IndexedHeader) {
        assert_eq!(tip.header().prev_blockhash, self.tip_hash());
        self.rows.push(tip)
    }

    /// Pop current tip.
    pub fn pop(&mut self) -> Option<index::IndexedHeader> {
        self.rows.pop()
    }

    pub fn tip(&self) -> Option<&index::IndexedHeader> {
        self.rows.last()
    }

    pub fn genesis(&self) -> Option<&index::IndexedHeader> {
        self.rows.first()
    }

    pub fn iter_headers(&self) -> impl Iterator<Item = &IndexedHeader> {
        self.rows.iter()
    }

    pub fn get_header(
        &self,
        hash: BlockHash,
        height: usize,
    ) -> Result<&index::IndexedHeader, Reorg> {
        let header = self.rows.get(height).ok_or(Reorg::Missing(hash, height))?;
        if header.hash() == hash {
            Ok(header)
        } else {
            Err(Reorg::Stale(hash, height))
        }
    }

    /// Find transaction's chain location.
    pub fn find_by_txnum(&self, txnum: index::TxNum) -> Location<'_> {
        // Compare each header using its `next_txnum`
        let block_height = match self
            .rows
            .binary_search_by_key(&txnum, index::IndexedHeader::next_txnum)
        {
            Ok(i) => i + 1, // hitting exactly a block boundary `txnum` -> next block
            Err(i) => i,
        };

        let indexed_header = self.rows.get(block_height).expect("missing height");
        assert!(
            txnum < indexed_header.next_txnum(),
            "binary search failed to find the correct position"
        );

        let prev_txnum = self
            .rows
            .get(block_height - 1)
            .map_or_else(index::TxNum::default, index::IndexedHeader::next_txnum);

        // txnum offset within its block
        let block_offset = txnum
            .offset_from(prev_txnum)
            .expect("binary search failed to find the correct position");

        Location {
            txnum,
            block_height,
            block_offset,
            indexed_header,
        }
    }
}