templar_market_contract/

impl_helper.rs

use near_sdk::{env, near, require, serde_json, AccountId, Gas, Promise, PromiseResult};
use templar_common::{
    asset::{
        BorrowAsset, BorrowAssetAmount, CollateralAsset, CollateralAssetAmount, FungibleAsset,
        ReturnStyle,
    },
    borrow::InitialBorrow,
    market::{LiquidateMsg, Withdrawal},
    oracle::pyth::OracleResponse,
    price::PricePair,
    self_ext,
    withdrawal_queue::WithdrawalQueueExecutionResult,
};

use crate::{Contract, ContractExt};

/// Internal helpers.
impl Contract {
    pub fn retrieve_price_pair(&self) -> Promise {
        self.configuration
            .price_oracle_configuration
            .retrieve_price_pair()
    }

    pub fn price_pair(&self, oracle_response: OracleResponse) -> PricePair {
        self.configuration
            .price_oracle_configuration
            .create_price_pair(&oracle_response)
            .unwrap_or_else(|e| templar_common::panic_with_message(&e.to_string()))
    }

    pub fn execute_supply(&mut self, account_id: AccountId, amount: BorrowAssetAmount) {
        if self.supply_position_ref(account_id.clone()).is_none() {
            self.charge_for_storage(
                &account_id,
                self.storage_usage_supply_position + self.storage_usage_snapshot * 2,
            );
        }

        let snapshot = self.snapshot();
        let mut supply_position = self.get_or_create_supply_position_guard(snapshot, account_id);
        let proof = supply_position.accumulate_yield();
        supply_position.record_deposit(proof, amount, env::block_timestamp_ms());
        require!(
            supply_position.is_within_allowable_range(),
            "New supply position is outside of allowable range",
        );
    }

    pub fn execute_collateralize(
        &mut self,
        account_id: AccountId,
        amount: CollateralAssetAmount,
        price_pair: &PricePair,
    ) {
        // TODO: This creates a borrow record implicitly. If we
        // require a discrete "sign-up" step, we will need to add
        // checks before this function call.
        //
        // The sign-up step would only be NFT gating or something of
        // that sort, which is just an additional pre condition check.
        // -- https://github.com/Templar-Protocol/contract-mvp/pull/6#discussion_r1923871982
        if self.borrow_position_ref(account_id.clone()).is_none() {
            self.charge_for_storage(
                &account_id,
                self.storage_usage_borrow_position + self.storage_usage_snapshot * 2,
            );
        }

        let snapshot = self.snapshot();
        let mut borrow_position = self.get_or_create_borrow_position_guard(snapshot, account_id);
        let proof = borrow_position.accumulate_interest();
        borrow_position.record_collateral_asset_deposit(proof, amount);
        require!(
            !borrow_position
                .status(price_pair, env::block_timestamp_ms())
                .is_liquidation(),
            "Position is eligible for liquidation after collateralization",
        );
    }

    /// Returns the amount that should be returned to the account.
    pub fn execute_repay(
        &mut self,
        account_id: AccountId,
        amount: BorrowAssetAmount,
        price_pair: &PricePair,
    ) -> BorrowAssetAmount {
        let snapshot = self.snapshot();
        let Some(mut borrow_position) = self.borrow_position_guard(snapshot, account_id) else {
            // No borrow exists: just return the whole amount.
            return amount;
        };
        let proof = borrow_position.accumulate_interest();
        require!(
            !borrow_position
                .status(price_pair, env::block_timestamp_ms())
                .is_liquidation(),
            "Cannot repay when eligible for liquidation",
        );
        // Returns the amount that should be returned to the borrower.
        borrow_position.record_repay(proof, amount)
    }
}

/// External helpers.
#[near]
impl Contract {
    // 3.9 Tgas
    pub const GAS_BORROW_01_CONSUME_PRICE: Gas = Gas::from_tgas(6)
        .saturating_add(FungibleAsset::<BorrowAsset>::GAS_FT_TRANSFER)
        .saturating_add(Self::GAS_BORROW_02_FINALIZE);

    #[private]
    pub fn borrow_01_consume_price(
        &mut self,
        account_id: AccountId,
        amount: BorrowAssetAmount,
        #[callback_unwrap] oracle_response: OracleResponse,
    ) -> Promise {
        let price_pair = self.price_pair(oracle_response);
        let snapshot = self.snapshot();

        let Some(mut borrow_position) = self.borrow_position_guard(snapshot, account_id.clone())
        else {
            templar_common::panic_with_message(
                "No borrower record. Please deposit collateral first.",
            );
        };

        let interest = borrow_position.accumulate_interest();

        let initial_borrow = borrow_position
            .record_borrow_initial(
                snapshot,
                interest,
                amount,
                &price_pair,
                env::block_timestamp_ms(),
            )
            .unwrap_or_else(|e| templar_common::panic_with_message(&e.to_string()));

        drop(borrow_position);

        self.configuration
            .borrow_asset
            .transfer(account_id.clone(), amount)
            .then(
                self_ext!(Self::GAS_BORROW_02_FINALIZE)
                    .borrow_02_finalize(account_id, initial_borrow),
            )
    }

