missing docs for esplora.rs (also remove useless pubs)

This commit is contained in:
Riccardo Casatta 2020-11-27 11:10:10 +01:00 committed by Steve Myers
parent 68db07b2e3
commit a766441fe0
No known key found for this signature in database
GPG Key ID: 8105A46B22C2D051

View File

@ -373,20 +373,22 @@ struct EsploraGetHistory {
status: EsploraGetHistoryStatus, status: EsploraGetHistoryStatus,
} }
/// `EsploraHeader` maps the json returned from esplora endpoint `GET /block/:hash`
/// It will be removed when `GET /block/:hash/header` will be deployed
#[derive(Default, Debug, Clone, PartialEq, Deserialize)] #[derive(Default, Debug, Clone, PartialEq, Deserialize)]
pub struct EsploraHeader { struct EsploraHeader {
pub id: String, id: String,
pub height: u32, height: u32,
pub version: i32, version: i32,
pub timestamp: u32, timestamp: u32,
pub tx_count: u32, tx_count: u32,
pub size: u32, size: u32,
pub weight: u32, weight: u32,
pub merkle_root: TxMerkleNode, merkle_root: TxMerkleNode,
pub previousblockhash: BlockHash, previousblockhash: BlockHash,
pub nonce: u32, nonce: u32,
pub bits: u32, bits: u32,
pub difficulty: u32, difficulty: u32,
} }
impl Into<BlockHeader> for EsploraHeader { impl Into<BlockHeader> for EsploraHeader {
@ -405,7 +407,11 @@ impl Into<BlockHeader> for EsploraHeader {
/// Configuration for an [`EsploraBlockchain`] /// Configuration for an [`EsploraBlockchain`]
#[derive(Debug, serde::Deserialize, serde::Serialize)] #[derive(Debug, serde::Deserialize, serde::Serialize)]
pub struct EsploraBlockchainConfig { pub struct EsploraBlockchainConfig {
/// Base URL of the esplora service
///
/// eg. `https://blockstream.info/api/`
pub base_url: String, pub base_url: String,
/// Number of parallel requests sent to the esplora service (default: 4)
pub concurrency: Option<u8>, pub concurrency: Option<u8>,
} }