Refactor loan repayment calculations in getBrokerUserPositions to include total penalty in outstanding amounts. Update related types and market user data to accommodate new totalPenalty field, ensuring accurate financial data representation across the SDK.

Author: tyler-tsai

packages/moolah-lending-sdk/CHANGELOG.md

@@ -1,5 +1,13 @@
 # @lista-dao/moolah-lending-sdk
 
+## 1.0.8
+
+### Patch Changes
+
+- Refactor loan repayment calculations in getBrokerUserPositions to include total penalty in outstanding amounts. Update related types and market user data to accommodate new totalPenalty field, ensuring accurate financial data representation across the SDK.
+- Updated dependencies
+  - @lista-dao/moolah-sdk-core@1.0.9
+
 ## 1.0.7
 
 ### Patch Changes

packages/moolah-lending-sdk/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lista-dao/moolah-lending-sdk",
-  "version": "1.0.7",
+  "version": "1.0.8",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",

packages/moolah-lending-sdk/src/__tests__/read/broker/getBrokerUserPositions.test.ts

@@ -0,0 +1,59 @@
+import { beforeEach, describe, expect, it, vi } from "vitest";
+import type { Address, PublicClient } from "viem";
+
+import { getBrokerUserPositions } from "../../../read/broker/getBrokerUserPositions.js";
+
+const mockReadContract = vi.fn();
+const mockPublicClient = {
+  readContract: mockReadContract,
+} as unknown as PublicClient;
+
+const BROKER = "0x1111111111111111111111111111111111111111" as Address;
+const RATE_CALCULATOR =
+  "0x2222222222222222222222222222222222222222" as Address;
+const USER = "0x3333333333333333333333333333333333333333" as Address;
+const RAY = 10n ** 27n;
+
+describe("getBrokerUserPositions - dynamic debt", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+  });
+
+  it("computes dynamic outstanding with normalizedDebt * rate / 1e27", async () => {
+    const principal = 17061806491632102441n;
+    const normalizedDebt = 16878807815476167930n;
+    const rate = 1011624315990879851775155575n;
+    const expectedOutstanding = (normalizedDebt * rate) / RAY;
+
+    mockReadContract.mockImplementation(async ({ functionName }) => {
+      switch (functionName) {
+        case "userFixedPositions":
+          return [];
+        case "getFixedTerms":
+          return [];
+        case "userDynamicPosition":
+          return { principal, normalizedDebt };
+        case "getRate":
+          return rate;
+        default:
+          throw new Error(`Unexpected function: ${String(functionName)}`);
+      }
+    });
+
+    const result = await getBrokerUserPositions(
+      mockPublicClient,
+      BROKER,
+      RATE_CALCULATOR,
+      USER,
+      18,
+    );
+
+    expect(result.dynamicOutstanding).not.toBeNull();
+    expect(result.dynamicOutstanding?.roundDown(18).numerator).toBe(
+      expectedOutstanding,
+    );
+    expect(result.totalOutstanding.roundDown(18).numerator).toBe(
+      expectedOutstanding,
+    );
+  });
+});

packages/moolah-lending-sdk/src/read/broker/getBrokerUserPositions.ts

