matroskin 0.1.0

whatsminer api client lib
Documentation 
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

//! Implement `set.miner.restore_setting` command
//!
//! Restores the miner's settings to their factory defaults.
//!
//! - Command: [SetMinerRestoreSetting]
//! - ApiDoc: <https://apidoc.whatsminer.com/#api-Miner-btminer_restore_setting>
use core::str;

use crate::{
    command::{Command, CommandLevel},
    error::Result,
    permission::PermissionLevel,
};

/// This command represents the `set.miner.restore_setting` operation.
///
/// Restores the miner's settings to their factory defaults.
///
/// - ApiDoc: <https://apidoc.whatsminer.com/#api-Miner-btminer_restore_setting>
///
/// # Example
/// ```rust,no_run
/// use matroskin::actor::Actor;
/// use matroskin::account::Account;
/// use matroskin::password::Password;
/// use matroskin::command::set_miner_restore_setting::SetMinerRestoreSetting;
///
/// #[tokio::main]
/// async fn main() -> Result<(), Box<dyn std::error::Error>> {
///     let actor = Actor::new("10.10.10.10:4433", Account::Super, Password::Super);
///     actor.connect()?;
///
///     let cmd = SetMinerRestoreSetting;
///     let response = actor.send(cmd).await?;
///     println!("Response: {:#?}", response);
///
///     Ok(())
/// }
/// ```
#[derive(Debug, Default)]
pub struct SetMinerRestoreSetting;

impl Command for SetMinerRestoreSetting {
    type Response = String;
    const CMD_NAME: &'static str = "set.miner.restore_setting";
    const LEVEL: CommandLevel = CommandLevel::Secured;
    const MINIMAL_PERMISSIONS: PermissionLevel = PermissionLevel::ReadWrite;

    fn params(&self) -> Result<Option<impl serde::Serialize>> {
        Ok(None::<()>)
    }
}

#[cfg(test)]
mod tests {
    use crate::account::Account;
    use crate::auth_data::AuthData;

    use super::*;

    const RESPONSE_JSON: &str =
        r#"{"code":0,"when":1692685496,"msg":"ok","desc":"set.miner.restore_setting"}"#;

    #[test]
    fn request_is_secured_without_params() {
        let cmd = SetMinerRestoreSetting;
        assert!(cmd.is_secured());
        assert!(!cmd.is_encrypted());

        let auth = AuthData::new::<SetMinerRestoreSetting>(Account::Super, "pass", "salt").unwrap();
        let encoded = cmd.encode(Some(auth)).unwrap();
        let json: serde_json::Value = serde_json::from_slice(&encoded.0).unwrap();

        assert_eq!(json["cmd"], "set.miner.restore_setting");
        assert_eq!(json["account"], "super");
        assert!(json["ts"].as_u64().unwrap() > 0);
        assert_eq!(json["token"].as_str().unwrap().len(), 8);
        assert!(json.get("param").is_none());
    }

    #[test]
    fn request_without_auth_returns_no_token() {
        let cmd = SetMinerRestoreSetting;
        let encoded = cmd.encode(None).unwrap();
        let json: serde_json::Value = serde_json::from_slice(&encoded.0).unwrap();
        assert!(json.get("token").is_none());
        assert!(json.get("param").is_none());
    }

    #[test]
    fn deserialize_response_fixture() {
        let response = SetMinerRestoreSetting::parse_response(RESPONSE_JSON.as_bytes()).unwrap();
        assert!(response.code.is_success());
        assert_eq!(response.desc, "set.miner.restore_setting");
        assert_eq!(response.when, 1692685496);
        assert_eq!(response.msg, "ok");
    }
}