Enum Trigger 

pub enum Trigger {
    Price(String),
    NumericTrailingDistance(String),
    PercentageTrailingDistance(String),
}

Defines the trigger mechanism for conditional orders.

This enum specifies how a conditional order should be triggered, supporting both fixed price triggers and dynamic trailing triggers that adjust with market movement.

Variants

• Price: Triggers at a specific fixed price level. The only variant the sequencer accepts.
• NumericTrailingDistance: reserved — rejected with TrailingStopTriggersNotSupported (125)
• PercentageTrailingDistance: reserved — rejected with TrailingStopTriggersNotSupported (125)

Field Aliases

All variants support compact aliases for efficient serialization:

• Price can be serialized as "trigger_price" or "tp"
• NumericTrailingDistance can be serialized as "trigger_numeric_trailing_distance" or "tntd"
• PercentageTrailingDistance can be serialized as "trigger_percentage_trailing_distance" or "tptd"

Examples

Fixed price trigger

use types::api::submit_order::Trigger;

let trigger = Trigger::price("50000.00");

Numeric trailing stop (follows price by fixed amount)

use types::api::submit_order::Trigger;

// Trigger when price moves $1000 from its peak
let trailing_trigger = Trigger::numeric_trailing_distance("1000.0");

Percentage trailing stop (follows price by percentage)

use types::api::submit_order::Trigger;

// Trigger when price drops 5% from its peak
let percentage_trigger = Trigger::percentage_trailing_distance("0.05");

JSON Examples

Fixed price trigger:

{"trigger_price": "50000.00"}
// or using alias:
{"tp": "50000.00"}

Trailing stop triggers:

{"trigger_numeric_trailing_distance": "1000.0"}
{"trigger_percentage_trailing_distance": "0.05"}
// or using aliases:
{"tntd": "1000.0"}
{"tptd": "0.05"}

Variants

Price(String)

Triggers when the reference price reaches a specific fixed price level.

This is the most straightforward trigger type, activating when the chosen reference price (last trade, index, or mark) reaches the specified value.

Example

• Trigger when BTC price reaches $50,000: Price("50000.00")

NumericTrailingDistance(String)

Triggers when the reference price moves a fixed numeric distance from its peak/trough.

This creates a trailing trigger that follows price movements while maintaining a constant numeric distance. The distance is measured from the most favorable price seen since the trigger was activated.

Behavior

• For buy orders (falls_below): Triggers when price drops by the specified amount from its highest point
• For sell orders (rises_above): Triggers when price rises by the specified amount from its lowest point

Example

• Trigger when BTC drops $2000 from its peak: NumericTrailingDistance("2000.5")

PercentageTrailingDistance(String)

Triggers when the reference price moves a percentage distance from its peak/trough.

This creates a trailing trigger that follows price movements while maintaining a constant percentage distance. The percentage is calculated from the most favorable price seen since the trigger was activated.

Behavior

• For buy orders (falls_below): Triggers when price drops by the specified percentage from its highest point
• For sell orders (rises_above): Triggers when price rises by the specified percentage from its lowest point

Format

The percentage should be expressed as a decimal (e.g., “0.05” for 5%, “0.10” for 10%)

Example

• Trigger when BTC drops 5% from its peak: PercentageTrailingDistance("0.05")

Implementations

impl Trigger

pub fn price<S>(price: S) -> Trigger

where S: Into<String>,

Create a Price trigger

pub fn numeric_trailing_distance<S>(distance: S) -> Trigger

where S: Into<String>,

Create a NumericTrailingDistance trigger

pub fn percentage_trailing_distance<S>(percentage: S) -> Trigger

where S: Into<String>,

Create a PercentageTrailingDistance trigger

Trait Implementations

impl Clone for Trigger

fn clone(&self) -> Trigger

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Trigger

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Trigger

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Trigger

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.