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

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/getControllerAddress.d.ts

@@ -0,0 +1,9 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the gauge controller address registered on the gauge.
+ * @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.
+ */
+export declare const getControllerAddress: (chainId: ChainId, gaugeAddressOrId: string, provider?: Provider) => Promise<string>;

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

@@ -0,0 +1,10 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the decimal adjustment factor used for a given reward token.
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - Address of the reward token.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+export declare const getDecimalAdjustment: (chainId: ChainId, gaugeAddressOrId: string, token: string, provider?: Provider) => Promise<bigint>;

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

@@ -0,0 +1,9 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Returns whether claimed RAAC is auto-deposited (locked) on claim.
+ * @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.
+ */
+export declare const getDepositRAACOnClaim: (chainId: ChainId, gaugeAddressOrId: string, provider?: Provider) => Promise<boolean>;

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

@@ -0,0 +1,13 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the registration data for a given distributor on the gauge.
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param distributor - Address of the distributor.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+export declare const getDistributorData: (chainId: ChainId, gaugeAddressOrId: string, distributor: string, provider?: Provider) => Promise<{
+    distributor: string;
+    approved: boolean;
+}>;

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

@@ -0,0 +1,9 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the list of distributor addresses registered on the gauge.
+ * @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.
+ */
+export declare const getDistributors: (chainId: ChainId, gaugeAddressOrId: string, provider?: Provider) => Promise<string[]>;

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,13 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
- * Gets the earned rewards for a user for a specific token (already claimed).
+ * 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 ID of the gauge.
- * @param tokenAddress - Address of the reward token.
+ * @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 amount of earned rewards formatted in ether units.
+ * @returns The claimed reward amount (raw, base units).
  */
-export declare const getEarnedReward: (chainId: ChainId, gaugeAddressOrId: string, tokenAddress: string, userAddress: string, provider?: Provider) => Promise<string>;
+export declare const getEarnedReward: (chainId: ChainId, gaugeAddressOrId: string, token: string, userAddress: string, provider?: Provider) => Promise<bigint>;

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

@@ -0,0 +1,9 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the list of extra reward token addresses registered on the gauge.
+ * @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.
+ */
+export declare const getExtraRewardTokens: (chainId: ChainId, gaugeAddressOrId: string, provider?: Provider) => Promise<string[]>;

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/getGaugeRewardTokenData.d.ts

@@ -0,0 +1,18 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the gauge-level reward accounting data for a specific token.
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - Address of the reward token.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+export declare const getGaugeRewardTokenData: (chainId: ChainId, gaugeAddressOrId: string, token: string, provider?: Provider) => Promise<{
+    isActive: boolean;
+    decimals: bigint;
+    rate: bigint;
+    integral: bigint;
+    lastUpdateTime: bigint;
+    distributed: bigint;
+    leftoverRewards: bigint;
+}>;

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/getPendingExtraRewards.d.ts

@@ -0,0 +1,11 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the pending extra rewards for a user for a specific token.
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - Address of the reward token.
+ * @param user - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+export declare const getPendingExtraRewards: (chainId: ChainId, gaugeAddressOrId: string, token: string, user: string, provider?: Provider) => Promise<bigint>;

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

@@ -1,13 +1,13 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
- * Gets the pending rewards for a user for a specific token.
+ * 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 ID of the gauge.
- * @param tokenAddress - Address of the reward token.
+ * @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 amount of pending rewards formatted in ether units.
+ * @returns The pending reward amount (raw, base units).
  */
-export declare const getPendingRewards: (chainId: ChainId, gaugeAddressOrId: string, tokenAddress: string, accountAddress: string, provider?: Provider) => Promise<string>;
+export declare const getPendingRewards: (chainId: ChainId, gaugeAddressOrId: string, token: string, accountAddress: string, provider?: Provider) => Promise<bigint>;

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

@@ -0,0 +1,9 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the minimum RAAC amount required to trigger an autolock on claim.
+ * @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.
+ */
+export declare const getRaacAutolockMin: (chainId: ChainId, gaugeAddressOrId: string, provider?: Provider) => Promise<bigint>;

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

@@ -1,11 +1,11 @@
 import { Provider } from "ethers";
 import { ChainId } from "../../../configs/chains";
 /**
- * Gets all registered reward tokens for the gauge.
+ * 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 ID of the gauge.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
  * @param provider - Optional ethers.js Provider instance.
- * @returns Array of reward token addresses.
+ * @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

@@ -0,0 +1,42 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+export interface ClaimableExtraReward {
+    token: string;
+    symbol: string;
+    decimals: number;
+    /** Claimable amount, base units. */
+    amount: bigint;
+    /** Claimable amount, formatted to `decimals`. */
+    formatted: string;
+}
+export interface UserClaimableRewards {
+    gauge: string;
+    /** 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;
+    /** Main reward the user can claim right now, base units. Same as `inGauge`. */
+    raac: bigint;
+    /** `raac` formatted to the reward token's decimals. */
+    raacFormatted: string;
+    /** Extra reward tokens claimable by the user. */
+    extras: ClaimableExtraReward[];
+}
+/**
+ * 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.
+ *
+ * Rewards still held by the GaugeRewardsDistributor are not included. They are not the user's yet: a pull
+ * (`pullRewardsFromDistributor`, or the pull every claim makes first) streams them to everyone staked over the rest of
+ * the reward period, so any per-user share of them would change with every stake, unstake and pull. Read the gauge's
+ * total still in the distributor with `governance.distributor.getClaimableForGauge` when it is needed.
+ * The distributor is read from the gauge itself, so RAAC and RWA gauges both resolve to their own system's distributor.
+ *
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param accountAddress - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+export declare const getUserClaimableRewards: (chainId: ChainId, gaugeAddressOrId: string, accountAddress: string, provider?: Provider) => Promise<UserClaimableRewards>;

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/getUserRewardTokenData.d.ts

@@ -0,0 +1,17 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets a user's reward accounting data for a specific token.
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param token - Address of the reward token.
+ * @param user - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+export declare const getUserRewardTokenData: (chainId: ChainId, gaugeAddressOrId: string, token: string, user: string, provider?: Provider) => Promise<{
+    integral: bigint;
+    lastGaugeIntegral: bigint;
+    claimable: bigint;
+    claimed: bigint;
+    lastUpdate: bigint;
+}>;

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

@@ -0,0 +1,10 @@
+import { Provider } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Gets the gauge vote weight for a given account.
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param account - Address of the user.
+ * @param provider - Optional ethers.js Provider instance.
+ */
+export declare const getUserWeight: (chainId: ChainId, gaugeAddressOrId: string, account: string, provider?: Provider) => Promise<bigint>;

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

