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

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

@@ -0,0 +1,41 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeApyOptions, GaugeApyPrices, GaugeRewardSource, RewardTokenApy } from "./_apy";
+export type { GaugeApyOptions, GaugeApyPrices, GaugeRewardSource, RewardTokenApy } from "./_apy";
+export interface GaugeApy {
+    gauge: string;
+    stakingToken: string;
+    rewardSource: GaugeRewardSource;
+    /** Raw staked tokens, formatted. */
+    totalStaked: string;
+    /** Sum of boosted working balances, formatted. Main rewards are shared over this. */
+    workingSupply: string;
+    tvlUSD: number;
+    /** Boost multiplier bounds, e.g. 1 and 2.5. */
+    minBoost: number;
+    maxBoost: number;
+    /** Main reward APY for a staker with no veRAAC boost, percent. */
+    minApy: number | null;
+    /** Main reward APY for a staker at max boost, percent. */
+    maxApy: number | null;
+    /** Extra reward APY, percent. Unboosted, so the same for every staker. */
+    extraApy: number | null;
+    /** minApy + extraApy. */
+    totalMinApy: number | null;
+    /** maxApy + extraApy. */
+    totalMaxApy: number | null;
+    rewards: RewardTokenApy[];
+}
+/**
+ * Calculates a gauge's minimum (no boost) and maximum (full boost) APY. Figures are simple annualized rates in percent, not compounded.
+ *
+ * Main rewards are shared by working balance, where a staker counts for `balance × boost / MAX_BOOST` (capped at balance). A fully boosted staker's working balance equals their stake, so maxApy = yearly main rewards USD / (workingSupply × staking price), and minApy = maxApy × MIN_BOOST / MAX_BOOST. Extra rewards are shared by raw balance over totalSupply. The figures hold workingSupply fixed, so a large new deposit, or other stakers boosting, lowers them. The "stream" source jumps whenever a pull compresses rewards into the rest of a period, e.g. after a pause.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param prices - USD price of the staking token and of each reward token (see `getRewardTokens`).
+ * @param options - Optional reward source: "epoch" (default) or "stream".
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns Min, max and extra APY with the supplies and per-token yearly rewards behind them. An APY is null when nothing is staked.
+ */
+export declare const getApy: (chainId: ChainId, gaugeAddressOrId: string, prices: GaugeApyPrices, options?: GaugeApyOptions, provider?: Provider) => Promise<GaugeApy>;

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

@@ -0,0 +1,13 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the total amount of an extra reward token a user has already claimed from a gauge.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - Address of a registered extra reward token (see `getExtraRewardTokens`).
+ * @param userAddress - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The claimed extra reward amount (raw, base units).
+ */
+export declare const getEarnedExtraReward: (chainId: ChainId, gaugeAddressOrId: string, token: string, userAddress: string, provider?: Provider) => Promise<bigint>;

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

@@ -1,12 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
- * Gets the total amount of main-reward-token a user has already claimed from a gauge.
+ * Gets the total amount of a reward token a user has already claimed from a gauge.
  *
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - Reward token address (see `getRewardTokens`).
  * @param userAddress - Address of the user.
  * @param provider - Optional ethers.js Provider instance.
  * @returns The claimed reward amount (raw, base units).
  */
-export declare const getEarnedReward: (chainId: ChainId, gaugeAddressOrId: string, userAddress: string, provider?: Provider) => Promise<bigint>;
+export declare const getEarnedReward: (chainId: ChainId, gaugeAddressOrId: string, token: string, userAddress: string, provider?: Provider) => Promise<bigint>;

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

@@ -0,0 +1,23 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+export interface GaugeData {
+    gaugeInitialStartTime: bigint;
+    /** Reward period length, seconds: 7 days for RAAC gauges, 28 days for RWA gauges. */
+    periodDuration: bigint;
+    periodIndex: bigint;
+    stakingToken: string;
+    totalSupply: bigint;
+    workingSupply: bigint;
+    rewardDistributor: string;
+    rewardToken: string;
+    lastUpdateTime: bigint;
+}
+/**
+ * Reads a gauge's `gaugeData` struct: its staking and reward tokens, distributor, supplies and period state.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The gauge data.
+ */
+export declare const getGaugeData: (chainId: ChainId, gaugeAddressOrId: string, provider?: Provider) => Promise<GaugeData>;

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

