Enum port_variable_rate_lending_instructions::instruction::LendingInstruction

pub enum LendingInstruction {
    RefreshReserve,
    DepositReserveLiquidity {
        liquidity_amount: u64,
    },
    RedeemReserveCollateral {
        collateral_amount: u64,
    },
    InitObligation,
    RefreshObligation,
    DepositObligationCollateral {
        collateral_amount: u64,
    },
    WithdrawObligationCollateral {
        collateral_amount: u64,
    },
    BorrowObligationLiquidity {
        liquidity_amount: u64,
    },
    RepayObligationLiquidity {
        liquidity_amount: u64,
    },
    LiquidateObligation {
        liquidity_amount: u64,
    },
    FlashLoan {
        amount: u64,
    },
    DepositReserveLiquidityAndObligationCollateral {
        liquidity_amount: u64,
    },
}

Instructions supported by the lending program.

Variants

RefreshReserve

Accrue interest and update market price of liquidity on a reserve.

Accounts expected by this instruction:

0. [writable] Reserve account.
1. [] Clock sysvar.
2. [] Reserve liquidity oracle account. Must be the Pyth price account specified at InitReserve.

DepositReserveLiquidity

Fields

liquidity_amount: u64

Amount of liquidity to deposit in exchange for collateral tokens

Deposit liquidity into a reserve in exchange for collateral. Collateral represents a share of the reserve liquidity pool.

Accounts expected by this instruction:

0. [writable] Source liquidity token account. $authority can transfer $liquidity_amount.
1. [writable] Destination collateral token account.
2. [writable] Reserve account.
3. [writable] Reserve liquidity supply SPL Token account.
4. [writable] Reserve collateral SPL Token mint.
5. [] Lending market account.
6. [] Derived lending market authority.
7. [signer] User transfer authority ($authority).
8. [] Clock sysvar.
9. [] Token program id.

RedeemReserveCollateral

Fields

collateral_amount: u64

Amount of collateral tokens to redeem in exchange for liquidity

Redeem collateral from a reserve in exchange for liquidity.

Accounts expected by this instruction:

0. [writable] Source collateral token account. $authority can transfer $collateral_amount.
1. [writable] Destination liquidity token account.
2. [writable] Reserve account.
3. [writable] Reserve collateral SPL Token mint.
4. [writable] Reserve liquidity supply SPL Token account.
5. [] Lending market account.
6. [] Derived lending market authority.
7. [signer] User transfer authority ($authority).
8. [] Clock sysvar.
9. [] Token program id.

InitObligation

Initializes a new lending market obligation.

Accounts expected by this instruction:

0. [writable] Obligation account - uninitialized.
1. [] Lending market account.
2. [signer] Obligation owner.
3. [] Clock sysvar.
4. [] Rent sysvar.
5. [] Token program id.

RefreshObligation

Refresh an obligation’s accrued interest and collateral and liquidity prices. Requires refreshed reserves, as all obligation collateral deposit reserves in order, followed by all liquidity borrow reserves in order.

Accounts expected by this instruction:

0. [writable] Obligation account.
1. [] Clock sysvar. .. [] Collateral deposit reserve accounts - refreshed, all, in order. .. [] Liquidity borrow reserve accounts - refreshed, all, in order.

DepositObligationCollateral

Fields

collateral_amount: u64

Amount of collateral tokens to deposit

Deposit collateral to an obligation. Requires a refreshed reserve.

Accounts expected by this instruction:

0. [writable] Source collateral token account. Minted by deposit reserve collateral mint. $authority can transfer $collateral_amount.
1. [writable] Destination deposit reserve collateral supply SPL Token account.
2. [] Deposit reserve account - refreshed.
3. [writable] Obligation account.
4. [] Lending market account.
5. [] Derived lending market authority.
6. [signer] Obligation owner.
7. [signer] User transfer authority ($authority).
8. [] Clock sysvar.
9. [] Token program id. 10 [writable, optional] Stake account. 11 [writable, optional] Staking pool. 12 [optional] staking program id.

WithdrawObligationCollateral

Fields

collateral_amount: u64

Amount of collateral tokens to withdraw - u64::MAX for up to 100% of deposited amount

Withdraw collateral from an obligation. Requires a refreshed obligation and reserve.

Accounts expected by this instruction:

0. [writable] Source withdraw reserve collateral supply SPL Token account.
1. [writable] Destination collateral token account. Minted by withdraw reserve collateral mint.
2. [] Withdraw reserve account - refreshed.
3. [writable] Obligation account - refreshed.
4. [] Lending market account.
5. [] Derived lending market authority.
6. [signer] Obligation owner.
7. [] Clock sysvar.
8. [] Token program id.
9. [writable, optional] Stake account. 10 [writable, optional] Staking pool. 11 [optional] staking program id.

BorrowObligationLiquidity

Fields

liquidity_amount: u64

Amount of liquidity to borrow - u64::MAX for 100% of borrowing power

Borrow liquidity from a reserve by depositing collateral tokens. Requires a refreshed obligation and reserve.

