Struct ProviderBuilder

pub struct ProviderBuilder {
    url: Result<Url>,
    chain: NamedChain,
    max_retry: u32,
    initial_backoff: u64,
    timeout: Duration,
    compute_units_per_second: u64,
    jwt: Option<String>,
    headers: Vec<String>,
    is_local: bool,
}

Helper type to construct a RetryProvider

Fields

url: Result<Url>

chain: NamedChain

max_retry: u32

initial_backoff: u64

timeout: Duration

compute_units_per_second: u64

available CUPS

jwt: Option<String>

JWT Secret

headers: Vec<String>

is_local: bool

Implementations

impl ProviderBuilder

pub fn new(url_str: &str) -> Self

Creates a new builder instance

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

Enables a request timeout.

The timeout is applied from when the request starts connecting until the response body has finished.

Default is no timeout.

pub fn chain(self, chain: NamedChain) -> Self

Sets the chain of the node the provider will connect to

pub fn max_retry(self, max_retry: u32) -> Self

How often to retry a failed request

pub fn maybe_max_retry(self, max_retry: Option<u32>) -> Self

How often to retry a failed request. If None, defaults to the already-set value.

pub fn maybe_initial_backoff(self, initial_backoff: Option<u64>) -> Self

The starting backoff delay to use after the first failed request. If None, defaults to the already-set value.

pub fn initial_backoff(self, initial_backoff: u64) -> Self

The starting backoff delay to use after the first failed request

pub fn compute_units_per_second(self, compute_units_per_second: u64) -> Self

Sets the number of assumed available compute units per second

See also, https://docs.alchemy.com/reference/compute-units#what-are-cups-compute-units-per-second

pub fn compute_units_per_second_opt( self, compute_units_per_second: Option<u64>, ) -> Self

Sets the number of assumed available compute units per second

See also, https://docs.alchemy.com/reference/compute-units#what-are-cups-compute-units-per-second

pub fn local(self, is_local: bool) -> Self

Sets the provider to be local.

This is useful for local dev nodes.

pub fn aggressive(self) -> Self

Sets aggressive max_retry and initial_backoff values

This is only recommend for local dev nodes

pub fn jwt(self, jwt: impl Into<String>) -> Self

Sets the JWT secret

pub fn headers(self, headers: Vec<String>) -> Self

Sets http headers

pub fn maybe_headers(self, headers: Option<Vec<String>>) -> Self

Sets http headers. If None, defaults to the already-set value.

pub fn build(self) -> Result<RetryProvider>

Constructs the RetryProvider taking all configs into account.

pub fn build_with_wallet( self, wallet: EthereumWallet, ) -> Result<RetryProviderWithSigner>

Constructs the RetryProvider with a wallet.

Trait Implementations

impl Debug for ProviderBuilder

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 184 bytes