support telegram proposal execution and closure notifications

src/webhooks/webhooks/telegram.ts

@@ -3,6 +3,8 @@ import {
   activeProposalModules,
   config as daoCoreConfig,
 } from '@/formulas/formulas/contract/daoCore/base'
+import { MultipleChoiceProposal } from '@/formulas/formulas/contract/proposal/daoProposalMultiple/types'
+import { SingleChoiceProposal } from '@/formulas/formulas/contract/proposal/daoProposalSingle/types'
 import { StatusEnum } from '@/formulas/formulas/contract/proposal/types'
 import { WebhookMaker, WebhookType } from '@/types'
 import { dbKeyForKeys, dbKeyToKeys } from '@/utils'
@@ -82,6 +84,7 @@ export const makeProposalCreated: WebhookMaker<WasmStateEvent> = (
     const daoUrl = config.daoDaoBase + `/dao/${daoAddress}`
 
     return {
+      type: 'proposal_created',
       apiKey: config.telegramNotifierApiKey,
       daoName: daoConfig.name,
       proposalTitle: event.valueJson.title,
@@ -92,3 +95,122 @@ export const makeProposalCreated: WebhookMaker<WasmStateEvent> = (
     }
   },
 })
+
+// Fire webhook when a proposal is executed or closed.
+export const makeProposalExecutedOrClosed: WebhookMaker<WasmStateEvent> = (
+  config,
+  state
+) => ({
+  filter: {
+    EventType: WasmStateEvent,
+    codeIdsKeys: CODE_IDS_KEYS,
+    matches: (event) =>
+      // Starts with proposals or proposals_v2.
+      (event.key.startsWith(KEY_PREFIX_PROPOSALS) ||
+        event.key.startsWith(KEY_PREFIX_PROPOSALS_V2)) &&
+      (event.valueJson.status === StatusEnum.Executed ||
+        event.valueJson.status === StatusEnum.ExecutionFailed ||
+        event.valueJson.status === StatusEnum.Closed),
+  },
+  endpoint: async (event, env) => {
+    const daoAddress = await getDaoAddressForProposalModule({
+      ...env,
+      contractAddress: event.contractAddress,
+    })
+    if (!daoAddress) {
+      return
+    }
+
+    return {
+      type: WebhookType.Url,
+      url: `https://telegram-notifier.dao-dao.workers.dev/${state.chainId}/${daoAddress}/notify`,
+      method: 'POST',
+    }
+  },
+  getValue: async (event, getLastEvent, env) => {
+    // Only fire the webhook if the last event was not executed.
+    const lastEvent = await getLastEvent()
+    if (
+      lastEvent &&
+      (lastEvent.valueJson.status === StatusEnum.Executed ||
+        lastEvent.valueJson.status === StatusEnum.ExecutionFailed ||
+        lastEvent.valueJson.status === StatusEnum.Closed)
+    ) {
+      return
+    }
+
+    // Get DAO config and proposal modules for this DAO so we can retrieve the
+    // DAO's name and the prefix for this proposal module.
+    const daoAddress = await getDaoAddressForProposalModule({
+      ...env,
+      contractAddress: event.contractAddress,
+    })
+    if (!daoAddress) {
+      return
+    }
+
+    const daoConfig = await daoCoreConfig.compute({
+      ...env,
+      contractAddress: daoAddress,
+    })
+    const proposalModules = await activeProposalModules.compute({
+      ...env,
+      contractAddress: daoAddress,
+    })
+    const proposalModule = proposalModules?.find(
+      (proposalModule) => proposalModule.address === event.contractAddress
+    )
+
+    if (!daoConfig || !proposalModule) {
+      return
+    }
+
+    // "proposals"|"proposals_v2", proposalNum
+    const [, proposalNum] = dbKeyToKeys(event.key, [false, true])
+    const proposalId = `${proposalModule.prefix}${proposalNum}`
+    const proposal: SingleChoiceProposal | MultipleChoiceProposal =
+      event.valueJson
+
+    // Include winning option if executed and multiple choice proposal.
+    let winningOption: string | undefined
+    if (
+      event.valueJson.status !== StatusEnum.Closed &&
+      'choices' in proposal &&
+      'votes' in proposal
+    ) {
+      // Pick choice with largest voting weight.
+      const winningChoice = proposal.choices.reduce((curr, choice) => {
+        const currentWeight = BigInt(proposal.votes.vote_weights[curr.index])
+        const weight = BigInt(proposal.votes.vote_weights[choice.index])
+        return currentWeight > weight ? curr : choice
+      })
+      winningOption = winningChoice?.title
+    }
+
+    const daoUrl = config.daoDaoBase + `/dao/${daoAddress}`
+
+    const type =
+      event.valueJson.status === StatusEnum.Executed
+        ? 'proposal_executed'
+        : event.valueJson.status === StatusEnum.ExecutionFailed
+        ? 'proposal_execution_failed'
+        : event.valueJson.status === StatusEnum.Closed
+        ? 'proposal_closed'
+        : ''
+    if (!type) {
+      return
+    }
+
+    return {
+      type,
+      apiKey: config.telegramNotifierApiKey,
+      daoName: daoConfig.name,
+      proposalTitle: event.valueJson.title,
+      proposalDescription: event.valueJson.description,
+      proposalId,
+      daoUrl,
+      url: daoUrl + `/proposals/${proposalId}`,
+      winningOption,
+    }
+  },
+})