@berachain/berajs 0.1.2 → 0.2.0

package/src/hooks/dex/useAggregatorsQuotes.ts

@@ -1,44 +1,35 @@
 import { useMemo } from "react";
-import useSWR, { type SWRConfiguration } from "swr";
-import { type Address, type PublicClient, parseUnits, zeroAddress } from "viem";
+import { type Address, zeroAddress } from "viem";
 
 import { defaultChainId } from "@berachain/config/internal";
 
 import { useBeraWallet, usePublicClient } from "@berachain/wagmi/hooks";
 
-import { BaseAggregator } from "~/actions/dex/aggregators/base";
 import { bex } from "~/actions/dex/aggregators/bex";
 import { bgtRedeem } from "~/actions/dex/aggregators/bgt";
-import { enso } from "~/actions/dex/aggregators/enso";
+import { enso } from "~/actions/dex/aggregators/enso/enso";
+import { erc4626Deposit } from "~/actions/dex/aggregators/erc4626";
 import { fly } from "~/actions/dex/aggregators/fly";
 import { haiku } from "~/actions/dex/aggregators/haiku";
-import {
-  HoneyNativeAggregator,
-  honeyNative,
-} from "~/actions/dex/aggregators/honey";
+import { honeyNative } from "~/actions/dex/aggregators/honey";
 import { kyberswap } from "~/actions/dex/aggregators/kyberswap";
 import { oogabooga } from "~/actions/dex/aggregators/oogabooga";
 import { openOcean } from "~/actions/dex/aggregators/openOcean";
 import { wberaSwap } from "~/actions/dex/aggregators/wbera";
 import { useBeraFlag } from "~/contexts/BeraFlags/BeraFlags";
-import type {
-  HoneyConfigContextReturn,
-  TokenWithOrder,
-} from "~/contexts/HoneyConfigProvider";
-import { POLLING } from "~/enum";
-import { BeraError } from "~/errors/BeraError";
-import { RequestError } from "~/errors/RequestError";
-import { useAggregatorsRouterFeeBps } from "~/hooks";
-import type {
-  DefaultHookOptions,
-  IRawAggregatorQuote,
-  SwapReferrer,
-} from "~/types";
-import type { Aggregators } from "~/types/dex";
+import type { HoneyConfigContextReturn } from "~/contexts/HoneyConfigProvider";
+import type { SwapReferrer } from "~/enum/dex";
+import { useAggregatorsRouterFeeBps } from "~/hooks/dex/useAggregatorsRouterFeeBps";
+import type { IRawAggregatorQuote, MinimalERC20 } from "~/types/dex";
+import type { DefaultHookOptions } from "~/types/global";
 import { parseBaseArgs } from "~/utils/parseBaseArgs";
-import { seconds } from "~/utils/time";
 import { isToken } from "~/utils/tokens";
+import { useUnderlyingAsset } from "../tokens/useUnderlyingAsset";
 import { useBexStatus } from "./useBexStatus";
