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
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
use std::fmt::{self, Display};
use std::io;
use chrono::{DateTime, Utc};
use failure::{Backtrace, Context, Fail};
use log::error;
use near_primitives_v01::block::BlockValidityError;
use near_primitives_v01::challenge::{ChunkProofs, ChunkState};
use near_primitives_v01::errors::{EpochError, StorageError};
use near_primitives_v01::serialize::to_base;
use near_primitives_v01::shard_layout::ShardLayoutError;
use near_primitives_v01::sharding::{ChunkHash, ShardChunkHeader};
use near_primitives_v01::types::{BlockHeight, EpochId, ShardId};
#[derive(thiserror::Error, Debug)]
pub enum QueryError {
#[error("Account ID {requested_account_id} is invalid")]
InvalidAccount {
requested_account_id: near_primitives_v01::types::AccountId,
block_height: near_primitives_v01::types::BlockHeight,
block_hash: near_primitives_v01::hash::CryptoHash,
},
#[error("Account {requested_account_id} does not exist while viewing")]
UnknownAccount {
requested_account_id: near_primitives_v01::types::AccountId,
block_height: near_primitives_v01::types::BlockHeight,
block_hash: near_primitives_v01::hash::CryptoHash,
},
#[error(
"Contract code for contract ID {contract_account_id} has never been observed on the node"
)]
NoContractCode {
contract_account_id: near_primitives_v01::types::AccountId,
block_height: near_primitives_v01::types::BlockHeight,
block_hash: near_primitives_v01::hash::CryptoHash,
},
#[error("Access key for public key {public_key} does not exist while viewing")]
UnknownAccessKey {
public_key: near_crypto_v01::PublicKey,
block_height: near_primitives_v01::types::BlockHeight,
block_hash: near_primitives_v01::hash::CryptoHash,
},
#[error("Internal error occurred: {error_message}")]
InternalError {
error_message: String,
block_height: near_primitives_v01::types::BlockHeight,
block_hash: near_primitives_v01::hash::CryptoHash,
},
#[error("Function call returned an error: {error_message}")]
ContractExecutionError {
error_message: String,
block_height: near_primitives_v01::types::BlockHeight,
block_hash: near_primitives_v01::hash::CryptoHash,
},
#[error("The state of account {requested_account_id} is too large")]
TooLargeContractState {
requested_account_id: near_primitives_v01::types::AccountId,
block_height: near_primitives_v01::types::BlockHeight,
block_hash: near_primitives_v01::hash::CryptoHash,
},
}
#[derive(Debug)]
pub struct Error {
inner: Context<ErrorKind>,
}
#[derive(Clone, Eq, PartialEq, Debug, Fail)]
pub enum ErrorKind {
#[fail(display = "Block is unfit: {}", _0)]
Unfit(String),
#[fail(display = "Orphan")]
Orphan,
#[fail(display = "Chunk Missing (unavailable on the node): {:?}", _0)]
ChunkMissing(ChunkHash),
#[fail(display = "Chunks Missing: {:?}", _0)]
ChunksMissing(Vec<ShardChunkHeader>),
#[fail(display = "Invalid Block Time: block time {} before previous {}", _1, _0)]
InvalidBlockPastTime(DateTime<Utc>, DateTime<Utc>),
#[fail(display = "Invalid Block Time: Too far in the future: {}", _0)]
InvalidBlockFutureTime(DateTime<Utc>),
#[fail(display = "Invalid Block Height {}", _0)]
InvalidBlockHeight(BlockHeight),
#[fail(display = "Invalid Block Proposer Signature")]
InvalidBlockProposer,
#[fail(display = "Invalid State Root Hash")]
InvalidStateRoot,
#[fail(display = "Invalid Block Tx Root Hash")]
InvalidTxRoot,
#[fail(display = "Invalid Chunk Receipts Root Hash")]
InvalidChunkReceiptsRoot,
#[fail(display = "Invalid Chunk Headers Root Hash")]
InvalidChunkHeadersRoot,
#[fail(display = "Invalid Chunk Tx Root Hash")]
InvalidChunkTxRoot,
#[fail(display = "Invalid Receipts Proof")]
InvalidReceiptsProof,
#[fail(display = "Invalid Outcomes Proof")]
InvalidOutcomesProof,
#[fail(display = "Invalid State Payload")]
InvalidStatePayload,
#[fail(display = "Invalid Transactions")]
InvalidTransactions,
#[fail(display = "Invalid Challenge Root")]
InvalidChallengeRoot,
#[fail(display = "Invalid Challenge")]
InvalidChallenge,
#[fail(display = "Malicious Challenge")]
MaliciousChallenge,
#[fail(display = "Incorrect Number of Chunk Headers")]
IncorrectNumberOfChunkHeaders,
#[fail(display = "Invalid Chunk")]
InvalidChunk,
#[fail(display = "Invalid Chunk Proofs")]
InvalidChunkProofs(Box<ChunkProofs>),
#[fail(display = "Invalid Chunk State")]
InvalidChunkState(Box<ChunkState>),
#[fail(display = "Invalid Chunk Mask")]
InvalidChunkMask,
#[fail(display = "Invalid Chunk Height")]
InvalidChunkHeight,
#[fail(display = "Invalid Epoch Hash")]
InvalidEpochHash,
#[fail(display = "Invalid Next BP Hash")]
InvalidNextBPHash,
#[fail(display = "Not enough approvals")]
NotEnoughApprovals,
#[fail(display = "Invalid finality info")]
InvalidFinalityInfo,
#[fail(display = "Invalid Validator Proposals")]
InvalidValidatorProposals,
#[fail(display = "Invalid Signature")]
InvalidSignature,
#[fail(display = "Invalid Approvals")]
InvalidApprovals,
#[fail(display = "Invalid Gas Limit")]
InvalidGasLimit,
#[fail(display = "Invalid Gas Price")]
InvalidGasPrice,
#[fail(display = "Invalid Gas Used")]
InvalidGasUsed,
#[fail(display = "Invalid Balance Burnt")]
InvalidBalanceBurnt,
#[fail(display = "Shard id {} does not exist", _0)]
InvalidShardId(ShardId),
#[fail(display = "Invalid state request: {}", _0)]
InvalidStateRequest(String),
#[fail(display = "Invalid Randomness Beacon Output")]
InvalidRandomnessBeaconOutput,
#[fail(display = "Invalid Block Merkle Root")]
InvalidBlockMerkleRoot,
#[fail(display = "Not A Validator")]
NotAValidator,
#[fail(display = "Validator Error: {}", _0)]
ValidatorError(String),
#[fail(display = "Epoch Out Of Bounds")]
EpochOutOfBounds(EpochId),
#[fail(display = "Challenged block on chain")]
ChallengedBlockOnChain,
#[fail(display = "IO Error: {}", _0)]
IOErr(String),
#[fail(display = "DB Not Found Error: {}", _0)]
DBNotFoundErr(String),
#[fail(display = "Storage Error: {}", _0)]
StorageError(StorageError),
#[fail(display = "GC Error: {}", _0)]
GCError(String),
#[fail(display = "Other Error: {}", _0)]
Other(String),
}
pub trait LogTransientStorageError {
fn log_storage_error(self, message: &str) -> Self;
}
impl<T> LogTransientStorageError for Result<T, Error> {
fn log_storage_error(self, message: &str) -> Self {
if let Err(ref e) = self {
error!(target: "client",
"Transient storage error: {}, {}",
message, e
);
}
self
}
}
impl Display for Error {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let cause = match self.cause() {
Some(c) => format!("{}", c),
None => String::from("Unknown"),
};
let output = format!("{} \n Cause: {}", self.inner, cause);
Display::fmt(&output, f)
}
}
impl Error {
pub fn kind(&self) -> ErrorKind {
self.inner.get_context().clone()
}
pub fn cause(&self) -> Option<&dyn Fail> {
self.inner.cause()
}
pub fn backtrace(&self) -> Option<&Backtrace> {
self.inner.backtrace()
}
pub fn is_bad_data(&self) -> bool {
match self.kind() {
ErrorKind::Unfit(_)
| ErrorKind::Orphan
| ErrorKind::ChunkMissing(_)
| ErrorKind::ChunksMissing(_)
| ErrorKind::InvalidChunkHeight
| ErrorKind::IOErr(_)
| ErrorKind::Other(_)
| ErrorKind::ValidatorError(_)
| ErrorKind::EpochOutOfBounds(_)
| ErrorKind::ChallengedBlockOnChain
| ErrorKind::StorageError(_)
| ErrorKind::GCError(_)
| ErrorKind::DBNotFoundErr(_) => false,
ErrorKind::InvalidBlockPastTime(_, _)
| ErrorKind::InvalidBlockFutureTime(_)
| ErrorKind::InvalidBlockHeight(_)
| ErrorKind::InvalidBlockProposer
| ErrorKind::InvalidChunk
| ErrorKind::InvalidChunkProofs(_)
| ErrorKind::InvalidChunkState(_)
| ErrorKind::InvalidChunkMask
| ErrorKind::InvalidStateRoot
| ErrorKind::InvalidTxRoot
| ErrorKind::InvalidChunkReceiptsRoot
| ErrorKind::InvalidOutcomesProof
| ErrorKind::InvalidChunkHeadersRoot
| ErrorKind::InvalidChunkTxRoot
| ErrorKind::InvalidReceiptsProof
| ErrorKind::InvalidStatePayload
| ErrorKind::InvalidTransactions
| ErrorKind::InvalidChallenge
| ErrorKind::MaliciousChallenge
| ErrorKind::IncorrectNumberOfChunkHeaders
| ErrorKind::InvalidEpochHash
| ErrorKind::InvalidNextBPHash
| ErrorKind::NotEnoughApprovals
| ErrorKind::InvalidFinalityInfo
| ErrorKind::InvalidValidatorProposals
| ErrorKind::InvalidSignature
| ErrorKind::InvalidApprovals
| ErrorKind::InvalidGasLimit
| ErrorKind::InvalidGasPrice
| ErrorKind::InvalidGasUsed
| ErrorKind::InvalidBalanceBurnt
| ErrorKind::InvalidShardId(_)
| ErrorKind::InvalidStateRequest(_)
| ErrorKind::InvalidRandomnessBeaconOutput
| ErrorKind::InvalidBlockMerkleRoot
| ErrorKind::NotAValidator
| ErrorKind::InvalidChallengeRoot => true,
}
}
pub fn is_error(&self) -> bool {
match self.kind() {
ErrorKind::IOErr(_) | ErrorKind::Other(_) | ErrorKind::DBNotFoundErr(_) => true,
_ => false,
}
}
}
impl From<ErrorKind> for Error {
fn from(kind: ErrorKind) -> Error {
Error { inner: Context::new(kind) }
}
}
impl From<io::Error> for Error {
fn from(error: io::Error) -> Error {
Error { inner: Context::new(ErrorKind::IOErr(error.to_string())) }
}
}
impl From<String> for Error {
fn from(error: String) -> Error {
Error { inner: Context::new(ErrorKind::Other(error)) }
}
}
impl std::error::Error for Error {}
impl From<EpochError> for Error {
fn from(error: EpochError) -> Self {
match error {
EpochError::EpochOutOfBounds(epoch_id) => ErrorKind::EpochOutOfBounds(epoch_id),
EpochError::MissingBlock(h) => ErrorKind::DBNotFoundErr(to_base(&h)),
err => ErrorKind::ValidatorError(err.to_string()),
}
.into()
}
}
impl From<ShardLayoutError> for Error {
fn from(error: ShardLayoutError) -> Self {
match error {
ShardLayoutError::InvalidShardIdError { shard_id } => {
ErrorKind::InvalidShardId(shard_id)
}
}
.into()
}
}
impl From<BlockValidityError> for Error {
fn from(error: BlockValidityError) -> Self {
match error {
BlockValidityError::InvalidStateRoot => ErrorKind::InvalidStateRoot,
BlockValidityError::InvalidReceiptRoot => ErrorKind::InvalidChunkReceiptsRoot,
BlockValidityError::InvalidTransactionRoot => ErrorKind::InvalidTxRoot,
BlockValidityError::InvalidChunkHeaderRoot => ErrorKind::InvalidChunkHeadersRoot,
BlockValidityError::InvalidChunkMask => ErrorKind::InvalidChunkMask,
BlockValidityError::InvalidChallengeRoot => ErrorKind::InvalidChallengeRoot,
}
.into()
}
}
impl From<StorageError> for Error {
fn from(error: StorageError) -> Self {
ErrorKind::StorageError(error).into()
}
}