Merge pull request #131 from shesek/202008-getnettotals

Implement RpcApi::get_net_totals()

Author: stevenroose

client/src/client.rs

@@ -991,6 +991,12 @@ pub trait RpcApi: Sized {
         Ok((res.start_height, res.stop_height))
     }
 
+    /// Returns information about network traffic, including bytes in, bytes out,
+    /// and current time.
+    fn get_net_totals(&self) -> Result<json::GetNetTotalsResult> {
+        self.call("getnettotals", &[])
+    }
+
     /// Returns the estimated network hashes per second based on the last n blocks.
     fn get_network_hash_ps(&self, nblocks: Option<u64>, height: Option<u64>) -> Result<f64> {
         let mut args = [opt_into_json(nblocks)?, opt_into_json(height)?];

integration_test/src/main.rs

@@ -147,6 +147,7 @@ fn main() {
     test_get_peer_info(&cl);
     test_rescan_blockchain(&cl);
     test_create_wallet(&cl);
+    test_get_net_totals(&cl);
     test_get_network_hash_ps(&cl);
     test_uptime(&cl);
     //TODO import_multi(
@@ -899,6 +900,10 @@ fn test_create_wallet(cl: &Client) {
     assert!(wallet_list.iter().zip(wallet_names).all(|(a, b)| a == b));
 }
 
+fn test_get_net_totals(cl: &Client) {
+    cl.get_net_totals().unwrap();
+}
+
 fn test_get_network_hash_ps(cl: &Client) {
     cl.get_network_hash_ps(None, None).unwrap();
 }

json/src/lib.rs

@@ -1180,6 +1180,39 @@ pub struct SignRawTransactionInput {
     pub amount: Option<Amount>,
 }
 
+#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
+pub struct GetNetTotalsResult {
+    /// Total bytes received
+    #[serde(rename = "totalbytesrecv")]
+    pub total_bytes_recv: u64,
+    /// Total bytes sent
+    #[serde(rename = "totalbytessent")]
+    pub total_bytes_sent: u64,
+    /// Current UNIX time in milliseconds
+    #[serde(rename = "timemillis")]
+    pub time_millis: u64,
+    /// Upload target statistics
+    #[serde(rename = "uploadtarget")]
+    pub upload_target: GetNetTotalsResultUploadTarget,
+}
+
+#[derive(Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
+pub struct GetNetTotalsResultUploadTarget {
+    /// Length of the measuring timeframe in seconds
+    #[serde(rename = "timeframe")]
+    pub time_frame: u64,
+    /// Target in bytes
+    pub target: u64,
+    /// True if target is reached
+    pub target_reached: bool,
+    /// True if serving historical blocks
+    pub serve_historical_blocks: bool,
+    /// Bytes left in current time cycle
+    pub bytes_left_in_cycle: u64,
+    /// Seconds left in current time cycle
+    pub time_left_in_cycle: u64,
+}
+
 /// Used to represent an address type.
 #[derive(Copy, Serialize, Deserialize, Clone, PartialEq, Eq, Debug)]
 #[serde(rename_all = "kebab-case")]