@@ -0,0 +1,19 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+export interface GaugePauseStatus {
+    /** The gauge's own emergency pause switch. */
+    gaugePaused: boolean;
+    /** The global emergency pause of the controller the gauge reports to. */
+    controllerPaused: boolean;
+    /** True when neither pause is on, i.e. stake, claims and reward pulls are open. Withdraw is open either way. */
+    live: boolean;
+}
+/**
+ * Reads both pause switches that gate a gauge, mirroring the contract's `whenGaugeLive` check.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The gauge's and its controller's pause flags, and whether the gauge is live.
+ */
+export declare const getPauseStatus: (chainId: ChainId, gaugeAddressOrId: string, provider?: Provider) => Promise<GaugePauseStatus>;

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

@@ -1,12 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
- * Gets the pending (unclaimed) main-reward-token amount for a user on a gauge.
+ * Gets the rewards a user can claim from a gauge for one reward token. Only counts rewards already pulled into the gauge, which is everything a user can claim right now; `getUserClaimableRewards` adds the extra reward tokens.
  *
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - The gauge's main reward token (`getGaugeData().rewardToken`). Any other token reverts with NotSupportedToken; use `getPendingExtraRewards` for extra reward tokens.
  * @param accountAddress - Address of the user.
  * @param provider - Optional ethers.js Provider instance.
  * @returns The pending reward amount (raw, base units).
  */
-export declare const getPendingRewards: (chainId: ChainId, gaugeAddressOrId: string, accountAddress: string, provider?: Provider) => Promise<bigint>;
+export declare const getPendingRewards: (chainId: ChainId, gaugeAddressOrId: string, token: string, accountAddress: string, provider?: Provider) => Promise<bigint>;

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

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

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

@@ -0,0 +1,44 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeApyOptions, GaugeApyPrices } from "./_apy";
+export interface UserApyPosition {
+    /** Raw stake, formatted. */
+    balance: string;
+    /** Boosted working balance, formatted. */
+    workingBalance: string;
+    /** Effective boost multiplier, between the controller's min and max (e.g. 1 to 2.5). Null with no stake. */
+    boost: number | null;
+    /** Main reward APY, percent. */
+    mainApy: number | null;
+    /** Extra reward APY, percent. */
+    extraApy: number | null;
+    /** mainApy + extraApy, percent. */
+    apy: number | null;
+}
+export interface UserGaugeApy {
+    gauge: string;
+    user: string;
+    /** What the user earns now, from the working balance stored at their last checkpoint. */
+    current: UserApyPosition;
+    /** What the user would earn once their working balance is re-checkpointed (stake, withdraw, claim or `updateUserRewards`) with their current veRAAC, after adding `additionalStake`. */
+    projected: UserApyPosition;
+    /** The gauge's min and max main reward APY for comparison, percent. */
+    gaugeMinApy: number | null;
+    gaugeMaxApy: number | null;
+}
+/**
+ * Calculates a user's APY on a gauge: what they earn now, and what they would earn after their boost is re-checkpointed, optionally with extra stake. Figures are simple annualized rates in percent, not compounded.
+ *
+ * The user's share of main rewards is workingBalance / workingSupply; extra rewards are shared by raw balance. The stored working balance only changes when the user's position is checkpointed, so `current` can lag their veRAAC: `projected` recomputes it with the controller's `calculateBoost` and adjusts workingSupply and totalSupply for the change, holding every other staker fixed.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param user - Address of the user.
+ * @param prices - USD price of the staking token and of each reward token (see `getRewardTokens`).
+ * @param options - Optional reward source ("epoch" default, or "stream") and `additionalStake`, a staking token amount in base units to add in the projection.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The user's current and projected position and APY, with the gauge's min and max APY. An APY is null when the position has no stake.
+ */
+export declare const getUserApy: (chainId: ChainId, gaugeAddressOrId: string, user: string, prices: GaugeApyPrices, options?: GaugeApyOptions & {
+    additionalStake?: string | number | bigint;
+}, provider?: Provider) => Promise<UserGaugeApy>;

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

