@curvefi/llamalend-api 2.3.0 → 2.3.2

package/docs/SUPPORT_LLv2.md

@@ -378,6 +378,7 @@ On the frontend, the value that we now return as **`totalAssets`** corresponds t
 | repay() | ✅ | ✅ | ❌ | ❌ | ✅ |
 | repayFutureLeverage() | ✅ | ✅ | ✅ | ✅ | ✅ |
 
+
 #### Shrink mechanism (v2 only)
 
 In v2, the `repay` operation supports a new **shrink** mode that allows users to exit soft-liquidation by cutting the converted part of their position.
@@ -391,8 +392,8 @@ Before shrink: `| c | c | c | c | c | c | c_a + b_a | b | b | b |`
 After shrink (6 bands): `| c + c_a/6 | c + c_a/6 | c + c_a/6 | c + c_a/6 | c + c_a/6 | c + c_a/6 |`
 
 **Constraints:**
-- User must have at least 4 unconverted bands to shrink
-- Additional borrowed tokens may be required (use `tokens_to_shrink` on the controller contract to check)
+- User must have at least 4 unconverted bands to shrink and have soft-liquidation mode. Use `loan.isRepayWithShrinkAvailable()`
+- Additional borrowed tokens may be required (use `loan.tokensToShrink` to check). And provide this value into `loan.repay()`
 
 **Updated method signatures (v2):**
 

package/lib/constants/aliases.js

