#node #bitcoin #query #request

bitcoin-node-query

Query your bitcoin node

10 releases

0.1.9 Oct 10, 2022
0.1.8 Aug 28, 2022

#327 in #request

Download history 6/week @ 2024-03-09 1/week @ 2024-03-16 17/week @ 2024-03-30 4/week @ 2024-04-06

70 downloads per month
Used in 2 crates

MIT license

35KB
548 lines

☠️⚠️ Work In Progress ⚠️☠️

Bitcoin Node Query

Request information from a Bitcoin node

This library provides helpful functions to query common information about the bitcoin network.

Install

Add package to Cargo.toml file

[dependencies]
bitcoin-node-query = "0.1.9"

Usage:

use bitcoin_node_query::{
  Client,
  get_block_height,
  get_time_since_last_block_in_seconds,
  get_average_block_time_for_last_2016_blocks
}

// Create a Client.
let bitcoind_password: &str = ...
let bitcoind_username: &str = ...
let bitcoind_url = "127.0.0.1:8332"
let client = Client::new(
        &bitcoind_url,
        &bitcoind_username,
        &bitcoind_password
    ).expect("failed to create client");

// get block height
let block_height = get_block_height(&client);
println!("Block height: {:#?}", block_height);

// Get how many seconds ago the last block was mined 
let seconds_since_last_block = get_time_since_last_block_in_seconds(&client);
println!(
    "Seconds since last block:",
    format_duration(seconds_since_last_block)
);

// Get the average seconds it took for each of the last 2016 blocks to be mined
let average_seconds_per_block_last_2016_blocks =
get_average_block_time_for_last_2016_blocks(&client);
println!(
    "Average block time for last 2016 blocks",
    format_duration(average_seconds_per_block_last_2016_blocks as i64)
);

API

Find a list of all the functions available in the documentation

License

MIT © Joe Gesualdo

Dependencies

~6–16MB
~219K SLoC