Struct OstiumClient 

pub struct OstiumClient { /* private fields */ }

Main client for interacting with the Ostium platform

Implementations

impl OstiumClient

pub fn builder(network: Network) -> OstiumClientBuilder

Create a new client builder for the specified network

pub fn builder_with_config(config: NetworkConfig) -> OstiumClientBuilder

Create a new client builder with custom configuration

pub async fn new(network: Network) -> Result<Self>

Create a new client with default configuration (no signer)

pub fn config(&self) -> &NetworkConfig

Get the network configuration

pub fn signer_address(&self) -> Option<Address>

Get the signer address if available

pub fn has_signer(&self) -> bool

Check if the client has a signer configured

pub fn map_contract_error( &self, error: &str, ) -> (String, String, HashMap<String, String>)

Maps Ethereum contract error selectors to human-readable messages

This function takes a contract error and attempts to decode it into a more meaningful error message based on known Ostium contract error selectors.

Arguments

• error - The error object or string containing the contract error

Returns

A tuple containing (error_message, error_type, error_data)

pub fn extract_error_selector(&self, error: &str) -> Option<String>

Extracts error selector (0x + 8 hex chars) from error message

pub fn get_error_description(&self, selector: &str) -> Option<&'static str>

Get human-readable error message for a specific error selector

pub fn map_contract_error_with_suggestions( &self, error: &str, ) -> (String, String, HashMap<String, String>, Option<String>)

Enhanced error mapping that includes suggestions for common issues

pub async fn get_minimum_position_size(&self, symbol: &str) -> Result<Decimal>

Get minimum position size for a given symbol Returns the minimum position size in the base asset units

pub async fn validate_trading_constraints( &self, symbol: &str, side: PositionSide, size: Decimal, leverage: Decimal, ) -> Result<()>

Validate trading constraints before executing a trade Checks: 1) Trading hours, 2) Minimum position size, 3) Open interest caps

impl OstiumClient

pub async fn open_position(&self, params: OpenPositionParams) -> Result<TxHash>

Open a new trading position

pub async fn close_position( &self, params: ClosePositionParams, ) -> Result<TxHash>

Close an existing position

pub async fn update_tp_sl(&self, params: UpdateTPSLParams) -> Result<TxHash>

Update take profit and stop loss for a position

pub async fn open_position_unsigned( &self, params: OpenPositionParams, trader_address: Address, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for opening a position

pub async fn close_position_unsigned( &self, params: ClosePositionParams, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for closing a position

pub async fn update_tp_sl_unsigned( &self, params: UpdateTPSLParams, tx_params: UnsignedTransactionParams, ) -> Result<Vec<UnsignedTransaction>>

Build unsigned transactions for updating TP/SL

pub async fn place_advanced_order_unsigned( &self, params: AdvancedOrderParams, trader_address: Address, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for placing an advanced order

pub async fn cancel_order_unsigned( &self, params: CancelOrderParams, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for canceling an order

impl OstiumClient

pub async fn place_advanced_order( &self, params: AdvancedOrderParams, ) -> Result<TxHash>

Place an advanced order (market, limit, or stop)

pub async fn place_limit_order( &self, params: LimitOrderParams, ) -> Result<TxHash>

Place a limit order

pub async fn place_stop_order(&self, params: StopOrderParams) -> Result<TxHash>

Place a stop order

pub async fn cancel_order(&self, params: CancelOrderParams) -> Result<TxHash>

Cancel an open limit or stop order

pub async fn update_limit_order( &self, params: UpdateLimitOrderParams, ) -> Result<TxHash>

Update an existing limit order

pub async fn validate_order_price( &self, symbol: &str, order_type: OrderExecutionType, price: Decimal, ) -> Result<bool>

Get current market price for validation purposes

impl OstiumClient

pub async fn get_pairs(&self) -> Result<Vec<TradingPair>>

Get all available trading pairs

pub async fn get_price(&self, symbol: &str) -> Result<Price>

Get current price for a trading pair

pub async fn get_trading_hours(&self, symbol: &str) -> Result<TradingHours>

Get trading hours for a symbol

impl OstiumClient

pub async fn get_balance(&self, address: Option<Address>) -> Result<Balance>

Get account balance

pub async fn get_positions( &self, address: Option<Address>, ) -> Result<Vec<Position>>

Get open positions for an account

pub async fn get_orders(&self, address: Option<Address>) -> Result<Vec<Order>>

Get open orders for an account

Trait Implementations

impl AccountApi for OstiumClient

async fn get_balance(&self, address: Option<Address>) -> Result<Balance>

Get account balance

async fn get_positions(&self, address: Option<Address>) -> Result<Vec<Position>>

Get open positions

async fn get_orders(&self, address: Option<Address>) -> Result<Vec<Order>>

Get open orders

impl AdvancedOrderApi for OstiumClient

async fn place_advanced_order( &self, params: AdvancedOrderParams, ) -> Result<TxHash>

Place an advanced order (market, limit, or stop)

async fn place_limit_order(&self, params: LimitOrderParams) -> Result<TxHash>

Place a limit order

async fn place_stop_order(&self, params: StopOrderParams) -> Result<TxHash>

Place a stop order

async fn cancel_order(&self, params: CancelOrderParams) -> Result<TxHash>

Cancel an open order

async fn update_limit_order( &self, params: UpdateLimitOrderParams, ) -> Result<TxHash>

Update an existing limit order

async fn validate_order_price( &self, symbol: &str, order_type: OrderExecutionType, price: Decimal, ) -> Result<bool>

Validate order price against current market

impl Clone for OstiumClient

fn clone(&self) -> OstiumClient

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl MarketDataApi for OstiumClient

async fn get_pairs(&self) -> Result<Vec<TradingPair>>

Get all trading pairs

async fn get_price(&self, symbol: &str) -> Result<Price>

Get price for a symbol

async fn get_trading_hours(&self, symbol: &str) -> Result<TradingHours>

Get trading hours for a symbol

impl TradingApi for OstiumClient

async fn open_position(&self, params: OpenPositionParams) -> Result<TxHash>

Open a new position

async fn close_position(&self, params: ClosePositionParams) -> Result<TxHash>

Close an existing position

async fn update_tp_sl(&self, params: UpdateTPSLParams) -> Result<TxHash>

Update take profit and stop loss

impl UnsignedTransactionApi for OstiumClient

async fn open_position_unsigned( &self, params: OpenPositionParams, trader_address: Address, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for opening a position

async fn close_position_unsigned( &self, params: ClosePositionParams, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for closing a position

async fn update_tp_sl_unsigned( &self, params: UpdateTPSLParams, tx_params: UnsignedTransactionParams, ) -> Result<Vec<UnsignedTransaction>>

Build unsigned transactions for updating TP/SL

async fn place_advanced_order_unsigned( &self, params: AdvancedOrderParams, trader_address: Address, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for placing an advanced order

async fn cancel_order_unsigned( &self, params: CancelOrderParams, tx_params: UnsignedTransactionParams, ) -> Result<UnsignedTransaction>

Build unsigned transaction for canceling an order