@berachain/berajs 0.2.11 → 0.2.13

package/src/hooks/governance/useIsCanceller.ts

@@ -10,12 +10,12 @@ import { POLLING } from "../../enum/polling";
 import { assertPublicClient } from "../../errors/assert";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
-export const useIsCanceller = ({
+export function useIsCanceller({
   account,
   ...baseArgs
 }: {
   account: Address | undefined;
-} & BeraJS.BaseFunctionArgs) => {
+} & BeraJS.BaseFunctionArgs) {
   const publicClient = usePublicClient();
   const { config: chainConfig } = parseBaseArgs(baseArgs);
 
@@ -41,4 +41,4 @@ export const useIsCanceller = ({
       revalidateOnFocus: false,
     },
   );
-};
+}

package/src/hooks/governance/usePollAllProposals.ts

@@ -16,9 +16,9 @@ import type { DefaultHookOptions } from "../../types/global";
 
 const DEFAULT_PER_PAGE = 10;
 
-const fromUiStatusToSubgraphStatuses = (
+function fromUiStatusToSubgraphStatuses(
   status: ProposalStatus,
-): ProposalStatus[] => {
+): ProposalStatus[] {
   switch (status) {
     case ProposalStatus.QuorumNotReached:
       return [ProposalStatus.Active, ProposalStatus.Pending];
@@ -30,7 +30,7 @@ const fromUiStatusToSubgraphStatuses = (
     default:
       return [status];
   }
-};
+}
 
 type UsePollAllProposalsArgs = {
   topic: string;

package/src/hooks/governance/usePollProposal.ts

@@ -33,10 +33,10 @@ export interface UsePollProposalResponse
  *   - mutate: () => Promise<ProposalWithVotesFragment | undefined> - Function to manually refresh the data
  *   - refresh: () => Promise<void> - Function to manually refresh the data
  */
-export const usePollProposal = (
+export function usePollProposal(
   proposalId: string,
   options?: DefaultHookOptions & { autoRefresh?: boolean },
-): UsePollProposalResponse => {
+): UsePollProposalResponse {
   const autoRefreshProposal = options?.autoRefresh ?? false;
   const publicClient = usePublicClient();
 
@@ -75,25 +75,22 @@ export const usePollProposal = (
     switch (swrResponse.data.status) {
       case ProposalStatus.Pending:
         if (timestamp >= Number(swrResponse.data.voteStartAt)) {
-          swrResponse.mutate();
+          swrResponse.refresh();
         }
         break;
       case ProposalStatus.Active:
         if (timestamp >= Number(swrResponse.data.voteEndAt)) {
-          swrResponse.mutate();
+          swrResponse.refresh();
         }
         break;
       case ProposalStatus.InQueue:
         if (Date.now() / 1000 + 1 >= Number(swrResponse.data.queueEnd)) {
-          swrResponse.mutate();
+          swrResponse.refresh();
         }
         break;
     }
   }, [swrResponse.data?.status, timestamp]);
 
   // const votes = swrResponse.data?.votes.nodes ?? [];
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse?.mutate?.(),
-  };
-};
+  return swrResponse;
+}

package/src/hooks/governance/usePollProposalThreshold.ts

@@ -9,16 +9,16 @@ import { POLLING } from "../../enum/polling";
 import { assertPublicClient } from "../../errors/assert";
 import type { DefaultHookReturnType } from "../../types/global";
 
