mirror of
https://github.com/pezkuwichain/pezkuwi-subxt.git
synced 2026-06-12 21:41:12 +00:00
Merge txpool-runtime-api with txpool-api (#4320)
* Remove transaction-pool-runtime-api * Merge runtime-api with transaction-pool.
This commit is contained in:
Tomasz Drwięga
committed by
Bastian Köcher
Bastian Köcher
parent
70db5da6c4
commit
3805393a13
@@ -68,15 +68,15 @@ pub enum Error {
|
||||
impl std::error::Error for Error {}
|
||||
|
||||
/// Transaction pool error conversion.
|
||||
pub trait IntoPoolError: ::std::error::Error + Send + Sized {
|
||||
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) }
|
||||
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) }
|
||||
fn into_pool_error(self) -> std::result::Result<Error, Self> { Ok(self) }
|
||||
}
|
||||
|
||||
@@ -14,315 +14,20 @@
|
||||
// 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.
|
||||
//! Transaction pool primitives types & Runtime API.
|
||||
|
||||
#![warn(missing_docs)]
|
||||
#![cfg_attr(not(feature = "std"), no_std)]
|
||||
|
||||
pub mod runtime_api;
|
||||
#[cfg(feature = "std")]
|
||||
pub mod error;
|
||||
#[cfg(feature = "std")]
|
||||
mod pool;
|
||||
|
||||
#[cfg(feature = "std")]
|
||||
pub use pool::*;
|
||||
|
||||
pub use error::IntoPoolError;
|
||||
pub use sp_runtime::transaction_validity::{
|
||||
TransactionLongevity, TransactionPriority, TransactionTag,
|
||||
};
|
||||
|
||||
use std::{
|
||||
collections::HashMap,
|
||||
hash::Hash,
|
||||
sync::Arc,
|
||||
};
|
||||
use futures::{
|
||||
Future, Stream,
|
||||
channel::mpsc,
|
||||
};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use sp_runtime::{
|
||||
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 `sp_runtime::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)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -0,0 +1,322 @@
|
||||
// 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 primitives types & Runtime API.
|
||||
|
||||
use std::{
|
||||
collections::HashMap,
|
||||
hash::Hash,
|
||||
sync::Arc,
|
||||
};
|
||||
use futures::{
|
||||
Future, Stream,
|
||||
channel::mpsc,
|
||||
};
|
||||
use serde::{Deserialize, Serialize};
|
||||
use sp_runtime::{
|
||||
generic::BlockId,
|
||||
traits::{Block as BlockT, Member},
|
||||
transaction_validity::{
|
||||
TransactionLongevity, TransactionPriority, TransactionTag,
|
||||
},
|
||||
};
|
||||
|
||||
/// 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 `sp_runtime::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<crate::error::Error> + crate::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)
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,28 @@
|
||||
// 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/>.
|
||||
|
||||
//! Tagged Transaction Queue Runtime API.
|
||||
|
||||
use sp_runtime::transaction_validity::TransactionValidity;
|
||||
use sp_runtime::traits::Block as BlockT;
|
||||
|
||||
sp_api::decl_runtime_apis! {
|
||||
/// The `TaggedTransactionQueue` api trait for interfering with the transaction queue.
|
||||
pub trait TaggedTransactionQueue {
|
||||
/// Validate the given transaction.
|
||||
fn validate_transaction(tx: <Block as BlockT>::Extrinsic) -> TransactionValidity;
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user