@raac/rpc 1.2.0-beta.9 → 2.0.0-beta.0

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,9 @@ 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 amount_1 = require("../../../utils/amount");
+const _tokens_1 = require("./_tokens");
 const TOTAL_SUPPLY_ABI = "function totalSupply() view returns (uint256)";
 /**
  * Gets the working supply of the gauge (includes boost).
@@ -14,29 +16,19 @@ const TOTAL_SUPPLY_ABI = "function totalSupply() view returns (uint256)";
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or ID of the gauge.
  * @param provider - Optional ethers.js Provider instance.
- * @returns The working supply formatted in ether units.
+ * @returns The working supply in staking token base units, with the staking token's registry decimals and symbol.
  */
 const getTotalSupply = async (chainId, gaugeAddressOrId, provider) => {
     if (!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);
+    const [totalSupply, stakingToken] = await Promise.all([
+        contract.totalSupply(),
+        (0, _tokens_1.getStakingToken)(chainId, gaugeAddress, provider),
+    ]);
+    return (0, amount_1.toTokenAmount)(chainId, stakingToken, totalSupply);
 };
 exports.getTotalSupply = getTotalSupply;

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

@@ -0,0 +1,73 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getUserApy = void 0;
+const ethers_1 = require("ethers");
+const amount_1 = require("../../../utils/amount");
+const _apy_1 = require("./_apy");
+const toPosition = (balance, working, workingSupply, totalSupply, decimals, symbol, 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: (0, amount_1.toAmount)(balance, decimals, symbol),
+        workingBalance: (0, amount_1.toAmount)(working, decimals, symbol),
+        boost: balance > 0n ? (working * maxBoost) / balance : 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 one whole staking token and of one whole reward token (see `getRewardTokens`), as plain numbers.
+ * @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 (staking token amounts, boost in basis points) and APY (percent floats), 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 = options.additionalStake ?? 0n;
+    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 s = state.stakingSymbol;
+    const current = toPosition(balance, working, state.workingSupply, state.totalSupply, d, s, state.maxBoost, state.mainYearlyUSD, state.extraYearlyUSD, price);
+    const projected = toPosition(projectedBalance, projectedWorking, state.workingSupply - working + projectedWorking, state.totalSupply + additionalStake, d, s, 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,84 +6,57 @@ 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 amount_1 = require("../../../utils/amount");
 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.
  * @param accountAddress - Address of the user.
  * @param provider - Optional ethers.js Provider instance.
+ * @returns The claimable main reward and extra rewards, each in its own token's base units with its registry decimals and symbol.
  */
 const getUserClaimableRewards = async (chainId, gaugeAddressOrId, 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 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 [pending, extraTokens] = await Promise.all([
+        gauge.pendingRewards(rewardToken, accountAddress).then((v) => BigInt(v)),
         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 inGauge = (0, amount_1.toTokenAmount)(chainId, rewardToken, pending);
     const extras = [];
     for (const token of extraTokens) {
         try {
             const amount = BigInt(await gauge.pendingExtraRewards(token, accountAddress));
             if (amount <= 0n)
                 continue;
-            const erc20 = new ethers_1.ethers.Contract(token, ERC20_META_ABI, provider);
-            const [symbol, decimals] = await Promise.all([
-                erc20.symbol().catch(() => "?"),
-                erc20.decimals().then((d) => Number(d)).catch(() => 18),
-            ]);
+            const tokenAmount = (0, amount_1.toTokenAmount)(chainId, token, amount);
             extras.push({
                 token,
-                symbol,
-                decimals,
-                amount,
-                formatted: ethers_1.ethers.formatUnits(amount, decimals),
+                symbol: tokenAmount.symbol,
+                decimals: tokenAmount.decimals,
+                amount: tokenAmount,
             });
         }
         catch {
@@ -125,10 +65,10 @@ const getUserClaimableRewards = async (chainId, gaugeAddressOrId, accountAddress
     }
     return {
         gauge: gaugeAddress,
+        rewardToken,
+        distributor: distributorAddr,
         inGauge,
-        inDistributor,
-        raac,
-        raacFormatted: ethers_1.ethers.formatEther(raac),
+        raac: inGauge,
         extras,
     };
 };

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

@@ -0,0 +1,52 @@
+"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 amount_1 = require("../../../utils/amount");
+const _tokens_1 = require("./_tokens");
+const RAW_BALANCE_OF_ABI = ["function rawBalanceOf(address account) view returns (uint256)"];
+const tokenState = async (chainId, token, user, spender, provider) => {
+    const contract = new ethers_1.ethers.Contract(token, _tokens_1.ERC20_ABI, provider);
+    const [balance, allowance] = await Promise.all([
+        contract.balanceOf(user),
+        contract.allowance(user, spender),
+    ]);
+    const balanceAmount = (0, amount_1.toTokenAmount)(chainId, token, balance);
+    return {
+        address: ethers_1.ethers.getAddress(token),
+        symbol: balanceAmount.symbol,
+        decimals: balanceAmount.decimals,
+        balance: balanceAmount,
+        allowance: (0, amount_1.toTokenAmount)(chainId, token, 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.
+ * @returns The wallet's gauge state. Every amount carries its own token's registry decimals and symbol.
+ */
+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(chainId, stakingToken, user, gauge, provider),
+        underlying ? tokenState(chainId, underlying, user, stakingToken, provider) : Promise.resolve(null),
+    ]);
+    return { gauge, staked: (0, amount_1.toTokenAmount)(chainId, stakingToken, staked), stakingToken: staking, underlying: wrappable };
+};
+exports.getUserGaugeState = getUserGaugeState;

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

@@ -7,31 +7,32 @@ exports.getUserRewardTokenData = 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");
+const amount_1 = require("../../../utils/amount");
 /**
- * Gets a user's reward accounting data for a specific token.
+ * Gets a user's reward accounting data for the gauge's main reward token.
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
  * @param token - Address of the reward token.
  * @param user - Address of the user.
  * @param provider - Optional ethers.js Provider instance.
+ * @returns The user's reward data; see `UserRewardTokenData` for the unit of each field.
  */
 const getUserRewardTokenData = async (chainId, gaugeAddressOrId, token, user, 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 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 [integral, lastGaugeIntegral, claimable, claimed, lastUpdate] = await contract.getUserRewardTokenData(token, user);
-    return { integral, lastGaugeIntegral, claimable, claimed, lastUpdate };
+    return {
+        integral: (0, amount_1.toAmount)(integral, amount_1.WAD_DECIMALS),
+        lastGaugeIntegral,
+        claimable: (0, amount_1.toAmount)(claimable, amount_1.WAD_DECIMALS),
+        claimed: (0, amount_1.toTokenAmount)(chainId, token, claimed),
+        lastUpdate,
+    };
 };
 exports.getUserRewardTokenData = getUserRewardTokenData;

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

@@ -7,29 +7,29 @@ exports.getUserWeight = 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");
+const amount_1 = require("../../../utils/amount");
+const _tokens_1 = require("./_tokens");
 /**
- * Gets the gauge vote weight for a given account.
+ * Gets the working balance an account would have if checkpointed now: its staked balance with its current veRAAC boost applied, capped at the staked balance.
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
  * @param account - Address of the user.
  * @param provider - Optional ethers.js Provider instance.
+ * @returns The boosted working balance in staking token base units, with the staking token's registry decimals and symbol.
  */
 const getUserWeight = async (chainId, gaugeAddressOrId, account, 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 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.getUserWeight(account);
+    const [weight, stakingToken] = await Promise.all([
+        contract.getUserWeight(account),
+        (0, _tokens_1.getStakingToken)(chainId, gaugeAddress, provider),
+    ]);
+    return (0, amount_1.toTokenAmount)(chainId, stakingToken, weight);
 };
 exports.getUserWeight = getUserWeight;

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

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 // Auto-generated barrel: re-exports every method in this namespace.
 __exportStar(require("./addRewardToken"), exports);
+__exportStar(require("./approveGaugeToken"), exports);
 __exportStar(require("./claimExtraReward"), exports);
 __exportStar(require("./claimExtraRewards"), exports);
 __exportStar(require("./claimOnBehalfOf"), exports);
@@ -23,15 +24,19 @@ __exportStar(require("./claimRewardsFor"), exports);
 __exportStar(require("./claimRewardToken"), exports);
 __exportStar(require("./depositRewardToken"), exports);
 __exportStar(require("./getAllPendingExtraRewards"), exports);
+__exportStar(require("./getApy"), exports);
 __exportStar(require("./getBalanceOf"), exports);
 __exportStar(require("./getControllerAddress"), exports);
 __exportStar(require("./getDecimalAdjustment"), exports);
 __exportStar(require("./getDepositRAACOnClaim"), exports);
 __exportStar(require("./getDistributorData"), exports);
 __exportStar(require("./getDistributors"), exports);
+__exportStar(require("./getEarnedExtraReward"), exports);
 __exportStar(require("./getEarnedReward"), exports);
 __exportStar(require("./getExtraRewardTokens"), exports);
+__exportStar(require("./getGaugeData"), exports);
 __exportStar(require("./getGaugeRewardTokenData"), exports);
+__exportStar(require("./getPauseStatus"), exports);
 __exportStar(require("./getPendingExtraRewards"), exports);
 __exportStar(require("./getPendingRewards"), exports);
 __exportStar(require("./getPeriodBoundaries"), exports);
@@ -39,18 +44,23 @@ __exportStar(require("./getPeriodDuration"), exports);
 __exportStar(require("./getRaacAutolockMin"), exports);
 __exportStar(require("./getRawBalanceOf"), exports);
 __exportStar(require("./getRawTotalSupply"), exports);
+__exportStar(require("./getRewardTokens"), exports);
 __exportStar(require("./getTotalSupply"), exports);
+__exportStar(require("./getUserApy"), exports);
 __exportStar(require("./getUserClaimableRewards"), exports);
+__exportStar(require("./getUserGaugeState"), exports);
 __exportStar(require("./getUserRewardTokenData"), exports);
 __exportStar(require("./getUserWeight"), exports);
 __exportStar(require("./isPaused"), exports);
 __exportStar(require("./manageDistributor"), exports);
+__exportStar(require("./pullRewardsFromDistributor"), exports);
 __exportStar(require("./setController"), exports);
 __exportStar(require("./setDepositRAACOnClaim"), exports);
-__exportStar(require("./setDistributorApproval"), exports);
 __exportStar(require("./setEmergencyPaused"), exports);
 __exportStar(require("./setGaugeRewardDistributor"), exports);
 __exportStar(require("./setRaacAutolockMin"), exports);
 __exportStar(require("./stake"), exports);
+__exportStar(require("./unwrapStakingToken"), exports);
 __exportStar(require("./updateUserRewards"), exports);
 __exportStar(require("./withdraw"), exports);
+__exportStar(require("./wrapStakingToken"), exports);

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

@@ -7,9 +7,9 @@ exports.isPaused = 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");
 /**
- * Returns whether the gauge is currently paused.
+ * Returns the gauge's own emergency pause switch. Does not reflect the controller's global pause; use `getPauseStatus` for both.
  * @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.
@@ -19,16 +19,9 @@ const isPaused = 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.paused();
+    return contract.isPaused();
 };
 exports.isPaused = isPaused;

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

@@ -1,12 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.manageDistributor = void 0;
 const ethers_1 = require("ethers");
 const artifacts_1 = require("../../../utils/artifacts");
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
  * Adds or removes a distributor on the gauge (requires GAUGE_ADMIN).
  * @param chainId - The chain/network to use.
@@ -18,14 +15,7 @@ const getContractAddress_1 = __importDefault(require("../../getContractAddress")
 const manageDistributor = async (chainId, gaugeAddressOrId, distributor, shouldAdd, signer) => {
     if (!signer)
         throw new Error("Signer is required");
-    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, signer);
     const tx = await contract.manageDistributor(distributor, shouldAdd);

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pullRewardsFromDistributor = void 0;
+const ethers_1 = require("ethers");
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+const _helpers_2 = require("../_helpers");
+/**
+ * Pulls a gauge's accrued share from its rewards distributor into the gauge's reward rate. Callable by anyone. Reverts while the gauge or its controller is paused; the share stays in the distributor and the first pull after the pause walks every missed epoch.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction after it has been mined.
+ */
+const pullRewardsFromDistributor = async (chainId, gaugeAddressOrId, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const contract = new ethers_1.ethers.Contract(gaugeAddress, (0, artifacts_1.getABI)("basegauge"), signer);
+    try {
+        const tx = await contract.pullRewardsFromDistributor();
+        await tx.wait();
+        return tx;
+    }
+    catch (error) {
+        throw (0, _helpers_2.toGovernanceTxError)("Failed to pull rewards from distributor", error);
+    }
+};
+exports.pullRewardsFromDistributor = pullRewardsFromDistributor;

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

@@ -1,12 +1,9 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setController = void 0;
 const ethers_1 = require("ethers");
 const artifacts_1 = require("../../../utils/artifacts");
-const getContractAddress_1 = __importDefault(require("../../getContractAddress"));
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
  * Sets the gauge controller address (requires GAUGE_ADMIN).
  * @param chainId - The chain/network to use.
@@ -17,14 +14,7 @@ const getContractAddress_1 = __importDefault(require("../../getContractAddress")
 const setController = async (chainId, gaugeAddressOrId, controller, signer) => {
     if (!signer)
         throw new Error("Signer is required");
-    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, signer);
     const tx = await contract.setController(controller);