@berachain/berajs 0.1.0 → 0.1.2

package/src/types/global.ts

@@ -0,0 +1,230 @@
+import type { Config, GetWalletClientReturnType } from "@wagmi/core";
+import type { SWRConfiguration, SWRResponse } from "swr";
+import type {
+  Abi,
+  Account,
+  Address,
+  ContractFunctionArgs,
+  ContractFunctionName,
+  Hex,
+  TransactionReceipt,
+  WalletCallReceipt,
+} from "viem";
+
+import type { BeraConfig, ChainId } from "@berachain/config";
+
+import type { TransactionActionType } from "~/enum/txnEnum";
+import type {
+  IUseContractWriteArgs,
+  TxnEventKeys,
+} from "~/hooks/useContractWrite/types";
+import type { Token } from "./dex";
+
+export type DefaultHookOptions = {
+  opts?: SWRConfiguration & { isEnabled?: boolean };
+};
+
+export type DefaultHookReturnType<T = any> = Omit<
+  SWRResponse<T, any, any>,
+  "mutate"
+> & {
+  refresh: () => void;
+};
+
+export interface TokenBalance {
+  address: Address;
+  /**
+   * Balance in wei, should be string to be serializable in JSON
+   */
+  balance: bigint | string;
+  formattedBalance: string;
+  /**
+   * Balance in USD
+   */
+  usdValue?: number;
+}
+
+export interface AllowanceToken extends Token {
+  allowance: bigint;
+  formattedAllowance: string;
+}
+
+export type IContractWriteFn = <
+  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,
+>(
+  props: IContractWrite<abi, functionName, params>,
+) => Promise<
+  | TransactionReceipt
+  | WalletCallReceipt<bigint, "success" | "reverted">
+  | undefined
+>;
+
+/**
+ * Posthog must be able to serialize this. BigInts are not supported.
+ */
+type AllowedEventData = number | string | boolean | null | undefined;
+
+type EventData = Record<
+  string,
+  | AllowedEventData
+  | AllowedEventData[]
+  | Record<
+      string,
+      | AllowedEventData
+      | AllowedEventData[]
+      | Record<string, AllowedEventData | AllowedEventData[]>
+    >
+>;
+
+/**
+ * A list of contract names that are not mapped in the devrel's contract mapping or that are generated by factories (e.g. RewardVault).
+ */
+export enum ContractName {
+  ENSO_ROUTER = "enso.router",
+  POL_REWARD_VAULT = "pol.rewardVault",
+  BEX_POOL = "bex.pool",
+  ERC20 = "others.erc20",
+  BEX_EXPLOITED_FUND_DISTRIBUTOR = "bex.exploitedFundDistributor",
+}
+
+export type IContractWrite<
+  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,
+> = {
+  /**
+   * A message that will be shown to user while the transaction is pending.
+   *
+   * @example "Sending approvals"
+   */
+  message: string;
+  /**
+   * The chain ID of the transaction.
+   *
+   * @default berachainChainId
+   */
+  chainId?: ChainId;
+  /**
+   * The type of transaction to be performed. It will be stored in the transaction history.
+   *
+   * Generally uses infinite tense.
+   * @example TransactionActionType.APPROVAL => "Approve tokens"
+   */
+  actionType: TransactionActionType;
+  txnName?: string;
+  gasLimit?: bigint;
+  account?: Account | Address;
+  /**
+   * Wheter the transaction can be sent by any account. Before setting this to true, make sure smart contract doesn't rely on `msg.sender`.
+   *
+   * Only transaction with permissionless flag set to true can be sent with overriden account.
+   * Everything else will throw an error.
+   */
+  permissionless?: boolean;
+  /**
+   * The event to be tracked more specifically.
+   * If not provided, the event will be tracked with the message and actionType.
+   */
+  track?: {
+    eventName: string;
+    eventData?: EventData;
+  };
+
+  /**
+   * A wagmi config used to get wallet clients, switch chains, etc.
+   *
+   * This is preferred over providing clients as state updates are kept synched in this config object w/o re-rendering.
+   */
+  wagmiConfig?: Config;
+
+  /**
+   * walletClient should only be provided for tests or scripts.
+   *
+   * Wagmi Config is preferred.
+   */
+  walletClient?: GetWalletClientReturnType | undefined;
+  /**
+   * The name of the contract to be used for the transaction. By default, it will be devrel's contract mapping.
+   * Custom values will be ignored if the address is already mapped in the devrel's contract mapping.
+   *
+   * @example "pol.rewardVault"
+   */
+  contractName?: ContractName;
+  /**
+   * This is a canonical list of ABIs that will be used to parse the error.
+   *
+   * This is an useful way to parse errors when providing raw data with no ABI.
+   */
+  errorsAbi?: Abi;
+} & IUseContractWriteArgs<abi, functionName, params> &
+  (abi extends Abi
+    ? {
+        abi: abi;
+        functionName: functionName;
+        params: params;
+        address: Address;
+        calls?: never;
+        value?: bigint;
+      }
+    :
+        | {
+            data: Hex;
+            address: Address;
+            value?: bigint;
+            calls?: never;
+          }
+        | {
+            value: bigint;
+            address: Address;
+            data?: Hex;
+            calls?: never;
+          }
+        | {
+            value?: never;
+            address?: never;
+            calls: (Omit<
+              IContractWrite,
+              | "calls"
+              | "gasLimit"
+              | "account"
+              | "address"
+              | "message"
+              | "actionType"
+              | TxnEventKeys
+            > & {
+              address: Address;
+            })[];
+          });
+
+declare global {
+  export namespace BeraJS {
+    export type BaseFunctionArgs = {
+      /**
+       * If only chainId is provided, config will be inferred from it
+       *
+       * @default `import { defaultChainId } from "@berachain/config/internal";`
+       */
+      chainId?: ChainId;
+      /**
+       * A config to infer the default values of the other arguments
+       *
+       * @default chainConfigs[chainId]
+       */
+      config?: BeraConfig;
+    };
+  }
+}

