Merge branch 'main' into 415-add-0g-plugin

Author: Wilbert957

.env.example

@@ -1,16 +1,19 @@
-# Required environment variables
+# Discord Configuration
 DISCORD_APPLICATION_ID=
-DISCORD_API_TOKEN= # Bot token
-OPENAI_API_KEY=sk-* # OpenAI API key, starting with sk-
-REDPILL_API_KEY= # REDPILL API Key
-GROK_API_KEY= # GROK API Key
-GROQ_API_KEY=gsk_*
+DISCORD_API_TOKEN=                     # Bot token
+
+# AI Model API Keys
+OPENAI_API_KEY=                        # OpenAI API key, starting with sk-
+REDPILL_API_KEY=                       # REDPILL API Key
+GROK_API_KEY=                          # GROK API Key
+GROQ_API_KEY=                          # Starts with gsk_
 OPENROUTER_API_KEY=
-GOOGLE_GENERATIVE_AI_API_KEY= # Gemini API key
+GOOGLE_GENERATIVE_AI_API_KEY=          # Gemini API key
 
-ELEVENLABS_XI_API_KEY= # API key from elevenlabs
+# Speech Synthesis
+ELEVENLABS_XI_API_KEY=                 # API key from elevenlabs
 
-# ELEVENLABS SETTINGS
+# ElevenLabs Settings
 ELEVENLABS_MODEL_ID=eleven_multilingual_v2
 ELEVENLABS_VOICE_ID=21m00Tcm4TlvDq8ikWAM
 ELEVENLABS_VOICE_STABILITY=0.5
@@ -20,78 +23,76 @@ ELEVENLABS_VOICE_USE_SPEAKER_BOOST=false
 ELEVENLABS_OPTIMIZE_STREAMING_LATENCY=4
 ELEVENLABS_OUTPUT_FORMAT=pcm_16000
 
+# Twitter/X Configuration
 TWITTER_DRY_RUN=false
-TWITTER_USERNAME= # Account username
-TWITTER_PASSWORD= # Account password
-TWITTER_EMAIL= # Account email
-TWITTER_COOKIES= # Account cookies
-
+TWITTER_USERNAME=                       # Account username
+TWITTER_PASSWORD=                       # Account password
+TWITTER_EMAIL=                         # Account email
+TWITTER_COOKIES=                       # Account cookies
 X_SERVER_URL=
 XAI_API_KEY=
 XAI_MODEL=
 
-#POST INTERVAL RANDOM MIN-MAX MINUTES
-POST_INTERVAL_MIN=  #90 #Default
-POST_INTERVAL_MAX= #180 #Default
-
-
-#USE IMAGE GEN
-IMAGE_GEN= #TRUE
+# Post Interval Settings (in minutes)
+POST_INTERVAL_MIN=                     # Default: 90
+POST_INTERVAL_MAX=                     # Default: 180
 
-#Leave blank to use local embeddings
-USE_OPENAI_EMBEDDING=  #TRUE
+# Feature Flags
+IMAGE_GEN=                            # Set to TRUE to enable image generation
+USE_OPENAI_EMBEDDING=                 # Set to TRUE for OpenAI, leave blank for local
 
-#OpenRouter (Use one model for everything or set individual for small, medium, large tasks)
-#leave blank to use defaults hermes 70b for small tasks & 405b for medium/large tasks
-OPENROUTER_MODEL=
+# OpenRouter Models
+OPENROUTER_MODEL=                     # Default: uses hermes 70b/405b
 SMALL_OPENROUTER_MODEL=
-MEDIUM_OLLAMA_MODEL=
-LARGE_OLLAMA_MODEL=
+MEDIUM_OPENROUTER_MODEL=
+LARGE_OPENROUTER_MODEL=
 
-
-#Set to Use for New OLLAMA provider
-OLLAMA_SERVER_URL=   #Leave blank for default localhost:11434
+# Ollama Configuration
+OLLAMA_SERVER_URL=                    # Default: localhost:11434
 OLLAMA_MODEL=
-OLLAMA_EMBEDDING_MODEL=     #default mxbai-embed-large
-#To use custom model types for different tasks set these
-SMALL_OLLAMA_MODEL=         #default llama3.2
-MEDIUM_OLLAMA_MODEL=        #default herems3
-LARGE_OLLAMA_MODEL=         #default hermes3:70b
+OLLAMA_EMBEDDING_MODEL=               # Default: mxbai-embed-large
+SMALL_OLLAMA_MODEL=                   # Default: llama3.2
+MEDIUM_OLLAMA_MODEL=                  # Default: hermes3
+LARGE_OLLAMA_MODEL=                   # Default: hermes3:70b
 
-# For asking Claude stuff
-ANTHROPIC_API_KEY=
+# API Keys
+ANTHROPIC_API_KEY=                    # For Claude
+HEURIST_API_KEY=                      # Get from https://heurist.ai/dev-access
 
-# Heurist API (Get API Key at https://heurist.ai/dev-access)
-HEURIST_API_KEY=
+# Heurist Models
 SMALL_HEURIST_LANGUAGE_MODEL=
 MEDIUM_HEURIST_LANGUAGE_MODEL=
 LARGE_HEURIST_LANGUAGE_MODEL=
 HEURIST_IMAGE_MODEL=
 
+# Wallet Configuration
 WALLET_PRIVATE_KEY=EXAMPLE_WALLET_PRIVATE_KEY
 WALLET_PUBLIC_KEY=EXAMPLE_WALLET_PUBLIC_KEY
-
 BIRDEYE_API_KEY=
 
+# Solana Configuration
 SOL_ADDRESS=So11111111111111111111111111111111111111112
 SLIPPAGE=1
 BASE_MINT=So11111111111111111111111111111111111111112
 RPC_URL=https://api.mainnet-beta.solana.com
 HELIUS_API_KEY=
 
-
-## Telegram
+# Telegram Configuration
 TELEGRAM_BOT_TOKEN=
 
+# Together Configuration
 TOGETHER_API_KEY=
+
+# Server Configuration
 SERVER_PORT=3000
 
-# Starknet
+# Starknet Configuration
 STARKNET_ADDRESS=
 STARKNET_PRIVATE_KEY=
+STARKNET_RPC_URL=
 
 #ZeroG
 ZEROG_INDEXER_RPC=
 ZEROG_EVM_RPC=
 ZEROG_PRIVATE_KEY=
-ZEROG_FLOW_ADDRESS=
+ZEROG_FLOW_ADDRESS=

.github/pull_request_template.md

@@ -77,3 +77,9 @@ None, automtated tests are fine.
 <!--
 ## Deployment instructions
 -->
+
+<!-- If you are on Discord, please join https://discord.gg/ai16z and state your Discord username here for contribute role and join us in #development-feed -->
+<!--
+## Discord username
+
+-->

.github/workflows/release.yaml

@@ -61,7 +61,7 @@ jobs:
             - name: Create GitHub Release
               uses: actions/create-release@v1
               env:
-                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+                  GITHUB_TOKEN: ${{ secrets.GH_TOKEN }}
                   PNPM_HOME: /home/runner/setup-pnpm/node_modules/.bin
               with:
                   tag_name: ${{ steps.get_tag.outputs.TAG }}

agent/.gitignore

@@ -3,4 +3,5 @@
 !character.ts
 .env
 *.env
-.env*
+.env*
+/data

agent/src/index.ts

@@ -6,13 +6,21 @@ import { AutoClientInterface } from "@ai16z/client-auto";
 import { TelegramClientInterface } from "@ai16z/client-telegram";
 import { TwitterClientInterface } from "@ai16z/client-twitter";
 import {
+    DbCacheAdapter,
     defaultCharacter,
+    FsCacheAdapter,
+    ICacheManager,
+    IDatabaseCacheAdapter,
+    stringToUuid,
     AgentRuntime,
-    settings,
+    CacheManager,
     Character,
     IAgentRuntime,
     ModelProviderName,
     elizaLogger,
+    settings,
+    IDatabaseAdapter,
+    validateCharacterConfig,
 } from "@ai16z/eliza";
 import { bootstrapPlugin } from "@ai16z/plugin-bootstrap";
 import { solanaPlugin } from "@ai16z/plugin-solana";
@@ -22,7 +30,13 @@ import Database from "better-sqlite3";
 import fs from "fs";
 import readline from "readline";
 import yargs from "yargs";
+import path from "path";
+import { fileURLToPath } from "url";
 import { character } from "./character.ts";
+import type { DirectClient } from "@ai16z/client-direct";
+
+const __filename = fileURLToPath(import.meta.url); // get the resolved path to the file
+const __dirname = path.dirname(__filename); // get the name of the directory
 
 export const wait = (minTime: number = 1000, maxTime: number = 3000) => {
     const waitTime =
@@ -55,21 +69,22 @@ export function parseArguments(): {
 export async function loadCharacters(
     charactersArg: string
 ): Promise<Character[]> {
-    let characterPaths = charactersArg
-        ?.split(",")
-        .map((path) => path.trim())
-        .map((path) => {
-            if (path[0] === "/") return path; // handle absolute paths
-            // assume relative to the project root where pnpm is ran
-            return `../${path}`;
-        });
+    let characterPaths = charactersArg?.split(",").map((filePath) => {
+        if (path.basename(filePath) === filePath) {
+            filePath = "../characters/" + filePath;
+        }
+        return path.resolve(process.cwd(), filePath.trim());
+    });
+
     const loadedCharacters = [];
 
     if (characterPaths?.length > 0) {
         for (const path of characterPaths) {
             try {
                 const character = JSON.parse(fs.readFileSync(path, "utf8"));
 
+                validateCharacterConfig(character);
+
                 // is there a "plugins" field?
                 if (character.plugins) {
                     console.log("Plugins are: ", character.plugins);
@@ -159,13 +174,18 @@ export function getTokenForProvider(
     }
 }
 
-function initializeDatabase() {
+function initializeDatabase(dataDir: string) {
     if (process.env.POSTGRES_URL) {
-        return new PostgresDatabaseAdapter({
+        const db = new PostgresDatabaseAdapter({
             connectionString: process.env.POSTGRES_URL,
         });
+        return db;
     } else {
-        return new SqliteDatabaseAdapter(new Database("./db.sqlite"));
+        const filePath =
+            process.env.SQLITE_FILE ?? path.resolve(dataDir, "db.sqlite");
+        // ":memory:";
+        const db = new SqliteDatabaseAdapter(new Database(filePath));
+        return db;
     }
 }
 
@@ -209,9 +229,10 @@ export async function initializeClients(
     return clients;
 }
 
-export async function createAgent(
+export function createAgent(
     character: Character,
-    db: any,
+    db: IDatabaseAdapter,
+    cache: ICacheManager,
     token: string
 ) {
     elizaLogger.success(
@@ -235,29 +256,54 @@ export async function createAgent(
         actions: [],
         services: [],
         managers: [],
+        cacheManager: cache,
     });
 }
 
-async function startAgent(character: Character, directClient: any) {
+function intializeFsCache(baseDir: string, character: Character) {
+    const cacheDir = path.resolve(baseDir, character.id, "cache");
+
+    const cache = new CacheManager(new FsCacheAdapter(cacheDir));
+    return cache;
+}
+
+function intializeDbCache(character: Character, db: IDatabaseCacheAdapter) {
+    const cache = new CacheManager(new DbCacheAdapter(db, character.id));
+    return cache;
+}
+
+async function startAgent(character: Character, directClient: DirectClient) {
     try {
+        character.id ??= stringToUuid(character.name);
+        character.username ??= character.name;
+
         const token = getTokenForProvider(character.modelProvider, character);
-        const db = initializeDatabase();
+        const dataDir = path.join(__dirname, "../data");
 
-        const runtime = await createAgent(character, db, token);
+        if (!fs.existsSync(dataDir)) {
+            fs.mkdirSync(dataDir, { recursive: true });
+        }
 
-        const clients = await initializeClients(
-            character,
-            runtime as IAgentRuntime
-        );
+        const db = initializeDatabase(dataDir);
+
+        await db.init();
 
-        directClient.registerAgent(await runtime);
+        const cache = intializeDbCache(character, db);
+        const runtime = createAgent(character, db, cache, token);
+
+        await runtime.initialize();
+
+        const clients = await initializeClients(character, runtime);
+
+        directClient.registerAgent(runtime);
 
         return clients;
     } catch (error) {
-        console.error(
+        elizaLogger.error(
             `Error starting agent for character ${character.name}:`,
             error
         );
+        console.error(error);
         throw error;
     }
 }
@@ -276,7 +322,7 @@ const startAgents = async () => {
 
     try {
         for (const character of characters) {
-            await startAgent(character, directClient);
+            await startAgent(character, directClient as DirectClient);
         }
     } catch (error) {
         elizaLogger.error("Error starting agents:", error);
@@ -306,9 +352,15 @@ const rl = readline.createInterface({
     output: process.stdout,
 });
 
+rl.on("SIGINT", () => {
+    rl.close();
+    process.exit(0);
+});
+
 async function handleUserInput(input, agentId) {
     if (input.toLowerCase() === "exit") {
         rl.close();
+        process.exit(0);
         return;
     }