@berachain/berajs 0.2.11 → 0.2.13

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

@@ -1,186 +1,15 @@
-import * as react from 'react';
-import { GovernanceTopic, CustomProposalErrors, CustomProposal } from '../../types/governance/exports.js';
-import * as _berachain_utils_pkg_swr from '@berachain/utils/pkg/swr';
-import { SWRResponse } from '@berachain/utils/pkg/swr';
-import { Address } from 'viem';
-import * as _berachain_graphql_governance from '@berachain/graphql/governance';
-import { Proposal_Filter, Proposal_OrderBy, OrderDirection, ProposalStatus, ProposalSelectionFragment, ProposalWithVotesFragment, GetProposalVotesQueryVariables } from '@berachain/graphql/governance';
-import { SWRInfiniteResponse, SWRInfiniteKeyLoader } from '@berachain/utils/pkg/swr/infinite';
-import { D as DefaultHookOptions, a as DefaultHookReturnType } from '../../global.d-q_LQWQqs.js';
-import * as swr_infinite from 'swr/infinite';
-import { g as getProposalVotes } from '../../getProposalVotes-DAUrdX2n.js';
-import * as swr__internal from 'swr/_internal';
-import '../../enum/governance/exports.js';
-import '@wagmi/core';
-import '@berachain/config';
-import '../../txnEnum-ByI5dtDi.js';
-import '../../BeraError-7-A5JYy_.js';
-
-declare const useCreateProposal: ({ initialData, currentTopic, onError, }: {
-    initialData?: any;
-    currentTopic: GovernanceTopic;
-    onError: (e: CustomProposalErrors) => void;
-}) => {
-    proposal: CustomProposal;
-    setProposal: react.Dispatch<react.SetStateAction<CustomProposal>>;
-    addProposalAction: () => void;
-    removeProposalAction: (idx: number) => void;
-    computeParamsAndErrors: () => readonly [`0x${string}`[], bigint[], `0x${string}`[], string] | undefined;
-};
-
-/**
- * Returns the amount of voting power that a wallet had when the voting period began.
- * {@link https://docs.openzeppelin.com/contracts/5.x/api/governance#Votes-getPastVotes-address-uint256-}
- */
-declare const useGetPastVotes: (args: {
-    wallet?: Address;
-} & ({
-    proposalId?: bigint;
-    timepoint: number | bigint;
-} | {
-    proposalId: bigint;
-    timepoint?: number | bigint;
-})) => _berachain_utils_pkg_swr.SWRResponse<string, any, any>;
-
-declare const useHasVoted: ({ proposalId, wallet, }: {
-    proposalId: string;
-    wallet?: Address;
-}) => _berachain_utils_pkg_swr.SWRResponse<boolean, any, any>;
-
-declare const useIsCanceller: ({ account, ...baseArgs }: {
-    account: Address | undefined;
-} & BeraJS.BaseFunctionArgs) => _berachain_utils_pkg_swr.SWRResponse<boolean, any, any>;
-
-type UsePollAllProposalsArgs = {
-    topic: string;
-    where?: Proposal_Filter;
-    perPage?: number;
-    orderBy?: Proposal_OrderBy;
-    orderDirection?: OrderDirection;
-    status_in?: ProposalStatus[];
-    text?: string;
-    autoRefreshProposals?: boolean;
-};
-type ProposalResult = {
-    data: ProposalSelectionFragment[][];
-    hasMore: boolean;
-} & Omit<SWRInfiniteResponse<ProposalSelectionFragment[]>, "data">;
-type PollAllProposalsKey = [
-    "usePollAllProposals",
-    number,
-    string,
-    Proposal_Filter | undefined,
-    ProposalStatus[] | undefined,
-    Proposal_OrderBy | undefined,
-    OrderDirection | undefined,
-    number,
-    string | undefined
-] | null;
-declare function usePollAllProposalsQueryKey(topic: string, args?: Partial<UsePollAllProposalsArgs>): (pageIndex: number, previousPageData?: ProposalSelectionFragment[] | null) => PollAllProposalsKey;
-/**
- * Fetch all proposals for a given topic
- */
-declare function usePollAllProposals(args: UsePollAllProposalsArgs, options?: DefaultHookOptions & {
-    autoRefresh?: boolean;
-}): ProposalResult;
-
-interface UsePollProposalResponse extends DefaultHookReturnType<ProposalWithVotesFragment> {
-}
-/**
- * Polls a proposal and returns the proposal details.
- * Pulls data from the subgraph and onchain.
- *
- * @param proposalId - The ID of the proposal to poll
- * @param options - Optional configuration options
- * @param options.autoRefresh - If true, the data will be refreshed automatically based on the block number and status threshold
- * @returns {UsePollProposalResponse} Object containing:
- *   - data: ProposalWithVotesFragment | undefined - The proposal data if successful
- *   - error: Error | undefined - Error object if request failed
- *   - isLoading: boolean - True while data is being fetched
- *   - isValidating: boolean - True while data is being revalidated
- *   - mutate: () => Promise<ProposalWithVotesFragment | undefined> - Function to manually refresh the data
- *   - refresh: () => Promise<void> - Function to manually refresh the data
- */
-declare const usePollProposal: (proposalId: string, options?: DefaultHookOptions & {
-    autoRefresh?: boolean;
-}) => UsePollProposalResponse;
-
-declare const usePollProposalThreshold: (governorAddress: Address) => DefaultHookReturnType<{
-    votesThreshold: string;
-}>;
-
-type UsePollProposalVotesArgs = Omit<GetProposalVotesQueryVariables, "offset" | "limit">;
-type ProposalVotesKey = [
-    string,
-    number,
-    number,
-    UsePollProposalVotesArgs["proposalId"],
-    UsePollProposalVotesArgs["orderBy"],
-    UsePollProposalVotesArgs["orderDirection"]
-] | null;
-/**
- * Fetches all the votes for a proposal from the Subgraph
- * @param args - The arguments to pass to the query
- * @param total - The total amount of pages of votes to fetch
- */
-declare const usePollProposalVotes: (args: UsePollProposalVotesArgs, total: number) => swr_infinite.SWRInfiniteResponse<{
-    data: _berachain_graphql_governance.GetProposalVotesQuery;
-}, any>;
-declare const usePollProposalVotesQueryKey: ({ ...args }: UsePollProposalVotesArgs, total: number) => SWRInfiniteKeyLoader<Awaited<ReturnType<typeof getProposalVotes>>, ProposalVotesKey>;
-
-declare const usePollUserDelegates: (options?: DefaultHookOptions) => DefaultHookReturnType<{
-    delegate: Address;
-    currentVotes: string | undefined;
-}>;
-
-declare const useProposalFromTx: (txHash?: Address) => SWRResponse<ProposalWithVotesFragment | null>;
-
-/**
- * Timepoint used to retrieve user’s votes and quorum. If using block
- * number (as per Compound’s Comp), the snapshot is performed at
- * the end of this block. Hence, voting for this proposal starts at the beginning of the following block.
- *
- * {@link https://docs.openzeppelin.com/contracts/5.x/api/governance#IGovernor-proposalSnapshot-uint256-}
- */
-declare const useProposalSnapshot: ({ proposalId, }: {
-    proposalId: number | bigint | string | undefined;
-}) => SWRResponse<string>;
-
-declare const useProposalState: ({ proposalId, governorAddress, }: {
-    proposalId: number | bigint | string | undefined;
-    governorAddress: Address;
-}) => SWRResponse<string>;
-
-declare const TimelockOperationState: {
-    readonly 0: "unset";
-    readonly 1: "waiting";
-    readonly 2: "ready";
-    readonly 3: "done";
-};
-/**
- * Fetches the state of a proposal timelock
- * @returns state of the proposal timelock (unset, waiting, ready, done)
- */
-declare function useProposalTimelockState({ proposalTimelockId, timelockAddress, }: {
-    proposalTimelockId: Address | undefined;
-    timelockAddress: Address;
-}): SWRResponse<(typeof TimelockOperationState)[keyof typeof TimelockOperationState]>;
-
-/**
- * Queries the quorum for a given timestamp.
- *
- * @returns current quorum if timestamp is in the future.
- */
-declare function useQuorum({ at }: {
-    at: number | string;
-}, { isEnabled, }: {
-    isEnabled?: boolean;
-}): {
-    data: number | undefined;
-    error: any;
-    mutate: _berachain_utils_pkg_swr.KeyedMutator<string>;
-    isValidating: boolean;
-    isLoading: swr__internal.IsLoadingResponse<Data, Config>;
-};
-
-export { type UsePollProposalResponse, useCreateProposal, useGetPastVotes, useHasVoted, useIsCanceller, usePollAllProposals, usePollAllProposalsQueryKey, usePollProposal, usePollProposalThreshold, usePollProposalVotes, usePollProposalVotesQueryKey, usePollUserDelegates, useProposalFromTx, useProposalSnapshot, useProposalState, useProposalTimelockState, useQuorum };
+export { useCreateProposal } from "./useCreateProposal";
+export * from "./useGetPastVotes";
+export * from "./useHasVoted";
+export * from "./useIsCanceller";
+export * from "./usePollAllProposals";
+export * from "./usePollProposal";
+export * from "./usePollProposalThreshold";
+export * from "./usePollProposalVotes";
+export * from "./usePollUserDelegates";
+export * from "./useProposalFromTx";
+export * from "./useProposalSnapshot";
+export * from "./useProposalState";
+export * from "./useProposalTimelockState";
+export * from "./useQuorum";
+//# sourceMappingURL=exports.d.ts.map

