@curvefi/llamalend-api 1.0.40 → 1.0.42

package/.github/workflows/publish.yml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - feat/init
 
 jobs:
   release:
@@ -12,7 +11,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
       - name: get-npm-version
         id: package-version
         uses: martinbeentjes/npm-get-version-action@main
@@ -42,19 +41,13 @@ jobs:
     permissions:
       contents: read
       id-token: write
+    environment: production
     steps:
-      - uses: actions/checkout@v4
-      - name: Setup node version
-        uses: actions/setup-node@v4
+      - uses: actions/checkout@v5
+      - uses: actions/setup-node@v5
         with:
           node-version: 24
           cache: npm
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install modules
-        run: npm ci
-      - name: Build
-        run: npm run build
-      - name: Publish to npm
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+      - run: npm ci
+      - run: npm run build
+      - run: npm publish

package/lib/lendMarkets/LendMarketTemplate.d.ts

@@ -407,6 +407,7 @@ export declare class LendMarketTemplate {
     private _addCollateral;
     addCollateralEstimateGas(collateral: number | string, address?: string): Promise<TGas>;
     addCollateral(collateral: number | string, address?: string): Promise<string>;
+    addCollateralFutureLeverage(collateral: number | string, userAddress?: string): Promise<string>;
     maxRemovable(): Promise<string>;
     private _removeCollateralBands;
     removeCollateralBands(collateral: number | string): Promise<[number, number]>;
@@ -415,6 +416,7 @@ export declare class LendMarketTemplate {
     private _removeCollateral;
     removeCollateralEstimateGas(collateral: number | string): Promise<TGas>;
     removeCollateral(collateral: number | string): Promise<string>;
+    removeCollateralFutureLeverage(collateral: number | string, userAddress?: string): Promise<string>;
     private _repayBands;
     repayBands(debt: number | string, address?: string): Promise<[number, number]>;
     repayPrices(debt: number | string, address?: string): Promise<string[]>;

package/lib/lendMarkets/LendMarketTemplate.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import memoize from "memoizee";
 import BigNumber from "bignumber.js";
-import { _getAddress, parseUnits, BN, toBN, fromBN, getBalances, _ensureAllowance, ensureAllowance, hasAllowance, ensureAllowanceEstimateGas, _cutZeros, formatUnits, formatNumber, MAX_ALLOWANCE, MAX_ACTIVE_BAND, _mulBy1_3, _getUsdRate, DIGas, smartNumber, } from "../utils.js";
+import { _getAddress, parseUnits, BN, toBN, fromBN, getBalances, _ensureAllowance, ensureAllowance, hasAllowance, ensureAllowanceEstimateGas, _cutZeros, formatUnits, formatNumber, MAX_ALLOWANCE, MAX_ACTIVE_BAND, _mulBy1_3, _getUsdRate, DIGas, smartNumber, calculateFutureLeverage, } from "../utils.js";
 import { _getExpectedOdos, _getQuoteOdos, _assembleTxOdos, _getUserCollateral, _getUserCollateralForce, _getMarketsData } from "../external-api.js";
 import ERC20Abi from '../constants/abis/ERC20.json' with { type: 'json' };
 import { cacheKey, cacheStats } from "../cache/index.js";
@@ -1683,6 +1683,17 @@ export class LendMarketTemplate {
             return yield this._addCollateral(collateral, address, false);
         });
     }
+    addCollateralFutureLeverage(collateral_1) {
+        return __awaiter(this, arguments, void 0, function* (collateral, userAddress = '') {
+            userAddress = _getAddress.call(this.llamalend, userAddress);
+            const [userCollateral, { collateral: currentCollateral }] = yield Promise.all([
+                _getUserCollateral(this.llamalend.constants.NETWORK_NAME, this.addresses.controller, userAddress),
+                this.userState(userAddress),
+            ]);
+            const total_deposit_from_user = userCollateral.total_deposit_from_user_precise;
+            return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'add');
+        });
+    }
     // ---------------- REMOVE COLLATERAL ----------------
     maxRemovable() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1751,6 +1762,17 @@ export class LendMarketTemplate {
             return yield this._removeCollateral(collateral, false);
         });
     }
