@berachain/berajs 0.1.2 → 0.2.1

package/src/hooks/enso/useBendZapSupply.ts

@@ -0,0 +1,216 @@
+"use client";
+
+import useSWR from "swr";
+import { type Address, formatEther, parseUnits, zeroAddress } from "viem";
+
+import { defaultChainId as berachainChainId } from "@berachain/config/internal";
+
+import { useBeraWallet, usePublicClient } from "@berachain/wagmi/hooks";
+
+import { ensoErc4626 } from "~/actions/dex/aggregators/enso/ensoErc4626";
+import { POLLING } from "~/enum/polling";
+import {
+  assertAddress,
+  assertDefined,
+  assertPublicClient,
+} from "~/errors/assert";
+import { usePollBalance } from "~/hooks/tokens/usePollBalance";
+import type { BalanceToken, MinimalERC20 } from "~/types/dex";
+import type { DefaultHookOptions } from "~/types/global";
+import { isToken } from "~/utils/tokens";
+import { useGetConvertToAssets } from "../bend/useGetConvertToAssets";
+import { usePriceImpact } from "../dex/usePriceImpact";
+import { useTokenPrices } from "../tokens/useTokenPrices";
+
+type UseBendZapSupplyArgs = {
+  /*
+   * The input token to swap from
+   */
+  tokenIn?: BalanceToken;
+  /*
+   * The loan token to swap to
+   */
+  loanToken: MinimalERC20;
+  /*
+   * The bend vault to swap to
+   */
+  bendVault: MinimalERC20;
+  /*
+   * The reward vault to swap to
+   */
+  rewardVault?: Address;
+  /*
+   * The amount of input token to swap
+   */
+  amount?: string;
+  /*
+   * The slippage tolerance to use for the route in percentage
+   */
+  slippage?: number;
+};
+
+/**
+ * Get the bend zap supply transaction requests for swapping tokens using Enso.
+ * @param {UseBendZapSupplyArgs} props - The props for the hook see {@link UseBendZapSupplyArgs}
+ * @returns {DefaultHookReturnType<GetZapTransactionResponse> & {tokens: BalanceToken[], refresh: () => void}}
+ *
+ * The bend transaction response data with polling enabled, see {@link GetZapTransactionResponse} and {@link BalanceToken}
+ * @remarks The hook is only enabled when all parameters are provided and amount is greater than 0
+ */
+export function useBendZapSupply(
+  {
+    tokenIn,
+    loanToken,
+    bendVault,
+    rewardVault,
+    amount,
+    slippage,
+  }: UseBendZapSupplyArgs,
+  options?: DefaultHookOptions,
+) {
+  const { getTokenPrice } = useTokenPrices({
+    tokens: tokenIn && loanToken ? [tokenIn, loanToken] : undefined,
+  });
+
+  const swrResponse = useBendZapSupplyHelper(
+    {
+      tokenIn,
+      loanToken,
+      bendVault,
+      rewardVault,
+      amount: amount
+        ? parseUnits(amount, tokenIn?.decimals ?? 18).toString()
+        : undefined,
+      slippage,
+    },
+    options,
+  );
+
+  const { data: zapSupplyAmount } = useGetConvertToAssets({
+    sharesAmount: BigInt(swrResponse.data?.amountOut ?? 0),
+    vaultAddress: bendVault.address,
+  });
+
+  const { data: priceImpact } = usePriceImpact({
+    tokenIn: tokenIn,
+    tokenOut: loanToken,
+    formattedAmountIn: amount,
+    formattedAmountOut: zapSupplyAmount?.formatted ?? "0",
+  });
+
+  const isCrossChain = tokenIn?.chainId && tokenIn.chainId !== berachainChainId;
+
+  // fetch native token balance for source chain (needed for bridge fee check)
+  const { data: nativeBalanceData, isLoading: isNativeBalanceLoading } =
+    usePollBalance(
+      {
+        address: zeroAddress,
+        chainId: isCrossChain ? tokenIn?.chainId : undefined,
+      },
+      { opts: { isEnabled: !!isCrossChain } },
+    );
+
+  // for cross-chain zaps, check if transaction value exceeds native token balance
+  // (tx.value includes bridge fees that must be paid in native token)
+  const transactionValue =
+    swrResponse.data?.getCalldata?.({ account: zeroAddress })?.value ?? 0n;
+
+  // check if user has enough native token for bridge fees
+  const nativeBalance = nativeBalanceData?.balance ?? {
+    raw: "0",
+    formatted: "0",
+  };
+  const hasInsufficientNativeBalance =
+    isCrossChain &&
+    transactionValue > 0n &&
+    !isNativeBalanceLoading &&
+    transactionValue > BigInt(nativeBalance.raw);
+
+  // formatted native fee for gas reserve display
+  const nativeFee =
+    isCrossChain && transactionValue > 0n
+      ? formatEther(transactionValue)
+      : undefined;
+
+  return {
+    ...swrResponse,
+    zapSupplyAmount,
+    priceImpact,
+    hasInsufficientNativeBalance,
+    isCrossChain,
+    nativeFee,
+    refresh: () => {
+      swrResponse.mutate();
+    },
+  };
+}
+
+export function useBendZapSupplyHelper(
+  {
+    tokenIn,
+    loanToken,
+    bendVault,
+    rewardVault,
+    amount,
+    slippage,
+  }: UseBendZapSupplyArgs,
+  options?: DefaultHookOptions,
+) {
+  const { address: fromAddress } = useBeraWallet();
+
+  const isEnabled =
+    !!tokenIn &&
+    !!loanToken &&
+    !!bendVault &&
+    !!amount &&
+    !!fromAddress &&
+    !isToken(loanToken.address, tokenIn.address) &&
+    tokenIn.chainId &&
+    Number(amount) > 0 &&
+    !!slippage;
+
+  const publicClientBeraChain = usePublicClient();
+  const QUERY_KEY = isEnabled
+    ? ([
+        "useBendZapSupply",
+        tokenIn,
+        loanToken,
+        bendVault,
+        rewardVault,
+        amount,
+        slippage,
+      ] as const)
+    : null;
+
+  return useSWR(
+    QUERY_KEY,
+    async ([
+      ,
+      tokenIn,
+      loanToken,
+      bendVault,
+      rewardVault,
+      amount,
+      slippage,
+    ]) => {
+      assertPublicClient(publicClientBeraChain);
+      assertAddress(fromAddress, "fromAddress");
+      assertAddress(tokenIn?.address, "tokenInAddress");
+      assertDefined(tokenIn?.chainId, "tokenInChainId");
+
+      return await ensoErc4626.getQuote({
+        tokenIn,
+        tokenOut: bendVault,
+        underlyingToken: loanToken,
+        amount,
+        slippage,
+        account: fromAddress,
+        rewardVault,
+      });
+    },
+    {
+      ...options?.opts,
+      refreshInterval: POLLING.NORMAL,
+    },
+  );
+}