@@ -11,26 +11,28 @@ export interface ClaimableExtraReward {
 }
 export interface UserClaimableRewards {
     gauge: string;
-    /** RAAC already accrued to the user inside the gauge (gauge.pendingRewards). */
+    /** The gauge's main reward token. */
+    rewardToken: string;
+    /** The distributor the gauge pulls its main reward from, read from the gauge. */
+    distributor: string;
+    /** Main reward already accrued to the user inside the gauge (gauge.pendingRewards), base units. */
     inGauge: bigint;
-    /** The user's pro-rata share of RAAC still sitting in the distributor for this gauge
-     *  (deposited but not yet pulled in via a claim). */
-    inDistributor: bigint;
-    /** Total claimable RAAC = inGauge + inDistributor, base units. */
+    /** Main reward the user can claim right now, base units. Same as `inGauge`. */
     raac: bigint;
-    /** Total claimable RAAC, formatted (18 decimals). */
+    /** `raac` formatted to the reward token's decimals. */
     raacFormatted: string;
     /** Extra reward tokens claimable by the user. */
     extras: ClaimableExtraReward[];
 }
 /**
- * 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.

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

@@ -0,0 +1,31 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+export interface UserGaugeTokenState {
+    address: string;
+    symbol: string;
+    decimals: number;
+    /** Wallet balance, base units. */
+    balance: bigint;
+    /** Allowance to `spender`, base units. */
+    allowance: bigint;
+    /** The contract that pulls the token: the gauge for the staking token, the wrapper for the underlying. */
+    spender: string;
+}
+export interface UserGaugeState {
+    gauge: string;
+    /** Staking token staked in the gauge, base units, without boost. */
+    staked: bigint;
+    stakingToken: UserGaugeTokenState;
+    /** The token to wrap before staking; null when the gauge takes its token directly. */
+    underlying: UserGaugeTokenState | null;
+}
+/**
+ * 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.
+ */
+export declare const getUserGaugeState: (chainId: ChainId, gaugeAddressOrId: string, user: string, provider?: Provider) => Promise<UserGaugeState>;

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

@@ -1,4 +1,5 @@
 export * from "./addRewardToken";
+export * from "./approveGaugeToken";
 export * from "./claimExtraReward";
 export * from "./claimExtraRewards";
 export * from "./claimOnBehalfOf";
@@ -6,15 +7,19 @@ export * from "./claimRewardsFor";
 export * from "./claimRewardToken";
 export * from "./depositRewardToken";
 export * from "./getAllPendingExtraRewards";
+export * from "./getApy";
 export * from "./getBalanceOf";
 export * from "./getControllerAddress";
 export * from "./getDecimalAdjustment";
 export * from "./getDepositRAACOnClaim";
 export * from "./getDistributorData";
 export * from "./getDistributors";
+export * from "./getEarnedExtraReward";
 export * from "./getEarnedReward";
 export * from "./getExtraRewardTokens";
+export * from "./getGaugeData";
 export * from "./getGaugeRewardTokenData";
+export * from "./getPauseStatus";
 export * from "./getPendingExtraRewards";
 export * from "./getPendingRewards";
 export * from "./getPeriodBoundaries";
@@ -22,18 +27,23 @@ export * from "./getPeriodDuration";
 export * from "./getRaacAutolockMin";
 export * from "./getRawBalanceOf";
 export * from "./getRawTotalSupply";
+export * from "./getRewardTokens";
 export * from "./getTotalSupply";
+export * from "./getUserApy";
 export * from "./getUserClaimableRewards";
