Struct TxHandlerCache

pub struct TxHandlerCache {
    pub prev_ready_to_reimburse: Option<TxHandler>,
    pub saved_txs: BTreeMap<TransactionType, TxHandler>,
}

Stores and manages cached transaction handlers for efficient flow construction.

This cache is used to avoid redundant construction of common transactions (such as round and move-to-vault transactions) when creating all transactions for a single operator, kickoff utxo, and deposit tuple. It is especially important during deposit flows, where many transactions share common intermediates. The cache tracks the previous ready-to-reimburse transaction and a map of saved transaction handlers by type. Note: Why is prev_ready_to_reimburse needed and not just stored in saved_txs? Because saved_txs can include the ReadyToReimburse txhandler for the current round, prev_ready_to_reimburse is specifically from the previous round.

Fields

• prev_ready_to_reimburse: Optionally stores the previous round’s ready-to-reimburse transaction handler.
• saved_txs: A map from TransactionType to TxHandler, storing cached transaction handlers for the current context.

Usage

• Use store_for_next_kickoff to cache the current round’s main transactions before moving to the next kickoff within the same round.
• Use store_for_next_round to update the cache when moving to the next round, preserving the necessary state.
• Use get_cached_txs to retrieve and clear the current cache when constructing new transactions.
• Use get_prev_ready_to_reimburse to access the previous round’s ready-to-reimburse transaction to create the next round’s round tx.

Fields

prev_ready_to_reimburse: Option<TxHandler>

saved_txs: BTreeMap<TransactionType, TxHandler>

Implementations

impl TxHandlerCache

pub fn new() -> Self

Creates a new, empty cache.

pub fn store_for_next_kickoff( &mut self, txhandlers: &mut BTreeMap<TransactionType, TxHandler>, ) -> Result<(), BridgeError>

Stores txhandlers for the next kickoff, caching MoveToVault, Round, and ReadyToReimburse.

Removes these transaction types from the provided map and stores them in the cache. This is used to preserve the state between kickoffs within the same round.

pub fn store_for_next_round(&mut self) -> Result<(), BridgeError>

Stores MoveToVault and previous ReadyToReimburse for the next round.

Moves the MoveToVault and ReadyToReimburse txhandlers from the cache to their respective fields, clearing the rest of the cache. This is used to preserve the state between rounds.

pub fn get_prev_ready_to_reimburse(&self) -> Option<&TxHandler>

Gets the previous ReadyToReimburse txhandler, if any.

This is used to chain rounds together, as the output of the previous ready-to-reimburse transaction is needed as input for the next round’s round transaction. Without caching, we would have to create the full collateral chain again.

pub fn get_cached_txs(&mut self) -> BTreeMap<TransactionType, TxHandler>

Takes and returns all cached txhandlers, clearing the cache.

Trait Implementations

impl Default for TxHandlerCache

fn default() -> Self

Returns the “default value” for a type.