Struct TradingFunction

pub struct TradingFunction {
    pub component: BareTradingFunction,
    pub pair: TradingPair,
}

Fields

component: BareTradingFunction

pair: TradingPair

Implementations

impl TradingFunction

pub fn new(pair: TradingPair, fee: u32, p: Amount, q: Amount) -> Self

pub fn matches_input(&self, input_id: Id) -> bool

Checks that the specified input’s asset type matches either end of this the trading function’s pair. Returns true if so, false otherwise.

pub fn fill( &self, input: Value, reserves: &Reserves, ) -> Result<(Value, Reserves, Value)>

Fills a trade of an input value against this position, returning the unfilled amount of the input asset, the updated reserves, and the output amount.

Errors

This method errors if:

• the asset type of the input does not match either end of the TradingPair.
• an overflow occurs during execution.

pub fn fill_output( &self, reserves: &Reserves, output: Value, ) -> Result<Option<(Reserves, Value)>>

Attempts to compute the input value required to produce the given output value, returning the input value and updated reserves if successful. Returns None if the output value exceeds the liquidity of the reserves.

Errors

This method errors if:

• The asset type of the output does not match either end of the reserves.
• An overflow occurs during the computation.

pub fn orient_end(&self, end: Id) -> Option<BareTradingFunction>

pub fn orient_start(&self, start: Id) -> Option<BareTradingFunction>

Trait Implementations

impl Clone for TradingFunction

fn clone(&self) -> TradingFunction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TradingFunction

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TradingFunction

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for TradingFunction

type Proto = TradingFunction

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<TradingFunction> for TradingFunction

fn from(phi: TradingFunction) -> Self

Converts to this type from the input type.

impl PartialEq for TradingFunction

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TradingFunction> for TradingFunction

type Error = Error

The type returned in the event of a conversion error.

fn try_from(phi: TradingFunction) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for TradingFunction

impl StructuralPartialEq for TradingFunction