+import {
+  getAggregatorsSWROptions,
+  raw_useSingleAggregatorQuote,
+} from "./useSingleAggregatorQuote";
 
 const AGGREGATORS = [
   oogabooga,
@@ -49,13 +40,12 @@ const AGGREGATORS = [
   enso,
   bex,
   honeyNative,
+  erc4626Deposit,
 ];
 
 type IUseAggregatorsQuotesArgs = BeraJS.BaseFunctionArgs & {
-  tokenIn: Address;
-  tokenOut: Address;
-  tokenInDecimals: number;
-  tokenOutDecimals: number;
+  tokenIn: MinimalERC20;
+  tokenOut: MinimalERC20;
   amount: string;
   slippage: number;
   referrer?: SwapReferrer;
@@ -72,141 +62,10 @@ type IUseAggregatorsQuotesArgs = BeraJS.BaseFunctionArgs & {
   >;
 };
 
-type IQueryKey = readonly [
-  string, // "useAggregatorsQuotes
-  string, // name
-  Address, // tokenIn
-  Address, // tokenOut
-  string, // parsedAmount
-  number, // slippage
-  Address | undefined, // account
-  number | undefined, // feeBps
-  number, // tokenInDecimals
-  number, // tokenOutDecimals
-  SwapReferrer | undefined, // referrer
-  Address | undefined, // rewardVault
-  TokenWithOrder[] | undefined, // collateralList
-];
-
-export const USE_AGGREGATORS_QUOTES_QUERY_KEY = "useAggregatorsQuotes";
-
-function getQueryKey({
-  name,
-  account,
-  args,
-  feeBps,
-  options,
-  activeAggregators,
-  honeyNativeState,
-}: {
-  name: Aggregators;
-  account: Address | undefined;
-  args: IUseAggregatorsQuotesArgs;
-  feeBps: number | undefined;
-  options?: DefaultHookOptions;
-  /**
-   * List of active aggregators fetched from edge config flags.
-   *
-   * If undefined, all aggregators are enabled.
-   */
-  activeAggregators: string[] | undefined;
-  honeyNativeState?: Pick<HoneyConfigContextReturn, "collateralList">;
-}): IQueryKey | null {
-  if (name !== bgtRedeem.name) {
-    if (
-      isToken(args.tokenIn, "BGT", { chainId: defaultChainId }) ||
-      isToken(args.tokenOut, "BGT", { chainId: defaultChainId })
-    ) {
-      // can't happen, but just in case
-      return null;
-    }
-  }
-
-  const {
-    tokenIn,
-    tokenOut,
-    tokenInDecimals,
-    tokenOutDecimals,
-    amount,
-    slippage,
-    referrer,
-    rewardVault,
-  } = args;
-  const parsedAmount = parseUnits(amount, tokenInDecimals).toString();
-
-  const isEnabledOnConfig =
-    !activeAggregators ||
-    activeAggregators.includes(name.toLowerCase().replaceAll(" ", ""));
-
-  return options?.opts?.isEnabled &&
-    Number(amount) &&
-    feeBps !== undefined &&
-    isEnabledOnConfig
-    ? [
-        USE_AGGREGATORS_QUOTES_QUERY_KEY,
-        name,
-        tokenIn,
-        tokenOut,
-        parsedAmount,
-        slippage,
-        account,
-        feeBps,
-        tokenInDecimals,
-        tokenOutDecimals,
-        referrer,
-        rewardVault,
-        honeyNativeState?.collateralList,
-      ]
-    : null;
-}
-
-function getQueryFn({
-  aggregator,
-  publicClient,
-  proxyAggregatorsThroughVercel,
-}: {
-  aggregator: BaseAggregator;
-  publicClient?: PublicClient;
-  proxyAggregatorsThroughVercel?: boolean;
-}) {
-  return async ([
-    ,
-    ,
-    tokenIn,
-    tokenOut,
-    amount,
-    slippage,
-    account,
-    aggregatorsFeeBps,
-    tokenInDecimals,
-    tokenOutDecimals,
-    referrer,
-    rewardVault,
-    honeyCollaterals,
-  ]: IQueryKey) =>
-    aggregator.getQuote({
-      tokenIn,
-      tokenOut,
-      amount,
-      slippage,
-      account,
-      aggregatorsFeeBps,
-      tokenInDecimals,
-      tokenOutDecimals,
-      publicClient,
-      proxyAggregatorsThroughVercel,
-      referrer,
-      rewardVault,
-      honeyNativeState: {
-        collateralList: honeyCollaterals ?? [],
-      },
-    });
-}
-
-export const useAggregatorsQuotes = (
+export function useAggregatorsQuotes(
   args: IUseAggregatorsQuotesArgs,
   options?: DefaultHookOptions,
-) => {
+) {
   const { address: account } = useBeraWallet();
   const proxyAggregatorsThroughVercel = useBeraFlag(
     "proxyAggregatorsThroughVercel",
@@ -215,20 +74,20 @@ export const useAggregatorsQuotes = (
   const publicClient = usePublicClient();
   const { data: feeBps } = useAggregatorsRouterFeeBps();
 
-  const { collateralList: collaterals, protocol: honeyProtocol } =
-    args.honeyNativeState ?? {};
-
   const isWrapOrUnwrap =
-    (isToken(args.tokenIn, "BERA") || isToken(args.tokenIn, "WBERA")) &&
-    (isToken(args.tokenOut, "BERA") || isToken(args.tokenOut, "WBERA"));
+    (isToken(args.tokenIn.address, "BERA") ||
+      isToken(args.tokenIn.address, "WBERA")) &&
+    (isToken(args.tokenOut.address, "BERA") ||
+      isToken(args.tokenOut.address, "WBERA"));
 
-  const isBgtRedeem = isToken(args.tokenIn, "BGT", { chainId: defaultChainId });
+  const isBgtRedeem = isToken(args.tokenIn.address, "BGT", {
+    chainId: defaultChainId,
+  });
+
+  const { data: underlyingToken } = useUnderlyingAsset({
+    token: args.tokenOut,
+  });
 
-  // retrieve the honey collaterals in order to check if the swap is a honey mint or redeem
-  const isHoneyNative = useMemo(
-    () => HoneyNativeAggregator.isHoneyNativeSwap(args),
-    [args.tokenOut, args.tokenIn, collaterals],
-  );
   /**
    * Whether it's a native swap (wrap/unwrap) or BGT redeem
    */
@@ -238,224 +97,126 @@ export const useAggregatorsQuotes = (
 
   const isMAEnabled = config.bex.aggregatorsRouter !== zeroAddress;
 
-  const swrOptions: SWRConfiguration = {
-    refreshInterval: POLLING.FAST, // every 10s
-    errorRetryCount: 3,
-    // biome-ignore lint/nursery/useMaxParams: the function is defined in the SWRConfiguration type
-    onErrorRetry(err, key, config, revalidate, revalidateOpts) {
-      if (err instanceof BeraError) {
-        if (err.reason === BaseAggregator.PATH_NOT_FOUND_REASON) {
-          return;
-        }
-      }
-
-      if (err instanceof RequestError && err.statusCode === 403) {
-        console.warn(key[1], "returned error 403, stopping retries");
-        return;
-      }
-
-      if (revalidateOpts.retryCount > (config.errorRetryCount ?? 3)) {
-        return;
-      }
-
-      setTimeout(() => {
-        revalidate();
-      }, config.errorRetryInterval ?? seconds(10));
-    },
-  };
+  const swrOptions = getAggregatorsSWROptions(options);
+
+  const sharedArgs = {
+    activeAggregators,
+    isMAEnabled,
+    underlyingToken,
+    isNativeSwap,
+    account,
+    publicClient,
+    proxyAggregatorsThroughVercel,
+    feeBps,
+  } as const;
 
   // we're using independent useSWRs so we can show quotes as they come
   // instead of waiting for all of them to load
-  const oogaBogaResult = useSWR(
-    isNativeSwap || !isMAEnabled
-      ? null
-      : getQueryKey({
-          name: oogabooga.name,
-          account,
-          args,
-          feeBps,
-          options,
-          activeAggregators,
-        }),
-    getQueryFn({ aggregator: oogabooga, proxyAggregatorsThroughVercel }),
-    swrOptions,
+  const oogaBogaResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: oogabooga,
+    },
+    { opts: swrOptions },
+  );
+
+  const flyResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: fly,
+    },
+    { opts: swrOptions },
   );
-  const flyResult = useSWR(
-    isNativeSwap || !isMAEnabled
-      ? null
-      : getQueryKey({
-          name: fly.name,
-          account,
-          args,
-          feeBps,
-          options,
-          activeAggregators,
-        }),
-    getQueryFn({ aggregator: fly, proxyAggregatorsThroughVercel }),
-    swrOptions,
+
+  const erc4626Result = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: erc4626Deposit,
+    },
+    { opts: swrOptions },
   );
-  const kyberswapResult = useSWR(
-    isNativeSwap || !isMAEnabled
-      ? null
-      : getQueryKey({
-          name: kyberswap.name,
-          account,
-          args,
-          feeBps,
-          options,
-          activeAggregators,
-        }),
-    getQueryFn({ aggregator: kyberswap, proxyAggregatorsThroughVercel }),
-    swrOptions,
+
+  const kyberswapResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: kyberswap,
+    },
+    { opts: swrOptions },
   );
-  const openOceanResult = useSWR(
-    isNativeSwap || !isMAEnabled
-      ? null
-      : getQueryKey({
-          name: openOcean.name,
-          account,
-          args,
-          feeBps,
-          options,
-          activeAggregators,
-        }),
-    getQueryFn({
+
+  const openOceanResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
       aggregator: openOcean,
-      publicClient,
-      proxyAggregatorsThroughVercel,
-    }),
-    swrOptions,
+    },
+    { opts: swrOptions },
   );
-  const haikuResult = useSWR(
-    isNativeSwap || !isMAEnabled
-      ? null
-      : getQueryKey({
-          name: haiku.name,
-          account,
-          args,
-          feeBps,
-          options,
-          activeAggregators,
-        }),
-    getQueryFn({
-      aggregator: haiku,
-      publicClient,
-      proxyAggregatorsThroughVercel,
-    }),
 
-    swrOptions,
+  const haikuResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: haiku,
+    },
+    { opts: swrOptions },
   );
