Struct ethers_middleware::gas_escalator::GasEscalatorMiddleware

pub struct GasEscalatorMiddleware<M, E> {
    pub txs: Arc<Mutex<Vec<(TxHash, TransactionRequest, Instant, Option<BlockId>)>>>,
    // some fields omitted
}

A Gas escalator allows bumping transactions’ gas price to avoid getting them stuck in the memory pool.

use ethers_providers::{Provider, Http};
use ethers_middleware::{
    gas_escalator::{GeometricGasPrice, Frequency, GasEscalatorMiddleware},
    gas_oracle::{EthGasStation, GasCategory, GasOracleMiddleware},
};
use std::{convert::TryFrom, time::Duration, sync::Arc};

let provider = Provider::try_from("http://localhost:8545")
    .unwrap()
    .interval(Duration::from_millis(2000u64));

let provider = {
    let escalator = GeometricGasPrice::new(5.0, 10u64, None::<u64>);
    GasEscalatorMiddleware::new(provider, escalator, Frequency::PerBlock)
};

// ... proceed to wrap it in other middleware
let gas_oracle = EthGasStation::new(None).category(GasCategory::SafeLow);
let provider = GasOracleMiddleware::new(provider, gas_oracle);

Fields

txs: Arc<Mutex<Vec<(TxHash, TransactionRequest, Instant, Option<BlockId>)>>>

The transactions which are currently being monitored for escalation

Implementations

impl<M, E> GasEscalatorMiddleware<M, E> where
    M: Middleware,
    E: GasEscalator, 

pub fn new(inner: M, escalator: E, frequency: Frequency) -> Self where
    E: Clone + 'static,
    M: Clone + 'static, 

Initializes the middleware with the provided gas escalator and the chosen escalation frequency (per block or per second)

pub async fn escalate(&self) -> Result<(), GasEscalatorError<M>>

Re-broadcasts pending transactions with a gas price escalator

Trait Implementations

impl<M: Clone, E: Clone> Clone for GasEscalatorMiddleware<M, E>

fn clone(&self) -> GasEscalatorMiddleware<M, E>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<M: Debug, E: Debug> Debug for GasEscalatorMiddleware<M, E>

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

Formats the value using the given formatter.

impl<M, E> Middleware for GasEscalatorMiddleware<M, E> where
    M: Middleware,
    E: GasEscalator, 

type Error = GasEscalatorError<M>

type Provider = M::Provider

type Inner = M

fn inner(&self) -> &M

The next middleware in the stack

fn send_transaction<'life0, 'async_trait, T: Into<TypedTransaction> + Send + Sync>(
    &'life0 self,
    tx: T,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<PendingTransaction<'_, Self::Provider>, Self::Error>> + Send + 'async_trait>> where
    T: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

fn provider(&self) -> &Provider<Self::Provider>

The HTTP or Websocket provider.

fn default_sender(&self) -> Option<H160>

fn client_version<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn fill_transaction<'life0, 'life1, 'async_trait>(
    &'life0 self,
    tx: &'life1 mut TypedTransaction,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Fill necessary details of a transaction for dispatch

fn get_block_number<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<U64, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn send_escalating<'a, 'life0, 'async_trait>(
    &'a self,
    tx: &'life0 TypedTransaction,
    escalations: usize,
    policy: Box<dyn Fn(U256, usize) + Send + Sync + 'static, Global>
) -> Pin<Box<dyn Future<Output = Result<EscalatingPending<'a, Self::Provider>, Self::Error>> + Send + 'async_trait, Global>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

Send a transaction with a simple escalation policy.

fn resolve_name<'life0, 'life1, 'async_trait>(
    &'life0 self,
    ens_name: &'life1 str
) -> Pin<Box<dyn Future<Output = Result<H160, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn lookup_address<'life0, 'async_trait>(
    &'life0 self,
    address: H160
) -> Pin<Box<dyn Future<Output = Result<String, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn get_block<'life0, 'async_trait, T>(
    &'life0 self,
    block_hash_or_number: T
) -> Pin<Box<dyn Future<Output = Result<Option<Block<H256>>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<BlockId> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_block_with_txs<'life0, 'async_trait, T>(
    &'life0 self,
    block_hash_or_number: T
) -> Pin<Box<dyn Future<Output = Result<Option<Block<Transaction>>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<BlockId> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_uncle_count<'life0, 'async_trait, T>(
    &'life0 self,
    block_hash_or_number: T
) -> Pin<Box<dyn Future<Output = Result<U256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<BlockId> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_uncle<'life0, 'async_trait, T>(
    &'life0 self,
    block_hash_or_number: T,
    idx: U64
) -> Pin<Box<dyn Future<Output = Result<Option<Block<H256>>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<BlockId> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_transaction_count<'life0, 'async_trait, T>(
    &'life0 self,
    from: T,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<U256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<NameOrAddress> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn estimate_gas<'life0, 'life1, 'async_trait>(
    &'life0 self,
    tx: &'life1 TypedTransaction
) -> Pin<Box<dyn Future<Output = Result<U256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn call<'life0, 'life1, 'async_trait>(
    &'life0 self,
    tx: &'life1 TypedTransaction,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<Bytes, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn get_chainid<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<U256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn get_net_version<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<U64, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn get_balance<'life0, 'async_trait, T>(
    &'life0 self,
    from: T,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<U256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<NameOrAddress> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_transaction<'life0, 'async_trait, T>(
    &'life0 self,
    transaction_hash: T
) -> Pin<Box<dyn Future<Output = Result<Option<Transaction>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Send + Sync + Into<H256> + 'async_trait,
    Self: 'async_trait, 

