@berachain/berajs 0.2.8-beta.9 → 0.2.9

package/dist/actions/governance/exports.d.ts

@@ -0,0 +1,140 @@
+import { AbiParameter, Address, PublicClient, AbiFunction, TransactionReceipt } from 'viem';
+import { ProposalErrorCodes, ProposalState } from '../../enum/governance/exports.js';
+import { ProposalStatus, ProposalSelectionFragment, Proposal_Filter, Proposal_OrderBy, OrderDirection, ProposalWithVotesFragment, GetProposalVotesQueryVariables, GetProposalVotesQuery } from '@berachain/graphql/governance';
+import { CustomProposal, GovernanceTopic, CustomProposalErrors } from '../../types/governance/exports.js';
+import graymatter from 'gray-matter';
+
+type CheckProposalFieldResultMinimal = ProposalErrorCodes | null;
+type CheckProposalFieldResult = ProposalErrorCodes | null | CheckProposalFieldResultMinimal[] | Record<string, CheckProposalFieldResultMinimal>;
+/**
+ * Validates a single proposal field or ABI-typed value.
+ * Returns `null` if valid, or a `ProposalErrorCodes` value describing the problem.
+ */
+declare function checkProposalField(arg: {
+    fieldOrType: "address" | "hex" | "abi" | "string" | "bool" | `uint${string}` | `int${string}` | "action" | "title" | "forumLink" | "description" | "logoURI" | "url";
+    value: unknown;
+    required?: boolean;
+    baseUrl?: string;
+    components?: readonly (AbiParameter | readonly AbiParameter[])[];
+}): CheckProposalFieldResultMinimal;
+/**
+ * For tuple/tuple[] types, may return nested error structures.
+ */
+declare function checkProposalField(arg: {
+    fieldOrType: "tuple[]" | "tuple";
+    value: unknown;
+    required?: boolean;
+    baseUrl?: string;
+    components?: readonly (AbiParameter | readonly AbiParameter[])[];
+}): CheckProposalFieldResult;
+
+declare const MOCKED_PROPOSAL_STATUSES: readonly ProposalStatus[];
+/**
+ * Derives the effective `ProposalStatus` by reconciling subgraph data with the
+ * on-chain contract state. Falls back to subgraph timestamps when the on-chain
+ * state is unavailable.
+ */
+declare function computeActualStatus(
+/** Subgraph proposal data */
+proposal: ProposalSelectionFragment, 
+/** Value returned by the `state` function of the governance contract */
+proposalOnChainState?: ProposalState): ProposalStatus;
+
+type GetAllProposalsArgs = BeraJS.BaseFunctionArgs & {
+    /** Subgraph filter applied to the proposals query */
+    where: Proposal_Filter;
+    /** Number of proposals to skip (for pagination) */
+    offset?: number;
+    /** Maximum proposals per page; must be ≤ 1000 */
+    perPage?: number;
+    orderBy?: Proposal_OrderBy;
+    orderDirection?: OrderDirection;
+    /** Full-text search query; switches to the search endpoint when provided */
+    text?: string;
+};
+/** Fetches a paginated list of governance proposals from the subgraph */
+declare function getAllProposals(_args: GetAllProposalsArgs): Promise<ProposalSelectionFragment[] | undefined>;
+
+interface GetBodyErrorsArgs {
+    /** The proposal to validate */
+    proposal: CustomProposal;
+    /** The current governance topic, used for forum link base URL validation */
+    currentTopic: GovernanceTopic;
+}
+/** Validates the body fields (title, description, forum link) of a proposal */
+declare function getBodyErrors({ proposal, currentTopic, }: GetBodyErrorsArgs): CustomProposalErrors;
+
+interface GetDecodedFunctionDataArgs {
+    /** Contract address that emitted the calldata */
+    address: Address;
+    /** Raw calldata to decode */
+    callData: `0x${string}`;
+    /** @default defaultChainId */
+    chainId?: number;
+    publicClient: PublicClient;
+}
+/**
+ * Decodes the function data from a given contract address and calldata.
+ *
+ * Attempts to decode using a known set of ABIs first, then falls back to
+ * fetching the ABI from the block-explorer API.
+ *
+ * @returns An object with the decoded ABI item, function signature, function name, and arguments.
+ */
+declare function getDecodedFunctionData({ address, callData, chainId, publicClient, }: GetDecodedFunctionDataArgs): Promise<{
+    args: never[];
+    abiItem?: undefined;
+    functionSignature?: undefined;
+    functionName?: undefined;
+} | {
+    abiItem: AbiFunction | undefined;
+    functionSignature: string | undefined;
+    functionName: string;
+    args: unknown[];
+}>;
+
+type GetProposalDetailsArgs = BeraJS.BaseFunctionArgs & {
+    /** On-chain proposal ID */
+    proposalId: string;
+    client?: PublicClient;
+};
+/** Fetches a single proposal with its vote data from the subgraph */
+declare function getProposalDetails(_args: GetProposalDetailsArgs): Promise<ProposalWithVotesFragment | undefined>;
+
+type GetProposalFromTxArgs = {
+    /** Viem public client used to fetch block and receipt data */
+    publicClient: PublicClient | undefined;
+} & ({
+    /** Pre-fetched transaction receipt */
+    tx: TransactionReceipt;
+} | {
+    /** Transaction hash to look up */
+    txHash: Address;
+});
+/**
+ * Reconstructs a `ProposalWithVotesFragment` from the `ProposalCreated` event
+ * emitted in a given transaction. Returns `null` if the event is not found.
+ */
+declare function getProposalFromTx(args: GetProposalFromTxArgs): Promise<ProposalWithVotesFragment | null>;
+
+type GetProposalVotesArgs = BeraJS.BaseFunctionArgs & {
+    /** GraphQL variables forwarded to the GetProposalVotes query */
+    variables: GetProposalVotesQueryVariables;
+};
+/** Fetches the votes for a proposal from the subgraph */
+declare function getProposalVotes(_args: GetProposalVotesArgs): Promise<{
+    data: GetProposalVotesQuery;
+}>;
+
+type ParseProposalBodyResult = graymatter.GrayMatterFile<string> & {
+    /** Whether the body uses YAML front-matter (true) or legacy heading format (false) */
+    isFrontMatter: boolean;
+};
+/**
+ * Parses the body of a governance proposal into structured front-matter and content.
+ * Supports YAML front-matter format and a legacy heading-based format.
+ * Falls back to raw description on parse failure.
+ */
+declare function parseProposalBody(proposal?: Pick<ProposalSelectionFragment, "description">): ParseProposalBodyResult;
+
+export { type GetAllProposalsArgs, type GetBodyErrorsArgs, type GetDecodedFunctionDataArgs, type GetProposalDetailsArgs, type GetProposalFromTxArgs, type GetProposalVotesArgs, MOCKED_PROPOSAL_STATUSES, type ParseProposalBodyResult, checkProposalField, computeActualStatus, getAllProposals, getBodyErrors, getDecodedFunctionData, getProposalDetails, getProposalFromTx, getProposalVotes, parseProposalBody };

