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

package/dist/contracts/governance/distributor/getDepositedAtEpoch.js

@@ -6,25 +6,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDepositedAtEpoch = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Gets the amount of a token deposited at a specific epoch.
+ * Returns the rewards deposited into the distributor for an epoch.
  *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
  * @param token - Address of the reward token.
- * @param epoch - The epoch to query.
+ * @param epoch - Epoch start timestamp, seconds.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Amount deposited at the epoch (bigint).
+ * @returns The deposited amount, base units.
  */
-const getDepositedAtEpoch = async (chainId, token, epoch, provider) => {
+const getDepositedAtEpoch = async (chainId, gaugeSystem, token, epoch, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
     return contract.depositedAtEpoch(token, epoch);
 };
 exports.getDepositedAtEpoch = getDepositedAtEpoch;

package/dist/contracts/governance/distributor/getDustLastProcessedEpoch.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.getDustLastProcessedEpoch = 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");
+/**
+ * Returns the cursor of the last epoch swept by `withdrawDust`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The epoch timestamp, seconds.
+ */
+const getDustLastProcessedEpoch = async (chainId, gaugeSystem, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
+    return contract.dustLastProcessedEpoch();
+};
+exports.getDustLastProcessedEpoch = getDustLastProcessedEpoch;

package/dist/contracts/governance/distributor/getGaugeController.js

@@ -6,23 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGaugeController = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Gets the gauge controller address used by the distributor.
+ * Returns the GaugeController the distributor reads weights from.
  *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Gauge controller address (string).
+ * @returns The controller address.
  */
-const getGaugeController = async (chainId, provider) => {
+const getGaugeController = async (chainId, gaugeSystem, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
     return contract.gaugeController();
 };
 exports.getGaugeController = getGaugeController;

package/dist/contracts/governance/distributor/getLastClaimedEpoch.js

@@ -6,24 +6,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getLastClaimedEpoch = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Gets the last epoch claimed for a gauge.
+ * Returns the epoch a gauge's next claim starts walking from.
  *
  * @param chainId - The chain/network to use.
- * @param gauge - Address of the gauge.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Last claimed epoch (bigint).
+ * @returns The epoch timestamp, seconds.
  */
-const getLastClaimedEpoch = async (chainId, gauge, provider) => {
+const getLastClaimedEpoch = async (chainId, gaugeSystem, gaugeAddressOrId, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
-    return contract.lastClaimedEpoch(gauge);
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
+    return contract.lastClaimedEpoch(gaugeAddress);
 };
 exports.getLastClaimedEpoch = getLastClaimedEpoch;

package/dist/contracts/governance/distributor/getMaxClaimBound.js

@@ -0,0 +1,29 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getMaxClaimBound = 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 whether claim walks are capped and the cap in epochs.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns enabled flag and maxEpochs.
+ */
+const getMaxClaimBound = async (chainId, gaugeSystem, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
+    const [enabled, maxEpochs] = await Promise.all([contract.enableMaxClaimBound(), contract.MAX_EPOCHS()]);
+    return { enabled, maxEpochs };
+};
+exports.getMaxClaimBound = getMaxClaimBound;

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

@@ -6,23 +6,23 @@ 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 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Gets the distributor's period (epoch) duration in seconds.
+ * Returns the distributor's period duration.
  *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Period duration in seconds (bigint).
+ * @returns The period duration, seconds.
  */
-const getPeriodDuration = async (chainId, provider) => {
+const getPeriodDuration = async (chainId, gaugeSystem, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
     return contract.PERIOD_DURATION();
 };
 exports.getPeriodDuration = getPeriodDuration;

package/dist/contracts/governance/distributor/getRewardToken.js

@@ -6,23 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRewardToken = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Gets the reward token address used by the distributor.
+ * Returns the single reward token the distributor pays out.
  *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Reward token address (string).
+ * @returns The reward token address.
  */
-const getRewardToken = async (chainId, provider) => {
+const getRewardToken = async (chainId, gaugeSystem, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
     return contract.rewardToken();
 };
 exports.getRewardToken = getRewardToken;

package/dist/contracts/governance/distributor/getRewardTokenInfo.js

@@ -6,23 +6,23 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRewardTokenInfo = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Gets aggregate statistics for the distributor's reward token.
+ * Reads the reward token totals and the distributor's current token balance.
  *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Object with totalDeposited, totalDistributed, totalClaimable and balance (all bigint).
+ * @returns totalDeposited, totalDistributed, totalClaimable and balance, base units.
  */
-const getRewardTokenInfo = async (chainId, provider) => {
+const getRewardTokenInfo = async (chainId, gaugeSystem, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
     const [totalDeposited, totalDistributed, totalClaimable, balance] = await contract.getRewardTokenInfo();
     return { totalDeposited, totalDistributed, totalClaimable, balance };
 };

package/dist/contracts/governance/distributor/getRewardTokenStats.js

@@ -6,24 +6,24 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getRewardTokenStats = void 0;
 const ethers_1 = require("ethers");
 const chains_1 = __importDefault(require("../../../configs/chains"));
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
 /**
- * Reads the rewardTokenInfo mapping entry for a given token.
+ * Reads the `rewardTokenInfo` mapping entry for a token.
  *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
  * @param token - Address of the reward token.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Object with totalDeposited, totalDistributed and totalClaimable (all bigint).
+ * @returns totalDeposited, totalDistributed and totalClaimable, base units.
  */
-const getRewardTokenStats = async (chainId, token, provider) => {
+const getRewardTokenStats = async (chainId, gaugeSystem, token, provider) => {
     if (!provider) {
         const rpc = chains_1.default[chainId].rpcs[0];
         provider = new ethers_1.ethers.JsonRpcProvider(rpc);
     }
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, provider);
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
     const [totalDeposited, totalDistributed, totalClaimable] = await contract.rewardTokenInfo(token);
     return { totalDeposited, totalDistributed, totalClaimable };
 };

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

@@ -21,13 +21,16 @@ __exportStar(require("./deposit"), exports);
 __exportStar(require("./getClaimableForGauge"), exports);
 __exportStar(require("./getClaimedAtEpoch"), exports);
 __exportStar(require("./getDepositedAtEpoch"), exports);
+__exportStar(require("./getDustLastProcessedEpoch"), exports);
 __exportStar(require("./getGaugeController"), exports);
 __exportStar(require("./getLastClaimedEpoch"), exports);
+__exportStar(require("./getMaxClaimBound"), exports);
 __exportStar(require("./getPeriodDuration"), exports);
 __exportStar(require("./getRewardToken"), exports);
 __exportStar(require("./getRewardTokenInfo"), exports);
 __exportStar(require("./getRewardTokenStats"), exports);
-__exportStar(require("./getStartEpoch"), exports);
 __exportStar(require("./setController"), exports);
+__exportStar(require("./setLastClaimedEpoch"), exports);
+__exportStar(require("./setMaxClaimBound"), exports);
+__exportStar(require("./withdrawDust"), exports);
 __exportStar(require("./withdrawRemovedGaugeRewards"), exports);
-__exportStar(require("./withdrawUnallocatedRewards"), exports);

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

@@ -2,25 +2,30 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.setController = void 0;
 const ethers_1 = require("ethers");
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+const _helpers_2 = require("../_helpers");
 /**
- * Sets the gauge controller for the distributor.
- * Requires DEFAULT_ADMIN_ROLE.
+ * Points the distributor at a different GaugeController. Requires DEFAULT_ADMIN_ROLE.
  *
  * @param chainId - The chain/network to use.
- * @param controller - Address of the new gauge controller.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param controller - Address of the new controller.
  * @param signer - An ethers.js Signer instance (required).
- * @returns Transaction after it has been mined.
+ * @returns The transaction after it has been mined.
  */
-const setController = async (chainId, controller, signer) => {
+const setController = async (chainId, gaugeSystem, controller, signer) => {
     if (!signer)
         throw new Error("Signer is required");
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, signer);
-    const tx = await contract.setController(controller);
-    await tx.wait();
-    return tx;
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), signer);
+    try {
+        const tx = await contract.setController(controller);
+        await tx.wait();
+        return tx;
+    }
+    catch (error) {
+        throw (0, _helpers_2.toGovernanceTxError)("Failed to set controller", error);
+    }
 };
 exports.setController = setController;

package/dist/contracts/governance/distributor/setLastClaimedEpoch.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setLastClaimedEpoch = void 0;
+const ethers_1 = require("ethers");
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+const _helpers_2 = require("../_helpers");
+/**
+ * Bootstraps a new gauge's claim checkpoint. Requires CONTROLLER_ROLE; the controller calls it from `addGauge`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction after it has been mined.
+ */
+const setLastClaimedEpoch = async (chainId, gaugeSystem, gaugeAddressOrId, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), signer);
+    try {
+        const tx = await contract.setLastClaimedEpoch(gaugeAddress);
+        await tx.wait();
+        return tx;
+    }
+    catch (error) {
+        throw (0, _helpers_2.toGovernanceTxError)("Failed to set last claimed epoch", error);
+    }
+};
+exports.setLastClaimedEpoch = setLastClaimedEpoch;

package/dist/contracts/governance/distributor/setMaxClaimBound.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.setMaxClaimBound = void 0;
+const ethers_1 = require("ethers");
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+const _helpers_2 = require("../_helpers");
+/**
+ * Caps how many epochs a claim walks per call (MAX_EPOCHS). Requires DISTRIBUTOR_ADMIN.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param enabled - True to cap claim walks.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction after it has been mined.
+ */
+const setMaxClaimBound = async (chainId, gaugeSystem, enabled, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), signer);
+    try {
+        const tx = await contract.setMaxClaimBound(enabled);
+        await tx.wait();
+        return tx;
+    }
+    catch (error) {
+        throw (0, _helpers_2.toGovernanceTxError)("Failed to set max claim bound", error);
+    }
+};
+exports.setMaxClaimBound = setMaxClaimBound;

