Struct Query 

pub struct Query(/* private fields */);

Implementations

impl Query

pub fn address(&self, address: Address) -> Result<AddressStats>

Examples found in repository

examples/query.rs (lines 65-67)

fn run() -> Result<()> {
    let bitcoin_dir = Client::default_bitcoin_path();
    // let bitcoin_dir = Path::new("/Volumes/WD_BLACK1/bitcoin");

    let blocks_dir = bitcoin_dir.join("blocks");

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    fs::create_dir_all(&outputs_dir)?;
    // let outputs_dir = Path::new("/Volumes/WD_BLACK1/brk");

    let client = Client::new(
        Client::default_url(),
        Auth::CookieFile(bitcoin_dir.join(".cookie")),
    )?;

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    // let outputs_dir = Path::new("../../_outputs");

    let exit = Exit::new();
    exit.set_ctrlc_handler();

    let reader = Reader::new(blocks_dir, &client);

    let indexer = Indexer::forced_import(&outputs_dir)?;

    let computer = Computer::forced_import(&outputs_dir, &indexer, None)?;

    let mempool = Mempool::new(&client);
    let mempool_clone = mempool.clone();
    thread::spawn(move || {
        mempool_clone.start();
    });

    let query = Query::build(&reader, &indexer, &computer, Some(mempool));

    dbg!(
        indexer
            .stores
            .addresstype_to_addresshash_to_addressindex
            .get_unwrap(OutputType::P2WSH)
            .approximate_len()
    );

    let _ = dbg!(query.address(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string(),
    )));

    let _ = dbg!(query.address_txids(
        Address::from("bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()),
        None,
        25
    ));

    let _ = dbg!(query.address_utxos(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()
    )));

    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date"].into(),
    //     range: DataRangeFormat::default().set_from(-1),
    // })?);
    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date", "timestamp"].into(),
    //     range: DataRangeFormat::default().set_from(-10).set_count(5),
    // })?);

    Ok(())
}

pub fn address_txids( &self, address: Address, after_txid: Option<Txid>, limit: usize, ) -> Result<Vec<Txid>>

Examples found in repository

examples/query.rs (lines 69-73)

fn run() -> Result<()> {
    let bitcoin_dir = Client::default_bitcoin_path();
    // let bitcoin_dir = Path::new("/Volumes/WD_BLACK1/bitcoin");

    let blocks_dir = bitcoin_dir.join("blocks");

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    fs::create_dir_all(&outputs_dir)?;
    // let outputs_dir = Path::new("/Volumes/WD_BLACK1/brk");

    let client = Client::new(
        Client::default_url(),
        Auth::CookieFile(bitcoin_dir.join(".cookie")),
    )?;

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    // let outputs_dir = Path::new("../../_outputs");

    let exit = Exit::new();
    exit.set_ctrlc_handler();

    let reader = Reader::new(blocks_dir, &client);

    let indexer = Indexer::forced_import(&outputs_dir)?;

    let computer = Computer::forced_import(&outputs_dir, &indexer, None)?;

    let mempool = Mempool::new(&client);
    let mempool_clone = mempool.clone();
    thread::spawn(move || {
        mempool_clone.start();
    });

    let query = Query::build(&reader, &indexer, &computer, Some(mempool));

    dbg!(
        indexer
            .stores
            .addresstype_to_addresshash_to_addressindex
            .get_unwrap(OutputType::P2WSH)
            .approximate_len()
    );

    let _ = dbg!(query.address(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string(),
    )));

    let _ = dbg!(query.address_txids(
        Address::from("bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()),
        None,
        25
    ));

    let _ = dbg!(query.address_utxos(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()
    )));

    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date"].into(),
    //     range: DataRangeFormat::default().set_from(-1),
    // })?);
    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date", "timestamp"].into(),
    //     range: DataRangeFormat::default().set_from(-10).set_count(5),
    // })?);

    Ok(())
}

pub fn address_utxos(&self, address: Address) -> Result<Vec<Utxo>>

Examples found in repository

examples/query.rs (lines 75-77)

