feat: add AI summary

package.json

@@ -47,7 +47,8 @@
     "graphql": "^16.7.1",
     "multiformats": "^9",
     "mysql": "^2.18.1",
-    "node-fetch": "^2.7.0"
+    "node-fetch": "^2.7.0",
+    "openai": "^4.29.2"
   },
   "devDependencies": {
     "@snapshot-labs/eslint-config": "^0.1.0-beta.15",

src/api.ts

@@ -7,6 +7,7 @@ import mintPayload from './lib/nftClaimer/mint';
 import deployPayload from './lib/nftClaimer/deploy';
 import { queue, getProgress } from './lib/queue';
 import { snapshotFee } from './lib/nftClaimer/utils';
+import AISummary from './lib/ai';
 
 const router = express.Router();
 
@@ -37,6 +38,29 @@ router.all('/votes/:id', async (req, res) => {
   }
 });
 
+router.post('/ai/summary/:id', async (req, res) => {
+  const { id } = req.params;
+  const aiSummary = new AISummary(id, storageEngine(process.env.AI_SUMMARY_SUBDIR));
+
+  try {
+    let cachedSummary = await aiSummary.getCache()
+
+    let summary = '';
+
+    if (cachedSummary === false) {
+      summary = (await aiSummary.createCache()).toString();
+    } else {
+      console.log(cachedSummary.toString());
+      summary = cachedSummary.toString();
+    }
+
+    return rpcSuccess(res.status(200), summary, id);
+  } catch (e) {
+    capture(e);
+    return rpcError(res, 'INTERNAL_ERROR', id);
+  }
+});
+
 router.get('/moderation', async (req, res) => {
   const { list } = req.query;
 
@@ -87,4 +111,5 @@ router.post('/nft-claimer/mint', async (req, res) => {
   }
 });
 
+
 export default router;

src/helpers/snapshot.ts

@@ -9,6 +9,9 @@ export type Proposal = {
   space: Space;
   votes: number;
   author: string;
+  title: string;
+  body: string;
+  discussion: string;
 };
 
 export type Vote = {
@@ -23,6 +26,7 @@ export type Vote = {
 export type Space = {
   id: string;
   network: string;
+  name: string;
 };
 
 const httpLink = createHttpLink({
@@ -65,10 +69,14 @@ const PROPOSAL_QUERY = gql`
       state
       choices
       votes
+      title
+      body
+      discussion
       author
       space {
         id
         network
+        name
       }
     }
   }

src/lib/ai.ts

@@ -0,0 +1,64 @@
+import express from 'express';
+import bodyParser from 'body-parser';
+import { capture } from '@snapshot-labs/snapshot-sentry';
+import { URL } from 'url';
+import { rpcError, fetchWithKeepAlive } from '../helpers/utils';
+import OpenAI from 'openai';
+import { fetchProposal } from '../helpers/snapshot';
+import { IStorage } from './storage/types';
+import { Proposal } from '../helpers/snapshot';
+import Cache from './cache';
+
+const openai = new OpenAI({ apiKey: process.env.apiKey });
+
+class AISummary extends Cache {
+    proposal?: Proposal | null;
+
+    constructor(id: string, storage: IStorage) {
+        super(id, storage);
+        this.filename = `snapshot-votes-report-${this.id}.csv`;
+    }
+
+    async isCacheable() {
+        this.proposal = await fetchProposal(this.id);
+        console.log(this.proposal);
+
+        if (!this.proposal) {
+            return Promise.reject('RECORD_NOT_FOUND');
+        }
+
+        return true;
+    }
+
+    getContent = async () => {
+        this.isCacheable();
+        console.log("--ID: " + this.id);
+        try {
+            const proposal = await fetchProposal(this.id);
+            const body = proposal?.body;
+            const title = proposal?.title;
+            const spaceName = proposal?.space?.name;
+            const completion = await openai.chat.completions.create({
+                messages: [{ role: 'system', content: `The following is a governance proposal of ${spaceName}. Generate me a summary in 300 characters max. Here's the title of the proposal: '${title}' . Here's the content of the proposal: '${body}'` }],
+                model: 'gpt-4-turbo-preview',
+            });
+
+            if (completion.choices.length === 0) {
+                throw new Error('No completion in response');
+            }
+            const res = completion?.choices[0];
+
+            if (res.message.content === null) {
+                throw new Error('No content in response');
+            }
+
+            const content = res.message?.content;
+            return content;
+        } catch (e: any) {
+            capture(e);
+            throw (e);
+        }
+    };
+}
+
+export default AISummary;