@berachain/berajs 0.2.11 → 0.2.13

package/src/errors/assert.ts

@@ -124,7 +124,13 @@ export function assertAddress(
  * @throws An InvalidArgumentError if the value is not positive.
  */
 export function assertPositive(
+  /**
+   * The value to assert.
+   */
   value: string | bigint | number,
+  /**
+   * The property name.
+   */
   property: string,
 ): void {
   const isPositive = typeof value === "bigint" ? value > 0n : Number(value) > 0;
@@ -137,6 +143,29 @@ export function assertPositive(
   }
 }
 
+/**
+ * Asserts that a value is an integer.
+ * @throws An InvalidArgumentError if the value is not an integer.
+ */
+export function assertInteger(
+  /**
+   * The value to assert.
+   */
+  value: number,
+  /**
+   * The property name.
+   */
+  property: string,
+): void {
+  if (!Number.isInteger(value)) {
+    throw new InvalidArgumentError({
+      property,
+      value,
+      expected: "integer",
+    });
+  }
+}
+
 /**
  * Asserts that a value is a number greater than 0.
  * @throws An InvalidArgumentError if the value is undefined, null, not a string or number, or not a number greater than 0.

package/src/hooks/bend/useGetConvertToAssets.ts

@@ -6,16 +6,16 @@ import { getConvertToAssets } from "../../actions/bend/getConvertToAssets";
 import { assertPublicClient } from "../../errors/assert";
 import type { DefaultHookOptions } from "../../types/global";
 
-export const useGetConvertToAssets = (
+export function useGetConvertToAssets(
   {
     sharesAmount,
     vaultAddress,
     vaultChainId,
   }: Omit<GetConvertToAssetsProps, "publicClient"> & { vaultChainId?: number },
   options?: DefaultHookOptions,
-) => {
+) {
   const publicClient = usePublicClient({ chainId: vaultChainId });
-  const swrResponse = useSWR(
+  return useSWR(
     publicClient && sharesAmount && vaultAddress
       ? ["useGetConvertToAssets", sharesAmount, vaultAddress, vaultChainId]
       : null,
@@ -32,11 +32,4 @@ export const useGetConvertToAssets = (
       ...options,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => {
-      swrResponse.mutate();
-    },
-  };
-};
+}

package/src/hooks/dex/useAggregatorsQuotes.ts

@@ -258,6 +258,8 @@ export function useAggregatorsQuotes(
 
   return {
     ...data,
-    refresh: () => results.map((r) => r.mutate()),
+    refresh: () => {
+      results.map((r) => r.refresh());
+    },
   };
 }

package/src/hooks/dex/useAggregatorsRouterFeeBps.ts

@@ -7,12 +7,12 @@ import { useSWRImmutable } from "@berachain/utils/pkg/swr";
 
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
-export const useAggregatorsRouterFeeBps = () => {
+export function useAggregatorsRouterFeeBps() {
   const publicClient = usePublicClient() as PublicClient;
   const { config } = parseBaseArgs({
     chainId: publicClient.chain?.id,
   });
-  const swrResponse = useSWRImmutable(
+  return useSWRImmutable(
     publicClient &&
       config.bex.aggregatorsRouter &&
       config.bex.aggregatorsRouter !== zeroAddress
@@ -27,9 +27,4 @@ export const useAggregatorsRouterFeeBps = () => {
       return Number(fee);
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: swrResponse.mutate,
-  };
-};
+}

package/src/hooks/dex/useAllUserPools.ts

@@ -5,19 +5,19 @@ import { getAllPools } from "../../actions/dex/getAllPools";
 import { POLLING } from "../../enum/polling";
 import type { DefaultHookOptions } from "../../types/global";
 
-export const useAllUserPoolsQueryKey = ({
+export function useAllUserPoolsQueryKey({
   query,
 }: {
   query?: GetPoolsQueryVariables;
-} = {}) => {
+} = {}) {
   return ["useAllUserPools", query];
-};
+}
 
-export const useAllUserPools = (
+export function useAllUserPools(
   query: GetPoolsQueryVariables,
   options?: DefaultHookOptions,
-) => {
-  const swrResponse = useSWR(
+) {
+  return useSWR(
     useAllUserPoolsQueryKey({ query }),
     async ([_, params]) => {
       return getAllPools({
@@ -30,11 +30,4 @@ export const useAllUserPools = (
       ...options,
     },
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => {
-      swrResponse.mutate();
-    },
-  };
-};
+}

package/src/hooks/dex/useApiPool.ts

@@ -7,15 +7,15 @@ import { getApiPool } from "../../actions/dex/getApiPool";
 import { POLLING } from "../../enum/polling";
 import { InvalidArgumentError } from "../../errors/InvalidArgumentError";
 
-export const useApiPoolQueryKey = ({
+export function useApiPoolQueryKey({
   poolId,
   account,
 }: {
   poolId: Hex;
   account?: Address;
-}) => {
+}) {
   return poolId ? ([`usePool-api`, poolId, account] as const) : null;
-};
+}
 
 export function useApiPool({
   poolId,
@@ -24,7 +24,7 @@ export function useApiPool({
   poolId: Hex;
   account?: Address;
 }) {
-  const res = useSWR(
+  return useSWR(
     useApiPoolQueryKey({ poolId, account }),
     async ([, poolId, account]): Promise<MinimalPoolFragment> => {
       if (account && !isAddress(account)) {
@@ -43,11 +43,4 @@ export function useApiPool({
       refreshInterval: POLLING.NORMAL,
     },
   );
-
-  return {
-    ...res,
-    refresh: () => {
-      res.mutate();
-    },
-  };
 }

package/src/hooks/dex/useCreatePool.ts

@@ -42,7 +42,7 @@ export interface Oracle {
   cacheDuration: number;
 }
 
-const createStablePoolArgs = ({
+function createStablePoolArgs({
   poolCreationHelper,
   poolCreateTokens,
   initialLiquidityTokens,
@@ -70,7 +70,7 @@ const createStablePoolArgs = ({
   message: string;
   actionType: TransactionActionType;
   gasLimit?: bigint;
-}) => {
+}) {
   // Map and sort pool creation token addresses NOTE: we should never see BERA in this array.
   const sortedPoolCreateAddresses = poolCreateTokens
     .map((token) => token.address.toLowerCase())
@@ -149,9 +149,9 @@ const createStablePoolArgs = ({
     typeof balancerPoolCreationHelperAbi,
     "createAndJoinStablePool"
   >;
-};
+}
 
-const createWeightedPoolArgs = ({
+function createWeightedPoolArgs({
   poolCreationHelper,
   poolCreateTokens,
   initialLiquidityTokens,
@@ -177,7 +177,7 @@ const createWeightedPoolArgs = ({
   message: string;
   actionType: TransactionActionType;
   gasLimit?: bigint;
-}) => {
+}) {
   // When joining weighted pools with BERA, we allow it as a joinPoolToken but never as a createPoolToken.
   const createPoolTokens: string[] = [];
   const joinPoolTokens: string[] = [];
@@ -242,9 +242,9 @@ const createWeightedPoolArgs = ({
     typeof balancerPoolCreationHelperAbi,
     "createAndJoinWeightedPool"
   >;
-};
+}
 
-export const useCreatePool = ({
+export function useCreatePool({
   poolCreateTokens,
   initialLiquidityTokens,
   normalizedWeights,
@@ -256,7 +256,7 @@ export const useCreatePool = ({
   amplification,
   oracles,
   ...baseArgs
-}: UseCreatePoolProps): UseCreatePoolReturn => {
+}: UseCreatePoolProps): UseCreatePoolReturn {
   // Generated names
   const { generatedPoolName, generatedPoolSymbol } = useMemo(() => {
     if (!poolCreateTokens) {
@@ -266,11 +266,11 @@ export const useCreatePool = ({
       };
     }
     const generatedPoolName = generatePoolName(poolCreateTokens);
-    const generatedPoolSymbol = generatePoolSymbol(
-      poolCreateTokens,
-      normalizedWeights,
+    const generatedPoolSymbol = generatePoolSymbol({
+      tokens: poolCreateTokens,
+      weights: normalizedWeights,
       poolType,
-    );
+    });
 
     return {
       generatedPoolName,
@@ -349,4 +349,4 @@ export const useCreatePool = ({
     generatedPoolSymbol,
     createPoolArgs,
   };
-};
+}

package/src/hooks/dex/useGlobalLiquidityAndSwapVolume.ts

@@ -2,7 +2,7 @@ import { useSWR } from "@berachain/utils/pkg/swr";
 
 import { getGlobalLiquidityAndSwapVolume } from "../../actions/dex/getGlobalLiquidityAndSwapVolume";
 
-export const useGlobalLiquidityAndSwapVolume = () => {
+export function useGlobalLiquidityAndSwapVolume() {
   const response = useSWR("useGlobalLiquidityAndSwapVolume", async () =>
     getGlobalLiquidityAndSwapVolume(),
   );
@@ -17,6 +17,5 @@ export const useGlobalLiquidityAndSwapVolume = () => {
         response.data?.protocolMetricsAggregated.swapVolume24h,
       ),
     },
-    refresh: () => response.mutate(),
   };
-};
+}

package/src/hooks/dex/useLiquidityMismatch.ts

@@ -39,7 +39,7 @@ interface UseLiquidityMismatchParams {
  * @param {number} liquidityMismatchTolerancePercent - The tolerance for liquidity mismatches in percent.
  * @returns {Object} The liquidity mismatch info.
  */
-export const useLiquidityMismatch = ({
+export function useLiquidityMismatch({
   currentStep,
   tokenPrices,
   isLoadingTokenPrices,
@@ -49,7 +49,7 @@ export const useLiquidityMismatch = ({
   poolType,
   liquidityMismatchTolerancePercent = DEFAULT_LIQUIDITY_MISMATCH_TOLERANCE_PERCENT,
   oracles,
-}: UseLiquidityMismatchParams): LiquidityMismatchInfo => {
+}: UseLiquidityMismatchParams): LiquidityMismatchInfo {
   // NOTE: would be nice to use Maps/Records more in here, as the zipping/unzipping is cumbersome.
   // NOTE: if we pull in string literal for currentStep things would also be a bit clearer in here.
   const [liquidityMismatchInfo, setLiquidityMismatchInfo] =
@@ -189,4 +189,4 @@ export const useLiquidityMismatch = ({
     oracles,
   ]);
   return liquidityMismatchInfo;
-};
+}

package/src/hooks/dex/useLpPosition.ts

@@ -19,10 +19,10 @@ type IUseLpPositionArgs = {
 /**
  * Given a pool and used within an initialized viem context, returns the user's position
  */
-export const useLpPosition = (
+export function useLpPosition(
   { pool, vaultAddress }: IUseLpPositionArgs,
   options?: DefaultHookOptions,
-): DefaultHookReturnType<IUserPosition> => {
+): DefaultHookReturnType<IUserPosition> {
   const { data: userPosition, ...rest } = usePollBalance({
     address: pool?.address,
   });
@@ -116,4 +116,4 @@ export const useLpPosition = (
       refreshVaultDeposit();
     },
   };
-};
+}

package/src/hooks/dex/useOnChainPoolData.ts

@@ -65,7 +65,7 @@ export function useOnChainPoolData(poolId: string) {
     data: poolData,
     error,
     isLoading,
-    mutate,
+    refresh: mutate,
   } = useSWRImmutable(
     // FIXME: why are we using useSWRImmutable when we fetch tokenSupply and swapFee?
     publicClient ? QUERY_KEY : null,
@@ -145,7 +145,6 @@ export function useOnChainPoolData(poolId: string) {
     data: pool,
     error,
     isLoading: isLoading || isTokenInformationLoading || isTokenPricesLoading,
-    mutate,
-    refresh: () => mutate(),
+    refresh: mutate,
   };
 }

package/src/hooks/dex/usePollPoolCreationRelayerApproval.ts

@@ -14,9 +14,9 @@ import { parseBaseArgs } from "../../utils/parseBaseArgs";
  *
  * @returns SWR data spread and refresh function
  */
-export const usePollPoolCreationRelayerApproval = (
+export function usePollPoolCreationRelayerApproval(
   options?: DefaultHookOptions,
-) => {
+) {
   const { address: account } = useBeraWallet();
   const publicClient = usePublicClient();
 
@@ -29,7 +29,7 @@ export const usePollPoolCreationRelayerApproval = (
         ] as const)
       : null;
 
-  const swrResponse = useSWR<boolean>(
+  return useSWR<boolean>(
     QUERY_KEY,
     async ([, account]) => {
       assertPublicClient(publicClient);
@@ -46,10 +46,4 @@ export const usePollPoolCreationRelayerApproval = (
     },
     { ...options },
   );
-
-  const refreshPoolCreationApproval = () => {
-    swrResponse.mutate();
-  };
-
-  return { ...swrResponse, refreshPoolCreationApproval };
-};
+}

package/src/hooks/dex/usePoolEvents.ts

@@ -4,13 +4,13 @@ import { useSWRImmutable } from "@berachain/utils/pkg/swr";
 import { getPoolEvents } from "../../actions/dex/getPoolEvents";
 import { POLLING } from "../../enum/polling";
 
-export const usePoolEvents = ({
+export function usePoolEvents({
   poolId,
   typeInArray,
 }: {
   poolId: string | undefined;
   typeInArray: GqlPoolEventType[];
-}) => {
+}) {
   return useSWRImmutable(
     poolId ? (["usePoolEvents", poolId, typeInArray] as const) : null,
     async ([, poolId, typeInArray]) => getPoolEvents({ poolId, typeInArray }),
@@ -18,4 +18,4 @@ export const usePoolEvents = ({
       refreshInterval: POLLING.SLOW,
     },
   );
-};
+}

package/src/hooks/dex/usePoolHistoricalData.ts

@@ -15,16 +15,16 @@ type UsePoolHistoricalDataArgs = {
   poolId: string | undefined;
 };
 
-export const usePoolHistoricalData = (
+export function usePoolHistoricalData(
   { poolId, ...baseArgs }: UsePoolHistoricalDataArgs & BeraJS.BaseFunctionArgs,
   options?: DefaultHookOptions,
-): DefaultHookReturnType<PoolHistoricalDataFragment[] | undefined> => {
+): DefaultHookReturnType<PoolHistoricalDataFragment[] | undefined> {
   const { config } = parseBaseArgs(baseArgs);
   const QUERY_KEY = poolId
     ? (["usePoolHistoricalData", poolId] as const)
     : null;
 
-  const swrResponse = useSWR<
+  return useSWR<
     PoolHistoricalDataFragment[] | undefined,
     any,
     typeof QUERY_KEY
@@ -38,9 +38,4 @@ export const usePoolHistoricalData = (
     },
     options,
   );
-
-  return {
-    ...swrResponse,
-    refresh: () => void swrResponse.mutate(),
-  };
-};
+}

package/src/hooks/dex/usePools.ts

@@ -9,26 +9,26 @@ import { POLLING } from "../../enum/polling";
 import type { DefaultHookOptions } from "../../types/global";
 import { useAllUserPools } from "./useAllUserPools";
 
-export const usePoolsQueryKey = ({
+export function usePoolsQueryKey({
   query,
 }: {
   query?: GetPoolsQueryVariables;
-} = {}) => {
+} = {}) {
   return ["useAllPools", query];
-};
+}
 /**
  * Returns all pools from bex api, including user's pools if logged in
  * @todo add subgraph fallback
  */
-export const usePools = (
+export function usePools(
   query: GetPoolsQueryVariables,
   options?: DefaultHookOptions,
-) => {
+) {
   const { address: account } = useBeraWallet();
   const {
     data: userPools,
     isLoading: isUserPoolsLoading,
-    mutate: mutateUserPools,
+    refresh: mutateUserPools,
   } = useAllUserPools({
     userAddress: account,
     chain: query.chain,
@@ -37,7 +37,7 @@ export const usePools = (
   const {
     data: pools,
     isLoading: isPoolsLoading,
-    mutate: mutatePools,
+    refresh: mutatePools,
     error: poolsError,
   } = useSWR(
     usePoolsQueryKey({ query }),
@@ -82,4 +82,4 @@ export const usePools = (
     },
     pagination,
   };
-};
+}

package/src/hooks/dex/usePriceImpact.ts

@@ -26,12 +26,12 @@ export function usePriceImpact({
       return undefined;
 
     if (tokenInPrice == null || tokenOutPrice == null) return null;
-    return computePriceImpact(
-      tokenInPrice.toString(),
-      tokenOutPrice.toString(),
-      formattedAmountIn,
-      formattedAmountOut,
-    );
+    return computePriceImpact({
+      tokenInPrice: tokenInPrice.toString(),
+      tokenOutPrice: tokenOutPrice.toString(),
+      inAmount: formattedAmountIn,
+      outAmount: formattedAmountOut,
+    });
   }, [
     tokenIn,
     tokenOut,

package/src/hooks/enso/useBendZapSupply.ts

@@ -151,7 +151,7 @@ export function useBendZapSupply(
     isCrossChain,
     nativeFee,
     refresh: () => {
-      swrResponse.mutate();
+      swrResponse.refresh();
     },
   };
 }

package/src/hooks/enso/useEnsoSwapBundle.ts

@@ -114,7 +114,7 @@ export function useEnsoSwapBundle({
   return {
     ...swrResponse,
     refresh: () => {
-      swrResponse.mutate();
+      swrResponse.refresh();
       refreshBalances();
     },
   };

package/src/hooks/enso/useEnsoUserTokensWithBalances.ts

@@ -29,7 +29,7 @@ export function useEnsoUserTokensWithBalances(
         ] as const)
       : null;
 
-  const swrResponse = useSWR(
+  return useSWR(
     QUERY_KEY,
     async ([, fromAddress, chainId]): Promise<BalanceToken[]> =>
       getEnsoUserTokensWithBalances({
@@ -45,8 +45,4 @@ export function useEnsoUserTokensWithBalances(
       ...options,
     },
   );
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse.mutate(),
-  };
 }

package/src/hooks/enso/useZapStakeBera.ts

@@ -106,8 +106,5 @@ export function useZapStakeBera(
       priceImpactPercentage,
       isCrossChain: inputToken && tokenOut.chainId !== inputToken?.chainId,
     },
-    refresh: () => {
-      swrResponse.mutate();
-    },
   };
 }

package/src/hooks/exports.ts

@@ -82,7 +82,6 @@ export * from "./tokens/usePollAllowances";
 export * from "./tokens/usePollBalance";
 export * from "./tokens/usePollWalletBalances";
 export * from "./tokens/useStakingTokenInformation";
-export * from "./tokens/useTokenCurrentPrice";
 export * from "./tokens/useTokenCurrentPrices";
 export * from "./tokens/useTokenInformation";
 export * from "./tokens/useTokenPrice";
@@ -98,13 +97,10 @@ export * from "./validators/useAllValidators";
 export * from "./validators/useApiEnrichedAllocation";
 export * from "./validators/useApiValidator";
 export * from "./validators/useBaselineRewardAllocation";
-export { useDailyValidatorBlockStats } from "./validators/useDailyValidatorBlockStats";
-export { useDefaultRewardAllocation } from "./validators/useDefaultRewardAllocation";
 export {
   type ManagedValidatorRole,
   useManagedValidatorRole,
 } from "./validators/useManagedValidatorRole";
-export * from "./validators/useOnChainValidator";
 export * from "./validators/useStakingPoolBatch";
 export { useUserActiveValidators } from "./validators/useUserActiveValidators";
 export { useUserBoostsOnValidator } from "./validators/useUserBoostsOnValidator";

package/src/hooks/governance/useCreateProposal.ts

@@ -24,15 +24,15 @@ const defaultAction = {
   message: "",
 } satisfies SafeProposalAction;
 
-export const useCreateProposal = ({
+export function useCreateProposal({
   initialData = {},
   currentTopic,
   onError,
 }: {
-  initialData?: any;
+  initialData?: Partial<CustomProposal>;
   currentTopic: GovernanceTopic;
   onError: (e: CustomProposalErrors) => void;
-}) => {
+}) {
   const [proposal, setProposal] = useState<CustomProposal>({
     title: "",
     description: "",
@@ -85,4 +85,4 @@ export const useCreateProposal = ({
     removeProposalAction,
     computeParamsAndErrors,
   };
-};
+}

package/src/hooks/governance/useGetPastVotes.ts

@@ -13,7 +13,7 @@ import { useProposalSnapshot } from "./useProposalSnapshot";
  * Returns the amount of voting power that a wallet had when the voting period began.
  * {@link https://docs.openzeppelin.com/contracts/5.x/api/governance#Votes-getPastVotes-address-uint256-}
  */
-export const useGetPastVotes = (
+export function useGetPastVotes(
   args: {
     wallet?: Address;
   } & (
@@ -26,7 +26,7 @@ export const useGetPastVotes = (
         timepoint?: number | bigint;
       }
   ),
-) => {
+) {
   const { address: account } = useBeraWallet();
   const publicClient = usePublicClient();
 
@@ -45,20 +45,24 @@ export const useGetPastVotes = (
 
   return useSWRImmutable(QUERY_KEY, async ([, ts, wallet]) => {
     assertPublicClient(publicClient);
-    const { config } = parseBaseArgs({
-      chainId: publicClient.chain.id,
-    });
     if (Number(ts) > Date.now() / 1000) {
       throw new Error("timepoint is in the future");
     }
 
+    // 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,
+    }).config.tokens.bgt;
+
     const votes = await publicClient.readContract({
       abi: bgtAbi,
-      address: config.tokens.bgt,
+      address: tokenAddress,
       functionName: "getPastVotes",
       args: [wallet, BigInt(ts)],
     });
 
     return formatUnits(votes, 18);
   });
-};
+}

package/src/hooks/governance/useHasVoted.ts

@@ -8,13 +8,13 @@ import { useSWR } from "@berachain/utils/pkg/swr";
 import { assertPublicClient } from "../../errors/assert";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
-export const useHasVoted = ({
+export function useHasVoted({
   proposalId,
   wallet,
 }: {
   proposalId: string;
   wallet?: Address;
-}) => {
+}) {
   const { address: account } = useBeraWallet();
   const publicClient = usePublicClient();
 
@@ -36,4 +36,4 @@ export const useHasVoted = ({
       });
     },
   );
-};
+}