Struct stable_swap_math::price::SaberSwap

source · [−]

pub struct SaberSwap {
    pub initial_amp_factor: u64,
    pub target_amp_factor: u64,
    pub current_ts: i64,
    pub start_ramp_ts: i64,
    pub stop_ramp_ts: i64,
    pub lp_mint_supply: u64,
    pub token_a_reserve: u64,
    pub token_b_reserve: u64,
}

Expand description

Utilities for calculating the virtual price of a Saber LP token.

This is especially useful for if you want to use a Saber LP token as collateral.

Calculating liquidation value

To use a Saber LP token as collateral, you will need to fetch the prices of both of the tokens in the pool and get the min of the two. Then, use the SaberSwap::calculate_virtual_price_of_pool_tokens function to get the virtual price.

This virtual price is resilient to manipulations of the LP token price.

Hence, min_lp_price = min_value * virtual_price.

Additional Reading

Chainlink: Using Chainlink Oracles to Securely Utilize Curve LP Pools

Fields

initial_amp_factor: u64

Initial amp factor, or A.

See StableSwap::compute_amp_factor.

target_amp_factor: u64

Target amp factor, or A.

See StableSwap::compute_amp_factor.

current_ts: i64

Current timestmap.

start_ramp_ts: i64

Start ramp timestamp for calculating the amp factor, or A.

See StableSwap::compute_amp_factor.

stop_ramp_ts: i64

Stop ramp timestamp for calculating the amp factor, or A.

See StableSwap::compute_amp_factor.

lp_mint_supply: u64

Total supply of LP tokens.

This is pool_mint.supply, where pool_mint is an SPL Token Mint.

token_a_reserve: u64

Amount of token A.

This is token_a.reserve.amount, where token_a.reserve is an SPL Token Token Account.

token_b_reserve: u64

Amount of token B.

This is token_b.reserve.amount, where token_b.reserve is an SPL Token Token Account.

Implementations

source

impl SaberSwap

source

pub fn calculate_pool_tokens_from_virtual_amount(
&self,
virtual_amount: u64
) -> Option<u64>

Calculates the amount of pool tokens represented by the given amount of virtual tokens.

A virtual token is the denomination of virtual price. For example, if there is a virtual price of 1.04 on USDC-USDT LP, then 1 virtual token maps to 1/1.04 USDC-USDT LP tokens.

This is useful for building assets that are backed by LP tokens. An example of this is Cashio, which allows users to mint $CASH tokens based on the virtual price of underlying LP tokens.

Arguments

virtual_amount - The number of “virtual” underlying tokens.

source

pub fn calculate_virtual_price_of_pool_tokens(
&self,
pool_token_amount: u64
) -> Option<u64>

Calculates the virtual price of the given amount of pool tokens.

The virtual price is defined as the current price of the pool LP token relative to the underlying pool assets.

The virtual price in the StableSwap algorithm is obtained through taking the invariance of the pool, which by default takes every token as valued at 1.00 of the underlying. You can get the virtual price of each pool by calling this function for it.¹

Source: https://blog.chain.link/using-chainlink-oracles-to-securely-utilize-curve-lp-pools/ ↩

source

pub fn compute_d(&self) -> Option<U192>

Computes D, which is the virtual price times the total supply of the pool.

Trait Implementations

source

impl Clone for SaberSwap

source

fn clone(&self) -> SaberSwap

Returns a copy of the value. Read more

This method tests for !=.

source

impl StructuralPartialEq for SaberSwap

Auto Trait Implementations

impl RefUnwindSafe for SaberSwap

impl Send for SaberSwap

impl Sync for SaberSwap

impl Unpin for SaberSwap

impl UnwindSafe for SaberSwap

Blanket Implementations

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct stable_swap_math::price::SaberSwap

Fields

Implementations

impl SaberSwap

pub fn calculate_pool_tokens_from_virtual_amount( &self, virtual_amount: u64) -> Option<u64>

pub fn calculate_virtual_price_of_pool_tokens( &self, pool_token_amount: u64) -> Option<u64>

pub fn compute_d(&self) -> Option<U192>

Trait Implementations

impl Clone for SaberSwap

fn clone(&self) -> SaberSwap

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

impl Debug for SaberSwap

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

impl Default for SaberSwap

fn default() -> SaberSwap

impl From<&'_ SaberSwap> for StableSwap

fn from(swap: &SaberSwap) -> Self

impl PartialEq<SaberSwap> for SaberSwap

fn eq(&self, other: &SaberSwap) -> bool

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

impl Copy for SaberSwap

impl Eq for SaberSwap

impl StructuralEq for SaberSwap

impl StructuralPartialEq for SaberSwap

Auto Trait Implementations

impl RefUnwindSafe for SaberSwap

impl Send for SaberSwap

impl Sync for SaberSwap

impl Unpin for SaberSwap

impl UnwindSafe for SaberSwap

Blanket Implementations

impl<T> AbiExample for T

default fn example() -> T

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn calculate_pool_tokens_from_virtual_amount(
&self,
virtual_amount: u64
) -> Option<u64>

pub fn calculate_virtual_price_of_pool_tokens(
&self,
pool_token_amount: u64
) -> Option<u64>

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,