@raac/rpc 1.2.0-beta.10 → 1.2.0-beta.11

package/dist/contracts/governance/gauge/getGaugeData.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getGaugeData = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+/**
+ * Reads a gauge's `gaugeData` struct: its staking and reward tokens, distributor, supplies and period state.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The gauge data.
+ */
+const getGaugeData = async (chainId, gaugeAddressOrId, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const contract = new ethers_1.ethers.Contract(gaugeAddress, (0, artifacts_1.getABI)("basegauge"), provider);
+    const [gaugeInitialStartTime, periodDuration, periodIndex, stakingToken, totalSupply, workingSupply, rewardDistributor, rewardToken, lastUpdateTime,] = await contract.gaugeData();
+    return {
+        gaugeInitialStartTime,
+        periodDuration,
+        periodIndex,
+        stakingToken,
+        totalSupply,
+        workingSupply,
+        rewardDistributor,
+        rewardToken,
+        lastUpdateTime,
+    };
+};
+exports.getGaugeData = getGaugeData;

package/dist/contracts/governance/gauge/getGaugeRewardTokenData.js

@@ -7,7 +7,7 @@ exports.getGaugeRewardTokenData = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const artifacts_1 = require("../../../utils/artifacts");
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
  * Gets the gauge-level reward accounting data for a specific token.
  * @param chainId - The chain/network to use.