package/dist/contracts/governance/distributor/withdrawDust.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withdrawDust = void 0;
+const ethers_1 = require("ethers");
+const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+const _helpers_2 = require("../_helpers");
+/**
+ * Sweeps leftover rewards from fully settled epochs to a recipient. Requires DEFAULT_ADMIN_ROLE. Reverts when there is nothing new to sweep.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param recipient - Address that receives the dust.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The transaction after it has been mined.
+ */
+const withdrawDust = async (chainId, gaugeSystem, recipient, signer) => {
+    if (!signer)
+        throw new Error("Signer is required");
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), signer);
+    try {
+        const tx = await contract.withdrawDust(recipient);
+        await tx.wait();
+        return tx;
+    }
+    catch (error) {
+        throw (0, _helpers_2.toGovernanceTxError)("Failed to withdraw dust", error);
+    }
+};
+exports.withdrawDust = withdrawDust;

package/dist/contracts/governance/distributor/withdrawRemovedGaugeRewards.js

@@ -2,26 +2,32 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.withdrawRemovedGaugeRewards = void 0;
 const ethers_1 = require("ethers");
-const getContractAddress_1 = require("../../getContractAddress");
 const artifacts_1 = require("../../../utils/artifacts");
+const _helpers_1 = require("../gaugeSystems/_helpers");
+const _helpers_2 = require("../_helpers");
 /**
- * Withdraws rewards belonging to a removed gauge to a recipient.
- * Requires DEFAULT_ADMIN_ROLE.
+ * Redirects a removed gauge's unclaimed entitlement to a recipient. Requires CONTROLLER_ROLE: the controller calls it from `removeGauge`, so admins normally use `governance.controller.removeGauge`.
  *
  * @param chainId - The chain/network to use.
- * @param gauge - Address of the removed gauge.
- * @param recipient - Address to receive the withdrawn rewards.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
+ * @param recipient - Address that receives the redirected rewards.
  * @param signer - An ethers.js Signer instance (required).
- * @returns Transaction after it has been mined.
+ * @returns The transaction after it has been mined.
  */