@@ -1,17 +1,49 @@
-export { getPendingRewards } from "./getPendingRewards";
-export { getAllPendingRewards, type AllPendingRewards } from "./getAllPendingRewards";
-export { getEarnedReward } from "./getEarnedReward";
-export { getAllEarnedRewards, type AllEarnedRewards } from "./getAllEarnedRewards";
-export { getRewardTokens } from "./getRewardTokens";
-export { getBalanceOf } from "./getBalanceOf";
-export { getRawBalanceOf } from "./getRawBalanceOf";
-export { getTotalSupply } from "./getTotalSupply";
-export { getRawTotalSupply } from "./getRawTotalSupply";
-export { getPeriodBoundaries, type PeriodBoundaries } from "./getPeriodBoundaries";
-export { getPeriodDuration } from "./getPeriodDuration";
-export { stake } from "./stake";
-export { withdraw } from "./withdraw";
-export { claimReward } from "./claimReward";
-export { claimRewardToken } from "./claimRewardToken";
-export { syncRewardTokens } from "./syncRewardTokens";
-export { updateUserRewards } from "./updateUserRewards";
+export * from "./addRewardToken";
+export * from "./approveGaugeToken";
+export * from "./claimExtraReward";
+export * from "./claimExtraRewards";
+export * from "./claimOnBehalfOf";
+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";
+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 "./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

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

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

@@ -0,0 +1,11 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Adds or removes a distributor on the gauge (requires GAUGE_ADMIN).
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param distributor - Address of the distributor to manage.
+ * @param shouldAdd - True to add, false to remove.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+export declare const manageDistributor: (chainId: ChainId, gaugeAddressOrId: string, distributor: string, shouldAdd: boolean, signer: Signer) => Promise<any>;

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/setController.d.ts

@@ -0,0 +1,10 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Sets the gauge controller address (requires GAUGE_ADMIN).
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param controller - Address of the new controller.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+export declare const setController: (chainId: ChainId, gaugeAddressOrId: string, controller: string, signer: Signer) => Promise<any>;

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

@@ -0,0 +1,10 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Toggles whether claimed RAAC is auto-deposited on claim (requires DEFAULT_ADMIN_ROLE).
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param value - New value for the deposit-on-claim flag.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+export declare const setDepositRAACOnClaim: (chainId: ChainId, gaugeAddressOrId: string, value: boolean, signer: Signer) => Promise<any>;

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

@@ -0,0 +1,10 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Sets the emergency paused state of the gauge (requires CONTROLLER_ROLE).
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param paused - True to pause, false to unpause.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+export declare const setEmergencyPaused: (chainId: ChainId, gaugeAddressOrId: string, paused: boolean, signer: Signer) => Promise<any>;

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

@@ -0,0 +1,10 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Sets the gauge reward distributor address (requires DEFAULT_ADMIN_ROLE).
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param rewardDistributor - Address of the new reward distributor.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+export declare const setGaugeRewardDistributor: (chainId: ChainId, gaugeAddressOrId: string, rewardDistributor: string, signer: Signer) => Promise<any>;

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

@@ -0,0 +1,10 @@
+import { Signer } from "ethers";
+import { ChainId } from "../../../configs/chains";
+/**
+ * Sets the minimum RAAC amount required to trigger an autolock on claim (requires DEFAULT_ADMIN_ROLE).
+ * @param chainId - The chain/network to use.
+ * @param gaugeAddressOrId - Address of the gauge contract or its config ID.
+ * @param amount - The new minimum autolock amount.
+ * @param signer - An ethers.js Signer instance (required).
+ */
+export declare const setRaacAutolockMin: (chainId: ChainId, gaugeAddressOrId: string, amount: string | number | bigint, signer: Signer) => Promise<any>;

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/updateUserRewards.d.ts

@@ -6,7 +6,8 @@ import configs from "../../../configs/chains";
  *
  * @param chainId - The chain/network to use.
  * @param gaugeAddressOrId - Address of the gauge contract or ID of the gauge.
+ * @param user - Address of the user whose reward state should be settled/kicked.
  * @param signer - An ethers.js Signer instance (must be connected to wallet).
  * @returns Transaction receipt after the update is complete.
  */
-export declare const updateUserRewards: (chainId: keyof typeof configs, gaugeAddressOrId: string, signer: Signer) => Promise<any>;
+export declare const updateUserRewards: (chainId: keyof typeof configs, gaugeAddressOrId: string, user: string, 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>;