Struct ethcontract::transaction::confirm::ConfirmParams

pub struct ConfirmParams {
    pub confirmations: usize,
    pub poll_interval_min: Duration,
    pub poll_interval_max: Duration,
    pub poll_interval_factor: f32,
    pub block_timeout: Option<usize>,
}

A struct with the confirmation parameters.

Fields

confirmations: usize

The number of blocks to confirm the transaction with. This is the number of blocks mined on top of the block where the transaction was mined. This means that, for example, to just wait for the transaction to be mined, then the number of confirmations should be 0. Positive non-zero values indicate that extra blocks should be waited for on top of the block where the transaction was mined.

poll_interval_min: Duration

Minimal delay between consecutive eth_blockNumber calls. We wait for transaction confirmation by polling node for latest block number. We use exponential backoff to control how often we poll the node.

poll_interval_max: Duration

Maximal delay between consecutive eth_blockNumber calls.

poll_interval_factor: f32

Factor, by which the delay between consecutive eth_blockNumber calls is multiplied after each call.

block_timeout: Option<usize>

The maximum number of blocks to wait for a transaction to get confirmed.

Implementations

impl ConfirmParams

pub fn mined() -> Self

Create new confirmation parameters for just confirming that the transaction was mined but not confirmed with any extra blocks.

pub fn with_confirmations(count: usize) -> Self

Create new confirmation parameters from the specified number of extra blocks to wait for with the default poll interval.

pub fn confirmations(self, confirmations: usize) -> Self

Set new value for confirmations.

pub fn poll_interval(self, min: Duration, max: Duration, factor: f32) -> Self

Set new values for exponential backoff settings.

pub fn poll_interval_min(self, poll_interval_min: Duration) -> Self

Set new value for poll_interval_min.

pub fn poll_interval_max(self, poll_interval_max: Duration) -> Self

Set new value for poll_interval_max.

pub fn poll_interval_factor(self, poll_interval_factor: f32) -> Self

Set new value for poll_interval_factor.

pub fn block_timeout(self, block_timeout: Option<usize>) -> Self

Set new value for block_timeout.

Trait Implementations

impl Clone for ConfirmParams

fn clone(&self) -> ConfirmParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ConfirmParams

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

Formats the value using the given formatter.

impl Default for ConfirmParams

fn default() -> Self

Returns the “default value” for a type.