+export * from "./getUserGaugeState";
 export * from "./getUserRewardTokenData";
 export * from "./getUserWeight";
 export * from "./isPaused";
 export * from "./manageDistributor";
+export * from "./pullRewardsFromDistributor";
 export * from "./setController";
 export * from "./setDepositRAACOnClaim";
-export * from "./setDistributorApproval";
 export * from "./setEmergencyPaused";
 export * from "./setGaugeRewardDistributor";
 export * from "./setRaacAutolockMin";
 export * from "./stake";
+export * from "./unwrapStakingToken";
 export * from "./updateUserRewards";
 export * from "./withdraw";
+export * from "./wrapStakingToken";

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

@@ -1,7 +1,7 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
- * 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.

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

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

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

@@ -0,0 +1,12 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Unwraps a wrapped gauge's staking token back into its underlying (ERC4626 `redeem`), sending it to the signer.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param shares - Staking token to unwrap, base units.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The mined transaction.
+ */
+export declare const unwrapStakingToken: (chainId: ChainId, gaugeAddressOrId: string, shares: bigint, signer: Signer) => Promise<any>;

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

@@ -0,0 +1,13 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Wraps the underlying of a wrapped gauge into its staking token (ERC4626 `deposit`), minting the shares to the signer.
+ * The underlying must be approved to the wrapper first, see `approveGaugeToken`.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param assets - Underlying to wrap, base units.
+ * @param signer - An ethers.js Signer instance (required).
+ * @returns The mined transaction.
+ */
+export declare const wrapStakingToken: (chainId: ChainId, gaugeAddressOrId: string, assets: bigint, signer: Signer) => Promise<any>;

package/dist/types/contracts/governance/gaugeController/addGauge.d.ts

@@ -1,10 +1,13 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Adds a new gauge to the GaugeController. Requires the GAUGE_ADMIN role.
+ * Registers a gauge on the controller. Requires GAUGE_ADMIN. The gauge must belong to this system (RAACGauge on the RAAC controller, RWAGauge on the RWA controller).
+ *
  * @param chainId - The chain/network to use.
- * @param gauge - Address of the gauge to add.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
  * @param signer - An ethers.js Signer instance (required).
- * @returns The transaction response.
+ * @returns The transaction after it has been mined.
  */
-export declare const addGauge: (chainId: ChainId, gauge: string, signer: Signer) => Promise<any>;
+export declare const addGauge: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/gaugeController/batchVote.d.ts

@@ -1,11 +1,14 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Casts votes on multiple gauges in a single transaction.
+ * Votes on several gauges in one transaction.
+ *
  * @param chainId - The chain/network to use.
- * @param gaugeAddresses - Array of gauge addresses to vote on.
- * @param voteWeights - Array of vote weights (basis points) aligned with gaugeAddresses.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param gaugeAddressesOrIds - Addresses or config ids of the gauges.
+ * @param voteWeights - Vote weight per gauge in basis points, index-aligned with the gauges.
  * @param signer - An ethers.js Signer instance (required).
- * @returns The transaction response.
+ * @returns The transaction after it has been mined.
  */
-export declare const batchVote: (chainId: ChainId, gaugeAddresses: string[], voteWeights: (string | number | bigint)[], signer: Signer) => Promise<any>;
+export declare const batchVote: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressesOrIds: string[], voteWeights: (string | number | bigint)[], signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/gaugeController/calculateBoost.d.ts

@@ -1,16 +1,18 @@
 import { Provider } from "ethers";
-import configs from "../../../configs/chains";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Reads the calculateBoost result from the GaugeController contract (read-only).
+ * Calculates the reward boost a user would get on a gauge for a staked amount.
  *
  * @param chainId - The chain/network to use.
