Struct ckb_tx_pool::service::TxPoolController

pub struct TxPoolController { /* private fields */ }

Controller to the tx-pool service.

The Controller is internally reference-counted and can be freely cloned. A Controller can be obtained when tx-pool service construct.

Implementations

impl TxPoolController

pub fn service_started(&self) -> bool

Return whether tx-pool service is started

pub fn handle(&self) -> &Handle

Return reference of tokio runtime handle

pub fn get_block_template(
    &self,
    bytes_limit: Option<u64>,
    proposals_limit: Option<u64>,
    max_version: Option<Version>,
    snapshot: Arc<Snapshot>
) -> Result<Result<BlockTemplate, AnyError>, AnyError>

Generate and return block_template

pub fn get_block_template_with_block_assembler_config(
    &self,
    bytes_limit: Option<u64>,
    proposals_limit: Option<u64>,
    max_version: Option<Version>,
    snapshot: Arc<Snapshot>,
    block_assembler_config: Option<BlockAssemblerConfig>
) -> Result<Result<BlockTemplate, AnyError>, AnyError>

Generate and return block_template with block_assembler_config

pub fn notify_new_uncle(&self, uncle: UncleBlockView) -> Result<(), AnyError>

Notify new uncle

pub fn update_tx_pool_for_reorg(
    &self,
    detached_blocks: VecDeque<BlockView>,
    attached_blocks: VecDeque<BlockView>,
    detached_proposal_id: HashSet<ProposalShortId>,
    snapshot: Arc<Snapshot>
) -> Result<(), AnyError>

Make tx-pool consistent after a reorg, by re-adding or recursively erasing detached block transactions from the tx-pool, and also removing any other transactions from the tx-pool that are no longer valid given the new tip/height.

pub fn submit_local_tx(
    &self,
    tx: TransactionView
) -> Result<Result<(), Reject>, AnyError>

Submit local tx to tx-pool

pub fn remove_local_tx(&self, tx_hash: Byte32) -> Result<bool, AnyError>

Remove tx from tx-pool

pub async fn submit_remote_tx(
    &self,
    tx: TransactionView,
    declared_cycles: Cycle,
    peer: PeerIndex
) -> Result<(), AnyError>

Submit remote tx with declared cycles and origin to tx-pool

pub fn plug_entry(
    &self,
    entries: Vec<TxEntry>,
    target: PlugTarget
) -> Result<(), AnyError>

Plug tx-pool entry to tx-pool, skip verification. only for test

pub fn notify_txs(&self, txs: Vec<TransactionView>) -> Result<(), AnyError>

Receive txs from network, try to add txs to tx-pool

pub fn get_tx_pool_info(&self) -> Result<TxPoolInfo, AnyError>

Return tx-pool information

pub fn fresh_proposals_filter(
    &self,
    proposals: Vec<ProposalShortId>
) -> Result<Vec<ProposalShortId>, AnyError>

Return fresh proposals

pub fn fetch_tx_for_rpc(
    &self,
    hash: Byte32
) -> Result<Option<(bool, TransactionView)>, AnyError>

Return tx for rpc

pub fn get_tx_status(
    &self,
    hash: Byte32
) -> Result<Result<TxStatus, AnyError>, AnyError>

Return tx_status for rpc (get_transaction verbosity = 1)

pub fn get_transaction_with_status(
    &self,
    hash: Byte32
) -> Result<Result<TransactionWithStatus, AnyError>, AnyError>

Return transaction_with_status for rpc (get_transaction verbosity = 2)

pub fn fetch_txs(
    &self,
    short_ids: Vec<ProposalShortId>
) -> Result<HashMap<ProposalShortId, TransactionView>, AnyError>

Return txs for network

pub fn fetch_txs_with_cycles(
    &self,
    short_ids: Vec<ProposalShortId>
) -> Result<Vec<(ProposalShortId, (TransactionView, Cycle))>, AnyError>

Return txs with cycles

pub fn clear_pool(&self, new_snapshot: Arc<Snapshot>) -> Result<(), AnyError>

Clears the tx-pool, removing all txs, update snapshot.

pub fn get_all_entry_info(&self) -> Result<TxPoolEntryInfo, AnyError>

TODO(doc): @zhangsoledad

pub fn get_all_ids(&self) -> Result<TxPoolIds, AnyError>

TODO(doc): @zhangsoledad

pub fn suspend_chunk_process(&self) -> Result<(), AnyError>

Sends suspend chunk process cmd

pub fn continue_chunk_process(&self) -> Result<(), AnyError>

Sends continue chunk process cmd

pub fn save_pool(&self) -> Result<(), AnyError>

Saves tx pool into disk.

Trait Implementations

impl Clone for TxPoolController

fn clone(&self) -> TxPoolController

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Drop for TxPoolController

fn drop(&mut self)

Executes the destructor for this type.