Struct WsTransportClient

pub struct WsTransportClient {
    pub connection: Arc<Mutex<WebSocketConnection>>,
    /* private fields */
}

Basic WebSocket transport client for blockchain interactions

This client provides a foundation for making WebSocket connections to blockchain nodes with built-in support for:

• Connection pooling and reuse
• Automatic endpoint rotation on failure
• Configurable timeouts and reconnection policies
• Heartbeat monitoring

The client is thread-safe and can be shared across multiple tasks.

Fields

connection: Arc<Mutex<WebSocketConnection>>

WebSocket connection state and stream

Implementations

impl WsTransportClient

pub async fn new( network: &Network, config: Option<WsConfig>, ) -> Result<Self, Error>

Creates a new WebSocket transport client with automatic endpoint management

This constructor:

1. Filters and sorts WebSocket RPC URLs by weight
2. Tests each URL’s connectivity with timeout
3. Uses the first working URL as active
4. Adds any additional URLs as fallbacks

Arguments

• network - Network configuration containing RPC URLs, weights, and other details

Returns

• Result<Self, anyhow::Error> - New client instance or connection error

Trait Implementations

impl BlockchainTransport for WsTransportClient

fn get_current_url<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = String> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Retrieves the currently active RPC endpoint URL

This method is useful for monitoring which endpoint is currently in use, especially in scenarios with multiple failover URLs.

Returns

• String - The URL of the currently active endpoint

fn send_raw_request<'life0, 'life1, 'async_trait, P>( &'life0 self, method: &'life1 str, params: Option<P>, ) -> Pin<Box<dyn Future<Output = Result<Value, TransportError>> + Send + 'async_trait>>

where P: Into<Value> + Send + Clone + Serialize + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sends a JSON-RPC request to the blockchain node via WebSocket

This method handles the formatting of the JSON-RPC request, including:

• Adding required JSON-RPC 2.0 fields
• Converting parameters to the correct format
• Connection health checks
• Activity tracking

Arguments

• method - The JSON-RPC method name to call
• params - Optional parameters for the method call

Returns

• Result<Value, anyhow::Error> - JSON response or error with context

Type Parameters

• P - Parameter type that can be serialized to JSON

fn update_endpoint_manager_client( &mut self, _client: ClientWithMiddleware, ) -> Result<(), Error>

Update endpoint manager with a new client

Note: Not applicable for WebSocket transport

fn customize_request<'life0, 'life1, 'async_trait, P>( &'life0 self, method: &'life1 str, params: Option<P>, ) -> Pin<Box<dyn Future<Output = Value> + Send + 'async_trait>>

where P: Into<Value> + Send + Clone + Serialize + 'async_trait, Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Customizes the request for specific blockchain requirements

impl Clone for WsTransportClient

fn clone(&self) -> WsTransportClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WsTransportClient

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

Formats the value using the given formatter.

impl RotatingTransport for WsTransportClient

fn try_connect<'life0, 'life1, 'async_trait>( &'life0 self, url: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Tests connectivity to a specific WebSocket endpoint

Attempts to establish a WebSocket connection with timeout and updates the connection state accordingly.

Arguments

• url - The WebSocket URL to test

Returns

• Result<(), anyhow::Error> - Success or detailed error message

fn update_client<'life0, 'life1, 'async_trait>( &'life0 self, url: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Updates the active endpoint URL

This method is called when rotating to a new endpoint, typically after a failure of the current endpoint.

Arguments

• url - The new URL to use for subsequent connections

Returns

• Result<(), anyhow::Error> - Success or error status