@berachain/berajs 0.1.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) Berachain Foundation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,86 @@
+# Berajs
+
+Berajs is a TypeScript interface for interacting with Berachain PoL logic and core Dapps. Built on top of the [wagmi v2](https://wagmi.sh/) and [viem](https://viem.sh/) libraries, BeraJs provides a library capable of plugging into your existing [wevm](https://wevm.dev/) projects. Berajs
+provides a suite of React Hooks using [swr](https://swr.vercel.app/) and a suite of typescript functions, called actions.
+
+Berajs is documented [here]("")
+
+
+## Commands
+
+| Script                   | Description                                                                                              |
+| ------------------------ | -------------------------------------------------------------------------------------------------------- |
+| `pnpm build`             | Builds the package                                                                                       |
+| `pnpm test`              | Runs tests                                                                                               |
+| `pnpm clean`             | Removes build and nod_modules                                                                            |
+| `pnpm dev`               | Builds in watch mode (rebuilds on changes)                                                               |
+| `pnpm lint`              | Runs linting                                                                                             |
+| `pnpm lint:fix`          | Runs linting and applies fixes                                                                           |
+
+
+## Guidelines
+
+In order for this package to be chain and config agnostic, every function should ideally follow a patter that lets
+consumers of the SDK override any argument. This aims to make the SDK more scalable and more ergonomic to adapt for new chain or testnet
+environment. However, getters should always default their arguments to the config exported by `@berachain/config/internal`. Hooks that consume
+these function might eventually override config or chain based on the app state.
+
+```ts
+import { chainConfigs, defaultChainId } from "@berachain/config/internal";
+import { Address, PublicClient } from "viem";
+import { pythAbi } from "~/abi/pyth/pyth";
+
+export async function getPythUpdateFee({
+  client,
+  priceFeedId,
+}: {
+  client: PublicClient;
+  priceFeedId: Address[];
+}) {
+
+    const result = await client.readContract({
+        // ❌ this forces the function to read from an hardcoded contracts
+        address: config.external.pyth,
+        abi: pythAbi,
+        functionName: "getUpdateFee",
+        args: [priceFeedId],
+    });
+    return result;
+}
+
+
+import { chainConfigs, defaultChainId } from "@berachain/config/internal";
+import { Address, PublicClient } from "viem";
+import { pythAbi } from "~/abi/pyth/pyth";
+
+
+export async function getPythUpdateFee({ 
+  client,
+  priceFeedId,
+}: {
+  client: PublicClient;
+  priceFeedId: Address[];
+  /**
+   * Address of pyth contract
+   * 
+   * @default `chainConfigs[chainId].external.pyth`
+   */
+  pythAddress?: Address;
+} & BeraJS.BaseFunctionArgs) {
+  try {
+    const result = await client.readContract({
+        // ✅ this defaults to 
+      address: pythAddress,
+      abi: pythAbi,
+      functionName: "getUpdateFee",
+      args: [priceFeedId],
+    });
+    return result;
+  } catch (e) {
+    console.error("getPythUpdateFee", e);
+    throw e;
+  }
+}
+
+
+```

package/dist/BeraError-CfcNTfpH.d.ts

@@ -0,0 +1,69 @@
+import { SeverityLevel } from '@sentry/nextjs';
+import { Abi } from 'viem';
+
+interface IBeraErrorArgs {
+    message?: string;
+    displayMessage?: string;
+    cause?: unknown;
+    reason?: string;
+    chainId?: number;
+    /**
+     * The level of the error to be used for Sentry.
+     */
+    level?: SeverityLevel;
+    tags?: {
+        [key in TagsKey]?: Primitive;
+    };
+    extra?: Record<string, unknown>;
+    /**
+     * Optional ABI to be used to parse the error.
+     */
+    abi?: Abi;
+}
+/**
+ * Copy pasted from sentry types
+ */
+type Primitive = number | string | boolean | bigint | symbol | null | undefined;
+/**
+ * An helper type to make sure we only use the allowed tags. Sync this with docs/errors.md
+ */
+type TagsKey = "wallet.chain" | "wallet.connector" | "wallet.address" | "error.reason" | "operation.type" | "operation.key" | "operation.txn.functionName" | "operation.txn.to" | "operation.txn.status" | "operation.source.url" | "operation.source.name" | "operation.source.queryName" | "operation.source.type";
+/**
+ * This is a generic error class that can be used to handle errors in the SDK.
+ */
+declare class BeraError extends Error {
+    /**
+     * A human-readable message that can be displayed to end user.
+     *
+     * In berachain dapps, this is shown in the error pop-up.
+     */
+    displayMessage: string;
+    /**
+     * The cause of the error.
+     *
+     * This is typically the error that was thrown.
+     */
+    cause: unknown;
+    /**
+     * The chain id of the error.
+     */
+    chainId?: number;
+    /**
+     * The code for the reason for the error.
+     *
+     * This is typically the error code can be found in the errorMap.ts file. I.e. NotEnoughBalance or BAL#508
+     */
+    reason: string | null;
+    private _tags;
+    set tags(tags: {
+        [key: string | TagsKey]: Primitive;
+    });
+    get tags(): {
+        [key: string | TagsKey]: Primitive;
+    };
+    level: SeverityLevel;
+    extra: Record<string, unknown>;
+    constructor({ message: m, displayMessage: dm, cause, reason, level, abi, tags, chainId, }: IBeraErrorArgs);
+}
+
+export { BeraError as B, type IBeraErrorArgs as I };

package/dist/BexStatusProvider-nS3NcdxI.d.ts

@@ -0,0 +1,70 @@
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import * as react from 'react';
+import { Dispatch, SetStateAction, PropsWithChildren } from 'react';
+import { Hex } from 'viem';
+import { EdgeConfigSchema } from '@berachain/config/internal/edge-config';
+
+type FactoryStatus = {
+    /**
+     * If the composable stable factory is enabled
+     */
+    composableStable: "paused" | "enabled";
+    /**
+     * If the weighted factory is enabled
+     */
+    weighted: "paused" | "enabled";
+};
+interface BexStatusProviderProps {
+    isVaultPaused: boolean;
+    pool?: {
+        id: Hex;
+        isInRecoveryMode: boolean;
+        isPaused: boolean;
+    };
+    factories: FactoryStatus;
+    labels?: NonNullable<EdgeConfigSchema["bex"]>["emergencyLabels"];
+}
+declare const BexStateContext: react.Context<{
+    protocol: {
+        isPaused: boolean;
+        factories: FactoryStatus & {
+            allPaused: boolean;
+        };
+    };
+    onPoolChange: Dispatch<SetStateAction<BexStatusProviderProps["pool"]>>;
+    pool?: {
+        id: Hex;
+        isInRecoveryMode: boolean;
+        isPaused: boolean;
+        disablePoolWithdrawals: boolean;
+        disablePoolDeposits: boolean;
+    };
+    labels?: NonNullable<EdgeConfigSchema["bex"]>["emergencyLabels"];
+}>;
+/**
+ * @description Determines the status of a pool or vault and returns the appropriate messages and flags to disable functionality.
+ * More information here https://www.notion.so/berachain/BEX-RecoveryMode-and-Pause-explained-17c6120abced80e0985dd589b57ff018
+ *
+ * @returns status flags to enable/disable/notify users across the BEX
+ *
+ **/
+declare function useBexStatus(): {
+    protocol: {
+        isPaused: boolean;
+        factories: FactoryStatus & {
+            allPaused: boolean;
+        };
+    };
+    onPoolChange: Dispatch<SetStateAction<BexStatusProviderProps["pool"]>>;
+    pool?: {
+        id: Hex;
+        isInRecoveryMode: boolean;
+        isPaused: boolean;
+        disablePoolWithdrawals: boolean;
+        disablePoolDeposits: boolean;
+    };
+    labels?: NonNullable<EdgeConfigSchema["bex"]>["emergencyLabels"];
+};
+declare function BexStatusProvider({ children, isVaultPaused, labels, factories, }: PropsWithChildren<BexStatusProviderProps>): react_jsx_runtime.JSX.Element;
+
+export { type BexStatusProviderProps as B, BexStateContext as a, BexStatusProvider as b, useBexStatus as u };

package/dist/RequestError-CtJLUaAc.d.ts

@@ -0,0 +1,57 @@
+import { ErrorLike } from '@apollo/client';
+import { B as BeraError, I as IBeraErrorArgs } from './BeraError-CfcNTfpH.js';
+
+/**
+ * This is an error class that should be used to handle errors from fetch requests.
+ */
+declare class RequestError extends BeraError {
+    /**
+     * The error response from the request.
+     */
+    response: Response | ErrorLike | undefined;
+    static isCorsError(error: Error): boolean;
+    /**
+     * The endpoint that was requested.
+     */
+    endpoint: {
+        name?: string;
+        url: string;
+        type?: "rest" | "graphql" | "rpc";
+    };
+    /**
+     * A list of domains that should have their query params removed.
+     */
+    private queryRichfulDomains;
+    statusCode: number | undefined;
+    payload?: object;
+    static readonly REASON_MAP: {
+        readonly 429: "RATE_LIMITED_429";
+        readonly NETWORK_ERROR: "NETWORK_ERROR";
+        readonly CORS_ERROR: "CORS";
+    };
+    constructor(args: IBeraErrorArgs & {
+        response: Response | ErrorLike | undefined;
+        /**
+         * The payload sent to the request.
+         */
+        payload?: object;
+        endpoint: string | URL | {
+            name?: string;
+            url: string | URL;
+            type: "rest" | "graphql" | "rpc";
+        };
+        statusCode?: number;
+    });
+    setEndpoint(endpoint: string | URL | {
+        name?: string;
+        url: string | URL;
+        type?: "rest" | "graphql" | "rpc";
+    }): {
+        name?: string;
+        url: string;
+        type?: "rest" | "graphql" | "rpc";
+    };
+    private tryMatchNetworkError;
+}
+
+export { RequestError as R };