package/dist/actions/governance/exports.mjs

@@ -0,0 +1,226 @@
+import {
+  checkProposalField,
+  getAllProposals,
+  getBodyErrors,
+  getProposalDetails,
+  getProposalFromTx,
+  getProposalVotes,
+  parseProposalBody
+} from "../../chunk-AFN4CVD3.mjs";
+import "../../chunk-DKMAIU74.mjs";
+import "../../chunk-KQUMKB66.mjs";
+import "../../chunk-J5I45WGQ.mjs";
+
+// src/actions/governance/computeActualStatus.ts
+import {
+  ProposalStatus
+} from "@berachain/graphql/governance";
+var GOVERNANCE_ACCELERATE_PROPOSAL = false;
+var MOCKED_PROPOSAL_STATUSES = [
+  ProposalStatus.Active,
+  ProposalStatus.PendingQueue,
+  ProposalStatus.PendingExecution,
+  ProposalStatus.Defeated,
+  ProposalStatus.QuorumNotReached
+];
+function computeActualStatus(proposal, proposalOnChainState) {
+  const timestampInSeconds = Date.now() / 1e3;
+  if (proposalOnChainState !== void 0) {
+    if (proposal.status === ProposalStatus.CanceledByGuardian) {
+      return ProposalStatus.CanceledByGuardian;
+    }
+    if (proposalOnChainState === 2 /* Canceled */) {
+      if (Number(proposal.voteStartAt) < timestampInSeconds)
+        return ProposalStatus.CanceledByUser;
+      return ProposalStatus.CanceledByGuardian;
+    }
+    if (proposalOnChainState === 3 /* Defeated */) {
+      if (!proposal.pollResult) {
+        return ProposalStatus.QuorumNotReached;
+      }
+      if (
+        // Quorum might be null if no votes were cast.
+        !proposal.quorum || BigInt(proposal.quorum) > BigInt(proposal.pollResult.totalTowardsQuorum)
+      ) {
+        return ProposalStatus.QuorumNotReached;
+      }
+      return ProposalStatus.Defeated;
+    }
+    if (proposalOnChainState === 4 /* Succeeded */) {
+      return ProposalStatus.PendingQueue;
+    }
+    if (proposalOnChainState === 5 /* Queued */) {
+      if (Number(proposal.queueEnd) < Date.now() / 1e3) {
+        return ProposalStatus.PendingExecution;
+      }
+      return ProposalStatus.InQueue;
+    }
+    if (proposalOnChainState === 6 /* Expired */) {
+      console.warn("Unexpected expired state on proposal id: ", proposal.id);
+      return ProposalStatus.Defeated;
+    }
+  }
+  if (proposal.status === ProposalStatus.InQueue) {
+    if (Number(proposal.queueEnd) < Date.now() / 1e3) {
+      return ProposalStatus.PendingExecution;
+    }
+  }
+  if (GOVERNANCE_ACCELERATE_PROPOSAL && proposalOnChainState === 1 /* Active */ && proposal.quorum && BigInt(proposal.quorum) < BigInt(proposal.pollResult.totalTowardsQuorum) && Number(proposal.pollResult.forPercentage) > Number(proposal.pollResult.againstPercentage)) {
+    return ProposalStatus.PendingQueue;
+  }
+  if (proposal.status === ProposalStatus.Pending) {
+    if (Number(proposal.voteStartAt) < timestampInSeconds && Number(proposal.voteEndAt) > timestampInSeconds) {
+      return ProposalStatus.Active;
+    }
+    if (Number(proposal.voteEndAt) < timestampInSeconds) {
+      if (!proposal.pollResult) {
+        return ProposalStatus.QuorumNotReached;
+      }
+      if (!proposal.quorum || BigInt(proposal.quorum) > BigInt(proposal.pollResult.totalTowardsQuorum)) {
+        return ProposalStatus.QuorumNotReached;
+      }
+      if (proposal.pollResult?.against > proposal.pollResult?.for) {
+        return ProposalStatus.Defeated;
+      }
+      return ProposalStatus.PendingQueue;
+    }
+    return ProposalStatus.Pending;
+  }
+  if (proposal.status === ProposalStatus.Active && Number(proposal.voteEndAt) < timestampInSeconds) {
+    if (!proposal.quorum || BigInt(proposal.quorum) > BigInt(proposal.pollResult.totalTowardsQuorum)) {
+      return ProposalStatus.QuorumNotReached;
+    }
+    if (BigInt(proposal.pollResult?.against ?? 0n) > BigInt(proposal.pollResult?.for ?? 0n)) {
+      return ProposalStatus.Defeated;
+    }
+    return ProposalStatus.PendingQueue;
+  }
+  if (proposal.status === ProposalStatus.InQueue) {
+    if (Number(proposal.queueEnd) < Date.now() / 1e3) {
+      return ProposalStatus.PendingExecution;
+    }
+  }
+  return proposal.status;
+}
+
+// src/actions/governance/getDecodedFunctionData.ts
+import {
+  decodeFunctionData,
+  erc20Abi,
+  pad,
+  toFunctionSignature,
+  trim
+} from "viem";
+import { appConfig, defaultChainId } from "@berachain/config/internal";
+import { beraChefAbi } from "@berachain/abis/pol/rewards/beraChef";
+import { rewardVaultAbi } from "@berachain/abis/pol/rewards/rewardVault";
+function isProxyABI(abi) {
+  return abi.some((item) => {
+    const i = item;
+    return i.name === "implementation" || i.name === "proxyType" || i.type === "constructor" && i.inputs?.[0]?.name === "implementation";
+  });
+}
+async function _getAbi({
+  contractAddress,
+  chainId,
+  publicClient
+}) {
+  const url = `https://api.etherscan.io/v2/api?module=contract&action=getabi&address=${contractAddress}&apikey=${appConfig.apiKeys.private.etherscan}&chainId=${chainId}`;
+  const response = await fetch(url);
+  if (!response.ok) {
+    throw new Error(`Failed to fetch ABI: ${response.statusText}`);
+  }
+  const data = await response.json();
+  if (data.status === "0") throw new Error(data.result);
+  const abi = JSON.parse(data.result);
+  if (!isProxyABI(abi)) return abi;
+  const implementationResult = await publicClient.getStorageAt({
+    address: contractAddress,
+    // bytes32(uint256(keccak256('eip1967.proxy.implementation')) - 1)).
+    slot: "0x360894a13ba1a3210667c828492db98dca3e2076cc3735a920a3ca505d382bbc"
+  });
+  if (!implementationResult || trim(implementationResult) === "0x00")
+    return abi;
+  const implementationAddress = pad(trim(implementationResult), { size: 20 });
+  return _getAbi({
+    contractAddress: implementationAddress,
+    chainId,
+    publicClient
+  });
+}
+async function _getAbiForCallData({
+  address,
+  callData,
+  knownAbi,
+  chainId,
+  publicClient
+}) {
+  try {
+    if (decodeFunctionData({ data: callData, abi: knownAbi })) {
+      return knownAbi;
+    }
+  } catch {
+  }
+  return _getAbi({ contractAddress: address, chainId, publicClient }).catch(
+    () => void 0
+  );
+}
+function _decodeCallData(callData, abi) {
+  try {
+    return decodeFunctionData({ data: callData, abi });
+  } catch {
+    return void 0;
+  }
+}
+function _findAbiItem(abi, functionName) {
+  return abi.find(
+    (a) => a.type === "function" && a.name === functionName
+  );
+}
+function _getFunctionSignature(abiItem) {
+  if (!abiItem) return;
+  try {
+    return toFunctionSignature(abiItem);
+  } catch (error) {
+    console.error(error);
+  }
+}
+async function getDecodedFunctionData({
+  address,
+  callData,
+  chainId = defaultChainId,
+  publicClient
+}) {
+  const knownAbi = [...beraChefAbi, ...rewardVaultAbi, ...erc20Abi];
+  const abi = await _getAbiForCallData({
+    address,
+    callData,
+    knownAbi,
+    chainId,
+    publicClient
+  });
+  const decodedData = _decodeCallData(callData, abi);
+  if (!abi || !decodedData) {
+    return { args: [] };
+  }
+  const abiItem = _findAbiItem(abi, decodedData.functionName);
+  const functionSignature = _getFunctionSignature(abiItem);
+  return {
+    abiItem,
+    functionSignature,
+    functionName: decodedData.functionName,
+    args: decodedData.args
+  };
+}
+export {
+  MOCKED_PROPOSAL_STATUSES,
+  checkProposalField,
+  computeActualStatus,
+  getAllProposals,
+  getBodyErrors,
+  getDecodedFunctionData,
+  getProposalDetails,
+  getProposalFromTx,
+  getProposalVotes,
+  parseProposalBody
+};