-  const ensoResult = useSWR(
-    isNativeSwap || !isMAEnabled
-      ? null
-      : getQueryKey({
-          name: enso.name,
-          account,
-          args,
-          feeBps,
-          options,
-          activeAggregators,
-        }),
-    getQueryFn({ aggregator: enso, proxyAggregatorsThroughVercel }),
-    swrOptions,
+
+  const ensoResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: enso,
+    },
+    { opts: swrOptions },
   );
+
   const { protocol: bexProtocol } = useBexStatus();
 
-  const bexResult = useSWR(
-    isNativeSwap ||
-      // dont use undefined as falsy
-      bexProtocol.isPaused === true ||
-      // BEX is not able to stake in a single transaction
-      args.rewardVault
-      ? null
-      : getQueryKey({
-          name: bex.name,
-          account,
-          args,
-          // Always zero on bex swaps
-          feeBps: 0,
-          options,
-          activeAggregators,
-        }),
-    getQueryFn({ aggregator: bex, publicClient }),
-    swrOptions,
-  );
-  const wberaSwapResult = useSWR(
-    isWrapOrUnwrap
-      ? getQueryKey({
-          name: wberaSwap.name,
-          account,
-          args,
-          // Always 0 for wrap/unwrap
-          feeBps: 0,
-          options,
-          // wbera is always enabled
-          activeAggregators: undefined,
-        })
-      : null,
-    async ([, , tokenIn, tokenOut, amount, , account]: IQueryKey) => {
-      return wberaSwap.getQuote({
-        tokenIn,
-        tokenOut,
-        amount,
-        account,
-      });
+  const bexResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: bex,
     },
-    swrOptions,
+    { opts: { ...swrOptions, isEnabled: bexProtocol.isPaused === false } },
   );