package/src/types/governance.ts

@@ -0,0 +1,174 @@
+import type { AbiFunction, Address, Hex } from "viem";
+
+import type {
+  ProposalVoteFragment,
+  ProposalWithVotesFragment,
+} from "@berachain/graphql/governance";
+
+export type Proposal = ProposalWithVotesFragment;
+
+export type Vote = ProposalVoteFragment;
+
+export type Voter = Address;
+
+/**
+ * Maps the proposal state from the governor contract to a more human-readable format.
+ * Don't edit this enum manually, it's synced with the governor contract.
+ *
+ * @see https://github.com/OpenZeppelin/openzeppelin-contracts/blob/master/contracts/governance/IGovernor.sol
+ */
+export enum ProposalState {
+  Pending = 0,
+  Active = 1,
+  Canceled = 2,
+  Defeated = 3,
+  Succeeded = 4,
+  Queued = 5,
+  Expired = 6,
+  Executed = 7,
+}
+
+export type ProposalVotes = {
+  yes: number;
+  no: number;
+  abstain: number;
+};
+
+export const VoteColorMap = {
+  yes: "#059669",
+  1: "#059669",
+  no: "#DC2629",
+  2: "#DC2629",
+  veto: "#0284C7",
+  4: "#0284C7",
+  abstain: "#78716c",
+  3: "#78716c",
+  yes_secondary: "#ECFDF5",
+  no_secondary: "#FEF2F2",
+  veto_secondary: "#F0F9FF",
+  abstain_secondary: "#E7E5E4",
+  default: "#57534e",
+};
+
+export enum VoteEnum {
+  AGAINST = "no",
+  FOR = "yes",
+  ABSTAIN = "abstain",
+}
+
+export type PROPOSAL_GENRE = "berahub" | "honey" | "bend" | "berps" | "general";
+
+export type CustomProposalActionErrors = {
+  type?: null | ProposalErrorCodes;
+  target?: null | ProposalErrorCodes;
+  value?: null | ProposalErrorCodes;
+  ABI?: null | ProposalErrorCodes;
+  functionSignature?: null | ProposalErrorCodes;
+  args?: (null | ProposalErrorCodes)[];
+  vault?: null | ProposalErrorCodes;
+  isFriend?: null | ProposalErrorCodes;
+  to?: null | ProposalErrorCodes;
+  amount?: null | ProposalErrorCodes;
+  minIncentiveRate?: null | ProposalErrorCodes;
+  managerAddress?: null | ProposalErrorCodes;
+  input?: null | ProposalErrorCodes;
+  token?: null | ProposalErrorCodes;
+  rawCalldata?: null | ProposalErrorCodes;
+  message?: null | ProposalErrorCodes;
+} | null;
+
+export type CustomProposalErrors = {
+  title?: null | ProposalErrorCodes;
+  description?: null | ProposalErrorCodes;
+  forumLink?: null | ProposalErrorCodes;
+  actions?: CustomProposalActionErrors[];
+};
+
+export enum ProposalErrorCodes {
+  REQUIRED = "Required",
+  INVALID_AMOUNT = "Invalid amount",
+  NEGATIVE_AMOUNT = "Negative amount",
+  INVALID_ADDRESS = "Invalid address",
+  INVALID_ACTION = "Invalid action",
+  INVALID_ABI = "Invalid ABI",
+  MUST_BE_HTTPS = "Must be HTTPS",
+  MUST_BE_HTTPS_OR_IPFS = "Must be HTTPS or IPFS",
+  INVALID_BASEPATH = "Must be a berachain forum link",
+  /**
+   * Mainly used when it's not a reward vault
+   */
+  INVALID_CONTRACT = "This is not a valid contract",
+}
+
+export type GovernanceTopic = {
+  id: PROPOSAL_GENRE;
+  color: string;
+  icon: React.ReactNode;
+  iconBackground?: string;
+  name: string;
+  slug: string;
+  forumLink: string;
+  description?: string;
+  comingSoon?: boolean;
+};
+
+export enum ProposalTypeEnum {
+  CUSTOM_PROPOSAL = "custom-action",
+  WHITELIST_REWARD_VAULT = "whitelist-reward-vault",
+  BLACKLIST_REWARD_VAULT = "blacklist-reward-vault",
+  ERC20_TRANSFER = "erc20-transfer",
+  WHITELIST_REWARD_VAULT_INCENTIVE = "whitelist-reward-vault-incentive",
+}
+
+export type CustomProposal = {
+  title: string;
+  description: any;
+  actions: ProposalAction[];
+  forumLink: string;
+  topic: Set<PROPOSAL_GENRE>;
+};
+
+export type SafeProposalAction = {
+  value: bigint;
+  target: "" | Address;
+} & (
+  | {
+      type: ProposalTypeEnum.CUSTOM_PROPOSAL;
+      input: "ABI" | "rawCalldata" | "message";
+      ABI: string;
+      _isVerifiedAbi?: boolean;
+      functionSignature: string;
+      args: string[];
+      rawCalldata: Hex;
+      message: string;
+    }
+  | {
+      type:
+        | ProposalTypeEnum.WHITELIST_REWARD_VAULT
+        | ProposalTypeEnum.BLACKLIST_REWARD_VAULT;
+      vault: Address;
+    }
+  | {
+      type: ProposalTypeEnum.ERC20_TRANSFER;
+      to: Address;
+      amount: string;
+    }
+  | {
+      type: ProposalTypeEnum.WHITELIST_REWARD_VAULT_INCENTIVE;
+      vault: Address;
+      token: Address;
+      minIncentiveRate: string;
+      managerAddress: Address;
+    }
+);
+
+export type ProposalAction = Partial<SafeProposalAction> & {
+  type: SafeProposalAction["type"];
+};
+
+export type VerifiedAbi = {
+  abiItem?: AbiFunction;
+  functionName?: string;
+  args: readonly unknown[];
+  functionSignature?: string;
+};

