bsv-primitives 0.2.0

BSV Blockchain SDK - Cryptographic primitives, hashing, and utilities
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
106
107
108
109

/// Unified error type for all primitives operations.
///
/// Covers errors from hashing, EC operations, encryption, encoding, and key management.
#[derive(Debug, thiserror::Error)]
pub enum PrimitivesError {
    /// Invalid private key data.
    #[error("invalid private key: {0}")]
    InvalidPrivateKey(String),

    /// Invalid public key data.
    #[error("invalid public key: {0}")]
    InvalidPublicKey(String),

    /// Invalid signature data.
    #[error("invalid signature: {0}")]
    InvalidSignature(String),

    /// Malformed WIF-encoded key.
    #[error("invalid WIF format: {0}")]
    InvalidWif(String),

    /// Base58Check checksum did not match.
    #[error("checksum mismatch")]
    ChecksumMismatch,

    /// EC point is not on the secp256k1 curve.
    #[error("point not on curve")]
    PointNotOnCurve,

    /// Key length does not match the expected size.
    #[error("invalid key length: expected {expected}, got {got}")]
    InvalidKeyLength {
        /// Expected length in bytes.
        expected: usize,
        /// Actual length in bytes.
        got: usize,
    },

    /// AES-GCM encryption failed.
    #[error("encryption error: {0}")]
    EncryptionError(String),

    /// AES-GCM decryption or authentication failed.
    #[error("decryption error: {0}")]
    DecryptionError(String),

    /// Invalid hexadecimal string.
    #[error("invalid hex: {0}")]
    InvalidHex(String),

    /// Invalid hash value.
    #[error("invalid hash: {0}")]
    InvalidHash(String),

    /// Invalid Base58 encoding.
    #[error("invalid base58: {0}")]
    InvalidBase58(String),

    /// Not enough Shamir shares to reconstruct the secret.
    #[error("insufficient shares for recovery: need {threshold}, got {got}")]
    InsufficientShares {
        /// Minimum shares required.
        threshold: usize,
        /// Shares actually provided.
        got: usize,
    },

    /// Shamir threshold value is invalid.
    #[error("invalid threshold: {0}")]
    InvalidThreshold(String),

    /// Duplicate Shamir share index.
    #[error("duplicate share detected")]
    DuplicateShare,

    /// Variable-length integer exceeds maximum size.
    #[error("varint too large")]
    VarIntTooLarge,

    /// Unexpected end of input data.
    #[error("unexpected end of data")]
    UnexpectedEof,

    /// Hex decoding error.
    #[error("hex decode error: {0}")]
    HexDecode(#[from] hex::FromHexError),

    /// Elliptic curve error (from k256).
    #[error("elliptic curve error: {0}")]
    EllipticCurve(#[from] k256::elliptic_curve::Error),

    /// ECDSA signature error (from k256/signature).
    #[error("ecdsa error: {0}")]
    Ecdsa(#[from] k256::ecdsa::signature::Error),

    /// AEAD (AES-GCM) error.
    #[error("aead error")]
    Aead,

    /// Catch-all error.
    #[error("{0}")]
    Other(String),
}

impl From<aes_gcm::Error> for PrimitivesError {
    fn from(_: aes_gcm::Error) -> Self {
        PrimitivesError::Aead
    }
}