Struct Position

pub struct Position {
    pub state: State,
    pub reserves: Reserves,
    pub phi: TradingFunction,
    pub nonce: [u8; 32],
    pub close_on_fill: bool,
}

Encapsulates the immutable parts of the position (phi/nonce), along with the mutable parts (state/reserves).

Fields

state: State

reserves: Reserves

phi: TradingFunction

A trading function to a specific trading pair.

nonce: [u8; 32]

A random value used to disambiguate different positions with the exact same trading function. The position ID is a hash of the trading function and the nonce; the chain rejects transactions creating duplicate position Ids, so it can track position ownership with a sequence of stateful NFTs based on the Id.

close_on_fill: bool

Set to true if a position is a limit-order, meaning that it will be closed after being filled against.

Implementations

impl Position

pub fn interpret_as_buy(&self) -> Option<BuyOrder>

Attempts to interpret this position as a “buy order”.

If both of the reserves are nonzero, returns None.

pub fn interpret_as_sell(&self) -> Option<SellOrder>

Attempts to interpret this position as a “sell order”.

If both of the reserves are nonzero, returns None.

pub fn interpret_as_mixed(&self) -> Option<(SellOrder, SellOrder)>

Interprets a position with mixed reserves as a pair of “sell orders”.

impl Position

pub fn new<R: CryptoRngCore>( rng: R, pair: DirectedTradingPair, fee: u32, p: Amount, q: Amount, reserves: Reserves, ) -> Position

Construct a new opened Position with a random nonce.

The p value is the coefficient for the position’s trading function that will be associated with the start asset, and the q value is the coefficient for the end asset.

The reserves r1 and r2 also correspond to the start and end assets, respectively.

pub fn new_with_nonce( nonce: [u8; 32], pair: DirectedTradingPair, fee: u32, p: Amount, q: Amount, reserves: Reserves, ) -> Position

Construct a new opened Position with a supplied random nonce.

pub fn id(&self) -> Id

Get the ID of this position.

pub fn check_stateless(&self) -> Result<()>

pub fn reserves_for(&self, asset: Id) -> Option<Amount>

Returns the amount of the given asset that is currently in the position’s reserves.

pub fn reserves_1(&self) -> Value

Returns the amount of reserves for asset 1.

pub fn reserves_2(&self) -> Value

Returns the amount of reserves for asset 2.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Position

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for Position

type Proto = Position

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl From<Position> for EventPositionOpen

fn from(value: Position) -> Self

Converts to this type from the input type.

impl From<Position> for Position

fn from(p: Position) -> Self

Converts to this type from the input type.

impl PartialEq for Position

fn eq(&self, other: &Position) -> 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 Serialize for Position

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<Position> for Position

type Error = Error

The type returned in the event of a conversion error.

fn try_from(p: Position) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Position

impl StructuralPartialEq for Position