fn run() -> Result<()> {
    let bitcoin_dir = Client::default_bitcoin_path();
    // let bitcoin_dir = Path::new("/Volumes/WD_BLACK1/bitcoin");

    let blocks_dir = bitcoin_dir.join("blocks");

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    fs::create_dir_all(&outputs_dir)?;
    // let outputs_dir = Path::new("/Volumes/WD_BLACK1/brk");

    let client = Client::new(
        Client::default_url(),
        Auth::CookieFile(bitcoin_dir.join(".cookie")),
    )?;

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    // let outputs_dir = Path::new("../../_outputs");

    let exit = Exit::new();
    exit.set_ctrlc_handler();

    let reader = Reader::new(blocks_dir, &client);

    let indexer = Indexer::forced_import(&outputs_dir)?;

    let computer = Computer::forced_import(&outputs_dir, &indexer, None)?;

    let mempool = Mempool::new(&client);
    let mempool_clone = mempool.clone();
    thread::spawn(move || {
        mempool_clone.start();
    });

    let query = Query::build(&reader, &indexer, &computer, Some(mempool));

    dbg!(
        indexer
            .stores
            .addresstype_to_addresshash_to_addressindex
            .get_unwrap(OutputType::P2WSH)
            .approximate_len()
    );

    let _ = dbg!(query.address(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string(),
    )));

    let _ = dbg!(query.address_txids(
        Address::from("bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()),
        None,
        25
    ));

    let _ = dbg!(query.address_utxos(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()
    )));

    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date"].into(),
    //     range: DataRangeFormat::default().set_from(-1),
    // })?);
    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date", "timestamp"].into(),
    //     range: DataRangeFormat::default().set_from(-10).set_count(5),
    // })?);

    Ok(())
}

pub fn address_mempool_txids(&self, address: Address) -> Result<Vec<Txid>>

impl Query

pub fn block(&self, hash: &BlockHash) -> Result<BlockInfo>

pub fn block_by_height(&self, height: Height) -> Result<BlockInfo>

pub fn blocks(&self, start_height: Option<Height>) -> Result<Vec<BlockInfo>>

pub fn height_by_hash(&self, hash: &BlockHash) -> Result<Height>

impl Query

pub fn block_raw(&self, hash: &BlockHash) -> Result<Vec<u8>>

impl Query

pub fn block_status(&self, hash: &BlockHash) -> Result<BlockStatus>

impl Query

pub fn block_by_timestamp(&self, timestamp: Timestamp) -> Result<BlockTimestamp>

impl Query

pub fn block_txids(&self, hash: &BlockHash) -> Result<Vec<Txid>>

pub fn block_txs( &self, hash: &BlockHash, start_index: TxIndex, ) -> Result<Vec<Transaction>>

pub fn block_txid_at_index( &self, hash: &BlockHash, index: TxIndex, ) -> Result<Txid>

impl Query

pub fn cost_basis_cohorts(&self) -> Result<Vec<String>>

List available cohorts for cost basis distribution.

pub fn cost_basis_distribution( &self, cohort: &str, date: Date, ) -> Result<CostBasisDistribution>

Get the cost basis distribution for a cohort on a specific date.

pub fn cost_basis_dates(&self, cohort: &str) -> Result<Vec<Date>>

List available dates for a cohort’s cost basis distribution.

pub fn cost_basis_formatted( &self, cohort: &str, date: Date, bucket: CostBasisBucket, value: CostBasisValue, ) -> Result<CostBasisFormatted>

Get the formatted cost basis distribution.

impl Query

pub fn mempool_info(&self) -> Result<MempoolInfo>

pub fn mempool_txids(&self) -> Result<Vec<Txid>>

pub fn recommended_fees(&self) -> Result<RecommendedFees>

pub fn mempool_blocks(&self) -> Result<Vec<MempoolBlock>>

impl Query

pub fn match_metric(&self, metric: &Metric, limit: Limit) -> Vec<&'static str>

pub fn metric_not_found_error(&self, metric: &Metric) -> Error

pub fn search( &self, params: &MetricSelection, ) -> Result<Vec<&'static dyn AnyExportableVec>>

Search for vecs matching the given metrics and index. Returns error if no metrics requested or any requested metric is not found.

pub fn weight( vecs: &[&dyn AnyExportableVec], from: Option<i64>, to: Option<i64>, ) -> usize

Calculate total weight of the vecs for the given range. Applies index-specific cost multipliers for rate limiting.

pub fn resolve( &self, params: MetricSelection, max_weight: usize, ) -> Result<ResolvedQuery>

Resolve query metadata without formatting (cheap). Use with format for lazy formatting after ETag check.

pub fn format(&self, resolved: ResolvedQuery) -> Result<MetricOutput>

Format a resolved query (expensive). Call after ETag/cache checks to avoid unnecessary work.

pub fn metric_to_index_to_vec(&self) -> &BTreeMap<&str, IndexToVec<'_>>

pub fn index_to_metric_to_vec(&self) -> &BTreeMap<Index, MetricToVec<'_>>

pub fn metric_count(&self) -> DetailedMetricCount

pub fn indexes(&self) -> &[IndexInfo]

pub fn metrics(&self, pagination: Pagination) -> PaginatedMetrics

pub fn metrics_catalog(&self) -> &TreeNode

pub fn index_to_vecids( &self, paginated_index: PaginationIndex, ) -> Option<&[&str]>

pub fn metric_to_indexes(&self, metric: Metric) -> Option<&Vec<Index>>