package/dist/hooks/governance/exports.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"exports.d.ts","sourceRoot":"","sources":["../../../src/hooks/governance/exports.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,qBAAqB,CAAC;AACxD,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,uBAAuB,CAAC;AACtC,cAAc,mBAAmB,CAAC;AAClC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,wBAAwB,CAAC;AACvC,cAAc,wBAAwB,CAAC;AACvC,cAAc,qBAAqB,CAAC;AACpC,cAAc,uBAAuB,CAAC;AACtC,cAAc,oBAAoB,CAAC;AACnC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,aAAa,CAAC"}

package/dist/hooks/governance/exports.mjs

@@ -5,20 +5,21 @@ import {
   getProposalDetails,
   getProposalFromTx,
   getProposalVotes
-} from "../../chunk-GUURQAME.mjs";
-import "../../chunk-DKMAIU74.mjs";
+} from "../../chunk-EGAB6NFQ.mjs";
+import "../../chunk-KL6YZ5VR.mjs";
 import {
   useSWR,
   useSWRImmutable
-} from "../../chunk-UD5IUNCW.mjs";
-import "../../chunk-SGIJVHZO.mjs";
+} from "../../chunk-RM227WHI.mjs";
+import "../../chunk-GLWPRM33.mjs";
 import {
+  assertDefined,
   assertPublicClient
-} from "../../chunk-GY6B3PD5.mjs";
+} from "../../chunk-QQASX4LJ.mjs";
 import {
   parseBaseArgs
-} from "../../chunk-DQRH5VE3.mjs";
-import "../../chunk-KHXJDYA4.mjs";
+} from "../../chunk-TGN55GKE.mjs";
+import "../../chunk-NZAH3SGT.mjs";
 
 // src/hooks/governance/useCreateProposal.ts
 import { useCallback, useEffect, useState } from "react";
