Struct OrderStreamClient 

pub struct OrderStreamClient {
    pub client: Client,
    pub base_url: Url,
    pub boundless_market_address: Address,
    pub chain_id: u64,
    pub api_key: Option<String>,
}

Available on non-target_os=zkvm only.

Client for interacting with the order stream server

Fields

client: Client

HTTP client

base_url: Url

Base URL of the order stream server

boundless_market_address: Address

Address of the market contract

chain_id: u64

Chain ID of the network

api_key: Option<String>

Optional API key for authenticated requests

Implementations

impl OrderStreamClient

pub fn new( base_url: Url, boundless_market_address: Address, chain_id: u64, ) -> Self

Create a new client

pub fn new_with_api_key( base_url: Url, boundless_market_address: Address, chain_id: u64, api_key: String, ) -> Self

Create a new client with API key

pub async fn submit_request( &self, request: &ProofRequest, signer: &impl Signer, ) -> Result<Order>

Submit a proof request to the order stream server

pub async fn fetch_order( &self, id: U256, request_digest: Option<B256>, ) -> Result<Order>

Fetch an order from the order stream server.

If multiple orders are found, the request_digest must be provided to select the correct order.

pub async fn fetch_order_with_timestamp( &self, id: U256, request_digest: Option<B256>, ) -> Result<(Order, DateTime<Utc>)>

Fetch an order with its creation timestamp from the order stream server.

Returns both the Order and the timestamp when it was created. If multiple orders are found, the request_digest must be provided to select the correct order.

pub async fn get_nonce(&self, address: Address) -> Result<Nonce>

Get the nonce from the order stream service for websocket auth

pub async fn list_orders_by_creation( &self, after: Option<DateTime<Utc>>, limit: u64, ) -> Result<Vec<OrderData>>

List orders sorted by creation time descending (most recent first)

Returns orders created after the given timestamp (if provided), up to the specified limit. If after is None, returns the most recent orders.

pub async fn list_orders_v2( &self, cursor: Option<String>, limit: Option<u64>, sort: Option<SortDirection>, before: Option<DateTime<Utc>>, after: Option<DateTime<Utc>>, ) -> Result<ListOrdersV2Response>

List orders with cursor-based pagination and flexible filtering (v2)

Provides cursor-based pagination for stable results, bidirectional sorting, and timestamp range filtering. This is the recommended method for paginating through orders as it handles concurrent inserts correctly.

Arguments

• cursor - Opaque cursor string from previous response for pagination
• limit - Maximum number of orders to return
• sort - Sort direction (Asc for oldest first, Desc for newest first)
• before - Optional timestamp to filter orders created before this time (EXCLUSIVE: created_at < before)
• after - Optional timestamp to filter orders created after this time (EXCLUSIVE: created_at > after)

Boundary Semantics

Both before and after parameters use exclusive comparison operators:

• before: Returns orders where created_at < before (does NOT include orders at the exact timestamp)
• after: Returns orders where created_at > after (does NOT include orders at the exact timestamp)

To include orders at a specific timestamp boundary, add/subtract a small time delta (e.g., 1 second).

pub async fn connect_async( &self, signer: &impl Signer, ) -> Result<WebSocketStream<MaybeTlsStream<TcpStream>>>

Return a WebSocket stream connected to the order stream server

An authentication message is sent to the server via the X-Auth-Data header. The authentication message must contain a valid claim of an address holding a (pre-configured) minimum balance on the boundless market in order to connect to the server. Only one connection per address is allowed.

Trait Implementations

impl Clone for OrderStreamClient

fn clone(&self) -> OrderStreamClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderStreamClient

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

Formats the value using the given formatter.