optimize dlc event and cet query

Author: keithsue

api/side/lending/query.pulsar.go

@@ -133,6 +133,7 @@ message QueryDlcEventCountResponse {
 
 message QueryLoanCetInfosRequest {
     string loan_id = 1;
+    string collateral_amount = 2;
 }
 
 message QueryLoanCetInfosResponse {

docs/static/openapi.yml

@@ -8,8 +8,10 @@ import (
 	"github.com/btcsuite/btcd/btcutil/psbt"
 	"github.com/btcsuite/btcd/txscript"
 
+	sdkmath "cosmossdk.io/math"
 	sdk "github.com/cosmos/cosmos-sdk/types"
 
+	dlctypes "github.com/sideprotocol/side/x/dlc/types"
 	"github.com/sideprotocol/side/x/lending/types"
 )
 
@@ -132,34 +134,50 @@ func (k Keeper) UpdateDLCMeta(ctx sdk.Context, loanId string, depositTxs []*psbt
 }
 
 // UpdateDLCEvent updates the dlc event of the given loan
-func (k Keeper) UpdateDLCEvent(ctx sdk.Context, loanId string) {
-	loan := k.GetLoan(ctx, loanId)
-
+func (k Keeper) UpdateDLCEvent(ctx sdk.Context, loan *types.Loan) {
 	dlcEvent := k.dlcKeeper.GetEvent(ctx, loan.DlcEventId)
 
 	// update description
-	dlcEvent.Description = fmt.Sprintf("DLC event for loan %s", loanId)
+	dlcEvent.Description = fmt.Sprintf("DLC event for loan %s", loan.VaultAddress)
+
+	liquidatedOutcome := "" // will be populated once the liquidation price is available
+	defaultLiquidatedOutcome := fmt.Sprintf("%d", loan.MaturityTime)
+	repaidOutcome := "Repaid"
 
 	// update outcomes
 	dlcEvent.Outcomes = []string{
-		"Liquidated",
-		"Default liquidated",
-		"Repaid",
+		liquidatedOutcome,
+		defaultLiquidatedOutcome,
+		repaidOutcome,
 	}
 
 	k.dlcKeeper.SetEvent(ctx, dlcEvent)
 }
 
+// UpdateDLCEventLiquidatedOutcome populates the 'liquidated' outcome for the dlc event with the specified liquidation price
+func (k Keeper) UpdateDLCEventLiquidatedOutcome(ctx sdk.Context, loan *types.Loan, dlcEvent *dlctypes.DLCEvent, liquidationPrice sdkmath.LegacyDec) {
+	pool := k.GetPool(ctx, loan.PoolId)
+
+	dlcEvent.Outcomes[types.LiquidatedOutcomeIndex] = types.FormatPriceWithPair(liquidationPrice, types.GetPricePair(pool.Config))
+}
+
 // GetCetInfos gets the related cet infos of the given loan
 // Assume that the loan exists
-func (k Keeper) GetCetInfos(ctx sdk.Context, loanId string) ([]*types.CetInfo, error) {
+func (k Keeper) GetCetInfos(ctx sdk.Context, loanId string, collateralAmount sdk.Coin) ([]*types.CetInfo, error) {
 	loan := k.GetLoan(ctx, loanId)
 	dlcMeta := k.GetDLCMeta(ctx, loanId)
 
 	liquidationScript, liquidationScriptControlBlock, _ := types.UnwrapLeafScript(dlcMeta.LiquidationScript)
 	repaymentScript, repaymentScriptControlBlock, _ := types.UnwrapLeafScript(dlcMeta.RepaymentScript)
 
 	dlcEvent := k.dlcKeeper.GetEvent(ctx, loan.DlcEventId)
+	if len(dlcEvent.Outcomes[types.LiquidatedOutcomeIndex]) == 0 {
+		// calculate the liquidation price
+		liquidationPrice := k.GetLiquidationPrice(ctx, loan, collateralAmount.Amount)
+
+		// update the dlc event outcome
+		k.UpdateDLCEventLiquidatedOutcome(ctx, loan, dlcEvent, liquidationPrice)
+	}
 
 	liquidationCetInfo, _ := types.GetCetInfo(dlcEvent, types.LiquidatedOutcomeIndex, liquidationScript, liquidationScriptControlBlock)
 	defaultLiquidationCetInfo, _ := types.GetCetInfo(dlcEvent, types.DefaultLiquidatedOutcomeIndex, liquidationScript, liquidationScriptControlBlock)

proto/side/lending/query.proto

@@ -222,6 +222,17 @@ func (k Keeper) GetRepayment(ctx sdk.Context, loanId string) *types.Repayment {
 	return &repayment
 }
 
+// GetLiquidationPrice gets the liquidation price of the given loan according to the specified collateral amount
+func (k Keeper) GetLiquidationPrice(ctx sdk.Context, loan *types.Loan, collateralAmount sdkmath.Int) sdkmath.LegacyDec {
+	pool := k.GetPool(ctx, loan.PoolId)
+
+	collateralDecimals := int(pool.Config.CollateralAsset.Decimals)
+	borrowDecimals := int(pool.Config.LendingAsset.Decimals)
+	collateralIsBaseAsset := pool.Config.CollateralAsset.IsBasePriceAsset
+
+	return types.GetLiquidationPrice(collateralAmount, collateralDecimals, loan.BorrowAmount.Amount, borrowDecimals, loan.Maturity, loan.BorrowAPR, k.GetBlocksPerYear(ctx), pool.Config.LiquidationThreshold, collateralIsBaseAsset)
+}
+
 // GetCurrentBorrowIndex gets the current borrow index of the given loan
 // Assume that the loan maturity exists in the pool tranches
 func (k Keeper) GetCurrentBorrowIndex(ctx sdk.Context, loan *types.Loan) sdkmath.LegacyDec {

x/lending/keeper/dlc.go

@@ -122,7 +122,7 @@ func (m msgServer) Apply(goCtx context.Context, msg *types.MsgApply) (*types.Msg
 	m.SetDLCMeta(ctx, loan.VaultAddress, dlcMeta)
 
 	// update dlc event
-	m.UpdateDLCEvent(ctx, loan.VaultAddress)
+	m.UpdateDLCEvent(ctx, loan)
 
 	ctx.EventManager().EmitEvent(
 		sdk.NewEvent(types.EventTypeApply,
@@ -160,9 +160,6 @@ func (m msgServer) SubmitCets(goCtx context.Context, msg *types.MsgSubmitCets) (
 		return nil, errorsmod.Wrap(types.ErrInvalidLoanStatus, "loan non requested")
 	}
 
-	pool := m.GetPool(ctx, loan.PoolId)
-	poolConfig := pool.Config
-
 	vaultPkScript, _ := types.GetPkScriptFromAddress(loan.VaultAddress)
 
 	depositTxs := []*psbt.Packet{}
@@ -186,7 +183,12 @@ func (m msgServer) SubmitCets(goCtx context.Context, msg *types.MsgSubmitCets) (
 		return nil, errorsmod.Wrap(types.ErrInsufficientCollateral, "collateral amount can not be zero")
 	}
 
+	// calculate liquidation price
+	liquidationPrice := m.GetLiquidationPrice(ctx, loan, collateralAmount)
+
+	// update dlc event outcome
 	dlcEvent := m.dlcKeeper.GetEvent(ctx, loan.DlcEventId)
+	m.UpdateDLCEventLiquidatedOutcome(ctx, loan, dlcEvent, liquidationPrice)
 
 	// verify cets
 	if err := types.VerifyCets(depositTxs, vaultPkScript, loan.BorrowerPubKey, loan.BorrowerAuthPubKey, loan.DCM, dlcEvent, msg.LiquidationCet, msg.LiquidationAdaptorSignatures, msg.DefaultLiquidationAdaptorSignatures, msg.RepaymentCet, msg.RepaymentSignatures); err != nil {
@@ -214,20 +216,16 @@ func (m msgServer) SubmitCets(goCtx context.Context, msg *types.MsgSubmitCets) (
 		}
 	}
 
-	collateralDecimals := int(poolConfig.CollateralAsset.Decimals)
-	borrowDecimals := int(poolConfig.LendingAsset.Decimals)
-	collateralIsBaseAsset := poolConfig.CollateralAsset.IsBasePriceAsset
-
-	// calculate liquidation price
-	liquidationPrice := types.GetLiquidationPrice(collateralAmount, collateralDecimals, loan.BorrowAmount.Amount, borrowDecimals, loan.Maturity, loan.BorrowAPR, m.GetBlocksPerYear(ctx), poolConfig.LiquidationThreshold, collateralIsBaseAsset)
-
 	// update loan
 	loan.Authorizations = append(loan.Authorizations, *authorization)
 	loan.CollateralAmount = collateralAmount
 	loan.LiquidationPrice = liquidationPrice
 	loan.Status = types.LoanStatus_Authorized
 	m.SetLoan(ctx, loan)
 
+	// update dlc event
+	m.dlcKeeper.SetEvent(ctx, dlcEvent)
+
 	return &types.MsgSubmitCetsResponse{}, nil
 }
 

x/lending/keeper/loan.go

@@ -213,7 +213,23 @@ func (k Keeper) LoanCetInfos(goCtx context.Context, req *types.QueryLoanCetInfos
 		return nil, status.Error(codes.InvalidArgument, "loan does not exist")
 	}
 
-	cetInfos, err := k.GetCetInfos(ctx, req.LoanId)
+	loan := k.GetLoan(ctx, req.LoanId)
+
+	var err error
+	var collateralAmount sdk.Coin
+
+	if loan.LiquidationPrice.IsZero() {
+		collateralAmount, err = sdk.ParseCoinNormalized(req.CollateralAmount)
+		if err != nil {
+			return nil, status.Error(codes.InvalidArgument, err.Error())
+		}
+
+		if !collateralAmount.IsPositive() {
+			return nil, status.Error(codes.InvalidArgument, "collateral amount must be positive")
+		}
+	}
+
+	cetInfos, err := k.GetCetInfos(ctx, req.LoanId, collateralAmount)
 	if err != nil {
 		return nil, status.Error(codes.Internal, err.Error())
 	}