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
// Bitcoin Dev Kit
// Written in 2020 by Alekos Filini <alekos.filini@gmail.com>
//
// Copyright (c) 2020-2021 Bitcoin Dev Kit Developers
//
// This file is licensed under the Apache License, Version 2.0 <LICENSE-APACHE
// or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option.
// You may not use this file except in accordance with one or both of these
// licenses.
//! Esplora by way of `ureq` HTTP client.
use std::collections::HashMap;
use std::str::FromStr;
use std::time::Duration;
use bpstd::hashes::{sha256, Hash};
use bpstd::{BlockHash, ScriptPubkey, Txid};
#[allow(unused_imports)]
use log::{debug, error, info, trace};
use ureq::{Agent, Proxy, Response};
use crate::{BlockStatus, BlockSummary, Builder, Error, OutputStatus, Tx, TxStatus, Utxo};
#[derive(Debug, Clone)]
pub struct BlockingClient {
url: String,
agent: Agent,
}
impl BlockingClient {
/// build a blocking client from a [`Builder`]
pub fn from_builder(builder: Builder) -> Result<Self, Error> {
let mut agent_builder = ureq::AgentBuilder::new();
if let Some(timeout) = builder.timeout {
agent_builder = agent_builder.timeout(Duration::from_secs(timeout));
}
if let Some(proxy) = &builder.proxy {
agent_builder = agent_builder.proxy(Proxy::new(proxy)?);
}
Ok(Self::from_agent(builder.base_url, agent_builder.build()))
}
/// build a blocking client from an [`Agent`]
pub fn from_agent(url: String, agent: Agent) -> Self {
BlockingClient { url, agent }
}
/* Uncomment once `bp-primitives` will support consensus serialziation
/// Get a [`Transaction`] option given its [`Txid`]
pub fn tx(&self, txid: &Txid) -> Result<Option<Transaction>, Error> {
let resp = self
.agent
.get(&format!("{}/tx/{}/raw", self.url, txid))
.call();
match resp {
Ok(resp) => Ok(Some(deserialize(&into_bytes(resp)?)?)),
Err(ureq::Error::Status(code, _)) => {
if is_status_not_found(code) {
return Ok(None);
}
Err(Error::HttpResponse(code))
}
Err(e) => Err(Error::Ureq(e)),
}
}
/// Get a [`Transaction`] given its [`Txid`].
pub fn tx_no_opt(&self, txid: &Txid) -> Result<Transaction, Error> {
match self.tx(txid) {
Ok(Some(tx)) => Ok(tx),
Ok(None) => Err(Error::TransactionNotFound(*txid)),
Err(e) => Err(e),
}
}
*/
/// Get a [`Txid`] of a transaction given its index in a block with a given hash.
pub fn txid_at_block_index(
&self,
block_hash: &BlockHash,
index: usize,
) -> Result<Option<Txid>, Error> {
let resp = self
.agent
.get(&format!("{}/block/{}/txid/{}", self.url, block_hash, index))
.call();
match resp {
Ok(resp) => Ok(Some(Txid::from_str(&resp.into_string()?)?)),
Err(ureq::Error::Status(code, _)) => {
if is_status_not_found(code) {
return Ok(None);
}
Err(Error::HttpResponse(code))
}
Err(e) => Err(Error::Ureq(e)),
}
}
/// Get the status of a [`Transaction`] given its [`Txid`].
pub fn tx_status(&self, txid: &Txid) -> Result<TxStatus, Error> {
let resp = self
.agent
.get(&format!("{}/tx/{}/status", self.url, txid))
.call();
match resp {
Ok(resp) => Ok(resp.into_json()?),
Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
Err(e) => Err(Error::Ureq(e)),
}
}
/* Uncomment once `bp-primitives` will support consensus serialziation
/// Get a [`BlockHeader`] given a particular block hash.
pub fn header_by_hash(&self, block_hash: &BlockHash) -> Result<BlockHeader, Error> {
let resp = self
.agent
.get(&format!("{}/block/{}/header", self.url, block_hash))
.call();
match resp {
Ok(resp) => Ok(deserialize(&Vec::from_hex(&resp.into_string()?)?)?),
Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
Err(e) => Err(Error::Ureq(e)),
}
}
*/
/// Get the [`BlockStatus`] given a particular [`BlockHash`].
pub fn block_status(&self, block_hash: &BlockHash) -> Result<BlockStatus, Error> {
let resp = self
.agent
.get(&format!("{}/block/{}/status", self.url, block_hash))
.call();
match resp {
Ok(resp) => Ok(resp.into_json()?),
Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
Err(e) => Err(Error::Ureq(e)),
}
}
/* TODO: Uncomment once `bp-primitives` will support blocks
/// Get a [`Block`] given a particular [`BlockHash`].
pub fn block_by_hash(&self, block_hash: &BlockHash) -> Result<Option<Block>, Error> {
let resp = self
.agent
.get(&format!("{}/block/{}/raw", self.url, block_hash))
.call();
match resp {
Ok(resp) => Ok(Some(deserialize(&into_bytes(resp)?)?)),
Err(ureq::Error::Status(code, _)) => {
if is_status_not_found(code) {
return Ok(None);
}
Err(Error::HttpResponse(code))
}
Err(e) => Err(Error::Ureq(e)),
}
}
/// Get a merkle inclusion proof for a [`Transaction`] with the given [`Txid`].
pub fn merkle_proof(&self, txid: &Txid) -> Result<Option<MerkleProof>, Error> {
let resp = self
.agent
.get(&format!("{}/tx/{}/merkle-proof", self.url, txid))
.call();
match resp {
Ok(resp) => Ok(Some(resp.into_json()?)),
Err(ureq::Error::Status(code, _)) => {
if is_status_not_found(code) {
return Ok(None);
}
Err(Error::HttpResponse(code))
}
Err(e) => Err(Error::Ureq(e)),
}
}
/// Get a [`MerkleBlock`] inclusion proof for a [`Transaction`] with the given [`Txid`].
pub fn merkle_block(&self, txid: &Txid) -> Result<Option<MerkleBlock>, Error> {
let resp = self
.agent
.get(&format!("{}/tx/{}/merkleblock-proof", self.url, txid))
.call();
match resp {
Ok(resp) => Ok(Some(deserialize(&Vec::from_hex(&resp.into_string()?)?)?)),
Err(ureq::Error::Status(code, _)) => {
if is_status_not_found(code) {
return Ok(None);
}
Err(Error::HttpResponse(code))
}
Err(e) => Err(Error::Ureq(e)),
}
}
*/
/// Get the spending status of an output given a [`Txid`] and the output index.
pub fn output_status(&self, txid: &Txid, index: u64) -> Result<Option<OutputStatus>, Error> {
let resp = self
.agent
.get(&format!("{}/tx/{}/outspend/{}", self.url, txid, index))
.call();
match resp {
Ok(resp) => Ok(Some(resp.into_json()?)),
Err(ureq::Error::Status(code, _)) => {
if is_status_not_found(code) {
return Ok(None);
}
Err(Error::HttpResponse(code))
}
Err(e) => Err(Error::Ureq(e)),
}
}
/* Uncomment once `bp-primitives` will support consensus serialziation
/// Broadcast a [`Transaction`] to Esplora
pub fn broadcast(&self, transaction: &Transaction) -> Result<(), Error> {
let resp = self
.agent
.post(&format!("{}/tx", self.url))
.send_string(&serialize(transaction).to_lower_hex_string());
match resp {
Ok(_) => Ok(()), // We do not return the txid?
Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
Err(e) => Err(Error::Ureq(e)),
}
}
*/
/// Get the height of the current blockchain tip.
pub fn height(&self) -> Result<u32, Error> {
let resp = self
.agent
.get(&format!("{}/blocks/tip/height", self.url))
.call();
match resp {
Ok(resp) => Ok(resp.into_string()?.parse()?),
Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
Err(e) => Err(Error::Ureq(e)),
}
}
/// Get the [`BlockHash`] of the current blockchain tip.
pub fn tip_hash(&self) -> Result<BlockHash, Error> {
let resp = self
.agent
.get(&format!("{}/blocks/tip/hash", self.url))
.call();
Self::process_block_result(resp)
}
/// Get the [`BlockHash`] of a specific block height
pub fn block_hash(&self, block_height: u32) -> Result<BlockHash, Error> {
let resp = self
.agent
.get(&format!("{}/block-height/{}", self.url, block_height))
.call();
if let Err(ureq::Error::Status(code, _)) = resp {
if is_status_not_found(code) {
return Err(Error::HeaderHeightNotFound(block_height));
}
}
Self::process_block_result(resp)
}
fn process_block_result(response: Result<Response, ureq::Error>) -> Result<BlockHash, Error> {
match response {
Ok(resp) => Ok(BlockHash::from_str(&resp.into_string()?)?),
Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
Err(e) => Err(Error::Ureq(e)),
}
}
/// Get an map where the key is the confirmation target (in number of blocks)
/// and the value is the estimated feerate (in sat/vB).
pub fn fee_estimates(&self) -> Result<HashMap<String, f64>, Error> {
let resp = self
.agent
.get(&format!("{}/fee-estimates", self.url,))
.call();
let map = match resp {
Ok(resp) => {
let map: HashMap<String, f64> = resp.into_json()?;
Ok(map)
}
Err(ureq::Error::Status(code, _)) => Err(Error::HttpResponse(code)),
Err(e) => Err(Error::Ureq(e)),
}?;
Ok(map)
}
/// Get confirmed transaction history for the specified address/scripthash,
/// sorted with newest first. Returns 25 transactions per page.
/// More can be requested by specifying the last txid seen by the previous query.
pub fn scripthash_txs(
&self,
script: &ScriptPubkey,
last_seen: Option<Txid>,
) -> Result<Vec<Tx>, Error> {
let script_hash = sha256::Hash::hash(script.as_ref());
let url = match last_seen {
Some(last_seen) => format!(
"{}/scripthash/{:x}/txs/chain/{}",
self.url, script_hash, last_seen
),
None => format!("{}/scripthash/{:x}/txs", self.url, script_hash),
};
Ok(self.agent.get(&url).call()?.into_json()?)
}
/// Get confirmed transaction history for the specified address/scripthash,
/// sorted with newest first. Returns 25 transactions per page.
/// More can be requested by specifying the last txid seen by the previous query.
pub fn scripthash_utxo(&self, script: &ScriptPubkey) -> Result<Vec<Utxo>, Error> {
let script_hash = sha256::Hash::hash(script.as_ref());
let url = format!("{}/scripthash/{:x}/utxo", self.url, script_hash);
Ok(self.agent.get(&url).call()?.into_json()?)
}
/// Gets some recent block summaries starting at the tip or at `height` if provided.
///
/// The maximum number of summaries returned depends on the backend itself: esplora returns `10`
/// while [mempool.space](https://mempool.space/docs/api) returns `15`.
pub fn blocks(&self, height: Option<u32>) -> Result<Vec<BlockSummary>, Error> {
let url = match height {
Some(height) => format!("{}/blocks/{}", self.url, height),
None => format!("{}/blocks", self.url),
};
Ok(self.agent.get(&url).call()?.into_json()?)
}
/// Get the underlying base URL.
pub fn url(&self) -> &str {
&self.url
}
/// Get the underlying [`Agent`].
pub fn agent(&self) -> &Agent {
&self.agent
}
}
fn is_status_not_found(status: u16) -> bool {
status == 404
}
/*
fn into_bytes(resp: Response) -> Result<Vec<u8>, std::io::Error> {
use std::io::Read;
const BYTES_LIMIT: usize = 10 * 1_024 * 1_024;
let mut buf: Vec<u8> = vec![];
resp.into_reader()
.take((BYTES_LIMIT + 1) as u64)
.read_to_end(&mut buf)?;
if buf.len() > BYTES_LIMIT {
return Err(io::Error::new(
io::ErrorKind::Other,
"response too big for into_bytes",
));
}
Ok(buf)
}
*/