@berachain/berajs 0.2.12 → 0.3.0

package/src/actions/enso/__tests__/helpers.ts

@@ -5,14 +5,15 @@ import { ChainId } from "@berachain/config/internal";
 
 import type { Token } from "../../../types/dex";
 
-export const makeToken = (decimals: number, symbol = "T"): Token =>
-  ({
+export function makeToken(decimals: number, symbol = "T"): Token {
+  return {
     address: "0x0000000000000000000000000000000000000001",
     decimals,
     symbol,
     name: symbol,
     chainId: ChainId.MAINNET,
-  }) as Token;
+  } as Token;
+}
 
 export const TEST_ADDRESS = getAddress(
   "0x79f453D56C4bC66586215827FbBc7b34Bc006b33",
@@ -33,10 +34,14 @@ export const MOCK_BUNDLE_RESPONSE = {
   gas: "500000",
 };
 
-export const makeMockEnsoClient = () => ({
-  getBundleData: vi.fn().mockResolvedValue(MOCK_BUNDLE_RESPONSE),
-});
-
-export const makeMockPublicClient = () => ({
-  readContract: vi.fn(),
-});
+export function makeMockEnsoClient() {
+  return {
+    getBundleData: vi.fn().mockResolvedValue(MOCK_BUNDLE_RESPONSE),
+  };
+}
+
+export function makeMockPublicClient() {
+  return {
+    readContract: vi.fn(),
+  };
+}

package/src/actions/enso/getBendMultiplyBundle.ts

@@ -228,7 +228,7 @@ export async function getBendMultiplyBundle({
 
   // -- Callback action indices for `useOutputOfCallAt` references.
   // These MUST match the array position of each action in the callback below.
-  const CALLBACK_IDX_ROUTE_LOAN_TO_COLLATERAL = 0;
+  // Index 0 is the route-loan-to-collateral action (not referenced by index).
   const CALLBACK_IDX_BALANCE_COLLATERAL = 1;
 
   const depositOnlyActions = [

package/src/actions/enso/getEnsoUserTokensWithBalances.ts

@@ -52,22 +52,18 @@ export async function getEnsoUserTokensWithBalances({
   const tokens: BalanceToken[] = ensoBalances.map(
     (balance) =>
       ({
-        name: balance.name,
-        symbol: balance.symbol,
+        name: balance.name ?? "",
+        symbol: balance.symbol ?? "",
         decimals: balance.decimals,
         address: isToken(balance.token, "ETH")
           ? beraToken.address
           : balance.token,
-        logoURI: balance.logoUri,
+        logoURI: balance.logoUri ?? undefined,
         balance: {
           raw: balance.amount.toString(),
           formatted: formatUnits(BigInt(balance.amount), balance.decimals),
         },
-
-        chainId: Number(
-          // @ts-expect-error - balance.chainId is defined just not typed by enso
-          balance.chainId,
-        ),
+        chainId: balance.chainId,
         price: Number(balance.price),
       }) as const satisfies BalanceToken,
   );

package/src/actions/enso/util.ts

@@ -15,7 +15,6 @@ import type { AllowanceQueryItem, Token } from "../../types/dex";
 import type {
   GetEnsoWalletTransactionsWithApprovalArgs,
   GetZapTransactions,
-  GetZapTransactionsArgs,
 } from "../../types/enso";
 
 /**
@@ -35,64 +34,6 @@ function toBigIntOrUndefined(
   return typeof value === "bigint" ? value : BigInt(value);
 }
 
-/**
- * Get the zap transactions for a given bundle.
- * @returns The zap transaction & approval transaction if required.
- */
-export async function getTransactionsFromBundle({
-  fromAddress,
-  amountIn,
-  tokenIn,
-  chainId,
-  ensoClient,
-  bundle,
-  publicClient,
-}: GetZapTransactionsArgs): Promise<GetZapTransactions> {
-  const transactions: GetZapTransactions = [];
-  /**
-   * If the token is not the native token, we need to check if approval is required.
-   */
-  if (tokenIn !== ethAddress) {
-    const approvalRequest = await ensoClient.getApprovalData({
-      fromAddress,
-      tokenAddress: tokenIn,
-      chainId,
-      amount: amountIn,
-    });
-
-    // check if approval is actually required by checking current allowance
-    let requiresApproval = true;
-    if (publicClient) {
-      const currentAllowance = await publicClient.readContract({
-        address: tokenIn as Address,
-        abi: erc20Abi,
-        functionName: "allowance",
-        args: [fromAddress, approvalRequest.spender],
-      });
-      requiresApproval = currentAllowance < BigInt(amountIn);
-    }
-
-    // Only add approval transaction if it's actually required
-    if (requiresApproval) {
-      const approvalValue = toBigIntOrUndefined(approvalRequest.tx.value) ?? 0n;
-      transactions.push({
-        to: approvalRequest.tx.to,
-        data: approvalRequest.tx.data as `0x${string}`,
-        value: approvalValue,
-        gasLimit: BigInt(approvalRequest.gas),
-      });
-    }
-  }
-  const bundleValue = toBigIntOrUndefined(bundle.tx.value) ?? 0n;
-  transactions.push({
-    to: bundle.tx.to,
-    data: bundle.tx.data as `0x${string}`,
-    value: bundleValue,
-    gasLimit: BigInt(bundle.gas),
-  });
-  return transactions;
-}
-
 /**
  * Get ensowallet transactions for a bundle with approval handling.
  * Checks allowance on the ensowallet spender and prepends approval when needed.

package/src/actions/exports.ts

@@ -15,7 +15,8 @@ export {
 } from "./clients/getApolloClient";
 export * from "./clients/getEnsoClient";
 export * from "./dex/aggregators/base";
-export * from "./dex/b-sdk";
+export { ensoErc4626 } from "./dex/aggregators/enso/ensoErc4626";
+export * from "./dex/bSdk";
 export * from "./dex/getAllPools";
 export * from "./dex/getApiPool";
 export * from "./dex/getGlobalLiquidityAndSwapVolume";
@@ -47,32 +48,29 @@ export * from "./pol/getAutoclaimedIncentives";
 export * from "./pol/getAutoclaimedIncentivesTxHash";
 export * from "./pol/getBeraTokenTotalSupply";
 export * from "./pol/getBgtAprSimulation";
-export * from "./pol/getBgtIncentiveDistributorPaused";
 export * from "./pol/getBlockTime";
 export * from "./pol/getEarnedStakedBeraVault";
 export * from "./pol/getGlobalData";
 export * from "./pol/getHeroEarnVaults";
 export * from "./pol/getLSTStakeConfig";
 export * from "./pol/getMarkets";
-export * from "./pol/getRewardProofsByValidator";
 export * from "./pol/getRewardTokenToBeraRate";
 export * from "./pol/getRewardVault";
 export * from "./pol/getRewardVaultDurationConstants";
+export * from "./pol/getRewardVaultEarnedRewards";
 export * from "./pol/getRewardVaultFromToken";
 export * from "./pol/getRewardVaultIncentives";
 export * from "./pol/getRewardVaultRewards";
 export * from "./pol/getRewardVaultStakingToken";
 export * from "./pol/getRewardVaults";
-export * from "./pol/getStakedBeraAPR";
+export * from "./pol/getStakedBeraAPY";
 export * from "./pol/getStakedBeraSnapshots";
 export * from "./pol/getStakeWithdrawalCooldown";
 export * from "./pol/getSWBeraVaultMetadata";
 export * from "./pol/getSWBeraWithdrawal";
 export * from "./pol/getTotalStakedAmount";
-export * from "./pol/getUserClaimableIncentives";
 export * from "./pol/getUserVaultInfo";
 export * from "./pol/getUserVaults";
-export * from "./pol/getUserVaultsReward";
 export * from "./pol/getVaultHistory";
 export * from "./pol/getVaultValidators";
 export * from "./prices/getTokenCurrentPrices";
@@ -87,13 +85,12 @@ export * from "./validators/getActiveBoostAndCommissionChangeDelay";
 export * from "./validators/getAllValidators";
 export * from "./validators/getApiEnrichedAllocation";
 export * from "./validators/getApiValidator";
-export * from "./validators/getDailyValidatorBlockStats";
 export * from "./validators/getDefaultRewardAllocation";
 export * from "./validators/getStakingPoolBatch";
 export * from "./validators/getUserActiveValidators";
+export * from "./validators/getUserBoosts";
 export * from "./validators/getUserBoostsOnValidator";
 export * from "./validators/getUserStakingPositions";
-export * from "./validators/getValidatorAnalytics";
 export * from "./validators/getValidatorCommission";
 export * from "./validators/getValidatorEstimatedBgtPerYear";
 export * from "./validators/getValidatorOperatorAddress";

package/src/actions/governance/getDecodedFunctionData.ts

@@ -93,7 +93,11 @@ async function _getAbiForCallData({
     if (decodeFunctionData({ data: callData, abi: knownAbi })) {
       return knownAbi;
     }
-  } catch {}
+  } catch {
+    // FIXME(coding-standards): error intentionally swallowed; the known ABI
+    // simply doesn't match, so we fall through to fetching the ABI. Preserved
+    // to avoid behavior change.
+  }
 
   return _getAbi({ contractAddress: address, chainId, publicClient }).catch(
     () => undefined,

package/src/actions/honey/getHoney24hVolume.ts

@@ -1,25 +1,16 @@
 import BigNumber from "@berachain/utils/pkg/bignumber.js";
 
-import { BeraError } from "../../errors/BeraError";
 import { fetchBeep } from "../clients/fetchBeep";
 
 /**
- * Browser-only. Sums the last 24 hourly honey snapshots into a 24h volume.
+ * Sums the last 24 hourly honey snapshots into a 24h volume.
  *
  * Reads from the `beep` backend (`fetchBeep`), which exposes `totalVolume` per
- * snapshot.
+ * snapshot. Safe to call from either the browser or the server.
  */
 export async function getHoney24hVolume(): Promise<BigNumber | undefined> {
-  if (typeof window === "undefined") {
-    throw new BeraError({
-      message:
-        "getHoney24hVolume is browser-only; call from a Client Component / SWR hook",
-      level: "error",
-    });
-  }
-
   // beep backend (next-gen), typed against `@berachain/graphql/beep`. Queried
-  // directly from the browser — no Vercel proxy.
+  // directly, no Vercel proxy.
   const snapshots = await fetchBeep("/v0/honey/snapshots/{interval}", {
     path: { interval: "hour" },
     query: { perPage: "24" },

package/src/actions/honey/getHoneyCollaterals.ts

@@ -1,7 +1,7 @@
 import type { PublicClient } from "viem";
 
 import type { Address } from "@berachain/config";
-import type { EdgeConfigSchema } from "@berachain/config/internal/edge-config";
+import type { EdgeConfigSchema } from "@berachain/edge-config";
 
 import { honeyFactoryAbi } from "@berachain/abis/honey/honeyFactory";
 

package/src/actions/honey/getSwapPayload.ts

@@ -32,7 +32,7 @@ interface GetSwapPayloadReturn {
   value: bigint;
 }
 
-export const getSwapPayload = async ({
+export async function getSwapPayload({
   state,
   publicClient,
   priceFeedMap,
@@ -48,7 +48,7 @@ export const getSwapPayload = async ({
   publicClient: PublicClient | undefined;
   priceFeedMap?: PythPriceFeedMap;
   isPythWrapperEnabled: boolean;
-}): Promise<({ account }: { account: Address }) => GetSwapPayloadReturn> => {
+}): Promise<({ account }: { account: Address }) => GetSwapPayloadReturn> {
   const { config } = parseBaseArgs(args);
   const honeyToken = getHoneyToken(args);
   const { actionType, fromAmount, collaterals, isBasketModeEnabled } = state;
@@ -56,7 +56,7 @@ export const getSwapPayload = async ({
     ? config.honey.pythWrapper
     : config.honey.factory;
   const pairMainAddress = collateralList.map((coll) => coll.address);
-  if (fromAmount[0] && !!pairMainAddress.length) {
+  if (fromAmount[0] && pairMainAddress.length) {
     const isMint = actionType === "mint";
     if (isPythWrapperEnabled && publicClient && priceFeedMap) {
       // to mint or redeem we need to update the prices for all the collaterals
@@ -128,4 +128,4 @@ export const getSwapPayload = async ({
   }
 
   throw new Error("Something went wrong while creating the Honey swap payload");
-};
+}

package/src/actions/pol/getAutoclaimedIncentives.ts

@@ -1,7 +1,7 @@
 import type { Address } from "viem";
 
 import { RequestError } from "../../errors/RequestError";
-import type { AutoclaimedIncentivesResponse } from "../../types/bribe-boost";
+import type { AutoclaimedIncentivesResponse } from "../../types/bribeBoost";
 import { beraFetchJson } from "../../utils/beraFetch";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 

package/src/actions/pol/getAutoclaimedIncentivesTxHash.ts

@@ -1,7 +1,7 @@
 import type { Address } from "viem";
 
 import { RequestError } from "../../errors/RequestError";
-import type { AutoclaimedIncentivesTxHashResponse } from "../../types/bribe-boost";
+import type { AutoclaimedIncentivesTxHashResponse } from "../../types/bribeBoost";
 import { beraFetchJson } from "../../utils/beraFetch";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 

package/src/actions/pol/getBeraTokenTotalSupply.ts

@@ -1,14 +1,4 @@
-import { ChainId } from "@berachain/config";
-
-import { beraFetchJson } from "../../utils/beraFetch";
-import { parseBaseArgs } from "../../utils/parseBaseArgs";
-
-interface SupplyMonitorBeraStatsResponse {
-  /** Total BERA supply, in whole BERA units. */
-  totalSupply: number;
-  /** Circulating BERA supply, in whole BERA units. */
-  circulatingSupply: number;
-}
+import { fetchBeep } from "../clients/fetchBeep";
 
 export type GetBeraTokenTotalSupplyArgs = BeraJS.BaseFunctionArgs;
 
@@ -19,27 +9,7 @@ export type GetBeraTokenTotalSupplyArgs = BeraJS.BaseFunctionArgs;
 export async function getBeraTokenTotalSupply(
   args: GetBeraTokenTotalSupplyArgs = {},
 ): Promise<string> {
-  const { config } = parseBaseArgs(args);
-  // supply-monitor only exposes BERA stats for mainnet/bepolia; returns 0 on other chains.
-  const network = config.chainId === ChainId.MAINNET ? "mainnet" : "bepolia";
-
-  // `supplyMonitor` is typed as `HttpLink` (string | { uri, name, ... }).
-  // Both forms are accepted; pick the URL out of whichever shape was used.
-  const supplyMonitor = config.pol.supplyMonitor;
-  const baseUrl =
-    typeof supplyMonitor === "string" ? supplyMonitor : supplyMonitor.uri;
-
-  const data = await beraFetchJson<SupplyMonitorBeraStatsResponse>(
-    {
-      url: `${baseUrl}/api/stats/bera?network=${network}`,
-      name:
-        typeof supplyMonitor === "string"
-          ? "supply-monitor-bera"
-          : supplyMonitor.name,
-      type: "rest",
-    },
-    { cache: "no-store" },
-  );
+  const res = await fetchBeep("/v0/stats/bera", {}, args);
 
-  return data.totalSupply.toString();
+  return res.totalSupply;
 }

package/src/actions/pol/getLSTStakeConfig.ts

@@ -5,7 +5,6 @@ import { lstStakerVaultAbi } from "@berachain/abis/pol/lst/lstStakerVault";
 import { assertPublicClient } from "../../errors/assert";
 import type { TokenWithMetadata } from "../../types/dex";
 import type { StakingConfig } from "../../types/staking";
-import { parseBaseArgs } from "../../utils/parseBaseArgs";
 import { isToken } from "../../utils/tokens";
 
 export type GetLSTStakeConfigArgs = {
@@ -25,11 +24,6 @@ export async function getLSTStakeConfig({
 }: GetLSTStakeConfigArgs): Promise<StakingConfig[]> {
   assertPublicClient(publicClient);
 
-  const { config } = parseBaseArgs({
-    ...args,
-    chainId: publicClient.chain?.id ?? args.chainId,
-  });
-
   const lstStakingTokens = tokenList.filter((token) =>
     lstStakingVaults.includes(token.address),
   );

package/src/actions/pol/{getUserVaultsReward.ts → getRewardVaultEarnedRewards.ts}

@@ -2,6 +2,8 @@ import type { Address, PublicClient } from "viem";
 
 import { rewardVaultAbi } from "@berachain/abis/pol/rewards/rewardVault";
 
+import { assertAddress, assertPublicClient } from "../../errors/assert";
+
 export interface GetUserVaultsInfo {
   account: string | undefined;
   vaultAddress: Address;
@@ -14,14 +16,14 @@ export interface GetUserVaultsInfo {
  * It can also be used to get the claimable fees from the BGT staker
  * @returns
  */
-export async function getUserVaultsReward({
+export async function getRewardVaultEarnedRewards({
   account,
   vaultAddress,
   publicClient,
 }: GetUserVaultsInfo): Promise<bigint> {
-  if (!publicClient) throw new Error("Missing public client");
-  if (!account) throw new Error("Missing user account");
-  if (!vaultAddress) throw new Error("Missing vault address");
+  assertPublicClient(publicClient);
+  assertAddress(account, "account");
+  assertAddress(vaultAddress, "vaultAddress");
 
   return publicClient.readContract({
     address: vaultAddress,

package/src/actions/pol/getSWBeraVaultMetadata.ts

@@ -1,4 +1,4 @@
-import { type Address, erc20Abi, erc4626Abi, type PublicClient } from "viem";
+import { type Address, erc4626Abi, type PublicClient } from "viem";
 
 import BigNumber from "@berachain/utils/pkg/bignumber.js";
 
@@ -7,150 +7,46 @@ import { getStakeWithdrawalCooldown } from "./getStakeWithdrawalCooldown";
 
 export interface VaultMetadata {
   current: {
-    exchangeRate: string;
-    totalSupply: string;
     totalAssets: string;
-    tvl: string;
   };
-  previous: {
-    exchangeRate: string;
-    totalSupply: string;
-    totalAssets: string;
-    tvl: string;
-  };
-  totalWBeraIssued: string;
   lockPeriod?: number;
   address: Address;
 }
 /**
  *
  * @param address - The address of the vault
- * @param underlyingAsset - The address of the vault's underlying asset token
  * @throws {Error} If the vault is not found
  * @returns
  */
 export async function getSWBeraVaultMetadata({
   address,
-  underlyingAsset,
   publicClient,
-  blockTime,
 }: {
   address: Address;
-  underlyingAsset: Address;
   publicClient?: PublicClient;
-  blockTime: number;
 }): Promise<VaultMetadata> {
   assertPublicClient(publicClient);
 
-  const hoursWindow = 26; // 26 hours is the window for the vault to ensure at least 1 claim per APR window.
   try {
-    const currentBlock = await publicClient.getBlock({ blockTag: "latest" });
-
-    const blocksPerWindow = Math.floor((hoursWindow * 60 * 60) / blockTime); // hoursWindow * 60 minutes * 60 seconds / actual block time
-    const blockWindowAgo = currentBlock.number - BigInt(blocksPerWindow);
-
-    const [
-      curretTotalAssets,
-      currentTotalSupply,
-      currentOneShareWorth,
-      currentTVL,
-      totalAssets24HoursAgo,
-      totalSupply24HoursAgo,
-      oneShareWorthWindowAgo,
-      tvl24HoursAgo,
-      underlyingTotalSupply,
-      lockPeriod,
-    ] = await Promise.all([
-      publicClient.readContract({
-        address,
-        abi: erc4626Abi,
-        functionName: "totalAssets",
-      }),
-      publicClient.readContract({
-        address,
-        abi: erc4626Abi,
-        functionName: "totalSupply",
-      }),
-      publicClient.readContract({
-        address,
-        abi: erc4626Abi,
-        functionName: "previewRedeem",
-        args: [10n ** 18n],
-        blockNumber: currentBlock.number,
-      }),
-      publicClient.readContract({
-        address: underlyingAsset,
-        abi: erc20Abi,
-        functionName: "balanceOf",
-        args: [address],
-      }),
+    const [curretTotalAssets, lockPeriod] = await Promise.all([
       publicClient.readContract({
         address,
         abi: erc4626Abi,
         functionName: "totalAssets",
-        blockNumber: blockWindowAgo,
-      }),
-      publicClient.readContract({
-        address,
-        abi: erc20Abi,
-        functionName: "totalSupply",
-        blockNumber: blockWindowAgo,
-      }),
-      publicClient.readContract({
-        address,
-        abi: erc4626Abi,
-        functionName: "previewRedeem",
-        args: [10n ** 18n],
-        blockNumber: blockWindowAgo,
-      }),
-      publicClient.readContract({
-        address: underlyingAsset,
-        abi: erc20Abi,
-        functionName: "balanceOf",
-        args: [address],
-        blockNumber: blockWindowAgo,
-      }),
-      publicClient.readContract({
-        address: underlyingAsset,
-        abi: erc20Abi,
-        functionName: "totalSupply",
       }),
       getStakeWithdrawalCooldown({
         publicClient,
         address,
       }),
     ]);
-    const exchangeRateWindowAgo = new BigNumber(
-      oneShareWorthWindowAgo.toString(),
-    );
-
-    const currentExchangeRate = new BigNumber(currentOneShareWorth.toString());
 
     return {
       address,
       current: {
-        exchangeRate: currentExchangeRate.toString(),
-        totalSupply: new BigNumber(currentTotalSupply.toString())
-          .dividedBy(1e18)
-          .toString(),
         totalAssets: new BigNumber(curretTotalAssets.toString())
           .dividedBy(1e18)
           .toString(),
-        tvl: new BigNumber(currentTVL.toString()).dividedBy(1e18).toString(),
-      },
-      previous: {
-        exchangeRate: exchangeRateWindowAgo.toString(),
-        totalSupply: new BigNumber(totalSupply24HoursAgo.toString())
-          .dividedBy(1e18)
-          .toString(),
-        totalAssets: new BigNumber(totalAssets24HoursAgo.toString())
-          .dividedBy(1e18)
-          .toString(),
-        tvl: new BigNumber(tvl24HoursAgo.toString()).dividedBy(1e18).toString(),
       },
-      totalWBeraIssued: new BigNumber(underlyingTotalSupply.toString())
-        .dividedBy(1e18)
-        .toString(),
       lockPeriod,
     };
   } catch (error) {

package/src/actions/pol/getStakedBeraAPY.ts

@@ -0,0 +1,45 @@
+import type { paths } from "@berachain/graphql/beep";
+
+import { fetchBeep } from "../clients/fetchBeep";
+
+type StakedBeraAPYWindow = "DAY" | "WEEK" | "6HOURS" | "12HOURS" | "18HOURS";
+
+function getBeepResolutionEnum(
+  window: StakedBeraAPYWindow,
+): paths["/v0/stake/apr"]["get"]["parameters"]["query"]["interval"] {
+  switch (window) {
+    case "18HOURS":
+      return "EIGHTEEN_HOURS";
+    case "12HOURS":
+      return "TWELVE_HOURS";
+    case "6HOURS":
+      return "SIX_HOURS";
+    case "DAY":
+      return "ONE_DAY";
+    case "WEEK":
+      return "SEVEN_DAYS";
+  }
+}
+/**
+ *
+ * @throws {Error} If the vault is not found
+ * @returns
+ */
+export async function getStakedBeraAPY({
+  window,
+}: {
+  /**
+   * APY might vary depending on the annualized time window (day or week)
+   */
+  window: StakedBeraAPYWindow;
+} & BeraJS.BaseFunctionArgs): Promise<number> {
+  const { apy } = await fetchBeep("/v0/stake/apr", {
+    query: {
+      interval: getBeepResolutionEnum(window),
+    },
+  });
+
+  // apy can be null if no claims have been made.
+  // this happens only on early stages of the protocol when there are no claims yet.
+  return apy === null ? 0 : Number(apy);
+}