impl Query

pub fn format_legacy( &self, resolved: ResolvedQuery, ) -> Result<MetricOutputLegacy>

Deprecated - format a resolved query as legacy output (expensive).

impl Query

pub fn block_fee_rates( &self, _time_period: TimePeriod, ) -> Result<Vec<BlockFeeRatesEntry>>

impl Query

pub fn block_fees(&self, time_period: TimePeriod) -> Result<Vec<BlockFeesEntry>>

impl Query

pub fn block_rewards( &self, time_period: TimePeriod, ) -> Result<Vec<BlockRewardsEntry>>

impl Query

pub fn block_sizes_weights( &self, time_period: TimePeriod, ) -> Result<BlockSizesWeights>

impl Query

pub fn difficulty_adjustment(&self) -> Result<DifficultyAdjustment>

impl Query

pub fn difficulty_adjustments( &self, time_period: Option<TimePeriod>, ) -> Result<Vec<DifficultyAdjustmentEntry>>

impl Query

pub fn hashrate( &self, time_period: Option<TimePeriod>, ) -> Result<HashrateSummary>

impl Query

pub fn mining_pools(&self, time_period: TimePeriod) -> Result<PoolsSummary>

pub fn all_pools(&self) -> Vec<PoolInfo>

pub fn pool_detail(&self, slug: PoolSlug) -> Result<PoolDetail>

impl Query

pub fn reward_stats(&self, block_count: usize) -> Result<RewardStats>

impl Query

pub fn transaction(&self, _: TxidParam) -> Result<Transaction>

pub fn transaction_status(&self, _: TxidParam) -> Result<TxStatus>

pub fn transaction_hex(&self, _: TxidParam) -> Result<String>

pub fn outspend(&self, _: TxidParam, vout: Vout) -> Result<TxOutspend>

pub fn outspends(&self, _: TxidParam) -> Result<Vec<TxOutspend>>

pub fn transaction_by_index(&self, txindex: TxIndex) -> Result<Transaction>

impl Query

pub fn build( reader: &Reader, indexer: &Indexer, computer: &Computer, mempool: Option<Mempool>, ) -> Self

Examples found in repository

examples/query.rs (line 55)

fn run() -> Result<()> {
    let bitcoin_dir = Client::default_bitcoin_path();
    // let bitcoin_dir = Path::new("/Volumes/WD_BLACK1/bitcoin");

    let blocks_dir = bitcoin_dir.join("blocks");

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    fs::create_dir_all(&outputs_dir)?;
    // let outputs_dir = Path::new("/Volumes/WD_BLACK1/brk");

    let client = Client::new(
        Client::default_url(),
        Auth::CookieFile(bitcoin_dir.join(".cookie")),
    )?;

    let outputs_dir = Path::new(&env::var("HOME").unwrap()).join(".brk");
    // let outputs_dir = Path::new("../../_outputs");

    let exit = Exit::new();
    exit.set_ctrlc_handler();

    let reader = Reader::new(blocks_dir, &client);

    let indexer = Indexer::forced_import(&outputs_dir)?;

    let computer = Computer::forced_import(&outputs_dir, &indexer, None)?;

    let mempool = Mempool::new(&client);
    let mempool_clone = mempool.clone();
    thread::spawn(move || {
        mempool_clone.start();
    });

    let query = Query::build(&reader, &indexer, &computer, Some(mempool));

    dbg!(
        indexer
            .stores
            .addresstype_to_addresshash_to_addressindex
            .get_unwrap(OutputType::P2WSH)
            .approximate_len()
    );

    let _ = dbg!(query.address(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string(),
    )));

    let _ = dbg!(query.address_txids(
        Address::from("bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()),
        None,
        25
    ));

    let _ = dbg!(query.address_utxos(Address::from(
        "bc1qwzrryqr3ja8w7hnja2spmkgfdcgvqwp5swz4af4ngsjecfz0w0pqud7k38".to_string()
    )));

    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date"].into(),
    //     range: DataRangeFormat::default().set_from(-1),
    // })?);
    // dbg!(query.search_and_format(MetricSelection {
    //     index: Index::Height,
    //     metrics: vec!["date", "timestamp"].into(),
    //     range: DataRangeFormat::default().set_from(-10).set_count(5),
    // })?);

    Ok(())
}

pub fn height(&self) -> Height

Current indexed height

pub fn reader(&self) -> &Reader

pub fn client(&self) -> &Client

pub fn blocks_dir(&self) -> &Path

pub fn indexer(&self) -> &Indexer

pub fn computer(&self) -> &Computer

pub fn mempool(&self) -> Option<&Mempool>

pub fn vecs(&self) -> &'static Vecs<'static>

Trait Implementations

impl Clone for Query

fn clone(&self) -> Query

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.