Struct ProviderBuilder

pub struct ProviderBuilder<L, F, N = Ethereum> { /* private fields */ }

A builder for constructing a Provider from various layers.

This type is similar to tower::ServiceBuilder, with extra complication around maintaining the network and transport types.

The ProviderBuilder can be instantiated in two ways, using ProviderBuilder::new() or ProviderBuilder::default().

ProviderBuilder::new() will create a new ProviderBuilder with the RecommendedFillers enabled, whereas ProviderBuilder::default() will instantiate it in its vanilla ProviderBuilder form i.e with no fillers enabled.

Implementations

impl ProviderBuilder<Identity, JoinFill<Identity, <Ethereum as RecommendedFillers>::RecommendedFillers>, Ethereum>

pub fn new() -> Self

Create a new ProviderBuilder with the recommended filler enabled.

Recommended fillers are preconfigured set of fillers that handle gas estimation, nonce management, and chain-id fetching.

Building a provider with this setting enabled will return a crate::fillers::FillProvider with crate::utils::JoinedRecommendedFillers.

You can opt-out of using these fillers by using the .disable_recommended_fillers() method.

pub fn disable_recommended_fillers( self, ) -> ProviderBuilder<Identity, Identity, Ethereum>

Opt-out of the recommended fillers by reseting the fillers stack in the ProviderBuilder.

This is equivalent to creating the builder using ProviderBuilder::default().

pub fn mocked() -> MockProvider<RootProvider, Ethereum>

Available on non-WebAssembly and (crate features reqwest or hyper) only.

Create a new MockProvider for the Ethereum network.

Sets the dummy RPC_URL to http://localhost:8545.

pub fn mocked_network<Net: Network>() -> MockProvider<RootProvider<Net>, Net>

Available on non-WebAssembly and (crate features reqwest or hyper) only.

Create a new MockProvider for a specific network.

Sets the dummy RPC_URL to http://localhost:8545.

impl<L, N: Network> ProviderBuilder<L, Identity, N>

pub fn with_recommended_fillers( self, ) -> ProviderBuilder<L, JoinFill<Identity, N::RecommendedFillers>, N>

where N: RecommendedFillers,

Add preconfigured set of layers handling gas estimation, nonce management, and chain-id fetching.

pub fn with_gas_estimation( self, ) -> ProviderBuilder<L, JoinFill<Identity, GasFiller>, N>

Add gas estimation to the stack being built.

See GasFiller

pub fn with_nonce_management<M: NonceManager>( self, nonce_manager: M, ) -> ProviderBuilder<L, JoinFill<Identity, NonceFiller<M>>, N>

Add nonce management to the stack being built.

See NonceFiller

pub fn with_simple_nonce_management( self, ) -> ProviderBuilder<L, JoinFill<Identity, NonceFiller>, N>

Add simple nonce management to the stack being built.

See SimpleNonceManager

pub fn with_cached_nonce_management( self, ) -> ProviderBuilder<L, JoinFill<Identity, NonceFiller<CachedNonceManager>>, N>

Add cached nonce management to the stack being built.

See CachedNonceManager

pub fn fetch_chain_id( self, ) -> ProviderBuilder<L, JoinFill<Identity, ChainIdFiller>, N>

Add a chain ID filler to the stack being built. The filler will attempt to fetch the chain ID from the provider using Provider::get_chain_id. the first time a transaction is prepared, and will cache it for future transactions.

pub fn with_chain_id( self, chain_id: ChainId, ) -> ProviderBuilder<L, JoinFill<Identity, ChainIdFiller>, N>

Add a specific chain ID to the stack being built. The filler will fill transactions with the provided chain ID, regardless of the chain ID that the provider reports via Provider::get_chain_id.

impl<L, F, N> ProviderBuilder<L, F, N>

pub fn layer<Inner>( self, layer: Inner, ) -> ProviderBuilder<Stack<Inner, L>, F, N>

Add a layer to the stack being built. This is similar to tower::ServiceBuilder::layer.

Note:

Layers are added in outer-to-inner order, as in tower::ServiceBuilder. The first layer added will be the first to see the request.

pub fn filler<F2>(self, filler: F2) -> ProviderBuilder<L, JoinFill<F, F2>, N>

Add a transaction filler to the stack being built. Transaction fillers are used to fill in missing fields on transactions before they are sent, and are all joined to form the outermost layer of the stack.

pub fn network<Net: Network>(self) -> ProviderBuilder<L, F, Net>

Change the network.

By default, the network is Ethereum. This method must be called to configure a different network.

builder.network::<Arbitrum>()

pub fn with_chain( self, chain: NamedChain, ) -> ProviderBuilder<Stack<ChainLayer, L>, F, N>

