Struct BalanceResponse 

pub struct BalanceResponse {
    pub order_books: HashMap<String, OrderBookBalance>,
    pub total_locked: u128,
    pub total_unlocked: u128,
    pub trading_account_balance: u128,
}

Balance response from GET /v1/balance.

The balance model tracks funds across three locations:

• trading_account_balance — funds sitting directly in the trading account contract, ready to be allocated to any market.
• total_unlocked — the total available balance, i.e. trading_account_balance plus unlocked amounts sitting in individual order-book contracts (e.g. proceeds from filled orders not yet settled). Use this when computing how much you can trade.
• total_locked — funds locked as collateral for currently open orders across all order-book contracts.

Warning

total_unlocked already includes trading_account_balance. Do not add them together — that double-counts your funds.

available_for_new_orders = total_unlocked           // correct
locked_in_open_orders   = total_locked
grand_total             = total_unlocked + total_locked

Fields

order_books: HashMap<String, OrderBookBalance>

total_locked: u128

Total balance locked as collateral for open orders (chain integer).

total_unlocked: u128

Total available balance for trading (chain integer).

This is trading_account_balance + unlocked amounts in each order-book contract. Use this value — not trading_account_balance alone — when deciding how much you can spend on new orders.

trading_account_balance: u128

Balance sitting directly in the trading account contract (chain integer).

This is a subset of total_unlocked. Do not add these two fields together.

Implementations

impl BalanceResponse

pub fn available(&self) -> u128

Total balance available for placing new orders.

Equivalent to total_unlocked.

pub fn locked(&self) -> u128

Total balance locked as collateral for open orders.

pub fn total(&self) -> u128

Grand total balance (available + locked in orders).

Trait Implementations

impl Clone for BalanceResponse

fn clone(&self) -> BalanceResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BalanceResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BalanceResponse

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for BalanceResponse

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.