@curvefi/llamalend-api 2.3.1 → 2.3.3

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/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/common/vault.d.ts

@@ -1,21 +1,21 @@
 import { IReward, TAmount, TGas } from "../../../interfaces";
 export interface IVault {
     maxDeposit: (address?: string) => Promise<string>;
-    previewDeposit: (amount: TAmount) => Promise<string>;
+    previewDeposit: (borrowed: TAmount) => Promise<string>;
     depositIsApproved: (borrowed: TAmount) => Promise<boolean>;
     depositApprove: (borrowed: TAmount) => Promise<string[]>;
-    deposit: (amount: TAmount) => Promise<string>;
+    deposit: (borrowed: TAmount) => Promise<string>;
     maxMint: (address?: string) => Promise<string>;
-    previewMint: (amount: TAmount) => Promise<string>;
+    previewMint: (shares: TAmount) => Promise<string>;
     mintIsApproved: (borrowed: TAmount) => Promise<boolean>;
     mintApprove: (borrowed: TAmount) => Promise<string[]>;
-    mint: (amount: TAmount) => Promise<string>;
+    mint: (shares: TAmount) => Promise<string>;
     maxWithdraw: (address?: string) => Promise<string>;
-    previewWithdraw: (amount: TAmount) => Promise<string>;
-    withdraw: (amount: TAmount) => Promise<string>;
+    previewWithdraw: (borrowed: TAmount) => Promise<string>;
+    withdraw: (borrowed: TAmount) => Promise<string>;
     maxRedeem: (address?: string) => Promise<string>;
-    previewRedeem: (amount: TAmount) => Promise<string>;
-    redeem: (amount: TAmount) => Promise<string>;
+    previewRedeem: (shares: TAmount) => Promise<string>;
+    redeem: (shares: TAmount) => Promise<string>;
     convertToShares: (assets: TAmount) => Promise<string>;
     convertToAssets: (shares: TAmount) => Promise<string>;
     stakeIsApproved: (vaultShares: number | string) => Promise<boolean>;
@@ -40,12 +40,12 @@ export interface IVault {
     }[]>;
     claimRewards: () => Promise<string>;
     estimateGas: {
-        depositApprove: (amount: TAmount) => Promise<TGas>;
-        deposit: (amount: TAmount) => Promise<TGas>;
-        mintApprove: (amount: TAmount) => Promise<TGas>;
-        mint: (amount: TAmount) => Promise<TGas>;
-        withdraw: (amount: TAmount) => Promise<TGas>;
-        redeem: (amount: TAmount) => Promise<TGas>;
+        depositApprove: (borrowed: TAmount) => Promise<TGas>;
+        deposit: (borrowed: TAmount) => Promise<TGas>;
+        mintApprove: (borrowed: TAmount) => Promise<TGas>;
+        mint: (shares: TAmount) => Promise<TGas>;
+        withdraw: (borrowed: TAmount) => Promise<TGas>;
+        redeem: (shares: TAmount) => Promise<TGas>;
         stakeApprove: (vaultShares: number | string) => Promise<TGas>;
         stake: (vaultShares: number | string) => Promise<TGas>;
         unstake: (vaultShares: number | string) => Promise<TGas>;

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/common/vault.d.ts

@@ -6,31 +6,31 @@ export declare class VaultModule {
     private llamalend;
     constructor(market: LendMarketTemplate);
     vaultMaxDeposit(address?: string): Promise<string>;
-    vaultPreviewDeposit(amount: TAmount): Promise<string>;
+    vaultPreviewDeposit(borrowed: TAmount): Promise<string>;
     vaultDepositIsApproved(borrowed: TAmount): Promise<boolean>;
     vaultDepositApproveEstimateGas(borrowed: TAmount): Promise<TGas>;
     vaultDepositApprove(borrowed: TAmount): Promise<string[]>;
     private _vaultDeposit;
-    vaultDepositEstimateGas(amount: TAmount): Promise<TGas>;
-    vaultDeposit(amount: TAmount): Promise<string>;
+    vaultDepositEstimateGas(borrowed: TAmount): Promise<TGas>;
+    vaultDeposit(borrowed: TAmount): Promise<string>;
     vaultMaxMint(address?: string): Promise<string>;
-    vaultPreviewMint(amount: TAmount): Promise<string>;
+    vaultPreviewMint(shares: TAmount): Promise<string>;
     vaultMintIsApproved(borrowed: TAmount): Promise<boolean>;
     vaultMintApproveEstimateGas(borrowed: TAmount): Promise<TGas>;
     vaultMintApprove(borrowed: TAmount): Promise<string[]>;
     private _vaultMint;
-    vaultMintEstimateGas(amount: TAmount): Promise<TGas>;
-    vaultMint(amount: TAmount): Promise<string>;
+    vaultMintEstimateGas(shares: TAmount): Promise<TGas>;
+    vaultMint(shares: TAmount): Promise<string>;
     vaultMaxWithdraw(address?: string): Promise<string>;
-    vaultPreviewWithdraw(amount: TAmount): Promise<string>;
+    vaultPreviewWithdraw(borrowed: TAmount): Promise<string>;
     private _vaultWithdraw;
-    vaultWithdrawEstimateGas(amount: TAmount): Promise<TGas>;
-    vaultWithdraw(amount: TAmount): Promise<string>;
+    vaultWithdrawEstimateGas(borrowed: TAmount): Promise<TGas>;
+    vaultWithdraw(borrowed: TAmount): Promise<string>;
     vaultMaxRedeem(address?: string): Promise<string>;
-    vaultPreviewRedeem(amount: TAmount): Promise<string>;
+    vaultPreviewRedeem(shares: TAmount): Promise<string>;
     private _vaultRedeem;
-    vaultRedeemEstimateGas(amount: TAmount): Promise<TGas>;
-    vaultRedeem(amount: TAmount): Promise<string>;
+    vaultRedeemEstimateGas(shares: TAmount): Promise<TGas>;
+    vaultRedeem(shares: TAmount): Promise<string>;
     vaultConvertToShares(assets: TAmount): Promise<string>;
     vaultConvertToAssets(shares: TAmount): Promise<string>;
     vaultStakeIsApproved(vaultShares: number | string): Promise<boolean>;

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

@@ -154,9 +154,9 @@ export class VaultModule {
             return formatUnits(_amount, this.market.borrowed_token.decimals);
         });
     }
-    vaultPreviewDeposit(amount) {
+    vaultPreviewDeposit(borrowed) {
         return __awaiter(this, void 0, void 0, function* () {
-            const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+            const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
             const _shares = yield this.llamalend.contracts[this.market.addresses.vault].contract.previewDeposit(_amount);
             return formatUnits(_shares, 18);
         });
@@ -176,9 +176,9 @@ export class VaultModule {
             return yield ensureAllowance.call(this.llamalend, [this.market.borrowed_token.address], [borrowed], this.market.addresses.vault);
         });
     }
-    _vaultDeposit(amount_1) {
-        return __awaiter(this, arguments, void 0, function* (amount, estimateGas = false) {
-            const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+    _vaultDeposit(borrowed_1) {
+        return __awaiter(this, arguments, void 0, function* (borrowed, estimateGas = false) {
+            const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
             const gas = yield this.llamalend.contracts[this.market.addresses.vault].contract.deposit.estimateGas(_amount, Object.assign({}, this.llamalend.constantOptions));
             if (estimateGas)
                 return smartNumber(gas);
@@ -187,17 +187,17 @@ export class VaultModule {
             return (yield this.llamalend.contracts[this.market.addresses.vault].contract.deposit(_amount, Object.assign(Object.assign({}, this.llamalend.options), { gasLimit }))).hash;
         });
     }
-    vaultDepositEstimateGas(amount) {
+    vaultDepositEstimateGas(borrowed) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!(yield this.vaultDepositIsApproved(amount)))
+            if (!(yield this.vaultDepositIsApproved(borrowed)))
                 throw Error("Approval is needed for gas estimation");
-            return yield this._vaultDeposit(amount, true);
+            return yield this._vaultDeposit(borrowed, true);
         });
     }
-    vaultDeposit(amount) {
+    vaultDeposit(borrowed) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.vaultDepositApprove(amount);
-            return yield this._vaultDeposit(amount, false);
+            yield this.vaultDepositApprove(borrowed);
+            return yield this._vaultDeposit(borrowed, false);
         });
     }
     vaultMaxMint() {
@@ -209,9 +209,9 @@ export class VaultModule {
             return formatUnits(_shares, 18);
         });
     }