@@ -240,11 +241,11 @@ var defaultAction = {
   rawCalldata: "0x",
   message: ""
 };
-var useCreateProposal = ({
+function useCreateProposal({
   initialData = {},
   currentTopic,
   onError
-}) => {
+}) {
   const [proposal, setProposal] = useState({
     title: "",
     description: "",
@@ -290,7 +291,7 @@ var useCreateProposal = ({
     removeProposalAction,
     computeParamsAndErrors
   };
-};
+}
 
 // src/hooks/governance/useGetPastVotes.ts
 import { formatUnits } from "viem";
@@ -300,9 +301,9 @@ import { useBeraWallet, usePublicClient as usePublicClient2 } from "@berachain/w
 // src/hooks/governance/useProposalSnapshot.ts
 import { berachainGovernanceAbi as governanceAbi } from "@berachain/abis/gov/berachainGovernance";
 import { usePublicClient } from "@berachain/wagmi/hooks";
-var useProposalSnapshot = ({
+function useProposalSnapshot({
   proposalId
-}) => {
+}) {
   const publicClient = usePublicClient();
   const QUERY_KEY = publicClient && proposalId ? ["useProposalSnapshot", proposalId] : null;
   return useSWRImmutable(QUERY_KEY, async ([, proposalId2]) => {
@@ -318,10 +319,10 @@ var useProposalSnapshot = ({
     });
     return snapshot.toString();
   });
-};
+}
 
 // src/hooks/governance/useGetPastVotes.ts
-var useGetPastVotes = (args) => {
+function useGetPastVotes(args) {
   const { address: account } = useBeraWallet();
   const publicClient = usePublicClient2();
   const wallet = args.wallet || account;
@@ -332,30 +333,30 @@ var useGetPastVotes = (args) => {
   const QUERY_KEY = ts && publicClient && wallet ? ["useGetPastVotes", ts, wallet] : null;
   return useSWRImmutable(QUERY_KEY, async ([, ts2, wallet2]) => {
     assertPublicClient(publicClient);
-    const { config } = parseBaseArgs({
-      chainId: publicClient.chain.id
-    });
     if (Number(ts2) > Date.now() / 1e3) {
       throw new Error("timepoint is in the future");
     }
+    const tokenAddress = parseBaseArgs({
+      chainId: publicClient.chain.id
+    }).config.tokens.bgt;
     const votes = await publicClient.readContract({
       abi: bgtAbi,
-      address: config.tokens.bgt,
+      address: tokenAddress,
       functionName: "getPastVotes",
       args: [wallet2, BigInt(ts2)]
     });
     return formatUnits(votes, 18);
   });
-};
+}
 
 // src/hooks/governance/useHasVoted.ts
 import { isAddress } from "viem";
 import { berachainGovernanceAbi as governanceAbi2 } from "@berachain/abis/gov/berachainGovernance";
 import { useBeraWallet as useBeraWallet2, usePublicClient as usePublicClient3 } from "@berachain/wagmi/hooks";
-var useHasVoted = ({
+function useHasVoted({
   proposalId,
   wallet
-}) => {
+}) {
   const { address: account } = useBeraWallet2();
   const publicClient = usePublicClient3();
   const address = wallet || account;
@@ -374,7 +375,7 @@ var useHasVoted = ({
       });
     }
   );
-};
+}
 
 // src/hooks/governance/useIsCanceller.ts
 import { timeLockAbi as governanceTimelockAbi } from "@berachain/abis/gov/timeLock";
@@ -384,10 +385,10 @@ import { usePublicClient as usePublicClient4 } from "@berachain/wagmi/hooks";
 var CANCELLER_ROLE = "0xfd643c72710c63c0180259aba6b2d05451e3591a24e58b62239378085726f783";
 
 // src/hooks/governance/useIsCanceller.ts
-var useIsCanceller = ({
+function useIsCanceller({
   account,
   ...baseArgs
-}) => {
+}) {
   const publicClient = usePublicClient4();
   const { config: chainConfig } = parseBaseArgs(baseArgs);
   const QUERY_KEY = account && publicClient ? ["useCancellerRole", account] : null;
@@ -408,7 +409,7 @@ var useIsCanceller = ({
       revalidateOnFocus: false
     }
   );
-};
+}
 
 // src/hooks/governance/usePollAllProposals.ts
 import { useEffect as useEffect2, useMemo, useState as useState2 } from "react";
@@ -432,7 +433,7 @@ var infinite_default = useSWRInfinite;
 
 // src/hooks/governance/usePollAllProposals.ts
 var DEFAULT_PER_PAGE = 10;
-var fromUiStatusToSubgraphStatuses = (status) => {
+function fromUiStatusToSubgraphStatuses(status) {
   switch (status) {
     case ProposalStatus.QuorumNotReached:
       return [ProposalStatus.Active, ProposalStatus.Pending];
@@ -444,7 +445,7 @@ var fromUiStatusToSubgraphStatuses = (status) => {
     default:
       return [status];
   }
-};
+}
 function usePollAllProposalsQueryKey(topic, args = {}) {
   const subgraphPageSize = 2 * (args.perPage ?? DEFAULT_PER_PAGE);
   return (pageIndex, previousPageData) => {
@@ -575,7 +576,7 @@ import {
   ProposalStatus as ProposalStatus2
 } from "@berachain/graphql/governance";
 import { usePublicClient as usePublicClient5 } from "@berachain/wagmi/hooks";
-var usePollProposal = (proposalId, options) => {
+function usePollProposal(proposalId, options) {
   const autoRefreshProposal = options?.autoRefresh ?? false;
   const publicClient = usePublicClient5();
   const QUERY_KEY = proposalId && publicClient ? ["usePollProposal", proposalId] : null;
@@ -603,35 +604,32 @@ var usePollProposal = (proposalId, options) => {
     switch (swrResponse.data.status) {
       case ProposalStatus2.Pending:
         if (timestamp >= Number(swrResponse.data.voteStartAt)) {
-          swrResponse.mutate();
+          swrResponse.refresh();
         }
         break;
       case ProposalStatus2.Active:
         if (timestamp >= Number(swrResponse.data.voteEndAt)) {
-          swrResponse.mutate();
+          swrResponse.refresh();
         }
         break;
       case ProposalStatus2.InQueue:
         if (Date.now() / 1e3 + 1 >= Number(swrResponse.data.queueEnd)) {
-          swrResponse.mutate();
+          swrResponse.refresh();
         }
         break;
     }
   }, [swrResponse.data?.status, timestamp]);
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse?.mutate?.()
-  };
-};
+  return swrResponse;
+}
 
 // src/hooks/governance/usePollProposalThreshold.ts
 import { formatEther } from "viem";
 import { berachainGovernanceAbi as governanceAbi3 } from "@berachain/abis/gov/berachainGovernance";
 import { usePublicClient as usePublicClient6 } from "@berachain/wagmi/hooks";
-var usePollProposalThreshold = (governorAddress) => {
+function usePollProposalThreshold(governorAddress) {
   const publicClient = usePublicClient6();
   const QUERY_KEY = publicClient ? ["usePollProposalThreshold", governorAddress] : null;
-  const swrResponse = useSWR(
+  return useSWR(
     QUERY_KEY,
     async ([, governorAddress2]) => {
       assertPublicClient(publicClient);
@@ -646,15 +644,11 @@ var usePollProposalThreshold = (governorAddress) => {
       refreshInterval: 18e4 /* SLOW */
     }
   );
-  return {
-    ...swrResponse,
-    refresh: swrResponse.mutate
-  };
-};
+}
 
 // src/hooks/governance/usePollProposalVotes.ts
 var DEFAULT_LIMIT = 1e3;
-var usePollProposalVotes = (args, total) => {
+function usePollProposalVotes(args, total) {
   return useSWRInfinite(
     usePollProposalVotesQueryKey(args, total),
     async ([_key, page]) => {
@@ -672,48 +666,48 @@ var usePollProposalVotes = (args, total) => {
       initialSize: Number.POSITIVE_INFINITY
     }
   );
-};
-var usePollProposalVotesQueryKey = ({ ...args }, total) => (pageIndex) => {
-  if (pageIndex > Math.floor(total / DEFAULT_LIMIT)) {
-    return null;
-  }
-  return [
-    "usePollProposalVotes",
-    pageIndex,
-    DEFAULT_LIMIT,
-    args.proposalId,
-    args.orderBy,
-    args.orderDirection
-  ];
-};
+}
+function usePollProposalVotesQueryKey({ ...args }, total) {
+  return (pageIndex) => {
+    if (pageIndex > Math.floor(total / DEFAULT_LIMIT)) {
+      return null;
+    }
+    return [
+      "usePollProposalVotes",
+      pageIndex,
+      DEFAULT_LIMIT,
+      args.proposalId,
+      args.orderBy,
+      args.orderDirection
+    ];
+  };
+}
 
 // src/hooks/governance/usePollUserDelegates.ts
 import { formatEther as formatEther2 } from "viem";
 import { bgtAbi as bgtAbi2 } from "@berachain/abis/pol/bgt";
 import { useBeraWallet as useBeraWallet3, usePublicClient as usePublicClient7 } from "@berachain/wagmi/hooks";
-var usePollUserDelegates = (options) => {
+function usePollUserDelegates(options) {
   const { address: account } = useBeraWallet3();
   const publicClient = usePublicClient7();
-  const QUERY_KEY = account ? ["usePollUserDelegates", account] : null;
-  const swrResponse = useSWR(
+  const QUERY_KEY = account && publicClient ? ["usePollUserDelegates", account] : null;
+  return useSWR(
     QUERY_KEY,
     async ([, account2]) => {
       assertPublicClient(publicClient);
-      const { config } = parseBaseArgs({
+      assertDefined(account2, "account");
+      const tokenAddress = parseBaseArgs({
         chainId: publicClient.chain.id
-      });
-      if (!publicClient || !account2) {
-        throw new Error("usePollUserDelegates needs publicClient and account");
-      }
+      }).config.tokens.bgt;
       const [delegate, currentVotes] = await Promise.all([
         publicClient.readContract({
-          address: config.tokens.bgt,
+          address: tokenAddress,
           abi: bgtAbi2,
           functionName: "delegates",
           args: [account2]
         }),
         publicClient.readContract({
-          address: config.tokens.bgt,
+          address: tokenAddress,
           abi: bgtAbi2,
           functionName: "getVotes",
           args: [account2]
@@ -729,21 +723,17 @@ var usePollUserDelegates = (options) => {
       refreshInterval: options?.refreshInterval ?? 18e4 /* SLOW */
     }
   );
-  return {
-    ...swrResponse,
-    refresh: () => swrResponse?.mutate?.()
-  };
-};
+}
 
 // src/hooks/governance/useProposalFromTx.ts
 import { usePublicClient as usePublicClient8, useTransactionReceipt } from "@berachain/wagmi/hooks";
-var useProposalFromTx = (txHash) => {
+function useProposalFromTx(txHash) {
   const { data: tx } = useTransactionReceipt({
     hash: txHash
   });
   const publicClient = usePublicClient8();
   const QUERY_KEY = tx && publicClient ? ["useProposalFromTx", txHash] : null;
-  const swrResponse = useSWR(QUERY_KEY, async ([, txHash2]) => {
+  return useSWR(QUERY_KEY, async ([, txHash2]) => {
     if (!tx) {
       throw new Error("Transaction not found");
     }
@@ -752,8 +742,7 @@ var useProposalFromTx = (txHash) => {
     }
     return getProposalFromTx({ tx, publicClient });
   });
-  return swrResponse;
-};
+}
 
 // src/hooks/governance/useProposalState.ts
 import { berachainGovernanceAbi as governanceAbi4 } from "@berachain/abis/gov/berachainGovernance";
@@ -768,10 +757,10 @@ var ProposalStateMap = {
   [6 /* Expired */]: "expired",
   [7 /* Executed */]: "executed"
 };
-var useProposalState = ({
+function useProposalState({
   proposalId,
   governorAddress
-}) => {
+}) {
   const publicClient = usePublicClient9();
   const QUERY_KEY = governorAddress && publicClient && proposalId ? ["useProposalState", proposalId] : null;
   return useSWRImmutable(QUERY_KEY, async ([, proposalId2]) => {
@@ -784,7 +773,7 @@ var useProposalState = ({
     });
     return ProposalStateMap[snapshot];
   });
-};
+}
 
 // src/hooks/governance/useProposalTimelockState.ts
 import { timeLockAbi as governanceTimelockAbi2 } from "@berachain/abis/gov/timeLock";
@@ -888,3 +877,4 @@ export {
   useProposalTimelockState,
   useQuorum
 };
+//# sourceMappingURL=exports.mjs.map