Struct levana_perpswap_cosmos_msg::prelude::SignedLeverageToBase

pub struct SignedLeverageToBase(/* private fields */);

The user-specified leverage for a position, with direction expressed as the signed value

Leverage is always specified by the user in terms of the base currency. In a collateral-is-quote market, that directly becomes the exposure to notional. In a collateral-is-base market, we need to convert that exposure from collateral to notional for internal calculations.

Implementations

impl SignedLeverageToBase

pub fn into_notional( self, market_type: MarketType ) -> Result<SignedLeverageToNotional, Error>

Get the leverage in terms of the notional currency.

If the MarketType is MarketType::CollateralIsQuote, the value is already in terms of notional, and no change is needed. Otherwise, in a MarketType::CollateralIsBase, we have to convert from leverage in terms of base/collateral into a notional value.

The formula for converting is leverage_to_notional = 1 - leverage_to_base. The motivation for that is:

1. Going long on notional is equivalent to going short on collateral and vice-versa, therefore we have a negative sign.

2. By holding the collateral asset, the trader already has exposure to its price fluctuation, so we need to represent that by adding 1.

pub fn split(self) -> (DirectionToBase, LeverageToBase)

Split up this value into the direction and absolute leverage.

pub fn checked_mul_base( self, base: NonZero<Base> ) -> Result<Signed<Base>, Error>

Multiply by active collateral of a position expressed in base

This returns the position size from a trader perspective, aka the exposure to the base asset.

Trait Implementations

impl Clone for SignedLeverageToBase

fn clone(&self) -> SignedLeverageToBase

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SignedLeverageToBase

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SignedLeverageToBase

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

Deserialize this value from the given Serde deserializer.

impl Display for SignedLeverageToBase

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

Formats the value using the given formatter.

impl FromStr for SignedLeverageToBase

type Err = Error

The associated error which can be returned from parsing.

fn from_str( s: &str ) -> Result<SignedLeverageToBase, <SignedLeverageToBase as FromStr>::Err>

Parses a string s to return a value of this type.

impl JsonSchema for SignedLeverageToBase

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl PartialEq for SignedLeverageToBase

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

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.

impl Copy for SignedLeverageToBase

impl StructuralPartialEq for SignedLeverageToBase