-const withdrawRemovedGaugeRewards = async (chainId, gauge, recipient, signer) => {
+const withdrawRemovedGaugeRewards = async (chainId, gaugeSystem, gaugeAddressOrId, recipient, signer) => {
     if (!signer)
         throw new Error("Signer is required");
-    const address = (0, getContractAddress_1.getContractAddress)(chainId, "gaugerewardsdistributor");
-    const abi = (0, artifacts_1.getABI)("gaugerewardsdistributor");
-    const contract = new ethers_1.ethers.Contract(address, abi, signer);
-    const tx = await contract.withdrawRemovedGaugeRewards(gauge, recipient);
-    await tx.wait();
-    return tx;
+    const address = (0, _helpers_1.resolveGaugeDistributor)(chainId, gaugeSystem);
+    const gaugeAddress = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const contract = new ethers_1.ethers.Contract(address, (0, artifacts_1.getABI)("gaugerewardsdistributor"), signer);
+    try {
+        const tx = await contract.withdrawRemovedGaugeRewards(gaugeAddress, recipient);
+        await tx.wait();
+        return tx;
+    }
+    catch (error) {
+        throw (0, _helpers_2.toGovernanceTxError)("Failed to withdraw removed gauge rewards", error);
+    }
 };
 exports.withdrawRemovedGaugeRewards = withdrawRemovedGaugeRewards;

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

@@ -0,0 +1,122 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadGaugeApyState = exports.toApyPct = exports.SECONDS_PER_YEAR = 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");
+exports.SECONDS_PER_YEAR = 365n * 24n * 60n * 60n;
+const E18 = 10n ** 18n;
+const E36 = 10n ** 36n;
+const ERC20_DECIMALS_ABI = ["function decimals() view returns (uint8)"];
+const priceOf = (prices, token) => {
+    const target = token.toLowerCase();
+    const entry = Object.entries(prices.rewardTokenPricesUSD ?? {}).find(([key]) => key.toLowerCase() === target);
+    return entry && Number.isFinite(entry[1]) ? entry[1] : null;
+};
+const toReward = (token, kind, yearly, decimals, active, prices) => {
+    const priceUSD = priceOf(prices, token);
+    const yearlyRewards = ethers_1.ethers.formatUnits(yearly, decimals);
+    return {
+        token,
+        kind,
+        yearlyRewards,
+        priceUSD,
+        yearlyRewardsUSD: priceUSD === null ? null : Number(yearlyRewards) * priceUSD,
+        active,
+    };
+};
+/** Annualized percentage: yearly USD over staked USD, or null when nothing is staked or the staking token has no price. */
+const toApyPct = (yearlyUSD, stakedUnits, stakingTokenPriceUSD) => {
+    const stakedUSD = stakedUnits * stakingTokenPriceUSD;
+    return stakedUSD > 0 ? (yearlyUSD / stakedUSD) * 100 : null;
+};
+exports.toApyPct = toApyPct;
+/**
+ * Loads the gauge state an APY calculation needs: supplies, boost bounds and each reward token's yearly emission.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param prices - USD prices for the staking token and reward tokens.
+ * @param options - Reward source selection.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The loaded state.
+ */
+const loadGaugeApyState = async (chainId, gaugeAddressOrId, prices, options = {}, provider) => {
+    if (!provider) {
+        const rpc = chains_1.default[chainId].rpcs[0];
+        provider = new ethers_1.ethers.JsonRpcProvider(rpc);
+    }
+    if (!prices || !Number.isFinite(prices.stakingTokenPriceUSD)) {
+        throw new Error("prices.stakingTokenPriceUSD is required");
+    }
+    const rewardSource = options.rewardSource ?? "epoch";
+    const gauge = (0, _helpers_1.resolveGauge)(chainId, gaugeAddressOrId);
+    const gaugeContract = new ethers_1.ethers.Contract(gauge, (0, artifacts_1.getABI)("basegauge"), provider);
+    const [data, controllerAddress, extraTokens, [, periodEnd], block] = await Promise.all([
+        gaugeContract.gaugeData(),
+        gaugeContract.gaugeController(),
+        gaugeContract.getExtraRewardTokens(),
+        gaugeContract.getPeriodBoundaries(),
+        provider.getBlock("latest"),
+    ]);
+    if (!block)
+        throw new Error("Failed to read the latest block");
+    const now = BigInt(block.timestamp);
+    const controller = new ethers_1.ethers.Contract(controllerAddress, (0, artifacts_1.getABI)("gaugecontroller"), provider);
+    const stakingTokenContract = new ethers_1.ethers.Contract(data.stakingToken, ERC20_DECIMALS_ABI, provider);
+    const [minBoost, maxBoost, stakingDecimals, mainData] = await Promise.all([
+        controller.MIN_BOOST(),
+        controller.MAX_BOOST(),
+        stakingTokenContract.decimals().then((d) => Number(d)),
+        gaugeContract.getGaugeRewardTokenData(data.rewardToken),
+    ]);
+    const rewards = [];
+    if (rewardSource === "epoch") {
+        const distributor = new ethers_1.ethers.Contract(data.rewardDistributor, (0, artifacts_1.getABI)("gaugerewardsdistributor"), provider);
+        const [week, currentEpoch] = await Promise.all([controller.WEEK(), controller.getCurrentEpoch()]);
+        const lastEpoch = currentEpoch - week;
+        const [deposited, [relativeWeight]] = await Promise.all([
+            distributor.depositedAtEpoch(data.rewardToken, lastEpoch),
+            controller.getGaugeRelativeWeightView(gauge, lastEpoch),
+        ]);
+        const perEpoch = (deposited * relativeWeight) / E18;
+        rewards.push(toReward(data.rewardToken, "main", (perEpoch * exports.SECONDS_PER_YEAR) / week, Number(mainData.decimals), perEpoch > 0n, prices));
+    }
+    else {
+        // rate is 18-decimal-normalized tokens per second scaled by 1e36 (ray-divided wad) and only streams until the period ends.
+        const active = now < periodEnd && mainData.rate > 0n;
+        const yearly = active ? (mainData.rate * exports.SECONDS_PER_YEAR) / E36 : 0n;
+        rewards.push(toReward(data.rewardToken, "main", yearly, 18, active, prices));
+    }
+    const extras = await Promise.all([...extraTokens].map(async (token) => {
+        const extra = await gaugeContract.extraRewardTokenData(token);
+        // Extra rate is 18-decimal-normalized tokens per second scaled by 1e18.
+        const active = extra.isActive && now < extra.periodFinish && extra.rate > 0n;
+        const yearly = active ? (extra.rate * exports.SECONDS_PER_YEAR) / E18 : 0n;
+        return toReward(token, "extra", yearly, 18, active, prices);
+    }));
+    rewards.push(...extras);
+    const sumUSD = (kind) => rewards.filter((r) => r.kind === kind).reduce((sum, r) => sum + (r.yearlyRewardsUSD ?? 0), 0);
+    return {
+        provider,
+        now,
+        gauge,
+        gaugeContract,
+        controller,
+        stakingToken: data.stakingToken,
+        stakingDecimals,
+        totalSupply: data.totalSupply,
+        workingSupply: data.workingSupply,
+        minBoost,
+        maxBoost,
+        rewardSource,
+        rewards,
+        mainYearlyUSD: sumUSD("main"),
+        extraYearlyUSD: sumUSD("extra"),
+    };
+};
+exports.loadGaugeApyState = loadGaugeApyState;