Struct BorrowPositionGuard

pub struct BorrowPositionGuard<'a>(/* private fields */);

Implementations

impl<'a> BorrowPositionGuard<'a>

pub fn new( market: &'a mut Market, account_id: AccountId, position: BorrowPosition, ) -> Self

pub fn record_collateral_asset_deposit( &mut self, _proof: InterestAccumulationProof, amount: CollateralAssetAmount, )

pub fn record_collateral_asset_withdrawal( &mut self, _proof: InterestAccumulationProof, amount: CollateralAssetAmount, )

pub fn record_borrow_initial( &mut self, _proof: SnapshotProof, _interest: InterestAccumulationProof, amount: BorrowAssetAmount, price_pair: &PricePair, block_timestamp_ms: u64, ) -> Result<InitialBorrow, InitialBorrowError>

Errors

• If there is not enough borrow asset available to borrow.
• If there is an error calculating the fee (e.g. overflow).

pub fn record_borrow_final( &mut self, _snapshot: SnapshotProof, interest: InterestAccumulationProof, borrow: &InitialBorrow, success: bool, block_timestamp_ms: u64, )

pub fn record_repay( &mut self, proof: InterestAccumulationProof, amount: BorrowAssetAmount, ) -> Result<BorrowAssetAmount, LiquidationLockError>

Returns the amount that is left over after repaying the whole position. That is, the return value is the number of tokens that may be returned to the owner of the borrow position.

Errors

• If any collateral is locked for liquidation.

pub fn accumulate_interest_partial(&mut self, snapshot_limit: u32)

pub fn accumulate_interest(&mut self) -> InterestAccumulationProof

pub fn liquidation_lock(&mut self, amount: CollateralAssetAmount)

pub fn liquidation_unlock(&mut self, amount: CollateralAssetAmount)

pub fn record_liquidation_initial( &mut self, _proof: InterestAccumulationProof, liquidator_sent: BorrowAssetAmount, liquidator_request: Option<CollateralAssetAmount>, price_pair: &PricePair, block_timestamp_ms: u64, ) -> Result<InitialLiquidation, InitialLiquidationError>

Errors

• If this record is not eligible for liquidation.
• If the liquidator requests to liquidate too much collateral from the position.
• If the calculation of the collateral value fails.
• If the liquidator offers too little to purchase the collateral.

pub fn record_liquidation_final( &mut self, proof: InterestAccumulationProof, liquidator_id: AccountId, initial_liquidation: &InitialLiquidation, )

Methods from Deref<Target = BorrowPositionRef<&'a mut Market>>

pub fn account_id(&self) -> &AccountId

pub fn inner(&self) -> &BorrowPosition

pub fn estimate_current_snapshot_interest(&self) -> BorrowAssetAmount

pub fn with_pending_interest(&mut self)

pub fn status( &self, price_pair: &PricePair, block_timestamp_ms: u64, ) -> BorrowStatus

pub fn within_allowable_borrow_range(&self) -> bool

pub fn liquidatable_collateral( &self, price_pair: &PricePair, ) -> CollateralAssetAmount

Trait Implementations

impl<'a> Deref for BorrowPositionGuard<'a>

type Target = BorrowPositionRef<&'a mut Market>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for BorrowPositionGuard<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl Drop for BorrowPositionGuard<'_>

fn drop(&mut self)

Executes the destructor for this type.