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

source

pub fn dyn_rpc() -> QuorumProviderBuilder<Box<dyn JsonRpcClientWrapper>>

Create a QuorumProvider for different JsonRpcClient types

source§

impl QuorumProvider<Box<dyn PubsubClientWrapper>>

source

pub fn dyn_pub_sub() -> QuorumProviderBuilder<Box<dyn PubsubClientWrapper>>

Create a QuorumProvider for different PubsubClient types

source§

impl<T> QuorumProvider<T>

source

pub fn builder() -> QuorumProviderBuilder<T>

Convenience method for creating a QuorumProviderBuilder with same JsonRpcClient types

source

pub fn new( quorum: Quorum, providers: impl IntoIterator<Item = WeightedProvider<T>> ) -> Self

Instantiate a new QuorumProvider from a Quorum and a set of providers

source

pub fn providers(&self) -> &[WeightedProvider<T>]

Return a reference to the weighted providers

source

pub fn quorum_weight(&self) -> u64

The weight at which the provider reached a quorum

source

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>

source§

fn clone(&self) -> QuorumProvider<T>

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl<T: Debug> Debug for QuorumProvider<T>

source§

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

Formats the value using the given formatter. Read more
source§

impl<C> JsonRpcClient for QuorumProvider<C>

§

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,

Sends a request with the provided JSON-RPC and parameters serialized as JSON
source§

impl<C> PubsubClient for QuorumProvider<C>
where C: PubsubClientWrapper,

§

type NotificationStream = QuorumStream

The type of stream this transport returns
source§

fn subscribe<T: Into<U256>>( &self, id: T ) -> Result<Self::NotificationStream, Self::Error>

Add a subscription to this transport
source§

fn unsubscribe<T: Into<U256>>(&self, id: T) -> Result<(), Self::Error>

Remove a subscription from this transport

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> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<C> JsonRpcClientWrapper for C
where C: JsonRpcClient,

source§

fn request<'life0, 'life1, 'async_trait>( &'life0 self, method: &'life1 str, params: QuorumParams ) -> Pin<Box<dyn Future<Output = Result<Value, ProviderError>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, C: 'async_trait,

Make a request, as crate::JsonRpcClient
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<T> JsonSchemaMaybe for T