package/src/hooks/enso/useEnsoSwapBundle.ts

@@ -0,0 +1,107 @@
+"use client";
+
+import { getPublicClient } from "@wagmi/core";
+import useSWR from "swr";
+import { parseUnits } from "viem";
+
+import { defaultChainId as berachainChainId } from "@berachain/config/internal";
+
+import { useBeraWallet, useConfig } from "@berachain/wagmi/hooks";
+
+import { getEnsoClient } from "~/actions/clients/getEnsoClient";
+import { getEnsoSwapBundle } from "~/actions/enso/getEnsoSwapBundle";
+import { POLLING } from "~/enum/polling";
+import {
+  assertAddress,
+  assertAmount,
+  assertDefined,
+  assertPublicClient,
+} from "~/errors/assert";
+import type { BalanceToken, MinimalERC20 } from "~/types/dex";
+import type { GetZapTransactionResponse } from "~/types/enso";
+import { usePollWalletBalances } from "../tokens/usePollWalletBalances";
+
+/**
+ * Get the swap bundle for swapping tokens using Enso.
+ * @param {Pick<BalanceToken, "address" | "decimals">} tokenIn - The input token to swap from
+ * @param {Pick<BalanceToken, "address" | "decimals">} tokenOut - The output token to swap to
+ * @param {string} amount - The amount of input token to swap
+ * @param {number} slippage - The slippage tolerance to use for the route in percentage
+ * @returns {DefaultHookReturnType<GetZapTransactionResponse> & {tokens: BalanceToken[], refresh: () => void}}
+ *
+ * The zap transaction response data with polling enabled, see {@link GetZapTransactionResponse} and {@link BalanceToken}
+ * @remarks The hook is only enabled when all parameters are provided and amount is greater than 0
+ */
+export function useEnsoSwapBundle({
+  tokenIn,
+  tokenOut,
+  amount,
+  slippage,
+}: {
+  tokenIn?: Pick<MinimalERC20, "address" | "decimals" | "chainId">;
+  tokenOut?: Pick<MinimalERC20, "address" | "decimals">;
+  amount?: string;
+  slippage?: number;
+}) {
+  const { address: fromAddress } = useBeraWallet();
+  const wagmiConfig = useConfig();
+  const ensoClient = getEnsoClient();
+
+  const { refresh: refreshBalances } = usePollWalletBalances();
+
+  const isEnabled =
+    !!tokenIn &&
+    !!tokenOut &&
+    !!amount &&
+    Number(amount) > 0 &&
+    !!slippage &&
+    !!fromAddress &&
+    !!tokenIn.chainId;
+
+  const QUERY_KEY = isEnabled
+    ? (["useEnsoSwapBundle", tokenIn, tokenOut, amount, slippage] as const)
+    : null;
+
+  const swrResponse = useSWR(
+    QUERY_KEY,
+    async ([, tokenIn, tokenOut, amount, slippage]) => {
+      assertAddress(fromAddress, "fromAddress");
+      assertAddress(tokenIn?.address, "tokenInAddress");
+      assertDefined(tokenIn?.chainId, "tokenInChainId");
+      assertAddress(tokenOut?.address, "tokenOutAddress");
+      assertAmount(amount, "amount");
+      assertAmount(slippage, "slippage");
+
+      const publicClient = getPublicClient(wagmiConfig, {
+        chainId: tokenIn.chainId,
+      });
+      assertPublicClient(publicClient);
+
+      const rawAmount = parseUnits(amount, tokenIn.decimals).toString();
+
+      return getEnsoSwapBundle({
+        fromAddress,
+        amountIn: rawAmount,
+        tokenIn: tokenIn.address,
+        tokenOut: tokenOut.address,
+        chainId: tokenIn.chainId,
+        ensoClient,
+        destinationChainId: berachainChainId,
+        slippage,
+        publicClient,
+      });
+    },
+    {
+      refreshInterval: POLLING.NORMAL,
+      isEnabled: isEnabled,
+    },
+  );
+
+  return {
+    ...swrResponse,
+    refresh: () => {
+      swrResponse.mutate();
+      refreshBalances();
+    },
+  };
+}

