Struct spl_token_swap::curve::base::SwapCurve

#[repr(C)]
pub struct SwapCurve {
    pub curve_type: CurveType,
    pub calculator: Arc<dyn CurveCalculator + Sync + Send>,
}

Concrete struct to wrap around the trait object which performs calculation.

Fields

curve_type: CurveType

The type of curve contained in the calculator, helpful for outside queries

calculator: Arc<dyn CurveCalculator + Sync + Send>

The actual calculator, represented as a trait object to allow for many different types of curves

Implementations

impl SwapCurve

pub fn swap(
    &self,
    source_amount: u128,
    swap_source_amount: u128,
    swap_destination_amount: u128,
    trade_direction: TradeDirection,
    fees: &Fees
) -> Option<SwapResult>

Subtract fees and calculate how much destination token will be provided given an amount of source token.

pub fn deposit_single_token_type(
    &self,
    source_amount: u128,
    swap_token_a_amount: u128,
    swap_token_b_amount: u128,
    pool_supply: u128,
    trade_direction: TradeDirection,
    fees: &Fees
) -> Option<u128>

Get the amount of pool tokens for the deposited amount of token A or B

pub fn withdraw_single_token_type_exact_out(
    &self,
    source_amount: u128,
    swap_token_a_amount: u128,
    swap_token_b_amount: u128,
    pool_supply: u128,
    trade_direction: TradeDirection,
    fees: &Fees
) -> Option<u128>

Get the amount of pool tokens for the withdrawn amount of token A or B

Trait Implementations

impl Debug for SwapCurve

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

Formats the value using the given formatter.

impl Default for SwapCurve

Default implementation for SwapCurve cannot be derived because of the contained Arc.

fn default() -> Self

Returns the “default value” for a type.

impl Pack for SwapCurve

const LEN: usize = 33usize

Size of encoding of all curve parameters, which include fees and any other constants used to calculate swaps, deposits, and withdrawals. This includes 1 byte for the type, and 72 for the calculator to use as it needs. Some calculators may be smaller than 72 bytes.

fn get_packed_len() -> usize

Get the packed length

fn unpack(input: &[u8]) -> Result<Self, ProgramError> where
    Self: IsInitialized, 

Unpack from slice and check if initialized

fn unpack_unchecked(input: &[u8]) -> Result<Self, ProgramError>

Unpack from slice without checking if initialized

fn pack(src: Self, dst: &mut [u8]) -> Result<(), ProgramError>

Pack into slice

impl PartialEq<SwapCurve> for SwapCurve

Simple implementation for PartialEq which assumes that the output of Pack is enough to guarantee equality

fn eq(&self, other: &Self) -> 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 !=.

impl Sealed for SwapCurve