feat: add candidate creation flow

Author: dan13ram

apps/subgraph/schema.graphql

@@ -104,7 +104,16 @@ type Snapshot @entity {
   proposalCount: Int!
 }
 
-type Proposal @entity {
+interface ProposalMetadataEntity {
+  id: ID!
+  title: String
+  description: String
+  metadata: String
+  representedAddress: String
+  discussionUrl: String
+}
+
+type Proposal implements ProposalMetadataEntity @entity {
   id: ID!
   proposalId: Bytes!
   proposalNumber: Int!
@@ -192,7 +201,7 @@ type ProposalCandidateGroup @entity {
   currentAbstainCount: BigInt!
 }
 
-type ProposalCandidateVersion @entity {
+type ProposalCandidateVersion implements ProposalMetadataEntity @entity {
   id: ID!
   group: ProposalCandidateGroup!
   candidateId: Bytes!
@@ -202,12 +211,13 @@ type ProposalCandidateVersion @entity {
   targets: [Bytes!]!
   values: [BigInt!]!
   calldatas: [Bytes!]!
-  description: String!
+  title: String
+  description: String
+  metadata: String
+  representedAddress: String
+  discussionUrl: String
   proposalId: Bytes!
   createdAt: BigInt!
-  title: String!
-  summary: String!
-  discussionUrl: String
   signatures: [CandidateSponsorSignature!]! @derivedFrom(field: "version")
   signatureCount: BigInt!
   totalVoteWeight: BigInt!

apps/subgraph/src/eas.ts

@@ -1,4 +1,4 @@
-import { Address, BigInt, Bytes, json, JSONValueKind } from '@graphprotocol/graph-ts'
+import { Address, BigInt, Bytes } from '@graphprotocol/graph-ts'
 
 import {
   Attested as AttestedEvent,
@@ -32,6 +32,7 @@ import {
   PROPOSAL_CANDIDATE_SCHEMA_UID,
   TREASURY_ASSET_PIN_SCHEMA_UID,
 } from './utils/eas'
+import { parseProposalMetadata } from './utils/proposalMetadata'
 
 const ZERO_BYTES32 = '0x0000000000000000000000000000000000000000000000000000000000000000'
 
@@ -206,23 +207,11 @@ function loadOrCreateCandidateGroup(
     group.currentAgainstCount = BigInt.fromI32(0)
     group.currentAbstainCount = BigInt.fromI32(0)
     group.leadingVersion = null
+    group.save()
   }
   return group
 }
 
-function getDescriptionField(description: string, key: string): string {
-  let parsedResult = json.try_fromString(description)
-  if (parsedResult.isError || parsedResult.value.kind != JSONValueKind.OBJECT) {
-    return ''
-  }
-  let obj = parsedResult.value.toObject()
-  let value = obj.get(key)
-  if (!value || value.kind != JSONValueKind.STRING) {
-    return ''
-  }
-  return value.toString()
-}
-
 function recomputeVersionSignatureAggregates(versionId: string): void {
   let version = ProposalCandidateVersion.load(versionId)
   if (!version) return
@@ -397,15 +386,24 @@ function handleProposalCandidateAttestation(event: AttestedEvent): void {
   version.targets = targets
   version.values = decoded.values
   version.calldatas = decoded.calldatas
-  version.description = decoded.description
+  version.metadata = decoded.description
   version.proposalId = decoded.proposalId
   version.createdAt = event.block.timestamp
-  let title = getDescriptionField(decoded.description, 'title')
-  let summary = getDescriptionField(decoded.description, 'description')
-  let discussionUrl = getDescriptionField(decoded.description, 'discussionUrl')
-  version.title = title.length > 0 ? title : ''
-  version.summary = summary.length > 0 ? summary : ''
-  version.discussionUrl = discussionUrl.length > 0 ? discussionUrl : null
+  let parsedMetadata = parseProposalMetadata(decoded.description)
+  version.title =
+    parsedMetadata && parsedMetadata.title.length > 0 ? parsedMetadata.title : null
+  version.description =
+    parsedMetadata && parsedMetadata.description.length > 0
+      ? parsedMetadata.description
+      : null
+  version.representedAddress =
+    parsedMetadata && parsedMetadata.representedAddress.length > 0
+      ? parsedMetadata.representedAddress
+      : null
+  version.discussionUrl =
+    parsedMetadata && parsedMetadata.discussionUrl.length > 0
+      ? parsedMetadata.discussionUrl
+      : null
   version.save()
   recomputeGroupVersionAggregates(group.id)
   recomputeGroupLeadingVersion(group.id)

apps/subgraph/src/governor.ts

@@ -5,8 +5,6 @@ import {
   Bytes,
   crypto,
   dataSource,
-  json,
-  JSONValueKind,
   log,
 } from '@graphprotocol/graph-ts'
 
@@ -33,49 +31,26 @@ import {
 } from '../generated/templates/Governor/Governor'
 import { Token as TokenContract } from '../generated/templates/Governor/Token'
 import { Treasury as TreasuryContract } from '../generated/templates/Governor/Treasury'
+import { parseProposalMetadata } from './utils/proposalMetadata'
 
 function parseDescriptionFields(descriptionMetadata: string): string[] {
   let title: string | null = null
   let description: string | null = null
   let representedAddress: string | null = null
   let discussionUrl: string | null = null
 
-  let parsedDescriptionResult = json.try_fromString(descriptionMetadata)
-
-  if (
-    !parsedDescriptionResult.isError &&
-    parsedDescriptionResult.value.kind == JSONValueKind.OBJECT
-  ) {
-    let parsedDescription = parsedDescriptionResult.value.toObject()
-
-    let parsedTitle = parsedDescription.get('title')
-    if (parsedTitle && parsedTitle.kind == JSONValueKind.STRING) {
-      let parsedTitleValue = parsedTitle.toString()
-      title = parsedTitleValue.length > 0 ? parsedTitleValue : null
-    }
-
-    let parsedBody = parsedDescription.get('description')
-    if (parsedBody && parsedBody.kind == JSONValueKind.STRING) {
-      let parsedBodyValue = parsedBody.toString()
-      description = parsedBodyValue.length > 0 ? parsedBodyValue : null
-    }
-
-    let parsedRepresentedAddress = parsedDescription.get('representedAddress')
-    if (
-      parsedRepresentedAddress &&
-      parsedRepresentedAddress.kind == JSONValueKind.STRING
-    ) {
-      let parsedRepresentedAddressValue = parsedRepresentedAddress.toString()
-      representedAddress =
-        parsedRepresentedAddressValue.length > 0 ? parsedRepresentedAddressValue : null
-    }
-
-    let parsedDiscussionUrl = parsedDescription.get('discussionUrl')
-    if (parsedDiscussionUrl && parsedDiscussionUrl.kind == JSONValueKind.STRING) {
-      let parsedDiscussionUrlValue = parsedDiscussionUrl.toString()
-      discussionUrl =
-        parsedDiscussionUrlValue.length > 0 ? parsedDiscussionUrlValue : null
-    }
+  let parsedDescription = parseProposalMetadata(descriptionMetadata)
+
+  if (parsedDescription) {
+    title = parsedDescription.title.length > 0 ? parsedDescription.title : null
+    description =
+      parsedDescription.description.length > 0 ? parsedDescription.description : null
+    representedAddress =
+      parsedDescription.representedAddress.length > 0
+        ? parsedDescription.representedAddress
+        : null
+    discussionUrl =
+      parsedDescription.discussionUrl.length > 0 ? parsedDescription.discussionUrl : null
   } else {
     let split = descriptionMetadata.split('&&')
     title = split.length > 0 && split[0].length > 0 ? split[0] : null

apps/subgraph/src/utils/proposalMetadata.ts

@@ -0,0 +1,44 @@
+import { json, JSONValue, JSONValueKind, TypedMap } from '@graphprotocol/graph-ts'
+
+export class ParsedProposalMetadata {
+  title: string
+  description: string
+  representedAddress: string
+  discussionUrl: string
+
+  constructor(
+    title: string = '',
+    description: string = '',
+    representedAddress: string = '',
+    discussionUrl: string = ''
+  ) {
+    this.title = title
+    this.description = description
+    this.representedAddress = representedAddress
+    this.discussionUrl = discussionUrl
+  }
+}
+
+function getStringField(obj: TypedMap<string, JSONValue>, key: string): string {
+  let value = obj.get(key)
+  if (!value || value.kind != JSONValueKind.STRING) {
+    return ''
+  }
+
+  return value.toString()
+}
+
+export function parseProposalMetadata(metadata: string): ParsedProposalMetadata | null {
+  let parsedResult = json.try_fromString(metadata)
+  if (parsedResult.isError || parsedResult.value.kind != JSONValueKind.OBJECT) {
+    return null
+  }
+
+  let obj = parsedResult.value.toObject()
+  return new ParsedProposalMetadata(
+    getStringField(obj, 'title'),
+    getStringField(obj, 'description'),
+    getStringField(obj, 'representedAddress'),
+    getStringField(obj, 'discussionUrl')
+  )
+}

apps/subgraph/tests/proposalMetadata.test.ts

@@ -0,0 +1,24 @@
+import { assert, describe, test } from 'matchstick-as'
+
+import { parseProposalMetadata } from '../src/utils/proposalMetadata'
+
+describe('Proposal metadata parser', () => {
+  test('parses canonical proposal metadata JSON', () => {
+    const parsed = parseProposalMetadata(
+      '{"version":1,"title":"JSON title","description":"JSON body","representedAddress":"0x1234","discussionUrl":"https://example.com/discussion","transactionBundles":[{"type":"transfer","callCount":1}]}'
+    )
+
+    assert.assertNotNull(parsed)
+    if (!parsed) return
+
+    assert.stringEquals(parsed.title, 'JSON title')
+    assert.stringEquals(parsed.description, 'JSON body')
+    assert.stringEquals(parsed.representedAddress, '0x1234')
+    assert.stringEquals(parsed.discussionUrl, 'https://example.com/discussion')
+  })
+
+  test('returns null for non-json metadata', () => {
+    const parsed = parseProposalMetadata('Legacy title&&Legacy body')
+    assert.assertTrue(parsed == null)
+  })
+})

apps/web/next.config.js

@@ -37,6 +37,7 @@ const basicConfig = {
     '@buildeross/stores',
     '@buildeross/auction-ui',
     '@buildeross/proposal-ui',
+    '@buildeross/candidate-ui',
     '@buildeross/dao-ui',
     '@buildeross/feed-ui',
     '@buildeross/create-proposal-ui',

apps/web/package.json

@@ -6,6 +6,7 @@
     "@buildeross/analytics": "workspace:*",
     "@buildeross/auction-ui": "workspace:*",
     "@buildeross/blocklist": "workspace:*",
+    "@buildeross/candidate-ui": "workspace:*",
     "@buildeross/constants": "workspace:*",
     "@buildeross/create-dao-ui": "workspace:*",
     "@buildeross/create-proposal-ui": "workspace:*",

apps/web/src/pages/dao/[network]/[token]/candidate/[candidateId].tsx

@@ -2,8 +2,9 @@ import { CACHE_TIMES } from '@buildeross/constants/cacheTimes'
 import { PUBLIC_DEFAULT_CHAINS } from '@buildeross/constants/chains'
 import type { CandidateGroup } from '@buildeross/sdk'
 import { getCandidateGroup } from '@buildeross/sdk'
+import { getDAOAddresses } from '@buildeross/sdk/contract'
 import { useChainStore } from '@buildeross/stores'
-import { CHAIN_ID } from '@buildeross/types'
+import { AddressType, CHAIN_ID } from '@buildeross/types'
 import { Box, Button, Flex, Stack, Text } from '@buildeross/zord'
 import { GetServerSideProps } from 'next'
 import { useRouter } from 'next/router'
@@ -130,9 +131,9 @@ const CandidateDetailPage: NextPageWithLayout<CandidateDetailPageProps> = ({
               </Box>
               <Box>
                 <Text fontWeight="label" fontSize={14} mb="x1">
-                  Summary
+                  Description
                 </Text>
-                <Text>{candidate.leadingVersion.summary}</Text>
+                <Text>{candidate.leadingVersion.description}</Text>
               </Box>
               {candidate.leadingVersion.discussionUrl && (
                 <Box>
@@ -201,7 +202,7 @@ CandidateDetailPage.getLayout = getDaoLayout
 
 export const getServerSideProps: GetServerSideProps = async (context) => {
   const network = context.params?.network as string
-  // const token = context.params?.token as string
+  const token = context.params?.token as AddressType
   const candidateId = context.params?.candidateId as string
 
   // Validate network
@@ -213,6 +214,12 @@ export const getServerSideProps: GetServerSideProps = async (context) => {
     return { notFound: true }
   }
 
+  const addresses = await getDAOAddresses(validChain.id, token)
+
+  if (!addresses) {
+    return { notFound: true }
+  }
+
   // Fetch candidate data server-side
   let initialData: CandidateGroup | undefined
   try {
@@ -233,8 +240,10 @@ export const getServerSideProps: GetServerSideProps = async (context) => {
 
   return {
     props: {
+      addresses,
       candidateId,
       initialData: initialData || null,
+      chainId: validChain.id,
     },
   }
 }