Recover transaction pool on light client (#3833)

* recover tx pool on light client * revert local tests fix * removed import renamings * futures03::Future -> std::future::Future * Update core/transaction-pool/graph/src/error.rs Co-Authored-By: Tomasz Drwięga <tomusdrw@users.noreply.github.com> * replace remove_from_ready with remove_invalid * avoid excess hashing * debug -> warn * TransactionPool + BasicTransactionPool * pause future tx reject when resubmitting * bump impl_version to make CI happy * and revert back local test fixes * alter doc to restart CI * Transaction::clone() -> Transaction::duplicate() * transactions -> updated_tranasctions * remove explicit consensus-common ref * ::std:: -> std:: * manual set/unset flag -> calling clusore with given flag value * removed comments * removed force argument * BestIterator -> Box<Iterator> * separate crate for TxPool + Maintainer trait * long line fix * pos-merge fix * fix benches compilation * Rename txpoolapi to txpool_api * Clean up. * Finalize merge. * post-merge fix * Move transaction pool api to primitives directly. * Consistent naming for txpool-runtime-api * Warn about missing docs. * Move abstraction for offchain calls to tx-pool-api. * Merge RPC instantiation. * Update cargo.lock * Post merge fixes. * Avoid depending on client. * Fix build
2026-06-12 13:31:10 +00:00 · 2019-11-28 03:00:54 +03:00
parent 3e26fceda4
commit a782021ee8
64 changed files with 2370 additions and 667 deletions
@@ -0,0 +1,82 @@
+// Copyright 2018-2019 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate 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.
+
+// Substrate 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Transaction pool errors.
+
+use sr_primitives::transaction_validity::{
+	TransactionPriority as Priority, InvalidTransaction, UnknownTransaction,
+};
+
+/// Transaction pool result.
+pub type Result<T> = std::result::Result<T, Error>;
+
+/// Transaction pool error type.
+#[derive(Debug, derive_more::Display, derive_more::From)]
+pub enum Error {
+	/// Transaction is not verifiable yet, but might be in the future.
+	#[display(fmt="Unknown transaction validity: {:?}", _0)]
+	UnknownTransaction(UnknownTransaction),
+	/// Transaction is invalid.
+	#[display(fmt="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.")]
+	NoTagsProvided,
+	/// The transaction is temporarily banned.
+	#[display(fmt="Temporarily Banned")]
+	TemporarilyBanned,
+	/// The transaction is already in the pool.
+	#[display(fmt="[{:?}] Already imported", _0)]
+	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)]
+	TooLowPriority {
+		/// Transaction already in the pool.
+		old: Priority,
+		/// Transaction entering the pool.
+		new: Priority
+	},
+	/// Deps cycle etected and we couldn't import transaction.
+	#[display(fmt="Cycle Detected")]
+	CycleDetected,
+	/// Transaction was dropped immediately after it got inserted.
+	#[display(fmt="Transaction couldn't enter the pool because of the limit.")]
+	ImmediatelyDropped,
+	/// Invalid block id.
+	InvalidBlockId(String),
+	/// The pool is not accepting future transactions.
+	#[display(fmt="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`
+	///
+	/// 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) }
+}
@@ -0,0 +1,328 @@
+// Copyright 2019 Parity Technologies (UK) Ltd.
+// This file is part of Substrate.
+
+// Substrate 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.
+
+// Substrate 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 Substrate.  If not, see <http://www.gnu.org/licenses/>.
+
+//! Transaction pool types.
+
+#![warn(missing_docs)]
+
+pub mod error;
+
+pub use error::IntoPoolError;
+pub use sr_primitives::transaction_validity::{
+	TransactionLongevity, TransactionPriority, TransactionTag,
+};
+
+use std::{
+	collections::HashMap,
+	hash::Hash,
+	sync::Arc,
+};
+use futures::{
+	Future, Stream,
+	channel::mpsc,
+};
+use serde::{Deserialize, Serialize};
+use sr_primitives::{
+	generic::BlockId,
+	traits::{Block as BlockT, Member},
+};
+
+/// Transaction pool status.
+#[derive(Debug)]
+pub struct PoolStatus {
+	/// Number of transactions in the ready queue.
+	pub ready: usize,
+	/// Sum of bytes of ready transaction encodings.
+	pub ready_bytes: usize,
+	/// Number of transactions in the future queue.
+	pub future: usize,
+	/// Sum of bytes of ready transaction encodings.
+	pub future_bytes: usize,
+}
+
+impl PoolStatus {
+	/// Returns true if the are no transactions in the pool.
+	pub fn is_empty(&self) -> bool {
+		self.ready == 0 && self.future == 0
+	}
+}
+
+/// Possible transaction status events.
+#[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
+#[serde(rename_all = "camelCase")]
+pub enum TransactionStatus<Hash, BlockHash> {
+	/// Transaction is part of the future queue.
+	Future,
+	/// Transaction is part of the ready queue.
+	Ready,
+	/// Transaction has been finalized in block with given hash.
+	Finalized(BlockHash),
+	/// Some state change (perhaps another transaction was included) rendered this transaction invalid.
+	Usurped(Hash),
+	/// The transaction has been broadcast to the given peers.
+	Broadcast(Vec<String>),
+	/// Transaction has been dropped from the pool because of the limit.
+	Dropped,
+	/// Transaction was detected as invalid.
+	Invalid,
+}
+
+/// The stream of transaction events.
+pub type TransactionStatusStream<Hash, BlockHash> = dyn Stream<Item=TransactionStatus<Hash, BlockHash>> + Send + Unpin;
+
+/// The import notification event stream.
+pub type ImportNotificationStream = mpsc::UnboundedReceiver<()>;
+
+/// Transaction hash type for a pool.
+pub type TxHash<P> = <P as TransactionPool>::Hash;
+/// Block hash type for a pool.
+pub type BlockHash<P> = <<P as TransactionPool>::Block as BlockT>::Hash;
+/// Transaction type for a pool.
+pub type TransactionFor<P> = <<P as TransactionPool>::Block as BlockT>::Extrinsic;
+/// Type of transactions event stream for a pool.
+pub type TransactionStatusStreamFor<P> = TransactionStatusStream<TxHash<P>, BlockHash<P>>;
+
+/// In-pool transaction interface.
+///
+/// The pool is container of transactions that are implementing this trait.
+/// See `sr_primitives::ValidTransaction` for details about every field.
+pub trait InPoolTransaction {
+	/// Transaction type.
+	type Transaction;
+	/// Transaction hash type.
+	type Hash;
+
+	/// Get the reference to the transaction data.
+	fn data(&self) -> &Self::Transaction;
+	/// Get hash of the transaction.
+	fn hash(&self) -> &Self::Hash;
+	/// Get priority of the transaction.
+	fn priority(&self) -> &TransactionPriority;
+	/// Get longevity of the transaction.
+	fn longevity(&self) ->&TransactionLongevity;
+	/// Get transaction dependencies.
+	fn requires(&self) -> &[TransactionTag];
+	/// Get tags that transaction provides.
+	fn provides(&self) -> &[TransactionTag];
+	/// Return a flag indicating if the transaction should be propagated to other peers.
+	fn is_propagateable(&self) -> bool;
+}
+
+/// Transaction pool interface.
+pub trait TransactionPool: Send + Sync {
+	/// Block type.
+	type Block: BlockT;
+	/// Transaction hash type.
+	type Hash: Hash + Eq + Member + Serialize;
+	/// In-pool transaction type.
+	type InPoolTransaction: InPoolTransaction<
+		Transaction = TransactionFor<Self>,
+		Hash = TxHash<Self>
+	>;
+	/// Error type.
+	type Error: From<error::Error> + IntoPoolError;
+
+	/// Returns a future that imports a bunch of unverified transactions to the pool.
+	fn submit_at(
+		&self,
+		at: &BlockId<Self::Block>,
+		xts: impl IntoIterator<Item=TransactionFor<Self>> + 'static,
+	) -> Box<dyn Future<Output=Result<
+		Vec<Result<TxHash<Self>, Self::Error>>,
+		Self::Error
+	>> + Send + Unpin>;
+
+	/// Returns a future that imports one unverified transaction to the pool.
+	fn submit_one(
+		&self,
+		at: &BlockId<Self::Block>,
+		xt: TransactionFor<Self>,
+	) -> Box<dyn Future<Output=Result<
+		TxHash<Self>,
+		Self::Error
+	>> + Send + Unpin>;
+
+	/// Returns a future that import a single transaction and starts to watch their progress in the pool.
+	fn submit_and_watch(
+		&self,
+		at: &BlockId<Self::Block>,
+		xt: TransactionFor<Self>,
+	) -> Box<dyn Future<Output=Result<Box<TransactionStatusStreamFor<Self>>, Self::Error>> + Send + Unpin>;
+
+	/// Remove transactions identified by given hashes (and dependent transactions) from the pool.
+	fn remove_invalid(&self, hashes: &[TxHash<Self>]) -> Vec<Arc<Self::InPoolTransaction>>;
+
+	/// Returns pool status.
+	fn status(&self) -> PoolStatus;
+
+	/// Get an iterator for ready transactions ordered by priority
+	fn ready(&self) -> Box<dyn Iterator<Item=Arc<Self::InPoolTransaction>>>;
+
+	/// Return an event stream of transactions imported to the pool.
+	fn import_notification_stream(&self) -> ImportNotificationStream;
+
+	/// Returns transaction hash
+	fn hash_of(&self, xt: &TransactionFor<Self>) -> TxHash<Self>;
+
+	/// Notify the pool about transactions broadcast.
+	fn on_broadcasted(&self, propagations: HashMap<TxHash<Self>, Vec<String>>);
+}
+
+/// An abstraction for transaction pool.
+///
+/// This trait is used by offchain calls to be able to submit transactions.
+/// The main use case is for offchain workers, to feed back the results of computations,
+/// but since the transaction pool access is a separate `ExternalitiesExtension` it can
+/// be also used in context of other offchain calls. For one may generate and submit
+/// a transaction for some misbehavior reports (say equivocation).
+pub trait OffchainSubmitTransaction<Block: BlockT>: Send + Sync {
+	/// Submit transaction.
+	///
+	/// The transaction will end up in the pool and be propagated to others.
+	fn submit_at(
+		&self,
+		at: &BlockId<Block>,
+		extrinsic: Block::Extrinsic,
+	) -> Result<(), ()>;
+}
+
+impl<TPool: TransactionPool> OffchainSubmitTransaction<TPool::Block> for TPool {
+	fn submit_at(
+		&self,
+		at: &BlockId<TPool::Block>,
+		extrinsic: <TPool::Block as BlockT>::Extrinsic,
+	) -> Result<(), ()> {
+		log::debug!(
+			target: "txpool",
+			"(offchain call) Submitting a transaction to the pool: {:?}",
+			extrinsic
+		);
+
+		let result = futures::executor::block_on(self.submit_one(&at, extrinsic));
+
+		result.map(|_| ())
+			.map_err(|e| log::warn!(
+				target: "txpool",
+				"(offchain call) Error submitting a transaction to the pool: {:?}",
+				e
+			))
+	}
+}
+
+/// Transaction pool maintainer interface.
+pub trait TransactionPoolMaintainer: Send + Sync {
+	/// Block type.
+	type Block: BlockT;
+	/// Transaction Hash type.
+	type Hash: Hash + Eq + Member + Serialize;
+
+	/// Returns a future that performs maintenance procedures on the pool when
+	/// with given hash is imported.
+	fn maintain(
+		&self,
+		id: &BlockId<Self::Block>,
+		retracted: &[Self::Hash],
+	) -> Box<dyn Future<Output=()> + Send + Unpin>;
+}
+
+/// Maintainable pool implementation.
+pub struct MaintainableTransactionPool<Pool, Maintainer> {
+	pool: Pool,
+	maintainer: Maintainer,
+}
+
+impl<Pool, Maintainer> MaintainableTransactionPool<Pool, Maintainer> {
+	/// Create new maintainable pool using underlying pool and maintainer.
+	pub fn new(pool: Pool, maintainer: Maintainer) -> Self {
+		MaintainableTransactionPool { pool, maintainer }
+	}
+}
+
+impl<Pool, Maintainer> TransactionPool for MaintainableTransactionPool<Pool, Maintainer>
+	where
+		Pool: TransactionPool,
+		Maintainer: Send + Sync,
+{
+	type Block = Pool::Block;
+	type Hash = Pool::Hash;
+	type InPoolTransaction = Pool::InPoolTransaction;
+	type Error = Pool::Error;
+
+	fn submit_at(
+		&self,
+		at: &BlockId<Self::Block>,
+		xts: impl IntoIterator<Item=TransactionFor<Self>> + 'static,
+	) -> Box<dyn Future<Output=Result<Vec<Result<TxHash<Self>, Self::Error>>, Self::Error>> + Send + Unpin> {
+		self.pool.submit_at(at, xts)
+	}
+
+	fn submit_one(
+		&self,
+		at: &BlockId<Self::Block>,
+		xt: TransactionFor<Self>,
+	) -> Box<dyn Future<Output=Result<TxHash<Self>, Self::Error>> + Send + Unpin> {
+		self.pool.submit_one(at, xt)
+	}
+
+	fn submit_and_watch(
+		&self,
+		at: &BlockId<Self::Block>,
+		xt: TransactionFor<Self>,
+	) -> Box<dyn Future<Output=Result<Box<TransactionStatusStreamFor<Self>>, Self::Error>> + Send + Unpin> {
+		self.pool.submit_and_watch(at, xt)
+	}
+
+	fn remove_invalid(&self, hashes: &[TxHash<Self>]) -> Vec<Arc<Self::InPoolTransaction>> {
+		self.pool.remove_invalid(hashes)
+	}
+
+	fn status(&self) -> PoolStatus {
+		self.pool.status()
+	}
+
+	fn ready(&self) -> Box<dyn Iterator<Item=Arc<Self::InPoolTransaction>>> {
+		self.pool.ready()
+	}
+
+	fn import_notification_stream(&self) -> ImportNotificationStream {
+		self.pool.import_notification_stream()
+	}
+
+	fn hash_of(&self, xt: &TransactionFor<Self>) -> TxHash<Self> {
+		self.pool.hash_of(xt)
+	}
+
+	fn on_broadcasted(&self, propagations: HashMap<TxHash<Self>, Vec<String>>) {
+		self.pool.on_broadcasted(propagations)
+	}
+}
+
+impl<Pool, Maintainer> TransactionPoolMaintainer for MaintainableTransactionPool<Pool, Maintainer>
+	where
+		Pool: Send + Sync,
+		Maintainer: TransactionPoolMaintainer
+{
+	type Block = Maintainer::Block;
+	type Hash = Maintainer::Hash;
+
+	fn maintain(
+		&self,
+		id: &BlockId<Self::Block>,
+		retracted: &[Self::Hash],
+	) -> Box<dyn Future<Output=()> + Send + Unpin> {
+		self.maintainer.maintain(id, retracted)
+	}
+}