package/dist/actions/server/exports.d.ts

@@ -0,0 +1,13 @@
+import { Address } from 'viem';
+import { GetValidatorBlockStatsQuery } from '@berachain/graphql/pol/subgraph';
+
+/**
+ * Server-only RSC variant. Goes directly to the pol subgraph upstream
+ * (no auth required) through the shared Apollo client factory.
+ */
+declare function getDailyValidatorBlockStats({ pubKey, first, ...args }: BeraJS.BaseFunctionArgs & {
+    pubKey: Address;
+    first?: number;
+}): Promise<GetValidatorBlockStatsQuery | undefined>;
+
+export { getDailyValidatorBlockStats };

package/dist/actions/server/exports.mjs

@@ -0,0 +1,27 @@
+import {
+  getApolloClient
+} from "../../chunk-4Z4AK6SH.mjs";
+import "../../chunk-75M6TF7M.mjs";
+import "../../chunk-SZ5C44L5.mjs";
+import "../../chunk-XIYN6AL6.mjs";
+import "../../chunk-J5I45WGQ.mjs";
+
+// src/actions/server/getDailyValidatorBlockStats.ts
+import {
+  GetValidatorBlockStats
+} from "@berachain/graphql/pol/subgraph";
+async function getDailyValidatorBlockStats({
+  pubKey,
+  first = 1,
+  ...args
+}) {
+  const client = getApolloClient("pol.subgraph", args);
+  const result = await client.query({
+    query: GetValidatorBlockStats,
+    variables: { pubKey, first }
+  });
+  return result.data;
+}
+export {
+  getDailyValidatorBlockStats
+};