Struct SubmitOrderRequestBuilder 

pub struct SubmitOrderRequestBuilder { /* private fields */ }

Builder for constructing SubmitOrderRequest with a fluent API.

This builder provides a type-safe way to construct order submission requests with proper validation of required fields and configuration constraints. It supports:

• Market and limit orders
• Various time-in-force options (GTC, GTT, IOC, FOK)
• Post-only and reduce-only flags
• Conditional orders (stop-loss, take-profit, trailing stops)
• Optional client order IDs for tracking

Required Fields

The following fields must be set before calling build():

• Market: Trading pair identifier
• Account: Account address
• Side: Buy or Sell
• Time in force: GTC, GTT, IOC, or FOK
• Order type: Market or Limit
• Quantity: Order size

Examples

Basic limit order:

use types::api::submit_order::SubmitOrderRequestBuilder;

let order = SubmitOrderRequestBuilder::new()
    .market("0x123")
    .account("0x123")
    .buy()
    .good_till_cancel()
    .limit_order("50000.00")
    .quantity("1.5")
    .build()
    .unwrap();

Market order with IOC:

use types::api::submit_order::SubmitOrderRequestBuilder;

let order = SubmitOrderRequestBuilder::new()
    .market("0x456")
    .account("0x456")
    .sell()
    .immediate_or_cancel()
    .market_order()
    .quantity("10.0")
    .build()
    .unwrap();

Post-only limit order with expiry:

use types::api::submit_order::SubmitOrderRequestBuilder;

let order = SubmitOrderRequestBuilder::new()
    .market("0x789")
    .account("0x789")
    .buy()
    .good_till_time(1747313713)
    .limit_order("48000.00")
    .quantity("0.5")
    .post_only(true)
    .client_order_id("order-123")
    .build()
    .unwrap();

Conditional stop-loss order (a market order must be IOC or FOK, and a conditional order carries its size in the conditional):

use types::api::submit_order::{SubmitOrderRequestBuilder, Conditional, Trigger};

let stop_loss = Conditional::builder()
    .falls_below()
    .trigger(Trigger::price("45000.00"))
    .last_trade_price()
    .absolute_quantity("1.0")
    .build()
    .unwrap();

let order = SubmitOrderRequestBuilder::new()
    .market("0xabc")
    .account("0xabc")
    .sell()
    .immediate_or_cancel()
    .market_order()
    .conditional(stop_loss)
    .build()
    .unwrap();

Implementations

impl SubmitOrderRequestBuilder

pub fn new() -> SubmitOrderRequestBuilder

Creates a new SubmitOrderRequestBuilder with all fields unset.

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new();

pub fn market<S>(self, market: S) -> SubmitOrderRequestBuilder

where S: Into<String>,

Sets the market (trading pair).

Required field - Must be set before calling build().

Arguments

• market - the market’s on-chain object id, 0x-prefixed hex. A symbol such as "BTC-USD" makes build() return InvalidFieldValue.

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .market("0x5efc5ad00c209baf4c5d77dfd1be18e8b50916e53adbe2142ae1b47af445303c");

pub fn account<S>(self, account: S) -> SubmitOrderRequestBuilder

where S: Into<String>,

Sets the account address.

Required field - Must be set before calling build().

Arguments

• account - Account address (e.g., “0x123…”)

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .account("0x1234567890abcdef");

pub fn side(self, side: Side) -> SubmitOrderRequestBuilder

Sets the order side directly.

Required field - Must be set before calling build().

Tip: Consider using buy() or sell() for better readability.

Arguments

• side - Buy or Sell

pub fn buy(self) -> SubmitOrderRequestBuilder

Sets the order side to Buy.

Required field - Must be set before calling build().

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .buy();

pub fn sell(self) -> SubmitOrderRequestBuilder

Sets the order side to Sell.

Required field - Must be set before calling build().

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .sell();

pub fn time_in_force(self, tif: TimeInForce) -> SubmitOrderRequestBuilder

Sets the time-in-force directly.

Required field - Must be set before calling build().

Tip: Consider using convenience methods like good_till_cancel(), immediate_or_cancel(), etc.

pub fn good_till_time(self, expiry_timestamp: u128) -> SubmitOrderRequestBuilder

Sets time-in-force to Good Till Time (GTT) with expiry timestamp.

The order will remain active until the specified timestamp or until filled/canceled.

Required field - Must be set before calling build().

Arguments

• expiry_timestamp - Unix timestamp in milliseconds when the order expires; must be in the future and no later than MAX_EXPIRY_TIMESTAMP_MS

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .good_till_time(1747313713);

pub fn good_till_cancel(self) -> SubmitOrderRequestBuilder

Sets time-in-force to Good Till Cancel (GTC).

The order remains active until explicitly canceled or filled.

Required field - Must be set before calling build().

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .good_till_cancel();

