clarity 1.7.0

Lightweight Ethereum client
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use std::fmt;
use std::num::ParseIntError;
use std::str::Utf8Error;

use num256::Uint256;

/// Custom error implementation that describes possible
/// error states.
///
/// This is shared by a whole crate.
#[derive(Debug)]
pub enum Error {
    InvalidNetworkId,
    InvalidV,
    InvalidR,
    InvalidS,
    InvalidSignatureValues,
    ZeroPrivKey,
    InvalidPrivKeyLength {
        got: usize,
        expected: usize,
    },
    DecodePrivKey(secp256k1::Error),
    DecodeRecoveryId(secp256k1::Error),
    ParseMessage(secp256k1::Error),
    ParseRecoverableSignature(secp256k1::Error),
    RecoverSignature(secp256k1::Error),
    InvalidAddressLength {
        got: usize,
        expected: usize,
    },
    InvalidUtf8(Utf8Error),
    InvalidHex(ParseIntError),
    InvalidEip55,
    InvalidCallError(String),
    InvalidSignatureLength,
    SerializeRlp,
    DeserializeRlp,
    NoSignature,
    UnknownTxType(Uint256),
    AbiInputTooShort {
        expected: usize,
        actual: usize,
    },
    AddressParseError,
    IntegerParseError,
    NonceTooLarge,
    GasCostOverflow,
    MaxPriorityFeeExceedsMaxFee,
    ZeroMaxPriorityFee,
    GasLimitTooLow {
        gas_limit: Uint256,
        intrinsic_gas: Uint256,
    },
    GasLimitTooHigh,
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::InvalidNetworkId => write!(f, "Invalid network id"),
            Error::InvalidV => write!(f, "Invalid V value"),
            Error::InvalidR => write!(f, "Invalid R value"),
            Error::InvalidS => write!(f, "Invalid S value"),
            Error::InvalidSignatureValues => write!(f, "Invalid signature values"),
            Error::ZeroPrivKey => write!(f, "Zero priv key cannot sign"),
            Error::InvalidPrivKeyLength { got, expected } => write!(
                f,
                "Invalid private key length, got {got} expected {expected}"
            ),
            Error::DecodePrivKey(_) => write!(f, "Failed to decode private key"),
            Error::DecodeRecoveryId(_) => write!(f, "Failed to decode recovery id"),
            Error::ParseMessage(_) => write!(f, "Failed to parse message"),
            Error::ParseRecoverableSignature(_) => {
                write!(f, "Failed to parse recoverable signature")
            }
            Error::RecoverSignature(_) => write!(f, "Failed to recover signature"),
            Error::InvalidAddressLength { got, expected } => {
                write!(f, "Invalid address length, got {got}, expected {expected}")
            }
            Error::InvalidUtf8(_) => write!(f, "Failed to parse bytes as utf8"),
            Error::InvalidHex(_) => write!(f, "Invalid hex character"),
            Error::InvalidEip55 => write!(f, "Invalid EIP-55 Address encoding"),
            Error::InvalidCallError(val) => write!(f, "Invalid function call {val}"),
            Error::InvalidSignatureLength => write!(f, "Signature should be exactly 65 bytes long"),
            Error::SerializeRlp => write!(f, "failed to serialize using RLP-encoding"),
            Error::DeserializeRlp => write!(f, "failed to deserialize using RLP-encoding"),
            Error::NoSignature => write!(f, "This transaction does not have a signature attached"),
            Error::UnknownTxType(t) => write!(f, "Unsupported Ethereum transaction type {}", t),
            Error::AbiInputTooShort {
                expected,
                actual: got,
            } => write!(
                f,
                "ABI input too short, expected at least {expected} bytes, got {got} bytes"
            ),
            Error::AddressParseError => write!(f, "Failed to parse address"),
            Error::IntegerParseError => write!(f, "Failed to parse integer"),
            Error::NonceTooLarge => write!(f, "Nonce must be less than 2^64 - 1"),
            Error::GasCostOverflow => write!(
                f,
                "Gas cost overflow: gas_limit * gas_price exceeds maximum"
            ),
            Error::MaxPriorityFeeExceedsMaxFee => {
                write!(f, "max_priority_fee_per_gas exceeds max_fee_per_gas")
            }
            Error::ZeroMaxPriorityFee => write!(f, "max_priority_fee_per_gas must be non-zero"),
            Error::GasLimitTooLow {
                gas_limit,
                intrinsic_gas,
            } => write!(
                f,
                "Gas limit {gas_limit} is below intrinsic gas {intrinsic_gas}"
            ),
            Error::GasLimitTooHigh => write!(f, "Gas limit exceeds 2^64 - 1"),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Error::DecodePrivKey(inner) => Some(inner),
            Error::DecodeRecoveryId(inner) => Some(inner),
            Error::ParseMessage(inner) => Some(inner),
            Error::ParseRecoverableSignature(inner) => Some(inner),
            Error::RecoverSignature(inner) => Some(inner),
            Error::InvalidHex(inner) => Some(inner),
            Error::InvalidUtf8(inner) => Some(inner),
            _ => None,
        }
    }
}

impl From<Utf8Error> for Error {
    fn from(e: Utf8Error) -> Self {
        Error::InvalidUtf8(e)
    }
}

impl From<ParseIntError> for Error {
    fn from(e: ParseIntError) -> Self {
        Error::InvalidHex(e)
    }
}