kobe-btc 0.5.2

Bitcoin wallet for Kobe
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

//! Error types for Bitcoin wallet operations.
//!
//! This module defines all errors that can occur during Bitcoin
//! wallet creation, key derivation, and address generation.

#[cfg(feature = "alloc")]
use alloc::string::String;
use core::fmt;

/// Errors that can occur during Bitcoin wallet operations.
#[derive(Debug)]
#[non_exhaustive]
pub enum Error {
    /// Invalid mnemonic phrase.
    Mnemonic(bip39::Error),
    /// BIP32 derivation error.
    Bip32(bitcoin::bip32::Error),
    /// Invalid word count for mnemonic.
    InvalidWordCount(usize),
    /// Invalid derivation path.
    #[cfg(feature = "alloc")]
    InvalidDerivationPath(String),
    /// Invalid WIF (Wallet Import Format) private key.
    InvalidWif,
    /// Invalid hex string.
    InvalidHex,
    /// Invalid private key.
    InvalidPrivateKey,
    /// Secp256k1 error.
    Secp256k1(bitcoin::secp256k1::Error),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Self::Mnemonic(e) => write!(f, "mnemonic error: {e}"),
            Self::Bip32(e) => write!(f, "BIP32 derivation error: {e}"),
            Self::InvalidWordCount(n) => {
                write!(f, "invalid word count {n}, must be 12, 15, 18, 21, or 24")
            }
            #[cfg(feature = "alloc")]
            Self::InvalidDerivationPath(p) => write!(f, "invalid derivation path: {p}"),
            Self::InvalidWif => write!(f, "invalid WIF format"),
            Self::InvalidHex => write!(f, "invalid hex string"),
            Self::InvalidPrivateKey => write!(f, "invalid private key"),
            Self::Secp256k1(e) => write!(f, "secp256k1 error: {e}"),
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::Mnemonic(e) => Some(e),
            Self::Bip32(e) => Some(e),
            Self::Secp256k1(e) => Some(e),
            Self::InvalidWordCount(_)
            | Self::InvalidWif
            | Self::InvalidHex
            | Self::InvalidPrivateKey => None,
            #[cfg(feature = "alloc")]
            Self::InvalidDerivationPath(_) => None,
        }
    }
}

impl From<bip39::Error> for Error {
    fn from(err: bip39::Error) -> Self {
        Self::Mnemonic(err)
    }
}

impl From<bitcoin::bip32::Error> for Error {
    fn from(err: bitcoin::bip32::Error) -> Self {
        Self::Bip32(err)
    }
}

impl From<bitcoin::secp256k1::Error> for Error {
    fn from(err: bitcoin::secp256k1::Error) -> Self {
        Self::Secp256k1(err)
    }
}