Struct PausedFeeTokenPool 

pub struct PausedFeeTokenPool {
    by_token: HashMap<Address, PausedTokenMeta>,
}

Pool for transactions whose fee token is temporarily paused.

Transactions are indexed by fee token address for efficient batch operations. Since all transactions for a token are paused/unpaused together, we track the pause timestamp at the token level rather than per-transaction.

Fields

by_token: HashMap<Address, PausedTokenMeta>

Fee token -> metadata including pause time and entries

Implementations

impl PausedFeeTokenPool

pub fn new() -> Self

Creates a new empty paused pool.

pub fn len(&self) -> usize

Returns the total number of paused transactions across all tokens.

pub fn is_empty(&self) -> bool

Returns true if there are no paused transactions.

pub fn insert_batch( &mut self, fee_token: Address, entries: Vec<PausedEntry>, ) -> usize

Inserts transactions for a fee token into the paused pool.

Takes the full batch at once since all transactions for a token are paused together. The pause timestamp is recorded at insertion time.

Enforces PAUSED_POOL_GLOBAL_CAP: if adding the batch would exceed the cap, the oldest-paused tokens are evicted first to make room. If the batch itself exceeds the cap, it is truncated.

Returns the number of existing entries that were evicted to make room.

fn evict_oldest(&mut self, need: usize) -> usize

Evicts at least need entries from the oldest-paused tokens.

Returns the total number of entries evicted.

pub fn drain_token(&mut self, fee_token: &Address) -> Vec<PausedEntry>

Drains all transactions for a given fee token.

Returns the list of paused entries for that token.

pub fn count_for_token(&self, fee_token: &Address) -> usize

Returns the number of transactions paused for a given fee token.

pub fn contains(&self, tx_hash: &TxHash) -> bool

Returns true if a transaction with the given hash is in the paused pool.

pub fn evict_expired(&mut self, tip_timestamp: u64) -> usize

Evicts expired transactions based on valid_before timestamp.

Returns the number of transactions removed.

pub fn evict_timed_out(&mut self) -> usize

Evicts all transactions for tokens that have been paused for too long (timeout).

Since all transactions for a token are paused together, we evict the entire token’s transactions when the token-level timeout expires.

Returns the number of transactions removed.

pub fn evict_invalidated( &mut self, revoked_keys: &RevokedKeys, spending_limit_updates: &SpendingLimitUpdates, spending_limit_spends: &SpendingLimitUpdates, ) -> usize

Removes transactions matching invalidation criteria from the paused pool.

This handles revoked keys, spending limit updates, and spending limit spends in a single pass. The spending_limit_spends parameter captures (account, key_id, fee_token) combos from keychain txs that were included in the block and decremented limits via verify_and_update_spending(). Uses account-keyed indexes for O(1) account lookup per transaction. Returns the number of transactions removed.

pub fn all_entries(&self) -> impl Iterator<Item = &PausedEntry>

Returns an iterator over all paused entries across all tokens.

Trait Implementations

impl Debug for PausedFeeTokenPool

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PausedFeeTokenPool

fn default() -> PausedFeeTokenPool

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 40 bytes