package/src/hooks/enso/useEnsoUserTokensWithBalances.ts

@@ -0,0 +1,43 @@
+import useSWR from "swr";
+
+import { useBeraWallet, useConfig } from "@berachain/wagmi/hooks";
+
+import { getEnsoClient } from "~/actions/clients/getEnsoClient";
+import { getEnsoUserTokensWithBalances } from "~/actions/enso/getEnsoUserTokensWithBalances";
+import { POLLING } from "~/enum/polling";
+import type { BalanceToken } from "~/types/dex";
+import type { DefaultHookOptions } from "~/types/global";
+
+export function useEnsoUserTokensWithBalances(
+  { chainId }: { chainId?: number } = {},
+  options?: DefaultHookOptions,
+) {
+  const { address: fromAddress } = useBeraWallet();
+  const wagmiConfig = useConfig();
+  const isEnabled = !!fromAddress && (options?.opts?.isEnabled ?? true);
+
+  const QUERY_KEY =
+    isEnabled && wagmiConfig
+      ? (["useEnsoUserTokensWithBalances", fromAddress, chainId] as const)
+      : null;
+
+  const swrResponse = useSWR(
+    QUERY_KEY,
+    async ([, fromAddress, chainId]): Promise<BalanceToken[]> =>
+      getEnsoUserTokensWithBalances({
+        account: fromAddress,
+        wagmiConfig,
+        chainId: chainId ?? "all",
+        ensoClient: getEnsoClient(),
+      }),
+    {
+      refreshInterval: POLLING.NORMAL,
+      isEnabled,
+      ...options?.opts,
+    },
+  );
+  return {
+    ...swrResponse,
+    refresh: () => swrResponse.mutate(),
+  };
+}

