Struct Mempool

pub struct Mempool {

    config: Config,
    active_state: ActiveState,
    sync_status: SyncStatus,
    debug_enable_at_height: Option<Height>,
    latest_chain_tip: LatestChainTip,
    chain_tip_change: ChainTipChange,
    outbound: Buffer<BoxService<Request, Response, BoxError>, Request>,
    state: Buffer<BoxService<Request, Response, BoxError>, Request>,
    tx_verifier: Buffer<BoxService<Request, Response, TransactionError>, Request>,
    transaction_sender: Sender<HashSet<UnminedTxId>>,
    queued_count_bar: Option<Tx>,
    transaction_count_bar: Option<Tx>,
    transaction_cost_bar: Option<Tx>,
    rejected_count_bar: Option<Tx>,
}

Mempool async management and query service.

The mempool is the set of all verified transactions that this node is aware of that have yet to be confirmed by the Zcash network. A transaction is confirmed when it has been included in a block (‘mined’).

Fields

config: Config

The configurable options for the mempool, persisted between states.

active_state: ActiveState

The state of the mempool.

sync_status: SyncStatus

Allows checking if we are near the tip to enable/disable the mempool.

debug_enable_at_height: Option<Height>

If the state’s best chain tip has reached this height, always enable the mempool.

latest_chain_tip: LatestChainTip

Allows efficient access to the best tip of the blockchain.

chain_tip_change: ChainTipChange

Allows the detection of newly added chain tip blocks, and chain tip resets.

outbound: Buffer<BoxService<Request, Response, BoxError>, Request>

Handle to the outbound service. Used to construct the transaction downloader.

state: Buffer<BoxService<Request, Response, BoxError>, Request>

Handle to the state service. Used to construct the transaction downloader.

tx_verifier: Buffer<BoxService<Request, Response, TransactionError>, Request>

Handle to the transaction verifier service. Used to construct the transaction downloader.

transaction_sender: Sender<HashSet<UnminedTxId>>

Sender part of a gossip transactions channel. Used to broadcast transaction ids to peers.

queued_count_bar: Option<Tx>

Queued transactions pending download or verification transmitter. Only displayed after the mempool’s first activation.

transaction_count_bar: Option<Tx>

Number of mempool transactions transmitter. Only displayed after the mempool’s first activation.

transaction_cost_bar: Option<Tx>

Mempool transaction cost transmitter. Only displayed after the mempool’s first activation.

rejected_count_bar: Option<Tx>

Rejected transactions transmitter. Only displayed after the mempool’s first activation.

Implementations

impl Mempool

pub(crate) fn new( config: &Config, outbound: Buffer<BoxService<Request, Response, BoxError>, Request>, state: Buffer<BoxService<Request, Response, BoxError>, Request>, tx_verifier: Buffer<BoxService<Request, Response, TransactionError>, Request>, sync_status: SyncStatus, latest_chain_tip: LatestChainTip, chain_tip_change: ChainTipChange, ) -> (Self, Receiver<HashSet<UnminedTxId>>)

fn is_enabled_by_debug(&self) -> bool

Is the mempool enabled by a debug config option?

fn update_state(&mut self, tip_action: Option<&TipAction>) -> bool

Update the mempool state (enabled / disabled) depending on how close to the tip is the synchronization, including side effects to state changes.

Accepts an optional TipAction for setting the last_seen_tip_hash field when enabling the mempool state, it will not enable the mempool if this is None.

Returns true if the state changed.

pub fn is_enabled(&self) -> bool

Return whether the mempool is enabled or not.

fn remove_expired_from_peer_list( send_to_peers_ids: &HashSet<UnminedTxId>, expired_transactions: &HashSet<Hash>, ) -> HashSet<UnminedTxId>

Remove expired transaction ids from a given list of inserted ones.

fn update_metrics(&mut self)

Update metrics for the mempool.

fn disable_metrics(&self)

Disable metrics for the mempool.

Trait Implementations

impl Drop for Mempool

fn drop(&mut self)

Executes the destructor for this type.

impl Service<Request> for Mempool

fn call(&mut self, req: Request) -> Self::Future

Call the mempool service.

Errors indicate that the peer has done something wrong or unexpected, and will cause callers to disconnect from the remote peer.

type Response = Response

Responses given by the service.

type Error = Box<dyn Error + Sync + Send>

Errors produced by the service.

type Future = Pin<Box<dyn Future<Output = Result<<Mempool as Service<Request>>::Response, <Mempool as Service<Request>>::Error>> + Send>>

The future response value.

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests.