Merge pull request #59 from ethernautdao/optimist

Optimist module initial functions

Author: raiseerco

package-lock.json

@@ -25,6 +25,8 @@
     "prettier": "^3.2.5"
   },
   "dependencies": {
-    "echomd": "^0.2.3"
+    "axios": "^1.8.4",
+    "echomd": "^0.2.3",
+    "node-fetch": "^2.7.0"
   }
 }

package.json

@@ -1 +1,2 @@
-**/src/internal/assistants/docs/kb-files
+**/src/internal/assistants/docs/kb-files/output/optimism/community-hub/chapters
+**/src/internal/assistants/docs/kb-files/output/optimism/docs/chapters

packages/ethernaut-ai/.gitignore

@@ -1,7 +1,7 @@
 {
   "name": "ethernaut-ai",
   "version": "1.1.11",
-  "description": "AI assistant that interprets user input and executes hardhat tasks",
+  "description": "AI assistant that interprets user input and executes hardhat tasks and chat with OP docs",
   "main": "src/index.js",
   "scripts": {
     "build": "npm run install:test",

packages/ethernaut-ai/package.json

@@ -45,5 +45,11 @@ extendConfig((config, userConfig) => {
         userConfig.ethernaut?.ai?.explainer?.additionalInstructions.concat() ||
         [],
     },
+    docs: {
+      additionalInstructions:
+        localConfig.ai?.docs?.additionalInstructions?.concat() ||
+        userConfig.ethernaut?.ai?.docs?.additionalInstructions?.concat() ||
+        [],
+    },
   }
 })

packages/ethernaut-ai/src/index.js

@@ -0,0 +1,31 @@
+const buildDocsDocs = require('./utils/build-docs-docs')
+const Assistant = require('./Assistant')
+
+class DocsAssistant extends Assistant {
+  constructor(hre) {
+    const config = require('./configs/docs.json')
+    config.tools = []
+    super('docs', config)
+    this.injectAdditionalInstructions(
+      hre.config.ethernaut.ai.docs.additionalInstructions,
+    )
+
+    this.hre = hre
+  }
+
+  async process(thread, model) {
+    const messages = await thread.getMessages()
+    const lastMessage = messages.data[0]
+    const query = lastMessage.content[0].text.value
+    // Load and inject the OP Developer Docs based on the query
+    const DocsDocs = await buildDocsDocs(query)
+    this.config.instructions = this.config.instructions.replace(
+      '[docs-docs]',
+      DocsDocs.join('\n\n'),
+    )
+
+    return await super.process(thread, model)
+  }
+}
+
+module.exports = DocsAssistant

packages/ethernaut-ai/src/internal/assistants/DocsAssistant.js

@@ -0,0 +1,6 @@
+{
+  "name": "EthernautAI OP Developer Docs",
+  "description": "A documentation assistant that provides information from the Optimism Developer Docs",
+  "instructions": "[common] Your role is to be a documentation assistant that answers questions about the Optimism ecosystem. You should ONLY provide direct answers based on the documentation provided, without suggesting or executing any commands. When answering:  1. Use the documentation content to provide accurate information  2. Cite specific sections or documents when providing information  3. If a question cannot be answered with the available documentation, clearly state that  4. Do not suggest or try to execute any CLI commands  5. Format your responses in a clear, readable way  6. If relevant, you can provide direct quotes from the documentation [docs-docs] [additional]",
+  "model": "gpt-4o-mini"
+}

packages/ethernaut-ai/src/internal/assistants/configs/docs.json

@@ -0,0 +1 @@
+{}