Struct Client

pub struct Client { /* private fields */ }

Implementations

impl Client

pub fn try_new(config: ClientConfig) -> Result<Self, ClientError>

Creates a new HTTP client with the provided configuration.

Arguments

• config - The client configuration containing an HTTP URL and an optional API key.

Returns

• Result<Self, ClientError> - A result containing the initialized client or an error.

Errors

Returns an error if the HTTP URL is invalid or has an unsupported scheme.

pub async fn connect_websocket(&self) -> Result<WsClient, ClientError>

Establishes a WebSocket connection to the server.

Returns

• Result<WsClient, ClientError> - A thread-safe WebSocket client for interacting with the server.

Errors

Returns an error if the connection or the WebSocket handshake fails.

Thread Safety

The returned WsClient is thread-safe and can be cloned to share across multiple tasks.

pub async fn get_opportunities( &self, params: Option<GetOpportunitiesQueryParams>, ) -> Result<Vec<Opportunity>, ClientError>

Fetches opportunities based on optional query parameters.

Arguments

• params - Optional query parameters for filtering opportunities.

Returns

• Result<Vec<Opportunity>, ClientError> - A list of opportunities or an error.

pub async fn new_bid( &self, opportunity: OpportunitySvm, params: NewBidParams, ) -> Result<BidCreate, ClientError>

Creates a new bid for an SVM opportunity.

It receives a list of instructions and add the “submit_bid” or “swap” instruction to it based on the opportunity type. Then it creates a transaction with the instructions and partially signs it with the signers. Finally, it returns a Bid object with the created transaction. If you don’t want to use this method, you can use the svm::Svm::get_submit_bid_instruction or svm::Svm::get_swap_instruction methods to create the “submit_bid” or “swap” instruction and manually create the transaction and bid object.

Arguments

• opportunity - The opportunity to bid on, received from the API.
• params - Bid parameters, ex: amount, deadline, signers, etc..

Returns

• Result<BidCreate, ClientError> - A bid creation object or an error.

Trait Implementations

impl Clone for Client

fn clone(&self) -> Client

Returns a duplicate of the value.

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

Performs copy-assignment from source.