Struct OrderBuilder 

pub struct OrderBuilder { /* private fields */ }

Order builder.

Note that the price input to the OrderBuilder is in the “common” units of the perpetual/currency, not the quantized/atomic value.

Two main classes of orders in dYdX from persistence perspective are short-term and long-term (stateful) orders.

For different types of orders see also Stop-Limit Versus Stop-Loss and Perpetual order types on dYdX Chain.

Implementations

impl OrderBuilder

pub fn new( market_params: OrderMarketParams, subaccount_owner: String, subaccount_number: u32, client_id: u32, ) -> Self

Create a new Order builder.

pub fn market(self, side: OrderSide, size: Decimal) -> Self

Set as Market order.

An instruction to immediately buy or sell an asset at the best available price when the order is placed.

pub fn limit(self, side: OrderSide, price: Decimal, size: Decimal) -> Self

Set as Limit order.

With a limit order, a trader specifies the price at which they’re willing to buy or sell an asset. Unlike market orders, limit orders don’t go into effect until the market price hits a trader’s “limit price.”

pub fn stop_limit( self, side: OrderSide, price: Decimal, trigger_price: Decimal, size: Decimal, ) -> Self

Set as Stop Limit order.

Stop-limit orders use a stop trigger_price and a limit price to give investors greater control over their trades.

pub fn stop_market( self, side: OrderSide, trigger_price: Decimal, size: Decimal, ) -> Self

Set as Stop Market order.

When using a stop order, the trader sets a trigger_price to trigger a buy or sell order on their exchange.

pub fn take_profit_limit( self, side: OrderSide, price: Decimal, trigger_price: Decimal, size: Decimal, ) -> Self

Set as Take Profit Limit order.

The order enters in force if the price reaches trigger_price and is executed at price after that.

pub fn take_profit_market( self, side: OrderSide, trigger_price: Decimal, size: Decimal, ) -> Self

Set as Take Profit Market order.

The order enters in force if the price reaches trigger_price and converts to an ordinary market order.

pub fn long_term(self) -> Self

Set order as a long-term order.

pub fn short_term(self) -> Self

Set order as a short-term order.

pub fn conditional(self) -> Self

Set order as a conditional order, triggered using trigger_price.

pub fn price(self, price: Decimal) -> Self

Set the limit price for Limit orders.

pub fn size(self, size: Decimal) -> Self

Set position size.

pub fn time_in_force(self, tif: OrderTimeInForce) -> Self

Set time execution options.

pub fn reduce_only(self, reduce: bool) -> Self

Set an order as reduce-only.

pub fn until(self, gtof: OrderGoodUntil) -> Self

Set order’s expiration.

pub fn build(self) -> Result<Order, Error>

Build the order.

Errors

Returns an error if the order parameters are invalid.

Trait Implementations

impl Clone for OrderBuilder

fn clone(&self) -> OrderBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderBuilder

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

Formats the value using the given formatter.

impl Default for OrderBuilder

fn default() -> Self

Returns the “default value” for a type.