matroskin 0.1.0

whatsminer api client lib
Documentation
//! Implement `set.miner.power_percent` command
//!
//! Adjusts the miner's power consumption to a percentage of its initial stable power.
//!
//! - Command: [SetMinerPowerPercent]
//! - ApiDoc: <https://apidoc.whatsminer.com/#api-Miner-btminer_set_power_percent>
use core::str;

use serde::Serialize;

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

/// This command represents the `set.miner.power_percent` operation.
///
/// Adjusts the miner's power consumption to a percentage of its initial stable power.
///
/// - ApiDoc: <https://apidoc.whatsminer.com/#api-Miner-btminer_set_power_percent>
///
/// # Example
/// ```rust,no_run
/// use matroskin::actor::Actor;
/// use matroskin::account::Account;
/// use matroskin::password::Password;
/// use matroskin::command::set_miner_power_percent::SetMinerPowerPercent;
///
/// #[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 = SetMinerPowerPercent::new(89, "fast");
///     let response = actor.send(cmd).await?;
///     println!("Response: {:#?}", response);
///
///     Ok(())
/// }
/// ```
#[derive(Debug, Serialize, Clone, PartialEq, Eq)]
#[serde(rename_all = "kebab-case")]
pub struct SetMinerPowerPercent {
    /// The desired power percentage. Range: 0-100.
    pub percent: u32,
    /// The adjustment mode. Valid values: `fast`, `normal`.
    pub mode: String,
}

impl SetMinerPowerPercent {
    /// Create a new `set.miner.power_percent` command.
    pub fn new(percent: u32, mode: impl Into<String>) -> Self {
        Self {
            percent,
            mode: mode.into(),
        }
    }
}

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

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

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

    use super::*;

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

    #[test]
    fn request_has_correct_structure() {
        let cmd = SetMinerPowerPercent::new(89, "fast");
        assert!(cmd.is_secured());
        assert!(!cmd.is_encrypted());

        let auth = AuthData::new::<SetMinerPowerPercent>(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.power_percent");
        assert_eq!(json["account"], "super");
        assert!(json["ts"].as_u64().unwrap() > 0);
        assert_eq!(json["token"].as_str().unwrap().len(), 8);
        assert_eq!(json["param"]["percent"], 89);
        assert_eq!(json["param"]["mode"], "fast");
    }

    #[test]
    fn request_without_auth_omits_token() {
        let cmd = SetMinerPowerPercent::new(50, "normal");
        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_eq!(json["param"]["percent"], 50);
        assert_eq!(json["param"]["mode"], "normal");
    }

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