-
Notifications
You must be signed in to change notification settings - Fork 247
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: default to Ethereum network in ProviderBuilder
#304
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
use crate::{layers::SignerLayer, Provider, RootProvider}; | ||
use alloy_network::Network; | ||
use alloy_network::{Ethereum, Network}; | ||
use alloy_rpc_client::RpcClient; | ||
use alloy_transport::Transport; | ||
use std::marker::PhantomData; | ||
|
@@ -70,9 +70,8 @@ where | |
/// | ||
/// [`tower::ServiceBuilder`]: https://docs.rs/tower/latest/tower/struct.ServiceBuilder.html | ||
#[derive(Debug)] | ||
pub struct ProviderBuilder<L, N = ()> { | ||
pub struct ProviderBuilder<L, N = Ethereum> { | ||
layer: L, | ||
|
||
network: PhantomData<N>, | ||
} | ||
|
||
|
@@ -99,25 +98,23 @@ impl<L, N> ProviderBuilder<L, N> { | |
/// [`tower::ServiceBuilder`]. The first layer added will be the first to | ||
/// see the request. | ||
/// | ||
/// | ||
/// [`tower::ServiceBuilder::layer`]: https://docs.rs/tower/latest/tower/struct.ServiceBuilder.html#method.layer | ||
/// [`tower::ServiceBuilder`]: https://docs.rs/tower/latest/tower/struct.ServiceBuilder.html | ||
pub fn layer<Inner>(self, layer: Inner) -> ProviderBuilder<Stack<Inner, L>> { | ||
pub fn layer<Inner>(self, layer: Inner) -> ProviderBuilder<Stack<Inner, L>, N> { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. need to be careful here not to ignore |
||
ProviderBuilder { layer: Stack::new(layer, self.layer), network: PhantomData } | ||
} | ||
|
||
/// Add a signer layer to the stack being built. | ||
/// | ||
/// See [`SignerLayer`]. | ||
pub fn signer<S>(self, signer: S) -> ProviderBuilder<Stack<SignerLayer<S>, L>> { | ||
pub fn signer<S>(self, signer: S) -> ProviderBuilder<Stack<SignerLayer<S>, L>, N> { | ||
self.layer(SignerLayer::new(signer)) | ||
} | ||
|
||
/// Change the network. | ||
/// | ||
/// By default, the network is invalid, and contains the unit type `()`. | ||
/// This method MUST be called before the provider is built. The `client` | ||
/// and `provider` methods only exist when the network is valid. | ||
/// By default, the network is `Ethereum`. This method must be called to configure a different | ||
/// network. | ||
/// | ||
/// ```rust,ignore | ||
/// builder.network::<Arbitrum>() | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe add
pub fn network<Other: Network>(self) -> ProviderBuilder<Stack<Inner, L>, Other>
for lazy users or programmatic switching?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Already exists
alloy/crates/provider/src/builder.rs
Lines 114 to 125 in 9a33128
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just noticed docs need an update. cc @onbjerg we want Ethereum here by default right?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
yes Ethereum by default