Struct ethers_providers::QuorumProvider
source · pub struct QuorumProvider<T = Box<dyn JsonRpcClientWrapper>> { /* private fields */ }
Expand description
A provider that bundles multiple providers and only returns a value to the caller once the quorum has been reached.
§Example
Create a QuorumProvider
that uses a homogenous Provider
type only returns a value if the
Quorum::Majority
of the weighted providers return the same value.
use ethers_core::types::U64;
use ethers_providers::{JsonRpcClient, QuorumProvider, Quorum, WeightedProvider, Http};
use std::str::FromStr;
let provider1 = WeightedProvider::new(Http::from_str("http://localhost:8545")?);
let provider2 = WeightedProvider::with_weight(Http::from_str("http://localhost:8545")?, 2);
let provider3 = WeightedProvider::new(Http::from_str("http://localhost:8545")?);
let provider = QuorumProvider::builder()
.add_providers([provider1, provider2, provider3])
.quorum(Quorum::Majority)
.build();
// the weight at which a quorum is reached,
assert_eq!(provider.quorum_weight(), 4 / 2); // majority >=50%
let block_number: U64 = provider.request("eth_blockNumber", ()).await?;
§Example
Create a QuorumProvider
consisting of different Provider
types
use ethers_core::types::U64;
use ethers_providers::{JsonRpcClient, QuorumProvider, Quorum, WeightedProvider, Http, Ws};
use std::str::FromStr;
let provider: QuorumProvider = QuorumProvider::dyn_rpc()
.add_provider(WeightedProvider::new(Box::new(Http::from_str("http://localhost:8545")?)))
.add_provider(WeightedProvider::with_weight(
Box::new(Ws::connect("ws://localhost:8545").await?),
2,
))
.add_provider(WeightedProvider::with_weight(
Box::new(Ws::connect("ws://localhost:8545").await?),
2,
))
// the quorum provider will yield the response if >50% of the weighted inner provider
// returned the same value
.quorum(Quorum::Majority)
.build();
Implementations§
source§impl QuorumProvider<Box<dyn JsonRpcClientWrapper>>
impl QuorumProvider<Box<dyn JsonRpcClientWrapper>>
sourcepub fn dyn_rpc() -> QuorumProviderBuilder<Box<dyn JsonRpcClientWrapper>>
pub fn dyn_rpc() -> QuorumProviderBuilder<Box<dyn JsonRpcClientWrapper>>
Create a QuorumProvider
for different JsonRpcClient
types
source§impl QuorumProvider<Box<dyn PubsubClientWrapper>>
impl QuorumProvider<Box<dyn PubsubClientWrapper>>
sourcepub fn dyn_pub_sub() -> QuorumProviderBuilder<Box<dyn PubsubClientWrapper>>
pub fn dyn_pub_sub() -> QuorumProviderBuilder<Box<dyn PubsubClientWrapper>>
Create a QuorumProvider
for different PubsubClient
types
source§impl<T> QuorumProvider<T>
impl<T> QuorumProvider<T>
sourcepub fn builder() -> QuorumProviderBuilder<T>
pub fn builder() -> QuorumProviderBuilder<T>
Convenience method for creating a QuorumProviderBuilder
with same JsonRpcClient
types
sourcepub fn new(
quorum: Quorum,
providers: impl IntoIterator<Item = WeightedProvider<T>>
) -> Self
pub fn new( quorum: Quorum, providers: impl IntoIterator<Item = WeightedProvider<T>> ) -> Self
Instantiate a new QuorumProvider
from a Quorum
and a set of
providers
sourcepub fn providers(&self) -> &[WeightedProvider<T>]
pub fn providers(&self) -> &[WeightedProvider<T>]
Return a reference to the weighted providers
sourcepub fn quorum_weight(&self) -> u64
pub fn quorum_weight(&self) -> u64
The weight at which the provider reached a quorum
sourcepub fn add_provider(&mut self, provider: WeightedProvider<T>)
pub fn add_provider(&mut self, provider: WeightedProvider<T>)
Add a provider to the set
Trait Implementations§
source§impl<T: Clone> Clone for QuorumProvider<T>
impl<T: Clone> Clone for QuorumProvider<T>
source§fn clone(&self) -> QuorumProvider<T>
fn clone(&self) -> QuorumProvider<T>
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moresource§impl<T: Debug> Debug for QuorumProvider<T>
impl<T: Debug> Debug for QuorumProvider<T>
source§impl<C> JsonRpcClient for QuorumProvider<C>where
C: JsonRpcClientWrapper,
impl<C> JsonRpcClient for QuorumProvider<C>where
C: JsonRpcClientWrapper,
§type Error = ProviderError
type Error = ProviderError
A JSON-RPC Error
source§fn request<'life0, 'life1, 'async_trait, T, R>(
&'life0 self,
method: &'life1 str,
params: T
) -> Pin<Box<dyn Future<Output = Result<R, Self::Error>> + Send + 'async_trait>>where
T: 'async_trait + Serialize + Send + Sync,
R: 'async_trait + DeserializeOwned,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn request<'life0, 'life1, 'async_trait, T, R>(
&'life0 self,
method: &'life1 str,
params: T
) -> Pin<Box<dyn Future<Output = Result<R, Self::Error>> + Send + 'async_trait>>where
T: 'async_trait + Serialize + Send + Sync,
R: 'async_trait + DeserializeOwned,
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Sends a request with the provided JSON-RPC and parameters serialized as JSON
source§impl<C> PubsubClient for QuorumProvider<C>where
C: PubsubClientWrapper,
impl<C> PubsubClient for QuorumProvider<C>where
C: PubsubClientWrapper,
§type NotificationStream = QuorumStream
type NotificationStream = QuorumStream
The type of stream this transport returns
Auto Trait Implementations§
impl<T> RefUnwindSafe for QuorumProvider<T>where
T: RefUnwindSafe,
impl<T> Send for QuorumProvider<T>where
T: Send,
impl<T> Sync for QuorumProvider<T>where
T: Sync,
impl<T> Unpin for QuorumProvider<T>where
T: Unpin,
impl<T> UnwindSafe for QuorumProvider<T>where
T: UnwindSafe,
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more