X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning-block-sync%2Fsrc%2Frpc.rs;h=e1dc43c8f28d65511c45ce32591ef9eb5b933e8b;hb=2d213a47bffe2f3d9b744fe64e0001d90a4bf8fa;hp=1e0aa9d93fc45e9113c8a78ff2c545e551df50ba;hpb=a3832b029c151e2afd910f5372d1aadcd4e394bc;p=rust-lightning diff --git a/lightning-block-sync/src/rpc.rs b/lightning-block-sync/src/rpc.rs index 1e0aa9d9..e1dc43c8 100644 --- a/lightning-block-sync/src/rpc.rs +++ b/lightning-block-sync/src/rpc.rs @@ -1,22 +1,43 @@ //! Simple RPC client implementation which implements [`BlockSource`] against a Bitcoin Core RPC //! endpoint. -use crate::{BlockHeaderData, BlockSource, AsyncBlockSourceResult}; +use crate::{BlockData, BlockHeaderData, BlockSource, AsyncBlockSourceResult}; use crate::http::{HttpClient, HttpEndpoint, HttpError, JsonResponse}; -use bitcoin::blockdata::block::Block; use bitcoin::hash_types::BlockHash; use bitcoin::hashes::hex::ToHex; -use futures::lock::Mutex; +use futures_util::lock::Mutex; use serde_json; use std::convert::TryFrom; use std::convert::TryInto; +use std::error::Error; +use std::fmt; use std::sync::atomic::{AtomicUsize, Ordering}; +/// An error returned by the RPC server. +#[derive(Debug)] +pub struct RpcError { + /// The error code. + pub code: i64, + /// The error message. + pub message: String, +} + +impl fmt::Display for RpcError { + fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result { + write!(f, "RPC error {}: {}", self.code, self.message) + } +} + +impl Error for RpcError {} + /// A simple RPC client for calling methods using HTTP `POST`. +/// +/// Implements [`BlockSource`] and may return an `Err` containing [`RpcError`]. See +/// [`RpcClient::call_method`] for details. pub struct RpcClient { basic_auth: String, endpoint: HttpEndpoint, @@ -39,6 +60,9 @@ impl RpcClient { } /// Calls a method with the response encoded in JSON format and interpreted as type `T`. + /// + /// When an `Err` is returned, [`std::io::Error::into_inner`] may contain an [`RpcError`] if + /// [`std::io::Error::kind`] is [`std::io::ErrorKind::Other`]. pub async fn call_method(&self, method: &str, params: &[serde_json::Value]) -> std::io::Result where JsonResponse: TryFrom, Error = std::io::Error> + TryInto { let host = format!("{}:{}", self.endpoint.host(), self.endpoint.port()); @@ -70,8 +94,11 @@ impl RpcClient { let error = &response["error"]; if !error.is_null() { // TODO: Examine error code for a more precise std::io::ErrorKind. - let message = error["message"].as_str().unwrap_or("unknown error"); - return Err(std::io::Error::new(std::io::ErrorKind::Other, message)); + let rpc_error = RpcError { + code: error["code"].as_i64().unwrap_or(-1), + message: error["message"].as_str().unwrap_or("unknown error").to_string() + }; + return Err(std::io::Error::new(std::io::ErrorKind::Other, rpc_error)); } let result = &mut response["result"]; @@ -91,11 +118,11 @@ impl BlockSource for RpcClient { }) } - fn get_block<'a>(&'a self, header_hash: &'a BlockHash) -> AsyncBlockSourceResult<'a, Block> { + fn get_block<'a>(&'a self, header_hash: &'a BlockHash) -> AsyncBlockSourceResult<'a, BlockData> { Box::pin(async move { let header_hash = serde_json::json!(header_hash.to_hex()); let verbosity = serde_json::json!(0); - Ok(self.call_method("getblock", &[header_hash, verbosity]).await?) + Ok(BlockData::FullBlock(self.call_method("getblock", &[header_hash, verbosity]).await?)) }) } @@ -164,7 +191,9 @@ mod tests { match client.call_method::("getblock", &[invalid_block_hash]).await { Err(e) => { assert_eq!(e.kind(), std::io::ErrorKind::Other); - assert_eq!(e.get_ref().unwrap().to_string(), "invalid parameter"); + let rpc_error: Box = e.into_inner().unwrap().downcast().unwrap(); + assert_eq!(rpc_error.code, -8); + assert_eq!(rpc_error.message, "invalid parameter"); }, Ok(_) => panic!("Expected error"), }