Struct ProviderBuilder

source

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

Expand description

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.

Implementations§

source §

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

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

source

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

Add gas estimation to the stack being built.

See GasFiller

source

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

source

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

Add simple nonce management to the stack being built.

See SimpleNonceManager

source

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

source

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.

source

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.

source §

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

source

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.

source

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.

source

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

Add a wallet layer to the stack being built.

See WalletFiller.

source

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>()

source

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.

source

pub fn on_provider<P, T>(self, provider: P) -> F::Provider
where L: ProviderLayer<P, T, N>, F: TxFiller<N> + ProviderLayer<L::Provider, T, N>, P: Provider<T, N>, T: Transport + Clone, N: Network,

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

source

pub fn on_client<T>(self, client: RpcClient<T>) -> F::Provider
where L: ProviderLayer<RootProvider<T, N>, T, N>, F: TxFiller<N> + ProviderLayer<L::Provider, T, N>, T: Transport + Clone, 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>.

source

pub async fn on_builtin(self, s: &str) -> Result<F::Provider, TransportError>
where L: ProviderLayer<RootProvider<BoxTransport, N>, BoxTransport, N>, F: TxFiller<N> + ProviderLayer<L::Provider, BoxTransport, 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.

source

pub async fn on_ws( self, connect: WsConnect, ) -> Result<F::Provider, TransportError>
where L: ProviderLayer<RootProvider<PubSubFrontend, N>, PubSubFrontend, N>, F: TxFiller<N> + ProviderLayer<L::Provider, PubSubFrontend, N>, N: Network,

Available on crate feature ws only.

Build this provider with a websocket connection.

source

pub async fn on_ipc<T>( self, connect: IpcConnect<T>, ) -> Result<F::Provider, TransportError>
where IpcConnect<T>: PubSubConnect, L: ProviderLayer<RootProvider<PubSubFrontend, N>, PubSubFrontend, N>, F: TxFiller<N> + ProviderLayer<L::Provider, PubSubFrontend, N>, N: Network,

Available on crate feature ipc only.

Build this provider with an IPC connection.

source

pub fn on_http(self, url: Url) -> F::Provider
where L: ProviderLayer<ReqwestProvider<N>, Http<Client>, N>, F: TxFiller<N> + ProviderLayer<L::Provider, Http<Client>, N>, N: Network,

Available on crate feature reqwest only.

Build this provider with an Reqwest HTTP transport.

source

pub fn on_hyper_http(self, url: Url) -> F::Provider
where L: ProviderLayer<HyperProvider<N>, HyperTransport, N>, F: TxFiller<N> + ProviderLayer<L::Provider, HyperTransport, N>, N: Network,

Available on crate feature hyper only.

Build this provider with an Hyper HTTP transport.

source §