@curvefi/api 2.71.6 → 2.72.0

package/lib/boosting.d.ts

@@ -1,5 +1,12 @@
 import { type Curve } from "./curve.js";
-import { IChainId, IDict } from "./interfaces";
+import { IChainId, IDict, IPoolData } from "./interfaces";
+type BoostPool = Pick<IPoolData, "name" | "gauge_address">;
+export declare function _getGaugeBoostStatus(this: Curve, gaugeAddress: string): {
+    hasGauge: boolean;
+    rewardsOnly: boolean;
+};
+export declare function _getUserBoosts(this: Curve, pools: BoostPool[], userAddress?: string, throwOnError?: boolean): Promise<(string | null)[]>;
+export declare function getUserBoosts(this: Curve, pools: string[], userAddress?: string, throwOnError?: boolean): Promise<IDict<string | null>>;
 export declare function getCrv(this: Curve, ...addresses: string[] | string[][]): Promise<IDict<string> | string>;
 export declare function getLockedAmountAndUnlockTime(this: Curve, ...addresses: string[] | string[][]): Promise<IDict<{
     lockedAmount: string;
@@ -39,3 +46,4 @@ export declare function sendBlockhashEstimateGas(this: Curve, block: number, cha
 export declare function sendBlockhash(this: Curve, block: number, chainId: IChainId): Promise<string>;
 export declare function submitProofEstimateGas(this: Curve, block: number, address?: string): Promise<number>;
 export declare function submitProof(this: Curve, block: number, address?: string): Promise<string>;
+export {};

package/lib/boosting.js

@@ -11,8 +11,70 @@ import { Contract } from "ethers";
 import BigNumber from "bignumber.js";
 import feeDistributorViewABI from "./constants/abis/fee_distributor_view.json" with { type: "json" };
 import feeDistributorCrvUSDViewABI from "./constants/abis/fee_distributor_crvusd_view.json" with { type: "json" };
-import { _ensureAllowance, _getBalances, _prepareAddresses, BN, DIGas, ensureAllowance, ensureAllowanceEstimateGas, hasAllowance, mulBy1_3, parseUnits, smartNumber, toBN, toStringFromBN, } from "./utils.js";
+import { _ensureAllowance, _getAddress, _getBalances, _prepareAddresses, BN, DIGas, ensureAllowance, ensureAllowanceEstimateGas, findAbiFunction, getPoolIdBySwapAddress, hasAllowance, mulBy1_3, parseUnits, smartNumber, toBN, toStringFromBN, } from "./utils.js";
 import { _generateBoostingProof } from './external-api.js';
+export function _getGaugeBoostStatus(gaugeAddress) {
+    const hasGauge = gaugeAddress !== this.constants.ZERO_ADDRESS;
+    // TODO remove the Kava and ZkSync exceptions
+    const rewardsOnly = this.chainId === 2222 || this.chainId === 324 ||
+        (hasGauge && !findAbiFunction(this.contracts[gaugeAddress].abi, 'inflation_rate')
+            .find((func) => ['', 'uint256'].includes(func.inputs.map((input) => `${input.type}`).join(','))));
+    return { hasGauge, rewardsOnly };
+}
+export function _getUserBoosts(pools_1) {
+    return __awaiter(this, arguments, void 0, function* (pools, userAddress = "", throwOnError = true) {
+        const checkedPools = pools.map((pool) => {
+            try {
+                const { hasGauge, rewardsOnly } = _getGaugeBoostStatus.call(this, pool.gauge_address);
+                if (!hasGauge)
+                    throw Error(`${pool.name} doesn't have gauge`);
+                if (rewardsOnly)
+                    throw Error(`${pool.name} has Rewards-Only Gauge. Use stats.rewardsApy instead`);
+                return pool;
+            }
+            catch (error) {
+                if (throwOnError)
+                    throw error;
+                return null;
+            }
+        }).filter((pool) => pool !== null);
+        userAddress = _getAddress.call(this, userAddress);
+        const calls = checkedPools.flatMap((pool) => {
+            const gaugeContract = this.contracts[pool.gauge_address].multicallContract;
+            return [
+                gaugeContract.working_balances(userAddress),
+                gaugeContract.balanceOf(userAddress),
+            ];
+        });
+        const response = calls.length > 0
+            ? yield this.multicallProvider.all(calls)
+            : [];
+        // Creating a Map because not all pools may have a boost value, and we want to return null for those that don't.
+        const boostsByPool = new Map(checkedPools.map((pool, index) => {
+            const workingBalanceBN = toBN(response[2 * index]);
+            const balanceBN = toBN(response[(2 * index) + 1]);
+            const boostBN = balanceBN.gt(0) ? workingBalanceBN.div(0.4).div(balanceBN) : toBN(BigInt(0), 0);
+            if (boostBN.lt(1))
+                return [pool, '1.0'];
+            if (boostBN.gt(2.5))
+                return [pool, '2.5'];
+            return [pool, boostBN.toFixed(4).replace(/([0-9])0+$/, '$1')];
+        }));
+        return pools.map((pool) => { var _a; return (_a = boostsByPool.get(pool)) !== null && _a !== void 0 ? _a : null; });
+    });
+}
+export function getUserBoosts(pools_1) {
+    return __awaiter(this, arguments, void 0, function* (pools, userAddress = "", throwOnError = true) {
+        if (pools.length === 0)
+            return {};
+        const poolsData = this.getPoolsData();
+        const poolIds = pools.map((poolAddress) => getPoolIdBySwapAddress.call(this, poolAddress));
+        if (poolIds.some((poolId) => !poolId))
+            throw new Error("One or more pool addresses doesn't have pool data");
+        const boosts = yield _getUserBoosts.call(this, poolIds.map((poolId) => poolsData[poolId]), userAddress, throwOnError);
+        return Object.fromEntries(pools.map((poolAddress, index) => [poolAddress, boosts[index]]));
+    });
+}
 export function getCrv(...addresses) {
     return __awaiter(this, void 0, void 0, function* () {
         addresses = _prepareAddresses.call(this, addresses);

package/lib/index.d.ts

@@ -194,6 +194,7 @@ export declare const createCurve: () => {
     };
     boosting: {
         getCrv: (...args: string[] | string[][]) => Promise<string | import("./interfaces.js").IDict<string>>;
+        getUserBoosts: (pools: string[], userAddress?: string | undefined, throwOnError?: boolean | undefined) => Promise<import("./interfaces.js").IDict<string | null>>;
         getLockedAmountAndUnlockTime: (...args: string[] | string[][]) => Promise<import("./interfaces.js").IDict<{
             lockedAmount: string;
             unlockTime: number;
@@ -532,6 +533,7 @@ declare const _default: {
     };
     boosting: {
         getCrv: (...args: string[] | string[][]) => Promise<string | import("./interfaces.js").IDict<string>>;
+        getUserBoosts: (pools: string[], userAddress?: string | undefined, throwOnError?: boolean | undefined) => Promise<import("./interfaces.js").IDict<string | null>>;
         getLockedAmountAndUnlockTime: (...args: string[] | string[][]) => Promise<import("./interfaces.js").IDict<{
             lockedAmount: string;
             unlockTime: number;

package/lib/index.js

@@ -12,7 +12,7 @@ import { getUserPoolListByLiquidity, getUserPoolListByClaimable, getUserPoolList
 import { getBestRouteAndOutput, getArgs, swapExpected, swapRequired, swapPriceImpact, swapIsApproved, swapApproveEstimateGas, swapApprove, swapPopulateApprove, swapEstimateGas, swap, populateSwap, getSwappedAmount, approveFromCalldata, approveFromCalldataEstimateGas, swapFromCalldata, swapFromCalldataEstimateGas, setRouterBlacklist, } from "./router.js";
 import { isSupported, assertIsSupported, allowedToBridge, bridgeCost, bridgeIsApproved, bridgeApproveEstimateGas, bridgeApprove, bridgeEstimateGas, bridge, getSupportedNetworks, } from "./bridge.js";
 import { Curve } from "./curve.js";
-import { getCrv, getLockedAmountAndUnlockTime, getVeCrv, getVeCrvPct, calcUnlockTime, createLockEstimateGas, createLock, isApproved, approveEstimateGas, approve, increaseAmountEstimateGas, increaseAmount, increaseUnlockTimeEstimateGas, increaseUnlockTime, withdrawLockedCrvEstimateGas, withdrawLockedCrv, claimableFees, claimFeesEstimateGas, claimFees, lastEthBlock, getAnycallBalance, topUpAnycall, topUpAnycallEstimateGas, lastBlockSent, blockToSend, sendBlockhash, sendBlockhashEstimateGas, submitProof, submitProofEstimateGas, claimFeesCrvUSDEstimateGas, claimableFeesCrvUSD, claimFeesCrvUSD, calculateVeCrv, } from "./boosting.js";
+import { getCrv, getUserBoosts, getLockedAmountAndUnlockTime, getVeCrv, getVeCrvPct, calcUnlockTime, createLockEstimateGas, createLock, isApproved, approveEstimateGas, approve, increaseAmountEstimateGas, increaseAmount, increaseUnlockTimeEstimateGas, increaseUnlockTime, withdrawLockedCrvEstimateGas, withdrawLockedCrv, claimableFees, claimFeesEstimateGas, claimFees, lastEthBlock, getAnycallBalance, topUpAnycall, topUpAnycallEstimateGas, lastBlockSent, blockToSend, sendBlockhash, sendBlockhashEstimateGas, submitProof, submitProofEstimateGas, claimFeesCrvUSDEstimateGas, claimableFeesCrvUSD, claimFeesCrvUSD, calculateVeCrv, } from "./boosting.js";
 import { getBalances, getAllowance, hasAllowance, ensureAllowanceEstimateGas, ensureAllowance, populateApprove, getUsdRate, getGasPriceFromL1, getGasPriceFromL2, getGasInfoForL2, getTVL, getCoinsData, getVolume, getPoolVolumes, hasDepositAndStake, hasRouter, getBasePools, getGasPrice, getCurveLiteNetworks, } from "./utils.js";
 import { deployStablePlainPool, deployStablePlainPoolEstimateGas, getDeployedStablePlainPoolAddress, setOracle, setOracleEstimateGas, deployStableMetaPool, deployStableMetaPoolEstimateGas, getDeployedStableMetaPoolAddress, deployCryptoPool, deployCryptoPoolEstimateGas, getDeployedCryptoPoolAddress, deployTricryptoPool, deployTricryptoPoolEstimateGas, getDeployedTricryptoPoolAddress, deployGauge, deployGaugeEstimateGas, getDeployedGaugeAddress, deployGaugeSidechain, deployGaugeSidechainEstimateGas, deployGaugeMirror, deployGaugeMirrorEstimateGas, getDeployedGaugeMirrorAddress, getDeployedGaugeMirrorAddressByTx, deployStableNgPlainPool, deployStableNgPlainPoolEstimateGas, deployStableNgMetaPool, deployStableNgMetaPoolEstimateGas, deployTwocryptoPool, deployTwocryptoPoolEstimateGas, getDeployedTwocryptoPoolAddress, } from './factory/deploy.js';
 import { getTwoCryptoImplementations } from './constants/twoCryptoImplementations.js';
@@ -186,6 +186,7 @@ export const createCurve = () => {
         },
         boosting: {
             getCrv: getCrv.bind(_curve),
+            getUserBoosts: getUserBoosts.bind(_curve),
             getLockedAmountAndUnlockTime: getLockedAmountAndUnlockTime.bind(_curve),
             getVeCrv: getVeCrv.bind(_curve),
             getVeCrvPct: getVeCrvPct.bind(_curve),

package/lib/pools/PoolTemplate.d.ts

@@ -89,7 +89,7 @@ export declare class PoolTemplate extends CorePool {
     claimableCrv(address?: string): Promise<string>;
     claimCrvEstimateGas(): Promise<number | number[]>;
     claimCrv(): Promise<string>;
-    userBoost: (address?: string) => Promise<string>;
+    userBoost: (userAddress?: string) => Promise<string>;
     private _userFutureBoostAndWorkingSupply;
     userFutureBoost: (address?: string) => Promise<string>;
     userCrvApy: (address?: string) => Promise<number>;

package/lib/pools/PoolTemplate.js

@@ -10,6 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 import memoize from "memoizee";
 import { getGaugesOverview } from '../prices-api.js';
 import { _getPoolFilters } from '../external-api.js';
+import { _getGaugeBoostStatus, _getUserBoosts } from "../boosting.js";
 import { _cutZeros, _ensureAllowance, _get_price_impact, _get_small_x, _getAddress, _getCoinAddresses, _getRewardsFromApi, _getUsdRate, _setContracts, BN, checkNumber, DIGas, ensureAllowance, ensureAllowanceEstimateGas, findAbiFunction, fromBN, hasAllowance, mulBy1_3, parseUnits, PERIODS, smartNumber, toBN, toStringFromBN, } from '../utils.js';
 import { OLD_CHAINS } from "../curve.js";
 import ERC20Abi from '../constants/abis/ERC20.json' with { type: 'json' };
@@ -178,23 +179,11 @@ export class PoolTemplate extends CorePool {
                 price: crvPrice,
             };
         });
-        this.userBoost = (...args_1) => __awaiter(this, [...args_1], void 0, function* (address = "") {
-            if (this.gauge.address === this.curve.constants.ZERO_ADDRESS)
-                throw Error(`${this.name} doesn't have gauge`);
-            if (this.rewardsOnly())
-                throw Error(`${this.name} has Rewards-Only Gauge. Use stats.rewardsApy instead`);
-            address = _getAddress.call(this.curve, address);
-            const gaugeContract = this.curve.contracts[this.gauge.address].multicallContract;
-            const [workingBalanceBN, balanceBN] = (yield this.curve.multicallProvider.all([
-                gaugeContract.working_balances(address),
-                gaugeContract.balanceOf(address),
-            ])).map((value) => toBN(value));
-            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');
+        this.userBoost = (...args_1) => __awaiter(this, [...args_1], void 0, function* (userAddress = "") {
+            return (yield _getUserBoosts.call(this.curve, [{
+                    name: this.name,
+                    gauge_address: this.gauge.address,
+                }], userAddress, true))[0];
         });
         this._userFutureBoostAndWorkingSupply = (address) => __awaiter(this, void 0, void 0, function* () {
             // Calc future working balance
@@ -591,12 +580,10 @@ export class PoolTemplate extends CorePool {
         return checkVyperVulnerability(this.curve.chainId, this.id, this.implementation);
     }
     rewardsOnly() {
-        if (this.curve.chainId === 2222 || this.curve.chainId === 324)
-            return true; // TODO remove this for Kava and ZkSync
-        if (this.gauge.address === this.curve.constants.ZERO_ADDRESS)
+        const { hasGauge, rewardsOnly } = _getGaugeBoostStatus.call(this.curve, this.gauge.address);
+        if (!hasGauge && !rewardsOnly)
             throw Error(`${this.name} doesn't have gauge`);
-        return !findAbiFunction(this.curve.contracts[this.gauge.address].abi, 'inflation_rate')
-            .find((func) => ['', 'uint256'].includes(func.inputs.map((a) => `${a.type}`).join(',')));
+        return rewardsOnly;
     }
     _pureCalcLpTokenAmount(_amounts_1) {
         return __awaiter(this, arguments, void 0, function* (_amounts, isDeposit = true, useUnderlying = true) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@curvefi/api",
-  "version": "2.71.6",
+  "version": "2.72.0",
   "description": "JavaScript library for curve.finance",
   "main": "lib/index.js",
   "author": "Macket",