@curvefi/llamalend-api 2.0.10 → 2.0.11

package/docs/SUPPORT_LLv2.md

@@ -469,6 +469,36 @@ market.loan.estimateGas.repay({ debt, address?, shrink? })  // params: { debt: T
 | forceUpdateUserState() | ✅ | ✅ | ✅ | ✅ | ✅ |
 | getCurrentLeverageParams() | ✅ | ✅ | ✅ | ✅ | ✅ |
 
+### `isSoftLiquidation` field in `userState` / `userStateBigInt`
+
+The `userState` and `userStateBigInt` methods now include an `isSoftLiquidation` field in their return value.
+
+**Updated return types:**
+
+```ts
+// userState
+market.userPosition.userState(address?: string): Promise<{
+  collateral: string,
+  borrowed: string,
+  debt: string,
+  N: string,
+  isSoftLiquidation: boolean,
+}>
+
+// userStateBigInt
+market.userPosition.userStateBigInt(address?: string): Promise<{
+  _collateral: bigint,
+  _borrowed: bigint,
+  _debt: bigint,
+  _N: bigint,
+  isSoftLiquidation: boolean,
+}>
+```
+
+**Logic:** `isSoftLiquidation` is `true` when the user has an active loan (`debt > 0`) and the AMM has partially converted collateral into the borrowed token (`borrowed > 0`).
+
+**Note:** Also applies to mint markets (`MintMarketTemplate`). In mint markets the field is returned by `userState` and is `true` when `stablecoin > 0` (the stablecoin amount reflects converted collateral in the AMM).
+
 ---
 
 ## Leverage Module (`market.leverage`)

package/lib/lendMarkets/interfaces/common/userPosition.d.ts