    // 3.1 Tgas
    pub const GAS_BORROW_02_FINALIZE: Gas = Gas::from_tgas(6);

    #[private]
    pub fn borrow_02_finalize(&mut self, account_id: AccountId, initial_borrow: InitialBorrow) {
        let snapshot = self.snapshot();
        let Some(mut borrow_position) = self.borrow_position_guard(snapshot, account_id) else {
            templar_common::panic_with_message(
                "Invariant violation: borrow position does not exist after transfer.",
            );
        };

        let proof = borrow_position.accumulate_interest();
        #[allow(deprecated)]
        let success = matches!(env::promise_result(0), PromiseResult::Successful(_));
        borrow_position.record_borrow_final(
            snapshot,
            proof,
            &initial_borrow,
            success,
            env::block_timestamp_ms(),
        );
    }

    // ~5.8 Tgas
    pub const GAS_EXECUTE_NEXT_SUPPLY_WITHDRAWAL_REQUEST_01_FINALIZE: Gas = Gas::from_tgas(8);

    #[private]
    pub fn execute_next_supply_withdrawal_request_01_finalize(
        &mut self,
        resolutions: Vec<Withdrawal>,
        result: WithdrawalQueueExecutionResult,
    ) -> WithdrawalQueueExecutionResult {
        let snapshot = self.snapshot();

        for (i, resolution) in resolutions.iter().enumerate() {
            #[allow(deprecated)]
            let succeeded = matches!(env::promise_result(i as u64), PromiseResult::Successful(_));

            if let Some(mut position) =
                self.supply_position_guard(snapshot, resolution.account_id.clone())
            {
                position.record_withdrawal_final(resolution, succeeded);
            }

            if succeeded && self.cleanup_supply_position(&resolution.account_id) {
                self.refund_for_storage(&resolution.account_id, self.storage_usage_supply_position);
            }
        }

        result
    }

    // ~3.4 TGas
    pub const GAS_COLLATERALIZE_TRANSFER_CALL_01_CONSUME_PRICE: Gas = Gas::from_tgas(6);

    #[private]
    pub fn collateralize_transfer_call_01_consume_price(
        &mut self,
        account_id: AccountId,
        amount: CollateralAssetAmount,
        return_style: ReturnStyle,
        #[callback_unwrap] oracle_response: OracleResponse,
    ) -> serde_json::Value {
        let price_pair = self.price_pair(oracle_response);

        self.execute_collateralize(account_id, amount, &price_pair);

        return_style.serialize(CollateralAssetAmount::zero())
    }

    // ~4.3 TGas
    pub const GAS_REPAY_TRANSFER_CALL_01_CONSUME_PRICE: Gas = Gas::from_tgas(7);

    #[private]
    pub fn repay_transfer_call_01_consume_price(
        &mut self,
        account_id: AccountId,
        amount: BorrowAssetAmount,
        return_style: ReturnStyle,
        #[callback_unwrap] oracle_response: OracleResponse,
    ) -> serde_json::Value {
        let price_pair = self.price_pair(oracle_response);

        let amount = self.execute_repay(account_id, amount, &price_pair);

        return_style.serialize(amount)
    }

    // ~5.3 Tgas
    pub const GAS_LIQUIDATE_TRANSFER_CALL_01_CONSUME_PRICE: Gas = Gas::from_tgas(7)
        .saturating_add(FungibleAsset::<CollateralAsset>::GAS_FT_TRANSFER)
        .saturating_add(Self::GAS_LIQUIDATE_TRANSFER_CALL_02_FINALIZE);

    #[private]
    pub fn liquidate_transfer_call_01_consume_price(
        &mut self,
        liquidator_id: AccountId,
        amount: BorrowAssetAmount,
        msg: LiquidateMsg,
        return_style: ReturnStyle,
        #[callback_unwrap] oracle_response: OracleResponse,
    ) -> Promise {
        let price_pair = self
            .configuration
            .price_oracle_configuration
            .create_price_pair(&oracle_response)
            .unwrap_or_else(|e| templar_common::panic_with_message(&e.to_string()));

        let result = {
            let snapshot = self.snapshot();
            let mut borrow_position = self
                .borrow_position_guard(snapshot, msg.account_id.clone())
                .unwrap_or_else(|| {
                    templar_common::panic_with_message("Borrow position does not exist")
                });

            let proof = borrow_position.accumulate_interest();

            borrow_position
                .record_liquidation(
                    proof,
                    liquidator_id.clone(),
                    amount,
                    msg.amount,
                    &price_pair,
                    env::block_timestamp_ms(),
                )
                .unwrap_or_else(|e| templar_common::panic_with_message(&e.to_string()))
        };

        if self.cleanup_borrow_position(&msg.account_id) {
            self.refund_for_storage(&msg.account_id, self.storage_usage_borrow_position);
        }

        self.configuration
            .collateral_asset
            .transfer(liquidator_id.clone(), result.liquidated)
            .then(
                self_ext!(Self::GAS_LIQUIDATE_TRANSFER_CALL_02_FINALIZE)
                    .liquidate_transfer_call_02_finalize(result.refund, return_style),
            )
    }