@@ -32,7 +32,7 @@ export const ALIASES_OPTIMISM = lowerCaseValues({
     "old_gauge_end_index": "4",
     "leverage_zap_deprecated": "0xBFab8ebc836E1c4D81837798FC076D219C9a1855", // odos v3
     "leverage_zap_v2": "0x56C526b0159a258887e0d79ec3a80dfb940d0cD7",
-    "leverage_zap_v2_llv2": "0x0000000000000000000000000000000000000000",
+    "leverage_zap_v2_llv2": "0xdbeBDaE6f2D47B553B984E4091693824cf38584a",
     "leverage_markets_start_id": "0",
     "gas_oracle": '0xc0d3C0d3C0d3c0D3C0D3C0d3C0d3C0D3C0D3000f',
     "gas_oracle_blob": '0x420000000000000000000000000000000000000f',

package/lib/lendMarkets/LendMarketTemplate.js

@@ -143,6 +143,7 @@ export class LendMarketTemplate {
             removeCollateralPrices: loan.removeCollateralPrices.bind(loan),
             removeCollateralHealth: loan.removeCollateralHealth.bind(loan),
             tokensToShrink: loan.tokensToShrink.bind(loan),
+            isRepayWithShrinkAvailable: loan.isRepayWithShrinkAvailable.bind(loan),
             removeCollateral: loan.removeCollateral.bind(loan),
             removeCollateralFutureLeverage: loan.removeCollateralFutureLeverage.bind(loan),
             repayBands: loan.repayBands.bind(loan),

package/lib/lendMarkets/interfaces/v1/loanV1.d.ts

@@ -33,6 +33,7 @@ export interface ILoanV1 {
     addCollateral: (collateral: TAmount, address?: string) => Promise<string>;
     addCollateralFutureLeverage: (collateral: TAmount, userAddress?: string) => Promise<string>;
     tokensToShrink: (dCollateral?: TAmount, address?: string) => Promise<string>;
+    isRepayWithShrinkAvailable: (address?: string) => Promise<boolean>;
     maxRemovable: () => Promise<string>;
     removeCollateralBands: (collateral: TAmount) => Promise<[number, number]>;
     removeCollateralPrices: (collateral: TAmount) => Promise<string[]>;

package/lib/lendMarkets/interfaces/v2/loanV2.d.ts

@@ -33,6 +33,7 @@ export interface ILoanV2 {
     addCollateral: (collateral: TAmount, address?: string) => Promise<string>;
     addCollateralFutureLeverage: (collateral: TAmount, userAddress?: string) => Promise<string>;
     tokensToShrink: (dCollateral?: TAmount, address?: string) => Promise<string>;
+    isRepayWithShrinkAvailable: (address?: string) => Promise<boolean>;
     maxRemovable: () => Promise<string>;
     removeCollateralBands: (collateral: TAmount) => Promise<[number, number]>;
     removeCollateralPrices: (collateral: TAmount) => Promise<string[]>;

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

@@ -40,6 +40,7 @@ export declare abstract class LoanBaseModule {
     abstract addCollateralHealth(collateral: number | string, full?: boolean, address?: string): Promise<string>;
     abstract removeCollateralHealth(collateral: number | string, full?: boolean, address?: string): Promise<string>;
     abstract tokensToShrink(dCollateral?: number | string, address?: string): Promise<string>;
+    abstract isRepayWithShrinkAvailable(address?: string): Promise<boolean>;
     _checkRange(range: number): void;
     createLoanMaxRecv(collateral: TAmount, range: number): Promise<string>;
     createLoanMaxRecvAllRanges: ((collateral: number | string) => Promise<{

package/lib/lendMarkets/modules/v1/loanV1.d.ts

@@ -11,6 +11,7 @@ export declare class LoanV1Module extends LoanBaseModule implements ILoanV1 {
     addCollateralHealth(collateral: number | string, full?: boolean, address?: string): Promise<string>;
     removeCollateralHealth(collateral: number | string, full?: boolean, address?: string): Promise<string>;
     tokensToShrink(): Promise<string>;
+    isRepayWithShrinkAvailable(): Promise<boolean>;
     protected _repayBands({ debt, address }: {
         debt: number | string;
         address: string;

package/lib/lendMarkets/modules/v1/loanV1.js

@@ -80,6 +80,11 @@ export class LoanV1Module extends LoanBaseModule {
             throw Error("tokensToShrink is not supported for v1 markets");
         });
     }
+    isRepayWithShrinkAvailable() {
+        return __awaiter(this, void 0, void 0, function* () {
+            return false;
+        });
+    }
     _repayBands(_a) {
         return __awaiter(this, arguments, void 0, function* ({ debt, address }) {
             const { _collateral: _currentCollateral, _borrowed, _debt: _currentDebt, _N } = yield this.market.userPosition.userStateBigInt(address);

package/lib/lendMarkets/modules/v2/loanV2.d.ts

@@ -6,6 +6,7 @@ export declare class LoanV2Module extends LoanBaseModule implements ILoanV2 {
     addCollateralHealth(collateral: number | string, full?: boolean, address?: string): Promise<string>;
     removeCollateralHealth(collateral: number | string, full?: boolean, address?: string): Promise<string>;
     tokensToShrink(dCollateral?: number | string, address?: string): Promise<string>;
+    isRepayWithShrinkAvailable(address?: string): Promise<boolean>;
     maxRemovable(): Promise<string>;
     borrowMoreHealth(collateral: number | string, debt: number | string, full?: boolean, address?: string): Promise<string>;
     repayHealth({ debt, shrink, full, address }: {

package/lib/lendMarkets/modules/v2/loanV2.js

@@ -57,6 +57,17 @@ export class LoanV2Module extends LoanBaseModule {
             return formatUnits(_tokens, this.market.borrowed_token.decimals);
         });
     }
+    isRepayWithShrinkAvailable() {
+        return __awaiter(this, arguments, void 0, function* (address = "") {
+            address = _getAddress.call(this.llamalend, address);
+            const { isSoftLiquidation } = yield this.market.userPosition.userState(address);
+            if (!isSoftLiquidation)
+                return false;
+            const bandsBalances = yield this.market.userPosition.userBandsBalances(address);
+            const bandsWithoutConversion = Object.values(bandsBalances).filter(({ borrowed }) => Number(borrowed) === 0).length;
+            return bandsWithoutConversion >= this.market.minBands;
+        });
+    }
     maxRemovable() {
         return __awaiter(this, void 0, void 0, function* () {
             const address = _getAddress.call(this.llamalend, '');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/llamalend-api",
-  "version": "2.3.0",
+  "version": "2.3.2",
   "description": "JavaScript library for Curve Lending",
   "main": "lib/index.js",
   "author": "Macket",
@@ -48,7 +48,7 @@
   "dependencies": {
     "@curvefi/ethcall": "6.0.16",
     "bignumber.js": "9.3.1",
-    "ethers": "6.15.0",
+    "ethers": "6.17.0",
     "memoizee": "0.4.17"
   }
 }

package/src/constants/aliases.ts

@@ -36,7 +36,7 @@ export const ALIASES_OPTIMISM = lowerCaseValues({
     "old_gauge_end_index": "4",
     "leverage_zap_deprecated": "0xBFab8ebc836E1c4D81837798FC076D219C9a1855", // odos v3
     "leverage_zap_v2": "0x56C526b0159a258887e0d79ec3a80dfb940d0cD7",
-    "leverage_zap_v2_llv2": "0x0000000000000000000000000000000000000000",
+    "leverage_zap_v2_llv2": "0xdbeBDaE6f2D47B553B984E4091693824cf38584a",
     "leverage_markets_start_id": "0",
     "gas_oracle": '0xc0d3C0d3C0d3c0D3C0D3C0d3C0d3C0D3C0D3000f',
     "gas_oracle_blob": '0x420000000000000000000000000000000000000f',

package/src/lendMarkets/LendMarketTemplate.ts

@@ -250,6 +250,7 @@ export class LendMarketTemplate<V extends 'v1' | 'v2' = 'v1' | 'v2'> {
             removeCollateralPrices: loan.removeCollateralPrices.bind(loan),
             removeCollateralHealth: loan.removeCollateralHealth.bind(loan),
             tokensToShrink: loan.tokensToShrink.bind(loan),
+            isRepayWithShrinkAvailable: loan.isRepayWithShrinkAvailable.bind(loan),
             removeCollateral: loan.removeCollateral.bind(loan),
             removeCollateralFutureLeverage: loan.removeCollateralFutureLeverage.bind(loan),
 

package/src/lendMarkets/interfaces/v1/loanV1.ts

@@ -31,6 +31,7 @@ export interface ILoanV1 {
     addCollateralFutureLeverage: (collateral: TAmount, userAddress?: string) => Promise<string>;
 
     tokensToShrink: (dCollateral?: TAmount, address?: string) => Promise<string>;
+    isRepayWithShrinkAvailable: (address?: string) => Promise<boolean>;
 
     maxRemovable: () => Promise<string>;
     removeCollateralBands: (collateral: TAmount) => Promise<[number, number]>;

package/src/lendMarkets/interfaces/v2/loanV2.ts

@@ -31,6 +31,7 @@ export interface ILoanV2 {
     addCollateralFutureLeverage: (collateral: TAmount, userAddress?: string) => Promise<string>;
 
     tokensToShrink: (dCollateral?: TAmount, address?: string) => Promise<string>;
+    isRepayWithShrinkAvailable: (address?: string) => Promise<boolean>;
 
     maxRemovable: () => Promise<string>;
     removeCollateralBands: (collateral: TAmount) => Promise<[number, number]>;

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

@@ -58,6 +58,8 @@ export abstract class LoanBaseModule {
 
     public abstract tokensToShrink(dCollateral?: number | string, address?: string): Promise<string>;
 
+    public abstract isRepayWithShrinkAvailable(address?: string): Promise<boolean>;
+
     public _checkRange(range: number): void {
         if (range < this.market.minBands) throw Error(`range must be >= ${this.market.minBands}`);
         if (range > this.market.maxBands) throw Error(`range must be <= ${this.market.maxBands}`);

package/src/lendMarkets/modules/v1/loanV1.ts

@@ -84,6 +84,10 @@ export class LoanV1Module extends LoanBaseModule implements ILoanV1 {
         throw Error("tokensToShrink is not supported for v1 markets");
     }
 
+    public async isRepayWithShrinkAvailable(): Promise<boolean> {
+        return false;
+    }
+
     protected async _repayBands({ debt, address }: { debt: number | string, address: string, shrink?: boolean }): Promise<[bigint, bigint]> {
         const { _collateral: _currentCollateral, _borrowed, _debt: _currentDebt, _N } = await this.market.userPosition.userStateBigInt(address);
         if (_currentDebt === BigInt(0)) throw Error(`Loan for ${address} does not exist`);

package/src/lendMarkets/modules/v2/loanV2.ts

@@ -53,6 +53,17 @@ export class LoanV2Module extends LoanBaseModule implements ILoanV2 {
         return formatUnits(_tokens, this.market.borrowed_token.decimals);
     }
 
+    public async isRepayWithShrinkAvailable(address = ""): Promise<boolean> {
+        address = _getAddress.call(this.llamalend, address);
+        const { isSoftLiquidation } = await this.market.userPosition.userState(address);
+        if (!isSoftLiquidation) return false;
+
+        const bandsBalances = await this.market.userPosition.userBandsBalances(address);
+        const bandsWithoutConversion = Object.values(bandsBalances).filter(({ borrowed }) => Number(borrowed) === 0).length;
+
+        return bandsWithoutConversion >= this.market.minBands;
+    }
+
     public async maxRemovable(): Promise<string> {
         const address = _getAddress.call(this.llamalend, '');
         const { _collateral: _currentCollateral, _debt: _currentDebt, _N } = await this.market.userPosition.userStateBigInt();