Accounts expected by this instruction:

0. [writable] Source borrow reserve liquidity supply SPL Token account.
1. [writable] Destination liquidity token account. Minted by borrow reserve liquidity mint.
2. [writable] Borrow reserve account - refreshed.
3. [writable] Borrow reserve liquidity fee receiver account. Must be the fee account specified at InitReserve.
4. [writable] Obligation account - refreshed.
5. [] Lending market account.
6. [] Derived lending market authority.
7. [signer] Obligation owner.
8. [] Clock sysvar.
9. [] Token program id.

RepayObligationLiquidity

Fields

liquidity_amount: u64

Amount of liquidity to repay - u64::MAX for 100% of borrowed amount

Repay borrowed liquidity to a reserve. Requires a refreshed obligation and reserve.

Accounts expected by this instruction:

0. [writable] Source liquidity token account. Minted by repay reserve liquidity mint. $authority can transfer $liquidity_amount.
1. [writable] Destination repay reserve liquidity supply SPL Token account.
2. [writable] Repay reserve account - refreshed.
3. [writable] Obligation account - refreshed.
4. [] Lending market account.
5. [signer] User transfer authority ($authority).
6. [] Clock sysvar.
7. [] Token program id.

LiquidateObligation

Fields

liquidity_amount: u64

Amount of liquidity to repay - u64::MAX for up to 100% of borrowed amount

Repay borrowed liquidity to a reserve to receive collateral at a discount from an unhealthy obligation. Requires a refreshed obligation and reserves.

Accounts expected by this instruction:

0. [writable] Source liquidity token account. Minted by repay reserve liquidity mint. $authority can transfer $liquidity_amount.
1. [writable] Destination collateral token account. Minted by withdraw reserve collateral mint.
2. [writable] Repay reserve account - refreshed.
3. [writable] Repay reserve liquidity supply SPL Token account.
4. [] Withdraw reserve account - refreshed.
5. [writable] Withdraw reserve collateral supply SPL Token account.
6. [writable] Obligation account - refreshed.
7. [] Lending market account.
8. [] Derived lending market authority.
9. [signer] User transfer authority ($authority). 10 [] Clock sysvar. 11 [] Token program id. 14 [writable, optional] Deposit stake account. 15 [writable, optional] Deposit staking pool. 16 [optional] staking program id.

FlashLoan

Fields

amount: u64

The amount that is to be borrowed - u64::MAX for up to 100% of available liquidity

Make a flash loan.

Accounts expected by this instruction:

0. [writable] Source liquidity token account. Minted by reserve liquidity mint. Must match the reserve liquidity supply.
1. [writable] Destination liquidity token account. Minted by reserve liquidity mint.
2. [writable] Reserve account.
3. [] Lending market account.
4. [] Derived lending market authority.
5. [] Flash loan receiver program account. Must implement an instruction that has tag of 0 and a signature of (repay_amount: u64) This instruction must return the amount to the source liquidity account.
6. [] Token program id.
7. [writable] Flash loan fee receiver account. Must match the reserve liquidity fee receiver.
8. [writable] Host fee receiver. .. [any] Additional accounts expected by the receiving program’s ReceiveFlashLoan instruction.

The flash loan receiver program that is to be invoked should contain an instruction with tag 0 and accept the total amount (including fee) that needs to be returned back after its execution has completed.

Flash loan receiver should have an instruction with the following signature:

0. [writable] Source liquidity (matching the destination from above).
1. [writable] Destination liquidity (matching the source from above).
2. [] Token program id .. [any] Additional accounts provided to the lending program’s FlashLoan instruction above. ReceiveFlashLoan { // Amount that is loaned to the receiver program amount: u64 }

DepositReserveLiquidityAndObligationCollateral

Fields

liquidity_amount: u64

Amount of liquidity to deposit in exchange

Combines DepositReserveLiquidity and DepositObligationCollateral

Accounts expected by this instruction:

0. [writable] Source liquidity token account. $authority can transfer $liquidity_amount.
1. [writable] Destination collateral token account.
2. [writable] Reserve account.
3. [writable] Reserve liquidity supply SPL Token account.
4. [writable] Reserve collateral SPL Token mint.
5. [] Lending market account.
6. [] Derived lending market authority.
7. [writable] Destination deposit reserve collateral supply SPL Token account.
8. [writable] Obligation account.
9. [signer] Obligation owner. 10 [signer] User transfer authority ($authority). 11 [] Clock sysvar. 12 [] Token program id. 13 [writable, optional] Stake account. 14 [writable, optional] Staking pool. 15 [optional] staking program id.

Implementations

impl LendingInstruction

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

Unpacks a byte buffer into a LendingInstruction.

pub fn pack(&self) -> Vec<u8>

Packs a LendingInstruction into a byte buffer.

Trait Implementations

impl Clone for LendingInstruction

fn clone(&self) -> LendingInstruction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LendingInstruction

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

Formats the value using the given formatter.

impl PartialEq<LendingInstruction> for LendingInstruction

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for LendingInstruction