Struct RpcClient

pub struct RpcClient<T>(/* private fields */);

A JSON-RPC client.

RpcClient should never be instantiated directly. Instead, use ClientBuilder.

Implementations

impl RpcClient<PubSubFrontend>

pub async fn connect_pubsub<C>(connect: C) -> TransportResult<Self>

where C: PubSubConnect,

Available on crate feature pubsub only.

Connect to a transport via a PubSubConnect implementor.

pub fn channel_size(&self) -> usize

Available on crate feature pubsub only.

Get the currently configured channel size. This is the number of items to buffer in new subscription channels. Defaults to 16. See tokio::sync::broadcast for a description of relevant behavior.

pub fn set_channel_size(&self, size: usize)

Available on crate feature pubsub only.

Set the channel size.

impl RpcClient<Identity>

pub const fn builder() -> ClientBuilder<Identity>

Create a new ClientBuilder.

impl RpcClient<Http<Client>>

pub fn new_http(url: Url) -> Self

Available on crate feature reqwest only.

Create a new RpcClient with an HTTP transport.

impl<T> RpcClient<T>

pub fn new(t: T, is_local: bool) -> Self

Creates a new RpcClient with the given transport.

pub fn from_inner(inner: RpcClientInner<T>) -> Self

Creates a new RpcClient with the given inner client.

pub const fn inner(&self) -> &Arc<RpcClientInner<T>>

Get a reference to the client.

pub fn into_inner(self) -> Arc<RpcClientInner<T>>

Convert the client into its inner type.

pub fn get_weak(&self) -> WeakClient<T>

Get a Weak reference to the client.

pub fn get_ref(&self) -> ClientRef<'_, T>

Borrow the client.

pub fn with_poll_interval(self, poll_interval: Duration) -> Self

Sets the poll interval for the client in milliseconds.

Note: This will only set the poll interval for the client if it is the only reference to the inner client. If the reference is held by many, then it will not update the poll interval.

impl<T: Transport> RpcClient<T>

pub fn prepare_static_poller<Params, Resp>( &self, method: impl Into<Cow<'static, str>>, params: Params, ) -> PollerBuilder<T, Params, Resp>

where T: Clone, Params: RpcParam + 'static, Resp: RpcReturn + Clone,

Build a poller that polls a method with the given parameters.

See PollerBuilder for examples and more details.

impl<T: Transport + Clone> RpcClient<T>

pub fn boxed(self) -> RpcClient<BoxTransport>

Boxes the transport.

This will create a new client if this instance is not the only reference to the inner client.

impl<T> RpcClient<Http<T>>

pub fn new_batch(&self) -> BatchRequest<'_, Http<T>>

Create a new BatchRequest builder.

Methods from Deref<Target = RpcClientInner<T>>

pub async fn get_raw_subscription(&self, id: B256) -> RawSubscription

Available on crate feature pubsub only.

Get a RawSubscription for the given subscription ID.

pub async fn get_subscription<T: DeserializeOwned>( &self, id: B256, ) -> Subscription<T>

Available on crate feature pubsub only.

Get a Subscription for the given subscription ID.

pub fn poll_interval(&self) -> Duration

Returns the default poll interval (milliseconds) for the client.

pub fn set_poll_interval(&self, poll_interval: Duration)

Set the poll interval for the client in milliseconds. Default: 7s for remote and 250ms for local transports.

pub fn transport(&self) -> &T

Returns a reference to the underlying transport.

pub fn pubsub_frontend(&self) -> Option<&PubSubFrontend>

where T: Any,

Available on crate feature pubsub only.

Returns a reference to the pubsub frontend if the transport supports it.

pub fn make_request<Params: RpcParam>( &self, method: impl Into<Cow<'static, str>>, params: Params, ) -> Request<Params>

Build a JsonRpcRequest with the given method and params.

This function reserves an ID for the request, however the request is not sent.

To send a request, use RpcClientInner::request and await the returned RpcCall.

pub fn is_local(&self) -> bool

true if the client believes the transport is local.

This can be used to optimize remote API usage, or to change program behavior on local endpoints. When the client is instantiated by parsing a URL or other external input, this value is set on a best-efforts basis and may be incorrect.

pub fn next_id(&self) -> Id

Reserve a request ID u64.

pub fn request<Params: RpcParam, Resp: RpcReturn>( &self, method: impl Into<Cow<'static, str>>, params: Params, ) -> RpcCall<T, Params, Resp>

Prepares an RpcCall.

This function reserves an ID for the request, however the request is not sent. To send a request, await the returned RpcCall.

Note

Serialization is done lazily. It will not be performed until the call is awaited. This means that if a serializer error occurs, it will not be caught until the call is awaited.

pub fn request_noparams<Resp: RpcReturn>( &self, method: impl Into<Cow<'static, str>>, ) -> RpcCall<T, NoParams, Resp>

Prepares an RpcCall with no parameters.

See request for more details.

Trait Implementations

impl<T> Clone for RpcClient<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for RpcClient<T>

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

Formats the value using the given formatter.

impl<T> Deref for RpcClient<T>

type Target = RpcClientInner<T>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.