-export const usePollProposalThreshold = (
+export function usePollProposalThreshold(
   governorAddress: Address,
-): DefaultHookReturnType<{ votesThreshold: string }> => {
+): DefaultHookReturnType<{ votesThreshold: string }> {
   const publicClient = usePublicClient();
 
   const QUERY_KEY = publicClient
     ? (["usePollProposalThreshold", governorAddress] as const)
     : null;
 
-  const swrResponse = useSWR<{ votesThreshold: string }, any, typeof QUERY_KEY>(
+  return useSWR<{ votesThreshold: string }, any, typeof QUERY_KEY>(
     QUERY_KEY,
     async ([, governorAddress]) => {
       assertPublicClient(publicClient);
@@ -34,9 +34,4 @@ export const usePollProposalThreshold = (
       refreshInterval: POLLING.SLOW,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: swrResponse.mutate,
-  };
-};
+}

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,26 +6,28 @@ 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 swrResponse = useSWR<
+  const QUERY_KEY =
+    account && publicClient
+      ? (["usePollUserDelegates", account] as const)
+      : null;
+
+  return useSWR<
     { delegate: Address; currentVotes: string | undefined },
     any,
     typeof QUERY_KEY
@@ -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,9 +70,4 @@ export const usePollUserDelegates = (
       refreshInterval: options?.refreshInterval ?? POLLING.SLOW,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse?.mutate?.(),
-  };
-};
+}

package/src/hooks/governance/useProposalFromTx.ts

@@ -2,14 +2,14 @@ import type { Address } from "viem";
 
 import type { ProposalWithVotesFragment } from "@berachain/graphql/governance";
 import { usePublicClient, useTransactionReceipt } from "@berachain/wagmi/hooks";
-import type { SWRResponse } from "@berachain/utils/pkg/swr";
+import type { BeraSwrResponse } from "@berachain/utils/pkg/swr";
 import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { getProposalFromTx } from "../../actions/governance/getProposalFromTx";
 
-export const useProposalFromTx = (
+export function useProposalFromTx(
   txHash?: Address,
-): SWRResponse<ProposalWithVotesFragment | null> => {
+): BeraSwrResponse<ProposalWithVotesFragment | null> {
   const { data: tx } = useTransactionReceipt({
     hash: txHash,
   });
@@ -19,7 +19,7 @@ export const useProposalFromTx = (
   const QUERY_KEY =
     tx && publicClient ? (["useProposalFromTx", txHash] as const) : null;
 
-  const swrResponse = useSWR(QUERY_KEY, async ([, txHash]) => {
+  return useSWR(QUERY_KEY, async ([, txHash]) => {
     if (!tx) {
       throw new Error("Transaction not found");
     }
@@ -33,6 +33,4 @@ export const useProposalFromTx = (
 
     return getProposalFromTx({ tx, publicClient });
   });
-
-  return swrResponse;
-};
+}

package/src/hooks/governance/useProposalSnapshot.ts

@@ -1,7 +1,7 @@
 import { berachainGovernanceAbi as governanceAbi } from "@berachain/abis/gov/berachainGovernance";
 
 import { usePublicClient } from "@berachain/wagmi/hooks";
-import type { SWRResponse } from "@berachain/utils/pkg/swr";
+import type { BeraSwrResponse } from "@berachain/utils/pkg/swr";
 import { useSWRImmutable } from "@berachain/utils/pkg/swr";
 
 import { assertPublicClient } from "../../errors/assert";
@@ -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;
-}): SWRResponse<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

@@ -3,7 +3,7 @@ import type { Address } from "viem";
 import { berachainGovernanceAbi as governanceAbi } from "@berachain/abis/gov/berachainGovernance";
 
 import { usePublicClient } from "@berachain/wagmi/hooks";
-import type { SWRResponse } from "@berachain/utils/pkg/swr";
+import type { BeraSwrResponse } from "@berachain/utils/pkg/swr";
 import { useSWRImmutable } from "@berachain/utils/pkg/swr";
 
 import { ProposalState } from "../../enum/governance";
@@ -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;
-}): SWRResponse<string> => {
+}): BeraSwrResponse<string> {
   const publicClient = usePublicClient();
 
   const QUERY_KEY =
@@ -46,4 +46,4 @@ export const useProposalState = ({
 
     return ProposalStateMap[snapshot];
   });
-};
+}

package/src/hooks/governance/useProposalTimelockState.ts

@@ -3,7 +3,7 @@ import type { Address } from "viem";
 import { timeLockAbi as governanceTimelockAbi } from "@berachain/abis/gov/timeLock";
 
 import { usePublicClient } from "@berachain/wagmi/hooks";
