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 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434
//! JsonRPC client implementation.
//!
//! TODO: - Add option for http connector.
//! - Refactor JsonRpcConnectorError into concrete error types and implement fmt::display [https://github.com/zingolabs/zaino/issues/67].
use http::Uri;
use reqwest::{Client, Url};
use serde::{Deserialize, Serialize};
use serde_json::Value;
use std::sync::atomic::{AtomicI32, Ordering};
use crate::jsonrpc::{
error::JsonRpcConnectorError,
response::{
GetBalanceResponse, GetBlockResponse, GetBlockchainInfoResponse, GetInfoResponse,
GetSubtreesResponse, GetTransactionResponse, GetTreestateResponse, GetUtxosResponse,
SendTransactionResponse, TxidsResponse,
},
};
#[derive(Serialize, Deserialize, Debug)]
struct RpcRequest<T> {
jsonrpc: String,
method: String,
params: T,
id: i32,
}
#[derive(Serialize, Deserialize, Debug)]
struct RpcResponse<T> {
id: i32,
jsonrpc: Option<String>,
result: T,
error: Option<RpcError>,
}
#[derive(Serialize, Deserialize, Debug)]
struct RpcError {
code: i32,
message: String,
data: Option<Value>,
}
/// JsonRPC Client config data.
#[derive(Debug)]
pub struct JsonRpcConnector {
url: Url,
id_counter: AtomicI32,
user: Option<String>,
password: Option<String>,
}
impl JsonRpcConnector {
/// Returns a new JsonRpcConnector instance, tests uri and returns error if connection is not established.
pub async fn new(
uri: Uri,
user: Option<String>,
password: Option<String>,
) -> Result<Self, JsonRpcConnectorError> {
let url = reqwest::Url::parse(&uri.to_string())?;
Ok(Self {
url,
id_counter: AtomicI32::new(0),
user,
password,
})
}
/// Returns the http::uri the JsonRpcConnector is configured to send requests to.
pub fn uri(&self) -> Result<Uri, JsonRpcConnectorError> {
Ok(self.url.as_str().parse()?)
}
/// Returns the reqwest::url the JsonRpcConnector is configured to send requests to.
pub fn url(&self) -> Url {
self.url.clone()
}
/// Sends a jsonRPC request and returns the response.
///
/// TODO: This function currently resends the call up to 5 times on a server response of "Work queue depth exceeded".
/// This is because the node's queue can become overloaded and stop servicing RPCs.
/// This functionality is weak and should be incorporated in Zaino's queue mechanism [WIP] that handles various errors appropriately.
async fn send_request<T: Serialize, R: for<'de> Deserialize<'de>>(
&self,
method: &str,
params: T,
) -> Result<R, JsonRpcConnectorError> {
let id = self.id_counter.fetch_add(1, Ordering::SeqCst);
let req = RpcRequest {
jsonrpc: "2.0".to_string(),
method: method.to_string(),
params,
id,
};
let max_attempts = 5;
let mut attempts = 0;
loop {
attempts += 1;
let client = Client::builder()
.connect_timeout(std::time::Duration::from_secs(2))
.timeout(std::time::Duration::from_secs(5))
.redirect(reqwest::redirect::Policy::none())
.build()?;
let mut request_builder = client
.post(self.url.clone())
.header("Content-Type", "application/json");
if let (Some(user), Some(password)) = (&self.user, &self.password) {
request_builder = request_builder.basic_auth(user.clone(), Some(password.clone()));
}
let request_body =
serde_json::to_string(&req).map_err(JsonRpcConnectorError::SerdeJsonError)?;
let response = request_builder
.body(request_body)
.send()
.await
.map_err(JsonRpcConnectorError::ReqwestError)?;
let status = response.status();
let body_bytes = response
.bytes()
.await
.map_err(JsonRpcConnectorError::ReqwestError)?;
let body_str = String::from_utf8_lossy(&body_bytes);
if body_str.contains("Work queue depth exceeded") {
if attempts >= max_attempts {
return Err(JsonRpcConnectorError::new(
"Error: The node's rpc queue depth was exceeded after multiple attempts",
));
}
tokio::time::sleep(std::time::Duration::from_millis(500)).await;
continue;
}
if !status.is_success() {
return Err(JsonRpcConnectorError::new(format!(
"Error: Error status from node's rpc server: {}, {}",
status, body_str
)));
}
let response: RpcResponse<R> = serde_json::from_slice(&body_bytes)
.map_err(JsonRpcConnectorError::SerdeJsonError)?;
return match response.error {
Some(error) => Err(JsonRpcConnectorError::new(format!(
"Error: Error from node's rpc server: {} - {}",
error.code, error.message
))),
None => Ok(response.result),
};
}
}
/// Returns software information from the RPC server, as a [`GetInfo`] JSON struct.
///
/// zcashd reference: [`getinfo`](https://zcash.github.io/rpc/getinfo.html)
/// method: post
/// tags: control
pub async fn get_info(&self) -> Result<GetInfoResponse, JsonRpcConnectorError> {
self.send_request::<(), GetInfoResponse>("getinfo", ())
.await
}
/// Returns blockchain state information, as a [`GetBlockChainInfo`] JSON struct.
///
/// zcashd reference: [`getblockchaininfo`](https://zcash.github.io/rpc/getblockchaininfo.html)
/// method: post
/// tags: blockchain
pub async fn get_blockchain_info(
&self,
) -> Result<GetBlockchainInfoResponse, JsonRpcConnectorError> {
self.send_request::<(), GetBlockchainInfoResponse>("getblockchaininfo", ())
.await
}
/// Returns the total balance of a provided `addresses` in an [`AddressBalance`] instance.
///
/// zcashd reference: [`getaddressbalance`](https://zcash.github.io/rpc/getaddressbalance.html)
/// method: post
/// tags: address
///
/// # Parameters
///
/// - `address_strings`: (object, example={"addresses": ["tmYXBYJj1K7vhejSec5osXK2QsGa5MTisUQ"]}) A JSON map with a single entry
/// - `addresses`: (array of strings) A list of base-58 encoded addresses.
pub async fn get_address_balance(
&self,
addresses: Vec<String>,
) -> Result<GetBalanceResponse, JsonRpcConnectorError> {
let params = vec![serde_json::json!({ "addresses": addresses })];
self.send_request("getaddressbalance", params).await
}
/// Sends the raw bytes of a signed transaction to the local node's mempool, if the transaction is valid.
/// Returns the [`SentTransactionHash`] for the transaction, as a JSON string.
///
/// zcashd reference: [`sendrawtransaction`](https://zcash.github.io/rpc/sendrawtransaction.html)
/// method: post
/// tags: transaction
///
/// # Parameters
///
/// - `raw_transaction_hex`: (string, required, example="signedhex") The hex-encoded raw transaction bytes.
pub async fn send_raw_transaction(
&self,
raw_transaction_hex: String,
) -> Result<SendTransactionResponse, JsonRpcConnectorError> {
let params = vec![serde_json::to_value(raw_transaction_hex)?];
self.send_request("sendrawtransaction", params).await
}
/// Returns the requested block by hash or height, as a [`GetBlock`] JSON string.
/// If the block is not in Zebra's state, returns
/// [error code `-8`.](https://github.com/zcash/zcash/issues/5758)
///
/// zcashd reference: [`getblock`](https://zcash.github.io/rpc/getblock.html)
/// method: post
/// tags: blockchain
///
/// # Parameters
///
/// - `hash_or_height`: (string, required, example="1") The hash or height for the block to be returned.
/// - `verbosity`: (number, optional, default=1, example=1) 0 for hex encoded data, 1 for a json object, and 2 for json object with transaction data.
pub async fn get_block(
&self,
hash_or_height: String,
verbosity: Option<u8>,
) -> Result<GetBlockResponse, JsonRpcConnectorError> {
let params = match verbosity {
Some(v) => vec![
serde_json::to_value(hash_or_height)?,
serde_json::to_value(v)?,
],
None => vec![
serde_json::to_value(hash_or_height)?,
serde_json::to_value(1)?,
],
};
self.send_request("getblock", params).await
}
/// Returns all transaction ids in the memory pool, as a JSON array.
///
/// zcashd reference: [`getrawmempool`](https://zcash.github.io/rpc/getrawmempool.html)
/// method: post
/// tags: blockchain
pub async fn get_raw_mempool(&self) -> Result<TxidsResponse, JsonRpcConnectorError> {
self.send_request::<(), TxidsResponse>("getrawmempool", ())
.await
}
/// Returns information about the given block's Sapling & Orchard tree state.
///
/// zcashd reference: [`z_gettreestate`](https://zcash.github.io/rpc/z_gettreestate.html)
/// method: post
/// tags: blockchain
///
/// # Parameters
///
/// - `hash | height`: (string, required, example="00000000febc373a1da2bd9f887b105ad79ddc26ac26c2b28652d64e5207c5b5") The block hash or height.
pub async fn get_treestate(
&self,
hash_or_height: String,
) -> Result<GetTreestateResponse, JsonRpcConnectorError> {
let params = vec![serde_json::to_value(hash_or_height)?];
self.send_request("z_gettreestate", params).await
}
/// Returns information about a range of Sapling or Orchard subtrees.
///
/// zcashd reference: [`z_getsubtreesbyindex`](https://zcash.github.io/rpc/z_getsubtreesbyindex.html) - TODO: fix link
/// method: post
/// tags: blockchain
///
/// # Parameters
///
/// - `pool`: (string, required) The pool from which subtrees should be returned. Either "sapling" or "orchard".
/// - `start_index`: (number, required) The index of the first 2^16-leaf subtree to return.
/// - `limit`: (number, optional) The maximum number of subtree values to return.
pub async fn get_subtrees_by_index(
&self,
pool: String,
start_index: u16,
limit: Option<u16>,
) -> Result<GetSubtreesResponse, JsonRpcConnectorError> {
let params = match limit {
Some(v) => vec![
serde_json::to_value(pool)?,
serde_json::to_value(start_index)?,
serde_json::to_value(v)?,
],
None => vec![
serde_json::to_value(pool)?,
serde_json::to_value(start_index)?,
],
};
self.send_request("z_getsubtreesbyindex", params).await
}
/// Returns the raw transaction data, as a [`GetRawTransaction`] JSON string or structure.
///
/// zcashd reference: [`getrawtransaction`](https://zcash.github.io/rpc/getrawtransaction.html)
/// method: post
/// tags: transaction
///
/// # Parameters
///
/// - `txid`: (string, required, example="mytxid") The transaction ID of the transaction to be returned.
/// - `verbose`: (number, optional, default=0, example=1) If 0, return a string of hex-encoded data, otherwise return a JSON object.
pub async fn get_raw_transaction(
&self,
txid_hex: String,
verbose: Option<u8>,
) -> Result<GetTransactionResponse, JsonRpcConnectorError> {
let params = match verbose {
Some(v) => vec![serde_json::to_value(txid_hex)?, serde_json::to_value(v)?],
None => vec![serde_json::to_value(txid_hex)?, serde_json::to_value(0)?],
};
self.send_request("getrawtransaction", params).await
}
/// Returns the transaction ids made by the provided transparent addresses.
///
/// zcashd reference: [`getaddresstxids`](https://zcash.github.io/rpc/getaddresstxids.html)
/// method: post
/// tags: address
///
/// # Parameters
///
/// - `request`: (object, required, example={\"addresses\": [\"tmYXBYJj1K7vhejSec5osXK2QsGa5MTisUQ\"], \"start\": 1000, \"end\": 2000}) A struct with the following named fields:
/// - `addresses`: (json array of string, required) The addresses to get transactions from.
/// - `start`: (numeric, required) The lower height to start looking for transactions (inclusive).
/// - `end`: (numeric, required) The top height to stop looking for transactions (inclusive).
pub async fn get_address_txids(
&self,
addresses: Vec<String>,
start: u32,
end: u32,
) -> Result<TxidsResponse, JsonRpcConnectorError> {
let params = serde_json::json!({
"addresses": addresses,
"start": start,
"end": end
});
self.send_request("getaddresstxids", vec![params]).await
}
/// Returns all unspent outputs for a list of addresses.
///
/// zcashd reference: [`getaddressutxos`](https://zcash.github.io/rpc/getaddressutxos.html)
/// method: post
/// tags: address
///
/// # Parameters
///
/// - `addresses`: (array, required, example={\"addresses\": [\"tmYXBYJj1K7vhejSec5osXK2QsGa5MTisUQ\"]}) The addresses to get outputs from.
pub async fn get_address_utxos(
&self,
addresses: Vec<String>,
) -> Result<Vec<GetUtxosResponse>, JsonRpcConnectorError> {
let params = vec![serde_json::json!({ "addresses": addresses })];
self.send_request("getaddressutxos", params).await
}
}
/// Tests connection with zebrad / zebrad.
async fn test_node_connection(
url: Url,
user: Option<String>,
password: Option<String>,
) -> Result<(), JsonRpcConnectorError> {
let client = Client::builder()
.connect_timeout(std::time::Duration::from_secs(2))
.timeout(std::time::Duration::from_secs(5))
.redirect(reqwest::redirect::Policy::none())
.build()?;
let user = user.unwrap_or_else(|| "xxxxxx".to_string());
let password = password.unwrap_or_else(|| "xxxxxx".to_string());
let request_body = r#"{"jsonrpc":"2.0","method":"getinfo","params":[],"id":1}"#;
let mut request_builder = client
.post(url.clone())
.header("Content-Type", "application/json")
.body(request_body);
request_builder = request_builder.basic_auth(user, Some(password)); // Used basic_auth method
let response = request_builder
.send()
.await
.map_err(JsonRpcConnectorError::ReqwestError)?;
let body_bytes = response
.bytes()
.await
.map_err(JsonRpcConnectorError::ReqwestError)?;
let _response: RpcResponse<serde_json::Value> =
serde_json::from_slice(&body_bytes).map_err(JsonRpcConnectorError::SerdeJsonError)?;
Ok(())
}
/// Tries to connect to zebrad/zcashd using IPv4 and IPv6 and returns the correct uri type, exits program with error message if connection cannot be established.
pub async fn test_node_and_return_uri(
port: &u16,
user: Option<String>,
password: Option<String>,
) -> Result<Uri, JsonRpcConnectorError> {
let ipv4_uri: Url = format!("http://127.0.0.1:{}", port).parse()?;
let ipv6_uri: Url = format!("http://[::1]:{}", port).parse()?;
let mut interval = tokio::time::interval(tokio::time::Duration::from_millis(500));
for _ in 0..3 {
match test_node_connection(ipv4_uri.clone(), user.clone(), password.clone()).await {
Ok(_) => {
println!("Connected to node using IPv4 at address {}.", ipv4_uri);
return Ok(ipv4_uri.as_str().parse()?);
}
Err(_e_ipv4) => {
match test_node_connection(ipv6_uri.clone(), user.clone(), password.clone()).await {
Ok(_) => {
println!("Connected to node using IPv6 at address {}.", ipv6_uri);
return Ok(ipv6_uri.as_str().parse()?);
}
Err(_e_ipv6) => {
tokio::time::sleep(std::time::Duration::from_secs(3)).await;
}
}
}
}
interval.tick().await;
}
eprintln!("Error: Could not establish connection with node. \nPlease check config and confirm node is listening at the correct address and the correct authorisation details have been entered. \nExiting..");
std::process::exit(1);
}