@@ -6,6 +6,7 @@ export interface IUserPosition {
         _borrowed: bigint;
         _debt: bigint;
         _N: bigint;
+        isSoftLiquidation: boolean;
     }>;
     userBandsBigInt: (address: string) => Promise<bigint[]>;
     userState: (address?: string) => Promise<{
@@ -13,6 +14,7 @@ export interface IUserPosition {
         borrowed: string;
         debt: string;
         N: string;
+        isSoftLiquidation: boolean;
     }>;
     userHealth: (full?: boolean, address?: string) => Promise<string>;
     userBands: (address?: string) => Promise<number[]>;

package/lib/lendMarkets/modules/common/userPosition.d.ts

@@ -12,12 +12,14 @@ export declare class UserPositionModule implements IUserPosition {
         borrowed: string;
         debt: string;
         N: string;
+        isSoftLiquidation: boolean;
     }>;
     userStateBigInt(address?: string): Promise<{
         _collateral: bigint;
         _borrowed: bigint;
         _debt: bigint;
         _N: bigint;
+        isSoftLiquidation: boolean;
     }>;
     userHealth(full?: boolean, address?: string): Promise<string>;
     private _userBands;

package/lib/lendMarkets/modules/common/userPosition.js

@@ -38,12 +38,14 @@ export class UserPositionModule {
                 borrowed: formatUnits(_borrowed, this.market.borrowed_token.decimals),
                 debt: formatUnits(_debt, this.market.borrowed_token.decimals),
                 N: formatUnits(_N, 0),
+                isSoftLiquidation: !!_debt && !!_borrowed,
             };
         });
     }
     userStateBigInt() {
         return __awaiter(this, arguments, void 0, function* (address = "") {
-            return yield this._userState(address);
+            const state = yield this._userState(address);
+            return Object.assign(Object.assign({}, state), { isSoftLiquidation: !!state._debt && !!state._borrowed });
         });
     }
     userHealth() {

package/lib/mintMarkets/MintMarketTemplate.d.ts

@@ -176,6 +176,7 @@ export declare class MintMarketTemplate {
         collateral: string;
         stablecoin: string;
         debt: string;
+        isSoftLiquidation: boolean;
     }>;
     userLoss(userAddress?: string): Promise<{
         deposited_collateral: string;

package/lib/mintMarkets/MintMarketTemplate.js

@@ -515,6 +515,7 @@ export class MintMarketTemplate {
                 collateral: formatUnits(_collateral, this.collateralDecimals),
                 stablecoin: formatUnits(_stablecoin),
                 debt: formatUnits(_debt),
+                isSoftLiquidation: !!_debt && !!_stablecoin,
             };
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/llamalend-api",
-  "version": "2.0.10",
+  "version": "2.0.11",
   "description": "JavaScript library for Curve Lending",
   "main": "lib/index.js",
   "author": "Macket",

package/src/lendMarkets/interfaces/common/userPosition.ts

@@ -2,9 +2,9 @@ import {IDict} from "../../../interfaces";
 
 export interface IUserPosition {
     userLoanExists: (address?: string) => Promise<boolean>,
-    userStateBigInt: (address?: string) => Promise<{ _collateral: bigint, _borrowed: bigint, _debt: bigint, _N: bigint }>,
+    userStateBigInt: (address?: string) => Promise<{ _collateral: bigint, _borrowed: bigint, _debt: bigint, _N: bigint, isSoftLiquidation: boolean }>,
     userBandsBigInt:(address: string) => Promise<bigint[]>,
-    userState: (address?: string) => Promise<{ collateral: string, borrowed: string, debt: string, N: string }>,
+    userState: (address?: string) => Promise<{ collateral: string, borrowed: string, debt: string, N: string, isSoftLiquidation: boolean }>,
     userHealth: (full?: boolean, address?: string) => Promise<string>,
     userBands: (address?: string) => Promise<number[]>,
     userRange: (address?: string) => Promise<number>,

package/src/lendMarkets/modules/common/userPosition.ts

@@ -36,7 +36,7 @@ export class UserPositionModule implements IUserPosition {
         maxAge: 10 * 1000, // 10s
     });
 
-    public async userState(address = ""): Promise<{ collateral: string, borrowed: string, debt: string, N: string }> {
+    public async userState(address = ""): Promise<{ collateral: string, borrowed: string, debt: string, N: string, isSoftLiquidation: boolean }> {
         const { _collateral, _borrowed, _debt, _N } = await this._userState(address);
 
         return {
@@ -44,11 +44,13 @@ export class UserPositionModule implements IUserPosition {
             borrowed: formatUnits(_borrowed, this.market.borrowed_token.decimals),
             debt: formatUnits(_debt, this.market.borrowed_token.decimals),
             N: formatUnits(_N, 0),
+            isSoftLiquidation: !!_debt && !!_borrowed,
         };
     }
 
-    public async userStateBigInt(address = ""): Promise<{ _collateral: bigint, _borrowed: bigint, _debt: bigint, _N: bigint }> {
-        return await this._userState(address);
+    public async userStateBigInt(address = ""): Promise<{ _collateral: bigint, _borrowed: bigint, _debt: bigint, _N: bigint, isSoftLiquidation: boolean }> {
+        const state = await this._userState(address);
+        return { ...state, isSoftLiquidation: !!state._debt && !!state._borrowed };
     }
 
     public async userHealth(full = true, address = ""): Promise<string> {

package/src/mintMarkets/MintMarketTemplate.ts

@@ -536,13 +536,14 @@ export class MintMarketTemplate {
         return { _collateral, _stablecoin, _debt }
     }
 
-    public async userState(address = ""): Promise<{ collateral: string, stablecoin: string, debt: string }> {
+    public async userState(address = ""): Promise<{ collateral: string, stablecoin: string, debt: string, isSoftLiquidation: boolean }> {
         const { _collateral, _stablecoin, _debt } = await this._userState(address);
 
         return {
             collateral: formatUnits(_collateral, this.collateralDecimals),
             stablecoin: formatUnits(_stablecoin),
             debt: formatUnits(_debt),
+            isSoftLiquidation: !!_debt && !!_stablecoin,
         };
     }