@berachain/berajs 0.1.2 → 0.2.0

package/src/hooks/enso/useZapTransactionRequests.ts

@@ -1,81 +0,0 @@
-"use client";
-
-import useSWR from "swr";
-
-import { POLLING } from "~/enum/polling";
-import { assertAddress, assertAmount, assertDefined } from "~/errors/assert";
-import type {
-  BalanceToken,
-  BalanceTokenWithMetadata,
-  GetZapTransactionResponse,
-} from "~/types";
-import { useEnsoZap } from "./useEnsoZap";
-
-/**
- * Get the zap transaction requests 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: BalanceTokenWithMetadata[], refresh: () => void}}
- *
- * The zap transaction response data with polling enabled, see {@link GetZapTransactionResponse} and {@link BalanceTokenWithMetadata}
- * @remarks The hook is only enabled when all parameters are provided and amount is greater than 0
- * @see {@link useEnsoZap}
- */
-export const useZapTransactionRequests = ({
-  tokenIn,
-  tokenOut,
-  amount,
-  slippage,
-  chainId,
-}: {
-  tokenIn?: Pick<BalanceToken, "address" | "decimals">;
-  tokenOut?: Pick<BalanceToken, "address" | "decimals">;
-  amount?: string;
-  slippage?: number;
-  chainId?: number;
-}) => {
-  const { getZapTransactionRequests, refreshTokens, tokens } = useEnsoZap({
-    chainId,
-  });
-  const isEnabled =
-    !!tokenIn && !!tokenOut && !!amount && Number(amount) > 0 && !!slippage;
-  const QUERY_KEY = isEnabled
-    ? ([
-        "useZapTransactionRequests",
-        tokenIn,
-        tokenOut,
-        amount,
-        slippage,
-      ] as const)
-    : null;
-
-  const swrResponse = useSWR(
-    QUERY_KEY,
-    async ([, tokenIn, tokenOut, amount, slippage]) => {
-      assertDefined(tokenIn, "tokenIn");
-      assertAddress(tokenOut?.address, "tokenOutAddress");
-      assertAmount(amount, "amount");
-      assertAmount(slippage, "slippage");
-      return getZapTransactionRequests({
-        amount,
-        tokenIn: tokenIn,
-        tokenOut: tokenOut.address,
-        slippage,
-      });
-    },
-    {
-      refreshInterval: POLLING.NORMAL,
-      isEnabled: isEnabled,
-    },
-  );
-  return {
-    ...swrResponse,
-    tokens,
-    refresh: () => {
-      swrResponse.mutate();
-      refreshTokens();
-    },
-  };
-};

package/src/hooks/pol/useEarnedStakedBeraVault.ts

@@ -1,59 +0,0 @@
-import useSWR from "swr";
-
-import {
-  GetStakeBeraVaultEarningsByOwner,
-  type GetStakeBeraVaultEarningsByOwnerQuery,
-  type GetStakeBeraVaultEarningsByOwnerQueryVariables,
-} from "@berachain/graphql/pol/api";
-import { useBeraWallet } from "@berachain/wagmi/hooks";
-
-import { getApolloClient } from "~/actions/clients/getApolloClient";
-import { POLLING } from "~/enum/polling";
-import type {
-  DefaultHookOptions,
-  DefaultHookReturnType,
-  TokenWithMetadata,
-} from "~/types";
-
-type UseEarnedStakedBeraVaultArgs = {
-  /**
-   * The token that the user has staked
-   */
-  receiptToken: TokenWithMetadata;
-};
-export function useEarnedStakedBeraVault(
-  { receiptToken }: UseEarnedStakedBeraVaultArgs,
-  opt?: DefaultHookOptions,
-): DefaultHookReturnType<string> {
-  const { address: account } = useBeraWallet();
-
-  const QUERY_KEY =
-    receiptToken.address && account
-      ? (["useEarnedStakedBeraVault", receiptToken.address, account] as const)
-      : null;
-
-  const swrResponse = useSWR(
-    QUERY_KEY,
-    async ([_, , account]) => {
-      const bexApiGraphqlClient = getApolloClient("api", {});
-      const response = await bexApiGraphqlClient.query<
-        GetStakeBeraVaultEarningsByOwnerQuery,
-        GetStakeBeraVaultEarningsByOwnerQueryVariables
-      >({
-        query: GetStakeBeraVaultEarningsByOwner,
-        variables: {
-          owner: account,
-        },
-      });
-      return response.data?.polGetStakeBeraVaultEarningsByOwner?.earnings;
-    },
-    {
-      refreshInterval: POLLING.SLOW,
-      ...opt?.opts,
-    },
-  );
-  return {
-    ...swrResponse,
-    refresh: swrResponse.mutate,
-  };
-}