-import type { SWRResponse } from "@berachain/utils/pkg/swr";
+import type { BeraSwrResponse } from "@berachain/utils/pkg/swr";
 import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { POLLING } from "../../enum/polling";
@@ -26,7 +26,7 @@ export function useProposalTimelockState({
 }: {
   proposalTimelockId: Address | undefined;
   timelockAddress: Address;
-}): SWRResponse<
+}): BeraSwrResponse<
   (typeof TimelockOperationState)[keyof typeof TimelockOperationState]
 > {
   const publicClient = usePublicClient();

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(
@@ -56,7 +56,7 @@ export const useCappedGlobally = (
         ] as const)
       : null;
 
-  const swrResponse = useSWR(
+  return useSWR(
     QUERY_KEY,
     async ([
       _,
@@ -85,9 +85,4 @@ export const useCappedGlobally = (
       refreshInterval: 0,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => void swrResponse.mutate(),
-  };
-};
+}

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 =
@@ -41,7 +41,7 @@ export const useCappedRelatively = (
         ] as const)
       : null;
 
-  const swrResponse = useSWR(
+  return useSWR(
     QUERY_KEY,
     async ([_, asset, amount, collaterals, referenceCollateral]) => {
       if (isBasketModeEnabled) {
@@ -83,9 +83,4 @@ export const useCappedRelatively = (
       ...options,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => void swrResponse.mutate(),
-  };
-};
+}

package/src/hooks/honey/useCollateralWeights.ts

@@ -15,21 +15,21 @@ 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
       ? (["useCollateralWeights", collateralList] as const)
       : undefined;
 
-  const swrResponse = useSWR(
+  return useSWR(
     QUERY_KEY,
     async ([_, collateralList]) => {
       assertPublicClient(publicClient);
@@ -44,9 +44,4 @@ export const useCollateralWeights = (
       refreshInterval: options?.refreshInterval ?? POLLING.NORMAL,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => void swrResponse.mutate(),
-  };
-};
+}

package/src/hooks/honey/useHoney24hVolume.ts

@@ -8,9 +8,5 @@ export function useHoney24hVolume() {
     refreshInterval: POLLING.SLOW,
   });
 
-  return {
-    ...response,
-
-    refresh: () => response.mutate(),
-  };
+  return response;
 }

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
@@ -48,7 +48,7 @@ export const useHoneyBalances = (): DefaultHookReturnType<
       ? (["useHoneyBalances", account, collateralList] as const)
       : null;
 
-  const swrResponse = useSWR(
+  return useSWR(
     QUERY_KEY,
     async ([_, account, collateralList]) => {
       assertPublicClient(publicClient);
@@ -75,9 +75,4 @@ export const useHoneyBalances = (): DefaultHookReturnType<
       refreshInterval: POLLING.FAST,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse.mutate(),
-  };
-};
+}

package/src/hooks/honey/useHoneyChartData.ts

@@ -3,15 +3,7 @@ import { useSWR } from "@berachain/utils/pkg/swr";
 import { getChartData } from "../../actions/honey/getChartData";
 
 export function useHoneyChartData({ days }: { days: number }) {
-  const swrResponse = useSWR(
-    ["useHoneyChartData", days] as const,
-    async ([_, days]) => {
-      return await getChartData({ days });
-    },
-  );
-
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse.mutate(),
-  };
+  return useSWR(["useHoneyChartData", days] as const, async ([_, days]) => {
+    return await getChartData({ days });
+  });
 }

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 =
@@ -23,7 +23,7 @@ export const useHoneyVaultsBalance = (
       ? (["useHoneyVaultsBalance", collateralList] as const)
       : null;
 
-  const swrResponse = useSWR(
+  return useSWR(
     QUERY_KEY,
     async ([_, collateralList]) => {
       assertPublicClient(publicClient);
@@ -35,9 +35,4 @@ export const useHoneyVaultsBalance = (
     },
     { ...options, refreshInterval: POLLING.NORMAL },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => void swrResponse.mutate(),
-  };
-};
+}