florestad/json_rpc/res.rs
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
use std::fmt::Display;
use axum::response::IntoResponse;
use serde::Deserialize;
use serde::Serialize;
#[derive(Deserialize, Serialize)]
pub struct GetBlockchainInfoRes {
pub best_block: String,
pub height: u32,
pub ibd: bool,
pub validated: u32,
pub latest_work: String,
pub latest_block_time: u32,
pub leaf_count: u32,
pub root_count: u32,
pub root_hashes: Vec<String>,
pub chain: String,
pub progress: f32,
pub difficulty: u64,
}
#[derive(Deserialize, Serialize)]
pub struct RawTxJson {
pub in_active_chain: bool,
pub hex: String,
pub txid: String,
pub hash: String,
pub size: u32,
pub vsize: u32,
pub weight: u32,
pub version: u32,
pub locktime: u32,
pub vin: Vec<TxInJson>,
pub vout: Vec<TxOutJson>,
pub blockhash: String,
pub confirmations: u32,
pub blocktime: u32,
pub time: u32,
}
#[derive(Deserialize, Serialize)]
pub struct TxOutJson {
pub value: u64,
pub n: u32,
pub script_pub_key: ScriptPubKeyJson,
}
#[derive(Deserialize, Serialize)]
pub struct ScriptPubKeyJson {
pub asm: String,
pub hex: String,
pub req_sigs: u32,
#[serde(rename = "type")]
pub type_: String,
pub address: String,
}
#[derive(Deserialize, Serialize)]
pub struct TxInJson {
pub txid: String,
pub vout: u32,
pub script_sig: ScriptSigJson,
pub sequence: u32,
pub witness: Vec<String>,
}
#[derive(Deserialize, Serialize)]
pub struct ScriptSigJson {
pub asm: String,
pub hex: String,
}
#[derive(Debug, Deserialize, Serialize)]
#[serde(untagged)]
pub enum GetBlockRes {
Verbose(Box<GetBlockResVerbose>),
Serialized(String),
}
#[derive(Debug, Deserialize, Serialize)]
pub struct RpcError {
pub code: i32,
pub message: String,
pub data: Option<String>,
}
/// Return type for the `gettxoutproof` rpc command, the internal is
/// just the hex representation of the Merkle Block, which was defined
/// by btc core.
#[derive(Debug, Deserialize, Serialize)]
pub struct GetTxOutProof(pub Vec<u8>);
/// A full bitcoin block, returned by get_block
#[derive(Debug, Deserialize, Serialize)]
pub struct GetBlockResVerbose {
/// 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 likely 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 committed 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** guaranteed 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` instead
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 rounding) 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 software (this one included) 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 coming before this one
pub previousblockhash: String,
#[serde(skip_serializing_if = "Option::is_none")]
/// The hash of the block coming after this one, if any
pub nextblockhash: Option<String>,
}
#[derive(Debug)]
pub enum JsonRpcError {
/// The request is missing some params field, which is required for most RPC calls
MissingParams,
/// The request is missing a request field, which is required for most RPC calls
MissingReq,
/// Verbosity level is not 0 or 1
InvalidVerbosityLevel,
/// The requested transaction is not found in the blockchain
TxNotFound,
/// The provided script is invalid, e.g., if it is not a valid P2PKH or P2SH script
InvalidScript,
/// The provided descriptor is invalid, e.g., if it does not match the expected format
InvalidDescriptor,
/// The requested block is not found in the blockchain
BlockNotFound,
/// There is an error with the chain, e.g., if the chain is not synced or when the chain is not valid
Chain,
/// The provided vout is invalid, e.g., if it is not a valid output
InvalidVout,
/// The provided height is invalid, e.g., if it is negative or too high
InvalidHeight,
/// The provided hash is invalid, e.g., if it is not a valid SHA256 hash
InvalidHash,
/// The provided block hash is invalid, e.g., if it is not a valid SHA256 hash
InvalidBlockHash,
/// The request is invalid, e.g., some parameters use an incorrect type
InvalidRequest,
/// The requested method is not found, e.g., if the method is not implemented or when the method is not available
MethodNotFound,
/// This error is returned when there is an error decoding the request, e.g., if the request is not valid JSON
Decode(String),
/// The provided port is invalid, e.g., when it is not a valid port number (0-65535)
InvalidPort,
/// The provided address is invalid, e.g., when it is not a valid IP address or hostname
InvalidAddress,
/// This error is returned when there is an error with the node, e.g., if the node is not connected or when the node is not responding
Node(String),
/// This error is returned when the node does not have block filters enabled, which is required for some RPC calls
NoBlockFilters,
/// The provided network is invalid, e.g., when it is not a valid Bitcoin network (mainnet, testnet3, testnet4, regtest)
InvalidNetwork,
/// This error is returned when a hex value is invalid
InvalidHex,
/// This error is returned when the node is in initial block download, which means it is still syncing the blockchain
InInitialBlockDownload,
/// This error is returned when there is an error encoding the response, e.g., if the response is not valid JSON
Encode,
InvalidMemInfoMode,
/// This error is returned when there is an error with the wallet, e.g., if the wallet is not loaded or when the wallet is not available
Wallet(String),
/// This error is returned when there is an error with block filters, e.g., if the filters are not available or when there is an issue with the filter data
Filters(String),
/// This error is returned when the addnode command is invalid, e.g., if the command is not recognized or when the parameters are incorrect
InvalidAddnodeCommand,
}
impl Display for JsonRpcError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
JsonRpcError::InvalidBlockHash => write!(f, "Provided a invalid BlockHash"),
JsonRpcError::InvalidRequest => write!(f, "Invalid request"),
JsonRpcError::InvalidHeight => write!(f, "Invalid height"),
JsonRpcError::InvalidHash => write!(f, "Invalid hash"),
JsonRpcError::InvalidHex => write!(f, "Invalid hex"),
JsonRpcError::InvalidVout => write!(f, "Invalid vout"),
JsonRpcError::MethodNotFound => write!(f, "Method not found"),
JsonRpcError::Decode(e) => write!(f, "error decoding request: {e}"),
JsonRpcError::TxNotFound => write!(f, "Transaction not found"),
JsonRpcError::InvalidDescriptor => write!(f, "Invalid descriptor"),
JsonRpcError::BlockNotFound => write!(f, "Block not found"),
JsonRpcError::Chain => write!(f, "Chain error"),
JsonRpcError::InvalidPort => write!(f, "Invalid port"),
JsonRpcError::InvalidAddress => write!(f, "Invalid address"),
JsonRpcError::Node(e) => write!(f, "Node error: {e}"),
JsonRpcError::NoBlockFilters => write!(f, "You don't have block filters enabled, please start florestad with --cfilters to run this RPC"),
JsonRpcError::InvalidNetwork => write!(f, "Invalid network"),
JsonRpcError::InInitialBlockDownload => write!(f, "Node is in initial block download, wait until it's finished"),
JsonRpcError::Encode => write!(f, "Error encoding response"),
JsonRpcError::InvalidScript => write!(f, "Invalid script"),
JsonRpcError::MissingParams => write!(f, "Missing params field"),
JsonRpcError::MissingReq => write!(f, "Missing request field"),
JsonRpcError::InvalidVerbosityLevel => write!(f, "Invalid verbosity level"),
JsonRpcError::InvalidMemInfoMode => write!(f, "Invalid meminfo mode, should be stats or mallocinfo"),
JsonRpcError::Wallet(e) => write!(f, "Wallet error: {e}"),
JsonRpcError::Filters(e) => write!(f, "Error with filters: {e}"),
JsonRpcError::InvalidAddnodeCommand => write!(f, "Invalid addnode command"),
}
}
}
impl IntoResponse for JsonRpcError {
fn into_response(self) -> axum::http::Response<axum::body::Body> {
let body = serde_json::json!({
"error": self.to_string(),
"result": serde_json::Value::Null,
"id": serde_json::Value::Null,
});
axum::http::Response::builder()
.status(axum::http::StatusCode::BAD_REQUEST)
.header("Content-Type", "application/json")
.body(axum::body::Body::from(serde_json::to_vec(&body).unwrap()))
.unwrap()
}
}