Struct tulipv2_sdk_common::lending::obligation::Obligation

pub struct Obligation {

    pub version: u8,
    pub last_update: LastUpdate,
    pub lending_market: Pubkey,
    pub owner: Pubkey,
    pub deposits: Vec<ObligationCollateral>,
    pub borrows: Vec<ObligationLiquidity>,
    pub borrowed_value: Decimal,
    pub vault_shares: u64,
    pub lp_tokens: u64,
    pub coin_deposits: u64,
    pub pc_deposits: u64,
    pub deposits_market_value: Decimal,
    pub lp_decimals: u8,
    pub coin_decimals: u8,
    pub pc_decimals: u8,
}

Lending market obligation state

Fields

version: u8

Version of the struct

last_update: LastUpdate

Last update to collateral, liquidity, or their market values

lending_market: Pubkey

Lending market address

owner: Pubkey

Vault address the obligation is associated with Owner authority which can borrow liquidity

deposits: Vec<ObligationCollateral>

Deposited collateral for the obligation, unique by deposit reserve address

borrows: Vec<ObligationLiquidity>

Borrowed liquidity for the obligation, unique by borrow reserve address

borrowed_value: Decimal

Market value of deposits Market value of borrows

vault_shares: u64

The maximum borrow value at the weighted average loan to value ratio The dangerous borrow value at the weighted average liquidation threshold vault shares

lp_tokens: u64

the number of lp token shares owned by this obligation when calculating loan to value ratio for obligations which have been used to borrow lp tokens, we calculate LTV using the pseudo deposits value instead of collateral value

coin_deposits: u64

the number of coin tokens owned by this obligation coin is wrt the lp token for this obligation this is used for deposit value when calculating LTV

pc_deposits: u64

the number of pc tokens owned by this obligation pc is wrt the lp token for this obligation this is used for deposit value when calculating LTV

deposits_market_value: Decimal

the market value of the user deposits includes lp (pseudo deposits), coin and pc tokens

lp_decimals: u8

the lp token pyth price account address the pc / quote pyth price account address Decimals in lp token

coin_decimals: u8

Decimals in coin

pc_decimals: u8

Decimals in pc

Implementations

impl Obligation

pub fn new(params: InitObligationParams) -> Self

Create a new obligation

pub fn init(&mut self, params: InitObligationParams)

Initialize an obligation

pub fn pseudo_loan_to_value(&self) -> Result<Decimal, ProgramError>

Calculate the current ratio of borrowed value using their pseudo deposited value instead of deposited value, allowing us to measure LTV using lp token value instead

todo(bonedaddy): add a test for this function

pub fn loan_to_value(&self) -> Result<Decimal, ProgramError>

Calculate the current ratio of borrowed value to deposited value

pub fn repay(
    &mut self,
    settle_amount: Decimal,
    liquidity_index: usize
) -> ProgramResult

Repay liquidity and remove it from borrows if zeroed out

pub fn withdraw(
    &mut self,
    withdraw_amount: u64,
    collateral_index: usize
) -> ProgramResult

Withdraw collateral and remove it from deposits if zeroed out

pub fn max_withdraw_value(&self) -> Result<Decimal, ProgramError>

Calculate the maximum collateral value that can be withdrawn

pub fn remaining_borrow_value(&self) -> Result<Decimal, ProgramError>

Calculate the maximum liquidity value that can be borrowed

pub fn max_liquidation_amount(
    &self,
    _liquidity: &ObligationLiquidity
) -> Result<Decimal, ProgramError>

Calculate the maximum liquidation amount for a given liquidity

pub fn find_collateral_in_deposits(
    &self,
    _deposit_reserve: Pubkey
) -> Result<(&ObligationCollateral, usize), ProgramError>

Find collateral by deposit reserve

pub fn find_or_add_collateral_to_deposits(
    &mut self,
    deposit_reserve: Pubkey
) -> Result<&mut ObligationCollateral, ProgramError>

Find or add collateral by deposit reserve

pub fn find_liquidity_in_borrows(
    &self,
    borrow_reserve: Pubkey
) -> Result<(&ObligationLiquidity, usize), ProgramError>

Find liquidity by borrow reserve

pub fn find_or_add_liquidity_to_borrows(
    &mut self,
    borrow_reserve: Pubkey,
    cumulative_borrow_rate_wads: Decimal
) -> Result<&mut ObligationLiquidity, ProgramError>

Find or add liquidity by borrow reserve

Trait Implementations

impl Clone for Obligation

fn clone(&self) -> Obligation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Obligation

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

Formats the value using the given formatter.

impl Default for Obligation

fn default() -> Obligation

Returns the “default value” for a type.

impl IsInitialized for Obligation

fn is_initialized(&self) -> bool

Is initialized

impl Pack for Obligation

const LEN: usize = 303usize

The length, in bytes, of the packed representation

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

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

impl StructuralPartialEq for Obligation