@berachain/berajs 0.2.12 → 0.2.13

package/src/hooks/governance/usePollProposalVotes.ts

@@ -28,10 +28,10 @@ type ProposalVotesKey =
  * @param args - The arguments to pass to the query
  * @param total - The total amount of pages of votes to fetch
  */
-export const usePollProposalVotes = (
+export function usePollProposalVotes(
   args: UsePollProposalVotesArgs,
   total: number,
-) => {
+) {
   return useSWRInfinite<
     Awaited<ReturnType<typeof getProposalVotes>>,
     any,
@@ -53,17 +53,16 @@ export const usePollProposalVotes = (
       initialSize: Number.POSITIVE_INFINITY,
     },
   );
-};
+}
 
-export const usePollProposalVotesQueryKey =
-  (
-    { ...args }: UsePollProposalVotesArgs,
-    total: number,
-  ): SWRInfiniteKeyLoader<
-    Awaited<ReturnType<typeof getProposalVotes>>,
-    ProposalVotesKey
-  > =>
-  (
+export function usePollProposalVotesQueryKey(
+  { ...args }: UsePollProposalVotesArgs,
+  total: number,
+): SWRInfiniteKeyLoader<
+  Awaited<ReturnType<typeof getProposalVotes>>,
+  ProposalVotesKey
+> {
+  return (
     pageIndex: number,
     // previousPageData: Awaited<ReturnType<typeof getProposalVotes>>,
   ) => {
@@ -80,3 +79,4 @@ export const usePollProposalVotesQueryKey =
       args.orderDirection,
     ];
   };
+}

package/src/hooks/governance/usePollUserDelegates.ts

@@ -6,24 +6,26 @@ import { useBeraWallet, usePublicClient } from "@berachain/wagmi/hooks";
 import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { POLLING } from "../../enum/polling";
-import { assertPublicClient } from "../../errors/assert";
+import { assertDefined, assertPublicClient } from "../../errors/assert";
 import type {
   DefaultHookOptions,
   DefaultHookReturnType,
 } from "../../types/global";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