-  const bgtRedeemResult = useSWR(
-    isBgtRedeem
-      ? getQueryKey({
-          name: bgtRedeem.name,
-          account,
-          args,
-          // Always 0 for native swaps
-          feeBps: 0,
-          options,
-          // BGT redeem is always enabled
-          activeAggregators: undefined,
-        })
-      : null,
-    async ([, , tokenIn, , amount]: IQueryKey) => {
-      return bgtRedeem.getQuote({
-        tokenIn,
-        amount,
-      });
+
+  const wberaSwapResult = raw_useSingleAggregatorQuote({
+    ...sharedArgs,
+    ...args,
+    aggregator: wberaSwap,
+  });
+
+  const bgtRedeemResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
+      aggregator: bgtRedeem,
     },
-    swrOptions,
+    { opts: swrOptions },
   );
-  const honeyResult = useSWR(
-    !isHoneyNative ||
-      isNativeSwap ||
-      honeyProtocol?.isPaused === true ||
-      !collaterals
-      ? null
-      : getQueryKey({
-          name: honeyNative.name,
-          account,
-          args,
-          // Always 0 for honey mint/redeem
-          feeBps: 0,
-          options,
-          // honey mint/redeem is always enabled
-          activeAggregators: undefined,
-          honeyNativeState: {
-            collateralList: collaterals,
-          },
-        }),
-    getQueryFn({
+
+  const honeyResult = raw_useSingleAggregatorQuote(
+    {
+      ...sharedArgs,
+      ...args,
       aggregator: honeyNative,
-      publicClient,
-      proxyAggregatorsThroughVercel,
-    }),
-    swrOptions,
+    },
+    { opts: swrOptions },
   );
+
   const results = isWrapOrUnwrap
     ? [wberaSwapResult]
     : isBgtRedeem
       ? [bgtRedeemResult]
       : [
           oogaBogaResult,
+          erc4626Result,
           flyResult,
           kyberswapResult,
           openOceanResult,
@@ -499,4 +260,4 @@ export const useAggregatorsQuotes = (
     ...data,
     refresh: () => results.map((r) => r.mutate()),
   };
-};
+}

package/src/hooks/dex/useAllUserPools.ts