    // ~2.1 Tgas
    pub const GAS_LIQUIDATE_TRANSFER_CALL_02_FINALIZE: Gas = Gas::from_tgas(4);

    /// Called during liquidation process; checks whether the transfer of
    /// collateral to the liquidator was successful.
    #[private]
    pub fn liquidate_transfer_call_02_finalize(
        &mut self,
        refund: BorrowAssetAmount,
        return_style: ReturnStyle,
    ) -> serde_json::Value {
        // let success = matches!(env::promise_result(0), PromiseResult::Successful(_));
        // If the transfer of collateral failed, it could mean:
        //
        // 1. The liquidator has opted-out of storage management for the
        //  collateral token. This can be due to negligence or malice, but
        //  we cannot be sure, so we cannot refund the tokens, because
        //  that would allow a borrow position in liquidation to
        //  indefinitely lock their collateral from being liquidated.
        //
        // 2. Somehow the contract does not have enough collateral
        //  available. This would be indicative of a *fundamental flaw*
        //  in the contract (i.e. this should never happen).

        return_style.serialize(refund)
    }

    // ~5.0 Tgas
    pub const GAS_WITHDRAW_COLLATERAL_01_CONSUME_PRICE: Gas = Gas::from_tgas(7)
        .saturating_add(FungibleAsset::<CollateralAsset>::GAS_FT_TRANSFER)
        .saturating_add(Self::GAS_WITHDRAW_COLLATERAL_02_FINALIZE);

    #[private]
    pub fn withdraw_collateral_01_consume_price(
        &mut self,
        account_id: AccountId,
        amount: CollateralAssetAmount,
        #[callback_unwrap] oracle_response: OracleResponse,
    ) -> Promise {
        let price_pair = self.price_pair(oracle_response);

        let snapshot = self.snapshot();
        let Some(mut borrow_position) = self.borrow_position_guard(snapshot, account_id.clone())
        else {
            templar_common::panic_with_message(
                "No borrower record. Please deposit collateral first.",
            );
        };

        let proof = borrow_position.accumulate_interest();
        borrow_position.record_collateral_asset_withdrawal_initial(proof, amount);

        require!(
            borrow_position
                .status(&price_pair, env::block_timestamp_ms())
                .is_healthy(),
            "Borrow position must be healthy after collateral withdrawal",
        );

        drop(borrow_position);

        self.configuration
            .collateral_asset
            .transfer(account_id.clone(), amount)
            .then(
                self_ext!(Self::GAS_WITHDRAW_COLLATERAL_02_FINALIZE)
                    .withdraw_collateral_02_finalize(account_id, amount),
            )
    }

    // ~2.2 Tgas
    pub const GAS_WITHDRAW_COLLATERAL_02_FINALIZE: Gas = Gas::from_tgas(5);

    #[private]
    pub fn withdraw_collateral_02_finalize(
        &mut self,
        account_id: AccountId,
        amount: CollateralAssetAmount,
    ) {
        #[allow(deprecated)]
        let succeeded = matches!(env::promise_result(0), PromiseResult::Successful(_));

        let snapshot = self.snapshot();
        let Some(mut position) = self.borrow_position_guard(snapshot, account_id.clone()) else {
            templar_common::panic_with_message(
                "Invariant violation: Borrow position must exist after collateral withdrawal.",
            );
        };

        let proof = position.accumulate_interest();
        position.record_collateral_asset_withdrawal_final(proof, amount, succeeded);

        if succeeded {
            drop(position);
            if self.cleanup_borrow_position(&account_id) {
                self.refund_for_storage(&account_id, self.storage_usage_borrow_position);
            }
        }
    }

    // ~2.1 Tgas
    pub const GAS_WITHDRAW_STATIC_YIELD_01_FINALIZE: Gas = Gas::from_tgas(5);

    #[private]
    pub fn withdraw_static_yield_01_finalize(
        &mut self,
        account_id: AccountId,
        amount: BorrowAssetAmount,
    ) {
        #[allow(deprecated)]
        if matches!(env::promise_result(0), PromiseResult::Failed) {
            let mut yield_record = self.static_yield.get(&account_id).unwrap_or_else(|| {
                templar_common::panic_with_message(
                    "Invariant violation: static yield entry must exist during callback",
                )
            });
            yield_record.add_once(amount);
            self.static_yield.insert(&account_id, &yield_record);
            self.borrow_asset_balance += amount;
        }
    }
}