github/reth
1
1
Fork 0
mirror of https://github.com/paradigmxyz/reth.git synced 2026-01-28 16:48:13 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs(txpool): clarify ParkedPool transaction type (#1671)

Browse Source
This commit is contained in:
Matthias Seitz
2023-03-08 13:57:37 +01:00
committed by GitHub
parent 77d108660e
commit 2c6a35929e
1 changed files with 8 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
crates/transaction-pool/src/pool/parked.rs
View File

@@ -4,10 +4,15 @@ use crate::{
use fnv::FnvHashMap;
use std::{cmp::Ordering, collections::BTreeSet, ops::Deref, sync::Arc};
/// A pool of transaction that are currently parked and wait for external changes that eventually
/// move the transaction into the pending pool.
/// A pool of transactions that are currently parked and are waiting for external changes (e.g.
/// basefee, ancestor transactions, balance) that eventually move the transaction into the pending
/// pool.
///
/// This pool is a bijection: at all times each set contains the same transactions.
/// This pool is a bijection: at all times each set (`best`, `by_id`) contains the same
/// transactions.
///
/// Note: This type is generic over [ParkedPool] which enforces that the underlying transaction type
/// is [ValidPoolTransaction] wrapped in an [Arc].
pub(crate) struct ParkedPool<T: ParkedOrd> {
/// Keeps track of transactions inserted in the pool.
///