package/src/hooks/enso/useZapStakeBera.ts

@@ -0,0 +1,113 @@
+"use client";
+
+import useSWR from "swr";
+import { formatUnits, parseUnits } from "viem";
+
+import { chainConfigs, defaultChainId } from "@berachain/config/internal";
+
+import { useBeraWallet } from "@berachain/wagmi/hooks";
+
+import { ensoErc4626 } from "~/actions/dex/aggregators/enso/ensoErc4626";
+import { POLLING } from "~/enum/polling";
+import type { MinimalERC20 } from "~/types/dex";
+import type { DefaultHookOptions } from "~/types/global";
+import { usePriceImpact } from "../dex/usePriceImpact";
+
+type UseZapStakeBeraArgs = {
+  inputToken: MinimalERC20 | undefined;
+  amount: string;
+  underlyingToken: MinimalERC20 | undefined;
+  slippage?: number;
+  inputTokenPrice?: number;
+  tokenOut: MinimalERC20;
+};
+
+/**
+ * hook to get zap stake BERA transaction data from enso.
+ * supports cross-chain zaps from any chain to berachain staking.
+ */
+export function useZapStakeBera(
+  {
+    inputToken,
+    amount,
+    underlyingToken,
+    slippage,
+    tokenOut,
+  }: UseZapStakeBeraArgs,
+  options?: DefaultHookOptions,
+) {
+  const { address: account } = useBeraWallet();
+  // enso route simulation needs a real EOA-like address; zeroAddress can fail simulation.
+  // use the connected wallet when available, otherwise fallback to our configured aggregator executor.
+  const quoteAccount =
+    account ?? chainConfigs[defaultChainId].bex.aggregatorsRouterExecutor;
+
+  const isEnabled =
+    !!inputToken &&
+    !!amount &&
+    Number(amount) > 0 &&
+    !!inputToken.chainId &&
+    !!underlyingToken &&
+    !!slippage;
+
+  const QUERY_KEY = isEnabled
+    ? ([
+        "useZapStakeBera",
+        inputToken,
+        amount,
+        quoteAccount,
+        slippage,
+        underlyingToken,
+        tokenOut,
+      ] as const)
+    : null;
+
+  const swrResponse = useSWR(
+    QUERY_KEY,
+    async ([
+      ,
+      inputToken,
+      amount,
+      quoteAccount,
+      slippage,
+      underlyingToken,
+      tokenOut,
+    ]) => {
+      const rawAmount = parseUnits(amount, inputToken.decimals).toString();
+
+      return ensoErc4626.getQuote({
+        account: quoteAccount,
+        amount: rawAmount,
+        tokenIn: inputToken,
+        underlyingToken: underlyingToken,
+        tokenOut: tokenOut,
+        slippage,
+      });
+    },
+    {
+      ...options?.opts,
+      refreshInterval: POLLING.NORMAL,
+    },
+  );
+  const { data: priceImpactPercentage } = usePriceImpact({
+    tokenIn: inputToken,
+    tokenOut: tokenOut,
+    formattedAmountIn: amount,
+    formattedAmountOut: formatUnits(
+      BigInt(swrResponse.data?.amountOut ?? "0"),
+      tokenOut.decimals,
+    ),
+  });
+
+  return {
+    ...swrResponse,
+    data: {
+      ...swrResponse.data,
+      priceImpactPercentage,
+      isCrossChain: inputToken && tokenOut.chainId !== inputToken?.chainId,
+    },
+    refresh: () => {
+      swrResponse.mutate();
+    },
+  };
+}

package/src/hooks/{index.ts → exports.ts}