+    removeCollateralFutureLeverage(collateral_1) {
+        return __awaiter(this, arguments, void 0, function* (collateral, userAddress = '') {
+            userAddress = _getAddress.call(this.llamalend, userAddress);
+            const [userCollateral, { collateral: currentCollateral }] = yield Promise.all([
+                _getUserCollateral(this.llamalend.constants.NETWORK_NAME, this.addresses.controller, userAddress),
+                this.userState(userAddress),
+            ]);
+            const total_deposit_from_user = userCollateral.total_deposit_from_user_precise;
+            return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'remove');
+        });
+    }
     // ---------------- REPAY ----------------
     _repayBands(debt, address) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/mintMarkets/MintMarketTemplate.d.ts

@@ -244,6 +244,7 @@ export declare class MintMarketTemplate {
     private _addCollateral;
     addCollateralEstimateGas(collateral: number | string, address?: string): Promise<number>;
     addCollateral(collateral: number | string, address?: string): Promise<string>;
+    addCollateralFutureLeverage(collateral: number | string, userAddress?: string): Promise<string>;
     maxRemovable(): Promise<string>;
     private _removeCollateralBands;
     removeCollateralBands(collateral: number | string): Promise<[number, number]>;
@@ -252,6 +253,7 @@ export declare class MintMarketTemplate {
     private _removeCollateral;
     removeCollateralEstimateGas(collateral: number | string): Promise<number>;
     removeCollateral(collateral: number | string): Promise<string>;
+    removeCollateralFutureLeverage(collateral: number | string, userAddress?: string): Promise<string>;
     private _repayBands;
     repayBands(debt: number | string, address?: string): Promise<[number, number]>;
     repayPrices(debt: number | string, address?: string): Promise<string[]>;

package/lib/mintMarkets/MintMarketTemplate.js

@@ -9,7 +9,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 import memoize from "memoizee";
 import BigNumber from "bignumber.js";
-import { _getAddress, parseUnits, BN, toBN, fromBN, getBalances, ensureAllowance, hasAllowance, ensureAllowanceEstimateGas, isEth, _cutZeros, formatUnits, smartNumber, MAX_ALLOWANCE, MAX_ACTIVE_BAND, _mulBy1_3, DIGas, } from "../utils.js";
+import { _getAddress, parseUnits, BN, toBN, fromBN, getBalances, ensureAllowance, hasAllowance, ensureAllowanceEstimateGas, isEth, _cutZeros, formatUnits, smartNumber, MAX_ALLOWANCE, MAX_ACTIVE_BAND, _mulBy1_3, DIGas, calculateFutureLeverage, } from "../utils.js";
 import { _getUserCollateralCrvUsd, _getUserCollateralCrvUsdFull } from "../external-api.js";
 import { LeverageV2Module } from "./modules/index.js";
 export class MintMarketTemplate {
@@ -960,6 +960,19 @@ export class MintMarketTemplate {
             return yield this._addCollateral(collateral, address, false);
         });
     }
+    addCollateralFutureLeverage(collateral_1) {
+        return __awaiter(this, arguments, void 0, function* (collateral, userAddress = '') {
+            var _a;
+            this._checkLeverageForStats();
+            userAddress = _getAddress.call(this.llamalend, userAddress);
+            const [userCollateral, { collateral: currentCollateral }] = yield Promise.all([
+                _getUserCollateralCrvUsdFull(this.llamalend.constants.NETWORK_NAME, this.controller, userAddress),
+                this.userState(userAddress),
+            ]);
+            const total_deposit_from_user = (_a = userCollateral.total_deposit_from_user_precise) !== null && _a !== void 0 ? _a : userCollateral.total_deposit_precise;
+            return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'add');
+        });
+    }
     // ---------------- REMOVE COLLATERAL ----------------
     maxRemovable() {
         return __awaiter(this, void 0, void 0, function* () {
@@ -1031,6 +1044,19 @@ export class MintMarketTemplate {
             return yield this._removeCollateral(collateral, false);
         });
     }
+    removeCollateralFutureLeverage(collateral_1) {
+        return __awaiter(this, arguments, void 0, function* (collateral, userAddress = '') {
+            var _a;
+            this._checkLeverageForStats();
+            userAddress = _getAddress.call(this.llamalend, userAddress);
+            const [userCollateral, { collateral: currentCollateral }] = yield Promise.all([
+                _getUserCollateralCrvUsdFull(this.llamalend.constants.NETWORK_NAME, this.controller, userAddress),
+                this.userState(userAddress),
+            ]);
+            const total_deposit_from_user = (_a = userCollateral.total_deposit_from_user_precise) !== null && _a !== void 0 ? _a : userCollateral.total_deposit_precise;
+            return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'remove');
+        });
+    }
     // ---------------- REPAY ----------------
     _repayBands(debt, address) {
         return __awaiter(this, void 0, void 0, function* () {

package/lib/utils.d.ts

@@ -57,3 +57,4 @@ export declare const getLsdApy: ((name: "wstETH" | "sfrxETH") => Promise<{
     baseApy: number;
     apyMean30d: number;
 }>>;
+export declare const calculateFutureLeverage: (currentCollateral: number | string, totalDepositFromUser: number | string, collateral: number | string, operation: "add" | "remove") => string;

package/lib/utils.js

@@ -463,3 +463,14 @@ export const getLsdApy = memoize((name) => __awaiter(void 0, void 0, void 0, fun
     promise: true,
     maxAge: 60 * 1000, // 1m
 });
+export const calculateFutureLeverage = (currentCollateral, totalDepositFromUser, collateral, operation) => {
+    const collateralBN = BN(collateral);
+    const currentCollateralBN = BN(currentCollateral);
+    const totalDepositBN = BN(totalDepositFromUser);
+    if (operation === 'add') {
+        return currentCollateralBN.plus(collateralBN).div(totalDepositBN.plus(collateralBN)).toString();
+    }
+    else {
+        return currentCollateralBN.minus(collateralBN).div(totalDepositBN.minus(collateralBN)).toString();
+    }
+};

package/package.json

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

package/src/lendMarkets/LendMarketTemplate.ts

@@ -21,6 +21,7 @@ import {
     _getUsdRate,
     DIGas,
     smartNumber,
+    calculateFutureLeverage,
 } from "../utils.js";
 import {IDict, TGas, TAmount, IReward, IQuoteOdos, IOneWayMarket, IPartialFrac} from "../interfaces.js";
 import { _getExpectedOdos, _getQuoteOdos, _assembleTxOdos, _getUserCollateral, _getUserCollateralForce, _getMarketsData } from "../external-api.js";
@@ -1747,6 +1748,18 @@ export class LendMarketTemplate {
         return await this._addCollateral(collateral, address, false) as string;
     }
 
+    public async addCollateralFutureLeverage(collateral: number | string, userAddress = ''): Promise<string> {
+        userAddress = _getAddress.call(this.llamalend, userAddress);
+        const [userCollateral, {collateral: currentCollateral}] = await Promise.all([
+            _getUserCollateral(this.llamalend.constants.NETWORK_NAME, this.addresses.controller, userAddress),
+            this.userState(userAddress),
+        ]);
+
+        const total_deposit_from_user = userCollateral.total_deposit_from_user_precise;
+
+        return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'add');
+    }
+
     // ---------------- REMOVE COLLATERAL ----------------
 
     public async maxRemovable(): Promise<string> {
@@ -1813,6 +1826,18 @@ export class LendMarketTemplate {
         return await this._removeCollateral(collateral, false) as string;
     }
 
+    public async removeCollateralFutureLeverage(collateral: number | string, userAddress = ''): Promise<string> {
+        userAddress = _getAddress.call(this.llamalend, userAddress);
+        const [userCollateral, {collateral: currentCollateral}] = await Promise.all([
+            _getUserCollateral(this.llamalend.constants.NETWORK_NAME, this.addresses.controller, userAddress),
+            this.userState(userAddress),
+        ]);
+
+        const total_deposit_from_user = userCollateral.total_deposit_from_user_precise;
+
+        return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'remove');
+    }
+
     // ---------------- REPAY ----------------
 
     private async _repayBands(debt: number | string, address: string): Promise<[bigint, bigint]> {

package/src/mintMarkets/MintMarketTemplate.ts

@@ -19,6 +19,7 @@ import {
     MAX_ACTIVE_BAND,
     _mulBy1_3,
     DIGas,
+    calculateFutureLeverage,
 } from "../utils.js";
 import {IDict, ILlamma, TGas} from "../interfaces.js";
 import {_getUserCollateralCrvUsd, _getUserCollateralCrvUsdFull} from "../external-api.js";
@@ -1001,6 +1002,19 @@ export class MintMarketTemplate {
         return await this._addCollateral(collateral, address, false) as string;
     }
 
+    public async addCollateralFutureLeverage(collateral: number | string, userAddress = ''): Promise<string> {
+        this._checkLeverageForStats();
+        userAddress = _getAddress.call(this.llamalend, userAddress);
+        const [userCollateral, {collateral: currentCollateral}] = await Promise.all([
+            _getUserCollateralCrvUsdFull(this.llamalend.constants.NETWORK_NAME, this.controller, userAddress),
+            this.userState(userAddress),
+        ]);
+
+        const total_deposit_from_user = userCollateral.total_deposit_from_user_precise ?? userCollateral.total_deposit_precise;
+
+        return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'add');
+    }
+
     // ---------------- REMOVE COLLATERAL ----------------
 
     public async maxRemovable(): Promise<string> {
@@ -1069,6 +1083,19 @@ export class MintMarketTemplate {
         return await this._removeCollateral(collateral, false) as string;
     }
 
+    public async removeCollateralFutureLeverage(collateral: number | string, userAddress = ''): Promise<string> {
+        this._checkLeverageForStats();
+        userAddress = _getAddress.call(this.llamalend, userAddress);
+        const [userCollateral, {collateral: currentCollateral}] = await Promise.all([
+            _getUserCollateralCrvUsdFull(this.llamalend.constants.NETWORK_NAME, this.controller, userAddress),
+            this.userState(userAddress),
+        ]);
+
+        const total_deposit_from_user = userCollateral.total_deposit_from_user_precise ?? userCollateral.total_deposit_precise;
+
+        return calculateFutureLeverage(currentCollateral, total_deposit_from_user, collateral, 'remove');
+    }
+
     // ---------------- REPAY ----------------
 
     private async _repayBands(debt: number | string, address: string): Promise<[bigint, bigint]> {

package/src/utils.ts

@@ -498,4 +498,21 @@ export const getLsdApy = memoize(async(name: 'wstETH' | 'sfrxETH'): Promise<{
 {
     promise: true,
     maxAge: 60 * 1000, // 1m
-});
+});
+
+export const calculateFutureLeverage = (
+    currentCollateral: number | string,
+    totalDepositFromUser: number | string,
+    collateral: number | string,
+    operation: 'add' | 'remove'
+): string => {
+    const collateralBN = BN(collateral);
+    const currentCollateralBN = BN(currentCollateral);
+    const totalDepositBN = BN(totalDepositFromUser);
+
+    if (operation === 'add') {
+        return currentCollateralBN.plus(collateralBN).div(totalDepositBN.plus(collateralBN)).toString();
+    } else {
+        return currentCollateralBN.minus(collateralBN).div(totalDepositBN.minus(collateralBN)).toString();
+    }
+};