pub fn immediate_or_cancel(self) -> SubmitOrderRequestBuilder

Sets time-in-force to Immediate or Cancel (IOC).

The order executes immediately for any available quantity, canceling the remainder.

Required field - Must be set before calling build().

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .immediate_or_cancel();

pub fn fill_or_kill(self) -> SubmitOrderRequestBuilder

Sets time-in-force to Fill or Kill (FOK).

The order must be filled completely and immediately, or it’s canceled entirely.

Required field - Must be set before calling build().

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .fill_or_kill();

pub fn expiry_timestamp(self, timestamp: u128) -> SubmitOrderRequestBuilder

Sets the expiry timestamp for GTT orders.

Note: This is typically set via good_till_time().

Arguments

• timestamp - Unix timestamp in milliseconds when the order expires

pub fn reduce_only(self, reduce_only: bool) -> SubmitOrderRequestBuilder

Sets the reduce-only flag.

When true, the order can only reduce an existing position, not increase it. Useful for closing positions without risk of opening new ones.

Arguments

• reduce_only - Whether this order can only reduce positions

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .reduce_only(true);

pub fn post_only(self, post_only: bool) -> SubmitOrderRequestBuilder

Sets the post-only flag.

When true, the order will only be placed if it doesn’t immediately match (i.e., it becomes a maker order). Prevents the order from taking liquidity.

Arguments

• post_only - Whether this order must be a maker order

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .post_only(true);

pub fn order_type(self, order_type: OrderType) -> SubmitOrderRequestBuilder

Sets the order type directly.

Required field - Must be set before calling build().

Tip: Consider using limit_order() or market_order() for better readability.

pub fn limit_order<S>(self, price: S) -> SubmitOrderRequestBuilder

where S: Into<String>,

Sets order as a limit order with the specified price.

Limit orders execute at the specified price or better.

Required field - Must be set before calling build().

Arguments

• price - Limit price as a decimal string (e.g., “50000.00”)

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .limit_order("50000.00");

pub fn market_order(self) -> SubmitOrderRequestBuilder

Sets order as a market order.

Market orders execute immediately at the best available price.

Required field - Must be set before calling build().

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .market_order();

pub fn limit_price<S>(self, price: S) -> SubmitOrderRequestBuilder

where S: Into<String>,

Sets the limit price for limit orders.

Note: This is typically set via limit_order().

Arguments

• price - Limit price as a decimal string (e.g., “50000.00”)

pub fn quantity<S>(self, quantity: S) -> SubmitOrderRequestBuilder

where S: Into<String>,

Sets the order quantity.

Required field - Must be set before calling build().

Arguments

• quantity - Order size as a decimal string (e.g., “1.5”, “0.001”)

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .quantity("1.5");

pub fn client_order_id<S>(self, id: S) -> SubmitOrderRequestBuilder

where S: Into<String>,

Sets a client-assigned order ID for tracking.

Useful for correlating orders with your internal systems and for order linking in bracket orders.

Arguments

• id - Client order ID (e.g., “order-123”)

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let builder = SubmitOrderRequestBuilder::new()
    .client_order_id("order-123");

pub fn conditional(self, conditional: Conditional) -> SubmitOrderRequestBuilder

Sets conditional order parameters (stop-loss, take-profit, trailing stops).

Allows creating orders that only activate when certain price conditions are met.

Arguments

• conditional - Conditional configuration built with Conditional::builder()

Example

use types::api::submit_order::{SubmitOrderRequestBuilder, Conditional, Trigger};

let stop_loss = Conditional::builder()
    .falls_below()
    .trigger(Trigger::price("45000.00"))
    .last_trade_price()
    .build()
    .unwrap();

let builder = SubmitOrderRequestBuilder::new()
    .conditional(stop_loss);

pub fn build(self) -> Result<SubmitOrderRequest, SubmitOrderRequestBuilderError>

Builds the SubmitOrderRequest, consuming the builder.

Returns

• Ok(SubmitOrderRequest) - Successfully built order request
• Err(SubmitOrderRequestBuilderError) - Missing required fields or invalid configuration

Errors

Returns an error if:

• Any required field is missing (market, account, side, time_in_force, order_type, quantity)
• Limit orders are missing a price
• Market orders have a price specified
• GTT orders are missing an expiry timestamp
• Order type is Unspecified

Example

use types::api::submit_order::SubmitOrderRequestBuilder;

let order = SubmitOrderRequestBuilder::new()
    .market("0x123")
    .account("0x123")
    .buy()
    .good_till_cancel()
    .limit_order("50000.00")
    .quantity("1.5")
    .build()
    .expect("Failed to build order");

Trait Implementations

impl Debug for SubmitOrderRequestBuilder

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

Formats the value using the given formatter.

impl Default for SubmitOrderRequestBuilder

fn default() -> SubmitOrderRequestBuilder

Returns the “default value” for a type.