Struct PubsubClient

pub struct PubsubClient { /* private fields */ }

A client for subscribing to messages from the RPC server.

See the module documentation.

Implementations

impl PubsubClient

pub async fn new(url: &str) -> Result<PubsubClient, PubsubClientError>

pub fn url(&self) -> Url

Returns the URL of the underlying Ws

pub fn is_running(&self) -> bool

Returns true if the underlying Ws connection task is running

NB: the actual Ws may be either connected or reconnecting

pub async fn shutdown(self) -> Result<(), PubsubClientError>

pub async fn account_subscribe( &self, pubkey: &Pubkey, config: Option<RpcAccountInfoConfig>, ) -> Result<(Pin<Box<dyn Stream<Item = Response<UiAccount>> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to account events.

Receives messages of type UiAccount when an account’s lamports or data changes.

RPC Reference

This method corresponds directly to the accountSubscribe RPC method.

pub async fn block_subscribe( &self, filter: RpcBlockSubscribeFilter, config: Option<RpcBlockSubscribeConfig>, ) -> Result<(Pin<Box<dyn Stream<Item = Response<RpcBlockUpdate>> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to block events.

Receives messages of type RpcBlockUpdate when a block is confirmed or finalized.

This method is disabled by default. It can be enabled by passing --rpc-pubsub-enable-block-subscription to agave-validator.

RPC Reference

This method corresponds directly to the blockSubscribe RPC method.

pub async fn logs_subscribe( &self, filter: RpcTransactionLogsFilter, config: RpcTransactionLogsConfig, ) -> Result<(Pin<Box<dyn Stream<Item = Response<RpcLogsResponse>> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to transaction log events.

Receives messages of type RpcLogsResponse when a transaction is committed.

RPC Reference

This method corresponds directly to the logsSubscribe RPC method.

pub async fn program_subscribe( &self, pubkey: &Pubkey, config: Option<RpcProgramAccountsConfig>, ) -> Result<(Pin<Box<dyn Stream<Item = Response<RpcKeyedAccount>> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to program account events.

Receives messages of type RpcKeyedAccount when an account owned by the given program changes.

RPC Reference

This method corresponds directly to the programSubscribe RPC method.

pub async fn vote_subscribe( &self, ) -> Result<(Pin<Box<dyn Stream<Item = RpcVote> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to vote events.

Receives messages of type RpcVote when a new vote is observed. These votes are observed prior to confirmation and may never be confirmed.

This method is disabled by default. It can be enabled by passing --rpc-pubsub-enable-vote-subscription to agave-validator.

RPC Reference

This method corresponds directly to the voteSubscribe RPC method.

pub async fn root_subscribe( &self, ) -> Result<(Pin<Box<dyn Stream<Item = u64> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to root events.

Receives messages of type Slot when a new root is set by the validator.

RPC Reference

This method corresponds directly to the rootSubscribe RPC method.

pub async fn signature_subscribe( &self, signature: &Signature, config: Option<RpcSignatureSubscribeConfig>, ) -> Result<(Pin<Box<dyn Stream<Item = Response<RpcSignatureResult>> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to transaction confirmation events.

Receives messages of type RpcSignatureResult when a transaction with the given signature is committed.

This is a subscription to a single notification. It is automatically cancelled by the server once the notification is sent.

RPC Reference

This method corresponds directly to the signatureSubscribe RPC method.

pub async fn slot_subscribe( &self, ) -> Result<(Pin<Box<dyn Stream<Item = SlotInfo> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to slot events.

Receives messages of type SlotInfo when a slot is processed.

RPC Reference

This method corresponds directly to the slotSubscribe RPC method.

pub async fn slot_updates_subscribe( &self, ) -> Result<(Pin<Box<dyn Stream<Item = SlotUpdate> + Send + '_>>, Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = ()> + Send>> + Send>), PubsubClientError>

Subscribe to slot update events.

Receives messages of type SlotUpdate when various updates to a slot occur.

Note that this method operates differently than other subscriptions: instead of sending the message to a receiver on a channel, it accepts a handler callback that processes the message directly. This processing occurs on another thread.

RPC Reference

This method corresponds directly to the slotUpdatesSubscribe RPC method.

Trait Implementations

impl Debug for PubsubClient

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

Formats the value using the given formatter.