@curvefi/llamalend-api 1.0.28 → 1.0.30

package/lib/lendMarkets/LendMarketTemplate.d.ts

@@ -518,4 +518,5 @@ export declare class LendMarketTemplate {
     private leverageRepay;
     currentLeverage(userAddress?: string): Promise<string>;
     currentPnL(userAddress?: string): Promise<Record<string, string>>;
+    userBoost(address?: string): Promise<string>;
 }

package/lib/lendMarkets/LendMarketTemplate.js

@@ -2774,4 +2774,29 @@ export class LendMarketTemplate {
             };
         });
     }
+    userBoost() {
+        return __awaiter(this, arguments, void 0, function* (address = "") {
+            if (this.addresses.gauge === this.llamalend.constants.ZERO_ADDRESS) {
+                throw Error(`${this.name} doesn't have gauge`);
+            }
+            if (this.vaultRewardsOnly()) {
+                throw Error(`${this.name} has Rewards-Only Gauge. Use stats.rewardsApy instead`);
+            }
+            address = _getAddress.call(this.llamalend, address);
+            const gaugeContract = this.llamalend.contracts[this.addresses.gauge].multicallContract;
+            const [workingBalanceBN, balanceBN] = (yield this.llamalend.multicallProvider.all([
+                gaugeContract.working_balances(address),
+                gaugeContract.balanceOf(address),
+            ])).map((value) => toBN(value));
+            if (balanceBN.isZero()) {
+                return '1.0';
+            }
+            const boostBN = workingBalanceBN.div(0.4).div(balanceBN);
+            if (boostBN.lt(1))
+                return '1.0';
+            if (boostBN.gt(2.5))
+                return '2.5';
+            return boostBN.toFixed(4).replace(/([0-9])0+$/, '$1');
+        });
+    }
 }

package/lib/mintMarkets/MintMarketTemplate.d.ts

@@ -80,6 +80,7 @@ export declare class MintMarketTemplate {
         }>;
     };
     leverage: {
+        maxLeverage: (N?: number) => Promise<string>;
         createLoanMaxRecv: (collateral: number | string, range: number) => Promise<{
             maxBorrowable: string;
             maxCollateral: string;
@@ -312,6 +313,8 @@ export declare class MintMarketTemplate {
     private _leverageCreateLoan;
     private leverageCreateLoanEstimateGas;
     private leverageCreateLoan;
+    private _get_k_effective_BN;
+    private maxLeverage;
     private _checkDeleverageZap;
     private deleverageRepayStablecoins;
     private deleverageGetRouteName;

package/lib/mintMarkets/MintMarketTemplate.js

@@ -294,6 +294,7 @@ export class MintMarketTemplate {
             balances: this.walletBalances.bind(this),
         };
         this.leverage = {
+            maxLeverage: this.maxLeverage.bind(this),
             createLoanMaxRecv: this.leverageCreateLoanMaxRecv.bind(this),
             createLoanMaxRecvAllRanges: this.leverageCreateLoanMaxRecvAllRanges.bind(this),
             createLoanCollateral: this.leverageCreateLoanCollateral.bind(this),
@@ -1594,6 +1595,29 @@ export class MintMarketTemplate {
             return yield this._leverageCreateLoan(collateral, debt, range, slippage, false);
         });
     }
+    _get_k_effective_BN(N) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // d_k_effective: uint256 = (1 - loan_discount) * sqrt((A-1)/A) / N
+            // k_effective = d_k_effective * sum_{0..N-1}(((A-1) / A)**k)
+            const { loan_discount } = yield this.statsParameters();
+            const A = this.A;
+            const A_BN = BN(A);
+            const A_ratio_BN = A_BN.minus(1).div(A_BN);
+            const d_k_effective_BN = BN(100).minus(loan_discount).div(100).times(A_ratio_BN.sqrt()).div(N);
+            let S = BN(0);
+            for (let n = 0; n < N; n++) {
+                S = S.plus(A_ratio_BN.pow(n));
+            }
+            return d_k_effective_BN.times(S);
+        });
+    }
+    maxLeverage() {
+        return __awaiter(this, arguments, void 0, function* (N = 4) {
+            // max_leverage = 1 / (k_effective - 1)
+            const k_effective_BN = yield this._get_k_effective_BN(N);
+            return BN(1).div(BN(1).minus(k_effective_BN)).toString();
+        });
+    }
     // ---------------- DELEVERAGE REPAY ----------------
     _checkDeleverageZap() {
         if (this.deleverageZap === "0x0000000000000000000000000000000000000000")

package/package.json

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

package/src/lendMarkets/LendMarketTemplate.ts

@@ -3134,4 +3134,30 @@ export class LendMarketTemplate {
             percentage: percentage.toFixed(2).toString(),
         };
     }