package/src/hooks/pol/useStakedBeraSnapshots.ts

@@ -1,27 +0,0 @@
-import useSWR from "swr";
-
-import type { GetSWberaVaultSnapshotsQuery } from "@berachain/graphql/pol/api";
-
-import {
-  type GetStakedBeraSnapshotsArgs,
-  getStakedBeraSnapshots,
-} from "~/actions/pol/getStakedBeraSnapshots";
-import type { DefaultHookReturnType } from "~/types/global";
-
-export const useStakedBeraSnapshots = ({
-  range,
-}: GetStakedBeraSnapshotsArgs): DefaultHookReturnType<
-  GetSWberaVaultSnapshotsQuery["polGetSWberaVaultSnapshots"]
-> => {
-  const QUERY_KEY = range ? (["useStakedBeraSnapshots", range] as const) : null;
-  const swrResponse = useSWR(QUERY_KEY, ([, range]) =>
-    getStakedBeraSnapshots({
-      range,
-    }),
-  );
-
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse.mutate(),
-  };
-};

package/src/types/index.ts

@@ -1,8 +0,0 @@
-export * from "./bribe-boost";
-export * from "./dex";
-export * from "./enso";
-export * from "./global";
-export * from "./governance";
-export * from "./honeySwap";
-export * from "./pol";
-export * from "./staking";

package/src/types/staking.ts

@@ -1,7 +0,0 @@
-export interface ProtocolMetadata {
-  name: string;
-  logoURI: string;
-  url: string;
-  description: string;
-  tags?: string[];
-}

package/src/utils/formatAggregatorsQuotes.ts

@@ -1,57 +0,0 @@
-import BigNumber from "bignumber.js";
-import { formatUnits } from "viem";
-
-import type { IAggregatorQuote, IRawAggregatorQuote, Token } from "~/types";
-import { computePriceImpact } from "./math";
-
-export const formatAggregatorsQuotes = (
-  rawQuotes: (IRawAggregatorQuote | IRawAggregatorQuote<false>)[],
-  selectedFrom: Token | undefined,
-  selectedTo: Token | undefined,
-  tokenInPrice: number,
-  tokenOutPrice: number,
-): IAggregatorQuote[] =>
-  rawQuotes
-    .map((quote) => {
-      const amountOut = formatUnits(
-        BigInt(quote.amountOut),
-        selectedTo?.decimals || 18,
-      );
-      const amountIn = formatUnits(
-        BigInt(quote.amountIn),
-        selectedFrom?.decimals || 18,
-      );
-      const amountOutUsd = new BigNumber(amountOut)
-        .times(tokenOutPrice)
-        .toFixed();
-      const amountInUsd = new BigNumber(amountIn).times(tokenInPrice).toFixed();
-      const priceImpactPercentage = computePriceImpact(
-        (tokenInPrice || 0).toString(),
-        (tokenOutPrice || 0).toString(),
-        amountIn,
-        amountOut,
-      );
-      return {
-        ...quote,
-        exchangeRate: new BigNumber(amountOut).div(amountIn).toNumber(),
-        amountIn,
-        amountOut,
-        amountOutUsd,
-        amountInUsd,
-        priceImpactPercentage,
-      };
-    })
-    .sort((a, b) => new BigNumber(b.amountOut).minus(a.amountOut).toNumber())
-    .map((quote, _, allQuotes) => ({
-      ...quote,
-      relativeLossPercentage: computePriceImpact(
-        // hardcoded to 1 since we're calculating relative loss percentage
-        // between this quote's output amount and the best quote's output amount.
-        // The input amounts are the same for all quotes, so we use 1 as a base
-        // to get the pure percentage difference between outputs.
-        "1",
-        "1",
-        allQuotes[0].amountOut,
-        quote.amountOut,
-      ),
-    }));

