Struct RetryClient

pub struct RetryClient<T>
where
    T: JsonRpcProvider,
    T::Error: Sync + Send + 'static + Debug,
{ /* private fields */ }

RetryClient presents as a wrapper around JsonRpcProvider 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 neo3::neo_clients::{HttpProvider, HttpRateLimitRetryPolicy, RetryClientBuilder};
use std::time::Duration;
use url::Url;

async fn demo() {
    let http = HttpProvider::new(Url::parse("http://localhost:8545").unwrap()).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

impl<T> RetryClient<T>

where T: JsonRpcProvider, T::Error: Sync + Send + 'static + Debug,

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 neo3::neo_clients::{HttpProvider, HttpRateLimitRetryPolicy, RetryClient};
use std::time::Duration;
use url::Url;

async fn demo() {
    let http = HttpProvider::new(Url::parse("http://localhost:8545").unwrap()).unwrap();
    let backoff_timeout = 3000; // in ms
    let max_retries = 10;
    let client = RetryClient::new(http, Box::new(HttpRateLimitRetryPolicy::default()), max_retries, backoff_timeout);
}

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

impl<T> Debug for RetryClient<T>

where T: JsonRpcProvider + Debug, T::Error: Sync + Send + 'static + Debug + Debug,

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

Formats the value using the given formatter.

impl<T> JsonRpcProvider for RetryClient<T>

where T: JsonRpcProvider + 'static, T::Error: Sync + Send + 'static + Debug,

type Error = RetryClientError

A JSON-RPC Error

fn fetch<'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