@@ -4,7 +4,7 @@ import type { GetPoolsQueryVariables } from "@berachain/graphql/dex/api";
 
 import { getAllPools } from "~/actions/dex/getAllPools";
 import { POLLING } from "~/enum/polling";
-import type { DefaultHookOptions } from "~/types";
+import type { DefaultHookOptions } from "~/types/global";
 
 export const useAllUserPoolsQueryKey = ({
   query,

package/src/hooks/dex/useApiPool.ts

@@ -5,7 +5,7 @@ import type { MinimalPoolFragment } from "@berachain/graphql/dex/api";
 
 import { getApiPool } from "~/actions/dex/getApiPool";
 import { POLLING } from "~/enum/polling";
-import { InvalidArgumentError } from "~/errors";
+import { InvalidArgumentError } from "~/errors/InvalidArgumentError";
 
 export const useApiPoolQueryKey = ({
   poolId,

package/src/hooks/dex/useCreatePool.ts

@@ -18,8 +18,9 @@ import {
 import { balancerPoolCreationHelperAbi } from "~/abi/bex/balancerPoolCreationHelper";
 import { getApolloClient } from "~/actions/clients/getApolloClient";
 import { TransactionActionType } from "~/enum/txnEnum";
-import type { IContractWrite, Token, TokenInput } from "~/types";
-import { DEFAULT_METAMASK_GAS_LIMIT } from "~/utils";
+import type { Token, TokenWithAmount } from "~/types/dex";
+import type { IContractWrite } from "~/types/global";
+import { DEFAULT_METAMASK_GAS_LIMIT } from "~/utils/constants";
 import { parseBaseArgs } from "~/utils/parseBaseArgs";
 import { generatePoolName, generatePoolSymbol } from "~/utils/poolNamings";
 import { isToken } from "~/utils/tokens";
@@ -28,7 +29,7 @@ import { wrapNativeTokens } from "~/utils/tokenWrapping";
 const DEFAULT_WEIGHTS_DUPLICATION_THRESHOLD = 0.005;
 interface UseCreatePoolProps extends BeraJS.BaseFunctionArgs {
   poolCreateTokens: Token[];
-  initialLiquidityTokens: TokenInput[];
+  initialLiquidityTokens: TokenWithAmount[];
   normalizedWeights: bigint[]; // NOTE: if you pass weights that have off-by-1 errors pool create will fail (ex: 0.3 repeating)
   poolType: PoolType;
   swapFee: number;
@@ -78,7 +79,7 @@ const createStablePoolArgs = ({
 }: {
   poolCreationHelper: Address;
   poolCreateTokens: Token[];
-  initialLiquidityTokens: TokenInput[];
+  initialLiquidityTokens: TokenWithAmount[];
   swapFeePercentage: bigint;
   salt: string;
   poolName: string;
@@ -186,7 +187,7 @@ const createWeightedPoolArgs = ({
 }: {
   poolCreationHelper: Address;
   poolCreateTokens: Token[];
-  initialLiquidityTokens: TokenInput[];
+  initialLiquidityTokens: TokenWithAmount[];
   normalizedWeights: bigint[];
   swapFeePercentage: bigint;
   salt: string;

package/src/hooks/dex/useExploitedTokens.ts

@@ -5,7 +5,7 @@ import { usePublicClient } from "@berachain/wagmi/hooks";
 
 import { getIsTokenExploited } from "~/actions/dex/getIsTokenExploited";
 import { assertPublicClient } from "~/errors/assert";
-import type { Token } from "~/types";
+import type { Token } from "~/types/dex";
 
 export const useExploitedTokensQueryKey = (tokens: Token[] | undefined) => {
   const filteredTokens = tokens?.filter((token) => token.address);

package/src/hooks/dex/useLiquidityMismatch.ts

@@ -1,11 +1,8 @@
 import { useEffect, useState } from "react";
 import { PoolType } from "@berachain-foundation/berancer-sdk";
 
-import {
-  PoolCreationStep,
-  type TokenCurrentPriceMap,
-  type TokenWithAmount,
-} from "~/types";
+import { PoolCreationStep } from "~/enum/dex";
+import type { TokenCurrentPriceMap, TokenWithAmount } from "~/types/dex";
 import { wrapNativeTokens } from "~/utils/tokenWrapping";
 import { type Oracle, OracleMode } from "./useCreatePool";