Add a chain layer to the stack being built. The layer will set the client’s poll interval based on the average block time for this chain.

Does nothing to the client with a local transport.

pub fn on_provider<P>(self, provider: P) -> F::Provider

where L: ProviderLayer<P, N>, F: TxFiller<N> + ProviderLayer<L::Provider, N>, P: Provider<N>, N: Network,

Finish the layer stack by providing a root Provider, outputting the final Provider type with all stack components.

pub fn on_client(self, client: RpcClient) -> F::Provider

where L: ProviderLayer<RootProvider<N>, N>, F: TxFiller<N> + ProviderLayer<L::Provider, N>, N: Network,

Finish the layer stack by providing a root RpcClient, outputting the final Provider type with all stack components.

This is a convenience function for ProviderBuilder::provider<RpcClient>.

pub async fn connect(self, s: &str) -> Result<F::Provider, TransportError>

where L: ProviderLayer<RootProvider<N>, N>, F: TxFiller<N> + ProviderLayer<L::Provider, N>, N: Network,

Finish the layer stack by providing a connection string for a built-in transport type, outputting the final Provider type with all stack components.

pub async fn on_ws( self, connect: WsConnect, ) -> Result<F::Provider, TransportError>

where L: ProviderLayer<RootProvider<N>, N>, F: TxFiller<N> + ProviderLayer<L::Provider, N>, N: Network,

Available on crate feature ws only.

Build this provider with a websocket connection.

pub async fn on_ipc<T>( self, connect: IpcConnect<T>, ) -> Result<F::Provider, TransportError>

where IpcConnect<T>: PubSubConnect, L: ProviderLayer<RootProvider<N>, N>, F: TxFiller<N> + ProviderLayer<L::Provider, N>, N: Network,

Available on crate feature ipc only.

Build this provider with an IPC connection.

pub fn on_http(self, url: Url) -> F::Provider

where L: ProviderLayer<RootProvider<N>, N>, F: TxFiller<N> + ProviderLayer<L::Provider, N>, N: Network,

Available on crate feature reqwest only.

Build this provider with an Reqwest HTTP transport.

pub fn on_hyper_http(self, url: Url) -> F::Provider

where L: ProviderLayer<RootProvider<N>, N>, F: TxFiller<N> + ProviderLayer<L::Provider, N>, N: Network,

Available on crate feature hyper only.

Build this provider with an Hyper HTTP transport.

impl<L, F, N: Network> ProviderBuilder<L, F, N>

pub fn wallet<W: IntoWallet<N>>( self, wallet: W, ) -> ProviderBuilder<L, JoinFill<F, WalletFiller<W::NetworkWallet>>, N>

Add a wallet layer to the stack being built.

See WalletFiller.

impl<L, F> ProviderBuilder<L, F, Ethereum>

pub fn on_anvil(self) -> F::Provider

where F: TxFiller<Ethereum> + ProviderLayer<L::Provider, Ethereum>, L: ProviderLayer<AnvilProvider<RootProvider>>,

Available on crate feature anvil-node only.

Build this provider with anvil, using the BoxTransport.

pub fn on_anvil_with_wallet( self, ) -> <JoinFill<F, WalletFiller<EthereumWallet>> as ProviderLayer<L::Provider>>::Provider

where F: TxFiller<Ethereum> + ProviderLayer<L::Provider, Ethereum>, L: ProviderLayer<AnvilProvider<RootProvider>>,

Available on crate feature anvil-node only.

Build this provider with anvil, using the BoxTransport. This function configures a wallet backed by anvil keys, and is intended for use in tests.

pub fn on_anvil_with_config(self, f: impl FnOnce(Anvil) -> Anvil) -> F::Provider

where F: TxFiller<Ethereum> + ProviderLayer<L::Provider, Ethereum>, L: ProviderLayer<AnvilProvider<RootProvider>>,

Available on crate feature anvil-node only.

Build this provider with anvil, using the BoxTransport. The given function is used to configure the anvil instance.

pub fn on_anvil_with_wallet_and_config( self, f: impl FnOnce(Anvil) -> Anvil, ) -> Result<<JoinFill<F, WalletFiller<EthereumWallet>> as ProviderLayer<L::Provider>>::Provider, NodeError>

where F: TxFiller<Ethereum> + ProviderLayer<L::Provider, Ethereum>, L: ProviderLayer<AnvilProvider<RootProvider>>,

Available on crate feature anvil-node only.

Build this provider with anvil, using the BoxTransport. This calls try_on_anvil_with_wallet_and_config and panics on error.

Trait Implementations

impl<L: Debug, F: Debug, N: Debug> Debug for ProviderBuilder<L, F, N>

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

Formats the value using the given formatter.

impl<N> Default for ProviderBuilder<Identity, Identity, N>

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.