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
use std::fmt::Display;
use serde::Deserialize;
use serde::Serialize;
#[derive(Debug, Deserialize, Serialize)]
pub struct GetBlockchainInfoRes {
/// The best block we know about
///
/// This should be the hash of the latest block in the most PoW chain we know about. We may
/// or may not have fully-validated it yet
pub best_block: String,
/// The depth of the most-PoW chain we know about
pub height: u32,
/// Whether we are on Initial Block Download
pub ibd: bool,
/// How many blocks we have fully-validated so far? This number will be smaller than
/// height during IBD, and should be equal to height otherwise
pub validated: u32,
/// The work performed by the last block
///
/// This is the estimated amount of hashes the miner of this block had to perform
/// before mining that block, on average
pub latest_work: String,
/// The UNIX timestamp for the latest block, as reported by the block's header
pub latest_block_time: u32,
/// How many leaves we have in the utreexo accumulator so far
///
/// This should be equal to the number of UTXOs returned by core's `gettxoutsetinfo`
pub leaf_count: u32,
/// How many roots we have in the acc
pub root_count: u32,
/// The actual hex-encoded roots
pub root_hashes: Vec<String>,
/// A short string representing the chain we're in
pub chain: String,
/// The validation progress
///
/// 0% means we didn't validate any block. 100% means we've validated all blocks, so
/// validated == height
pub progress: Option<f32>,
/// Current network "difficulty"
///
/// On average, miners needs to make `difficulty` hashes before finding one that
/// solves a block's PoW
pub difficulty: u64,
}
/// The information returned by a get_raw_tx
#[derive(Deserialize, Serialize)]
pub struct RawTx {
/// Whether this tx is in our best known chain
pub in_active_chain: bool,
/// The hex-encoded tx
pub hex: String,
/// Tha sha256d of the serialized transaction without witness
pub txid: String,
/// The sha256d of the serialized transaction including witness
pub hash: String,
/// The size this transaction occupies on disk
pub size: u32,
/// The virtual size of this transaction, as define by the segwit soft-fork
pub vsize: u32,
/// The weight of this transacion, as defined by the segwit soft-fork
pub weight: u32,
/// This transaction's version. The current bigger version is 2
pub version: u32,
/// This transaction's locktime
pub locktime: u32,
/// A list of inputs being spent by this transaction
///
/// See [TxIn] for more information about the contents of this
pub vin: Vec<TxIn>,
/// A list of outputs being created by this tx
///
/// Se [TxOut] for more information
pub vout: Vec<TxOut>,
/// The hash of the block that included this tx, if any
pub blockhash: String,
/// How many blocks have been mined after this transaction's confirmation
/// including the block that confirms it. A zero value means this tx is unconfirmed
pub confirmations: u32,
/// The timestamp for the block confirming this tx, if confirmed
pub blocktime: u32,
/// Same as blocktime
pub time: u32,
}
/// A transaction output returned by some RPCs like getrawtransaction and getblock
#[derive(Deserialize, Serialize)]
pub struct TxOut {
/// The amount in sats locked in this UTXO
pub value: u64,
/// This utxo's index inside the transaction
pub n: u32,
/// The loking script of this utxo
pub script_pub_key: ScriptPubKey,
}
/// The locking script inside a txout
#[derive(Deserialize, Serialize)]
pub struct ScriptPubKey {
/// A ASM representation for this script
///
/// Assembly is a high-level representation of a lower level code. Instructions
/// are turned into OP_XXXXX and data is hex-encoded.
/// E.g: OP_DUP OP_HASH160 <0000000000000000000000000000000000000000> OP_EQUALVERIFY OP_CHECKSIG
pub asm: String,
/// The hex-encoded raw script
pub hex: String,
/// How many signatures are required to spend this UTXO.
///
/// This field is deprecated and is here for compatibility with Core
pub req_sigs: u32,
#[serde(rename = "type")]
/// The type of this spk. E.g: PKH, SH, WSH, WPKH, TR, non-standard...
pub type_: String,
/// Encode this script using one of the standard address types, if possible
pub address: String,
}
/// A transaction input returned by some rpcs, like getrawtransaction and getblock
#[derive(Deserialize, Serialize)]
pub struct TxIn {
/// The txid that created this UTXO
pub txid: String,
/// The index of this UTXO inside the tx that created it
pub vout: u32,
/// Unlocking script that should solve the challenge and prove ownership over
/// that UTXO
pub script_sig: ScriptSigJson,
/// The nSequence field, used in relative and absolute lock-times
pub sequence: u32,
/// A vector of witness elements for this input
pub witness: Vec<String>,
}
/// A representation for the transaction ScriptSig, returned by some rpcs
/// like getrawtransaction and getblock
#[derive(Deserialize, Serialize)]
pub struct ScriptSigJson {
/// A ASM representation for this scriptSig
///
/// Assembly is a high-level representation of a lower level code. Instructions
/// are turned into OP_XXXXX and data is hex-encoded.
/// E.g: OP_PUSHBYTES32 <000000000000000000000000000000000000000000000000000000000000000000>
pub asm: String,
/// The hex-encoded script sig
pub hex: String,
}
/// General information about our peers. Returned by get_peer_info
#[derive(Debug, Deserialize, Serialize)]
pub struct PeerInfo {
/// The network address for this peer.
pub address: String,
/// A string with the services this peer advertises. E.g. NODE_NETWORK, UTREEXO, WITNESS...
pub services: String,
/// User agent is a string that represents the client being used by our peer. E.g.
/// /Satoshi-26.0/ for bitcoin core version 26
pub user_agent: String,
/// This peer's height at the time we've openned a connection with them
pub initial_height: u32,
/// The connection type of this peer
///
/// We can connect with peers for different reasons. E.g. we can connect to a peer to
/// see if it has a block we're missing, or just to check if that address is still alive.
/// Possible values are: Feeler, Regular and Extra
pub kind: String,
/// The state of this peer
///
/// Can be either Ready, Connecting or Banned
pub state: String,
}
/// A full bitcoin block, returned by get_block
#[derive(Debug, Deserialize, Serialize)]
pub struct GetBlockRes {
/// This block's hash.
pub hash: String,
/// How many blocks have been added to the chain, after this one have been found. This is
/// inclusive, so it starts with one when this block is the latest. If another one is found,
/// then it increments to 2 and so on...
pub confirmations: u32,
/// The size of this block, without the witness
pub strippedsize: usize,
/// This block's size, with the witness
pub size: usize,
/// This block's weight.
///
/// Data inside a segwit block is counted differently, 'base data' has a weight of 4, while
/// witness only counts 1. This is (3 * base_size) + size
pub weight: usize,
/// How many blocks there are before this block
pub height: u32,
/// This block's version field
///
/// Currently, blocks have version 2 (see BIP34), but it may also flip some of the LSB for
/// either consensus reason (see BIPs 8 and 9) or for version rolling mining, usually bits
/// after the 24th are not touched. Therefore, the actual version is likelly the result of
/// version & ~(1 << 24).
/// This is encoded as a number, see `version_hex` for a hex-encoded version
pub version: i32,
#[serde(rename = "versionHex")]
/// Same as `version` by hex-encoded
pub version_hex: String,
/// This block's merkle root
///
/// A Merkle Tree is a binary tree where every leaf is some data, and the branches are pairwise
/// hashes util reaching the root. This allows for compact proof of inclusion in the original
/// set. This merkle tree commits to the txid of all transactions in a block, and is used by
/// some light clients to determine whether a transaction is in a given block
pub merkleroot: String,
/// A list of hex-encoded transaction id for the tx's in this block
pub tx: Vec<String>,
/// The timestamp commited to in this block's header
///
/// Since there's no central clock that can tell time precisely in Bitcoin, this value is
/// reported by miners and only constrained by a couple of consensus rules. More sensibly, it
/// is **not** garanteed to be monotonical. So a block n might have a lower timestamp than
/// block `n - 1`.
/// If you need it to be monotonical, see `mediantime` insted
pub time: u32,
/// The meadian of the last 11 blocktimes.
///
/// This is a monotonically increasing number that bounds how old a block can be. Blocks may
/// not have a timestamp less than the current `mediantime`. This is also used in relative
/// timelocks.
pub mediantime: u32,
/// The nonce used to mine this block.
///
/// Blocks are mined by increasing this value until you find a hash that is less than a network
/// defined target. This number has no meaning in itself and is just a random u32.
pub nonce: u32,
/// Bits is a compact representation for the target.
///
/// This is a exponential format (with well-define rouding) used by openssl that Satoshi
/// decided to make consensus critical :/
pub bits: String,
/// The difficulty is derived from the current target and is defined as how many hashes, on
/// average, one has to make before finding a valid block
///
/// This is computed as 1 / (target / 2 ^ 256). In most softwares (this one inclued) the
/// difficulty is a multiple of the smallest possible difficulty. So to find the actual
/// difficulty you have to multiply this by the min_diff.
/// For mainnet, mindiff is 2 ^ 32
pub difficulty: u128,
/// Commullative work in this network
///
/// This is a estimate of how many hashes the network has ever made to produce this chain
pub chainwork: String,
/// How many transactions in this block
pub n_tx: usize,
/// The hash of the block comming before this one
pub previousblockhash: String,
#[serde(skip_serializing_if = "Option::is_none")]
/// The hash of the block comming after this one, if any
pub nextblockhash: Option<String>,
}
#[derive(Debug)]
/// All possible errors returned by the jsonrpc
pub enum Error {
/// An error while deserializing our response
Serde(serde_json::Error),
#[cfg(feature = "with-jsonrpc")]
/// An internal reqwest error
JsonRpc(jsonrpc::Error),
/// An error internal to our jsonrpc server
Api(serde_json::Value),
/// The server sent an empty response
EmtpyResponse,
}
impl From<serde_json::Error> for Error {
fn from(value: serde_json::Error) -> Self {
Error::Serde(value)
}
}
#[cfg(feature = "with-jsonrpc")]
impl From<jsonrpc::Error> for Error {
fn from(value: jsonrpc::Error) -> Self {
Error::JsonRpc(value)
}
}
impl Display for Error {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
#[cfg(feature = "with-jsonrpc")]
Error::JsonRpc(e) => write!(f, "JsonRpc returned an error {e}"),
Error::Api(e) => write!(f, "general jsonrpc error: {e}"),
Error::Serde(e) => write!(f, "error while deserializing the response: {e}"),
Error::EmtpyResponse => write!(f, "got an empty response from server"),
}
}
}
impl std::error::Error for Error {}