sc-rpc-api 0.55.0

Substrate RPC interfaces.
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

// This file is part of Substrate.

// Copyright (C) Parity Technologies (UK) Ltd.
// SPDX-License-Identifier: GPL-3.0-or-later WITH Classpath-exception-2.0

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.

// You should have received a copy of the GNU General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.

//! Error helpers for Dev RPC module.

use jsonrpsee::types::error::{ErrorObject, ErrorObjectOwned};

/// Dev RPC Result type.
pub type Result<T> = std::result::Result<T, Error>;

/// Dev RPC errors.
#[derive(Debug, thiserror::Error)]
pub enum Error {
	/// Failed to query specified block or its parent: Probably an invalid hash.
	#[error("Error while querying block: {0}")]
	BlockQueryError(Box<dyn std::error::Error + Send>),
	/// The re-execution of the specified block failed.
	#[error("Failed to re-execute the specified block")]
	BlockExecutionFailed,
	/// Failed to extract the proof.
	#[error("Failed to extract the proof")]
	ProofExtractionFailed,
	/// The witness compaction failed.
	#[error("Failed to create to compact the witness")]
	WitnessCompactionFailed,
	/// The method is marked as unsafe but unsafe flag wasn't supplied on the CLI.
	#[error(transparent)]
	UnsafeRpcCalled(#[from] crate::policy::UnsafeRpcError),
}

/// Base error code for all dev errors.
const BASE_ERROR: i32 = crate::error::base::DEV;

impl From<Error> for ErrorObjectOwned {
	fn from(e: Error) -> Self {
		let msg = e.to_string();

		match e {
			Error::BlockQueryError(_) => ErrorObject::owned(BASE_ERROR + 1, msg, None::<()>),
			Error::BlockExecutionFailed => ErrorObject::owned(BASE_ERROR + 3, msg, None::<()>),
			Error::WitnessCompactionFailed => ErrorObject::owned(BASE_ERROR + 4, msg, None::<()>),
			Error::ProofExtractionFailed => ErrorObject::owned(BASE_ERROR + 5, msg, None::<()>),
			Error::UnsafeRpcCalled(e) => e.into(),
		}
	}
}