package/src/types/honeySwap.ts

@@ -0,0 +1,35 @@
+import type { Address, Hex } from "viem";
+
+import type { HoneyPreviewResult } from "~/actions/honey/getHoneyPreview";
+import type { TokenWithOrder } from "~/contexts/HoneyConfigProvider";
+
+export enum HoneySwapAction {
+  RESET_AMOUNTS = "RESET_AMOUNTS",
+  ACTION_TYPE_CHANGE = "ACTION_TYPE_CHANGE",
+  COLLATERALS_CHANGE = "COLLATERALS_CHANGE",
+  FROM_AMOUNT_CHANGE = "FROM_AMOUNT_CHANGE",
+  TO_AMOUNT_CHANGE = "TO_AMOUNT_CHANGE",
+  PREVIEW_CHANGE = "PREVIEW_CHANGE",
+  IS_BASKET_MODE_ENABLED_CHANGE = "IS_BASKET_MODE_ENABLED_CHANGE",
+  IS_TYPING_CHANGE = "IS_TYPING_CHANGE",
+  IS_SUBMITTING_CHANGE = "IS_SUBMITTING_CHANGE",
+  IS_LOADING_CHANGE = "IS_LOADING_CHANGE",
+}
+
+export type PythPriceFeedMap = Record<Address, Hex>;
+
+export type HoneySwapActions =
+  | { type: HoneySwapAction.RESET_AMOUNTS }
+  | { type: HoneySwapAction.ACTION_TYPE_CHANGE; value: "mint" | "redeem" }
+  | { type: HoneySwapAction.COLLATERALS_CHANGE; value: TokenWithOrder[] }
+  | { type: HoneySwapAction.FROM_AMOUNT_CHANGE; index: number; value: string }
+  | { type: HoneySwapAction.TO_AMOUNT_CHANGE; index: number; value: string }
+  | {
+      type: HoneySwapAction.PREVIEW_CHANGE;
+      value: HoneyPreviewResult;
+      changedAsset: Address;
+    }
+  | { type: HoneySwapAction.IS_BASKET_MODE_ENABLED_CHANGE; value: boolean }
+  | { type: HoneySwapAction.IS_TYPING_CHANGE; value: boolean }
+  | { type: HoneySwapAction.IS_SUBMITTING_CHANGE; value: boolean }
+  | { type: HoneySwapAction.IS_LOADING_CHANGE; value: boolean };

