useGroupedProposals.ts

import { gql, request } from "graphql-request";
import { useQuery } from "wagmi";
import { useSnapshotConfig } from "./useSnapshotConfig";

// Snapshot docs here: https://docs.snapshot.org/tools/graphql-api
const PROPOSALS_QUERY = (snapshotSpace: string, startTimestamp: number) => gql`
  query {
    proposals(
      first: 100
      skip: 0
      where: { space_in: ["${snapshotSpace}"], created_gte: ${startTimestamp} }
      orderBy: "created"
      orderDirection: desc
    ) {
      id
      title
      start
      end
      snapshot
      state
    }
  }
`;

export type Proposal = {
  id: string;
  title: string;
  /** This is a **unix timestamp** (seconds, not ms).  */
  start: number;
  /** This is a **unix timestamp** (seconds, not ms).  */
  end: number;
  /** Block number as a string */
  snapshot: string;
  state: "closed" | "open" | "pending";
};

type ProposalsQueryResult = {
  proposals: Proposal[];
};

/**
 *
 * @returns Groups of proposals. Each group contains proposals that have the
 * same start and end.
 */
export const useGroupedProposals = () => {
  const snapshot = useSnapshotConfig();
  const fetch = async () => {
    const result = await request<ProposalsQueryResult>(
      snapshot.apiEndpoint,
      PROPOSALS_QUERY(snapshot.space, snapshot.startTimestamp),
    );
    const proposalGroups: Proposal[][] = [];

    // group all proposals that have the same start and end
    result.proposals.forEach((proposal) => {
      const group = proposalGroups.find(
        (group) =>
          group[0].start === proposal.start && group[0].end === proposal.end,
      );
      if (group) {
        group.push(proposal);
      } else {
        proposalGroups.push([proposal]);
      }
    });

    return proposalGroups;
  };

  return useQuery([snapshot.apiEndpoint, snapshot.space, "proposals"], fetch, {
    cacheTime: 604_800_000, // 7 days
    staleTime: 3_600_000, // 1 hour
    refetchInterval: 3_600_000, // 1 hour
    refetchIntervalInBackground: false,
  });
};