@@ -1,5 +1,5 @@
 /**
- * This file avods more barrel files.
+ * This file avoids more barrel files.
  *
  * It's used to speed up the build process.
  *
@@ -24,9 +24,15 @@ export * from "./dex/usePool";
 export * from "./dex/usePoolEvents";
 export * from "./dex/usePoolHistoricalData";
 export * from "./dex/usePools";
-export * from "./enso/useBendTransactionRequests";
-export * from "./enso/useEnsoZap";
-export * from "./enso/useZapTransactionRequests";
+export * from "./dex/usePriceImpact";
+// let's avoid exporting the raw_useSingleAggregatorQuote hook
+export {
+  USE_AGGREGATORS_QUOTES_QUERY_KEY,
+  useSingleAggregatorQuote,
+} from "./dex/useSingleAggregatorQuote";
+export * from "./enso/useBendZapSupply";
+export * from "./enso/useEnsoSwapBundle";
+export * from "./enso/useZapStakeBera";
 export { useCreateProposal } from "./governance/useCreateProposal";
 export * from "./governance/useGetPastVotes";
 export * from "./governance/useHasVoted";
@@ -57,7 +63,6 @@ export * from "./perps/usePythUpdateFee";
 export * from "./pol/useBgtAprSimulation";
 export { useBgtUnstakedBalance } from "./pol/useBgtUnstakedBalance";
 export { useClaimableFees } from "./pol/useClaimableFees";
-export * from "./pol/useEarnedStakedBeraVault";
 export * from "./pol/useHighestVaultsAPR";
 export * from "./pol/usePollGlobalData";
 export * from "./pol/usePollMarkets";
@@ -70,7 +75,11 @@ export * from "./pol/useRewardVaultIncentives";
 export { useRewardVaultRewards } from "./pol/useRewardVaultRewards";
 export * from "./pol/useRewardVaults";
 export { useRewardVaults } from "./pol/useRewardVaults";
-export * from "./pol/useStakedBeraSnapshots";
+export * from "./pol/useStakedAPR";
+export * from "./pol/useStakedData";
+export * from "./pol/useStakedSnapshots";
+export * from "./pol/useSWBeraVaultMetadata";
+export * from "./pol/useTotalStakedAmount";
 export { useUserVaultInfo } from "./pol/useUserVaultInfo";
 export { useUserVaults } from "./pol/useUserVaults";
 export * from "./pol/useVaultAddress";
@@ -85,12 +94,10 @@ export * from "./tokens/useStakingTokenInformation";
 export * from "./tokens/useTokenCurrentPrice";
 export * from "./tokens/useTokenCurrentPrices";
 export * from "./tokens/useTokenInformation";
+export * from "./tokens/useTokenPrice";
+export * from "./tokens/useTokenPrices";
 export * from "./tokens/useTokens";
 export * from "./tokens/useTotalSupply";
-export * from "./transactions/TransactionStoreContext";
-export * from "./transactions/transactionStore";
-export * from "./transactions/useAddRecentTransaction";
-export * from "./transactions/useRecentTransactions";
 export * from "./useBlockToTimestamp";
 export * from "./useContractWrite";
 export * from "./useGetVerifiedAbi";

package/src/hooks/governance/useCreateProposal.ts

@@ -3,14 +3,14 @@
 import { useCallback, useEffect, useState } from "react";
 
 import { getProposalParams } from "~/actions/governance/getProposalParams";
-import {
-  type CustomProposal,
-  type CustomProposalErrors,
-  type GovernanceTopic,
-  type PROPOSAL_GENRE,
-  ProposalTypeEnum,
-  type SafeProposalAction,
-} from "../../types";
+import { ProposalTypeEnum } from "~/enum/governance";
+import type {
+  CustomProposal,
+  CustomProposalErrors,
+  GovernanceTopic,
+  PROPOSAL_GENRE,
+  SafeProposalAction,
+} from "~/types/governance";
 
 const defaultAction = {
   type: ProposalTypeEnum.CUSTOM_PROPOSAL,

package/src/hooks/governance/usePollAllProposals.ts

@@ -11,7 +11,7 @@ import {
 
 import { getAllProposals } from "~/actions/governance/getAllProposals";
 import { POLLING } from "~/enum/polling";
-import type { DefaultHookOptions } from "~/types";
+import type { DefaultHookOptions } from "~/types/global";
 
 const DEFAULT_PER_PAGE = 10;
 

package/src/hooks/governance/usePollProposal.ts

@@ -10,7 +10,7 @@ import { usePublicClient } from "@berachain/wagmi/hooks";
 import { getProposalDetails } from "~/actions/governance/getProposalDetails";
 import { POLLING } from "~/enum/polling";
 import { assertPublicClient } from "~/errors/assert";
-import type { DefaultHookOptions, DefaultHookReturnType } from "~/types";
+import type { DefaultHookOptions, DefaultHookReturnType } from "~/types/global";
 
 export interface UsePollProposalResponse
   extends DefaultHookReturnType<ProposalWithVotesFragment> {}

package/src/hooks/governance/usePollProposalThreshold.ts

@@ -6,7 +6,7 @@ import { usePublicClient } from "@berachain/wagmi/hooks";
 import { governanceAbi } from "~/abi/governance/governance";
 import { POLLING } from "~/enum/polling";
 import { assertPublicClient } from "~/errors/assert";
-import type { DefaultHookReturnType } from "~/types";
+import type { DefaultHookReturnType } from "~/types/global";
 
 export const usePollProposalThreshold = (
   governorAddress: Address,

package/src/hooks/governance/usePollUserDelegates.ts

@@ -6,7 +6,7 @@ import { useBeraWallet, usePublicClient } from "@berachain/wagmi/hooks";
 import { bgtAbi } from "~/abi/pol/bgt";
 import { POLLING } from "~/enum/polling";
 import { assertPublicClient } from "~/errors/assert";
-import type { DefaultHookOptions, DefaultHookReturnType } from "~/types";
+import type { DefaultHookOptions, DefaultHookReturnType } from "~/types/global";
 import { parseBaseArgs } from "~/utils/parseBaseArgs";
 
 export const usePollUserDelegates = (

package/src/hooks/governance/useProposalState.ts

@@ -4,9 +4,9 @@ import type { Address } from "viem";
 
 import { usePublicClient } from "@berachain/wagmi/hooks";
 
+import { governanceAbi } from "~/abi/governance/governance";
+import { ProposalState } from "~/enum/governance";
 import { assertPublicClient } from "~/errors/assert";
-import { ProposalState } from "~/types";
-import { governanceAbi } from "../../abi/governance/governance";
 
 const ProposalStateMap: Record<ProposalState, string> = {
   [ProposalState.Pending]: "pending",

package/src/hooks/honey/useCappedGlobally.ts

@@ -5,7 +5,8 @@ import { usePublicClient } from "@berachain/wagmi/hooks";
 import { getGlobalCapLimit } from "~/actions/honey/getGlobalCapLimit";
 import { useHoneyConfig } from "~/contexts/HoneyConfigProvider";
 import { assertPublicClient } from "~/errors/assert";
-import type { DefaultHookOptions, DefaultHookReturnType, Token } from "~/types";
+import type { Token } from "~/types/dex";
+import type { DefaultHookOptions, DefaultHookReturnType } from "~/types/global";
 import { usePythLatestPrices } from "./usePythLatestPrices";
 
 export interface UseCappedGloballyResponse

package/src/hooks/honey/useCappedRelatively.ts

@@ -6,7 +6,7 @@ import { usePublicClient } from "@berachain/wagmi/hooks";
 import { getRelativeCapLimit } from "~/actions/honey/getRelativeCapLimit";
 import { useHoneyConfig } from "~/contexts/HoneyConfigProvider";
 import { assertPublicClient } from "~/errors/assert";
-import type { DefaultHookOptions, DefaultHookReturnType } from "~/types";
+import type { DefaultHookOptions, DefaultHookReturnType } from "~/types/global";
 
 export interface UseCappedRelativelyResponse
   extends DefaultHookReturnType<boolean | undefined> {}

package/src/hooks/honey/useCollateralWeights.ts

@@ -6,7 +6,8 @@ import { usePublicClient } from "@berachain/wagmi/hooks";
 import { getCollateralWeights } from "~/actions/honey/getCollateralWeights";
 import { POLLING } from "~/enum/polling";
 import { assertPublicClient } from "~/errors/assert";
-import type { DefaultHookOptions, DefaultHookReturnType, Token } from "~/types";
+import type { Token } from "~/types/dex";
+import type { DefaultHookOptions, DefaultHookReturnType } from "~/types/global";
 
 export interface UseCollateralWeightsResponse
   extends DefaultHookReturnType<Record<Address, bigint> | undefined> {}