brk_iterator 0.3.0-beta.4

A Bitcoin block iterator
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
123
124
125
126
127
128
129
130

use std::sync::Arc;

use brk_error::Result;
use brk_reader::Reader;
use brk_rpc::Client;
use brk_types::{BlockHash, Height};

mod iterator;
mod range;
mod source;
mod state;

use iterator::*;
use range::*;
use source::*;
use state::*;

///
/// Block iterator factory
///
/// Creates iterators over Bitcoin blocks from various sources (RPC/Reader).
/// Iterators may end earlier than expected if a chain reorganization occurs.
///
/// Thread-safe and free to clone.
///
#[derive(Clone)]
pub struct Blocks(Arc<Source>);

impl Blocks {
    /// Create with smart mode (auto-select source based on range size)
    pub fn new(client: &Client, reader: &Reader) -> Self {
        Self::new_inner(Source::Smart {
            client: client.clone(),
            reader: reader.clone(),
        })
    }

    /// Create with RPC-only mode
    pub fn new_rpc(client: &Client) -> Self {
        Self::new_inner(Source::Rpc {
            client: client.clone(),
        })
    }

    /// Create with Reader-only mode
    pub fn new_reader(reader: &Reader) -> Self {
        Self::new_inner(Source::Reader {
            reader: reader.clone(),
        })
    }

    fn new_inner(source: Source) -> Self {
        Self(Arc::new(source))
    }

    /// Iterate over a specific range (start..=end)
    pub fn range(&self, start: Height, end: Height) -> Result<BlockIterator> {
        self.iter(BlockRange::Span { start, end })
    }

    /// Iterate from start (inclusive) to chain tip
    pub fn start(&self, start: Height) -> Result<BlockIterator> {
        self.iter(BlockRange::Start { start })
    }

    /// Iterate from genesis to end (inclusive)
    pub fn end(&self, end: Height) -> Result<BlockIterator> {
        self.iter(BlockRange::End { end })
    }

    /// Iterate over last n blocks
    pub fn last(&self, n: u32) -> Result<BlockIterator> {
        self.iter(BlockRange::Last { n })
    }

    /// Iterate after hash
    pub fn after(&self, hash: Option<BlockHash>) -> Result<BlockIterator> {
        self.iter(BlockRange::After { hash })
    }

    fn iter(&self, range: BlockRange) -> Result<BlockIterator> {
        let (start, end, hash_opt) = self.resolve_range(range)?;

        let count = end.saturating_sub(*start) + 1;

        let state = match &*self.0 {
            Source::Smart { client, reader } => {
                if count <= 10 {
                    State::new_rpc(client.clone(), start, end, hash_opt)
                } else {
                    State::new_reader(reader.clone(), start, end, hash_opt)?
                }
            }
            Source::Rpc { client } => State::new_rpc(client.clone(), start, end, hash_opt),
            Source::Reader { reader, .. } => {
                State::new_reader(reader.clone(), start, end, hash_opt)?
            }
        };

        Ok(BlockIterator::new(state))
    }

    fn resolve_range(&self, range: BlockRange) -> Result<(Height, Height, Option<BlockHash>)> {
        let client = self.0.client();

        match range {
            BlockRange::Span { start, end } => Ok((start, end, None)),
            BlockRange::Start { start } => {
                let end = client.get_last_height()?;
                Ok((start, end, None))
            }
            BlockRange::End { end } => Ok((Height::ZERO, end, None)),
            BlockRange::Last { n } => {
                let end = client.get_last_height()?;
                let start = Height::new((*end).saturating_sub(n - 1));
                Ok((start, end, None))
            }
            BlockRange::After { hash } => {
                let start = if let Some(hash) = hash.as_ref() {
                    let block_info = client.get_block_header_info(hash)?;
                    (block_info.height + 1).into()
                } else {
                    Height::ZERO
                };
                let end = client.get_last_height()?;
                Ok((start, end, hash))
            }
        }
    }
}