-export const usePollUserDelegates = (
+export function usePollUserDelegates(
   options?: DefaultHookOptions,
 ): DefaultHookReturnType<{
   delegate: Address;
   currentVotes: string | undefined;
-}> => {
+}> {
   const { address: account } = useBeraWallet();
   const publicClient = usePublicClient();
-  const QUERY_KEY = account
-    ? (["usePollUserDelegates", account] as const)
-    : null;
+
+  const QUERY_KEY =
+    account && publicClient
+      ? (["usePollUserDelegates", account] as const)
+      : null;
 
   return useSWR<
     { delegate: Address; currentVotes: string | undefined },
@@ -33,23 +35,25 @@ export const usePollUserDelegates = (
     QUERY_KEY,
     async ([, account]) => {
       assertPublicClient(publicClient);
-      const { config } = parseBaseArgs({
+      assertDefined(account, "account");
+
+      // TODO(governance-token): once a real ERC-20Votes substitute for BGT exists,
+      // resolve the governance token from config here. The app is single-chain, so
+      // it's fixed for the deployment — no need to thread it through the SWR key.
+      const tokenAddress = parseBaseArgs({
         chainId: publicClient.chain.id,
-      });
-      if (!publicClient || !account) {
-        throw new Error("usePollUserDelegates needs publicClient and account");
-      }
+      }).config.tokens.bgt;
 
       // use promise all to better catch errors and have type safety
       const [delegate, currentVotes] = await Promise.all([
         publicClient.readContract({
-          address: config.tokens.bgt,
+          address: tokenAddress,
           abi: bgtAbi,
           functionName: "delegates",
           args: [account],
         }),
         publicClient.readContract({
-          address: config.tokens.bgt,
+          address: tokenAddress,
           abi: bgtAbi,
           functionName: "getVotes",
           args: [account],
@@ -66,4 +70,4 @@ export const usePollUserDelegates = (
       refreshInterval: options?.refreshInterval ?? POLLING.SLOW,
     },
   );
-};
+}

package/src/hooks/governance/useProposalFromTx.ts

@@ -7,9 +7,9 @@ import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { getProposalFromTx } from "../../actions/governance/getProposalFromTx";
 
-export const useProposalFromTx = (
+export function useProposalFromTx(
   txHash?: Address,
-): BeraSwrResponse<ProposalWithVotesFragment | null> => {
+): BeraSwrResponse<ProposalWithVotesFragment | null> {
   const { data: tx } = useTransactionReceipt({
     hash: txHash,
   });
@@ -33,4 +33,4 @@ export const useProposalFromTx = (
 
     return getProposalFromTx({ tx, publicClient });
   });
-};
+}

package/src/hooks/governance/useProposalSnapshot.ts

@@ -14,11 +14,11 @@ import { parseBaseArgs } from "../../utils/parseBaseArgs";
  *
  * {@link https://docs.openzeppelin.com/contracts/5.x/api/governance#IGovernor-proposalSnapshot-uint256-}
  */
-export const useProposalSnapshot = ({
+export function useProposalSnapshot({
   proposalId,
 }: {
   proposalId: number | bigint | string | undefined;
-}): BeraSwrResponse<string> => {
+}): BeraSwrResponse<string> {
   const publicClient = usePublicClient();
 
   const QUERY_KEY =
@@ -41,4 +41,4 @@ export const useProposalSnapshot = ({
 
     return snapshot.toString();
   });
-};
+}

package/src/hooks/governance/useProposalState.ts

@@ -20,13 +20,13 @@ const ProposalStateMap: Record<ProposalState, string> = {
   [ProposalState.Executed]: "executed",
 };
 
-export const useProposalState = ({
+export function useProposalState({
   proposalId,
   governorAddress,
 }: {
   proposalId: number | bigint | string | undefined;
   governorAddress: Address;
-}): BeraSwrResponse<string> => {
+}): BeraSwrResponse<string> {
   const publicClient = usePublicClient();
 
   const QUERY_KEY =
@@ -46,4 +46,4 @@ export const useProposalState = ({
 
     return ProposalStateMap[snapshot];
   });
-};
+}

package/src/hooks/honey/useCappedGlobally.ts

@@ -14,7 +14,7 @@ import { usePythLatestPrices } from "./usePythLatestPrices";
 export interface UseCappedGloballyResponse
   extends DefaultHookReturnType<boolean | undefined> {}
 
-export const useCappedGlobally = (
+export function useCappedGlobally(
   {
     asset,
     amount,
@@ -27,7 +27,7 @@ export const useCappedGlobally = (
     isBasketModeEnabled: boolean | undefined;
   },
   options?: DefaultHookOptions,
-): UseCappedGloballyResponse => {
+): UseCappedGloballyResponse {
   const publicClient = usePublicClient();
   const { priceFeedMap, flags } = useHoneyConfig();
   const { data: latestPrices } = usePythLatestPrices(
@@ -85,4 +85,4 @@ export const useCappedGlobally = (
       refreshInterval: 0,
     },
   );
-};
+}

package/src/hooks/honey/useCappedRelatively.ts

@@ -14,7 +14,7 @@ import type {
 export interface UseCappedRelativelyResponse
   extends DefaultHookReturnType<boolean | undefined> {}
 
-export const useCappedRelatively = (
+export function useCappedRelatively(
   {
     asset,
     amount,
@@ -27,7 +27,7 @@ export const useCappedRelatively = (
     isBasketModeEnabled: boolean | undefined;
   },
   options?: DefaultHookOptions,
-): UseCappedRelativelyResponse => {
+): UseCappedRelativelyResponse {
   const publicClient = usePublicClient();
   const { collateralList, referenceCollateral } = useHoneyConfig();
   const QUERY_KEY =
@@ -83,4 +83,4 @@ export const useCappedRelatively = (
       ...options,
     },
   );
-};
+}

package/src/hooks/honey/useCollateralWeights.ts

@@ -15,14 +15,14 @@ import type {
 export interface UseCollateralWeightsResponse
   extends DefaultHookReturnType<Record<Address, bigint> | undefined> {}
 
-export const useCollateralWeights = (
+export function useCollateralWeights(
   {
     collateralList,
   }: {
     collateralList: Token[] | undefined;
   },
   options?: DefaultHookOptions,
-): UseCollateralWeightsResponse => {
+): UseCollateralWeightsResponse {
   const publicClient = usePublicClient();
   const QUERY_KEY =
     publicClient && collateralList
@@ -44,4 +44,4 @@ export const useCollateralWeights = (
       refreshInterval: options?.refreshInterval ?? POLLING.NORMAL,
     },
   );
-};
+}

package/src/hooks/honey/useHoneyAlerts.ts

@@ -64,7 +64,7 @@ interface HoneyAlertsReturn {
  * @returns {boolean} isLow - True if liquidity is below the threshold, false otherwise
  * @returns {Token[]} isLiquidityLowCollaterals - The collaterals that are below the threshold
  */
-const getIsLiquidityLowerThan = ({
+function getIsLiquidityLowerThan({
   lowerThan,
   vaultsBalances,
   state,
@@ -74,7 +74,7 @@ const getIsLiquidityLowerThan = ({
   state: HoneyAlertStateProps;
   vaultsBalances: GetHoneyVaultsBalanceResponse[] | undefined;
   collateralList: TokenWithOrder[];
-}): { isLow: boolean; isLiquidityLowCollaterals: Token[] } => {
+}): { isLow: boolean; isLiquidityLowCollaterals: Token[] } {
   const isMint = state.actionType === "mint";
   if (!isMint && !state.isBasketModeEnabled) {
     const redeemedVaultBalance = vaultsBalances?.find(
@@ -103,7 +103,7 @@ const getIsLiquidityLowerThan = ({
     isLow: false,
     isLiquidityLowCollaterals: [],
   };
-};
+}
 
 /**
  * Checks if the requested redeem amount exceeds the available liquidity in the vault
@@ -115,7 +115,7 @@ const getIsLiquidityLowerThan = ({
  * @returns {boolean} isMore - True if redeem amount exceeds liquidity, false otherwise
  * @returns {Token[]} isRedeemMoreThanLiquidityCollaterals - The collaterals that exceed the liquidity
  */
-const getRedeemMoreThanLiquidity = ({
+function getRedeemMoreThanLiquidity({
   vaultsBalances,
   redeemedVaultBalance,
   state,
@@ -125,7 +125,7 @@ const getRedeemMoreThanLiquidity = ({
   redeemedVaultBalance: GetHoneyVaultsBalanceResponse | undefined;
   collateralList: TokenWithOrder[];
   state: HoneyAlertStateProps;
-}) => {
+}) {
   const isMint = state.actionType === "mint";
   if (!isMint && vaultsBalances && redeemedVaultBalance) {
     // if basket mode is enabled, check all collateral balances and amount to redeem
@@ -148,7 +148,7 @@ const getRedeemMoreThanLiquidity = ({
     };
   }
   return { isMore: false, isRedeemMoreThanLiquidityCollaterals: undefined };
-};
+}
 
 /**
  * Checks if the input amount exceeds the user's balance
@@ -207,13 +207,13 @@ function getExceedingBalance({
  * @returns {HoneyAlertsReturn} Object containing various alert states
 
  */
-export const useHoneyAlerts = ({
+export function useHoneyAlerts({
   actionType,
   collaterals,
   fromAmount,
   toAmount,
   isBasketModeEnabled,
-}: HoneyAlertStateProps): HoneyAlertsReturn => {
+}: HoneyAlertStateProps): HoneyAlertsReturn {
   const state = {
     actionType,
     collaterals,
@@ -311,4 +311,4 @@ export const useHoneyAlerts = ({
     isCappedRelatively,
     isExceedingBalance,
   };
-};
+}

package/src/hooks/honey/useHoneyBalances.ts

@@ -36,9 +36,9 @@ import { getHoneyToken } from "../../utils/tokens";
  *   - isLoading: Loading state
  *   - refresh: Function to manually refresh balances
  */
-export const useHoneyBalances = (): DefaultHookReturnType<
+export function useHoneyBalances(): DefaultHookReturnType<
   Record<Address, BalanceToken>
-> => {
+> {
   const publicClient = usePublicClient();
   const { address: account } = useBeraWallet();
   const { collateralList } = useHoneyConfig(); // needed
@@ -75,4 +75,4 @@ export const useHoneyBalances = (): DefaultHookReturnType<
       refreshInterval: POLLING.FAST,
     },
   );
-};
+}

package/src/hooks/honey/useHoneySwapState.ts

@@ -153,7 +153,7 @@ export function reducer(
   }
 }
 
-export const useHoneySwapState = () => {
+export function useHoneySwapState() {
   const { collateralList } = useHoneyConfig();
   const [state, dispatch] = useReducer(
     reducer,
@@ -200,4 +200,4 @@ export const useHoneySwapState = () => {
   }, [isBasketModeEnabled]);
 
   return { state, dispatch };
-};
+}

package/src/hooks/honey/useHoneyVaultsBalance.ts

@@ -13,9 +13,9 @@ import type {
   DefaultHookReturnType,
 } from "../../types/global";
 
-export const useHoneyVaultsBalance = (
+export function useHoneyVaultsBalance(
   options?: DefaultHookOptions,
-): DefaultHookReturnType<GetHoneyVaultsBalanceResponse[]> => {
+): DefaultHookReturnType<GetHoneyVaultsBalanceResponse[]> {
   const publicClient = usePublicClient();
   const { collateralList } = useHoneyConfig();
   const QUERY_KEY =
@@ -35,4 +35,4 @@ export const useHoneyVaultsBalance = (
     },
     { ...options, refreshInterval: POLLING.NORMAL },
   );
-};
+}

package/src/hooks/honey/useIsBadCollateralAsset.ts

@@ -18,10 +18,10 @@ import { usePythLatestPrices } from "./usePythLatestPrices";
 export interface UseIsBadCollateralResponse
   extends DefaultHookReturnType<IsBadCollateralResponse | undefined> {}
 
-export const useIsBadCollateralAsset = (
+export function useIsBadCollateralAsset(
   { collateral }: { collateral: Token | undefined },
   options?: DefaultHookOptions,
-): UseIsBadCollateralResponse => {
+): UseIsBadCollateralResponse {
   const publicClient = usePublicClient();
   const { priceFeedMap, flags } = useHoneyConfig();
   const { data: latestPrices } = usePythLatestPrices(
@@ -66,4 +66,4 @@ export const useIsBadCollateralAsset = (
       refreshInterval: options?.refreshInterval ?? POLLING.NORMAL,
     },
   );
-};
+}

package/src/hooks/perps/usePythUpdateFee.ts

@@ -8,7 +8,7 @@ import { assertPublicClient } from "../../errors/assert";
 import type { DefaultHookOptions } from "../../types/global";
 import { getPythDefaultUpdateFee } from "../../utils/pythHoneyUtils";
 
-export const usePythUpdateFee = (
+export function usePythUpdateFee(
   {
     pythPriceFeedCalldata,
     tokenListLength,
@@ -17,7 +17,7 @@ export const usePythUpdateFee = (
     tokenListLength: number;
   },
   options?: DefaultHookOptions,
-) => {
+) {
   const publicClient = usePublicClient();
   const QUERY_KEY =
     pythPriceFeedCalldata && pythPriceFeedCalldata.length > 0
@@ -42,4 +42,4 @@ export const usePythUpdateFee = (
     data,
     isLoading,
   };
-};
+}

package/src/hooks/pol/useAutoclaimedIncentives.ts

@@ -2,7 +2,7 @@ import { useBeraWallet } from "@berachain/wagmi/hooks";
 import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { getAutoclaimedIncentives } from "../../actions/pol/getAutoclaimedIncentives";
-import type { AutoclaimedIncentivesResponse } from "../../types/bribe-boost";
+import type { AutoclaimedIncentivesResponse } from "../../types/bribeBoost";
 import type { DefaultHookReturnType } from "../../types/global";
 
 interface UseAutoclaimedIncentivesArgs {

package/src/hooks/pol/useAutoclaimedIncentivesTxHash.ts

@@ -3,7 +3,7 @@ import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { getAutoclaimedIncentivesTxHash } from "../../actions/pol/getAutoclaimedIncentivesTxHash";
 import { POLLING } from "../../enum/polling";
-import type { AutoclaimedIncentivesTxHashResponse } from "../../types/bribe-boost";
+import type { AutoclaimedIncentivesTxHashResponse } from "../../types/bribeBoost";
 import type { DefaultHookReturnType } from "../../types/global";
 
 interface UseAutoclaimedIncentivesTxHashArgs {

package/src/hooks/pol/useBgtUnstakedBalance.ts

@@ -14,9 +14,9 @@ import type {
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
 // TODO: REFACTOR ON REDEPLOY
-export const useBgtUnstakedBalance = (
+export function useBgtUnstakedBalance(
   options?: DefaultHookOptions,
-): DefaultHookReturnType<string | undefined> => {
+): DefaultHookReturnType<string | undefined> {
   const { address: account } = useBeraWallet();
   const publicClient = usePublicClient();
   const QUERY_KEY =
@@ -46,4 +46,4 @@ export const useBgtUnstakedBalance = (
       refreshInterval: options?.refreshInterval ?? POLLING.NORMAL,
     },
   );
-};
+}

package/src/hooks/pol/useClaimableFees.ts

@@ -3,12 +3,12 @@ import { formatUnits } from "viem";
 import { useBeraWallet, usePublicClient } from "@berachain/wagmi/hooks";
 import { useSWR } from "@berachain/utils/pkg/swr";
 
-import { getUserVaultsReward } from "../../actions/pol/getUserVaultsReward";
+import { getRewardVaultEarnedRewards } from "../../actions/pol/getRewardVaultEarnedRewards";
 import { POLLING } from "../../enum/polling";
 import { assertPublicClient } from "../../errors/assert";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
-export const useClaimableFees = () => {
+export function useClaimableFees() {
   const { address: account } = useBeraWallet();
   const publicClient = usePublicClient();
   const QUERY_KEY =
@@ -20,7 +20,7 @@ export const useClaimableFees = () => {
       const { config } = parseBaseArgs({
         chainId: publicClient.chain.id,
       });
-      const vaultReward = await getUserVaultsReward({
+      const vaultReward = await getRewardVaultEarnedRewards({
         account,
         vaultAddress: config.pol.staker,
         publicClient,
@@ -31,4 +31,4 @@ export const useClaimableFees = () => {
       refreshInterval: POLLING.SLOW * 2,
     },
   );
-};
+}

package/src/hooks/pol/useHighestVaultsAPR.ts

@@ -21,13 +21,13 @@ import { useRewardVaults } from "./useRewardVaults";
  *   filteringVaults: ['0x123...', '0x456...']
  * });
  */
-export const useHighestVaultsAPR = (
+export function useHighestVaultsAPR(
   where: GqlRewardVaultFilter = {},
   { isEnabled = true }: { isEnabled?: boolean } = {},
 ): {
   highestApr: GqlRewardVaultDynamicData["apr"] | undefined;
   isLoading: boolean;
-} => {
+} {
   const swrResponse = useRewardVaults(
     {
       filter: {
@@ -49,4 +49,4 @@ export const useHighestVaultsAPR = (
     isLoading: swrResponse.isLoading,
     highestApr: swrResponse.data?.rewardVaultList[0].dynamicData?.apr,
   };
-};
+}

package/src/hooks/pol/useOnChainRewardVault.ts

@@ -14,19 +14,20 @@ import { assertPublicClient } from "../../errors/assert";
 import type { DefaultHookOptions } from "../../types/global";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
-const useOnChainRewardVaultQueryKey = (address: Address | undefined) =>
-  address && isAddress(address)
+function useOnChainRewardVaultQueryKey(address: Address | undefined) {
+  return address && isAddress(address)
     ? (["onChainRewardVault", address.toLowerCase() as Address] as const)
     : null;
+}
 
-export const useOnChainRewardVault = (
+export function useOnChainRewardVault(
   {
     address,
   }: {
     address: Address | undefined;
   },
   opt: DefaultHookOptions,
-) => {
+) {
   const publicClient = usePublicClient();
 
   const QUERY_KEY = useOnChainRewardVaultQueryKey(address);
@@ -118,4 +119,4 @@ export const useOnChainRewardVault = (
     },
     opt,
   );
-};
+}

package/src/hooks/pol/usePollGlobalData.ts

@@ -11,9 +11,9 @@ import type {
   DefaultHookReturnType,
 } from "../../types/global";
 
-export const usePollGlobalData = (
+export function usePollGlobalData(
   options?: DefaultHookOptions,
-): DefaultHookReturnType<GlobalData> => {
+): DefaultHookReturnType<GlobalData> {
   const publicClient = usePublicClient();
 
   return useSWR<GlobalData>(
@@ -28,4 +28,4 @@ export const usePollGlobalData = (
       ...options,
     },
   );
-};
+}

package/src/hooks/pol/usePollMarkets.ts

@@ -9,13 +9,13 @@ import type {
 export interface UsePollMarketsResponse
   extends DefaultHookReturnType<GetMarkets> {}
 
-export const usePollMarketsQueryKey = () => {
+export function usePollMarketsQueryKey() {
   return "usePollMarkets";
-};
+}
 
-export const usePollMarkets = (
+export function usePollMarkets(
   options?: DefaultHookOptions,
-): UsePollMarketsResponse => {
+): UsePollMarketsResponse {
   const QUERY_KEY = usePollMarketsQueryKey();
   return useSWRImmutable<GetMarkets, any, typeof QUERY_KEY>(
     QUERY_KEY,
@@ -27,4 +27,4 @@ export const usePollMarkets = (
       ...options,
     },
   );
-};
+}

package/src/hooks/pol/useRewardTokenToBeraRate.ts

@@ -1,4 +1,4 @@
-import { type Address, isAddress } from "viem";
+import type { Address } from "viem";
 
 import { defaultChainId } from "@berachain/config/internal";
 
@@ -6,18 +6,17 @@ import { usePublicClient } from "@berachain/wagmi/hooks";
 import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { getRewardTokenToBeraRate } from "../../actions/pol/getRewardTokenToBeraRate";
-import { assertPublicClient } from "../../errors/assert";
-import { InvalidArgumentError } from "../../errors/InvalidArgumentError";
+import { assertAddress, assertPublicClient } from "../../errors/assert";
 import type { DefaultHookOptions } from "../../types/global";
 
-export const useRewardTokenToBeraRate = (
+export function useRewardTokenToBeraRate(
   {
     address,
   }: {
     address: Address | undefined;
   },
   opt?: DefaultHookOptions,
-) => {
+) {
   const QUERY_KEY = address
     ? (["useRewardTokenToBeraRate", address] as const)
     : null;
@@ -26,14 +25,7 @@ export const useRewardTokenToBeraRate = (
   return useSWR(
     QUERY_KEY,
     async ([_, address]) => {
-      if (!address || !isAddress(address)) {
-        throw new InvalidArgumentError({
-          property: "address",
-          value: address,
-          expected: "Address",
-        });
-      }
-
+      assertAddress(address, "address");
       assertPublicClient(publicClient);
 
       return getRewardTokenToBeraRate({
@@ -45,4 +37,4 @@ export const useRewardTokenToBeraRate = (
       ...opt,
     },
   );
-};
+}

package/src/hooks/pol/useRewardVault.ts

@@ -13,15 +13,16 @@ import { useOnChainRewardVault } from "./useOnChainRewardVault";
 export interface UseRewardVaultResponse
   extends DefaultHookReturnType<ApiVaultFragment> {}
 
-export const useRewardVaultQueryKey = (address: Address | undefined) =>
-  address
+export function useRewardVaultQueryKey(address: Address | undefined) {
+  return address
     ? (["useRewardVault", address.toLowerCase() as Address] as const)
     : null;
+}
 
-export const useRewardVault = (
+export function useRewardVault(
   id: Address | undefined,
   options?: DefaultHookOptions,
-): UseRewardVaultResponse => {
+): UseRewardVaultResponse {
   const QUERY_KEY = useRewardVaultQueryKey(id);
 
   // The off-chain fetch is intentionally always enabled; `isEnabled` only gates
@@ -52,4 +53,4 @@ export const useRewardVault = (
       onChainRewardVault.refresh();
     },
   };
-};
+}