Struct OrderRequest 

pub struct OrderRequest { /* private fields */ }

Request to post/modify an order.

Implementations

impl OrderRequest

pub fn new( request_id: RequestId, perp_id: PerpetualId, type: RequestType, order_id: Option<OrderId>, price: UD64, size: UD64, expiry_block: Option<u64>, post_only: bool, fill_or_kill: bool, immediate_or_cancel: bool, max_matches: Option<u32>, leverage: UD64, last_exec_block: Option<u64>, amount: Option<UD128>, max_neg_pnl_collat_bps: u16, ) -> Self

Create a new order request with provided parameters.

Provided [request_id] is stored as [client_order_id] once the order gets placed.

Use Self::prepare_v2 to get an OrderDesc with its order extension and then issue transactions with crate::abi::dex::Exchange::ExchangeInstance::execOrdersV2 calls, or Self::prepare for the builder-blind V1 crate::abi::dex::Exchange::ExchangeInstance::execOrders.

pub fn with_builder(self, builder: BuilderAttribution) -> Self

Attributes the order to a builder, which charges its own additive fee on the size the order adds.

Only the V2 entrypoints carry attribution: use Self::prepare_v2 to get the corresponding order extension envelope. Attribution is silently dropped by Self::prepare, as the V1 entrypoints have nothing to carry it in.

pub fn builder(&self) -> Option<BuilderAttribution>

Builder attribution of the request, if any.

pub fn prepare(&self, exchange: &Exchange) -> OrderDesc

Prepare order request for execution via the V1 entrypoints (execOrder/execOrders), which cannot carry builder attribution.

Panics

If the perpetual contract of the request is not tracked by exchange.

pub fn prepare_v2( &self, exchange: &Exchange, ) -> Result<(OrderDesc, Bytes), DexError>

Prepare order request for execution via the V2 entrypoints (execOrderV2/execOrdersV2), returning the order descriptor along with its order extension envelope.

The envelope is empty for a request without builder attribution, which is the V1-identical fast path on-chain. A batch where no order carries attribution can omit the extensions array entirely.

Fails if the request carries builder attribution the deployed contract does not support, or a builder fee rate the contract’s decoder would reject - which reverts execOrderV2 and skips the order on the batched path.

pub fn to_order_extension(&self) -> Result<Bytes, OrderExtensionError>

Order extension envelope of the request, empty without builder attribution.

Trait Implementations

impl Clone for OrderRequest

fn clone(&self) -> OrderRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OrderRequest

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

Formats the value using the given formatter.