From 7a1958ca4e0741d677635111d59112642bf98e42 Mon Sep 17 00:00:00 2001
From: Tsvetomir Dimitrov <tsv.dimitrov@gmail.com>
Date: Thu, 19 Jan 2023 13:32:50 +0200
Subject: [PATCH] Expose `UnknownBlock` error via `ApiError` (#12707)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
* Expose `UnknownBlock` error via `ApiError`
In [certain cases](https://github.com/paritytech/polkadot/issues/5885) a
runtime api is called for an unknown block. For example a block which is
already pruned or on an abandon fork.
In such cases the correct error is returned but it is wrapped in
`ApiError::Application` and the only way to figure out what is the
problem is to inspect the actual message in the error. In polkadot for
example this usually happens when the runtime api version is being
queried. It's beneficial to be able to clearly separate such errors so i
that when they occur the client side can handle them more gracefully.
E.g. log less stressful error message than `State already discarded for
BlockId` or cancel any pending work related on this block.
* Update primitives/api/src/lib.rs
Co-authored-by: Bastian Köcher <git@kchr.de>
Co-authored-by: Bastian Köcher <git@kchr.de>
---
substrate/primitives/api/src/lib.rs | 2 ++
substrate/primitives/blockchain/src/error.rs | 1 +
2 files changed, 3 insertions(+)
diff --git a/substrate/primitives/api/src/lib.rs b/substrate/primitives/api/src/lib.rs
index 91d4b07a1ce..4ff4becb80f 100644
--- a/substrate/primitives/api/src/lib.rs
+++ b/substrate/primitives/api/src/lib.rs
@@ -519,6 +519,8 @@ pub enum ApiError {
StateBackendIsNotTrie,
#[error(transparent)]
Application(#[from] Box<dyn std::error::Error + Send + Sync>),
+ #[error("Api called for an unknown Block: {0}")]
+ UnknownBlock(String),
}
/// Extends the runtime api implementation with some common functionality.
diff --git a/substrate/primitives/blockchain/src/error.rs b/substrate/primitives/blockchain/src/error.rs
index 783c40c4061..6585cc54f15 100644
--- a/substrate/primitives/blockchain/src/error.rs
+++ b/substrate/primitives/blockchain/src/error.rs
@@ -191,6 +191,7 @@ impl From<Box<dyn sp_state_machine::Error>> for Error {
impl From<Error> for ApiError {
fn from(err: Error) -> ApiError {
match err {
+ Error::UnknownBlock(msg) => ApiError::UnknownBlock(msg),
Error::RuntimeApiError(err) => err,
e => ApiError::Application(Box::new(e)),
}
--
GitLab