@berachain/berajs 0.1.2 → 0.2.1

package/src/actions/dex/aggregators/honey.ts

@@ -1,8 +1,9 @@
-import { BigNumber } from "bignumber.js";
 import { type Address, formatUnits } from "viem";
 
 import { ChainId } from "@berachain/config/internal";
 
+import BigNumber from "@berachain/utils/pkg/bignumber.js";
+
 import {
   getHoneyPreview,
   type HoneyPreviewArgs,
@@ -12,14 +13,15 @@ import { getHoneyVaultsBalance } from "~/actions/honey/getHoneyVaultsBalance";
 import { getSwapPayload } from "~/actions/honey/getSwapPayload";
 import { isBasketModeEnabled } from "~/actions/honey/isBasketModeEnabled";
 import type { HoneyConfigContextReturn } from "~/contexts/HoneyConfigProvider";
+import { Aggregators } from "~/enum/dex";
 import { assertPublicClient } from "~/errors/assert";
 import { BeraError } from "~/errors/BeraError";
 import { InvalidArgumentError } from "~/errors/InvalidArgumentError";
-import {
-  Aggregators,
-  type IAggregatorArgs,
-  type IRawAggregatorQuote,
-  type TokenWithMetadata,
+import type {
+  IAggregatorArgs,
+  IRawAggregatorQuote,
+  Token,
+  TokenWithMetadata,
 } from "~/types/dex";
 import { getHoneyToken, isToken } from "~/utils/tokens";
 import { BaseAggregator } from "./base";
@@ -40,11 +42,12 @@ export class HoneyNativeAggregator extends BaseAggregator {
   readonly type = "rpc";
 
   readonly honeyToken: TokenWithMetadata = getHoneyToken(this);
+
   /**
    * Determines if the swap is a honey mint or redeem based on the tokenIn, tokenOut and the colalterals passed.
    * @returns True if the swap is a honey mint or redeem
    */
-  static isHoneyNativeSwap({
+  isHoneyNativeSwap({
     tokenIn,
     tokenOut,
     honeyNativeState,
@@ -66,6 +69,26 @@ export class HoneyNativeAggregator extends BaseAggregator {
     );
   }
 
+  checkChainSupport({
+    tokenIn,
+    tokenOut,
+    honeyNativeState,
+  }: {
+    tokenIn: Token;
+    tokenOut: Token;
+    honeyNativeState?: Pick<HoneyConfigContextReturn, "collateralList">;
+  }): boolean {
+    return (
+      super.checkChainSupport({ tokenIn, tokenOut }) &&
+      tokenIn.chainId === tokenOut.chainId &&
+      this.isHoneyNativeSwap({
+        tokenIn: tokenIn.address,
+        tokenOut: tokenOut.address,
+        honeyNativeState,
+      })
+    );
+  }
+
   async getQuote({
     tokenIn,
     tokenOut,
@@ -73,7 +96,7 @@ export class HoneyNativeAggregator extends BaseAggregator {
     publicClient,
     account,
     honeyNativeState,
-  }: IHoneyNativeArgs): Promise<IRawAggregatorQuote<false> | undefined> {
+  }: IHoneyNativeArgs): Promise<IRawAggregatorQuote | undefined> {
     const { collateralList: collaterals } = honeyNativeState ?? {};
     if (!collaterals) {
       throw new InvalidArgumentError({
@@ -85,24 +108,10 @@ export class HoneyNativeAggregator extends BaseAggregator {
     }
     assertPublicClient(publicClient);
 
-    this.checkChainSupport();
+    this.assertChainSupport({ tokenIn, tokenOut });
 
     const isMint = isToken(tokenOut, this.honeyToken);
 
-    // these should never happen but just in case
-    // checking that the tokenOut & tokenIn are correct to allow mint or redeem
-    if (
-      !HoneyNativeAggregator.isHoneyNativeSwap({
-        tokenIn: tokenIn as Address,
-        tokenOut: tokenOut as Address,
-        honeyNativeState,
-      })
-    ) {
-      throw new BeraError({
-        message: "Honey Aggregator only supports minting or redeeming Honey",
-      });
-    }
-
     /**
      * The collaterals on Honey are managed with a state that changes the order based on the selected collateral.
      * hub does not do that, so we need to order the collaterals based on the tokenIn.
@@ -112,10 +121,7 @@ export class HoneyNativeAggregator extends BaseAggregator {
 
     // Check if the token requested as collateral is a valid collateral token that can be used to mint or redeem honey
     const collateral = collaterals.find((collateral) =>
-      isToken(
-        collateral.address,
-        isMint ? (tokenIn as Address) : (tokenOut as Address),
-      ),
+      isToken(collateral.address, isMint ? tokenIn.address : tokenOut.address),
     );
     if (!collateral) {
       throw new BeraError({
@@ -190,7 +196,7 @@ export class HoneyNativeAggregator extends BaseAggregator {
 
     // check if the vault has enough liquidity to redeem the collateral
     const haveEnoughLiquidity = !isMint
-      ? new BigNumber(collateralVaultBalance?.formattedBalance ?? "0").gte(
+      ? new BigNumber(collateralVaultBalance?.balance.formatted ?? "0").gte(
           formatUnits(
             collateralsQuote[collateral.address],
             collateral.decimals,
@@ -206,21 +212,18 @@ export class HoneyNativeAggregator extends BaseAggregator {
      * Get the swap payload for the Honey mint
      * If the account is not provided, we will not get the payload
      */
-    const payload = account
-      ? await getSwapPayload({
-          state: {
-            actionType: isMint ? "mint" : "redeem",
-            fromAmount: [honeyFormattedAmountIn],
-            collaterals: hubOrderedCollaterals,
-            isBasketModeEnabled: false, // In Hub, we don't support basket mode
-          },
-          account: account,
-          collateralList: hubOrderedCollaterals,
-          publicClient,
-          priceFeedMap: undefined,
-          isPythWrapperEnabled: false,
-        })
-      : undefined;
+    const payload = await getSwapPayload({
+      state: {
+        actionType: isMint ? "mint" : "redeem",
+        fromAmount: [honeyFormattedAmountIn],
+        collaterals: hubOrderedCollaterals,
+        isBasketModeEnabled: false, // In Hub, we don't support basket mode
+      },
+      collateralList: hubOrderedCollaterals,
+      publicClient,
+      priceFeedMap: undefined,
+      isPythWrapperEnabled: false,
+    });
 
     // In case the user is not connected the payload will not be generated but the preview yes
     if (!payload && account) {
@@ -234,10 +237,16 @@ export class HoneyNativeAggregator extends BaseAggregator {
       amountOut: isMint
         ? honeyQuote.toString()
         : collateralsQuote[collateral.address].toString(),
-      spender: this.config.honey.factory,
+      allowanceRequirements: this.parseAllowanceRequirements({
+        tokenIn,
+        rawAmount: amount,
+        spender: this.config.bex.aggregatorsRouter,
+      }),
       name: Aggregators.Honey,
       swapFeeBps: 0,
-      calldata: payload,
+      getCalldata: ({ account }) => {
+        return payload({ account });
+      },
     };
   }
 }

package/src/actions/dex/aggregators/kyberswap.ts

@@ -3,11 +3,8 @@ import { zeroAddress } from "viem";
 import { ChainId } from "@berachain/config/internal";
 
 import { aggregatorsRouterAbi } from "~/abi/bex/aggregatorsRouter";
-import {
-  Aggregators,
-  type IAggregatorArgs,
-  type IRawAggregatorQuote,
-} from "~/types";
+import { Aggregators } from "~/enum/dex";
+import type { IAggregatorArgs, IRawAggregatorQuote } from "~/types/dex";
 import { BaseAggregator } from "./base";
 
 class KyberSwapAggregator extends BaseAggregator {
@@ -30,13 +27,13 @@ class KyberSwapAggregator extends BaseAggregator {
     proxyAggregatorsThroughVercel = false,
     rewardVault,
   }: IAggregatorArgs): Promise<IRawAggregatorQuote> {
-    this.checkChainSupport();
+    this.assertChainSupport({ tokenIn, tokenOut });
     const {
       isTokenInNative,
       isTokenOutNative,
       tokenInAddress,
       tokenOutAddress,
-    } = this.parseAddresses(tokenIn, tokenOut);
+    } = this.parseAddresses(tokenIn.address, tokenOut.address);
 
     const inputAmountAfterFees = this.getAmountAfterFees(
       amount,
@@ -62,13 +59,14 @@ class KyberSwapAggregator extends BaseAggregator {
     const formattedQuote = {
       amountOut: routeData.data.routeSummary.amountOut,
       amountIn: amount,
-      spender: this.config.bex.aggregatorsRouter,
       name: this.name,
       swapFeeBps: aggregatorsFeeBps!,
-    };
-
-    // If no account, return quote early
-    if (account === zeroAddress) return formattedQuote;
+      allowanceRequirements: this.parseAllowanceRequirements({
+        tokenIn,
+        rawAmount: amount,
+        spender: this.config.bex.aggregatorsRouter,
+      }),
+    } satisfies IRawAggregatorQuote;
 
     // Get the build route data for transaction
     const buildRouteBody = {
@@ -105,35 +103,39 @@ class KyberSwapAggregator extends BaseAggregator {
       isNative: isTokenInNative,
     });
 
-    const outputData = {
-      tokenOut: tokenOutAddress,
-      receiver: account,
-      minAmountOut: this.getMinAmountOut(formattedQuote.amountOut, slippage),
-      isNative: isTokenOutNative,
-    };
-
-    const aggregatorData = {
-      aggregator: buildData.data.routerAddress,
-      data: buildData.data.data,
-    };
-
     return {
       ...formattedQuote,
-      calldata: {
-        params: [
-          inputData,
-          outputData,
-          aggregatorData,
-          {
-            rewardVault: rewardVault ?? zeroAddress,
-            isSwapAndStake: !!rewardVault,
-          },
-        ],
-        functionName: "swap",
-        abi: aggregatorsRouterAbi,
-        // send full amount to router first, which will deduct the swap fee before executing trade
-        value: isTokenInNative ? BigInt(amount) : BigInt("0"),
-        address: this.config.bex.aggregatorsRouter,
+      getCalldata: ({ account }) => {
+        const outputData = {
+          tokenOut: tokenOutAddress,
+          receiver: account,
+          minAmountOut: this.getMinAmountOut(
+            formattedQuote.amountOut,
+            slippage,
+          ),
+          isNative: isTokenOutNative,
+        };
+
+        const aggregatorData = {
+          aggregator: buildData.data.routerAddress,
+          data: buildData.data.data,
+        };
+        return {
+          params: [
+            inputData,
+            outputData,
+            aggregatorData,
+            {
+              rewardVault: rewardVault ?? zeroAddress,
+              isSwapAndStake: !!rewardVault,
+            },
+          ],
+          functionName: "swap",
+          abi: aggregatorsRouterAbi,
+          // send full amount to router first, which will deduct the swap fee before executing trade
+          value: isTokenInNative ? BigInt(amount) : BigInt("0"),
+          address: this.config.bex.aggregatorsRouter,
+        };
       },
     };
   }

package/src/actions/dex/aggregators/oogabooga.ts

@@ -3,11 +3,8 @@ import { zeroAddress } from "viem";
 import { ChainId } from "@berachain/config/internal";
 
 import { aggregatorsRouterAbi } from "~/abi/bex/aggregatorsRouter";
-import {
-  Aggregators,
-  type IAggregatorArgs,
-  type IRawAggregatorQuote,
-} from "~/types";
+import { Aggregators } from "~/enum/dex";
+import type { IAggregatorArgs, IRawAggregatorQuote } from "~/types/dex";
 import { BaseAggregator } from "./base";
 
 class OogaboogaAggregator extends BaseAggregator {
@@ -20,19 +17,18 @@ class OogaboogaAggregator extends BaseAggregator {
     tokenOut,
     amount,
     slippage,
-    account = zeroAddress,
     aggregatorsFeeBps,
     proxyAggregatorsThroughVercel = false,
     rewardVault,
   }: IAggregatorArgs): Promise<IRawAggregatorQuote> {
-    this.checkChainSupport();
+    this.assertChainSupport({ tokenIn, tokenOut });
 
     const {
       tokenInAddress,
       tokenOutAddress,
       isTokenInNative,
       isTokenOutNative,
-    } = this.parseAddresses(tokenIn, tokenOut);
+    } = this.parseAddresses(tokenIn.address, tokenOut.address);
 
     const inputAmountAfterFees = this.getAmountAfterFees(
       amount,
@@ -58,50 +54,55 @@ class OogaboogaAggregator extends BaseAggregator {
     const formattedQuote = {
       amountOut: quote.assumedAmountOut,
       amountIn: amount,
-      spender: this.config.bex.aggregatorsRouter,
+      allowanceRequirements: this.parseAllowanceRequirements({
+        tokenIn,
+        spender: this.config.bex.aggregatorsRouter,
+        rawAmount: amount,
+      }),
       name: this.name,
       priceImpactPercentage: quote.priceImpact,
       swapFeeBps: aggregatorsFeeBps!,
-    };
-
-    // if no account, return quote early
-    if (account === zeroAddress) return formattedQuote;
-
-    const inputData = this.getInputData({
-      tokenIn: tokenInAddress,
-      amountIn: amount,
-      isNative: isTokenInNative,
-    });
-
-    const outputData = {
-      tokenOut: tokenOutAddress,
-      receiver: account,
-      minAmountOut: this.getMinAmountOut(formattedQuote.amountOut, slippage),
-      isNative: isTokenOutNative,
-    };
-
-    const aggregatorData = {
-      aggregator: quote.tx?.to,
-      data: quote.tx?.data,
-    };
+    } satisfies IRawAggregatorQuote;
 
     return {
       ...formattedQuote,
-      calldata: {
-        params: [
-          inputData,
-          outputData,
-          aggregatorData,
-          {
-            rewardVault: rewardVault ?? zeroAddress,
-            isSwapAndStake: !!rewardVault,
-          },
-        ],
-        functionName: "swap",
-        abi: aggregatorsRouterAbi,
-        // send full amount to router first, which will deduct the swap fee before executing trade
-        value: isTokenInNative ? BigInt(amount) : BigInt("0"),
-        address: this.config.bex.aggregatorsRouter,
+      getCalldata: ({ account }) => {
+        const inputData = this.getInputData({
+          tokenIn: tokenInAddress,
+          amountIn: amount,
+          isNative: isTokenInNative,
+        });
+
+        const outputData = {
+          tokenOut: tokenOutAddress,
+          receiver: account,
+          minAmountOut: this.getMinAmountOut(
+            formattedQuote.amountOut,
+            slippage,
+          ),
+          isNative: isTokenOutNative,
+        };
+
+        const aggregatorData = {
+          aggregator: quote.tx?.to,
+          data: quote.tx?.data,
+        };
+        return {
+          params: [
+            inputData,
+            outputData,
+            aggregatorData,
+            {
+              rewardVault: rewardVault ?? zeroAddress,
+              isSwapAndStake: !!rewardVault,
+            },
+          ],
+          functionName: "swap",
+          abi: aggregatorsRouterAbi,
+          // send full amount to router first, which will deduct the swap fee before executing trade
+          value: isTokenInNative ? BigInt(amount) : BigInt("0"),
+          address: this.config.bex.aggregatorsRouter,
+        };
       },
     };
   }

package/src/actions/dex/aggregators/openOcean.ts

@@ -3,13 +3,11 @@ import { zeroAddress } from "viem";
 import { ChainId } from "@berachain/config/internal";
 
 import { aggregatorsRouterAbi } from "~/abi/bex/aggregatorsRouter";
-import { assertPublicClient, InvalidArgumentError } from "~/errors";
+import { Aggregators } from "~/enum/dex";
+import { assertPublicClient } from "~/errors/assert";
+import { InvalidArgumentError } from "~/errors/InvalidArgumentError";
 import { RequestError } from "~/errors/RequestError";
-import {
-  Aggregators,
-  type IAggregatorArgs,
-  type IRawAggregatorQuote,
-} from "~/types";
+import type { IAggregatorArgs, IRawAggregatorQuote } from "~/types/dex";
 import { BaseAggregator } from "./base";
 
 class OpenOceanAggregator extends BaseAggregator {
@@ -26,22 +24,21 @@ class OpenOceanAggregator extends BaseAggregator {
     slippage,
     account = zeroAddress,
     aggregatorsFeeBps,
-    tokenInDecimals,
     publicClient,
     rewardVault,
   }: IAggregatorArgs): Promise<IRawAggregatorQuote> {
     assertPublicClient(publicClient);
 
-    if (!tokenInDecimals) {
+    if (!tokenIn.decimals) {
       throw new InvalidArgumentError({
-        property: "tokenInDecimals",
-        value: tokenInDecimals,
+        property: "tokenIn.decimals",
+        value: tokenIn.decimals,
         expected: "number",
         chainId: this.chainId,
       });
     }
 
-    this.checkChainSupport();
+    this.assertChainSupport({ tokenIn, tokenOut });
 
     const inputAmountAfterFees = this.getAmountAfterFees(
       amount,
@@ -53,7 +50,7 @@ class OpenOceanAggregator extends BaseAggregator {
       tokenOutAddress,
       isTokenInNative,
       isTokenOutNative,
-    } = this.parseAddresses(tokenIn, tokenOut);
+    } = this.parseAddresses(tokenIn.address, tokenOut.address);
 
     const gasPrice = (await publicClient.getGasPrice()).toString();
 
@@ -94,46 +91,54 @@ class OpenOceanAggregator extends BaseAggregator {
     const formattedQuote = {
       amountOut: quoteData.data.outAmount,
       amountIn: amount,
-      spender: this.config.bex.aggregatorsRouter,
+      allowanceRequirements: this.parseAllowanceRequirements({
+        tokenIn,
+        rawAmount: amount,
+        spender: this.config.bex.aggregatorsRouter,
+      }),
       name: this.name,
       swapFeeBps: aggregatorsFeeBps!,
     };
 
-    const inputData = this.getInputData({
-      tokenIn: tokenInAddress,
-      amountIn: amount,
-      isNative: isTokenInNative,
-    });
-
-    const outputData = {
-      tokenOut: tokenOutAddress,
-      receiver: account,
-      minAmountOut: this.getMinAmountOut(formattedQuote.amountOut, slippage),
-      isNative: isTokenOutNative,
-    };
-
-    const aggregatorData = {
-      aggregator: quoteData.data.to,
-      data: quoteData.data.data,
-    };
-
     return {
       ...formattedQuote,
-      calldata: {
-        params: [
-          inputData,
-          outputData,
-          aggregatorData,
-          {
-            rewardVault: rewardVault ?? zeroAddress,
-            isSwapAndStake: !!rewardVault,
-          },
-        ],
-        functionName: "swap",
-        abi: aggregatorsRouterAbi,
-        // send full amount to router first, which will deduct the swap fee before executing trade
-        value: isTokenInNative ? BigInt(amount) : BigInt("0"),
-        address: this.config.bex.aggregatorsRouter,
+      getCalldata: ({ account }) => {
+        const inputData = this.getInputData({
+          tokenIn: tokenInAddress,
+          amountIn: amount,
+          isNative: isTokenInNative,
+        });
+
+        const outputData = {
+          tokenOut: tokenOutAddress,
+          receiver: account,
+          minAmountOut: this.getMinAmountOut(
+            formattedQuote.amountOut,
+            slippage,
+          ),
+          isNative: isTokenOutNative,
+        };
+
+        const aggregatorData = {
+          aggregator: quoteData.data.to,
+          data: quoteData.data.data,
+        };
+        return {
+          params: [
+            inputData,
+            outputData,
+            aggregatorData,
+            {
+              rewardVault: rewardVault ?? zeroAddress,
+              isSwapAndStake: !!rewardVault,
+            },
+          ],
+          functionName: "swap",
+          abi: aggregatorsRouterAbi,
+          // send full amount to router first, which will deduct the swap fee before executing trade
+          value: isTokenInNative ? BigInt(amount) : BigInt("0"),
+          address: this.config.bex.aggregatorsRouter,
+        };
       },
     };
   }