Struct order_book::LimitOrder

pub struct LimitOrder<T>where
    T: Config,{
    pub id: T::OrderId,
    pub owner: T::AccountId,
    pub side: PriceVariant,
    pub price: OrderPrice,
    pub original_amount: OrderVolume,
    pub amount: OrderVolume,
    pub time: MomentOf<T>,
    pub lifespan: MomentOf<T>,
    pub expires_at: BlockNumberFor<T>,
}

GTC Limit Order

Fields

id: T::OrderId

owner: T::AccountId

side: PriceVariant

price: OrderPrice

Price is specified in OrderBookId quote asset. It should be a base asset of DEX.

original_amount: OrderVolume

amount: OrderVolume

Amount of OrderBookId base asset

time: MomentOf<T>

lifespan: MomentOf<T>

expires_at: BlockNumberFor<T>

Implementations

impl<T: Config + Sized> LimitOrder<T>

pub fn new( id: T::OrderId, owner: T::AccountId, side: PriceVariant, price: OrderPrice, amount: OrderVolume, time: MomentOf<T>, lifespan: MomentOf<T>, current_block: BlockNumberFor<T> ) -> Self

pub fn ensure_valid(&self) -> Result<(), DispatchError>

pub fn is_empty(&self) -> bool

pub fn deal_amount( &self, role: MarketRole, base_amount_to_take: Option<OrderVolume> ) -> Result<OrderAmount, DispatchError>

Returns appropriate deal amount of asset. Used to get total amount of associated asset if order is executed.

If base_amount_to_take defined, it is used as base asset amount involved in the deal, otherwise the limit order amount is fully involved in the deal. base_amount_to_take cannot be greater then limit order amount.

If limit order is Buy - it means maker wants to buy and taker wants to sell amount of base asset for quote asset at the price In this case if order is executed, maker receives appropriate amount of base asset and taker receives appropriate amount of quote asset.

If limit order is Sell - it means maker wants to sell and taker wants to buy amount of base asset that they have for quote asset at the price In this case if order is executed, maker receives appropriate amount of quote asset and taker receives appropriate amount of base asset.

Trait Implementations

impl<T> Clone for LimitOrder<T>where T: Config + Clone, T::OrderId: Clone, T::AccountId: Clone,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for LimitOrder<T>where T: Config + Debug, T::OrderId: Debug, T::AccountId: Debug,

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

Formats the value using the given formatter.

impl<T> Decode for LimitOrder<T>where T: Config, T::OrderId: Decode, T::AccountId: Decode, MomentOf<T>: Decode, BlockNumberFor<T>: Decode,

fn decode<__CodecInputEdqy: Input>( __codec_input_edqy: &mut __CodecInputEdqy ) -> Result<Self, Error>

Attempt to deserialise the value from input.

fn decode_into<I>( input: &mut I, dst: &mut MaybeUninit<Self> ) -> Result<DecodeFinished, Error>where I: Input,

Attempt to deserialize the value from input into a pre-allocated piece of memory.

fn skip<I>(input: &mut I) -> Result<(), Error>where I: Input,

Attempt to skip the encoded value from input.

fn encoded_fixed_size() -> Option<usize>

Returns the fixed encoded size of the type.

impl<T> Encode for LimitOrder<T>where T: Config, T::OrderId: Encode, T::AccountId: Encode, MomentOf<T>: Encode, BlockNumberFor<T>: Encode,

fn size_hint(&self) -> usize

If possible give a hint of expected size of the encoding.

fn encode_to<__CodecOutputEdqy: Output + ?Sized>( &self, __codec_dest_edqy: &mut __CodecOutputEdqy )

Convert self to a slice and append it to the destination.

fn encode(&self) -> Vec<u8, Global>

Convert self to an owned vector.

fn using_encoded<R, F>(&self, f: F) -> Rwhere F: FnOnce(&[u8]) -> R,

Convert self to a slice and then invoke the given closure with it.

fn encoded_size(&self) -> usize

Calculates the encoded size.

impl<T> MaxEncodedLen for LimitOrder<T>where T: Config, T::OrderId: MaxEncodedLen, T::AccountId: MaxEncodedLen, MomentOf<T>: MaxEncodedLen, BlockNumberFor<T>: MaxEncodedLen,

fn max_encoded_len() -> usize

Upper bound, in bytes, of the maximum encoded size of this item.

impl<T> PartialEq<LimitOrder<T>> for LimitOrder<T>where T: Config + PartialEq, T::OrderId: PartialEq, T::AccountId: PartialEq,

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<T> TypeInfo for LimitOrder<T>where T: Config + 'static, T::OrderId: TypeInfo + 'static, T::AccountId: TypeInfo + 'static, MomentOf<T>: TypeInfo + 'static, BlockNumberFor<T>: TypeInfo + 'static,

type Identity = LimitOrder<T>

The type identifying for which type info is provided.

fn type_info() -> Type

Returns the static type identifier for Self.

impl<T> EncodeLike<LimitOrder<T>> for LimitOrder<T>where T: Config, T::OrderId: Encode, T::AccountId: Encode, MomentOf<T>: Encode, BlockNumberFor<T>: Encode,

impl<T> Eq for LimitOrder<T>where T: Config + Eq, T::OrderId: Eq, T::AccountId: Eq,

impl<T> StructuralEq for LimitOrder<T>where T: Config,

impl<T> StructuralPartialEq for LimitOrder<T>where T: Config,