+
+    public async userBoost(address = ""): Promise<string> {
+        if (this.addresses.gauge === this.llamalend.constants.ZERO_ADDRESS) {
+            throw Error(`${this.name} doesn't have gauge`);
+        }
+        if (this.vaultRewardsOnly()) {
+            throw Error(`${this.name} has Rewards-Only Gauge. Use stats.rewardsApy instead`);
+        }
+        address = _getAddress.call(this.llamalend, address);
+
+        const gaugeContract = this.llamalend.contracts[this.addresses.gauge].multicallContract;
+        const [workingBalanceBN, balanceBN] = (await this.llamalend.multicallProvider.all([
+            gaugeContract.working_balances(address),
+            gaugeContract.balanceOf(address),
+        ]) as bigint[]).map((value: bigint) => toBN(value));
+
+        if (balanceBN.isZero()) {
+            return '1.0';
+        }
+
+        const boostBN = workingBalanceBN.div(0.4).div(balanceBN);
+        if (boostBN.lt(1)) return '1.0';
+        if (boostBN.gt(2.5)) return '2.5';
+
+        return boostBN.toFixed(4).replace(/([0-9])0+$/, '$1');
+    }
 }

package/src/mintMarkets/MintMarketTemplate.ts

@@ -90,6 +90,7 @@ export class MintMarketTemplate {
         balances: (address?: string) => Promise<{ stablecoin: string, collateral: string }>,
     };
     leverage: {
+        maxLeverage: (N?: number) => Promise<string>,
         createLoanMaxRecv: (collateral: number | string, range: number) => Promise<{ maxBorrowable: string, maxCollateral: string, leverage: string, routeIdx: number }>,
         createLoanMaxRecvAllRanges: (collateral: number | string) => Promise<IDict<{ maxBorrowable: string, maxCollateral: string, leverage: string, routeIdx: number }>>,
         createLoanCollateral: (userCollateral: number | string, debt: number | string) => Promise<{ collateral: string, leverage: string, routeIdx: number }>,
@@ -185,6 +186,7 @@ export class MintMarketTemplate {
             balances: this.walletBalances.bind(this),
         }
         this.leverage = {
+            maxLeverage: this.maxLeverage.bind(this),
             createLoanMaxRecv: this.leverageCreateLoanMaxRecv.bind(this),
             createLoanMaxRecvAllRanges: this.leverageCreateLoanMaxRecvAllRanges.bind(this),
             createLoanCollateral: this.leverageCreateLoanCollateral.bind(this),
@@ -1688,6 +1690,30 @@ export class MintMarketTemplate {
         return await this._leverageCreateLoan(collateral, debt, range, slippage, false) as string;
     }
 
+    private async _get_k_effective_BN(N: number): Promise<BigNumber> {
+        // d_k_effective: uint256 = (1 - loan_discount) * sqrt((A-1)/A) / N
+        // k_effective = d_k_effective * sum_{0..N-1}(((A-1) / A)**k)
+        const { loan_discount } = await this.statsParameters();
+        const A = this.A;
+        const A_BN = BN(A);
+        const A_ratio_BN = A_BN.minus(1).div(A_BN);
+
+        const d_k_effective_BN = BN(100).minus(loan_discount).div(100).times(A_ratio_BN.sqrt()).div(N);
+        let S = BN(0);
+        for (let n = 0; n < N; n++) {
+            S = S.plus(A_ratio_BN.pow(n))
+        }
+
+        return d_k_effective_BN.times(S);
+    }
+
+    private async maxLeverage(N: number = 4): Promise<string> {
+        // max_leverage = 1 / (k_effective - 1)
+        const k_effective_BN = await this._get_k_effective_BN(N);
+
+        return BN(1).div(BN(1).minus(k_effective_BN)).toString()
+    }
+
     // ---------------- DELEVERAGE REPAY ----------------
 
     private _checkDeleverageZap(): void {