- * @param userAddress - The user for which to calculate boost.
- * @param gaugeAddress - The gauge address to calculate the boost for.
- * @param amount - The amount to calculate the boost for.
- * @param provider - An ethers.js Provider instance for read-only RPC.
- * @returns {Promise<{ boostBasisPoints: bigint, boostedAmount: bigint }>}
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param user - Address of the user.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
+ * @param amount - Staked amount, base units.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The boost in basis points and the boosted amount.
  */
-export declare const calculateBoost: (chainId: keyof typeof configs, userAddress: string, gaugeAddress: string, amount: string | number | bigint, provider: Provider) => Promise<{
+export declare const calculateBoost: (chainId: ChainId, gaugeSystem: GaugeSystemRef, user: string, gaugeAddressOrId: string, amount: string | number | bigint, provider?: Provider) => Promise<{
     boostBasisPoints: bigint;
     boostedAmount: bigint;
 }>;

package/dist/types/contracts/governance/gaugeController/forceCompleteCheckpoint.d.ts

@@ -1,10 +1,13 @@
-import { Signer } from "ethers";
+import { ethers, Signer } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Forces completion of a pending checkpoint for a gauge.
+ * Completes a gauge's pending weight checkpoint.
+ *
  * @param chainId - The chain/network to use.
- * @param gauge - Address of the gauge to checkpoint.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
  * @param signer - An ethers.js Signer instance (required).
- * @returns The transaction response.
+ * @returns The transaction after it has been mined.
  */
-export declare const forceCompleteCheckpoint: (chainId: ChainId, gauge: string, signer: Signer) => Promise<any>;
+export declare const forceCompleteCheckpoint: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, signer: Signer) => Promise<ethers.ContractTransactionResponse>;

package/dist/types/contracts/governance/gaugeController/getActiveGaugeCount.d.ts

@@ -0,0 +1,12 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
+/**
+ * Returns the number of registered gauges on the controller. Emergency-paused gauges are counted.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The registered gauge count.
+ */
+export declare const getActiveGaugeCount: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/gaugeController/getActiveGauges.d.ts

@@ -1,15 +1,19 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 export interface ActiveGaugesInfo {
     gauges: string[];
+    /** Weight per gauge at the current epoch, formatted in ether units, index-aligned with `gauges`. */
     weights: string[];
+    /** Sum of all gauge weights, formatted in ether units. */
     totalWeight: string;
 }
 /**
- * Gets the active gauges and their weights.
+ * Gets the active gauges on a controller and their weights at the current epoch.
  *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Active gauges, their weights, and total weight. (address[] memory, uint256[] memory, uint256} {activeGauges, weights, totalWeight} Tuple of active gauges, weights and total weight)
+ * @returns Active gauges, their weights and the total weight.
  */
-export declare const getActiveGauges: (chainId: ChainId, provider?: Provider) => Promise<ActiveGaugesInfo>;
+export declare const getActiveGauges: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<ActiveGaugesInfo>;

package/dist/types/contracts/governance/gaugeController/getConstants.d.ts

@@ -1,13 +1,15 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Reads the immutable/constant configuration values from the GaugeController.
+ * Reads the constant configuration values from a GaugeController.
+ *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
  * @param provider - Optional ethers.js Provider instance.
- * @returns An object with maxBoost, minBoost, weightPrecision, week, weightVoteDelay,
- *   minVoteWeight and maxVoteWeight, all bigint.
+ * @returns maxBoost, minBoost, weightPrecision, week, weightVoteDelay, minVoteWeight and maxVoteWeight.
  */
