mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-07-18 17:35:42 +00:00
chore/error: remove from str conversion and add deprecation notificat… (#7472)
* chore/error: remove from str conversion and add deprecation notifications * fixup changes * fix test looking for gone ::Msg variant * another test fix * one is duplicate, the other is not, so duplicates reported are n-1 * darn spaces Co-authored-by: Andronik Ordian <write@reusable.software> * remove pointless doc comments of error variants without any value * low hanging fruits (for a tall person) * moar error type variants * avoid the storage modules for now They are in need of a refactor, and the pain is rather large removing all String error and DefaultError occurences. * chore remove pointless error generic * fix test for mocks, add a bunch of non_exhaustive * max line width * test fixes due to error changes * fin * error outputs... again * undo stderr adjustments * Update client/consensus/slots/src/lib.rs Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * remove closure clutter Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * more error types * introduce ApiError * extract Mock error * ApiError refactor * even more error types * the last for now * chore unused deps * another extraction * reduce should panic, due to extended error messages * error test happiness * shift error lines by one * doc tests * white space Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * Into -> From Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * remove pointless codec Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> * avoid pointless self import Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com> Co-authored-by: Bernhard Schuster <bernhard@parity.io> Co-authored-by: Andronik Ordian <write@reusable.software> Co-authored-by: Bastian Köcher <bkchr@users.noreply.github.com>
This commit is contained in:
Bernhard Schuster
committed by
GitHub
GitHub
parent
6722a83ba6
commit
8c7d217091
@@ -21,6 +21,7 @@ sp-runtime = { version = "2.0.0", default-features = false, path = "../runtime"
|
||||
sp-version = { version = "2.0.0", default-features = false, path = "../version" }
|
||||
sp-state-machine = { version = "0.8.0", optional = true, path = "../../primitives/state-machine" }
|
||||
hash-db = { version = "0.15.2", optional = true }
|
||||
thiserror = { version = "1.0.21", optional = true }
|
||||
|
||||
[dev-dependencies]
|
||||
sp-test-primitives = { version = "2.0.0", path = "../test-primitives" }
|
||||
@@ -35,4 +36,5 @@ std = [
|
||||
"sp-state-machine",
|
||||
"sp-version/std",
|
||||
"hash-db",
|
||||
"thiserror",
|
||||
]
|
||||
|
||||
@@ -708,13 +708,7 @@ impl<'a> ToClientSideDecl<'a> {
|
||||
},
|
||||
#crate_::NativeOrEncoded::Encoded(r) => {
|
||||
<#ret_type as #crate_::Decode>::decode(&mut &r[..])
|
||||
.map_err(|err|
|
||||
format!(
|
||||
"Failed to decode result of `{}`: {}",
|
||||
#function_name,
|
||||
err.what(),
|
||||
).into()
|
||||
)
|
||||
.map_err(|err| { #crate_::ApiError::new(#function_name, err).into() })
|
||||
}
|
||||
}
|
||||
)
|
||||
|
||||
@@ -69,7 +69,9 @@ fn implement_common_api_traits(
|
||||
) -> Result<TokenStream> {
|
||||
let crate_ = generate_crate_access(HIDDEN_INCLUDES_ID);
|
||||
|
||||
let error_type = error_type.map(|e| quote!(#e)).unwrap_or_else(|| quote!(String));
|
||||
let error_type = error_type
|
||||
.map(|e| quote!(#e))
|
||||
.unwrap_or_else(|| quote!( #crate_::ApiError ) );
|
||||
|
||||
// Quote using the span from `error_type` to generate nice error messages when the type is
|
||||
// not implementing a trait or similar.
|
||||
|
||||
@@ -74,6 +74,7 @@ use sp_core::OpaqueMetadata;
|
||||
#[cfg(feature = "std")]
|
||||
use std::{panic::UnwindSafe, cell::RefCell};
|
||||
|
||||
|
||||
/// Maximum nesting level for extrinsics.
|
||||
pub const MAX_EXTRINSIC_DEPTH: u32 = 256;
|
||||
|
||||
@@ -288,7 +289,7 @@ pub use sp_api_proc_macro::impl_runtime_apis;
|
||||
/// /// Sets the error type that is being used by the mock implementation.
|
||||
/// /// The error type is used by all runtime apis. It is only required to
|
||||
/// /// be specified in one trait implementation.
|
||||
/// type Error = String;
|
||||
/// type Error = sp_api::ApiError;
|
||||
///
|
||||
/// fn build_block() -> Block {
|
||||
/// unimplemented!("Not Required in tests")
|
||||
@@ -315,6 +316,7 @@ pub use sp_api_proc_macro::impl_runtime_apis;
|
||||
/// # use sp_runtime::{traits::Block as BlockT, generic::BlockId};
|
||||
/// # use sp_test_primitives::Block;
|
||||
/// # use sp_core::NativeOrEncoded;
|
||||
/// # use codec;
|
||||
/// #
|
||||
/// # sp_api::decl_runtime_apis! {
|
||||
/// # /// Declare the api trait.
|
||||
@@ -331,15 +333,15 @@ pub use sp_api_proc_macro::impl_runtime_apis;
|
||||
///
|
||||
/// sp_api::mock_impl_runtime_apis! {
|
||||
/// impl Balance<Block> for MockApi {
|
||||
/// type Error = String;
|
||||
/// type Error = sp_api::ApiError;
|
||||
/// #[advanced]
|
||||
/// fn get_balance(&self, at: &BlockId<Block>) -> Result<NativeOrEncoded<u64>, String> {
|
||||
/// fn get_balance(&self, at: &BlockId<Block>) -> Result<NativeOrEncoded<u64>, Self::Error> {
|
||||
/// println!("Being called at: {}", at);
|
||||
///
|
||||
/// Ok(self.balance.into())
|
||||
/// }
|
||||
/// #[advanced]
|
||||
/// fn set_balance(at: &BlockId<Block>, val: u64) -> Result<NativeOrEncoded<()>, String> {
|
||||
/// fn set_balance(at: &BlockId<Block>, val: u64) -> Result<NativeOrEncoded<()>, Self::Error> {
|
||||
/// if let BlockId::Number(1) = at {
|
||||
/// println!("Being called to set balance to: {}", val);
|
||||
/// }
|
||||
@@ -392,12 +394,42 @@ pub trait ConstructRuntimeApi<Block: BlockT, C: CallApiAt<Block>> {
|
||||
fn construct_runtime_api<'a>(call: &'a C) -> ApiRef<'a, Self::RuntimeApi>;
|
||||
}
|
||||
|
||||
/// An error describing which API call failed.
|
||||
#[cfg_attr(feature = "std", derive(Debug, thiserror::Error, Eq, PartialEq))]
|
||||
#[cfg_attr(feature = "std", error("Failed to execute API call {tag}"))]
|
||||
#[cfg(feature = "std")]
|
||||
pub struct ApiError {
|
||||
tag: &'static str,
|
||||
#[source]
|
||||
error: codec::Error,
|
||||
}
|
||||
|
||||
#[cfg(feature = "std")]
|
||||
impl From<(&'static str, codec::Error)> for ApiError {
|
||||
fn from((tag, error): (&'static str, codec::Error)) -> Self {
|
||||
Self {
|
||||
tag,
|
||||
error,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(feature = "std")]
|
||||
impl ApiError {
|
||||
pub fn new(tag: &'static str, error: codec::Error) -> Self {
|
||||
Self {
|
||||
tag,
|
||||
error,
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Extends the runtime api traits with an associated error type. This trait is given as super
|
||||
/// trait to every runtime api trait.
|
||||
#[cfg(feature = "std")]
|
||||
pub trait ApiErrorExt {
|
||||
/// Error type used by the runtime apis.
|
||||
type Error: std::fmt::Debug + From<String>;
|
||||
type Error: std::fmt::Debug + From<ApiError>;
|
||||
}
|
||||
|
||||
/// Extends the runtime api implementation with some common functionality.
|
||||
@@ -506,7 +538,7 @@ pub struct CallApiAtParams<'a, Block: BlockT, C, NC, Backend: StateBackend<HashF
|
||||
#[cfg(feature = "std")]
|
||||
pub trait CallApiAt<Block: BlockT> {
|
||||
/// Error type used by the implementation.
|
||||
type Error: std::fmt::Debug + From<String>;
|
||||
type Error: std::fmt::Debug + From<ApiError>;
|
||||
|
||||
/// The state backend that is used to store the block states.
|
||||
type StateBackend: StateBackend<HashFor<Block>>;
|
||||
|
||||
@@ -17,6 +17,7 @@
|
||||
|
||||
use sp_api::{
|
||||
RuntimeApiInfo, decl_runtime_apis, impl_runtime_apis, mock_impl_runtime_apis,
|
||||
ApiError,
|
||||
ApiExt,
|
||||
};
|
||||
use sp_runtime::{traits::{GetNodeBlockType, Block as BlockT}, generic::BlockId};
|
||||
@@ -103,17 +104,27 @@ mock_impl_runtime_apis! {
|
||||
}
|
||||
|
||||
#[advanced]
|
||||
fn same_name(_: &BlockId<Block>) -> std::result::Result<NativeOrEncoded<()>, String> {
|
||||
fn same_name(_: &BlockId<Block>) ->
|
||||
std::result::Result<
|
||||
NativeOrEncoded<()>,
|
||||
ApiError
|
||||
>
|
||||
{
|
||||
Ok(().into())
|
||||
}
|
||||
|
||||
#[advanced]
|
||||
fn wild_card(at: &BlockId<Block>, _: u32) -> std::result::Result<NativeOrEncoded<()>, String> {
|
||||
fn wild_card(at: &BlockId<Block>, _: u32) ->
|
||||
std::result::Result<
|
||||
NativeOrEncoded<()>,
|
||||
ApiError
|
||||
>
|
||||
{
|
||||
if let BlockId::Number(1337) = at {
|
||||
// yeah
|
||||
Ok(().into())
|
||||
} else {
|
||||
Err("Ohh noooo".into())
|
||||
Err(ApiError::new("MockApi", codec::Error::from("Ohh noooo")))
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -197,5 +208,8 @@ fn mock_runtime_api_works_with_advanced() {
|
||||
|
||||
Api::<Block>::same_name(&mock, &BlockId::Number(0)).unwrap();
|
||||
mock.wild_card(&BlockId::Number(1337), 1).unwrap();
|
||||
assert_eq!(String::from("Ohh noooo"), mock.wild_card(&BlockId::Number(1336), 1).unwrap_err());
|
||||
assert_eq!(
|
||||
ApiError::new("MockApi", ::codec::Error::from("Ohh noooo")),
|
||||
mock.wild_card(&BlockId::Number(1336), 1).unwrap_err()
|
||||
);
|
||||
}
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
use substrate_test_runtime_client::runtime::Block;
|
||||
use sp_api::ApiError;
|
||||
|
||||
sp_api::decl_runtime_apis! {
|
||||
pub trait Api {
|
||||
@@ -11,7 +12,7 @@ struct MockApi;
|
||||
sp_api::mock_impl_runtime_apis! {
|
||||
impl Api<Block> for MockApi {
|
||||
#[advanced]
|
||||
fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, String> {
|
||||
fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
|
||||
Ok(().into())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,13 +1,13 @@
|
||||
error: `BlockId` needs to be taken by reference and not by value!
|
||||
--> $DIR/mock_advanced_block_id_by_value.rs:11:1
|
||||
--> $DIR/mock_advanced_block_id_by_value.rs:12:1
|
||||
|
|
||||
11 | / sp_api::mock_impl_runtime_apis! {
|
||||
12 | | impl Api<Block> for MockApi {
|
||||
13 | | #[advanced]
|
||||
14 | | fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, String> {
|
||||
12 | / sp_api::mock_impl_runtime_apis! {
|
||||
13 | | impl Api<Block> for MockApi {
|
||||
14 | | #[advanced]
|
||||
15 | | fn test(&self, _: BlockId<Block>) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
|
||||
... |
|
||||
17 | | }
|
||||
18 | | }
|
||||
18 | | }
|
||||
19 | | }
|
||||
| |_^
|
||||
|
|
||||
= note: this error originates in a macro (in Nightly builds, run with -Z macro-backtrace for more info)
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
use substrate_test_runtime_client::runtime::Block;
|
||||
use sp_api::ApiError;
|
||||
|
||||
sp_api::decl_runtime_apis! {
|
||||
pub trait Api {
|
||||
@@ -11,7 +12,7 @@ struct MockApi;
|
||||
sp_api::mock_impl_runtime_apis! {
|
||||
impl Api<Block> for MockApi {
|
||||
#[advanced]
|
||||
fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, String> {
|
||||
fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
|
||||
Ok(().into())
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
error: If using the `advanced` attribute, it is required that the function takes at least one argument, the `BlockId`.
|
||||
--> $DIR/mock_advanced_missing_blockid.rs:14:3
|
||||
--> $DIR/mock_advanced_missing_blockid.rs:15:3
|
||||
|
|
||||
14 | fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, String> {
|
||||
15 | fn test(&self) -> Result<sp_core::NativeOrEncoded<()>, ApiError> {
|
||||
| ^^
|
||||
|
||||
@@ -10,16 +10,16 @@ error: First error type was declared here.
|
||||
17 | type Error = u32;
|
||||
| ^^^
|
||||
|
||||
error[E0277]: the trait bound `u32: std::convert::From<std::string::String>` is not satisfied
|
||||
error[E0277]: the trait bound `u32: std::convert::From<sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiError>` is not satisfied
|
||||
--> $DIR/mock_only_one_error_type.rs:17:16
|
||||
|
|
||||
17 | type Error = u32;
|
||||
| ^^^ the trait `std::convert::From<std::string::String>` is not implemented for `u32`
|
||||
| ^^^ the trait `std::convert::From<sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiError>` is not implemented for `u32`
|
||||
|
|
||||
::: $WORKSPACE/primitives/api/src/lib.rs
|
||||
|
|
||||
| type Error: std::fmt::Debug + From<String>;
|
||||
| ------------ required by this bound in `sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiErrorExt`
|
||||
| type Error: std::fmt::Debug + From<ApiError>;
|
||||
| -------------- required by this bound in `sp_api_hidden_includes_DECL_RUNTIME_APIS::sp_api::ApiErrorExt`
|
||||
|
|
||||
= help: the following implementations were found:
|
||||
<u32 as std::convert::From<bool>>
|
||||
|
||||
@@ -18,8 +18,10 @@ log = "0.4.11"
|
||||
lru = "0.6.1"
|
||||
parking_lot = "0.10.0"
|
||||
thiserror = "1.0.21"
|
||||
futures = "0.3"
|
||||
codec = { package = "parity-scale-codec", version = "1.3.1", default-features = false, features = ["derive"] }
|
||||
sp-consensus = { version = "0.8.0", path = "../consensus/common" }
|
||||
sp-runtime = { version = "2.0.0", path = "../runtime" }
|
||||
sp-state-machine = { version = "0.8.0", path = "../state-machine" }
|
||||
sp-database = { version = "2.0.0", path = "../database" }
|
||||
sp-api = { version = "2.0.0", path = "../api" }
|
||||
|
||||
@@ -172,7 +172,7 @@ pub trait Backend<Block: BlockT>: HeaderBackend<Block> + HeaderMetadata<Block, E
|
||||
if let Some(max_number) = maybe_max_number {
|
||||
loop {
|
||||
let current_header = self.header(BlockId::Hash(current_hash.clone()))?
|
||||
.ok_or_else(|| Error::from(format!("failed to get header for hash {}", current_hash)))?;
|
||||
.ok_or_else(|| Error::MissingHeader(current_hash.to_string()))?;
|
||||
|
||||
if current_header.number() <= &max_number {
|
||||
best_hash = current_header.hash();
|
||||
@@ -191,7 +191,7 @@ pub trait Backend<Block: BlockT>: HeaderBackend<Block> + HeaderMetadata<Block, E
|
||||
}
|
||||
|
||||
let current_header = self.header(BlockId::Hash(current_hash.clone()))?
|
||||
.ok_or_else(|| Error::from(format!("failed to get header for hash {}", current_hash)))?;
|
||||
.ok_or_else(|| Error::MissingHeader(current_hash.to_string()))?;
|
||||
|
||||
// stop search in this chain once we go below the target's block number
|
||||
if current_header.number() < target_header.number() {
|
||||
|
||||
@@ -22,12 +22,14 @@ use sp_state_machine;
|
||||
use sp_runtime::transaction_validity::TransactionValidityError;
|
||||
use sp_consensus;
|
||||
use codec::Error as CodecError;
|
||||
use sp_api::ApiError;
|
||||
|
||||
/// Client Result type alias
|
||||
pub type Result<T> = result::Result<T, Error>;
|
||||
|
||||
/// Error when the runtime failed to apply an extrinsic.
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
#[allow(missing_docs)]
|
||||
pub enum ApplyExtrinsicFailed {
|
||||
/// The transaction cannot be included into the current block.
|
||||
///
|
||||
@@ -35,114 +37,142 @@ pub enum ApplyExtrinsicFailed {
|
||||
/// unappliable onto the current block.
|
||||
#[error("Extrinsic is not valid: {0:?}")]
|
||||
Validity(#[from] TransactionValidityError),
|
||||
/// This is used for miscellaneous errors that can be represented by string and not handleable.
|
||||
///
|
||||
/// This will become obsolete with complete migration to v4 APIs.
|
||||
#[error("Extrinsic failed: {0}")]
|
||||
Msg(String),
|
||||
|
||||
#[error("Application specific error")]
|
||||
Application(#[source] Box<dyn 'static + std::error::Error + Send + Sync>),
|
||||
}
|
||||
|
||||
/// Substrate Client error
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
#[allow(missing_docs)]
|
||||
#[non_exhaustive]
|
||||
pub enum Error {
|
||||
/// Consensus Error
|
||||
#[error("Cancelled oneshot channel {0}")]
|
||||
OneShotCancelled(#[from] futures::channel::oneshot::Canceled),
|
||||
|
||||
#[error(transparent)]
|
||||
Consensus(#[from] sp_consensus::Error),
|
||||
/// Backend error.
|
||||
|
||||
#[error("Backend error: {0}")]
|
||||
Backend(String),
|
||||
/// Unknown block.
|
||||
|
||||
#[error("UnknownBlock: {0}")]
|
||||
UnknownBlock(String),
|
||||
/// The `apply_extrinsic` is not valid due to the given `TransactionValidityError`.
|
||||
|
||||
#[error(transparent)]
|
||||
ApplyExtrinsicFailed(#[from] ApplyExtrinsicFailed),
|
||||
/// Execution error.
|
||||
|
||||
#[error("Child type is invalid")]
|
||||
InvalidChildType,
|
||||
|
||||
#[error("RemoteBodyRequest: invalid extrinsics root expected: {expected} but got {received}")]
|
||||
ExtrinsicRootInvalid { received: String, expected: String },
|
||||
|
||||
// `inner` cannot be made member, since it lacks `std::error::Error` trait bounds.
|
||||
#[error("Execution failed: {0:?}")]
|
||||
Execution(Box<dyn sp_state_machine::Error>),
|
||||
/// Blockchain error.
|
||||
|
||||
#[error("Blockchain")]
|
||||
Blockchain(#[source] Box<Error>),
|
||||
/// Invalid authorities set received from the runtime.
|
||||
|
||||
/// A error used by various storage subsystems.
|
||||
///
|
||||
/// Eventually this will be replaced.
|
||||
#[error("{0}")]
|
||||
StorageChanges(sp_state_machine::DefaultError),
|
||||
|
||||
#[error("Invalid child storage key")]
|
||||
InvalidChildStorageKey,
|
||||
|
||||
#[error("Current state of blockchain has invalid authorities set")]
|
||||
InvalidAuthoritiesSet,
|
||||
/// Could not get runtime version.
|
||||
|
||||
#[error("Failed to get runtime version: {0}")]
|
||||
VersionInvalid(String),
|
||||
/// Genesis config is invalid.
|
||||
|
||||
#[error("Genesis config provided is invalid")]
|
||||
GenesisInvalid,
|
||||
/// Error decoding header justification.
|
||||
|
||||
#[error("error decoding justification for header")]
|
||||
JustificationDecode,
|
||||
/// Justification for header is correctly encoded, but invalid.
|
||||
|
||||
#[error("bad justification for header: {0}")]
|
||||
BadJustification(String),
|
||||
/// Not available on light client.
|
||||
|
||||
#[error("This method is not currently available when running in light client mode")]
|
||||
NotAvailableOnLightClient,
|
||||
/// Invalid remote CHT-based proof.
|
||||
|
||||
#[error("Remote node has responded with invalid header proof")]
|
||||
InvalidCHTProof,
|
||||
/// Remote fetch has been cancelled.
|
||||
|
||||
#[error("Remote data fetch has been cancelled")]
|
||||
RemoteFetchCancelled,
|
||||
/// Remote fetch has been failed.
|
||||
|
||||
#[error("Remote data fetch has been failed")]
|
||||
RemoteFetchFailed,
|
||||
/// Error decoding call result.
|
||||
|
||||
#[error("Error decoding call result of {0}")]
|
||||
CallResultDecode(&'static str, #[source] CodecError),
|
||||
/// Error converting a parameter between runtime and node.
|
||||
#[error("Error converting `{0}` between runtime and node")]
|
||||
RuntimeParamConversion(String),
|
||||
/// Changes tries are not supported.
|
||||
|
||||
#[error(transparent)]
|
||||
RuntimeApiCodecError(#[from] ApiError),
|
||||
|
||||
#[error("Runtime :code missing in storage")]
|
||||
RuntimeCodeMissing,
|
||||
|
||||
#[error("Changes tries are not supported by the runtime")]
|
||||
ChangesTriesNotSupported,
|
||||
/// Error reading changes tries configuration.
|
||||
|
||||
#[error("Error reading changes tries configuration")]
|
||||
ErrorReadingChangesTriesConfig,
|
||||
/// Key changes query has failed.
|
||||
|
||||
#[error("Failed to check changes proof: {0}")]
|
||||
ChangesTrieAccessFailed(String),
|
||||
/// Last finalized block not parent of current.
|
||||
|
||||
#[error("Did not finalize blocks in sequential order.")]
|
||||
NonSequentialFinalization(String),
|
||||
/// Safety violation: new best block not descendent of last finalized.
|
||||
|
||||
#[error("Potential long-range attack: block not in finalized chain.")]
|
||||
NotInFinalizedChain,
|
||||
/// Hash that is required for building CHT is missing.
|
||||
|
||||
#[error("Failed to get hash of block for building CHT")]
|
||||
MissingHashRequiredForCHT,
|
||||
/// Invalid calculated state root on block import.
|
||||
|
||||
#[error("Calculated state root does not match.")]
|
||||
InvalidStateRoot,
|
||||
/// Incomplete block import pipeline.
|
||||
|
||||
#[error("Incomplete block import pipeline.")]
|
||||
IncompletePipeline,
|
||||
|
||||
#[error("Transaction pool not ready for block production.")]
|
||||
TransactionPoolNotReady,
|
||||
|
||||
#[error("Database")]
|
||||
DatabaseError(#[from] sp_database::error::DatabaseError),
|
||||
/// A convenience variant for String
|
||||
#[error("{0}")]
|
||||
Msg(String),
|
||||
|
||||
#[error("Failed to get header for hash {0}")]
|
||||
MissingHeader(String),
|
||||
|
||||
|
||||
#[error("State Database error: {0}")]
|
||||
StateDatabase(String),
|
||||
|
||||
#[error(transparent)]
|
||||
Application(#[from] Box<dyn std::error::Error + Send + Sync + 'static>),
|
||||
|
||||
// Should be removed/improved once
|
||||
// the storage `fn`s returns typed errors.
|
||||
#[error("Runtime code error: {0}")]
|
||||
RuntimeCode(&'static str),
|
||||
|
||||
// Should be removed/improved once
|
||||
// the storage `fn`s returns typed errors.
|
||||
#[error("Storage error: {0}")]
|
||||
Storage(String),
|
||||
}
|
||||
|
||||
impl<'a> From<&'a str> for Error {
|
||||
fn from(s: &'a str) -> Self {
|
||||
Error::Msg(s.into())
|
||||
}
|
||||
}
|
||||
|
||||
impl From<String> for Error {
|
||||
fn from(s: String) -> Self {
|
||||
Error::Msg(s)
|
||||
}
|
||||
}
|
||||
|
||||
impl From<Box<dyn sp_state_machine::Error + Send + Sync>> for Error {
|
||||
fn from(e: Box<dyn sp_state_machine::Error + Send + Sync>) -> Self {
|
||||
impl From<Box<dyn sp_state_machine::Error + Send + Sync + 'static>> for Error {
|
||||
fn from(e: Box<dyn sp_state_machine::Error + Send + Sync + 'static>) -> Self {
|
||||
Self::from_state(e)
|
||||
}
|
||||
}
|
||||
@@ -163,4 +193,11 @@ impl Error {
|
||||
pub fn from_state(e: Box<dyn sp_state_machine::Error>) -> Self {
|
||||
Error::Execution(e)
|
||||
}
|
||||
|
||||
/// Construct from a state db error.
|
||||
// Can not be done directly, since that would make cargo run out of stack if
|
||||
// `sc-state-db` is lib is added as dependency.
|
||||
pub fn from_state_db<E>(e: E) -> Self where E: std::fmt::Debug {
|
||||
Error::StateDatabase(format!("{:?}", e))
|
||||
}
|
||||
}
|
||||
|
||||
@@ -25,6 +25,7 @@ pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
/// Error type.
|
||||
#[derive(Debug, thiserror::Error)]
|
||||
#[non_exhaustive]
|
||||
pub enum Error {
|
||||
/// Missing state at block with given descriptor.
|
||||
#[error("State unavailable at block {0}")]
|
||||
|
||||
@@ -32,18 +32,18 @@ impl<T: 'static + fmt::Debug + fmt::Display + Send + Sync> Error for T {}
|
||||
/// would not be executed unless externalities were available. This is included for completeness,
|
||||
/// and as a transition away from the pre-existing framework.
|
||||
#[derive(Debug, Eq, PartialEq)]
|
||||
#[allow(missing_docs)]
|
||||
#[cfg_attr(feature = "std", derive(thiserror::Error))]
|
||||
pub enum ExecutionError {
|
||||
/// Backend error.
|
||||
#[cfg_attr(feature = "std", error("Backend error {0:?}"))]
|
||||
Backend(crate::DefaultError),
|
||||
/// The entry `:code` doesn't exist in storage so there's no way we can execute anything.
|
||||
|
||||
#[cfg_attr(feature = "std", error("`:code` entry does not exist in storage"))]
|
||||
CodeEntryDoesNotExist,
|
||||
/// Backend is incompatible with execution proof generation process.
|
||||
|
||||
#[cfg_attr(feature = "std", error("Unable to generate proof"))]
|
||||
UnableToGenerateProof,
|
||||
/// Invalid execution proof.
|
||||
|
||||
#[cfg_attr(feature = "std", error("Invalid execution proof"))]
|
||||
InvalidProof,
|
||||
}
|
||||
|
||||
@@ -14,8 +14,9 @@ readme = "README.md"
|
||||
targets = ["x86_64-unknown-linux-gnu"]
|
||||
|
||||
[dependencies]
|
||||
thiserror = { version = "1.0.21", optional = true }
|
||||
codec = { package = "parity-scale-codec", version = "1.3.1", optional = true }
|
||||
derive_more = { version = "0.99.2", optional = true }
|
||||
derive_more = { version = "0.99.11", optional = true }
|
||||
futures = { version = "0.3.1", optional = true }
|
||||
log = { version = "0.4.8", optional = true }
|
||||
serde = { version = "1.0.101", features = ["derive"], optional = true}
|
||||
@@ -31,6 +32,7 @@ std = [
|
||||
"futures",
|
||||
"log",
|
||||
"serde",
|
||||
"thiserror",
|
||||
"sp-api/std",
|
||||
"sp-blockchain",
|
||||
"sp-runtime/std",
|
||||
|
||||
@@ -25,49 +25,49 @@ use sp_runtime::transaction_validity::{
|
||||
pub type Result<T> = std::result::Result<T, Error>;
|
||||
|
||||
/// Transaction pool error type.
|
||||
#[derive(Debug, derive_more::Display, derive_more::From)]
|
||||
#[derive(Debug, thiserror::Error, derive_more::From)]
|
||||
#[allow(missing_docs)]
|
||||
pub enum Error {
|
||||
/// Transaction is not verifiable yet, but might be in the future.
|
||||
#[display(fmt="Unknown transaction validity: {:?}", _0)]
|
||||
#[error("Unknown transaction validity: {0:?}")]
|
||||
UnknownTransaction(UnknownTransaction),
|
||||
/// Transaction is invalid.
|
||||
#[display(fmt="Invalid transaction validity: {:?}", _0)]
|
||||
|
||||
#[error("Invalid transaction validity: {0:?}")]
|
||||
InvalidTransaction(InvalidTransaction),
|
||||
|
||||
/// The transaction validity returned no "provides" tag.
|
||||
///
|
||||
/// Such transactions are not accepted to the pool, since we use those tags
|
||||
/// to define identity of transactions (occupance of the same "slot").
|
||||
#[display(fmt="The transaction does not provide any tags, so the pool can't identify it.")]
|
||||
#[error("Transaction does not provide any tags, so the pool can't identify it")]
|
||||
NoTagsProvided,
|
||||
/// The transaction is temporarily banned.
|
||||
#[display(fmt="Temporarily Banned")]
|
||||
|
||||
#[error("Transaction temporarily Banned")]
|
||||
TemporarilyBanned,
|
||||
/// The transaction is already in the pool.
|
||||
#[display(fmt="[{:?}] Already imported", _0)]
|
||||
|
||||
#[error("[{0:?}] Already imported")]
|
||||
AlreadyImported(Box<dyn std::any::Any + Send>),
|
||||
/// The transaction cannot be imported cause it's a replacement and has too low priority.
|
||||
#[display(fmt="Too low priority ({} > {})", old, new)]
|
||||
|
||||
#[error("Too low priority ({} > {})", old, new)]
|
||||
TooLowPriority {
|
||||
/// Transaction already in the pool.
|
||||
old: Priority,
|
||||
/// Transaction entering the pool.
|
||||
new: Priority
|
||||
},
|
||||
/// Deps cycle detected and we couldn't import transaction.
|
||||
#[display(fmt="Cycle Detected")]
|
||||
#[error("Transaction with cyclic dependency")]
|
||||
CycleDetected,
|
||||
/// Transaction was dropped immediately after it got inserted.
|
||||
#[display(fmt="Transaction couldn't enter the pool because of the limit.")]
|
||||
|
||||
#[error("Transaction couldn't enter the pool because of the limit")]
|
||||
ImmediatelyDropped,
|
||||
/// Invalid block id.
|
||||
|
||||
#[from(ignore)]
|
||||
#[error("{0}")]
|
||||
InvalidBlockId(String),
|
||||
/// The pool is not accepting future transactions.
|
||||
#[display(fmt="The pool is not accepting future transactions")]
|
||||
|
||||
#[error("The pool is not accepting future transactions")]
|
||||
RejectedFutureTransaction,
|
||||
}
|
||||
|
||||
impl std::error::Error for Error {}
|
||||
|
||||
/// Transaction pool error conversion.
|
||||
pub trait IntoPoolError: std::error::Error + Send + Sized {
|
||||
/// Try to extract original `Error`
|
||||
|
||||
Reference in New Issue
Block a user