fuel-core-txpool 0.47.0

Transaction pool that manages transactions and their dependencies.
Documentation 
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

use std::collections::HashSet;

use fuel_core_types::fuel_tx::ContractId;

use crate::storage::{
    RemovedTransactions,
    StorageData,
};

pub mod ratio_tip_gas;

/// Constraints that the selection algorithm has to respect.
pub struct Constraints {
    /// Minimum gas price that all transaction must support.
    pub minimal_gas_price: u64,
    /// Maximum limit of gas that all selected transaction shouldn't exceed.
    pub max_gas: u64,
    /// Maximum number of transactions that can be selected.
    pub maximum_txs: u16,
    /// Maximum size of the block.
    pub maximum_block_size: u32,
    /// List of excluded contracts.
    pub excluded_contracts: HashSet<ContractId>,
}

/// The selection algorithm is responsible for selecting the best transactions to include in a block.
pub trait SelectionAlgorithm {
    /// The storage type of the selection algorithm.
    type Storage;
    /// The index that identifies a transaction in the storage.
    type StorageIndex;
    /// Given the constraints, the selection algorithm has to return the best list of transactions to include in a block.
    fn gather_best_txs(
        &mut self,
        constraints: Constraints,
        storage: &mut Self::Storage,
    ) -> RemovedTransactions;

    /// Update the selection algorithm with the new transaction that are executable.
    fn new_executable_transaction(
        &mut self,
        storage_id: Self::StorageIndex,
        store_entry: &StorageData,
    );

    /// Returns the number of executable transactions
    fn number_of_executable_transactions(&self) -> usize;

    /// Get less worth transactions iterator
    fn get_less_worth_txs(&self) -> impl Iterator<Item = &Self::StorageIndex>;

    /// Inform the selection algorithm that a transaction was removed from the pool.
    fn on_removed_transaction(&mut self, storage_entry: &StorageData);
}