@berachain/berajs 0.1.2 → 0.2.1

package/dist/global.d-wYu8G8IQ.d.ts

@@ -0,0 +1,473 @@
+import { Address, Hex, AbiFunction, Abi, ContractFunctionName, ContractFunctionArgs, TransactionReceipt, WalletCallReceipt, Account } from 'viem';
+import { ProposalWithVotesFragment, ProposalVoteFragment } from '@berachain/graphql/governance';
+import { b as ProposalTypeEnum, a as ProposalErrorCodes, T as TransactionActionType, C as ContractName } from './txnEnum-BlBYhNRl.js';
+import { a as TokenWithMetadata, b as Token } from './HoneyConfigProvider-CK6mOKFH.js';
+import { ApiValidatorFragment } from '@berachain/graphql/pol/api';
+import { Config, GetWalletClientReturnType } from '@wagmi/core';
+import { SWRConfiguration, SWRResponse } from 'swr';
+import { ChainId, BeraConfig } from '@berachain/config';
+import { B as BeraError } from './BeraError-_mQdkanr.js';
+
+type Proposal = ProposalWithVotesFragment;
+
+type Vote = ProposalVoteFragment;
+
+type Voter = Address;
+
+type ProposalVotes = {
+  yes: number;
+  no: number;
+  abstain: number;
+};
+
+type PROPOSAL_GENRE = "berahub" | "honey" | "bend" | "berps" | "general";
+
+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;
+
+type CustomProposalErrors = {
+  title?: null | ProposalErrorCodes;
+  description?: null | ProposalErrorCodes;
+  forumLink?: null | ProposalErrorCodes;
+  actions?: CustomProposalActionErrors[];
+};
+
+type GovernanceTopic = {
+  id: PROPOSAL_GENRE;
+  color: string;
+  icon: React.ReactNode;
+  iconBackground?: string;
+  name: string;
+  slug: string;
+  forumLink: string;
+  description?: string;
+  comingSoon?: boolean;
+};
+type CustomProposal = {
+  title: string;
+  description: any;
+  actions: ProposalAction[];
+  forumLink: string;
+  topic: Set<PROPOSAL_GENRE>;
+};
+
+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;
+    }
+);
+
+type ProposalAction = Partial<SafeProposalAction> & {
+  type: SafeProposalAction["type"];
+};
+
+type VerifiedAbi = {
+  abiItem?: AbiFunction;
+  functionName?: string;
+  args: readonly unknown[];
+  functionSignature?: string;
+};
+
+interface ProtocolMetadata {
+  name: string;
+  logoURI: string;
+  url: string;
+  description: string;
+  tags?: string[];
+}
+
+/**
+ * Configuration for a single staking option.
+ * Maps receipt tokens to their accepted input tokens.
+ */
+type StakingConfig = {
+  /** Unique identifier for this staking config */
+  id: string;
+  /** The token received when staking (e.g., sWBERA, siBERA) */
+  receiptToken: TokenWithMetadata;
+  /** Tokens that can be staked to receive the receipt token */
+  inputTokens: TokenWithMetadata[];
+};
+
+interface BribeBoostReward {
+  token: string;
+  total_unclaimed: string;
+}
+
+interface BribeBoostRewardItem {
+  rewards: BribeBoostReward[];
+  validator: string;
+}
+
+interface BribeBoostRewardProof {
+  validator?: string;
+  pagination: {
+    next: number;
+    previous: number;
+    record_per_page: number;
+    current_page: number;
+    total_page: number;
+  };
+  rewards:
+    | {
+        id: string;
+        dist_id: string;
+        token: Address;
+        recipient: string;
+        amount: string;
+        merkle_proof: string[];
+        available_at: number;
+      }[]
+    | null;
+}
+
+interface BribeBoostValidatorApr {
+  id: string;
+  boost_total_bgt: string;
+  rewards_total_usd: string;
+  daily_rate: string;
+  apr: string;
+  apy: string;
+  tokens: Address[]; // Confirm this type with backend real data
+  validator: string;
+  start_block: number;
+  end_block: number;
+  start_timestamp: number;
+  end_timestamp: number;
+  created_at: string;
+  updated_at: string;
+}
+
+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;
+};
+interface IncentiveRewardChunksWithValidatorData {
+  validator: ApiValidatorFragment | undefined;
+  maxTimestamp: number | undefined;
+  minTimestamp: number | undefined;
+  totalValue: number;
+  tokenTotals: {
+    chainId: number;
+    address: Address;
+    amount: number;
+    value: number;
+    metadata: Token | undefined;
+  }[];
+  rewards: IncentiveReward[];
+  isCurrent: boolean;
+}
+
+interface AggregatedTokenTotals {
+  address: Address;
+  amount: number;
+  value: number;
+  metadata: Token | undefined;
+  chainId: number;
+}
+
+type ClaimedIncentives = Record<string, string>;
+
+type ClaimedIncentivesLocalState = Record<string, ClaimedIncentives>;
+
+interface UserVaultInfo {
+  balance: bigint;
+  delegatedBalance: bigint;
+  withdrawableBalance: bigint;
+  rewards: string;
+  percentage: string;
+}
+
+type StakedBeraAsset = {
+  token: TokenWithMetadata;
+  apr: number;
+  stakedAmount: number;
+  stakedAmountUsd: number;
+  earnedAmount: number;
+  earnedAmountUsd: number;
+};
+
+interface UseContractWriteApi {
+    isLoading: boolean;
+    isSubmitting: boolean;
+    isSuccess: boolean;
+    isError: boolean;
+    write: IContractWriteFn;
+    reset: () => void;
+}
+type PropagatedArgs<args> = Omit<args, TxnEventKeys | "contractName"> & {
+    contractName?: string;
+};
+type TxnEventKeys = "onSuccess" | "onError" | "onLoading" | "onSubmission" | "onWarning";
+interface IUseContractWriteArgs<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> {
+    onSuccess?: (receipts: TransactionReceipt | WalletCallReceipt<bigint, "success" | "reverted">, 
+    /**
+     * Arguments that were used to call the write function.
+     */
+    writeArgs: PropagatedArgs<IContractWrite<abi, functionName, params>>) => void;
+    onError?: (e: BeraError, 
+    /**
+     * Arguments that were used to call the write function.
+     */
+    writeArgs: PropagatedArgs<IContractWrite<abi, functionName, params>>) => void;
+    onLoading?: (
+    /**
+     * Arguments that were used to call the write function.
+     */
+    writeArgs: PropagatedArgs<IContractWrite<abi, functionName, params>>) => void;
+    onSubmission?: (
+    /**
+     * @param args.id If request is a batch call, this will be the id of the request to the wallet provider
+     * @param args.txHash If request is a single transaction, this will be the hash of the transaction to wait for
+     */
+    args: {
+        txHash: Hex;
+        id?: never;
+    } | {
+        id: string;
+        txHash?: never;
+    }, 
+    /**
+     * Arguments that were used to call the write function.
+     */
+    writeArgs: PropagatedArgs<IContractWrite<abi, functionName, params>>) => void;
+    /**
+     * Callback function executed when a transaction encounters a warning. Transaction will still be submitted.
+     */
+    onWarning?: (e: BeraError, writeArgs: Omit<IContractWrite<abi, functionName, params>, TxnEventKeys>) => void;
+}
+
+type DefaultHookOptions = {
+  opts?: SWRConfiguration & { isEnabled?: boolean };
+};
+
+type DefaultHookReturnType<T = any> = Omit<
+  SWRResponse<T, any, any>,
+  "mutate"
+> & {
+  refresh: () => void;
+};
+
+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[]>
+    >
+>;
+
+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;
+    };
+  }
+}
+
+export type { AggregatedTokenTotals as A, BribeBoostRewardProof as B, CustomProposal as C, DefaultHookOptions as D, GovernanceTopic as G, IContractWrite as I, ProtocolMetadata as P, StakingConfig as S, TxnEventKeys as T, UserVaultInfo as U, Vote as V, CustomProposalErrors as a, BribeBoostRewardItem as b, DefaultHookReturnType as c, StakedBeraAsset as d, IUseContractWriteArgs as e, UseContractWriteApi as f, BribeBoostReward as g, BribeBoostValidatorApr as h, IContractWriteFn as i, Proposal as j, Voter as k, ProposalVotes as l, PROPOSAL_GENRE as m, CustomProposalActionErrors as n, SafeProposalAction as o, ProposalAction as p, VerifiedAbi as q, IncentiveReward as r, IncentiveRewardChunksWithValidatorData as s, ClaimedIncentives as t, ClaimedIncentivesLocalState as u };

package/dist/honey-CYm0RWf4.d.cts

@@ -0,0 +1,14 @@
+declare 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 { HoneySwapAction as H };

package/dist/honey-CYm0RWf4.d.ts

@@ -0,0 +1,14 @@
+declare 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 { HoneySwapAction as H };