Struct StopOrderTicket 

pub struct StopOrderTicket<T: MoveType> {
    pub id: UID,
    pub executors: MoveVec<Address>,
    pub gas: Balance<SUI>,
    pub account_id: u64,
    pub stop_order_type: u64,
    pub encrypted_details: MoveVec<u8>,
    /* private fields */
}

Object that allows to place one order on behalf of the user, used to offer stop limit or market orders. A stop order is an order that is placed only if the index price respects certain conditions, like being above or below a certain price.

Only the AccountCap owner can mint this object and can decide who can be the executor of the ticket. This allows users to run their own stop orders bots eventually, but it’s mainly used to allow 3rd parties to offer such a service (the user is required to trust such 3rd party). The object is shared and the 3rd party is set as executors. The ticket can be destroyed in any moment only by the user or by the executor. The user needs to trust the 3rd party for liveness of the service offered.

The order details are encrypted offchain and the result is stored in the ticket. The user needs to share such details with the 3rd party only to allow for execution.

The ticket can be either a shared, owned or party object. The permission to execute or cancel it is controlled exclusively through executors, which can be modified only by the AccountCap owner associated with the ticket using the function edit_stop_order_ticket_executors.

Fields

id: UID

executors: MoveVec<Address>

Addresses allowed to execute the order on behalf of the user.

gas: Balance<SUI>

The executor collects the gas in case the order is placed or canceled for any reason. The user gets back the gas in case he manually cancels the order.

account_id: u64

User account id

stop_order_type: u64

Value to indentify the stop order type. Available values can be found in the constants module.

encrypted_details: MoveVec<u8>

Vector containing the blake2b hash obtained from offchain on the stop order parameters. Depending on the stop order type value, a different set of parameters is expected to be used.

Parameters encoded for a SLTP stop order (stop_order_type code 0):

• clearing_house_id: ID
• expire_timestamp: Option
• is_limit_order: true if limit order, false if market order
• stop_index_price: u256
• is_stop_loss: true if stop loss order, false if take profit order
• position_is_ask: true if position is short, false if position is long
• size: u64
• price: u64 (can be set at random value if is_limit_order is false)
• order_type: u64 (can be set at random value if is_limit_order is false)
• salt: vector

Parameters encoded for a Standalone stop order (stop_order_type code 1):

• clearing_house_id: ID
• expire_timestamp: Option
• is_limit_order: true if limit order, false if market order
• stop_index_price: u256
• ge_stop_index_price: true means the order can be placed when oracle index price is >= than chosen stop_index_price
• side: bool
• size: u64
• price: u64 (can be set at random value if is_limit_order is false)
• order_type: u64 (can be set at random value if is_limit_order is false)
• reduce_only: bool
• salt: vector

Implementations

impl<T: MoveType> StopOrderTicket<T>

pub fn new( id: UID, executors: MoveVec<Address>, gas: Balance<SUI>, account_id: u64, stop_order_type: u64, encrypted_details: MoveVec<u8>, ) -> Self

Constructs a new StopOrderTicket.

impl<T: MoveType> StopOrderTicket<T>

pub fn move_instance( self, address: Address, t: <T as MoveType>::TypeTag, ) -> MoveInstance<Self>

pub fn type_( address: Address, t: <T as MoveType>::TypeTag, ) -> StopOrderTicketTypeTag<T>

Trait Implementations

impl<T: Clone + MoveType> Clone for StopOrderTicket<T>

fn clone(&self) -> StopOrderTicket<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + MoveType> Debug for StopOrderTicket<T>

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

Formats the value using the given formatter.

impl<'de, T: MoveType> Deserialize<'de> for StopOrderTicket<T>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: MoveType> Display for StopOrderTicket<T>

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

Formats the value using the given formatter.

impl<T: MoveType> HasKey for StopOrderTicket<T>

fn object_id(&self) -> Address

impl<T: Hash + MoveType> Hash for StopOrderTicket<T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: MoveType> MoveStruct for StopOrderTicket<T>

type StructTag = StopOrderTicketTypeTag<T>

impl<T: MoveType> MoveType for StopOrderTicket<T>

type TypeTag = StopOrderTicketTypeTag<T>

fn from_bcs(bytes: &[u8]) -> Result<Self, Error>

Deserialize the contents of the Move type from BCS bytes.

fn into_bcs(self) -> Result<Vec<u8>, Error>

Consuming version of to_bcs.

fn to_bcs(&self) -> Result<Vec<u8>, Error>

Serialize the contents of the Move type to BCS bytes.

fn into_json(self) -> Value

Consuming version of to_json.

fn to_json(&self) -> Value

Serialize the contents of the Move type to JSON.

impl<T: PartialEq + MoveType> PartialEq for StopOrderTicket<T>

fn eq(&self, other: &StopOrderTicket<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: MoveType> Serialize for StopOrderTicket<T>

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: MoveType> StaticModule for StopOrderTicket<T>

fn module() -> Identifier

impl<T: MoveType> StaticName for StopOrderTicket<T>

fn name() -> Identifier

impl<T: MoveType + StaticTypeTag> StaticTypeParams for StopOrderTicket<T>

fn type_params() -> Vec<TypeTag>

impl<T: MoveType> Tabled for StopOrderTicket<T>

const LENGTH: usize

A length of fields and headers, which must be the same.

fn fields(&self) -> Vec<Cow<'_, str>>

Fields method must return a list of cells.

fn headers() -> Vec<Cow<'static, str>>

Headers must return a list of column names.

impl<T: Eq + MoveType> Eq for StopOrderTicket<T>

impl<T: MoveType> StructuralPartialEq for StopOrderTicket<T>