package/src/utils/formatAggregatorsQuotes.unit.test.ts

@@ -1,191 +0,0 @@
-import { zeroAddress } from "viem";
-import { describe, expect, expectTypeOf, test } from "vitest";
-
-import {
-  Aggregators,
-  type IAggregatorQuote,
-  type IRawAggregatorQuote,
-  type Token,
-} from "~/types/dex";
-import { formatAggregatorsQuotes } from "./formatAggregatorsQuotes";
-
-const mockToken = (symbol: string, decimals: number): Token => ({
-  symbol,
-  decimals,
-  address: zeroAddress,
-  name: symbol,
-  chainId: 1,
-});
-
-const mockCalldata = {
-  params: [],
-  functionName: "",
-  abi: [],
-  address: zeroAddress,
-  value: BigInt(0),
-};
-
-const mockQuotes: IRawAggregatorQuote<false>[] = [
-  {
-    amountOut: "1000000000000000000", // 1 token
-    amountIn: "2000000000000000000", // 2 tokens
-    name: Aggregators.Fly,
-    spender: zeroAddress,
-    calldata: mockCalldata,
-    swapFeeBps: 10,
-  },
-  {
-    amountOut: "1200000000000000000", // 1.2 tokens
-    amountIn: "2000000000000000000", // 2 tokens
-    name: Aggregators.HubPools,
-    spender: zeroAddress,
-    calldata: mockCalldata,
-    swapFeeBps: 10,
-  },
-  {
-    amountOut: "800000000000000000", // 0.8 tokens
-    amountIn: "2000000000000000000", // 2 tokens
-    name: Aggregators.Oogabooga,
-    spender: zeroAddress,
-    calldata: mockCalldata,
-    swapFeeBps: 10,
-  },
-];
-
-describe("formatAggregatorsQuotes", () => {
-  test("should return an empty array if no quotes are provided", () => {
-    expect(formatAggregatorsQuotes([], undefined, undefined, 0, 0)).toEqual([]);
-  });
-
-  test("should return the correct type", () => {
-    const results = formatAggregatorsQuotes(
-      mockQuotes,
-      undefined,
-      undefined,
-      0,
-      0,
-    );
-    expectTypeOf(results).toEqualTypeOf<IAggregatorQuote[]>();
-  });
-
-  test("should sort quotes by amountOut in descending order", () => {
-    const tokenIn = mockToken("TOKEN_IN", 18);
-    const tokenOut = mockToken("TOKEN_OUT", 18);
-
-    const results = formatAggregatorsQuotes(
-      mockQuotes,
-      tokenIn,
-      tokenOut,
-      1,
-      1,
-    );
-
-    expect(results[0].amountOut).toBe("1.2");
-    expect(results[1].amountOut).toBe("1");
-    expect(results[2].amountOut).toBe("0.8");
-  });
-
-  test("should calculate relative loss percentage correctly", () => {
-    const tokenIn = mockToken("ABC", 18);
-    const tokenOut = mockToken("XYZ", 18);
-
-    const results = formatAggregatorsQuotes(
-      mockQuotes,
-      tokenIn,
-      tokenOut,
-      1,
-      1,
-    );
-
-    // best quote has 0% loss
-    expect(results[0].relativeLossPercentage).toBe(0);
-
-    // other quotes show percentage loss relative to best quote
-    expect(results[1].relativeLossPercentage).toBeCloseTo(0.166);
-    expect(results[2].relativeLossPercentage).toBeCloseTo(0.333);
-  });
-
-  test("should handle tokens with different decimals", () => {
-    const tokenIn = mockToken("USDC", 6);
-    const tokenOut = mockToken("ETH", 18);
-
-    const quotesWithDifferentDecimals: IRawAggregatorQuote<false>[] = [
-      {
-        amountOut: "1000000000000000000", // 1 ETH
-        amountIn: "2000000", // 2 USDC
-        name: Aggregators.Fly,
-        spender: zeroAddress,
-        calldata: mockCalldata,
-        swapFeeBps: 10,
-      },
-    ];
-
-    const results = formatAggregatorsQuotes(
-      quotesWithDifferentDecimals,
-      tokenIn,
-      tokenOut,
-      1,
-      1,
-    );
-
-    expect(results[0].amountIn).toBe("2");
-    expect(results[0].amountOut).toBe("1");
-  });
-
-  test("should calculate amountOutUsd correctly", () => {
-    const tokenIn = mockToken("ABC", 18);
-    const tokenOut = mockToken("XYZ", 18);
-    const tokenOutPrice = 100; // $100 per token
-
-    const results = formatAggregatorsQuotes(
-      mockQuotes,
-      tokenIn,
-      tokenOut,
-      1,
-      tokenOutPrice,
-    );
-
-    // amountOutUsd = amountOut * tokenOutPrice
-    expect(results[0].amountOutUsd).toBe("120"); // 1.2 * $100
-    expect(results[1].amountOutUsd).toBe("100"); // 1.0 * $100
-    expect(results[2].amountOutUsd).toBe("80"); // 0.8 * $100
-  });
-
-  test("should calculate amountOutUsd correctly with different decimals", () => {
-    const tokenIn = mockToken("USDC", 6);
-    const tokenOut = mockToken("ETH", 18);
-    const tokenOutPrice = 100.5; // $100.50 per token
-
-    const results = formatAggregatorsQuotes(
-      mockQuotes,
-      tokenIn,
-      tokenOut,
-      1,
-      tokenOutPrice,
-    );
-
-    // amountOutUsd = amountOut * tokenOutPrice
-    expect(results[0].amountOutUsd).toBe("120.6"); // 1.2 * $100.50
-    expect(results[1].amountOutUsd).toBe("100.5"); // 1.0 * $100.50
-    expect(results[2].amountOutUsd).toBe("80.4"); // 0.8 * $100.50
-  });
-
-  test("should calculate price impact when token prices provided", () => {
-    const tokenIn = mockToken("ABC", 18);
-    const tokenOut = mockToken("XYZ", 18);
-
-    const results = formatAggregatorsQuotes(
-      mockQuotes,
-      tokenIn,
-      tokenOut,
-      100, // $100 per token in
-      50, // $50 per token out
-    );
-
-    // For best quote (1.2 out for 2 in):
-    // USD in = 2 * $100 = $200
-    // USD out = 1.2 * $50 = $60
-    // Price impact = 1 - (60/200) = 0.7 = 70%
-    expect(results[0].priceImpactPercentage).toBe(0.7);
-  });
-});

