@berachain/berajs 0.2.12 → 0.3.0

package/src/actions/pol/getStakedBeraSnapshots.ts

@@ -1,17 +1,21 @@
-import {
-  GetSWberaVaultSnapshots,
-  type GetSWberaVaultSnapshotsQuery,
-  type GetSWberaVaultSnapshotsQueryVariables,
-  type GqlChain,
-  GqlVaultSnapshotDataRange,
-} from "@berachain/graphql/pol/api";
+import type { paths } from "@berachain/graphql/beep";
 
-import { parseBaseArgs } from "../../utils/parseBaseArgs";
-import { getApolloClient } from "../clients/getApolloClient";
+import { fetchBeep } from "../clients/fetchBeep";
+
+/**
+ * Look-back span (in days) for the beep sWBERA APR history endpoint.
+ * The values are the literal `days` query params accepted by
+ * `/v0/stake/apr/history`, so they can be passed straight through.
+ */
+export enum StakeSnapshotRange {
+  SevenDays = "7",
+  ThirtyDays = "30",
+  SixtyDays = "60",
+  NinetyDays = "90",
+}
 
 export type GetStakedBeraSnapshotsArgs = {
-  chain?: GqlChain;
-  range?: GqlVaultSnapshotDataRange;
+  range?: StakeSnapshotRange;
 } & BeraJS.BaseFunctionArgs;
 
 /**
@@ -20,29 +24,9 @@ export type GetStakedBeraSnapshotsArgs = {
  * @returns
  */
 export async function getStakedBeraSnapshots({
-  chain,
-  range = GqlVaultSnapshotDataRange.ThirtyDays,
-  ...args
+  range = StakeSnapshotRange.ThirtyDays,
 }: GetStakedBeraSnapshotsArgs = {}): Promise<
-  GetSWberaVaultSnapshotsQuery["polGetSWberaVaultSnapshots"]
+  paths["/v0/stake/apr/history"]["get"]["responses"]["200"]["content"]["application/json"]
 > {
-  const { config } = parseBaseArgs(args);
-  const bexApiGraphqlClient = getApolloClient("api", args);
-  try {
-    const data = await bexApiGraphqlClient.query<
-      GetSWberaVaultSnapshotsQuery,
-      GetSWberaVaultSnapshotsQueryVariables
-    >({
-      query: GetSWberaVaultSnapshots,
-      variables: {
-        chain: chain ?? (config.bex.chainName as GqlChain),
-        range,
-      },
-    });
-
-    return data.data.polGetSWberaVaultSnapshots;
-  } catch (error) {
-    console.error("Failed to get SW Bera Snapshots", error);
-    throw error;
-  }
+  return await fetchBeep("/v0/stake/apr/history", { query: { days: range } });
 }

package/src/actions/pol/getUserVaultInfo.ts

@@ -1,8 +1,8 @@
 import { type Address, formatEther, type PublicClient } from "viem";
 
 import type { UserVaultInfo } from "../../types/pol";
+import { getRewardVaultEarnedRewards } from "./getRewardVaultEarnedRewards";
 import { getUserVaultsBalance } from "./getUserVaultsBalance";
