Merge pull request #127 from public-assembly/salief/adjust-proposal-q…

…uery

small mod to how props are returned

.changeset/nasty-ravens-glow.md

@@ -0,0 +1,5 @@
+---
+'@public-assembly/builder-utils': patch
+---
+
+getStatefulProposals now returns a proposals state as the corresponding string name. Votes is added to the dao proposals query.

packages/builder-utils/src/context/GovernorProvider.tsx

@@ -6,7 +6,7 @@ import { Proposal } from '../subgraph/types/graphql'
 import { Hex } from 'viem'
 import { getStatefulProposals } from '../lib/getProposalState'
 
-export type StatefulProposal = Omit<Proposal, '__typename' | 'votes'> & {
+export type StatefulProposal = Omit<Proposal, '__typename'> & {
   state: string
 }
 
@@ -28,7 +28,7 @@ export function GovernorProvider({ children }: PropsWithChildren) {
     if (!daoProposals) return
     // prettier-ignore
     (async () => {
-      setProposals(await getStatefulProposals(daoProposals, governorAddress))
+      setProposals(await getStatefulProposals(daoProposals, governorAddress as Hex))
     })()
   }, [daoProposals])
 

packages/builder-utils/src/lib/getProposalState.ts

@@ -2,32 +2,33 @@ import { governorAbi } from '../abi'
 import { Hash, Hex } from 'viem'
 import { readContract } from 'wagmi/actions'
 
-export enum ProposalState {
-  Pending = 0,
-  Active = 1,
-  Canceled = 2,
-  Defeated = 3,
-  Succeeded = 4,
-  Queued = 5,
-  Expired = 6,
-  Executed = 7,
-  Vetoed = 8,
+export const ProposalState = {
+  0: 'Pending',
+  1: 'Active',
+  2: 'Canceled',
+  3: 'Defeated',
+  4: 'Succeeded',
+  5: 'Queued',
+  6: 'Expired',
+  7: 'Executed',
+  8: 'Vetoed',
 }
 
 export const getProposalState = async (governorAddress: Hex, proposalId: Hash) => {
-  return (await readContract({
+  return await readContract({
     address: governorAddress,
     abi: governorAbi,
     functionName: 'state',
     args: [proposalId],
-  })) as ProposalState
+  })
 }
 
-export const getStatefulProposals = async (daoProposals, governorAddress) => {
+export const getStatefulProposals = async (daoProposals, governorAddress: Hex) => {
   const statefulProposals = await Promise.all(
     daoProposals.map(async (proposal) => {
       const state = await getProposalState(governorAddress, proposal.id)
-      return { ...proposal, state }
+      const stateString = ProposalState[state] // Access the string value from the ProposalState object
+      return { ...proposal, state: stateString }
     })
   )
 

packages/builder-utils/src/subgraph/hooks/useProposalDetailsQuery.ts

@@ -60,6 +60,7 @@ export function useProposalDetailsQuery({ proposalId }: { proposalId: string })
       transactionHash: proposalDetails?.proposal?.transactionHash,
       governorAddress: proposalDetails?.proposal?.dao.governorAddress,
       tokenAddress: proposalDetails?.proposal?.dao.tokenAddress,
+      votes: proposalDetails?.proposal?.votes,
     },
   }
 }

packages/builder-utils/src/subgraph/queries/proposalDetails.ts

@@ -33,6 +33,12 @@ export const PROPOSAL_DETAILS_QUERY = graphql(`
         governorAddress
         tokenAddress
       }
+      votes {
+        reason
+        support
+        voter
+        weight
+      }
     }
   }
 `)

packages/builder-utils/src/subgraph/types/gql.ts

