pub struct RetryClient<T>
where T: JsonRpcClient, T::Error: RpcError + Sync + Send + 'static,
{ /* private fields */ }
Expand description

RetryClient presents as a wrapper around JsonRpcClient that will retry requests based with an exponential backoff and filtering based on RetryPolicy.

The RetryPolicy, mainly for rate-limiting errors, can be adjusted for specific applications, endpoints. In addition to the RetryPolicy errors due to connectivity issues, like timed out connections or responses in range 5xx can be retried separately.

§Example

use ethers_providers::{Http, RetryClient, RetryClientBuilder, HttpRateLimitRetryPolicy};
use std::time::Duration;
use url::Url;

let http = Http::new(Url::parse("http://localhost:8545").unwrap());
let client = RetryClientBuilder::default()
    .rate_limit_retries(10)
    .timeout_retries(3)
    .initial_backoff(Duration::from_millis(500))
    .build(http, Box::new(HttpRateLimitRetryPolicy::default()));

Implementations§

source§

impl<T> RetryClient<T>
where T: JsonRpcClient, T::Error: Sync + Send + 'static,

source

pub fn new( inner: T, policy: Box<dyn RetryPolicy<T::Error>>, max_retry: u32, initial_backoff: u64 ) -> Self

Creates a new RetryClient that wraps a client and adds retry and backoff support

§Example
 
use ethers_providers::{Http, RetryClient, HttpRateLimitRetryPolicy};
use std::time::Duration;
use url::Url;

let http = Http::new(Url::parse("http://localhost:8545").unwrap());
let backoff_timeout = 3000; // in ms
let max_retries = 10;
let client = RetryClient::new(http, Box::new(HttpRateLimitRetryPolicy::default()), max_retries, backoff_timeout);
source

pub fn set_compute_units(&mut self, cpus: u64) -> &mut Self

Sets the free compute units per second limit.

This is the maximum number of weighted request that can be handled per second by the endpoint before rate limit kicks in.

This is used to guesstimate how long to wait until to retry again

Trait Implementations§

source§

impl<T> Debug for RetryClient<T>
where T: JsonRpcClient + Debug, T::Error: RpcError + Sync + Send + 'static + Debug,

source§

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

Formats the value using the given formatter. Read more
source§

impl<T> JsonRpcClient for RetryClient<T>
where T: JsonRpcClient + 'static, T::Error: Sync + Send + 'static,

§

type Error = RetryClientError

A JSON-RPC Error
source§

fn request<'life0, 'life1, 'async_trait, A, R>( &'life0 self, method: &'life1 str, params: A ) -> Pin<Box<dyn Future<Output = Result<R, Self::Error>> + Send + 'async_trait>>
where A: Debug + Serialize + Send + Sync + 'async_trait, R: DeserializeOwned + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a request with the provided JSON-RPC and parameters serialized as JSON

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for RetryClient<T>

§

impl<T> Send for RetryClient<T>

§

impl<T> Sync for RetryClient<T>

§

impl<T> Unpin for RetryClient<T>
where T: Unpin,

§

impl<T> !UnwindSafe for RetryClient<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<C> JsonRpcClientWrapper for C
where C: JsonRpcClient,

source§

fn request<'life0, 'life1, 'async_trait>( &'life0 self, method: &'life1 str, params: QuorumParams ) -> Pin<Box<dyn Future<Output = Result<Value, ProviderError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, C: 'async_trait,

Make a request, as crate::JsonRpcClient
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> JsonSchemaMaybe for T