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

package/dist/types/configs/chains/index.d.ts

@@ -105,31 +105,26 @@ declare const chains: {
                 contract: string;
             };
         };
-        governance: {
-            gaugerewardsdistributor: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gaugecontroller: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            raacgauge: {
-                id: string;
-                name: string;
-                contract: string;
+        gauges: {
+            raacgauges: {
+                id: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: {
+                    id: string;
+                    name: string;
+                    contract: string;
+                }[];
             };
-            rwagauge: {
+            rwagauges: {
                 id: string;
-                name: string;
-                contract: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: any[];
             };
         };
         proposals: any[];
@@ -351,31 +346,26 @@ export declare const configs: {
                 contract: string;
             };
         };
-        governance: {
-            gaugerewardsdistributor: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gaugecontroller: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            raacgauge: {
-                id: string;
-                name: string;
-                contract: string;
+        gauges: {
+            raacgauges: {
+                id: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: {
+                    id: string;
+                    name: string;
+                    contract: string;
+                }[];
             };
-            rwagauge: {
+            rwagauges: {
                 id: string;
-                name: string;
-                contract: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: any[];
             };
         };
         proposals: any[];

package/dist/types/configs/index.d.ts

@@ -105,31 +105,26 @@ declare function getChainsConfig(): {
                 contract: string;
             };
         };
-        governance: {
-            gaugerewardsdistributor: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gaugecontroller: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            gauge: {
-                id: string;
-                name: string;
-                contract: string;
-            };
-            raacgauge: {
-                id: string;
-                name: string;
-                contract: string;
+        gauges: {
+            raacgauges: {
+                id: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: {
+                    id: string;
+                    name: string;
+                    contract: string;
+                }[];
             };
-            rwagauge: {
+            rwagauges: {
                 id: string;
-                name: string;
-                contract: string;
+                label: string;
+                gaugeType: string;
+                controller: string;
+                distributor: string;
+                gauges: any[];
             };
         };
         proposals: any[];

package/dist/types/contracts/governance/distributor/claimAll.d.ts

@@ -1,11 +1,13 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Claims accrued rewards for multiple gauges in a single transaction.
+ * Claims rewards for the caller on several gauges. Each gauge must be active.
  *
  * @param chainId - The chain/network to use.
- * @param gauges - Array of gauge addresses.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param gaugeAddressesOrIds - Addresses or config ids of the gauges.
  * @param signer - An ethers.js Signer instance (required).
- * @returns Transaction after it has been mined.
+ * @returns The transaction after it has been mined.
  */
-export declare const claimAll: (chainId: ChainId, gauges: string[], signer: Signer) => Promise<any>;
+export declare const claimAll: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressesOrIds: string[], signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/distributor/claimForGauge.d.ts

@@ -1,12 +1,13 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Claims accrued rewards for a gauge.
- * Note: only callable by the gauge contract itself (msg.sender must == gauge).
+ * Transfers a gauge's accrued share from the distributor to the gauge.
  *
  * @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 signer - An ethers.js Signer instance (required).
- * @returns Transaction after it has been mined.
+ * @returns The transaction after it has been mined.
  */
-export declare const claimForGauge: (chainId: ChainId, gauge: string, signer: Signer) => Promise<any>;
+export declare const claimForGauge: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/distributor/deposit.d.ts

@@ -1,13 +1,14 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Deposits reward tokens into the distributor.
- * The reward token must be pre-approved by the caller before calling.
+ * Deposits reward tokens into the distributor for the current epoch. The token must be the distributor's reward token and pre-approved. Reverts when no gauge is registered.
  *
  * @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 amount - Amount of reward tokens to deposit.
+ * @param amount - Amount to deposit, base units.
  * @param signer - An ethers.js Signer instance (required).
- * @returns Transaction after it has been mined.
+ * @returns The transaction after it has been mined.
  */
-export declare const deposit: (chainId: ChainId, token: string, amount: string | number | bigint, signer: Signer) => Promise<any>;
+export declare const deposit: (chainId: ChainId, gaugeSystem: GaugeSystemRef, token: string, amount: string | number | bigint, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/distributor/getClaimableForGauge.d.ts

@@ -1,11 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Gets the amount of rewards currently claimable for a gauge.
+ * Estimates the rewards a gauge can still pull from the distributor.
  *
  * @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 Claimable reward amount (bigint).
+ * @returns The claimable amount, base units.
  */
-export declare const getClaimableForGauge: (chainId: ChainId, gauge: string, provider?: Provider) => Promise<bigint>;
+export declare const getClaimableForGauge: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/distributor/getClaimedAtEpoch.d.ts

@@ -1,12 +1,14 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Gets the amount claimed by a gauge at a specific epoch.
+ * Returns how much a gauge has already pulled for an epoch.
  *
  * @param chainId - The chain/network to use.
- * @param gauge - Address of the gauge.
- * @param epoch - The epoch to query.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeRewardsDistributor address.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
+ * @param epoch - Epoch start timestamp, seconds.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Amount claimed at the epoch (bigint).
+ * @returns The claimed amount, base units.
  */
-export declare const getClaimedAtEpoch: (chainId: ChainId, gauge: string, epoch: string | number | bigint, provider?: Provider) => Promise<bigint>;
+export declare const getClaimedAtEpoch: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, epoch: string | number | bigint, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/distributor/getDepositedAtEpoch.d.ts

@@ -1,12 +1,14 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
  */
-export declare const getDepositedAtEpoch: (chainId: ChainId, token: string, epoch: string | number | bigint, provider?: Provider) => Promise<bigint>;
+export declare const getDepositedAtEpoch: (chainId: ChainId, gaugeSystem: GaugeSystemRef, token: string, epoch: string | number | bigint, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/distributor/getDustLastProcessedEpoch.d.ts

@@ -0,0 +1,12 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
+ */
+export declare const getDustLastProcessedEpoch: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/distributor/getGaugeController.d.ts

@@ -1,10 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
  */
-export declare const getGaugeController: (chainId: ChainId, provider?: Provider) => Promise<string>;
+export declare const getGaugeController: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<string>;

package/dist/types/contracts/governance/distributor/getLastClaimedEpoch.d.ts

@@ -1,11 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
  */
-export declare const getLastClaimedEpoch: (chainId: ChainId, gauge: string, provider?: Provider) => Promise<bigint>;
+export declare const getLastClaimedEpoch: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/distributor/getMaxClaimBound.d.ts

@@ -0,0 +1,15 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
+ */
+export declare const getMaxClaimBound: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<{
+    enabled: boolean;
+    maxEpochs: bigint;
+}>;

package/dist/types/contracts/governance/distributor/getPeriodDuration.d.ts

@@ -1,10 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
  */
-export declare const getPeriodDuration: (chainId: ChainId, provider?: Provider) => Promise<bigint>;
+export declare const getPeriodDuration: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/distributor/getRewardToken.d.ts

@@ -1,10 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
  */
-export declare const getRewardToken: (chainId: ChainId, provider?: Provider) => Promise<string>;
+export declare const getRewardToken: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<string>;

package/dist/types/contracts/governance/distributor/getRewardTokenInfo.d.ts

@@ -1,13 +1,15 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
  */
-export declare const getRewardTokenInfo: (chainId: ChainId, provider?: Provider) => Promise<{
+export declare const getRewardTokenInfo: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<{
     totalDeposited: bigint;
     totalDistributed: bigint;
     totalClaimable: bigint;

package/dist/types/contracts/governance/distributor/getRewardTokenStats.d.ts

@@ -1,14 +1,16 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../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.
  */
-export declare const getRewardTokenStats: (chainId: ChainId, token: string, provider?: Provider) => Promise<{
+export declare const getRewardTokenStats: (chainId: ChainId, gaugeSystem: GaugeSystemRef, token: string, provider?: Provider) => Promise<{
     totalDeposited: bigint;
     totalDistributed: bigint;
     totalClaimable: bigint;

package/dist/types/contracts/governance/distributor/index.d.ts

@@ -4,13 +4,16 @@ export * from "./deposit";
 export * from "./getClaimableForGauge";
 export * from "./getClaimedAtEpoch";
 export * from "./getDepositedAtEpoch";
+export * from "./getDustLastProcessedEpoch";
 export * from "./getGaugeController";
 export * from "./getLastClaimedEpoch";
+export * from "./getMaxClaimBound";
 export * from "./getPeriodDuration";
 export * from "./getRewardToken";
 export * from "./getRewardTokenInfo";
 export * from "./getRewardTokenStats";
-export * from "./getStartEpoch";
 export * from "./setController";
+export * from "./setLastClaimedEpoch";
+export * from "./setMaxClaimBound";
+export * from "./withdrawDust";
 export * from "./withdrawRemovedGaugeRewards";
-export * from "./withdrawUnallocatedRewards";

package/dist/types/contracts/governance/distributor/setController.d.ts

@@ -1,12 +1,13 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_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.
  */
-export declare const setController: (chainId: ChainId, controller: string, signer: Signer) => Promise<any>;
+export declare const setController: (chainId: ChainId, gaugeSystem: GaugeSystemRef, controller: string, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/distributor/setLastClaimedEpoch.d.ts

@@ -0,0 +1,13 @@
+import { ethers, Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_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.
+ */
+export declare const setLastClaimedEpoch: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/distributor/setMaxClaimBound.d.ts

@@ -0,0 +1,13 @@
+import { ethers, Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_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.
+ */
+export declare const setMaxClaimBound: (chainId: ChainId, gaugeSystem: GaugeSystemRef, enabled: boolean, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/distributor/withdrawDust.d.ts

@@ -0,0 +1,13 @@
+import { ethers, Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_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.
+ */
+export declare const withdrawDust: (chainId: ChainId, gaugeSystem: GaugeSystemRef, recipient: string, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/distributor/withdrawRemovedGaugeRewards.d.ts

@@ -1,13 +1,14 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_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.
  */
-export declare const withdrawRemovedGaugeRewards: (chainId: ChainId, gauge: string, recipient: string, signer: Signer) => Promise<any>;
+export declare const withdrawRemovedGaugeRewards: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, recipient: string, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/gauge/_apy.d.ts

@@ -0,0 +1,61 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { BaseGauge, GaugeController } from "../../../typechain-types";
+export declare const SECONDS_PER_YEAR: bigint;
+/** Where the main reward token's yearly emission is read from. */
+export type GaugeRewardSource = "stream" | "epoch";
+export interface GaugeApyPrices {
+    /** USD price of one staking token. */
+    stakingTokenPriceUSD: number;
+    /** USD price of one reward token, keyed by token address in any case. Reward tokens without a price are reported but left out of every APY. */
+    rewardTokenPricesUSD: Record<string, number>;
+}
+export interface GaugeApyOptions {
+    /** "epoch" (default) annualizes the gauge's share of the last completed distributor epoch: what the gauge is entitled to per week, lagging one epoch. "stream" annualizes the rate the gauge is paying right now, which spikes when a pull lands late in a period or after a pause, and reads 0 once the period has ended without a new pull. Extra reward tokens always use their stream. */
+    rewardSource?: GaugeRewardSource;
+}
+export interface RewardTokenApy {
+    token: string;
+    /** "main" rewards are shared by working balance (boosted); "extra" rewards by raw balance (unboosted). */
+    kind: "main" | "extra";
+    /** Reward tokens paid per year at the current rate, formatted. */
+    yearlyRewards: string;
+    priceUSD: number | null;
+    yearlyRewardsUSD: number | null;
+    /** False when the stream has ended (period over) or, for "epoch", the last epoch paid nothing. */
+    active: boolean;
+}
+/** On-chain state shared by the gauge and user APY calculations. */
+export interface GaugeApyState {
+    gauge: string;
+    gaugeContract: BaseGauge;
+    controller: GaugeController;
+    stakingToken: string;
+    stakingDecimals: number;
+    totalSupply: bigint;
+    workingSupply: bigint;
+    minBoost: bigint;
+    maxBoost: bigint;
+    rewardSource: GaugeRewardSource;
+    rewards: RewardTokenApy[];
+    /** Sum of priced main-token rewards per year, USD. */
+    mainYearlyUSD: number;
+    /** Sum of priced extra-token rewards per year, USD. */
+    extraYearlyUSD: number;
+}
+/** Annualized percentage: yearly USD over staked USD, or null when nothing is staked or the staking token has no price. */
+export declare const toApyPct: (yearlyUSD: number, stakedUnits: number, stakingTokenPriceUSD: number) => number | null;
+/**
+ * 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.
+ */
+export declare const loadGaugeApyState: (chainId: ChainId, gaugeAddressOrId: string, prices: GaugeApyPrices, options?: GaugeApyOptions, provider?: Provider) => Promise<GaugeApyState & {
+    provider: Provider;
+    now: bigint;
+}>;

package/dist/types/contracts/governance/gauge/_tokens.d.ts

@@ -0,0 +1,14 @@
+import { Provider, Signer } from "ethers";
+export declare const ERC20_ABI: string[];
+export declare const ERC4626_ABI: string[];
+export interface GaugeTokens {
+    /** The token the gauge takes. For a wrapped gauge this is the ERC4626 wrapper, which is also the contract that wraps. */
+    stakingToken: string;
+    /** The token the wrapper wraps; null when the gauge takes its token directly. */
+    underlying: string | null;
+}
+/**
+ * Reads a gauge's staking token from the gauge and whether it wraps another token. A staking token counts as a wrapper
+ * when it exposes a non-zero `asset()` and a working `totalAssets()`, the same test the subgraph uses for its `wrapped` flag.
+ */
+export declare const getGaugeTokens: (gaugeAddress: string, runner: Provider | Signer) => Promise<GaugeTokens>;

package/dist/types/contracts/governance/gauge/approveGaugeToken.d.ts

@@ -0,0 +1,14 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Approves the contract that pulls a gauge token: the staking token to the gauge, or for a wrapped gauge the underlying
+ * to the wrapper.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - "staking" to stake, "underlying" to wrap.
+ * @param amount - Allowance to set, base units.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The mined transaction.
+ */
+export declare const approveGaugeToken: (chainId: ChainId, gaugeAddressOrId: string, token: "staking" | "underlying", amount: bigint, signer: Signer) => Promise<any>;

package/dist/types/contracts/governance/gauge/claimRewardToken.d.ts

@@ -1,7 +1,7 @@
 import { Signer } from "ethers";
 import configs from "../../../configs/chains";
 /**
- * Claims a specific reward token from a gauge.
+ * Claims the caller's main reward token from a gauge, pulling the gauge's share from its distributor first. Reverts while the gauge or its controller is paused.
  *
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or ID of the gauge.