mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-04-27 01:07:57 +00:00
Alexandru Vasile
4f13d5b790
This PR improves the transaction status documentation. - Added doc references for describing the main states - Extra comment wrt pool ready / future queues - `FinalityTimeout` no longer describes a lagging finality gadget, it signals that the maximum number of finality gadgets has been reached A few helper methods are added to indicate when: - a final event is generated by the transaction pool for a given event - a final event is provided, although the transaction might become valid at a later time and could be re-submitted The helper methods are used and taken from https://github.com/paritytech/polkadot-sdk/pull/3079 to help us better keep it in sync. cc @paritytech/subxt-team --------- Signed-off-by: Alexandru Vasile <alexandru.vasile@parity.io>
115 lines
3.5 KiB
Rust
115 lines
3.5 KiB
Rust
// 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/>.
|
|
|
|
//! Transaction pool errors.
|
|
|
|
use sp_runtime::transaction_validity::{
|
|
InvalidTransaction, TransactionPriority as Priority, UnknownTransaction,
|
|
};
|
|
|
|
/// Transaction pool result.
|
|
pub type Result<T> = std::result::Result<T, Error>;
|
|
|
|
/// Transaction pool error type.
|
|
#[derive(Debug, thiserror::Error)]
|
|
#[allow(missing_docs)]
|
|
pub enum Error {
|
|
#[error("Unknown transaction validity: {0:?}")]
|
|
UnknownTransaction(UnknownTransaction),
|
|
|
|
#[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").
|
|
#[error("Transaction does not provide any tags, so the pool can't identify it")]
|
|
NoTagsProvided,
|
|
|
|
#[error("Transaction temporarily Banned")]
|
|
TemporarilyBanned,
|
|
|
|
#[error("[{0:?}] Already imported")]
|
|
AlreadyImported(Box<dyn std::any::Any + Send + Sync>),
|
|
|
|
#[error("Too low priority ({} > {})", old, new)]
|
|
TooLowPriority {
|
|
/// Transaction already in the pool.
|
|
old: Priority,
|
|
/// Transaction entering the pool.
|
|
new: Priority,
|
|
},
|
|
#[error("Transaction with cyclic dependency")]
|
|
CycleDetected,
|
|
|
|
#[error("Transaction couldn't enter the pool because of the limit")]
|
|
ImmediatelyDropped,
|
|
|
|
#[error("Transaction cannot be propagated and the local node does not author blocks")]
|
|
Unactionable,
|
|
|
|
#[error("{0}")]
|
|
InvalidBlockId(String),
|
|
|
|
#[error("The pool is not accepting future transactions")]
|
|
RejectedFutureTransaction,
|
|
}
|
|
|
|
impl Error {
|
|
/// Returns true if the transaction could be re-submitted to the pool in the future.
|
|
///
|
|
/// For example, `Error::ImmediatelyDropped` is retriable, because the transaction
|
|
/// may enter the pool if there is space for it in the future.
|
|
pub fn is_retriable(&self) -> bool {
|
|
match self {
|
|
// An invalid transaction is temporarily banned, however it can
|
|
// become valid at a later time.
|
|
Error::TemporarilyBanned |
|
|
// The pool is full at the moment.
|
|
Error::ImmediatelyDropped |
|
|
// The block id is not known to the pool.
|
|
// The node might be lagging behind, or during a warp sync.
|
|
Error::InvalidBlockId(_) |
|
|
// The pool is configured to not accept future transactions.
|
|
Error::RejectedFutureTransaction => {
|
|
true
|
|
}
|
|
_ => false
|
|
}
|
|
}
|
|
}
|
|
|
|
/// Transaction pool error conversion.
|
|
pub trait IntoPoolError: std::error::Error + Send + Sized + Sync {
|
|
/// Try to extract original `Error`
|
|
///
|
|
/// This implementation is optional and used only to
|
|
/// provide more descriptive error messages for end users
|
|
/// of RPC API.
|
|
fn into_pool_error(self) -> std::result::Result<Error, Self> {
|
|
Err(self)
|
|
}
|
|
}
|
|
|
|
impl IntoPoolError for Error {
|
|
fn into_pool_error(self) -> std::result::Result<Error, Self> {
|
|
Ok(self)
|
|
}
|
|
}
|