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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
// SPDX-License-Identifier: Apache-2.0
use std::error::Error as StdError;
use std::result::Result as StdResult;
use crate::entity_id::Checksum;
use crate::{
AccountId,
Hbar,
Status,
TransactionId,
};
/// `Result<T, Error>`
pub type Result<T> = StdResult<T, Error>;
pub(crate) type BoxStdError = Box<dyn StdError + Send + Sync + 'static>;
/// Represents any possible error from a fallible function in the Hiero SDK.
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum Error {
/// Request timed out.
#[error("failed to complete request within the maximum time allowed; most recent attempt failed with: {0}")]
TimedOut(#[source] Box<Error>),
/// GRPC status code was an error.
#[error("grpc: {0:?}")]
GrpcStatus(#[from] tonic::Status),
/// Failed to parse an SDK type from a protobuf response.
#[error("failed to create a SDK type from a protobuf response: {0}")]
FromProtobuf(#[source] BoxStdError),
// todo: bikeshed this.
/// Freeze failed due to there being no explicitly set node account IDs and no client being provided to generate them.
#[error("freeze failed due to node account IDs being unset")]
FreezeUnsetNodeAccountIds,
/// A transaction failed pre-check.
///
/// The transaction had the ID `transaction_id`.
///
/// Caused by `status` being an error.
#[error("transaction `{transaction_id}` failed pre-check with status `{status:?}`")]
TransactionPreCheckStatus {
/// The status that caused the [`Transaction`](crate::Transaction) to fail pre-check.
status: Status,
/// The `TransactionId` of the failed [`Transaction`](crate::Transaction) .
transaction_id: Box<TransactionId>,
/// The estimated transaction fee, if the status was [`InsufficientTxFee`].
cost: Option<Hbar>,
},
/// A [`Query`](crate::Query) for `transaction_id` failed pre-check.
///
/// Caused by `status` being an error.
#[error("query for transaction `{transaction_id}` failed pre-check with status `{status:?}`")]
QueryPreCheckStatus {
/// The `Status` that caused the [`Query`](crate::Query) to fail pre-check.
status: Status,
/// The associated transaction's ID.
transaction_id: Box<TransactionId>,
},
/// A [`Query`](crate::Query) failed pre-check.
///
/// The query had an associated `PaymentTransaction` with ID `transaction_id`.
///
/// Caused by `status` being an error.
#[error(
"query with payment transaction `{transaction_id}` failed pre-check with status `{status:?}`"
)]
QueryPaymentPreCheckStatus {
/// The `Status` that caused the [`Query`](crate::Query) to fail pre-check.
status: Status,
/// The associated `PaymentTransaction`'s `TransactionId`.
transaction_id: Box<TransactionId>,
},
/// A [`Query`](crate::Query) failed pre-check.
///
/// The query had no `PaymentTransaction`.
///
/// Caused by `status` being an error.
#[error("query with no payment transaction failed pre-check with status `{status:?}`")]
QueryNoPaymentPreCheckStatus {
/// The `Status` that caused the [`Query`](crate::Query) to fail pre-check.
status: Status,
},
/// Failed to parse a basic type from string
/// (ex. [`AccountId`](crate::AccountId), [`ContractId`](crate::ContractId), [`TransactionId`](crate::TransactionId), etc.).
#[error("failed to parse: {0}")]
BasicParse(#[source] BoxStdError),
/// An entity ID had an invalid checksum
#[error("entity ID {shard}.{realm}.{num}-{present_checksum} was incorrect")]
BadEntityId {
/// The shard number
shard: u64,
/// The realm number
realm: u64,
/// The entity number
num: u64,
/// The (invalid) checksum that was present on the entity ID
present_checksum: Checksum,
/// The checksum that SHOULD HAVE BEEN on the entity ID
expected_checksum: Checksum,
},
/// An entity ID cannot be converted to a string with a checksum, because it is in an alternate form,
/// such as an `alias` or `evm_address`
#[error("an entity ID with an `alias` or `evm_address` cannot have a checksum")]
CannotCreateChecksum,
/// Failed to parse a [`PublicKey`](crate::PublicKey) or [`PrivateKey`](crate::PrivateKey).
#[error("failed to parse a key: {0}")]
KeyParse(#[source] BoxStdError),
/// Failed to derive a [`PrivateKey`](crate::PrivateKey) from another `PrivateKey`.
///
/// Examples of when this can happen (non-exhaustive):
/// - [`PrivateKey::derive`](fn@crate::PrivateKey::derive) when the `PrivateKey` doesn't have a chain code.
/// - [`PrivateKey::derive`](fn@crate::PrivateKey::derive)
/// or [`PrivateKey::legacy_derive`](fn@crate::PrivateKey::legacy_derive) on an `Ecsda` key.
#[error("Failed to derive a key: {0}")]
KeyDerive(#[source] BoxStdError),
/// Failed to parse a [`Mnemonic`](crate::Mnemonic) due to the given `reason`.
///
/// the `Mnemonic` is provided because invalid `Mnemonics`
/// can technically still provide valid [`PrivateKeys`](crate::PrivateKey).
#[cfg(feature = "mnemonic")]
#[error("failed to parse a mnemonic: {reason}")]
MnemonicParse {
/// This error's source.
#[source]
reason: MnemonicParseError,
/// The `Mnemonic` in question.
mnemonic: crate::Mnemonic,
},
/// An error occurred while attempting to convert a [`Mnemonic`](crate::Mnemonic) to a [`PrivateKey`](crate::PrivateKey)
#[cfg(feature = "mnemonic")]
#[error("failed to convert a mnemonic to entropy: {0}")]
MnemonicEntropy(#[from] MnemonicEntropyError),
/// The [`Client`](crate::Client) had no payer account (operator)
/// and the attempted request had no explicit [`TransactionId`].
#[error("client must be configured with a payer account or requests must be given an explicit transaction id")]
NoPayerAccountOrTransactionId,
/// Cost of a [`Query`](crate::Query) is more expensive than `max_query_payment`.
///
/// The actual cost of the `Query` is `query_cost`.
#[error("cost of {query_cost} without explicit payment is greater than the maximum allowed payment of {max_query_payment}")]
MaxQueryPaymentExceeded {
/// the configured maximum query payment.
max_query_payment: Hbar,
/// How much the query actually cost.
query_cost: Hbar,
},
/// The associated node account was not found in the network.
#[error("node account `{0}` was not found in the configured network")]
NodeAccountUnknown(Box<AccountId>),
/// Received an unrecognized status code from the Hiero Network.
///
/// This can happen when the SDK is outdated, try updating your SDK.
#[error("received unrecognized status code: {0}, try updating your SDK")]
ResponseStatusUnrecognized(i32),
// fixme(sr): Citation needed (unsure if this is accurate).
/// Getting the receipt for `transaction_id` failed with `status`.
#[error("receipt for transaction `{transaction_id:?}` failed with status `{status:?}`")]
ReceiptStatus {
/// The Error's status code.
status: Status,
/// The [`Transaction`](crate::Transaction)'s ID.
transaction_id: Option<Box<TransactionId>>,
},
/// Failed to verify a signature.
#[error("failed to verify a signature: {0}")]
SignatureVerify(#[source] BoxStdError),
}
impl Error {
pub(crate) fn from_protobuf<E: Into<BoxStdError>>(error: E) -> Self {
Self::FromProtobuf(error.into())
}
pub(crate) fn key_parse<E: Into<BoxStdError>>(error: E) -> Self {
Self::KeyParse(error.into())
}
pub(crate) fn key_derive<E: Into<BoxStdError>>(error: E) -> Self {
Self::KeyDerive(error.into())
}
pub(crate) fn basic_parse<E: Into<BoxStdError>>(error: E) -> Self {
Self::BasicParse(error.into())
}
pub(crate) fn signature_verify(error: impl Into<BoxStdError>) -> Self {
Self::SignatureVerify(error.into())
}
}
/// Failed to parse a mnemonic.
#[cfg(feature = "mnemonic")]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum MnemonicParseError {
/// The [`Mnemonic`](crate::Mnemonic) contains an unexpected length.
#[error("bad length: expected `12` or `24` words, found `{0}`")]
BadLength(usize),
/// The [`Mnemonic`](crate::Mnemonic) contains words that aren't in the wordlist.
#[error("unknown words at indecies: `{0:?}`")]
UnknownWords(Vec<usize>),
/// The [`Mnemonic`](crate::Mnemonic) has an invalid checksum.
#[error("checksum mismatch: expected `{expected:02x}`, found `{actual:02x}`")]
ChecksumMismatch {
/// The checksum that was expected.
expected: u8,
/// The checksum that was actually found.
actual: u8,
},
}
/// Failed to convert a [`Mnemonic`](crate::Mnemonic) to a [`PrivateKey`](crate::PrivateKey)
// todo: find a better name before release.
#[cfg(feature = "mnemonic")]
#[derive(Debug, thiserror::Error)]
#[non_exhaustive]
pub enum MnemonicEntropyError {
/// Encountered a [`Mnemonic`](crate::Mnemonic) of unexpected length.
#[error("bad length: expected `{expected}` words, found {actual} words")]
BadLength {
/// The number of words that were expected (12, 22, or 24)
expected: usize,
/// The number of words that were actually found.
actual: usize,
},
/// The [`Mnemonic`](crate::Mnemonic) has an invalid checksum.
#[error("checksum mismatch: expected `{expected:02x}`, found `{actual:02x}`")]
ChecksumMismatch {
/// The checksum that was expected.
expected: u8,
/// The checksum that was actually found.
actual: u8,
},
/// Used a passphrase with a legacy [`Mnemonic`](crate::Mnemonic).
#[error("used a passphrase with a legacy mnemonic")]
LegacyWithPassphrase,
}