lsdk 0.0.0

Rust SDK for hardware wallets speaking the BOLOS APDU protocol: HID/WebHID transport, device info, genuine check, app management, firmware updates and app signers
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
99
100
101
102
103
104
105

//! Error type used across the crate.

use crate::apdu::StatusWord;

/// Result alias using [`Error`].
pub type Result<T, E = Error> = core::result::Result<T, E>;

/// Every error the SDK can produce.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
    /// The device answered with a non-success status word.
    #[error("device returned status {0}")]
    Status(StatusWord),

    /// No device could be found.
    #[error("no device found")]
    NoDevice,

    /// The device was disconnected during an operation.
    #[error("device disconnected")]
    Disconnected,

    /// Transport level failure (HID I/O, WebHID promise rejected...).
    #[error("transport error: {0}")]
    Transport(String),

    /// The device did not answer in time.
    #[error("timeout waiting for device")]
    Timeout,

    /// HID framing error (bad channel, tag or sequence).
    #[error("framing error: {0}")]
    Framing(String),

    /// A response could not be parsed.
    #[error("invalid response: {0}")]
    InvalidResponse(String),

    /// Caller supplied invalid input.
    #[error("invalid input: {0}")]
    InvalidInput(String),

    /// The device must be on the dashboard (no app open) for this operation.
    #[error("device must be on the dashboard (close any open app)")]
    DashboardExpected,

    /// The user refused the action on the device.
    #[error("action refused on device")]
    UserRefused,

    /// The device is locked (PIN not entered).
    #[error("device is locked")]
    Locked,

    /// HTTP error when talking to the manager API.
    #[error("http error: {0}")]
    Http(String),

    /// Websocket error when talking to the HSM.
    #[error("websocket error: {0}")]
    WebSocket(String),

    /// The HSM reported an error.
    #[error("hsm error: {0}")]
    Hsm(String),

    /// Requested item was not found (app, firmware...).
    #[error("not found: {0}")]
    NotFound(String),

    /// Operation was cancelled.
    #[error("cancelled")]
    Cancelled,

    /// App specific error.
    #[error("{0}")]
    App(String),
}

impl Error {
    /// Status word carried by this error, if any.
    pub fn status(&self) -> Option<StatusWord> {
        match self {
            Error::Status(sw) => Some(*sw),
            _ => None,
        }
    }
}

impl From<StatusWord> for Error {
    fn from(sw: StatusWord) -> Self {
        match sw {
            StatusWord::LOCKED_DEVICE => Error::Locked,
            sw => Error::Status(sw),
        }
    }
}

#[cfg(any(feature = "manager-api", feature = "hsm"))]
impl From<serde_json::Error> for Error {
    fn from(e: serde_json::Error) -> Self {
        Error::InvalidResponse(e.to_string())
    }
}