Enum Command 

pub enum Command {
    SubmitOrder(SubmitOrderRequest),
    CancelOrder(CancelOrderRequest),
    LiquidatePosition(LiquidatePositionRequest),
    SwitchToCross(SwitchToCrossRequest),
    SwitchToIsolated(SwitchToIsolatedRequest),
    SetImr(SetImrRequest),
    Admin(AdminRequest),
}

Command variants that can be executed within a transaction.

Each command represents a specific action that can be performed in the matching engine. Commands are validated individually before being executed.

Variants

• SubmitOrder - Submit a new order to the order book
• CancelOrder - Cancel an existing order or all orders for an account
• LiquidatePosition - Liquidate an account’s position in a market
• SwitchToCross - Switch a position’s margin mode to cross
• SwitchToIsolated - Switch a position’s margin mode to isolated
• SetImr - Set a position’s initial margin ratio
• Admin - Admin command; only accepted inside a v2 multisig transaction

Examples

use types::api::{Command, SubmitOrderRequest};

let command = Command::SubmitOrder(
    SubmitOrderRequest::builder()
        .account("0x123")
        .market("0x123")
        .buy()
        .limit_order("50000.00")
        .quantity("0.1")
        .good_till_cancel()
        .build()
        .expect("Failed to build order")
);

Variants

SubmitOrder(SubmitOrderRequest)

CancelOrder(CancelOrderRequest)

LiquidatePosition(LiquidatePositionRequest)

SwitchToCross(SwitchToCrossRequest)

SwitchToIsolated(SwitchToIsolatedRequest)

SetImr(SetImrRequest)

Admin(AdminRequest)

Implementations

impl Command

pub fn get_markets(&self) -> Vec<MarketId>

Extracts the market identifier from the command, if available.

pub fn get_account(&self) -> AccountId

Extracts the account identifier from the command. Admin commands have no account binding and return the default AccountId; the validation path skips the per-account sender check for them.

pub fn is_margin_parameter(&self) -> bool

True for the three sequencer-only margin-parameter commands. These must be alone in a transaction (batch of 1) — enforced in TransactionPayload::validate.

pub fn is_admin(&self) -> bool

True for admin commands. Admin commands are only accepted in a v2 multisig transaction; non-multisig owners attempting them are rejected in TransactionPayload::validate.

Trait Implementations

impl Clone for Command

fn clone(&self) -> Command

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Command

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Command

fn deserialize<__D>( __deserializer: __D, ) -> Result<Command, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CancelOrderRequest> for Command

fn from(value: CancelOrderRequest) -> Command

Converts to this type from the input type.

impl From<SetImrRequest> for Command

fn from(value: SetImrRequest) -> Command

Converts to this type from the input type.

impl From<SubmitOrderRequest> for Command

fn from(value: SubmitOrderRequest) -> Command

Converts to this type from the input type.

impl From<SwitchToCrossRequest> for Command

fn from(value: SwitchToCrossRequest) -> Command

Converts to this type from the input type.

impl From<SwitchToIsolatedRequest> for Command

fn from(value: SwitchToIsolatedRequest) -> Command

Converts to this type from the input type.

impl Serialize for Command

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

where __S: Serializer,

Serialize this value into the given Serde serializer.