@@ -27,7 +27,7 @@ const documents = {
     types.HistoricalAuctionDocument,
   '\n  query HistoricalToken($id: ID!, $tokenId: BigInt!) {\n    dao(id: $id) {\n      tokens(where: { tokenId: $tokenId }) {\n        tokenId\n        name\n        owner\n        mintedAt\n        image\n      }\n    }\n  }\n':
     types.HistoricalTokenDocument,
-  '\n  query ProposalDetails($proposalId: ID!) {\n    proposal(id: $proposalId) {\n      abstainVotes\n      againstVotes\n      calldatas\n      canceled\n      description\n      descriptionHash\n      executableFrom\n      executed\n      expiresAt\n      forVotes\n      proposalId\n      proposalNumber\n      proposalThreshold\n      proposer\n      queued\n      quorumVotes\n      targets\n      timeCreated\n      title\n      values\n      vetoed\n      voteCount\n      voteEnd\n      voteStart\n      snapshotBlockNumber\n      transactionHash\n      dao {\n        governorAddress\n        tokenAddress\n      }\n    }\n  }\n':
+  '\n  query ProposalDetails($proposalId: ID!) {\n    proposal(id: $proposalId) {\n      abstainVotes\n      againstVotes\n      calldatas\n      canceled\n      description\n      descriptionHash\n      executableFrom\n      executed\n      expiresAt\n      forVotes\n      proposalId\n      proposalNumber\n      proposalThreshold\n      proposer\n      queued\n      quorumVotes\n      targets\n      timeCreated\n      title\n      values\n      vetoed\n      voteCount\n      voteEnd\n      voteStart\n      snapshotBlockNumber\n      transactionHash\n      dao {\n        governorAddress\n        tokenAddress\n      }\n      votes {\n        reason\n        support\n        voter\n        weight\n      }\n    }\n  }\n':
     types.ProposalDetailsDocument,
   '\n  query ProposalVotes($proposalId: ID!) {\n    proposal(id: $proposalId) {\n      votes {\n        reason\n        support\n        voter\n        weight\n      }\n    }\n  }\n':
     types.ProposalVotesDocument,
@@ -93,8 +93,8 @@ export function graphql(
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */
 export function graphql(
-  source: '\n  query ProposalDetails($proposalId: ID!) {\n    proposal(id: $proposalId) {\n      abstainVotes\n      againstVotes\n      calldatas\n      canceled\n      description\n      descriptionHash\n      executableFrom\n      executed\n      expiresAt\n      forVotes\n      proposalId\n      proposalNumber\n      proposalThreshold\n      proposer\n      queued\n      quorumVotes\n      targets\n      timeCreated\n      title\n      values\n      vetoed\n      voteCount\n      voteEnd\n      voteStart\n      snapshotBlockNumber\n      transactionHash\n      dao {\n        governorAddress\n        tokenAddress\n      }\n    }\n  }\n'
-): typeof documents['\n  query ProposalDetails($proposalId: ID!) {\n    proposal(id: $proposalId) {\n      abstainVotes\n      againstVotes\n      calldatas\n      canceled\n      description\n      descriptionHash\n      executableFrom\n      executed\n      expiresAt\n      forVotes\n      proposalId\n      proposalNumber\n      proposalThreshold\n      proposer\n      queued\n      quorumVotes\n      targets\n      timeCreated\n      title\n      values\n      vetoed\n      voteCount\n      voteEnd\n      voteStart\n      snapshotBlockNumber\n      transactionHash\n      dao {\n        governorAddress\n        tokenAddress\n      }\n    }\n  }\n']
+  source: '\n  query ProposalDetails($proposalId: ID!) {\n    proposal(id: $proposalId) {\n      abstainVotes\n      againstVotes\n      calldatas\n      canceled\n      description\n      descriptionHash\n      executableFrom\n      executed\n      expiresAt\n      forVotes\n      proposalId\n      proposalNumber\n      proposalThreshold\n      proposer\n      queued\n      quorumVotes\n      targets\n      timeCreated\n      title\n      values\n      vetoed\n      voteCount\n      voteEnd\n      voteStart\n      snapshotBlockNumber\n      transactionHash\n      dao {\n        governorAddress\n        tokenAddress\n      }\n      votes {\n        reason\n        support\n        voter\n        weight\n      }\n    }\n  }\n'
+): typeof documents['\n  query ProposalDetails($proposalId: ID!) {\n    proposal(id: $proposalId) {\n      abstainVotes\n      againstVotes\n      calldatas\n      canceled\n      description\n      descriptionHash\n      executableFrom\n      executed\n      expiresAt\n      forVotes\n      proposalId\n      proposalNumber\n      proposalThreshold\n      proposer\n      queued\n      quorumVotes\n      targets\n      timeCreated\n      title\n      values\n      vetoed\n      voteCount\n      voteEnd\n      voteStart\n      snapshotBlockNumber\n      transactionHash\n      dao {\n        governorAddress\n        tokenAddress\n      }\n      votes {\n        reason\n        support\n        voter\n        weight\n      }\n    }\n  }\n']
 /**
  * The graphql function is used to parse GraphQL queries into a document that can be used by GraphQL clients.
  */

packages/builder-utils/src/subgraph/types/graphql.ts

@@ -2042,6 +2042,13 @@ export type ProposalDetailsQuery = {
     snapshotBlockNumber: any
     transactionHash: any
     dao: { __typename?: 'DAO'; governorAddress: any; tokenAddress: any }
+    votes: Array<{
+      __typename?: 'ProposalVote'
+      reason?: string | null
+      support: ProposalVoteSupport
+      voter: any
+      weight: number
+    }>
   } | null
 }
 
@@ -2735,6 +2742,19 @@ export const ProposalDetailsDocument = {
                     ],
                   },
                 },
+                {
+                  kind: 'Field',
+                  name: { kind: 'Name', value: 'votes' },
+                  selectionSet: {
+                    kind: 'SelectionSet',
+                    selections: [
+                      { kind: 'Field', name: { kind: 'Name', value: 'reason' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'support' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'voter' } },
+                      { kind: 'Field', name: { kind: 'Name', value: 'weight' } },
+                    ],
+                  },
+                },
               ],
             },
           },