package/src/types/index.ts

@@ -0,0 +1,8 @@
+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/pol.ts

@@ -0,0 +1,52 @@
+import type { Address } from "viem";
+
+import type { ApiValidatorFragment } from "@berachain/graphql/pol/api";
+
+import type { Token } from "./dex";
+
+export type IncentiveReward = {
+  tokenMetadata: Token | undefined;
+  tokenPrice: number;
+  tokenValue: number;
+  id: string;
+  dist_id: string;
+  token: string;
+  recipient: string;
+  formattedAmount: string;
+  amount: string;
+  merkle_proof: string[];
+  available_at: number;
+};
+export interface IncentiveRewardChunksWithValidatorData {
+  validator: ApiValidatorFragment | undefined;
+  maxTimestamp: number | undefined;
+  minTimestamp: number | undefined;
+  totalValue: number;
+  tokenTotals: {
+    address: Address;
+    amount: number;
+    value: number;
+    metadata: Token | undefined;
+  }[];
+  rewards: IncentiveReward[];
+  isCurrent: boolean;
+}
+
+export interface AggregatedTokenTotals {
+  address: Address;
+  amount: number;
+  value: number;
+  metadata: Token | undefined;
+}
+
+export type ClaimedIncentives = Record<string, string>;
+
+export type ClaimedIncentivesLocalState = Record<string, ClaimedIncentives>;
+
+export interface UserVaultInfo {
+  balance: bigint;
+  delegatedBalance: bigint;
+  withdrawableBalance: bigint;
+  rewards: string;
+  percentage: string;
+}

package/src/types/staking.ts

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

package/src/utils/beraFetch.ts

@@ -0,0 +1,55 @@
+import { RequestError } from "~/errors/RequestError";
+import { getErrorResponse } from "./getErrorResponse";
+
+type RequestOptions = RequestInit;
+
+export async function beraFetch(
+  endpoint: ConstructorParameters<typeof RequestError>[0]["endpoint"],
+  options?: RequestOptions,
+) {
+  try {
+    const response = await fetch(
+      typeof endpoint === "string" || endpoint instanceof URL
+        ? endpoint
+        : endpoint.url,
+      {
+        ...options,
+      },
+    );
+    if (!response.ok) {
+      const error = await getErrorResponse(response);
+      throw new RequestError({
+        cause: error,
+        // @to-do import getErrorResponse logic in this function
+        // when it's removed from other places
+        response: response,
+        endpoint,
+      });
+    }
+    return response;
+  } catch (error) {
+    if (error instanceof RequestError) {
+      throw error;
+    }
+
+    throw new RequestError({
+      cause: error,
+      endpoint,
+      response: undefined,
+    });
+  }
+}
+
+export async function beraFetchJson<T>(
+  endpoint: ConstructorParameters<typeof RequestError>[0]["endpoint"],
+  options?: RequestOptions,
+) {
+  const response = await beraFetch(endpoint, {
+    ...options,
+    headers: {
+      Accept: "application/json",
+      ...options?.headers,
+    },
+  });
+  return response.json() as Promise<T>;
+}

package/src/utils/constants.ts

@@ -0,0 +1,35 @@
+import { parseEther } from "viem";
+
+// the buffer of the cap limit, if the user gets close to 10% of the cap limit
+// they should be warned
+export const CAP_LIMIT_BUFFER = parseEther("0.005");
+
+/**
+ * Maximum allowed input for a custom deadline in seconds.
+ * @type {number}
+ */
+export const MAX_CUSTOM_DEADLINE = 100000;
+
+/**
+ * Minimum allowed input for a custom deadline in seconds.
+ * @type {number}
+ */
+export const MIN_CUSTOM_DEADLINE = 1;
+
+/**
+ * Minimum allowed input for a custom slippage tolerance percentage.
+ * @type {number}
+ */
+export const MIN_CUSTOM_SLIPPAGE = 0.1;
+
+/**
+ * Maximum allowed input for a custom slippage tolerance percentage.
+ * @type {number}
+ */
+export const MAX_CUSTOM_SLIPPAGE = 50;
+
+/**
+ * Default gas limit used by MetaMask
+ * @see {@link https://github.com/MetaMask/metamask-extension/blob/06cf7459b963e26d0ae60312d4f9a342d07ab89d/ui/pages/confirmations/send/send.constants.js#L8}
+ */
+export const DEFAULT_METAMASK_GAS_LIMIT = 7920027n;

package/src/utils/formatAggregatorsQuotes.ts

@@ -0,0 +1,57 @@
+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,
+      ),
+    }));