package/src/utils/sentryBeforeSend.ts

@@ -1,52 +0,0 @@
-import type * as SentryType from "@sentry/nextjs";
-
-import { RequestError } from "~/errors/RequestError";
-import { BeraError } from "../errors/BeraError";
-
-/**
- * Util to make Sentry errors consistent with BeraErrors
- * @returns
- */
-export function sentryBeforeSend<
-  TEvent extends SentryType.ErrorEvent,
-  THint extends SentryType.EventHint,
->(
-  event: TEvent,
-  hint: THint,
-): PromiseLike<SentryType.ErrorEvent | null> | SentryType.ErrorEvent | null {
-  const originalException = hint.originalException;
-
-  if (!originalException) {
-    return event;
-  }
-
-  if (originalException instanceof BeraError) {
-    // if it's a bera error, we want to add the tags and level to the event
-    // we're using them as defaults and override them if the captureContext has different values
-
-    event.extra = {
-      ...originalException,
-      ...event.extra,
-    };
-    event.tags = {
-      ...originalException.tags,
-      ...event.tags,
-    };
-    event.level =
-      hint.captureContext && "level" in hint.captureContext
-        ? hint.captureContext.level
-        : originalException.level;
-  }
-
-  if (originalException instanceof TypeError) {
-    // this is either CORS or network error
-    event.extra = { ...originalException };
-    event.tags = {
-      "error.reason": RequestError.isCorsError(originalException)
-        ? RequestError.REASON_MAP.CORS_ERROR
-        : originalException.name,
-      level: "warning",
-    };
-  }
-  return event;
-}