hwi 0.5.0

Rust wrapper for the Bitcoin Core Hardware Wallet Interface.
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

use std::convert::TryFrom;
use std::fmt;

#[derive(Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
pub enum ErrorCode {
    NoDeviceType = 1,
    MissingArguments = 2,
    DeviceConnError = 3,
    UnknownDeviceType = 4,
    InvalidTx = 5,
    NoPassword = 6,
    BadArgument = 7,
    NotImplemented = 8,
    UnavailableAction = 9,
    DeviceAlreadyInit = 10,
    DeviceAlreadyUnlocked = 11,
    DeviceNotReady = 12,
    UnknownError = 13,
    ActionCanceled = 14,
    DeviceBusy = 15,
    NeedToBeRoot = 16,
    HelpText = 17,
    DeviceNotInitialized = 18,
}

impl ErrorCode {
    pub fn as_u8(&self) -> u8 {
        *self as u8
    }

    pub fn as_i8(&self) -> i8 {
        -(*self as i8)
    }
}

impl TryFrom<i8> for ErrorCode {
    type Error = Error;
    fn try_from(code: i8) -> Result<Self, Error> {
        match code {
            -1 => Ok(Self::NoDeviceType),
            -2 => Ok(Self::MissingArguments),
            -3 => Ok(Self::DeviceConnError),
            -4 => Ok(Self::UnknownDeviceType),
            -5 => Ok(Self::InvalidTx),
            -6 => Ok(Self::NoPassword),
            -7 => Ok(Self::BadArgument),
            -8 => Ok(Self::NotImplemented),
            -9 => Ok(Self::UnavailableAction),
            -10 => Ok(Self::DeviceAlreadyInit),
            -11 => Ok(Self::DeviceAlreadyUnlocked),
            -12 => Ok(Self::DeviceNotReady),
            -13 => Ok(Self::UnknownError),
            -14 => Ok(Self::ActionCanceled),
            -15 => Ok(Self::DeviceBusy),
            -16 => Ok(Self::NeedToBeRoot),
            -17 => Ok(Self::HelpText),
            -18 => Ok(Self::DeviceNotInitialized),
            _ => Err(Error::HWIError("Invalid error code".to_string(), None)),
        }
    }
}

impl fmt::Debug for ErrorCode {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.as_i8())
    }
}

#[derive(Debug, PartialEq, Eq, Clone)]
pub enum Error {
    JSON(String),
    Utf8(String),
    IOError(String),
    InvalidOption(String),
    HWIError(String, Option<ErrorCode>),
    PyErr(String),
}

macro_rules! impl_error {
    ( $from:ty, $to:ident ) => {
        impl std::convert::From<$from> for Error {
            fn from(err: $from) -> Self {
                Error::$to(err.to_string())
            }
        }
    };
}

impl_error!(serde_json::Error, JSON);
impl_error!(std::str::Utf8Error, Utf8);
impl_error!(std::io::Error, IOError);
impl_error!(pyo3::prelude::PyErr, PyErr);

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{:?}", self)
    }
}

impl std::error::Error for Error {}