-export declare const getConstants: (chainId: ChainId, provider?: Provider) => Promise<{
+export declare const getConstants: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<{
     maxBoost: bigint;
     minBoost: bigint;
     weightPrecision: bigint;

package/dist/types/contracts/governance/gaugeController/getCurrentEpoch.d.ts

@@ -1,9 +1,12 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Gets the current epoch boundary (rounded down to the week) from the GaugeController.
+ * Returns the start timestamp of the controller's current epoch.
+ *
  * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Current epoch timestamp as a bigint.
+ * @returns The current epoch timestamp, seconds.
  */
-export declare const getCurrentEpoch: (chainId: ChainId, provider?: Provider) => Promise<bigint>;
+export declare const getCurrentEpoch: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<bigint>;

package/dist/types/contracts/governance/gaugeController/getExpiredGaugeVotePower.d.ts

@@ -0,0 +1,16 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
+/**
+ * Returns the vote power a user still has assigned to gauges whose votes no longer count, because every lock backing the vote has decayed out by the next epoch. Free it by re-voting those gauges.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param user - Address of the voter.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The stale vote weight in basis points and the gauges it sits on.
+ */
+export declare const getExpiredGaugeVotePower: (chainId: ChainId, gaugeSystem: GaugeSystemRef, user: string, provider?: Provider) => Promise<{
+    expiredGaugePower: bigint;
+    gauges: string[];
+}>;

package/dist/types/contracts/governance/gaugeController/getGauge.d.ts

@@ -1,13 +1,16 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
 /**
- * Reads the gauge config struct from the public `gauges` mapping on the GaugeController.
+ * Reads a gauge's entry from the controller's public `gauges` mapping.
+ *
  * @param chainId - The chain/network to use.
- * @param gauge - Address of the gauge.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param gaugeAddressOrId - Address or config id of the gauge.
  * @param provider - Optional ethers.js Provider instance.
- * @returns An object with isActive, isBoostAmplificationEnabled (booleans), weight and lastUpdateTime (bigint).
+ * @returns isActive and isBoostAmplificationEnabled flags, weight and lastUpdateTime.
  */
-export declare const getGauge: (chainId: ChainId, gauge: string, provider?: Provider) => Promise<{
+export declare const getGauge: (chainId: ChainId, gaugeSystem: GaugeSystemRef, gaugeAddressOrId: string, provider?: Provider) => Promise<{
     isActive: boolean;
     isBoostAmplificationEnabled: boolean;
     weight: bigint;

package/dist/types/contracts/governance/gaugeController/getGaugeDistributor.d.ts

@@ -0,0 +1,12 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+import { GaugeSystemRef } from "../gaugeSystems/_helpers";
+/**
+ * Returns the GaugeRewardsDistributor wired to the controller.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges") or a GaugeController address.
+ * @param provider - Optional ethers.js Provider instance.
+ * @returns The distributor address.
+ */
+export declare const getGaugeDistributor: (chainId: ChainId, gaugeSystem: GaugeSystemRef, provider?: Provider) => Promise<string>;

package/dist/types/contracts/governance/gaugeController/getGaugeEmissions.d.ts

@@ -1,5 +1,6 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
+import { GaugeSystemId } from "../../../configs/chains/chain";
 export interface GaugeEpochEmission {
     /** Epoch (Unix-week) start timestamp, seconds. */
     epoch: number;
@@ -57,8 +58,10 @@ export interface GaugeEmissionsResult {
  * where scheduledWeekEmission = minter.calculateScheduledMintableAmount(week) × distributorShare.
  *
  * @param chainId - The chain/network to use.
- * @param gauge - Gauge address (or config key).
- * @param numEpochs - How many epochs to include, ending at the current one (default 8).
+ * @param gaugeSystem - Gauge system id ("raacgauges" or "rwagauges").
+ * @param gaugeAddressOrId - Address or config id of the gauge.
+ * @param numEpochs - How many epochs to include, ending at the current one (default 8), clamped to the gauge's start.
+ * @param includeUpcoming - Whether to append a projection for the next epoch (default true).
  * @param provider - Optional ethers.js Provider instance.
  */
-export declare const getGaugeEmissions: (chainId: ChainId, gauge: string, numEpochs?: number, includeUpcoming?: boolean, provider?: Provider) => Promise<GaugeEmissionsResult>;
+export declare const getGaugeEmissions: (chainId: ChainId, gaugeSystem: GaugeSystemId, gaugeAddressOrId: string, numEpochs?: number, includeUpcoming?: boolean, provider?: Provider) => Promise<GaugeEmissionsResult>;