@@ -20,14 +20,7 @@ const getGaugeRewardTokenData = async (chainId, gaugeAddressOrId, token, provide
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-        gaugeAddress = gaugeAddressOrId;
-    }
-    else {
-        // @ts-ignore
-        gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const abi = (0, artifacts_1.getABI)("basegauge");
     const contract = new ethers_1.ethers.Contract(gaugeAddress, abi, provider);
     const [isActive, decimals, rate, integral, lastUpdateTime, distributed, leftoverRewards,] = await contract.getGaugeRewardTokenData(token);

package/dist/contracts/governance/gauge/getPauseStatus.js

@@ -0,0 +1,31 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPauseStatus = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+/**
+ * Reads both pause switches that gate a gauge, mirroring the contract's `whenGaugeLive` check.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The gauge's and its controller's pause flags, and whether the gauge is live.
+ */
+const getPauseStatus = async (chainId, gaugeAddressOrId, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const gauge = new ethers_1.ethers.Contract(gaugeAddress, (0, artifacts_1.getABI)("basegauge"), provider);
+    const [gaugePaused, controllerAddress] = await Promise.all([gauge.isPaused(), gauge.gaugeController()]);
+    const controller = new ethers_1.ethers.Contract(controllerAddress, (0, artifacts_1.getABI)("gaugecontroller"), provider);
+    const controllerPaused = await controller.isPaused();
+    return { gaugePaused, controllerPaused, live: !gaugePaused && !controllerPaused };
+};
+exports.getPauseStatus = getPauseStatus;

package/dist/contracts/governance/gauge/getPendingExtraRewards.js

@@ -7,7 +7,7 @@ exports.getPendingExtraRewards = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const artifacts_1 = require("../../../utils/artifacts");
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
  * Gets the pending extra rewards for a user for a specific token.
  * @param chainId - The chain/network to use.
@@ -21,14 +21,7 @@ const getPendingExtraRewards = async (chainId, gaugeAddressOrId, token, user, pr
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-        gaugeAddress = gaugeAddressOrId;
-    }
-    else {
-        // @ts-ignore
-        gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const abi = (0, artifacts_1.getABI)("basegauge");
     const contract = new ethers_1.ethers.Contract(gaugeAddress, abi, provider);
     return contract.pendingExtraRewards(token, user);

package/dist/contracts/governance/gauge/getPendingRewards.js

@@ -6,31 +6,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPendingRewards = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
-const PENDING_REWARDS_ABI = "function pendingRewards(address account) view returns (uint256)";
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Gets the pending (unclaimed) main-reward-token amount for a user on a gauge.
+ * Gets the rewards a user can claim from a gauge for one reward token. Only counts rewards already pulled into the gauge, which is everything a user can claim right now; `getUserClaimableRewards` adds the extra reward tokens.
  *
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - The gauge's main reward token (`getGaugeData().rewardToken`). Any other token reverts with NotSupportedToken; use `getPendingExtraRewards` for extra reward tokens.
  * @param accountAddress - Address of the user.
  * @param provider - Optional ethers.js Provider instance.
  * @returns The pending reward amount (raw, base units).
  */
-const getPendingRewards = async (chainId, gaugeAddressOrId, accountAddress, provider) => {
+const getPendingRewards = async (chainId, gaugeAddressOrId, token, accountAddress, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-        gaugeAddress = gaugeAddressOrId;
-    }
-    else {
-        // @ts-ignore
-        gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-    }
-    const contract = new ethers_1.ethers.Contract(gaugeAddress, [PENDING_REWARDS_ABI], provider);
-    return contract.pendingRewards(accountAddress);
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const contract = new ethers_1.ethers.Contract(gaugeAddress, (0, artifacts_1.getABI)("basegauge"), provider);
+    return contract.pendingRewards(token, accountAddress);
 };
 exports.getPendingRewards = getPendingRewards;

package/dist/contracts/governance/gauge/getPeriodBoundaries.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPeriodBoundaries = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 const GET_PERIOD_BOUNDARIES_ABI = "function getPeriodBoundaries() view returns (uint256 periodStartTime, uint256 periodEndTime)";
 /**
  * Gets the start and end time of the current period.
@@ -21,20 +21,7 @@ const getPeriodBoundaries = async (chainId, gaugeAddressOrId, provider) => {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    try {
-        if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-            gaugeAddress = gaugeAddressOrId;
-        }
-        else {
-            // @ts-ignore
-            gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-        }
-    }
-    catch (error) {
-        console.error("Error getting period boundaries:", error);
-        throw new Error(`Failed to get period boundaries from gauge ${gaugeAddress}: ${error.message}`);
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const contract = new ethers_1.ethers.Contract(gaugeAddress, [GET_PERIOD_BOUNDARIES_ABI], provider);
     const [periodStartTime, periodEndTime] = await contract.getPeriodBoundaries();
     return {

package/dist/contracts/governance/gauge/getPeriodDuration.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPeriodDuration = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 const PERIOD_DURATION_ABI = "function periodDuration() view returns (uint256)";
 /**
  * Gets the period duration for the gauge.
@@ -21,20 +21,7 @@ const getPeriodDuration = async (chainId, gaugeAddressOrId, provider) => {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    try {
-        if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-            gaugeAddress = gaugeAddressOrId;
-        }
-        else {
-            // @ts-ignore
-            gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-        }
-    }
-    catch (error) {
-        console.error("Error getting period duration:", error);
-        throw new Error(`Failed to get period duration from gauge ${gaugeAddress}: ${error.message}`);
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const contract = new ethers_1.ethers.Contract(gaugeAddress, [PERIOD_DURATION_ABI], provider);
     const periodDuration = await contract.periodDuration();
     return Number(periodDuration);

package/dist/contracts/governance/gauge/getRaacAutolockMin.js

@@ -7,7 +7,7 @@ exports.getRaacAutolockMin = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
 const artifacts_1 = require("../../../utils/artifacts");
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
  * Gets the minimum RAAC amount required to trigger an autolock on claim.
  * @param chainId - The chain/network to use.
@@ -19,14 +19,7 @@ const getRaacAutolockMin = async (chainId, gaugeAddressOrId, provider) => {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-        gaugeAddress = gaugeAddressOrId;
-    }
-    else {
-        // @ts-ignore
-        gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const abi = (0, artifacts_1.getABI)("basegauge");
     const contract = new ethers_1.ethers.Contract(gaugeAddress, abi, provider);
     return contract.raacAutolockMin();

package/dist/contracts/governance/gauge/getRawBalanceOf.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRawBalanceOf = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 const RAW_BALANCE_OF_ABI = "function rawBalanceOf(address account) view returns (uint256)";
 /**
  * Gets the raw balance of an account (without boost).
@@ -22,20 +22,7 @@ const getRawBalanceOf = async (chainId, gaugeAddressOrId, accountAddress, provid
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    try {
-        if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-            gaugeAddress = gaugeAddressOrId;
-        }
-        else {
-            // @ts-ignore
-            gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-        }
-    }
-    catch (error) {
-        console.error("Error getting raw balance of:", error);
-        throw new Error(`Failed to get raw balance of from gauge ${gaugeAddress}: ${error.message}`);
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const contract = new ethers_1.ethers.Contract(gaugeAddress, [RAW_BALANCE_OF_ABI], provider);
     const balance = await contract.rawBalanceOf(accountAddress);
     return ethers_1.ethers.formatEther(balance);

package/dist/contracts/governance/gauge/getRawTotalSupply.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRawTotalSupply = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 const RAW_TOTAL_SUPPLY_ABI = "function rawTotalSupply() view returns (uint256)";
 /**
  * Gets the raw total supply of the gauge (without boost).
@@ -21,20 +21,7 @@ const getRawTotalSupply = async (chainId, gaugeAddressOrId, provider) => {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    try {
-        if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-            gaugeAddress = gaugeAddressOrId;
-        }
-        else {
-            // @ts-ignore
-            gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-        }
-    }
-    catch (error) {
-        console.error("Error getting raw total supply:", error);
-        throw new Error(`Failed to get raw total supply from gauge ${gaugeAddress}: ${error.message}`);
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const contract = new ethers_1.ethers.Contract(gaugeAddress, [RAW_TOTAL_SUPPLY_ABI], provider);
     const rawTotalSupply = await contract.rawTotalSupply();
     return ethers_1.ethers.formatEther(rawTotalSupply);

package/dist/contracts/governance/gauge/getRewardTokens.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRewardTokens = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+/**
+ * Gets every reward token of a gauge: the main reward token first, then the extra reward tokens.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The reward token addresses.
+ */
+const getRewardTokens = async (chainId, gaugeAddressOrId, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const contract = new ethers_1.ethers.Contract(gaugeAddress, (0, artifacts_1.getABI)("basegauge"), provider);
+    return [...(await contract.getRewardTokens())];
+};
+exports.getRewardTokens = getRewardTokens;

package/dist/contracts/governance/gauge/getTotalSupply.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getTotalSupply = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 const TOTAL_SUPPLY_ABI = "function totalSupply() view returns (uint256)";
 /**
  * Gets the working supply of the gauge (includes boost).
@@ -21,20 +21,7 @@ const getTotalSupply = async (chainId, gaugeAddressOrId, provider) => {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    try {
-        if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-            gaugeAddress = gaugeAddressOrId;
-        }
-        else {
-            // @ts-ignore
-            gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-        }
-    }
-    catch (error) {
-        console.error("Error getting total supply:", error);
-        throw new Error(`Failed to get total supply from gauge ${gaugeAddress}: ${error.message}`);
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const contract = new ethers_1.ethers.Contract(gaugeAddress, [TOTAL_SUPPLY_ABI], provider);
     const totalSupply = await contract.totalSupply();
     return ethers_1.ethers.formatEther(totalSupply);

package/dist/contracts/governance/gauge/getUserApy.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserApy = void 0;
+const ethers_1 = require("ethers");
+const _apy_1 = require("./_apy");
+const toPosition = (balance, working, workingSupply, totalSupply, decimals, maxBoost, mainYearlyUSD, extraYearlyUSD, price) => {
+    const balanceUnits = Number(ethers_1.ethers.formatUnits(balance, decimals));
+    const workingUnits = Number(ethers_1.ethers.formatUnits(working, decimals));
+    const workingSupplyUnits = Number(ethers_1.ethers.formatUnits(workingSupply, decimals));
+    const userMainUSD = workingSupplyUnits > 0 ? (mainYearlyUSD * workingUnits) / workingSupplyUnits : 0;
+    const mainApy = (0, _apy_1.toApyPct)(userMainUSD, balanceUnits, price);
+    const extraApy = balance > 0n ? (0, _apy_1.toApyPct)(extraYearlyUSD, Number(ethers_1.ethers.formatUnits(totalSupply, decimals)), price) : null;
+    return {
+        balance: ethers_1.ethers.formatUnits(balance, decimals),
+        workingBalance: ethers_1.ethers.formatUnits(working, decimals),
+        boost: balance > 0n ? (workingUnits / balanceUnits) * (Number(maxBoost) / 10000) : null,
+        mainApy,
+        extraApy,
+        apy: mainApy === null && extraApy === null ? null : (mainApy ?? 0) + (extraApy ?? 0),
+    };
+};
+/**
+ * Calculates a user's APY on a gauge: what they earn now, and what they would earn after their boost is re-checkpointed, optionally with extra stake. Figures are simple annualized rates in percent, not compounded.
+ *
+ * The user's share of main rewards is workingBalance / workingSupply; extra rewards are shared by raw balance. The stored working balance only changes when the user's position is checkpointed, so `current` can lag their veRAAC: `projected` recomputes it with the controller's `calculateBoost` and adjusts workingSupply and totalSupply for the change, holding every other staker fixed.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param user - Address of the user.
+ * @param prices - USD price of the staking token and of each reward token (see `getRewardTokens`).
+ * @param options - Optional reward source ("epoch" default, or "stream") and `additionalStake`, a staking token amount in base units to add in the projection.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The user's current and projected position and APY, with the gauge's min and max APY. An APY is null when the position has no stake.
+ */
+const getUserApy = async (chainId, gaugeAddressOrId, user, prices, options = {}, provider) => {
+    if (!ethers_1.ethers.isAddress(user)) {
+        throw new Error(`Invalid user address: ${user}`);
+    }
+    const state = await (0, _apy_1.loadGaugeApyState)(chainId, gaugeAddressOrId, prices, options, provider);
+    const additionalStake = BigInt(options.additionalStake ?? 0);
+    if (additionalStake < 0n) {
+        throw new Error("additionalStake cannot be negative");
+    }
+    const [balance, working] = await Promise.all([state.gaugeContract.rawBalanceOf(user), state.gaugeContract.balanceOf(user)]);
+    const projectedBalance = balance + additionalStake;
+    let boostBps = state.minBoost;
+    if (projectedBalance > 0n) {
+        // Mirrors BaseGauge._applyBoost, which falls back to MIN_BOOST when calculateBoost reverts (removed gauge).
+        boostBps = await state.controller
+            .calculateBoost(user, state.gauge, projectedBalance)
+            .then(([bps]) => bps)
+            .catch(() => state.minBoost);
+    }
+    let projectedWorking = (projectedBalance * boostBps) / state.maxBoost;
+    if (projectedWorking > projectedBalance)
+        projectedWorking = projectedBalance;
+    const price = prices.stakingTokenPriceUSD;
+    const d = state.stakingDecimals;
+    const current = toPosition(balance, working, state.workingSupply, state.totalSupply, d, state.maxBoost, state.mainYearlyUSD, state.extraYearlyUSD, price);
+    const projected = toPosition(projectedBalance, projectedWorking, state.workingSupply - working + projectedWorking, state.totalSupply + additionalStake, d, state.maxBoost, state.mainYearlyUSD, state.extraYearlyUSD, price);
+    const gaugeMaxApy = (0, _apy_1.toApyPct)(state.mainYearlyUSD, Number(ethers_1.ethers.formatUnits(state.workingSupply, d)), price);
+    return {
+        gauge: state.gauge,
+        user: ethers_1.ethers.getAddress(user),
+        current,
+        projected,
+        gaugeMinApy: gaugeMaxApy === null ? null : (gaugeMaxApy * Number(state.minBoost)) / Number(state.maxBoost),
+        gaugeMaxApy,
+    };
+};
+exports.getUserApy = getUserApy;

package/dist/contracts/governance/gauge/getUserClaimableRewards.js

@@ -1,37 +1,4 @@
 "use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -39,27 +6,26 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getUserClaimableRewards = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = __importStar(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 const GAUGE_ABI = [
-    "function pendingRewards(address account) view returns (uint256)",
-    "function balanceOf(address account) view returns (uint256)", // boosted working balance
-    "function totalSupply() view returns (uint256)", // working supply
+    "function gaugeData() view returns (uint256 gaugeInitialStartTime, uint256 periodDuration, uint256 periodIndex, address stakingToken, uint256 totalSupply, uint256 workingSupply, address rewardDistributor, address rewardToken, uint256 lastUpdateTime)",
+    "function pendingRewards(address token, address account) view returns (uint256)",
     "function getExtraRewardTokens() view returns (address[])",
     "function pendingExtraRewards(address token, address account) view returns (uint256)",
 ];
-const DISTRIBUTOR_ABI = ["function getClaimableForGauge(address gauge) view returns (uint256)"];
 const ERC20_META_ABI = [
     "function symbol() view returns (string)",
     "function decimals() view returns (uint8)",
 ];
 /**
- * The user's TRUE claimable rewards on a gauge.
+ * What a user can claim from a gauge right now: the main reward already accrued to them inside the gauge, plus any
+ * extra reward tokens.
  *
- * The gauge's `pendingRewards()` view only reflects RAAC already pulled into the gauge.
- * RAAC emitted to the gauge sits in the GaugeRewardsDistributor until a claim pulls it in
- * (`claimRewardToken`/`claimRewardsFor` call `_pullRewardsFromDistributor` first). So a
- * user's real claimable also includes their working-balance share of the distributor's
- * `getClaimableForGauge(gauge)`. This helper combines both, plus any extra reward tokens.
+ * Rewards still held by the GaugeRewardsDistributor are not included. They are not the user's yet: a pull
+ * (`pullRewardsFromDistributor`, or the pull every claim makes first) streams them to everyone staked over the rest of
+ * the reward period, so any per-user share of them would change with every stake, unstake and pull. Read the gauge's
+ * total still in the distributor with `governance.distributor.getClaimableForGauge` when it is needed.
+ * The distributor is read from the gauge itself, so RAAC and RWA gauges both resolve to their own system's distributor.
  *
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
@@ -71,35 +37,16 @@ const getUserClaimableRewards = async (chainId, gaugeAddressOrId, accountAddress
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    let gaugeAddress;
-    if ((0, ethers_1.isAddress)(gaugeAddressOrId)) {
-        gaugeAddress = gaugeAddressOrId;
-    }
-    else {
-        // @ts-ignore
-        gaugeAddress = (0, getContractAddress_1.default)(chainId, gaugeAddressOrId.toLowerCase());
-    }
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
     const gauge = new ethers_1.ethers.Contract(gaugeAddress, GAUGE_ABI, provider);
-    const [inGauge, working, supply, extraTokens] = await Promise.all([
-        gauge.pendingRewards(accountAddress).then((v) => BigInt(v)).catch(() => 0n),
-        gauge.balanceOf(accountAddress).then((v) => BigInt(v)).catch(() => 0n),
-        gauge.totalSupply().then((v) => BigInt(v)).catch(() => 0n),
+    const [rewardToken, distributorAddr] = await gauge
+        .gaugeData()
+        .then((d) => [d.rewardToken, d.rewardDistributor]);
+    const [inGauge, rewardDecimals, extraTokens] = await Promise.all([
+        gauge.pendingRewards(rewardToken, accountAddress).then((v) => BigInt(v)).catch(() => 0n),
+        new ethers_1.ethers.Contract(rewardToken, ERC20_META_ABI, provider).decimals().then((d) => Number(d)).catch(() => 18),
         gauge.getExtraRewardTokens().catch(() => []),
     ]);
-    // User's share of RAAC still held by the distributor for this gauge.
-    let inDistributor = 0n;
-    try {
-        const distributorAddr = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-        const distributor = new ethers_1.ethers.Contract(distributorAddr, DISTRIBUTOR_ABI, provider);
-        const gaugeClaimable = BigInt(await distributor.getClaimableForGauge(gaugeAddress));
-        if (supply > 0n && working > 0n && gaugeClaimable > 0n) {
-            inDistributor = (gaugeClaimable * working) / supply;
-        }
-    }
-    catch {
-        /* distributor not configured / no pending */
-    }
-    const raac = inGauge + inDistributor;
     const extras = [];
     for (const token of extraTokens) {
         try {
@@ -125,10 +72,11 @@ const getUserClaimableRewards = async (chainId, gaugeAddressOrId, accountAddress
     }
     return {
         gauge: gaugeAddress,
+        rewardToken,
+        distributor: distributorAddr,
         inGauge,
-        inDistributor,
-        raac,
-        raacFormatted: ethers_1.ethers.formatEther(raac),
+        raac: inGauge,
+        raacFormatted: ethers_1.ethers.formatUnits(inGauge, rewardDecimals),
         extras,
     };
 };

package/dist/contracts/governance/gauge/getUserGaugeState.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserGaugeState = void 0;
+const ethers_1 = require("ethers");
+const chains_1 = __importDefault(require("../../../configs/chains"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
+const _tokens_1 = require("./_tokens");
+const RAW_BALANCE_OF_ABI = ["function rawBalanceOf(address account) view returns (uint256)"];
+const tokenState = async (token, user, spender, provider) => {
+    const contract = new ethers_1.ethers.Contract(token, _tokens_1.ERC20_ABI, provider);
+    const [symbol, decimals, balance, allowance] = await Promise.all([
+        contract.symbol(),
+        contract.decimals(),
+        contract.balanceOf(user),
+        contract.allowance(user, spender),
+    ]);
+    return { address: ethers_1.ethers.getAddress(token), symbol, decimals: Number(decimals), balance, allowance, spender: ethers_1.ethers.getAddress(spender) };
+};
+/**
+ * What a wallet needs to stake in, wrap for, or unstake from a gauge: its stake, its balance of the staking token and its
+ * allowance to the gauge, and for a wrapped gauge its balance of the underlying and allowance to the wrapper.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param user - The wallet.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+const getUserGaugeState = async (chainId, gaugeAddressOrId, user, provider) => {
+    if (!provider) {
+        provider = new ethers_1.ethers.JsonRpcProvider(chains_1.default[chainId].rpcs[0]);
+    }
+    const gauge = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const { stakingToken, underlying } = await (0, _tokens_1.getGaugeTokens)(gauge, provider);
+    const [staked, staking, wrappable] = await Promise.all([
+        new ethers_1.ethers.Contract(gauge, RAW_BALANCE_OF_ABI, provider).rawBalanceOf(user),
+        tokenState(stakingToken, user, gauge, provider),
+        underlying ? tokenState(underlying, user, stakingToken, provider) : Promise.resolve(null),
+    ]);
+    return { gauge, staked, stakingToken: staking, underlying: wrappable };
+};
+exports.getUserGaugeState = getUserGaugeState;