sc_transaction_pool/fork_aware_txpool/view_store.rs
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 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910
// 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 view store. Basically block hash to view map with some utility methods.
use super::{
multi_view_listener::{MultiViewListener, TxStatusStream},
view::{View, ViewPoolObserver},
};
use crate::{
fork_aware_txpool::dropped_watcher::MultiViewDroppedWatcherController,
graph::{
self,
base_pool::{TimedTransactionSource, Transaction},
BaseSubmitOutcome, BlockHash, ExtrinsicFor, ExtrinsicHash, TransactionFor,
ValidatedPoolSubmitOutcome,
},
ReadyIteratorFor, LOG_TARGET,
};
use itertools::Itertools;
use parking_lot::RwLock;
use sc_transaction_pool_api::{error::Error as PoolError, PoolStatus, TxInvalidityReportMap};
use sp_blockchain::{HashAndNumber, TreeRoute};
use sp_runtime::{
generic::BlockId,
traits::{Block as BlockT, Saturating},
transaction_validity::{InvalidTransaction, TransactionValidityError},
};
use std::{
collections::{hash_map::Entry, HashMap, HashSet},
sync::Arc,
time::Instant,
};
use tracing::{trace, warn};
/// Helper struct to maintain the context for pending transaction submission, executed for
/// newly inserted views.
#[derive(Clone)]
struct PendingTxSubmission<ChainApi>
where
ChainApi: graph::ChainApi,
{
/// New transaction replacing the old one.
xt: ExtrinsicFor<ChainApi>,
/// Source of the transaction.
source: TimedTransactionSource,
}
/// Helper type representing the callback allowing to trigger per-transaction events on
/// `ValidatedPool`'s listener.
type RemovalCallback<ChainApi> = Arc<
dyn Fn(
&mut crate::graph::EventDispatcher<ChainApi, ViewPoolObserver<ChainApi>>,
ExtrinsicHash<ChainApi>,
) + Send
+ Sync,
>;
/// Helper struct to maintain the context for pending transaction removal, executed for
/// newly inserted views.
struct PendingTxRemoval<ChainApi>
where
ChainApi: graph::ChainApi,
{
/// Hash of the transaction that will be removed,
xt_hash: ExtrinsicHash<ChainApi>,
/// Action that shall be executed on underlying `ValidatedPool`'s listener.
listener_action: RemovalCallback<ChainApi>,
}
/// This enum represents an action that should be executed on the newly built
/// view before this view is inserted into the view store.
enum PreInsertAction<ChainApi>
where
ChainApi: graph::ChainApi,
{
/// Represents the action of submitting a new transaction. Intended to use to handle usurped
/// transactions.
SubmitTx(PendingTxSubmission<ChainApi>),
/// Represents the action of removing a subtree of transactions.
RemoveSubtree(PendingTxRemoval<ChainApi>),
}
/// Represents a task awaiting execution, to be performed immediately prior to the view insertion
/// into the view store.
struct PendingPreInsertTask<ChainApi>
where
ChainApi: graph::ChainApi,
{
/// The action to be applied when inserting a new view.
action: PreInsertAction<ChainApi>,
/// Indicates if the action was already applied to all the views in the view_store.
/// If true, it can be removed after inserting any new view.
processed: bool,
}
impl<ChainApi> PendingPreInsertTask<ChainApi>
where
ChainApi: graph::ChainApi,
{
/// Creates new unprocessed instance of pending transaction submission.
fn new_submission_action(xt: ExtrinsicFor<ChainApi>, source: TimedTransactionSource) -> Self {
Self {
processed: false,
action: PreInsertAction::SubmitTx(PendingTxSubmission { xt, source }),
}
}
/// Creates new unprocessed instance of pending transaction removal.
fn new_removal_action(
xt_hash: ExtrinsicHash<ChainApi>,
listener: RemovalCallback<ChainApi>,
) -> Self {
Self {
processed: false,
action: PreInsertAction::RemoveSubtree(PendingTxRemoval {
xt_hash,
listener_action: listener,
}),
}
}
/// Marks a task as done for every view present in view store. Basically means that can be
/// removed on new view insertion.
fn mark_processed(&mut self) {
self.processed = true;
}
}
/// The helper structure encapsulates all the views.
pub(super) struct ViewStore<ChainApi, Block>
where
Block: BlockT,
ChainApi: graph::ChainApi<Block = Block>,
{
/// The blockchain api.
pub(super) api: Arc<ChainApi>,
/// Active views at tips of the forks.
///
/// Active views are updated with incoming transactions.
pub(super) active_views: RwLock<HashMap<Block::Hash, Arc<View<ChainApi>>>>,
/// Inactive views at intermediary blocks that are no longer tips of the forks.
///
/// Inactive views are not updated with incoming transactions, while they can still be used to
/// build new blocks upon them.
pub(super) inactive_views: RwLock<HashMap<Block::Hash, Arc<View<ChainApi>>>>,
/// Listener for controlling external watchers of transactions.
///
/// Provides a side-channel allowing to send per-transaction state changes notification.
pub(super) listener: Arc<MultiViewListener<ChainApi>>,
/// Most recent block processed by tx-pool. Used in the API functions that were not changed to
/// add `at` parameter.
pub(super) most_recent_view: RwLock<Option<Block::Hash>>,
/// The controller of multi view dropped stream.
pub(super) dropped_stream_controller: MultiViewDroppedWatcherController<ChainApi>,
/// The map used to synchronize replacement of transactions between maintain and dropped
/// notifcication threads. It is meant to assure that replaced transaction is also removed from
/// newly built views in maintain process.
///
/// The map's key is hash of actionable extrinsic (to avoid duplicated entries).
pending_txs_tasks: RwLock<HashMap<ExtrinsicHash<ChainApi>, PendingPreInsertTask<ChainApi>>>,
}
/// Type alias to outcome of submission to `ViewStore`.
pub(super) type ViewStoreSubmitOutcome<ChainApi> =
BaseSubmitOutcome<ChainApi, TxStatusStream<ChainApi>>;
impl<ChainApi: graph::ChainApi> From<ValidatedPoolSubmitOutcome<ChainApi>>
for ViewStoreSubmitOutcome<ChainApi>
{
fn from(value: ValidatedPoolSubmitOutcome<ChainApi>) -> Self {
Self::new(value.hash(), value.priority())
}
}
impl<ChainApi, Block> ViewStore<ChainApi, Block>
where
Block: BlockT,
ChainApi: graph::ChainApi<Block = Block> + 'static,
<Block as BlockT>::Hash: Unpin,
{
/// Creates a new empty view store.
pub(super) fn new(
api: Arc<ChainApi>,
listener: Arc<MultiViewListener<ChainApi>>,
dropped_stream_controller: MultiViewDroppedWatcherController<ChainApi>,
) -> Self {
Self {
api,
active_views: Default::default(),
inactive_views: Default::default(),
listener,
most_recent_view: RwLock::from(None),
dropped_stream_controller,
pending_txs_tasks: Default::default(),
}
}
/// Imports a bunch of unverified extrinsics to every active view.
pub(super) async fn submit(
&self,
xts: impl IntoIterator<Item = (TimedTransactionSource, ExtrinsicFor<ChainApi>)> + Clone,
) -> HashMap<Block::Hash, Vec<Result<ViewStoreSubmitOutcome<ChainApi>, ChainApi::Error>>> {
let submit_futures = {
let active_views = self.active_views.read();
active_views
.iter()
.map(|(_, view)| {
let view = view.clone();
let xts = xts.clone();
async move {
(
view.at.hash,
view.submit_many(xts)
.await
.into_iter()
.map(|r| r.map(Into::into))
.collect::<Vec<_>>(),
)
}
})
.collect::<Vec<_>>()
};
let results = futures::future::join_all(submit_futures).await;
HashMap::<_, _>::from_iter(results.into_iter())
}
/// Synchronously imports single unverified extrinsics into every active view.
pub(super) fn submit_local(
&self,
xt: ExtrinsicFor<ChainApi>,
) -> Result<ViewStoreSubmitOutcome<ChainApi>, ChainApi::Error> {
let active_views = self
.active_views
.read()
.iter()
.map(|(_, view)| view.clone())
.collect::<Vec<_>>();
let tx_hash = self.api.hash_and_length(&xt).0;
let result = active_views
.iter()
.map(|view| view.submit_local(xt.clone()))
.find_or_first(Result::is_ok);
match result {
Some(Err(error)) => {
trace!(
target: LOG_TARGET,
?tx_hash,
%error,
"submit_local failed"
);
Err(error)
},
None => Ok(ViewStoreSubmitOutcome::new(tx_hash, None)),
Some(Ok(r)) => Ok(r.into()),
}
}
/// Import a single extrinsic and starts to watch its progress in the pool.
///
/// The extrinsic is imported to every view, and the individual streams providing the progress
/// of this transaction within every view are added to the multi view listener.
///
/// The external stream of aggregated/processed events provided by the `MultiViewListener`
/// instance is returned.
pub(super) async fn submit_and_watch(
&self,
_at: Block::Hash,
source: TimedTransactionSource,
xt: ExtrinsicFor<ChainApi>,
) -> Result<ViewStoreSubmitOutcome<ChainApi>, ChainApi::Error> {
let tx_hash = self.api.hash_and_length(&xt).0;
let Some(external_watcher) = self.listener.create_external_watcher_for_tx(tx_hash) else {
return Err(PoolError::AlreadyImported(Box::new(tx_hash)).into())
};
let submit_futures = {
let active_views = self.active_views.read();
active_views
.iter()
.map(|(_, view)| {
let view = view.clone();
let xt = xt.clone();
let source = source.clone();
async move { view.submit_one(source, xt).await }
})
.collect::<Vec<_>>()
};
let result = futures::future::join_all(submit_futures)
.await
.into_iter()
.find_or_first(Result::is_ok);
match result {
Some(Err(error)) => {
trace!(
target: LOG_TARGET,
?tx_hash,
%error,
"submit_and_watch failed"
);
return Err(error);
},
Some(Ok(result)) =>
Ok(ViewStoreSubmitOutcome::from(result).with_watcher(external_watcher)),
None => Ok(ViewStoreSubmitOutcome::new(tx_hash, None).with_watcher(external_watcher)),
}
}
/// Returns the pool status for every active view.
pub(super) fn status(&self) -> HashMap<Block::Hash, PoolStatus> {
self.active_views.read().iter().map(|(h, v)| (*h, v.status())).collect()
}
/// Returns true if there are no active views.
pub(super) fn is_empty(&self) -> bool {
self.active_views.read().is_empty() && self.inactive_views.read().is_empty()
}
/// Finds the best existing active view to clone from along the path.
///
/// ```text
/// Tree route from R1 to E2.
/// <- R3 <- R2 <- R1
/// /
/// C
/// \-> E1 -> E2
/// ```
/// ```text
/// Search path is:
/// [E1, C, R3, R2, R1]
/// ```
pub(super) fn find_best_view(
&self,
tree_route: &TreeRoute<Block>,
) -> Option<Arc<View<ChainApi>>> {
let active_views = self.active_views.read();
let best_view = {
tree_route
.retracted()
.iter()
.chain(std::iter::once(tree_route.common_block()))
.chain(tree_route.enacted().iter())
.rev()
.find(|block| active_views.contains_key(&block.hash))
};
best_view.map(|h| {
active_views
.get(&h.hash)
.expect("hash was just found in the map's keys. qed")
.clone()
})
}
/// Returns an iterator for ready transactions for the most recently notified best block.
///
/// The iterator for future transactions is returned if the most recently notified best block,
/// for which maintain process was accomplished, exists.
pub(super) fn ready(&self) -> ReadyIteratorFor<ChainApi> {
let ready_iterator = self
.most_recent_view
.read()
.map(|at| self.get_view_at(at, true))
.flatten()
.map(|(v, _)| v.pool.validated_pool().ready());
if let Some(ready_iterator) = ready_iterator {
return Box::new(ready_iterator)
} else {
return Box::new(std::iter::empty())
}
}
/// Returns a list of future transactions for the most recently notified best block.
///
/// The set of future transactions is returned if the most recently notified best block, for
/// which maintain process was accomplished, exists.
pub(super) fn futures(
&self,
) -> Vec<Transaction<ExtrinsicHash<ChainApi>, ExtrinsicFor<ChainApi>>> {
self.most_recent_view
.read()
.map(|at| self.futures_at(at))
.flatten()
.unwrap_or_default()
}
/// Returns a list of future transactions in the view at given block hash.
pub(super) fn futures_at(
&self,
at: Block::Hash,
) -> Option<Vec<Transaction<ExtrinsicHash<ChainApi>, ExtrinsicFor<ChainApi>>>> {
self.get_view_at(at, true)
.map(|(v, _)| v.pool.validated_pool().pool.read().futures().cloned().collect())
}
/// Collects all the transactions included in the blocks on the provided `tree_route` and
/// triggers finalization event for them.
///
/// The finalization event is sent using side-channel of the multi view `listener`.
///
/// Returns the list of finalized transactions hashes.
pub(super) async fn finalize_route(
&self,
finalized_hash: Block::Hash,
tree_route: &[Block::Hash],
) -> Vec<ExtrinsicHash<ChainApi>> {
trace!(
target: LOG_TARGET,
?finalized_hash,
?tree_route,
"finalize_route"
);
let mut finalized_transactions = Vec::new();
for block in tree_route.iter().chain(std::iter::once(&finalized_hash)) {
let extrinsics = self
.api
.block_body(*block)
.await
.unwrap_or_else(|error| {
warn!(
target: LOG_TARGET,
%error,
"Finalize route: error request"
);
None
})
.unwrap_or_default()
.iter()
.map(|e| self.api.hash_and_length(&e).0)
.collect::<Vec<_>>();
extrinsics
.iter()
.enumerate()
.for_each(|(i, tx_hash)| self.listener.transaction_finalized(*tx_hash, *block, i));
finalized_transactions.extend(extrinsics);
}
finalized_transactions
}
/// Return specific ready transaction by hash, if there is one.
///
/// Currently the ready transaction is returned if it exists for the most recently notified best
/// block (for which maintain process was accomplished).
pub(super) fn ready_transaction(
&self,
at: Block::Hash,
tx_hash: &ExtrinsicHash<ChainApi>,
) -> Option<TransactionFor<ChainApi>> {
self.active_views
.read()
.get(&at)
.and_then(|v| v.pool.validated_pool().ready_by_hash(tx_hash))
}
/// Inserts new view into the view store.
///
/// All the views associated with the blocks which are on enacted path (including common
/// ancestor) will be:
/// - moved to the inactive views set (`inactive_views`),
/// - removed from the multi view listeners.
///
/// The `most_recent_view` is updated with the reference to the newly inserted view.
///
/// If there are any pending tx replacments, they are applied to the new view.
pub(super) async fn insert_new_view(
&self,
view: Arc<View<ChainApi>>,
tree_route: &TreeRoute<Block>,
) {
self.apply_pending_tx_replacements(view.clone()).await;
//note: most_recent_view must be synced with changes in in/active_views.
{
let mut most_recent_view_lock = self.most_recent_view.write();
let mut active_views = self.active_views.write();
let mut inactive_views = self.inactive_views.write();
std::iter::once(tree_route.common_block())
.chain(tree_route.enacted().iter())
.map(|block| block.hash)
.for_each(|hash| {
active_views.remove(&hash).map(|view| {
inactive_views.insert(hash, view);
});
});
active_views.insert(view.at.hash, view.clone());
most_recent_view_lock.replace(view.at.hash);
};
trace!(
target: LOG_TARGET,
inactive_views = ?self.inactive_views.read().keys(),
"insert_new_view"
);
}
/// Returns an optional reference to the view at given hash.
///
/// If `allow_retracted` flag is set, inactive views are also searched.
///
/// If the view at provided hash does not exist `None` is returned.
pub(super) fn get_view_at(
&self,
at: Block::Hash,
allow_inactive: bool,
) -> Option<(Arc<View<ChainApi>>, bool)> {
if let Some(view) = self.active_views.read().get(&at) {
return Some((view.clone(), false));
}
if allow_inactive {
if let Some(view) = self.inactive_views.read().get(&at) {
return Some((view.clone(), true))
}
};
None
}
/// The finalization event handle for the view store.
///
/// Views that have associated block number less than finalized block number are removed from
/// both active and inactive set.
///
/// Note: the views with the associated number greater than finalized block number on the forks
/// that are not finalized will stay in the view store. They will be removed in the future, once
/// new finalized blocks will be notified. This is to avoid scanning for common ancestors.
///
/// All watched transactions in the blocks from the tree_route will be notified with `Finalized`
/// event.
///
/// Returns the list of hashes of all finalized transactions along the provided `tree_route`.
pub(crate) async fn handle_finalized(
&self,
finalized_hash: Block::Hash,
tree_route: &[Block::Hash],
) -> Vec<ExtrinsicHash<ChainApi>> {
let finalized_xts = self.finalize_route(finalized_hash, tree_route).await;
let finalized_number = self.api.block_id_to_number(&BlockId::Hash(finalized_hash));
let mut dropped_views = vec![];
//clean up older then finalized
{
let mut active_views = self.active_views.write();
let mut inactive_views = self.inactive_views.write();
active_views.retain(|hash, v| {
let retain = match finalized_number {
Err(_) | Ok(None) => *hash == finalized_hash,
Ok(Some(n)) if v.at.number == n => *hash == finalized_hash,
Ok(Some(n)) => v.at.number > n,
};
if !retain {
dropped_views.push(*hash);
}
retain
});
inactive_views.retain(|hash, v| {
let retain = match finalized_number {
Err(_) | Ok(None) => false,
Ok(Some(n)) => v.at.number >= n,
};
if !retain {
dropped_views.push(*hash);
}
retain
});
trace!(
target: LOG_TARGET,
inactive_views = ?inactive_views.keys(),
"handle_finalized"
);
}
trace!(
target: LOG_TARGET,
?dropped_views,
"handle_finalized"
);
self.listener.remove_stale_controllers();
self.dropped_stream_controller.remove_transactions(finalized_xts.clone());
self.listener.remove_view(finalized_hash);
for view in dropped_views {
self.listener.remove_view(view);
self.dropped_stream_controller.remove_view(view);
}
finalized_xts
}
/// Terminates all the ongoing background views revalidations triggered at the end of maintain
/// process.
///
/// Refer to [*View revalidation*](../index.html#view-revalidation) for more details.
pub(crate) async fn finish_background_revalidations(&self) {
let start = Instant::now();
let finish_revalidation_futures = {
let active_views = self.active_views.read();
active_views
.iter()
.map(|(_, view)| {
let view = view.clone();
async move { view.finish_revalidation().await }
})
.collect::<Vec<_>>()
};
futures::future::join_all(finish_revalidation_futures).await;
trace!(
target: LOG_TARGET,
duration = ?start.elapsed(),
"finish_background_revalidations"
);
}
/// Reports invalid transactions to the view store.
///
/// This function accepts an array of tuples, each containing a transaction hash and an
/// optional error encountered during the transaction execution at a specific (also optional)
/// block.
///
/// Removal operation applies to provided transactions. Their descendants can be removed from
/// the view, but will not be invalidated or banned.
///
/// Invalid future and stale transaction will be removed only from given `at` view, and will be
/// kept in the view_store. Such transaction will not be reported in returned vector. They
/// also will not be banned from re-entering the pool. No event will be triggered.
///
/// For other errors, the transaction will be removed from the view_store, and it will be
/// included in the returned vector. Additionally, transactions provided as input will be banned
/// from re-entering the pool.
///
/// If the tuple's error is None, the transaction will be forcibly removed from the view_store,
/// banned and included into the returned vector.
///
/// For every transaction removed from the view_store (excluding descendants) an Invalid event
/// is triggered.
///
/// Returns the list of actually removed transactions from the mempool, which were included in
/// the provided input list.
pub(crate) fn report_invalid(
&self,
at: Option<Block::Hash>,
invalid_tx_errors: TxInvalidityReportMap<ExtrinsicHash<ChainApi>>,
) -> Vec<TransactionFor<ChainApi>> {
let mut remove_from_view = vec![];
let mut remove_from_pool = vec![];
invalid_tx_errors.into_iter().for_each(|(hash, e)| match e {
Some(TransactionValidityError::Invalid(
InvalidTransaction::Future | InvalidTransaction::Stale,
)) => {
remove_from_view.push(hash);
},
_ => {
remove_from_pool.push(hash);
},
});
// transaction removed from view, won't be included into the final result, as they may still
// be in the pool.
at.map(|at| {
self.get_view_at(at, true)
.map(|(view, _)| view.remove_subtree(&remove_from_view, false, |_, _| {}))
});
let mut removed = vec![];
for tx_hash in &remove_from_pool {
let removed_from_pool = self.remove_transaction_subtree(*tx_hash, |_, _| {});
removed_from_pool
.iter()
.find(|tx| tx.hash == *tx_hash)
.map(|tx| removed.push(tx.clone()));
}
self.listener.transactions_invalidated(&remove_from_pool);
removed
}
/// Replaces an existing transaction in the view_store with a new one.
///
/// Attempts to replace a transaction identified by `replaced` with a new transaction `xt`.
///
/// Before submitting a transaction to the views, the new *unprocessed* transaction replacement
/// record will be inserted into a pending replacement map. Once the submission to all the views
/// is accomplished, the record is marked as *processed*.
///
/// This map is later applied in `insert_new_view` method executed from different thread.
///
/// If the transaction is already being replaced, it will simply return without making
/// changes.
pub(super) async fn replace_transaction(
&self,
source: TimedTransactionSource,
xt: ExtrinsicFor<ChainApi>,
replaced: ExtrinsicHash<ChainApi>,
) {
if let Entry::Vacant(entry) = self.pending_txs_tasks.write().entry(replaced) {
entry.insert(PendingPreInsertTask::new_submission_action(xt.clone(), source.clone()));
} else {
return
};
let tx_hash = self.api.hash_and_length(&xt).0;
trace!(
target: LOG_TARGET,
?replaced,
?tx_hash,
"replace_transaction"
);
self.replace_transaction_in_views(source, xt, tx_hash, replaced).await;
if let Some(replacement) = self.pending_txs_tasks.write().get_mut(&replaced) {
replacement.mark_processed();
}
}
/// Applies pending transaction replacements to the specified view.
///
/// After application, all already processed replacements are removed.
async fn apply_pending_tx_replacements(&self, view: Arc<View<ChainApi>>) {
let mut futures = vec![];
for replacement in self.pending_txs_tasks.read().values() {
match replacement.action {
PreInsertAction::SubmitTx(ref submission) => {
let xt_hash = self.api.hash_and_length(&submission.xt).0;
futures.push(self.replace_transaction_in_view(
view.clone(),
submission.source.clone(),
submission.xt.clone(),
xt_hash,
));
},
PreInsertAction::RemoveSubtree(ref removal) => {
view.remove_subtree(&[removal.xt_hash], true, &*removal.listener_action);
},
}
}
let _results = futures::future::join_all(futures).await;
self.pending_txs_tasks.write().retain(|_, r| r.processed);
}
/// Submits `xt` to the given view.
///
/// For watched transaction stream is added to the listener.
async fn replace_transaction_in_view(
&self,
view: Arc<View<ChainApi>>,
source: TimedTransactionSource,
xt: ExtrinsicFor<ChainApi>,
tx_hash: ExtrinsicHash<ChainApi>,
) {
if let Err(error) = view.submit_one(source, xt).await {
trace!(
target: LOG_TARGET,
?tx_hash,
at_hash = ?view.at.hash,
%error,
"replace_transaction: submit failed"
);
}
}
/// Sends `xt` to every view (both active and inactive) containing `replaced` extrinsics.
///
/// It is assumed that transaction is already known by the pool. Intended to ba called when `xt`
/// is replacing `replaced` extrinsic.
async fn replace_transaction_in_views(
&self,
source: TimedTransactionSource,
xt: ExtrinsicFor<ChainApi>,
tx_hash: ExtrinsicHash<ChainApi>,
replaced: ExtrinsicHash<ChainApi>,
) {
let submit_futures = {
let active_views = self.active_views.read();
let inactive_views = self.inactive_views.read();
active_views
.iter()
.chain(inactive_views.iter())
.filter(|(_, view)| view.is_imported(&replaced))
.map(|(_, view)| {
self.replace_transaction_in_view(
view.clone(),
source.clone(),
xt.clone(),
tx_hash,
)
})
.collect::<Vec<_>>()
};
let _results = futures::future::join_all(submit_futures).await;
}
/// Removes a transaction subtree from every view in the view_store, starting from the given
/// transaction hash.
///
/// This function traverses the dependency graph of transactions and removes the specified
/// transaction along with all its descendant transactions from every view.
///
/// A `listener_action` callback function is invoked for every transaction that is removed,
/// providing a reference to the pool's listener and the hash of the removed transaction. This
/// allows to trigger the required events. Note that listener may be called multiple times for
/// the same hash.
///
/// Function will also schedule view pre-insertion actions to ensure that transactions will be
/// removed from newly created view.
///
/// Returns a vector containing the hashes of all removed transactions, including the root
/// transaction specified by `tx_hash`. Vector contains only unique hashes.
pub(super) fn remove_transaction_subtree<F>(
&self,
xt_hash: ExtrinsicHash<ChainApi>,
listener_action: F,
) -> Vec<TransactionFor<ChainApi>>
where
F: Fn(
&mut crate::graph::EventDispatcher<ChainApi, ViewPoolObserver<ChainApi>>,
ExtrinsicHash<ChainApi>,
) + Clone
+ Send
+ Sync
+ 'static,
{
if let Entry::Vacant(entry) = self.pending_txs_tasks.write().entry(xt_hash) {
entry.insert(PendingPreInsertTask::new_removal_action(
xt_hash,
Arc::from(listener_action.clone()),
));
};
let mut seen = HashSet::new();
let removed = self
.active_views
.read()
.iter()
.chain(self.inactive_views.read().iter())
.filter(|(_, view)| view.is_imported(&xt_hash))
.flat_map(|(_, view)| view.remove_subtree(&[xt_hash], true, &listener_action))
.filter_map(|xt| seen.insert(xt.hash).then(|| xt.clone()))
.collect();
if let Some(removal_action) = self.pending_txs_tasks.write().get_mut(&xt_hash) {
removal_action.mark_processed();
}
removed
}
/// Clears stale views when blockchain finality stalls.
///
/// This function removes outdated active and inactive views based on the block height
/// difference compared to the current block's height. Views are considered stale and
/// purged from the `ViewStore` if their height difference from the current block `at`
/// exceeds the specified `threshold`.
///
/// If any views are removed, corresponding cleanup operations are performed on multi-view
/// stream controllers to ensure views are also removed there.
pub(crate) fn finality_stall_view_cleanup(&self, at: &HashAndNumber<Block>, threshold: usize) {
let mut dropped_views = vec![];
{
let mut active_views = self.active_views.write();
let mut inactive_views = self.inactive_views.write();
let mut f = |hash: &BlockHash<ChainApi>, v: &View<ChainApi>| -> bool {
let diff = at.number.saturating_sub(v.at.number);
if diff.into() > threshold.into() {
dropped_views.push(*hash);
false
} else {
true
}
};
active_views.retain(|h, v| f(h, v));
inactive_views.retain(|h, v| f(h, v));
}
if !dropped_views.is_empty() {
for view in dropped_views {
self.listener.remove_view(view);
self.dropped_stream_controller.remove_view(view);
}
}
}
}