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 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
//!
//! Crates APIs, essential structs, functions, methods are all here!
//!
//! To quickly understand how to use this crate, have a look at the
//! documentation for `bitcoin_explorer::BitcoinDB`!!.
//!
//! # Example
//!
//! ```rust
//! use bitcoin_explorer::BitcoinDB;
//! use std::path::Path;
//!
//! let path = Path::new("/Users/me/bitcoin");
//!
//! // launch without reading txindex
//! let db = BitcoinDB::new(path, false).unwrap();
//!
//! // launch attempting to read txindex
//! let db = BitcoinDB::new(path, true).unwrap();
//! ```
//!
mod connected;
use crate::parser::blk_file::BlkFile;
use crate::parser::errors::{OpError, OpResult};
use crate::parser::script::{evaluate_script, ScriptInfo};
use crate::parser::tx_index::TxDB;
use std::ops::Deref;
use std::path::Path;
use std::sync::Arc;
// re-exports
pub use crate::iter::{BlockIter, ConnectedBlockIter};
pub use crate::parser::block_index::{BlockIndex, BlockIndexRecord};
pub use crate::parser::proto::connected_proto::{
ConnectedBlock, ConnectedTx, FConnectedBlock, FConnectedTransaction, SConnectedBlock,
SConnectedTransaction,
};
pub use crate::parser::proto::full_proto::{FBlock, FBlockHeader, FTransaction, FTxOut};
pub use crate::parser::proto::simple_proto::{SBlock, SBlockHeader, STransaction, STxOut};
pub use bitcoin::hashes::hex::{FromHex, ToHex};
pub use bitcoin::{Address, Block, BlockHash, BlockHeader, Network, Script, Transaction, Txid};
///
/// Extract addresses from a script public key.
///
#[deprecated(since = "1.2.7", note = "use `get_addresses_from_script` instead")]
pub fn parse_script(script_pub_key: &str) -> OpResult<ScriptInfo> {
get_addresses_from_script(script_pub_key)
}
///
/// Extract addresses from a script public key.
///
#[inline]
pub fn get_addresses_from_script(script_pub_key: &str) -> OpResult<ScriptInfo> {
let script = Script::from_hex(script_pub_key)?;
Ok(evaluate_script(&script, Network::Bitcoin))
}
pub struct InnerDB {
pub block_index: BlockIndex,
pub blk_file: BlkFile,
pub tx_db: TxDB,
}
///
/// This is the main struct of this crate!! Click and read the doc.
///
/// All queries start from initializing `BitcoinDB`.
///
/// Note: This is an Arc wrap around `InnerDB`.
///
#[derive(Clone)]
pub struct BitcoinDB(Arc<InnerDB>);
impl Deref for BitcoinDB {
type Target = InnerDB;
fn deref(&self) -> &Self::Target {
self.0.deref()
}
}
impl BitcoinDB {
///
/// This is the main structure for reading Bitcoin blockchain data.
///
/// Instantiating this class by passing the `-datadir` directory of
/// Bitcoin core to the `new()` method.
/// `tx_index`: whether to try to open tx_index levelDB.
///
/// # Example
///
/// ```rust
/// use bitcoin_explorer::BitcoinDB;
/// use std::path::Path;
///
/// let path = Path::new("/Users/me/bitcoin");
///
/// // launch without reading txindex
/// let db = BitcoinDB::new(path, false).unwrap();
///
/// // launch attempting to read txindex
/// let db = BitcoinDB::new(path, true).unwrap();
/// ```
pub fn new(p: &Path, tx_index: bool) -> OpResult<BitcoinDB> {
if !p.exists() {
return Err(OpError::from("data_dir does not exist"));
}
let blk_path = p.join("blocks");
let index_path = blk_path.join("index");
let block_index = BlockIndex::new(index_path.as_path())?;
let tx_db = if tx_index {
let tx_index_path = p.join("indexes").join("txindex");
TxDB::new(&tx_index_path, &block_index)
} else {
TxDB::null()
};
let inner = InnerDB {
block_index,
blk_file: BlkFile::new(blk_path.as_path())?,
tx_db,
};
Ok(BitcoinDB(Arc::new(inner)))
}
///
/// Get the maximum height found in block index.
///
/// Note, not all blocks lower than this height have
/// been downloaded (different from `get_block_count()`).
///
/// Deprecated: use `get_block_count()`
///
#[deprecated(since = "1.2.6", note = "use `get_block_count()` instead")]
pub fn get_max_height(&self) -> usize {
self.block_index.records.len()
}
///
/// Get the maximum number of blocks downloaded.
///
/// This API guarantee that block 0 to `get_block_count() - 1`
/// have been downloaded and available for query.
///
pub fn get_block_count(&self) -> usize {
let records = self.block_index.records.len();
for h in 0..records {
// n_tx == 0 indicates that the block is not downloaded
if self.block_index.records.get(h).unwrap().n_tx == 0 {
return h;
}
}
records
}
///
/// Get block header information.
///
/// This is an in-memory query, thus very fast.
/// This method is useful for computing blockchain statistics.
///
/// # Example
///
/// ## Compute total number of transactions
/// ```rust
/// use bitcoin_explorer::BitcoinDB;
/// use std::path::Path;
///
/// let path = Path::new("/Users/me/bitcoin");
///
/// // launch without reading txindex
/// let db = BitcoinDB::new(path, false).unwrap();
///
/// let mut total_number_of_tx: usize = 0;
///
/// // This computation should finish immediately. No Disk Access.
/// for i in 0..db.get_block_count() {
/// let header = db.get_header(i).unwrap();
/// total_number_of_tx += header.n_tx as usize;
/// }
/// println!("total number of transactions found on disk : {}.", total_number_of_tx);
/// ```
///
pub fn get_header(&self, height: usize) -> OpResult<&BlockIndexRecord> {
if let Some(header) = self.block_index.records.get(height) {
Ok(header)
} else {
Err(OpError::from("height not found"))
}
}
///
/// Get block hash of a certain height.
///
pub fn get_hash_from_height(&self, height: usize) -> OpResult<BlockHash> {
match self.block_index.records.get(height) {
None => Err(OpError::from("height not found")),
Some(s) => Ok(s.block_header.block_hash()),
}
}
///
/// Get block height of certain hash.
///
/// Note that the hash is a hex string of the block hash.
///
pub fn get_height_from_hash(&self, hash: &BlockHash) -> OpResult<usize> {
match self.block_index.hash_to_height.get(hash) {
None => Err(OpError::from("hash not found")),
Some(h) => Ok(*h as usize),
}
}
///
/// Get a raw block as bytes
///
pub fn get_raw_block(&self, height: usize) -> OpResult<Vec<u8>> {
if let Some(index) = self.block_index.records.get(height) {
let blk = self
.blk_file
.read_raw_block(index.n_file, index.n_data_pos)?;
Ok(blk)
} else {
Err(OpError::from("height not found"))
}
}
///
/// Get a block (in different formats (Block, FBlock, SBlock))
///
/// # Example
/// ```rust
/// use bitcoin_explorer::{BitcoinDB, FBlock, SBlock, Block};
/// use std::path::Path;
///
/// let path = Path::new("/Users/me/bitcoin");
///
/// // launch without reading txindex
/// let db = BitcoinDB::new(path, false).unwrap();
///
/// // get block of height 600000 (in different formats)
/// let block: Block = db.get_block(600000).unwrap();
/// let block: FBlock = db.get_block(600000).unwrap();
/// let block: SBlock = db.get_block(600000).unwrap();
/// ```
///
pub fn get_block<T: From<Block>>(&self, height: usize) -> OpResult<T> {
if let Some(index) = self.block_index.records.get(height) {
let blk = self.blk_file.read_block(index.n_file, index.n_data_pos)?;
Ok(blk.into())
} else {
Err(OpError::from("height not found"))
}
}
///
/// Get a transaction by providing txid.
///
/// This function requires `txindex` to be set to `true` for `BitcoinDB`,
/// and requires that flag `txindex=1` has been enabled when
/// running Bitcoin Core.
///
/// A transaction cannot be found using this function if it is
/// not yet indexed using `txindex`.
///
/// # Example
/// ```rust
/// use bitcoin_explorer::{BitcoinDB, Transaction, FTransaction, STransaction, Txid, FromHex};
/// use std::path::Path;
///
/// let path = Path::new("/Users/me/bitcoin");
///
/// // !!must launch with txindex=true!!
/// let db = BitcoinDB::new(path, true).unwrap();
///
/// // get transaction
/// // e3bf3d07d4b0375638d5f1db5255fe07ba2c4cb067cd81b84ee974b6585fb468
/// let txid_str = "e3bf3d07d4b0375638d5f1db5255fe07ba2c4cb067cd81b84ee974b6585fb468";
/// let txid = Txid::from_hex(txid_str).unwrap();
///
/// // get transactions in different formats
/// let tx: Transaction = db.get_transaction(&txid).unwrap();
/// let tx: FTransaction = db.get_transaction(&txid).unwrap();
/// let tx: STransaction = db.get_transaction(&txid).unwrap();
/// ```
///
pub fn get_transaction<T: From<Transaction>>(&self, txid: &Txid) -> OpResult<T> {
if !self.tx_db.is_open() {
return Err(OpError::from("TxDB not open"));
}
// give special treatment for genesis transaction
if self.tx_db.is_genesis_tx(txid) {
return Ok(self.get_block::<Block>(0)?.txdata.swap_remove(0).into());
}
let record = self.tx_db.get_tx_record(txid)?;
let tx = self
.blk_file
.read_transaction(record.n_file, record.n_pos, record.n_tx_offset)?;
Ok(tx.into())
}
///
/// Get the height of the block containing a particular transaction.
///
/// This function requires `txindex` to be set to `true` for `BitcoinDB`,
/// and requires that flag `txindex=1` has been enabled when
/// running Bitcoin Core.
///
/// A transaction cannot be found using this function if it is
/// not yet indexed using `txindex`.
///
pub fn get_height_of_transaction(&self, txid: &Txid) -> OpResult<usize> {
if !self.tx_db.is_open() {
return Err(OpError::from("TxDB not open"));
}
self.tx_db.get_block_height_of_tx(txid)
}
///
/// Iterate through all blocks from `start` to `end` (excluded).
///
/// Formats: `Block` / `FBlock` / `SBlock`.
///
/// # Performance
///
/// This iterator is implemented to read the blocks in concurrency,
/// but the result is still produced in sequential order.
/// Results read are stored in a synced queue for `next()`
/// to get.
///
/// The iterator stops automatically when a block cannot be
/// read (i.e., when the max height in the database met).
///
/// This is a very efficient implementation.
/// Using SSD and intel core i7 (4 core, 8 threads)
/// Iterating from height 0 to 700000 takes about 10 minutes.
///
/// # Example
///
/// ```rust
/// use bitcoin_explorer::{BitcoinDB, Block, SBlock, FBlock};
/// use std::path::Path;
///
/// let path = Path::new("/Users/me/bitcoin");
///
/// // launch without reading txindex
/// let db = BitcoinDB::new(path, false).unwrap();
///
/// // iterate over block from 600000 to 700000
/// for block in db.iter_block::<Block>(600000, 700000) {
/// for tx in block.txdata {
/// println!("do something for this transaction");
/// }
/// }
///
/// // iterate over block from 600000 to 700000
/// for block in db.iter_block::<FBlock>(600000, 700000) {
/// for tx in block.txdata {
/// println!("do something for this transaction");
/// }
/// }
///
/// // iterate over block from 600000 to 700000
/// for block in db.iter_block::<SBlock>(600000, 700000) {
/// for tx in block.txdata {
/// println!("do something for this transaction");
/// }
/// }
/// ```
///
pub fn iter_block<T>(&self, start: usize, end: usize) -> BlockIter<T>
where
T: From<Block> + Send + 'static,
{
BlockIter::from_range(self, start, end)
}
///
/// Iterate through all blocks of given heights.
///
/// Formats: `Block` / `FBlock` / `SBlock`.
///
/// # Performance
///
/// This iterator is implemented to read the blocks in concurrency,
/// but the result is still produced in the given order in `heights`.
/// Results read are stored in a synced queue for `next()`
/// to get.
///
/// This is a very efficient implementation.
/// Using SSD and intel core i7 (4 core, 8 threads)
/// Iterating from height 0 to 700000 takes about 10 minutes.
///
/// ## Fails Fast
///
/// The iterator stops immediately when a `height` cannot be found.
///
/// # Example
///
/// ```rust
/// use bitcoin_explorer::{BitcoinDB, Block, FBlock, SBlock};
/// use std::path::Path;
///
/// let path = Path::new("/Users/me/bitcoin");
///
/// // launch without reading txindex
/// let db = BitcoinDB::new(path, false).unwrap();
///
/// let some_heights = vec![3, 5, 7, 9];
///
/// // iterate over blocks from 600000 to 700000
/// for block in db.iter_heights::<Block, _>(some_heights.clone()) {
/// for tx in block.txdata {
/// println!("do something for this transaction");
/// }
/// }
///
/// // iterate over simple blocks from 600000 to 700000
/// for block in db.iter_heights::<SBlock, _>(some_heights.clone()) {
/// for tx in block.txdata {
/// println!("do something for this transaction");
/// }
/// }
///
/// // iterate over full blocks from 600000 to 700000
/// for block in db.iter_heights::<FBlock, _>(some_heights.clone()) {
/// for tx in block.txdata {
/// println!("do something for this transaction");
/// }
/// }
///
///
/// ```
///
pub fn iter_heights<T, TIter>(&self, heights: TIter) -> BlockIter<T>
where
T: 'static + From<Block> + Send,
TIter: IntoIterator<Item = usize> + Send + 'static,
<TIter as IntoIterator>::IntoIter: Send + 'static,
{
BlockIter::new(self, heights)
}
}