Merge #74: Add raw_call to ElectrumApi

3d96644 Add raw_call to ElectrumApi (Zoe Faltibà)

Pull request description:

  In order to give more flexibility to the users of this library I added a `raw_call` method to the `ElectrumApi` trait that will allow to call any arbitrary electrum API call.

ACKs for top commit:
  afilini:
    ACK 3d96644

Tree-SHA512: b88ece7bd9ff8121272c3b3528430e9ccb8778661b15cce276c6f67a8797a4dbf4c52a8521191942c21e8b67ebde8187fd75ac49189440b0fbb71274974b4b41

Author: afilini

src/api.rs

@@ -65,6 +65,9 @@ pub trait ElectrumApi {
         self.transaction_broadcast_raw(&buffer)
     }
 
+    /// Executes the requested API call returning the raw answer.
+    fn raw_call(&self, call: &Call) -> Result<serde_json::Value, Error>;
+
     /// Execute a queue of calls stored in a [`Batch`](../batch/struct.Batch.html) struct. Returns
     /// `Ok()` **only if** all of the calls are successful. The order of the JSON `Value`s returned
     /// reflects the order in which the calls were made on the `Batch` struct.

src/batch.rs

@@ -5,7 +5,7 @@
 use bitcoin::hashes::hex::ToHex;
 use bitcoin::{Script, Txid};
 
-use types::{Param, ToElectrumScriptHash};
+use types::{Call, Param, ToElectrumScriptHash};
 
 /// Helper structure that caches all the requests before they are actually sent to the server.
 ///
@@ -18,7 +18,7 @@ use types::{Param, ToElectrumScriptHash};
 /// [`batch_script_get_balance`](../client/struct.Client.html#method.batch_script_get_balance) to ask the
 /// server for the balance of multiple scripts with a single request.
 pub struct Batch {
-    calls: Vec<(String, Vec<Param>)>,
+    calls: Vec<Call>,
 }
 
 impl Batch {

src/client.rs

@@ -160,6 +160,11 @@ impl Client {
 }
 
 impl ElectrumApi for Client {
+    #[inline]
+    fn raw_call(&self, call: &Call) -> Result<serde_json::Value, Error> {
+        impl_inner_call!(self, raw_call, call)
+    }
+
     #[inline]
     fn batch_call(&self, batch: &Batch) -> Result<Vec<serde_json::Value>, Error> {
         impl_inner_call!(self, batch_call, batch)

src/raw_client.rs

@@ -666,6 +666,17 @@ impl<S: Read + Write> RawClient<S> {
 }
 
 impl<T: Read + Write> ElectrumApi for RawClient<T> {
+    fn raw_call(&self, call: &Call) -> Result<serde_json::Value, Error> {
+        let req = Request::new_id(
+            self.last_id.fetch_add(1, Ordering::SeqCst),
+            &call.0,
+            call.1.to_vec(),
+        );
+        let result = self.call(req)?;
+
+        Ok(result)
+    }
+
     fn batch_call(&self, batch: &Batch) -> Result<Vec<serde_json::Value>, Error> {
         let mut raw = Vec::new();
 
@@ -1283,4 +1294,35 @@ mod test {
         assert!(client.transaction_broadcast_raw(&[0x00]).is_err());
         assert!(client.server_features().is_ok());
     }
+
+    #[test]
+    fn test_raw_call() {
+        use types::Param;
+
+        let client = RawClient::new(get_test_server(), None).unwrap();
+
+        let params = vec![
+            Param::String(
+                "cc2ca076fd04c2aeed6d02151c447ced3d09be6fb4d4ef36cb5ed4e7a3260566".to_string(),
+            ),
+            Param::Bool(false),
+        ];
+        let call = ("blockchain.transaction.get".to_string(), params);
+
+        let resp = client.raw_call(&call).unwrap();
+
+        assert_eq!(
+            resp,
+            "01000000000101000000000000000000000000000000000000000000000000000\
+            0000000000000ffffffff5403f09c091b4d696e656420627920416e74506f6f6c3\
+            13139ae006f20074d6528fabe6d6d2ab1948d50b3d991e2a0821df74358ed9c255\
+            3af00c7a61f97771ca0acee106e0400000000000000cbec00802461f905fffffff\
+            f0354ceac2a000000001976a91411dbe48cc6b617f9c6adaf4d9ed5f625b1c7cb5\
+            988ac0000000000000000266a24aa21a9ed2e578bce2ca6c6bc9359377345d8e98\
+            5dd5f90c78421ffa6efa5eb60428e698c0000000000000000266a24b9e11b6d2f6\
+            21d7ec3f45a5eca89d3ea6a294cdf3a042e973009584470a12916111e2caa01200\
+            000000000000000000000000000000000000000000000000000000000000000000\
+            00000"
+        )
+    }
 }

src/types.rs

@@ -17,6 +17,8 @@ use serde::{de, Deserialize, Serialize};
 
 static JSONRPC_2_0: &str = "2.0";
 
+pub type Call = (String, Vec<Param>);
+
 #[derive(Serialize, Clone)]
 #[serde(untagged)]
 /// A single parameter of a [`Request`](struct.Request.html)