fn get_transaction_receipt<'life0, 'async_trait, T>(
    &'life0 self,
    transaction_hash: T
) -> Pin<Box<dyn Future<Output = Result<Option<TransactionReceipt>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Send + Sync + Into<H256> + 'async_trait,
    Self: 'async_trait, 

fn get_block_receipts<'life0, 'async_trait, T>(
    &'life0 self,
    block: T
) -> Pin<Box<dyn Future<Output = Result<Vec<TransactionReceipt, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<BlockNumber> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_gas_price<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<U256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn estimate_eip1559_fees<'life0, 'async_trait>(
    &'life0 self,
    estimator: Option<fn(U256, Vec<Vec<U256, Global>, Global>) -> (U256, U256)>
) -> Pin<Box<dyn Future<Output = Result<(U256, U256), Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn get_accounts<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<Vec<H160, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn send_raw_transaction<'a, 'async_trait>(
    &'a self,
    tx: Bytes
) -> Pin<Box<dyn Future<Output = Result<PendingTransaction<'a, Self::Provider>, Self::Error>> + Send + 'async_trait, Global>> where
    'a: 'async_trait,
    Self: 'async_trait, 

fn is_signer<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

This returns true if either the middleware stack contains a SignerMiddleware, or the JSON-RPC provider has an unlocked key that can sign using the eth_sign call. If none of the above conditions are met, then the middleware stack is not capable of signing data.

fn sign<'life0, 'life1, 'async_trait, T>(
    &'life0 self,
    data: T,
    from: &'life1 H160
) -> Pin<Box<dyn Future<Output = Result<Signature, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    T: Into<Bytes> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn sign_transaction<'life0, 'life1, 'async_trait>(
    &'life0 self,
    tx: &'life1 TypedTransaction,
    from: H160
) -> Pin<Box<dyn Future<Output = Result<Signature, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

Sign a transaction via RPC call

fn get_logs<'life0, 'life1, 'async_trait>(
    &'life0 self,
    filter: &'life1 Filter
) -> Pin<Box<dyn Future<Output = Result<Vec<Log, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn new_filter<'life0, 'life1, 'async_trait>(
    &'life0 self,
    filter: FilterKind<'life1>
) -> Pin<Box<dyn Future<Output = Result<U256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait, 

fn uninstall_filter<'life0, 'async_trait, T>(
    &'life0 self,
    id: T
) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<U256> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn watch<'a, 'life0, 'async_trait>(
    &'a self,
    filter: &'life0 Filter
) -> Pin<Box<dyn Future<Output = Result<FilterWatcher<'a, Self::Provider, Log>, Self::Error>> + Send + 'async_trait, Global>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait, 

fn watch_pending_transactions<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<FilterWatcher<'life0, Self::Provider, H256>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn get_filter_changes<'life0, 'async_trait, T, R>(
    &'life0 self,
    id: T
) -> Pin<Box<dyn Future<Output = Result<Vec<R, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<U256> + Send + Sync + 'async_trait,
    R: Serialize + DeserializeOwned + Send + Sync + Debug + 'async_trait,
    Self: 'async_trait, 