-import { getUserVaultsReward } from "./getUserVaultsReward";
 import { getVaultsSupply } from "./getVaultsSupply";
 
 export interface GetUserVaultInfoParams {
@@ -22,7 +22,7 @@ export async function getUserVaultInfo({
       vaultAddress,
       publicClient,
     }),
-    getUserVaultsReward({
+    getRewardVaultEarnedRewards({
       account,
       vaultAddress,
       publicClient,

package/src/actions/pol/getVaultsSupply.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 GetVaultsSupply {
   vaultAddress: Address;
   publicClient: PublicClient | undefined;
@@ -11,8 +13,9 @@ export async function getVaultsSupply({
   vaultAddress,
   publicClient,
 }: GetVaultsSupply): Promise<bigint> {
-  if (!publicClient) throw new Error("Missing public client");
-  if (!vaultAddress) throw new Error("Missing vault address");
+  assertPublicClient(publicClient);
+  assertAddress(vaultAddress, "vaultAddress");
+
   try {
     const result = await publicClient.readContract({
       address: vaultAddress,

package/src/actions/server/getDailyValidatorBlockStats.ts

@@ -1,12 +1,11 @@
 import type { Address } from "viem";
 
-import {
-  GetValidatorBlockStats,
-  type GetValidatorBlockStatsQuery,
-  type GetValidatorBlockStatsQueryVariables,
-} from "@berachain/graphql/pol/subgraph";
+import type {
+  BlocksBlockStatsResponse,
+  ValidatorBlockStatsResponse,
+} from "@berachain/graphql/beep";
 
-import { getApolloClient } from "../clients/getApolloClient";
+import { fetchBeep } from "../clients/fetchBeep";
 
 /**
  * Server-only RSC variant. Goes directly to the pol subgraph upstream
@@ -15,19 +14,31 @@ import { getApolloClient } from "../clients/getApolloClient";
 export async function getDailyValidatorBlockStats({
   pubKey,
   first = 1,
-  ...args
 }: BeraJS.BaseFunctionArgs & {
   pubKey: Address;
   first?: number;
-}): Promise<GetValidatorBlockStatsQuery | undefined> {
-  const client = getApolloClient("pol.subgraph", args);
+}): Promise<{
+  validatorBlockStats: ValidatorBlockStatsResponse;
+  blockStats: BlocksBlockStatsResponse;
+}> {
+  const [validatorBlockStats, blockStats] = await Promise.all([
+    fetchBeep("/v0/validators/{pubkey}/block-stats", {
+      path: { pubkey: pubKey },
+      query: {
+        interval: "day",
+        perPage: first.toString(),
+      },
+    }),
+    fetchBeep("/v0/blocks/block-stats", {
+      query: {
+        interval: "day",
+        perPage: first.toString(),
+      },
+    }),
+  ]);
 
-  const result = await client.query<
-    GetValidatorBlockStatsQuery,
-    GetValidatorBlockStatsQueryVariables
-  >({
-    query: GetValidatorBlockStats,
-    variables: { pubKey, first },
-  });
-  return result.data;
+  return {
+    validatorBlockStats: validatorBlockStats,
+    blockStats: blockStats,
+  };
 }

package/src/actions/tokens/getWalletBalances.ts

@@ -70,10 +70,8 @@ export async function getWalletBalances({
   wagmiConfig: config,
 }: GetWalletBalances): Promise<BalanceToken[] | undefined> {
   assertDefined(config, "config");
-  if (!account || !tokenList)
-    throw new Error("account or tokenList is not defined");
-
   assertAddress(account, "account");
+  assertDefined(tokenList, "tokenList");
 
   const filteredTokenList = tokenList.filter((token) =>
     isAddress(token.address),

package/src/actions/transactions/beraWriteContract.integration.test.ts

@@ -1,5 +1,8 @@
 import {
+  type Abi,
   type Address,
+  type ContractFunctionArgs,
+  type ContractFunctionName,
   createWalletClient,
   encodeFunctionData,
   erc20Abi,
@@ -19,7 +22,7 @@ import { rewardVaultAbi } from "@berachain/abis/pol/rewards/rewardVault";
 import { getConfig } from "@berachain/wagmi/config";
 
 import { TransactionActionType } from "../../enum/txnEnum";
-import type { IContractWriteFn } from "../../types/global";
+import type { IContractWrite } from "../../types/global";
 import { getServerSidePublicClient } from "../../utils/getServerSideClient";
 import { getTestClient } from "../../utils/getTestClient";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
@@ -28,9 +31,19 @@ import { testTransports } from "../__test/transports";
 import { getUserVaults } from "../pol/getUserVaults";
 import { beraWriteContract } from "./beraWriteContract";
 
-const testFn: IContractWriteFn = async (_args) => {
+async function testFn<
+  abi extends Abi | undefined = undefined,
+  functionName extends abi extends Abi
+    ? ContractFunctionName<abi>
+    : never = abi extends Abi ? ContractFunctionName<abi> : never,
+  params extends abi extends Abi
+    ? ContractFunctionArgs<abi, "payable" | "nonpayable", functionName>
+    : never = abi extends Abi
+    ? ContractFunctionArgs<abi, "payable" | "nonpayable", functionName>
+    : never,
+>(_args: IContractWrite<abi, functionName, params>) {
   return undefined;
-};
+}
 
 describe("beraWriteContract", () => {
   const { config } = parseBaseArgs({ chainId: defaultChain.id });

package/src/actions/transactions/beraWriteContract.ts

@@ -44,9 +44,9 @@ import { seconds } from "../../utils/time";
  */
 const defaultPollingInterval = seconds(1);
 
-const increaseByPercentage = (value: bigint, percentage: number) => {
+function increaseByPercentage(value: bigint, percentage: number) {
   return (value * (100n + BigInt(percentage))) / 100n;
-};
+}
 
 /**
  * This helps prevent IntegerOutOfRangeError by not providing a nonce if it's too large.

package/src/actions/validators/getActiveBoostAndCommissionChangeDelay.ts

@@ -1,6 +1,6 @@
 import type { PublicClient } from "viem";
 
-import type { EdgeConfigSchema } from "@berachain/config/internal/edge-config";
+import type { EdgeConfigSchema } from "@berachain/edge-config";
 
 import { bgtAbi } from "@berachain/abis/pol/bgt";
 import { beraChefAbi } from "@berachain/abis/pol/rewards/beraChef";

package/src/actions/validators/getUserActiveValidators.ts

@@ -17,82 +17,144 @@ export type ValidatorWithUserBoost = ApiValidatorInListFragment & {
   userBoosts: UserBoostsOnValidator;
 };
 
-export async function getUserActiveValidators({
+export type UserValidatorsApiData = ApiValidatorInListFragment[];
+
+/**
+ * Fetches the API-side data for a user's boosted validators: the list of
+ * validator IDs the user has boosted (from the boosts API) and the validator
+ * info for each. On-chain boost amounts are fetched separately by
+ * {@link getUserActiveValidatorsOnChain} so the two can refresh independently.
+ */
+export async function getUserActiveValidatorsApi({
   account,
-  publicClient,
   chain,
   ...args
 }: {
   account: string;
-  publicClient: PublicClient | undefined;
   chain?: GqlChain;
-} & BeraJS.BaseFunctionArgs): Promise<ValidatorWithUserBoost[] | undefined> {
+} & BeraJS.BaseFunctionArgs): Promise<UserValidatorsApiData> {
   const { config } = parseBaseArgs(args);
   const resolvedChain = chain ?? (config.bex.chainName as GqlChain);
 
   const userBoosts = await getUserBoosts({ account });
 
-  const [validatorInfoList, onChainBoosts] = await Promise.all([
-    getAllValidators({
-      variables: {
-        chain: resolvedChain,
-        where: {
-          idIn: userBoosts.data.polGetValidatorBoosts.boosts.map(
-            (t) => t.validatorId,
-          ),
-        },
-      },
-    }),
-    Promise.all(
-      userBoosts.data.polGetValidatorBoosts.boosts
-        .filter(
-          (t) =>
-            // there's an edge case here where api doesn't return the pubkey
-            // because the user might have boosted a pubkey that doesn't exist
-            // api doesn't return the pubkey in this case, but we're choosing to filter them out
-            !!t.validator,
-        )
-        .map((t) =>
-          getUserBoostsOnValidator({
-            account: account as Address,
-            pubkey: t.validator!.pubkey,
-            publicClient: publicClient,
-          }),
+  const validatorInfoList = await getAllValidators({
+    variables: {
+      chain: resolvedChain,
+      where: {
+        idIn: userBoosts.data.polGetValidatorBoosts.boosts.map(
+          (t) => t.validatorId,
         ),
+      },
+    },
+  });
+
+  return validatorInfoList?.validators.validators ?? [];
+}
+
+/**
+ * Reads the on-chain boost amounts for each validator in the API data.
+ * Cheap to re-run on its own, which is what powers the hook's
+ * `refreshOnChain()`.
+ */
+export async function getUserActiveValidatorsOnChain({
+  account,
+  validators,
+  publicClient,
+}: {
+  account: string;
+  validators: UserValidatorsApiData;
+  publicClient: PublicClient | undefined;
+}): Promise<UserBoostsOnValidator[]> {
+  return await Promise.all(
+    validators.map((validator) =>
+      getUserBoostsOnValidator({
+        account: account as Address,
+        pubkey: validator.pubkey as Address,
+        publicClient,
+      }),
     ),
-  ]);
+  );
+}
 
-  return validatorInfoList?.validators.validators.map((validator) => {
+/**
+ * Merges API validator info with on-chain boost amounts into the shape widgets
+ * consume. Validators without a matching on-chain read are dropped (the API can
+ * return a pubkey that was never actually boosted on-chain).
+ */
+export function mergeUserActiveValidators({
+  validators,
+  onChainBoosts,
+}: {
+  validators: UserValidatorsApiData;
+  onChainBoosts: UserBoostsOnValidator[];
+}): ValidatorWithUserBoost[] {
+  return validators.flatMap((validator) => {
     const userDeposited = onChainBoosts.find(
       (data) => data.pubkey.toLowerCase() === validator.pubkey.toLowerCase(),
     );
 
     if (!userDeposited) {
-      throw new Error("User deposited not found");
+      // there's an edge case here where api doesn't return the pubkey
+      // because the user might have boosted a pubkey that doesn't exist
+      // api doesn't return the pubkey in this case, but we're choosing to
+      // filter them out
+      return [];
     }
 
     const droppableBoostAmount =
-      parseEther(userDeposited?.activeBoostAmount ?? "0") -
-      parseEther(userDeposited?.queuedDropBoostAmount);
+      parseEther(userDeposited.activeBoostAmount ?? "0") -
+      parseEther(userDeposited.queuedDropBoostAmount);
 
-    return {
-      ...validator,
-      userBoosts: {
-        pubkey: userDeposited.pubkey,
-        activeBoostAmount: userDeposited?.activeBoostAmount,
-        queuedBoostAmount: userDeposited?.queuedBoostAmount,
-        queuedBoostStartBlock: Number(userDeposited?.queuedBoostStartBlock),
-        queuedDropBoostAmount: userDeposited?.queuedDropBoostAmount,
-        queuedDropBoostStartBlock: Number(
-          userDeposited?.queuedDropBoostStartBlock,
-        ),
-        droppableBoostAmount: formatEther(droppableBoostAmount),
-        hasPendingBoosts:
-          Number(userDeposited?.queuedBoostAmount) > 0 ||
-          Number(userDeposited?.queuedDropBoostAmount) > 0,
-        hasActiveBoosts: Number(userDeposited?.activeBoostAmount) > 0,
-        hasDroppableBoosts: droppableBoostAmount > 0n,
-      } satisfies UserBoostsOnValidator,
-    } satisfies ValidatorWithUserBoost;
+    return [
+      {
+        ...validator,
+        userBoosts: {
+          pubkey: userDeposited.pubkey,
+          activeBoostAmount: userDeposited.activeBoostAmount,
+          queuedBoostAmount: userDeposited.queuedBoostAmount,
+          queuedBoostStartBlock: Number(userDeposited.queuedBoostStartBlock),
+          queuedDropBoostAmount: userDeposited.queuedDropBoostAmount,
+          queuedDropBoostStartBlock: Number(
+            userDeposited.queuedDropBoostStartBlock,
+          ),
+          droppableBoostAmount: formatEther(droppableBoostAmount),
+          hasPendingBoosts:
+            Number(userDeposited.queuedBoostAmount) > 0 ||
+            Number(userDeposited.queuedDropBoostAmount) > 0,
+          hasActiveBoosts: Number(userDeposited.activeBoostAmount) > 0,
+          hasDroppableBoosts: droppableBoostAmount > 0n,
+        } satisfies UserBoostsOnValidator,
+      } satisfies ValidatorWithUserBoost,
+    ];
+  });
+}
+
+/**
+ * Fetches a user's boosted validators with their on-chain boost amounts.
+ * Combines the API query, on-chain query, and merge; the hook
+ * `useUserActiveValidators` splits these so it can refresh the on-chain part
+ * alone.
+ */
+export async function getUserActiveValidators({
+  account,
+  publicClient,
+  chain,
+  ...args
+}: {
+  account: string;
+  publicClient: PublicClient | undefined;
+  chain?: GqlChain;
+} & BeraJS.BaseFunctionArgs): Promise<ValidatorWithUserBoost[]> {
+  const validators = await getUserActiveValidatorsApi({
+    account,
+    chain,
+    ...args,
+  });
+  const onChainBoosts = await getUserActiveValidatorsOnChain({
+    account,
+    validators,
+    publicClient,
   });
+  return mergeUserActiveValidators({ validators, onChainBoosts });
 }

package/src/actions/validators/getUserBoostsOnValidator.ts

@@ -2,6 +2,7 @@ import { type Address, formatEther, type PublicClient } from "viem";
 
 import { bgtAbi } from "@berachain/abis/pol/bgt";
 
+import { assertAddress, assertPublicClient } from "../../errors/assert";
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
 
 export type UserBoostsOnValidator = {
@@ -35,12 +36,8 @@ export async function getUserBoostsOnValidator({
 } & BeraJS.BaseFunctionArgs): Promise<UserBoostsOnValidator> {
   const { config } = parseBaseArgs(args);
 
-  if (!account) {
-    throw new Error("account is required");
-  }
-  if (!publicClient) {
-    throw new Error("publicClient is required");
-  }
+  assertAddress(account, "address");
+  assertPublicClient(publicClient);
 
   const [activeBoostAmount, queuedBoostAmount, queuedDropBoostAmount] =
     await Promise.all([
@@ -48,19 +45,19 @@ export async function getUserBoostsOnValidator({
         address: config.tokens.bgt,
         abi: bgtAbi,
         functionName: "boosted",
-        args: [account!, pubkey!],
+        args: [account, pubkey],
       }),
       publicClient.readContract({
         address: config.tokens.bgt,
         abi: bgtAbi,
         functionName: "boostedQueue",
-        args: [account!, pubkey!],
+        args: [account, pubkey],
       }),
       publicClient.readContract({
         address: config.tokens.bgt,
         abi: bgtAbi,
         functionName: "dropBoostQueue",
-        args: [account!, pubkey!],
+        args: [account, pubkey],
       }),
     ]);
 

package/src/actions/validators/getValidatorEstimatedBgtPerYear.ts

@@ -2,11 +2,11 @@ import type { ApiValidatorMinimalFragment } from "@berachain/graphql/pol/api";
 
 import { yearsInSeconds } from "../../utils/time";
 
-export const getValidatorEstimatedBgtPerYear = (
+export function getValidatorEstimatedBgtPerYear(
   validator: ApiValidatorMinimalFragment,
   totalStakedBeraAmount: number,
   blockTime: number,
-): number => {
+): number {
   if (!totalStakedBeraAmount || !validator) return 0;
 
   const estimatedBlocksPerYear = yearsInSeconds(1) / blockTime;
@@ -22,4 +22,4 @@ export const getValidatorEstimatedBgtPerYear = (
     estimatedValidatorBlocksPerYear *
     Number.parseFloat(validator.dynamicData?.rewardRate ?? "0")
   );
-};
+}

package/src/actions/validators/getValidatorRewardAllocation.ts

@@ -3,6 +3,7 @@ import type { Address, PublicClient } from "viem";
 import { beraChefAbi } from "@berachain/abis/pol/rewards/beraChef";
 
 import { parseBaseArgs } from "../../utils/parseBaseArgs";
+import { isDefaultRewardAllocation } from "./getDefaultRewardAllocation";
 
 export interface ValidatorRewardAllocationRaw {
   startBlock: bigint;
@@ -86,6 +87,11 @@ export async function getValidatorRewardAllocation({
    */
   isBaseline: boolean;
 
+  /**
+   * Whether the reward allocation is the default reward allocation.
+   */
+  isDefault: boolean;
+
   isNeverSet: boolean;
 }> {
   const { config } = parseBaseArgs(args);
@@ -132,9 +138,13 @@ export async function getValidatorRewardAllocation({
       Number(lastRaUpdateSet.timestamp),
     );
 
+    const isDefault = isDefaultRewardAllocation(activeRewardAllocation);
+
     let isBaseline = false;
 
-    if (setRewardAllocation.start.blockNumber === 0) {
+    if (isDefault) {
+      isBaseline = false;
+    } else if (setRewardAllocation.start.blockNumber === 0) {
       // the validator has never set the reward allocation
       isBaseline = true;
     } else {
@@ -150,6 +160,7 @@ export async function getValidatorRewardAllocation({
       activeRewardAllocation: activeRewardAllocation,
       setRewardAllocation,
       isBaseline,
+      isDefault,
       isNeverSet: setRewardAllocation?.start.blockNumber === 0,
     };
   } catch (e) {

package/src/contexts/BeraFlags/BeraFlags.tsx

@@ -1,9 +1,6 @@
 import { createContext, useContext } from "react";
 
-import {
-  type EdgeConfigSchema,
-  isFlagEnabled,
-} from "@berachain/config/internal/edge-config";
+import { type EdgeConfigSchema, isFlagEnabled } from "@berachain/edge-config";
 
 import { type BeraFlags, defaultFlags } from "./defaultFlags";
 

package/src/contexts/BeraFlags/defaultFlags.ts

@@ -1,4 +1,4 @@
-import type { flags } from "@berachain/config/internal/flags";
+import type { flags } from "@berachain/edge-config/flags";
 
 type ClientSideFlags = keyof typeof flags;
 
@@ -19,7 +19,6 @@ export type BeraFlags = Record<
     | "isZapStakeBeraEnabled"
     | "mockValidatorOperator"
     | "mockValidatorRewardAllocator"
-    | "isBgtPolRewardToken"
     | "mockRewardDurationManager"
     | "mockIncentiveManager"
     | "isHoneyPythWrapperEnabled"
@@ -43,7 +42,6 @@ export const defaultFlags: BeraFlags = {
   isZapStakeBeraEnabled: false,
   mockValidatorOperator: false,
   mockValidatorRewardAllocator: false,
-  isBgtPolRewardToken: true,
   mockRewardDurationManager: false,
   mockIncentiveManager: false,
   isHoneyPythWrapperEnabled: true,

package/src/contexts/BexStatusProvider.tsx

@@ -8,7 +8,7 @@ import {
 } from "react";
 import type { Hex } from "viem";
 
-import type { EdgeConfigSchema } from "@berachain/config/internal/edge-config";
+import type { EdgeConfigSchema } from "@berachain/edge-config";
 
 import { BeraError } from "../errors/BeraError";
 

package/src/contexts/TokensProvider.tsx

@@ -1,9 +1,6 @@
 import { createContext, type PropsWithChildren, useMemo } from "react";
 
-import {
-  type EdgeConfigSchema,
-  isFlagEnabled,
-} from "@berachain/config/internal/edge-config";
+import { type EdgeConfigSchema, isFlagEnabled } from "@berachain/edge-config";
 
 import { useEnsoUserTokensWithBalances } from "../hooks/enso/useEnsoUserTokensWithBalances";
 import type { BalanceToken, Token, TokenWithMetadata } from "../types/dex";

package/src/contexts/exports.ts

@@ -7,7 +7,7 @@ export {
   useBeraFlags,
 } from "./BeraFlags/BeraFlags";
 export * from "./BexStatusProvider";
-export * from "./block-time-provider";
+export * from "./BlockTimeProvider";
 export * from "./HoneyConfigProvider";
 export * from "./SwrFallback";
 export * from "./TokensProvider";

package/src/enum/contracts.ts

@@ -8,7 +8,10 @@ export enum ContractName {
   BEX_POOL = "bex.pool",
   ERC20 = "others.erc20",
   ERC4626 = "others.erc4626",
+  POL_BGT = "pol.bgt",
   POL_STAKE_VAULT = "pol.stakeVault",
+  INFRARED_IBGT_VAULT = "infrared.ibgtVault",
+  INFRARED_IBGT_REDEEMER = "infrared.ibgtRedeemer",
   BEX_EXPLOITED_FUND_DISTRIBUTOR = "bex.exploitedFundDistributor",
   TW_MINIMAL_ACCOUNT = "thirdweb.minimalAccount",
 }