@@ -3,7 +3,6 @@ import {
   Decimal,
   LENDING_BROKER_ABI,
   BROKER_RATE_CALCULATOR_ABI,
-  calculateDynamicLoanRepayment,
   calculateFixedLoanRepayment,
   type BrokerUserPositionsData,
   type FixedLoanPosition,
@@ -81,19 +80,18 @@ export async function getBrokerUserPositions(
   let dynamicOutstanding: Decimal | null = null;
 
   if (dynamicPosition?.principal && dynamicPosition.principal > 0n) {
-    const { totalRepay } = calculateDynamicLoanRepayment(
-      {
-        principal: dynamicPosition.principal,
-        normalizedDebt: dynamicPosition.normalizedDebt,
-        rate: dynamicRate,
-      },
+    const normalizedDebt = new Decimal(
+      dynamicPosition.normalizedDebt ?? dynamicPosition.principal,
       loanDecimals,
     );
-    dynamicOutstanding = totalRepay.roundDown(loanDecimals);
+    dynamicOutstanding = normalizedDebt
+      .mul(new Decimal(dynamicRate, 27))
+      .roundDown(loanDecimals);
   }
 
   // Calculate fixed positions data
   let fixedOutstanding = Decimal.ZERO;
+  let totalPenalty = Decimal.ZERO;
   let totalOutstanding = Decimal.ZERO;
   let weightedSum = Decimal.ZERO;
 
@@ -119,9 +117,18 @@ export async function getBrokerUserPositions(
       return;
     }
 
-    const { totalRepay } = calculateFixedLoanRepayment(position);
+    const {
+      principal: remainPrincipal,
+      interest,
+      penalty,
+    } = calculateFixedLoanRepayment(position);
+    const totalRepayNoPenalty = new Decimal(
+      remainPrincipal + interest,
+      loanDecimals,
+    );
 
-    fixedOutstanding = fixedOutstanding.add(totalRepay);
+    fixedOutstanding = fixedOutstanding.add(totalRepayNoPenalty);
+    totalPenalty = totalPenalty.add(new Decimal(penalty, loanDecimals));
 
     const duration =
       BigInt(position.end ?? 0n) > BigInt(position.start ?? 0n)
@@ -132,8 +139,8 @@ export async function getBrokerUserPositions(
       termRateByDuration.get(duration.toString()) ??
       new Decimal(normalizeAprRate(position.apr), 27);
 
-    totalOutstanding = totalOutstanding.add(totalRepay);
-    weightedSum = weightedSum.add(totalRepay.mul(normalizedFixedRate));
+    totalOutstanding = totalOutstanding.add(totalRepayNoPenalty);
+    weightedSum = weightedSum.add(totalRepayNoPenalty.mul(normalizedFixedRate));
   });
 
   // Calculate weighted borrow rate
@@ -149,6 +156,7 @@ export async function getBrokerUserPositions(
     dynamicRatePercent: currentFlexibleRate,
     dynamicOutstanding,
     fixedOutstanding,
+    totalPenalty,
     totalOutstanding,
     weightedBorrowRate,
     termRateByDuration,

packages/moolah-lending-sdk/src/read/market/getMarketUserData.ts

@@ -107,6 +107,7 @@ export async function getMarketUserData(
     fixedTermData && !fixedTermData.weightedBorrowRate.isZero()
       ? fixedTermData.weightedBorrowRate
       : marketExtraInfo.borrowRate;
+  const totalPenalty = fixedTermData?.totalPenalty ?? Decimal.ZERO;
 
   const _getExtraRepayAmount = () => {
     const now = BigInt(Math.round(Date.now() / 1000));
@@ -166,6 +167,7 @@ export async function getMarketUserData(
     collateral,
     borrowShares,
     borrowed: finalBorrowed,
+    totalPenalty,
     rawBorrowed: borrowed,
     borrowRate: finalBorrowRate,
     loanable,

packages/moolah-sdk-core/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @lista-dao/moolah-sdk-core
 
+## 1.0.9
+
+### Patch Changes
+
+- Refactor loan repayment calculations in getBrokerUserPositions to include total penalty in outstanding amounts. Update related types and market user data to accommodate new totalPenalty field, ensuring accurate financial data representation across the SDK.
+
 ## 1.0.8
 
 ### Patch Changes

packages/moolah-sdk-core/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lista-dao/moolah-sdk-core",
-  "version": "1.0.8",
+  "version": "1.0.9",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.js",

packages/moolah-sdk-core/src/brokerToUserFixedTermData.ts

@@ -14,6 +14,7 @@ export function brokerPositionsToUserFixedTermData(
     dynamicOutstanding: data.dynamicOutstanding ?? Decimal.ZERO,
     fixedOutstanding: data.fixedOutstanding,
     totalBorrowed: data.totalOutstanding,
+    totalPenalty: data.totalPenalty,
     weightedBorrowRate: data.weightedBorrowRate,
   };
 }

packages/moolah-sdk-core/src/types/broker.ts

@@ -34,6 +34,7 @@ export interface BrokerUserPositionsData {
   dynamicRatePercent: Decimal | null;
   dynamicOutstanding: Decimal | null;
   fixedOutstanding: Decimal;
+  totalPenalty: Decimal;
   totalOutstanding: Decimal;
   weightedBorrowRate: Decimal;
   termRateByDuration: Map<string, Decimal>;

packages/moolah-sdk-core/src/types/market.ts

@@ -204,6 +204,7 @@ export interface MarketUserData {
   collateral: Decimal;
   borrowShares: bigint;
   borrowed: Decimal;
+  totalPenalty: Decimal;
   rawBorrowed: Decimal;
   borrowRate: Decimal;
   loanable: Decimal;
@@ -282,5 +283,6 @@ export interface UserFixedTermData {
   dynamicOutstanding: Decimal;
   fixedOutstanding: Decimal;
   totalBorrowed: Decimal;
+  totalPenalty: Decimal;
   weightedBorrowRate: Decimal;
 }