1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
// Copyright 2019-2020 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, pin::Pin, }; 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. /// /// This events are being emitted by `TransactionPool` watchers, /// which are also exposed over RPC. /// /// The status events can be grouped based on their kinds as: /// 1. Entering/Moving within the pool: /// - `Future` /// - `Ready` /// 2. Inside `Ready` queue: /// - `Broadcast` /// 3. Leaving the pool: /// - `InBlock` /// - `Invalid` /// - `Usurped` /// - `Dropped` /// 4. Re-entering the pool: /// - `Retracted` /// 5. Block finalized: /// - `Finalized` /// - `FinalityTimeout` /// /// The events will always be received in the order described above, however /// there might be cases where transactions alternate between `Future` and `Ready` /// pool, and are `Broadcast` in the meantime. /// /// There is also only single event causing the transaction to leave the pool. /// I.e. only one of the listed ones should be triggered. /// /// Note that there are conditions that may cause transactions to reappear in the pool. /// 1. Due to possible forks, the transaction that ends up being in included /// in one block, may later re-enter the pool or be marked as invalid. /// 2. Transaction `Dropped` at one point, may later re-enter the pool if some other /// transactions are removed. /// 3. `Invalid` transaction may become valid at some point in the future. /// (Note that runtimes are encouraged to use `UnknownValidity` to inform the pool about /// such case). /// 4. `Retracted` transactions might be included in some next block. /// /// The stream is considered finished only when either `Finalized` or `FinalityTimeout` /// event is triggered. You are however free to unsubscribe from notifications at any point. /// The first one will be emitted when the block, in which transaction was included gets /// finalized. The `FinalityTimeout` event will be emitted when the block did not reach finality /// within 512 blocks. This either indicates that finality is not available for your chain, /// or that finality gadget is lagging behind. If you choose to wait for finality longer, you can /// re-subscribe for a particular transaction hash manually again. #[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, /// The transaction has been broadcast to the given peers. Broadcast(Vec<String>), /// Transaction has been included in block with given hash. InBlock(BlockHash), /// The block this transaction was included in has been retracted. Retracted(BlockHash), /// Maximum number of finality watchers has been reached, /// old watchers are being removed. FinalityTimeout(BlockHash), /// Transaction has been finalized by a finality-gadget, e.g GRANDPA Finalized(BlockHash), /// Transaction has been replaced in the pool, by another transaction /// that provides the same tags. (e.g. same (sender, nonce)). Usurped(Hash), /// Transaction has been dropped from the pool because of the limit. Dropped, /// Transaction is no longer valid in the current state. 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<H> = mpsc::UnboundedReceiver<H>; /// 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>>; /// Typical future type used in transaction pool api. pub type PoolFuture<T, E> = std::pin::Pin<Box<dyn Future<Output=Result<T, E>> + Send>>; /// 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_propagable(&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; // *** RPC /// Returns a future that imports a bunch of unverified transactions to the pool. fn submit_at( &self, at: &BlockId<Self::Block>, xts: Vec<TransactionFor<Self>>, ) -> PoolFuture<Vec<Result<TxHash<Self>, Self::Error>>, Self::Error>; /// Returns a future that imports one unverified transaction to the pool. fn submit_one( &self, at: &BlockId<Self::Block>, xt: TransactionFor<Self>, ) -> PoolFuture<TxHash<Self>, Self::Error>; /// 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>, ) -> PoolFuture<Box<TransactionStatusStreamFor<Self>>, Self::Error>; // *** Block production / Networking /// Get an iterator for ready transactions ordered by priority fn ready(&self) -> Box<dyn Iterator<Item=Arc<Self::InPoolTransaction>>>; // *** Block production /// Remove transactions identified by given hashes (and dependent transactions) from the pool. fn remove_invalid(&self, hashes: &[TxHash<Self>]) -> Vec<Arc<Self::InPoolTransaction>>; // *** logging /// Returns pool status. fn status(&self) -> PoolStatus; // *** logging / RPC / networking /// Return an event stream of transactions imported to the pool. fn import_notification_stream(&self) -> ImportNotificationStream<TxHash<Self>>; // *** networking /// Notify the pool about transactions broadcast. fn on_broadcasted(&self, propagations: HashMap<TxHash<Self>, Vec<String>>); /// Returns transaction hash fn hash_of(&self, xt: &TransactionFor<Self>) -> TxHash<Self>; /// Return specific ready transaction by hash, if there is one. fn ready_transaction(&self, hash: &TxHash<Self>) -> Option<Arc<Self::InPoolTransaction>>; } /// Events that the transaction pool listens for. pub enum ChainEvent<B: BlockT> { /// New blocks have been added to the chain NewBlock { /// Is this the new best block. is_new_best: bool, /// Id of the just imported block. id: BlockId<B>, /// Header of the just imported block header: B::Header, /// List of retracted blocks ordered by block number. retracted: Vec<B::Hash>, }, /// An existing block has been finalized. Finalized { /// Hash of just finalized block hash: B::Hash, }, } /// Trait for transaction pool maintenance. pub trait MaintainedTransactionPool: TransactionPool { /// Perform maintenance fn maintain(&self, event: ChainEvent<Self::Block>) -> Pin<Box<dyn Future<Output=()> + Send>>; } /// 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 )) } }