fn watch_blocks<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<FilterWatcher<'life0, Self::Provider, H256>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn get_code<'life0, 'async_trait, T>(
    &'life0 self,
    at: T,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<Bytes, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<NameOrAddress> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_storage_at<'life0, 'async_trait, T>(
    &'life0 self,
    from: T,
    location: H256,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<H256, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<NameOrAddress> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn get_proof<'life0, 'async_trait, T>(
    &'life0 self,
    from: T,
    locations: Vec<H256, Global>,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<EIP1186ProofResponse, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<NameOrAddress> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn txpool_content<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<TxpoolContent, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn txpool_inspect<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<TxpoolInspect, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn txpool_status<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<TxpoolStatus, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

fn trace_call<'life0, 'async_trait, T>(
    &'life0 self,
    req: T,
    trace_type: Vec<TraceType, Global>,
    block: Option<BlockNumber>
) -> Pin<Box<dyn Future<Output = Result<BlockTrace, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<TypedTransaction> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

Executes the given call and returns a number of possible traces for it

fn trace_raw_transaction<'life0, 'async_trait>(
    &'life0 self,
    data: Bytes,
    trace_type: Vec<TraceType, Global>
) -> Pin<Box<dyn Future<Output = Result<BlockTrace, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Traces a call to eth_sendRawTransaction without making the call, returning the traces

fn trace_replay_transaction<'life0, 'async_trait>(
    &'life0 self,
    hash: H256,
    trace_type: Vec<TraceType, Global>
) -> Pin<Box<dyn Future<Output = Result<BlockTrace, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Replays a transaction, returning the traces

fn trace_replay_block_transactions<'life0, 'async_trait>(
    &'life0 self,
    block: BlockNumber,
    trace_type: Vec<TraceType, Global>
) -> Pin<Box<dyn Future<Output = Result<Vec<BlockTrace, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Replays all transactions in a block returning the requested traces for each transaction

fn trace_block<'life0, 'async_trait>(
    &'life0 self,
    block: BlockNumber
) -> Pin<Box<dyn Future<Output = Result<Vec<Trace, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns traces created at given block

fn trace_filter<'life0, 'async_trait>(
    &'life0 self,
    filter: TraceFilter
) -> Pin<Box<dyn Future<Output = Result<Vec<Trace, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Return traces matching the given filter

fn trace_get<'life0, 'async_trait, T>(
    &'life0 self,
    hash: H256,
    index: Vec<T, Global>
) -> Pin<Box<dyn Future<Output = Result<Trace, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<U64> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

Returns trace at the given position

fn trace_transaction<'life0, 'async_trait>(
    &'life0 self,
    hash: H256
) -> Pin<Box<dyn Future<Output = Result<Vec<Trace, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait, 

Returns all traces of a given transaction

fn parity_block_receipts<'life0, 'async_trait, T>(
    &'life0 self,
    block: T
) -> Pin<Box<dyn Future<Output = Result<Vec<TransactionReceipt, Global>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<BlockNumber> + Send + Sync + 'async_trait,
    Self: 'async_trait, 

Returns all receipts for that block. Must be done on a parity node.

fn subscribe<'life0, 'async_trait, T, R>(
    &'life0 self,
    params: T
) -> Pin<Box<dyn Future<Output = Result<SubscriptionStream<'life0, Self::Provider, R>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Debug + Serialize + Send + Sync + 'async_trait,
    R: DeserializeOwned + Send + Sync + 'async_trait,
    Self: 'async_trait,
    Self::Provider: PubsubClient, 

fn unsubscribe<'life0, 'async_trait, T>(
    &'life0 self,
    id: T
) -> Pin<Box<dyn Future<Output = Result<bool, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    T: Into<U256> + Send + Sync + 'async_trait,
    Self: 'async_trait,
    Self::Provider: PubsubClient, 

fn subscribe_blocks<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<SubscriptionStream<'life0, Self::Provider, Block<H256>>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait,
    Self::Provider: PubsubClient, 

fn subscribe_pending_txs<'life0, 'async_trait>(
    &'life0 self
) -> Pin<Box<dyn Future<Output = Result<SubscriptionStream<'life0, Self::Provider, H256>, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    Self: 'async_trait,
    Self::Provider: PubsubClient, 

fn subscribe_logs<'a, 'life0, 'async_trait>(
    &'a self,
    filter: &'life0 Filter
) -> Pin<Box<dyn Future<Output = Result<SubscriptionStream<'a, Self::Provider, Log>, Self::Error>> + Send + 'async_trait, Global>> where
    'a: 'async_trait,
    'life0: 'async_trait,
    Self: 'async_trait,
    Self::Provider: PubsubClient, 

fn fee_history<'life0, 'life1, 'async_trait, T>(
    &'life0 self,
    block_count: T,
    last_block: BlockNumber,
    reward_percentiles: &'life1 [f64]
) -> Pin<Box<dyn Future<Output = Result<FeeHistory, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    T: Into<U256> + Serialize + Send + Sync + 'async_trait,
    Self: 'async_trait, 

fn create_access_list<'life0, 'life1, 'async_trait>(
    &'life0 self,
    tx: &'life1 TypedTransaction,
    block: Option<BlockId>
) -> Pin<Box<dyn Future<Output = Result<AccessListWithGasUsed, Self::Error>> + Send + 'async_trait, Global>> where
    'life0: 'async_trait,
    'life1: 'async_trait,
    Self: 'async_trait,