-    vaultPreviewMint(amount) {
+    vaultPreviewMint(shares) {
         return __awaiter(this, void 0, void 0, function* () {
-            const _amount = parseUnits(amount, 18);
+            const _amount = parseUnits(shares, 18);
             const _assets = yield this.llamalend.contracts[this.market.addresses.vault].contract.previewMint(_amount);
             return formatUnits(_assets, this.market.borrowed_token.decimals);
         });
@@ -231,9 +231,9 @@ export class VaultModule {
             return yield ensureAllowance.call(this.llamalend, [this.market.borrowed_token.address], [borrowed], this.market.addresses.vault);
         });
     }
-    _vaultMint(amount_1) {
-        return __awaiter(this, arguments, void 0, function* (amount, estimateGas = false) {
-            const _amount = parseUnits(amount, 18);
+    _vaultMint(shares_1) {
+        return __awaiter(this, arguments, void 0, function* (shares, estimateGas = false) {
+            const _amount = parseUnits(shares, 18);
             const gas = yield this.llamalend.contracts[this.market.addresses.vault].contract.mint.estimateGas(_amount, Object.assign({}, this.llamalend.constantOptions));
             if (estimateGas)
                 return smartNumber(gas);
@@ -242,17 +242,17 @@ export class VaultModule {
             return (yield this.llamalend.contracts[this.market.addresses.vault].contract.mint(_amount, Object.assign(Object.assign({}, this.llamalend.options), { gasLimit }))).hash;
         });
     }
-    vaultMintEstimateGas(amount) {
+    vaultMintEstimateGas(shares) {
         return __awaiter(this, void 0, void 0, function* () {
-            if (!(yield this.vaultMintIsApproved(amount)))
+            if (!(yield this.vaultMintIsApproved(shares)))
                 throw Error("Approval is needed for gas estimation");
-            return yield this._vaultMint(amount, true);
+            return yield this._vaultMint(shares, true);
         });
     }
-    vaultMint(amount) {
+    vaultMint(shares) {
         return __awaiter(this, void 0, void 0, function* () {
-            yield this.vaultMintApprove(amount);
-            return yield this._vaultMint(amount, false);
+            yield this.vaultMintApprove(shares);
+            return yield this._vaultMint(shares, false);
         });
     }
     vaultMaxWithdraw() {
@@ -262,16 +262,16 @@ export class VaultModule {
             return formatUnits(_assets, this.market.borrowed_token.decimals);
         });
     }
-    vaultPreviewWithdraw(amount) {
+    vaultPreviewWithdraw(borrowed) {
         return __awaiter(this, void 0, void 0, function* () {
-            const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+            const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
             const _shares = yield this.llamalend.contracts[this.market.addresses.vault].contract.previewWithdraw(_amount);
             return formatUnits(_shares, 18);
         });
     }
-    _vaultWithdraw(amount_1) {
-        return __awaiter(this, arguments, void 0, function* (amount, estimateGas = false) {
-            const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+    _vaultWithdraw(borrowed_1) {
+        return __awaiter(this, arguments, void 0, function* (borrowed, estimateGas = false) {
+            const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
             const gas = yield this.llamalend.contracts[this.market.addresses.vault].contract.withdraw.estimateGas(_amount, Object.assign({}, this.llamalend.constantOptions));
             if (estimateGas)
                 return smartNumber(gas);
@@ -280,14 +280,14 @@ export class VaultModule {
             return (yield this.llamalend.contracts[this.market.addresses.vault].contract.withdraw(_amount, Object.assign(Object.assign({}, this.llamalend.options), { gasLimit }))).hash;
         });
     }
-    vaultWithdrawEstimateGas(amount) {
+    vaultWithdrawEstimateGas(borrowed) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this._vaultWithdraw(amount, true);
+            return yield this._vaultWithdraw(borrowed, true);
         });
     }
-    vaultWithdraw(amount) {
+    vaultWithdraw(borrowed) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this._vaultWithdraw(amount, false);
+            return yield this._vaultWithdraw(borrowed, false);
         });
     }
     vaultMaxRedeem() {
@@ -297,16 +297,16 @@ export class VaultModule {
             return formatUnits(_shares, 18);
         });
     }
-    vaultPreviewRedeem(amount) {
+    vaultPreviewRedeem(shares) {
         return __awaiter(this, void 0, void 0, function* () {
-            const _amount = parseUnits(amount, 18);
+            const _amount = parseUnits(shares, 18);
             const _assets = yield this.llamalend.contracts[this.market.addresses.vault].contract.previewRedeem(_amount);
             return formatUnits(_assets, this.market.borrowed_token.decimals);
         });
     }
-    _vaultRedeem(amount_1) {
-        return __awaiter(this, arguments, void 0, function* (amount, estimateGas = false) {
-            const _amount = parseUnits(amount, 18);
+    _vaultRedeem(shares_1) {
+        return __awaiter(this, arguments, void 0, function* (shares, estimateGas = false) {
+            const _amount = parseUnits(shares, 18);
             const gas = yield this.llamalend.contracts[this.market.addresses.vault].contract.redeem.estimateGas(_amount, Object.assign({}, this.llamalend.constantOptions));
             if (estimateGas)
                 return smartNumber(gas);
@@ -315,14 +315,14 @@ export class VaultModule {
             return (yield this.llamalend.contracts[this.market.addresses.vault].contract.redeem(_amount, Object.assign(Object.assign({}, this.llamalend.options), { gasLimit }))).hash;
         });
     }
-    vaultRedeemEstimateGas(amount) {
+    vaultRedeemEstimateGas(shares) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this._vaultRedeem(amount, true);
+            return yield this._vaultRedeem(shares, true);
         });
     }
-    vaultRedeem(amount) {
+    vaultRedeem(shares) {
         return __awaiter(this, void 0, void 0, function* () {
-            return yield this._vaultRedeem(amount, false);
+            return yield this._vaultRedeem(shares, false);
         });
     }
     // ---------------- VAULT UTILS ----------------

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/lib/st-crvUSD.js

@@ -76,7 +76,7 @@ export function depositApproveEstimateGas(assets) {
     });
 }
 export function depositApprove(assets_1) {
-    return __awaiter(this, arguments, void 0, function* (assets, isMax = true) {
+    return __awaiter(this, arguments, void 0, function* (assets, isMax = false) {
         return yield ensureAllowance.call(this, [this.constants.ALIASES.crvUSD], [assets], this.constants.ALIASES.st_crvUSD, isMax);
     });
 }
@@ -147,7 +147,7 @@ export function mintApproveEstimateGas(shares) {
     });
 }
 export function mintApprove(shares_1) {
-    return __awaiter(this, arguments, void 0, function* (shares, isMax = true) {
+    return __awaiter(this, arguments, void 0, function* (shares, isMax = false) {
         const assets = yield previewMint.call(this, shares);
         return yield ensureAllowance.call(this, [this.constants.ALIASES.crvUSD], [assets], this.constants.ALIASES.st_crvUSD, isMax);
     });

package/lib/utils.js

@@ -214,7 +214,7 @@ export const hasAllowance = function (coins, amounts, address, spender) {
     });
 };
 export const _ensureAllowance = function (coins_1, _amounts_1, spender_1) {
-    return __awaiter(this, arguments, void 0, function* (coins, _amounts, spender, isMax = true) {
+    return __awaiter(this, arguments, void 0, function* (coins, _amounts, spender, isMax = false) {
         const address = this.signerAddress;
         const _allowance = yield _getAllowance.call(this, coins, address, spender);
         const txHashes = [];
@@ -232,7 +232,7 @@ export const _ensureAllowance = function (coins_1, _amounts_1, spender_1) {
 };
 // coins can be either addresses or symbols
 export const ensureAllowanceEstimateGas = function (coins_1, amounts_1, spender_1) {
-    return __awaiter(this, arguments, void 0, function* (coins, amounts, spender, isMax = true) {
+    return __awaiter(this, arguments, void 0, function* (coins, amounts, spender, isMax = false) {
         const coinAddresses = _getCoinAddresses.call(this, coins);
         const decimals = _getCoinDecimals.call(this, coinAddresses).map((item) => Number(item));
         const _amounts = amounts.map((a, i) => parseUnits(a, decimals[i]));
@@ -251,7 +251,7 @@ export const ensureAllowanceEstimateGas = function (coins_1, amounts_1, spender_
 };
 // coins can be either addresses or symbols
 export const ensureAllowance = function (coins_1, amounts_1, spender_1) {
-    return __awaiter(this, arguments, void 0, function* (coins, amounts, spender, isMax = true) {
+    return __awaiter(this, arguments, void 0, function* (coins, amounts, spender, isMax = false) {
         const coinAddresses = _getCoinAddresses.call(this, coins);
         const decimals = _getCoinDecimals.call(this, coinAddresses).map((item) => Number(item));
         const _amounts = amounts.map((a, i) => parseUnits(a, decimals[i]));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/llamalend-api",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "JavaScript library for Curve Lending",
   "main": "lib/index.js",
   "author": "Macket",
@@ -37,16 +37,15 @@
     "chai": "^5.3.3",
     "eslint": "^9.38.0",
     "globals": "^16.4.0",
-    "mocha": "^11.7.5",
+    "mocha": "^11.7.6",
     "typescript": "^5.9.3",
     "vue-eslint-parser": "^10.2.0"
   },
   "overrides": {
-    "serialize-javascript": "^7.0.4",
-    "diff": "^8.0.3"
+    "serialize-javascript": "^7.0.4"
   },
   "dependencies": {
-    "@curvefi/ethcall": "6.0.16",
+    "@curvefi/ethcall": "6.0.20",
     "bignumber.js": "9.3.1",
     "ethers": "6.17.0",
     "memoizee": "0.4.17"

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/common/vault.ts

@@ -2,21 +2,21 @@ import {IReward, TAmount, TGas} from "../../../interfaces";
 
 export interface IVault {
     maxDeposit: (address?: string) => Promise<string>,
-    previewDeposit: (amount: TAmount) => Promise<string>,
+    previewDeposit: (borrowed: TAmount) => Promise<string>,
     depositIsApproved: (borrowed: TAmount) => Promise<boolean>
     depositApprove: (borrowed: TAmount) => Promise<string[]>
-    deposit: (amount: TAmount) => Promise<string>,
+    deposit: (borrowed: TAmount) => Promise<string>,
     maxMint: (address?: string) => Promise<string>,
-    previewMint: (amount: TAmount) => Promise<string>,
+    previewMint: (shares: TAmount) => Promise<string>,
     mintIsApproved: (borrowed: TAmount) => Promise<boolean>
     mintApprove: (borrowed: TAmount) => Promise<string[]>
-    mint: (amount: TAmount) => Promise<string>,
+    mint: (shares: TAmount) => Promise<string>,
     maxWithdraw: (address?: string) => Promise<string>,
-    previewWithdraw: (amount: TAmount) => Promise<string>,
-    withdraw: (amount: TAmount) => Promise<string>,
+    previewWithdraw: (borrowed: TAmount) => Promise<string>,
+    withdraw: (borrowed: TAmount) => Promise<string>,
     maxRedeem: (address?: string) => Promise<string>,
-    previewRedeem: (amount: TAmount) => Promise<string>,
-    redeem: (amount: TAmount) => Promise<string>,
+    previewRedeem: (shares: TAmount) => Promise<string>,
+    redeem: (shares: TAmount) => Promise<string>,
     convertToShares: (assets: TAmount) => Promise<string>,
     convertToAssets: (shares: TAmount) => Promise<string>,
     stakeIsApproved: (vaultShares: number | string) => Promise<boolean>,
@@ -33,12 +33,12 @@ export interface IVault {
     claimableRewards: (address?: string) => Promise<{token: string, symbol: string, amount: string}[]>,
     claimRewards: () => Promise<string>,
     estimateGas: {
-        depositApprove: (amount: TAmount) => Promise<TGas>,
-        deposit: (amount: TAmount) => Promise<TGas>,
-        mintApprove: (amount: TAmount) => Promise<TGas>,
-        mint: (amount: TAmount) => Promise<TGas>,
-        withdraw: (amount: TAmount) => Promise<TGas>,
-        redeem: (amount: TAmount) => Promise<TGas>,
+        depositApprove: (borrowed: TAmount) => Promise<TGas>,
+        deposit: (borrowed: TAmount) => Promise<TGas>,
+        mintApprove: (borrowed: TAmount) => Promise<TGas>,
+        mint: (shares: TAmount) => Promise<TGas>,
+        withdraw: (borrowed: TAmount) => Promise<TGas>,
+        redeem: (shares: TAmount) => Promise<TGas>,
         stakeApprove: (vaultShares: number | string) => Promise<TGas>,
         stake: (vaultShares: number | string) => Promise<TGas>,
         unstake: (vaultShares: number | string) => Promise<TGas>,

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/common/vault.ts

@@ -39,8 +39,8 @@ export class VaultModule {
         return formatUnits(_amount,  this.market.borrowed_token.decimals);
     }
 
-    public async vaultPreviewDeposit(amount: TAmount): Promise<string> {
-        const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+    public async vaultPreviewDeposit(borrowed: TAmount): Promise<string> {
+        const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
         const _shares = await this.llamalend.contracts[this.market.addresses.vault].contract.previewDeposit(_amount);
 
         return formatUnits(_shares, 18);
@@ -58,8 +58,8 @@ export class VaultModule {
         return await ensureAllowance.call(this.llamalend, [this.market.borrowed_token.address], [borrowed], this.market.addresses.vault);
     }
 
-    private async _vaultDeposit(amount: TAmount, estimateGas = false): Promise<string | TGas> {
-        const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+    private async _vaultDeposit(borrowed: TAmount, estimateGas = false): Promise<string | TGas> {
+        const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
         const gas = await this.llamalend.contracts[this.market.addresses.vault].contract.deposit.estimateGas(_amount, { ...this.llamalend.constantOptions });
         if (estimateGas) return smartNumber(gas);
 
@@ -70,14 +70,14 @@ export class VaultModule {
         return (await this.llamalend.contracts[this.market.addresses.vault].contract.deposit(_amount, { ...this.llamalend.options, gasLimit })).hash;
     }
 
-    public async vaultDepositEstimateGas(amount: TAmount): Promise<TGas> {
-        if (!(await this.vaultDepositIsApproved(amount))) throw Error("Approval is needed for gas estimation");
-        return await this._vaultDeposit(amount, true) as number;
+    public async vaultDepositEstimateGas(borrowed: TAmount): Promise<TGas> {
+        if (!(await this.vaultDepositIsApproved(borrowed))) throw Error("Approval is needed for gas estimation");
+        return await this._vaultDeposit(borrowed, true) as number;
     }
 
-    public async vaultDeposit(amount: TAmount): Promise<string> {
-        await this.vaultDepositApprove(amount);
-        return await this._vaultDeposit(amount, false) as string;
+    public async vaultDeposit(borrowed: TAmount): Promise<string> {
+        await this.vaultDepositApprove(borrowed);
+        return await this._vaultDeposit(borrowed, false) as string;
     }
 
 
@@ -90,8 +90,8 @@ export class VaultModule {
         return formatUnits(_shares, 18);
     }
 
-    public async vaultPreviewMint(amount: TAmount): Promise<string> {
-        const _amount = parseUnits(amount, 18);
+    public async vaultPreviewMint(shares: TAmount): Promise<string> {
+        const _amount = parseUnits(shares, 18);
         const _assets = await this.llamalend.contracts[this.market.addresses.vault].contract.previewMint(_amount);
 
         return formatUnits(_assets, this.market.borrowed_token.decimals);
@@ -109,8 +109,8 @@ export class VaultModule {
         return await ensureAllowance.call(this.llamalend, [this.market.borrowed_token.address], [borrowed], this.market.addresses.vault);
     }
 
-    private async _vaultMint(amount: TAmount, estimateGas = false): Promise<string | TGas> {
-        const _amount = parseUnits(amount, 18);
+    private async _vaultMint(shares: TAmount, estimateGas = false): Promise<string | TGas> {
+        const _amount = parseUnits(shares, 18);
         const gas = await this.llamalend.contracts[this.market.addresses.vault].contract.mint.estimateGas(_amount, { ...this.llamalend.constantOptions });
         if (estimateGas) return smartNumber(gas);
 
@@ -121,14 +121,14 @@ export class VaultModule {
         return (await this.llamalend.contracts[this.market.addresses.vault].contract.mint(_amount, { ...this.llamalend.options, gasLimit })).hash;
     }
 
-    public async vaultMintEstimateGas(amount: TAmount): Promise<TGas> {
-        if (!(await this.vaultMintIsApproved(amount))) throw Error("Approval is needed for gas estimation");
-        return await this._vaultMint(amount, true) as number;
+    public async vaultMintEstimateGas(shares: TAmount): Promise<TGas> {
+        if (!(await this.vaultMintIsApproved(shares))) throw Error("Approval is needed for gas estimation");
+        return await this._vaultMint(shares, true) as number;
     }
 
-    public async vaultMint(amount: TAmount): Promise<string> {
-        await this.vaultMintApprove(amount);
-        return await this._vaultMint(amount, false) as string;
+    public async vaultMint(shares: TAmount): Promise<string> {
+        await this.vaultMintApprove(shares);
+        return await this._vaultMint(shares, false) as string;
     }
 
 
@@ -139,15 +139,15 @@ export class VaultModule {
         return formatUnits(_assets, this.market.borrowed_token.decimals);
     }
 
-    public async vaultPreviewWithdraw(amount: TAmount): Promise<string> {
-        const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+    public async vaultPreviewWithdraw(borrowed: TAmount): Promise<string> {
+        const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
         const _shares = await this.llamalend.contracts[this.market.addresses.vault].contract.previewWithdraw(_amount);
 
         return formatUnits(_shares, 18);
     }
 
-    private async _vaultWithdraw(amount: TAmount, estimateGas = false): Promise<string | TGas> {
-        const _amount = parseUnits(amount, this.market.borrowed_token.decimals);
+    private async _vaultWithdraw(borrowed: TAmount, estimateGas = false): Promise<string | TGas> {
+        const _amount = parseUnits(borrowed, this.market.borrowed_token.decimals);
         const gas = await this.llamalend.contracts[this.market.addresses.vault].contract.withdraw.estimateGas(_amount, { ...this.llamalend.constantOptions });
         if (estimateGas) return smartNumber(gas);
 
@@ -158,12 +158,12 @@ export class VaultModule {
         return (await this.llamalend.contracts[this.market.addresses.vault].contract.withdraw(_amount, { ...this.llamalend.options, gasLimit })).hash;
     }
 
-    public async vaultWithdrawEstimateGas(amount: TAmount): Promise<TGas> {
-        return await this._vaultWithdraw(amount, true) as number;
+    public async vaultWithdrawEstimateGas(borrowed: TAmount): Promise<TGas> {
+        return await this._vaultWithdraw(borrowed, true) as number;
     }
 
-    public async vaultWithdraw(amount: TAmount): Promise<string> {
-        return await this._vaultWithdraw(amount, false) as string;
+    public async vaultWithdraw(borrowed: TAmount): Promise<string> {
+        return await this._vaultWithdraw(borrowed, false) as string;
     }
 
 
@@ -174,15 +174,15 @@ export class VaultModule {
         return formatUnits(_shares, 18);
     }
 
-    public async vaultPreviewRedeem(amount: TAmount): Promise<string> {
-        const _amount = parseUnits(amount, 18);
+    public async vaultPreviewRedeem(shares: TAmount): Promise<string> {
+        const _amount = parseUnits(shares, 18);
         const _assets = await this.llamalend.contracts[this.market.addresses.vault].contract.previewRedeem(_amount);
 
         return formatUnits(_assets, this.market.borrowed_token.decimals);
     }
 
-    private async _vaultRedeem(amount: TAmount, estimateGas = false): Promise<string | TGas> {
-        const _amount = parseUnits(amount, 18);
+    private async _vaultRedeem(shares: TAmount, estimateGas = false): Promise<string | TGas> {
+        const _amount = parseUnits(shares, 18);
         const gas = await this.llamalend.contracts[this.market.addresses.vault].contract.redeem.estimateGas(_amount, { ...this.llamalend.constantOptions });
         if (estimateGas) return smartNumber(gas);
 
@@ -193,12 +193,12 @@ export class VaultModule {
         return (await this.llamalend.contracts[this.market.addresses.vault].contract.redeem(_amount, { ...this.llamalend.options, gasLimit })).hash;
     }
 
-    public async vaultRedeemEstimateGas(amount: TAmount): Promise<TGas> {
-        return await this._vaultRedeem(amount, true) as number;
+    public async vaultRedeemEstimateGas(shares: TAmount): Promise<TGas> {
+        return await this._vaultRedeem(shares, true) as number;
     }
 
-    public async vaultRedeem(amount: TAmount): Promise<string> {
-        return await this._vaultRedeem(amount, false) as string;
+    public async vaultRedeem(shares: TAmount): Promise<string> {
+        return await this._vaultRedeem(shares, false) as string;
     }
 
     // ---------------- VAULT UTILS ----------------

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();

package/src/st-crvUSD.ts

@@ -78,7 +78,7 @@ export async function depositApproveEstimateGas(this: Llamalend, assets: TAmount
     return await ensureAllowanceEstimateGas.call(this, [this.constants.ALIASES.crvUSD], [assets], this.constants.ALIASES.st_crvUSD);
 }
 
-export async function depositApprove(this: Llamalend, assets: TAmount, isMax = true): Promise<string[]> {
+export async function depositApprove(this: Llamalend, assets: TAmount, isMax = false): Promise<string[]> {
     return await ensureAllowance.call(this, [this.constants.ALIASES.crvUSD], [assets], this.constants.ALIASES.st_crvUSD, isMax);
 }
 
@@ -142,7 +142,7 @@ export async function mintApproveEstimateGas(this: Llamalend, shares: TAmount):
     return await ensureAllowanceEstimateGas.call(this, [this.constants.ALIASES.crvUSD], [assets], this.constants.ALIASES.st_crvUSD);
 }
 
-export async function mintApprove(this: Llamalend, shares: TAmount, isMax = true): Promise<string[]> {
+export async function mintApprove(this: Llamalend, shares: TAmount, isMax = false): Promise<string[]> {
     const assets = await previewMint.call(this, shares);
     return await ensureAllowance.call(this, [this.constants.ALIASES.crvUSD], [assets], this.constants.ALIASES.st_crvUSD, isMax);
 }

package/src/utils.ts

@@ -235,7 +235,7 @@ export const hasAllowance = async function (this: Llamalend, coins: string[], am
     return _allowance.map((a, i) => a >= _amounts[i]).reduce((a, b) => a && b);
 }
 
-export const _ensureAllowance = async function (this: Llamalend, coins: string[], _amounts: bigint[], spender: string, isMax = true): Promise<string[]> {
+export const _ensureAllowance = async function (this: Llamalend, coins: string[], _amounts: bigint[], spender: string, isMax = false): Promise<string[]> {
     const address = this.signerAddress;
     const _allowance: bigint[] = await _getAllowance.call(this, coins, address, spender);
 
@@ -254,7 +254,7 @@ export const _ensureAllowance = async function (this: Llamalend, coins: string[]
 }
 
 // coins can be either addresses or symbols
-export const ensureAllowanceEstimateGas = async function (this: Llamalend, coins: string[], amounts: (number | string)[], spender: string, isMax = true): Promise<TGas> {
+export const ensureAllowanceEstimateGas = async function (this: Llamalend, coins: string[], amounts: (number | string)[], spender: string, isMax = false): Promise<TGas> {
     const coinAddresses = _getCoinAddresses.call(this, coins);
     const decimals = _getCoinDecimals.call(this, coinAddresses).map((item) => Number(item));
     const _amounts = amounts.map((a, i) => parseUnits(a, decimals[i]));
@@ -274,7 +274,7 @@ export const ensureAllowanceEstimateGas = async function (this: Llamalend, coins
 }
 
 // coins can be either addresses or symbols
-export const ensureAllowance = async function (this: Llamalend, coins: string[], amounts: (number | string)[], spender: string, isMax = true): Promise<string[]> {
+export const ensureAllowance = async function (this: Llamalend, coins: string[], amounts: (number | string)[], spender: string, isMax = false): Promise<string[]> {
     const coinAddresses = _getCoinAddresses.call(this, coins);
     const decimals = _getCoinDecimals.call(this, coinAddresses).map((item) => Number(item));
     const _amounts = amounts.map((a, i) => parseUnits(a, decimals[i]));