Sharad/instrumentation

.agenda

@@ -0,0 +1,30 @@
+Architecture
+
+
+Eliza Agent OS is a comprehensive, modular, and highly extensible system that brings together a variety of components to create intelligent, autonomous agents capable of interacting with users across multiple platforms. At its core, the architecture is built around three fundamental pillars:
+
+1. The Agent Core
+   • The "@agent" package is the heart of the system. It boots up the intelligent agent by loading and merging configuration files (in JSON format) that define a character's personality, voice settings, and available functionalities.
+
+   • It sets up essential connections to support systems such as databases (Postgres, SQLite, Supabase, MongoDB, etc.) and caching layers (Redis or local caches), ensuring that all stateful data—like conversation histories or persistent memories—is reliably stored and retrieved.
+
+   • Agents encapsulate the decision-making logic. They parse incoming messages, decide whether or not to act based on pre-defined templates and rules, and invoke corresponding action handlers. This core logic is agnostic to the communication channel, allowing the system to be robust and adaptable.
+
+2. Plugins
+   • Plugins extend the capabilities of the agent far beyond simple messaging. For example, the "@plugin-github" plugin introduces deep GitHub-specific functionality into the system.
+     - It starts by defining its package metadata (through package.json) and ensuring proper dependency management with libraries like @octokit/rest.
+     - Rigorous input validation is achieved through constants and types defined using libraries like Zod, ensuring that every GitHub action—from creating issues and commits to initializing repositories—receives correctly formatted data.
+     - The plugin is structured around modular "actions" (each with unique names, descriptions, validate functions, and handler logic) and "providers" to interact with various GitHub contents like source code and documentation.
+     - Finally, its components are re-exported in a unified interface, so that the core agent can seamlessly integrate these functionalities.
+   • Similarly, other plugins (such as @plugin-email and others) offer specialized integrations that address distinct needs within the ecosystem, making it easy to customize and extend the functionality without altering the system's core.
+
+3. Clients
+   • Clients function as the "bridges" between the core agent and the external communication platforms. They abstract away platform-specific details, allowing agents to interact with the outside world effortlessly.
+   • For example, the Slack client (@client-slack) handles all aspects of connection management, event listening (via a dedicated event adapter), and message formatting. It captures events like new messages, URL verifications, and reactions, then forwards these events to the agent's logic.
+   • This separation enables the agents to generate responses and take actions without needing to know the specifics of how Slack, Twitter, Discord, or any other platform operates. It also means that integrating a new communication channel is as simple as swapping out or adding a new client module.
+
+4. Adapters
+   • Adapters serve as abstraction layers for data persistence and caching. They enable the system to interact with different databases and storage systems using a unified API.
+   • For instance, the "@adapter-postgres" module integrates PostgreSQL into the ecosystem. It manages schema migrations, seed data, and leverages advanced features such as pgvector for vector-based similarity search and fuzzystrmatch for text matching.
+   • The adapter is designed with careful separation of concerns: SQL migration scripts establish the database schema and row-level security measures, dedicated utility functions handle dynamic SQL queries, and rigorous testing (often in Docker-based environments) confirms the correct operation of critical functions.
+   • By encapsulating all the complexities of database operations, adapters allow other components (agents, plugins, and clients) to store and retrieve data efficiently without needing to manage the underlying database intricacies.

.env.example

@@ -431,6 +431,16 @@ COINBASE_PRIVATE_KEY=               # From Coinbase developer portal
 COINBASE_GENERATED_WALLET_ID=       # Not your address but the wallet ID from generating a wallet through the plugin
 COINBASE_GENERATED_WALLET_HEX_SEED= # Not your address but the wallet hex seed from generating a wallet through the plugin and calling export
 COINBASE_NOTIFICATION_URI=          # For webhook plugin the uri you want to send the webhook to for dummy ones use https://webhook.site
+COINBASE_TRADING_AMOUNT=                # Amount allocated for trading
+COINBASE_SHORT_TERM_TRADING_WALLET_SEED= # Seed for short-term trading wallet
+COINBASE_SHORT_TERM_TRADING_WALLET_ID=   # ID for short-term trading wallet
+COINBASE_LONG_TERM_TRADING_WALLET_SEED=  # Seed for long-term trading wallet
+COINBASE_LONG_TERM_TRADING_WALLET_ID=    # ID for long-term trading wallet
+COINBASE_DRY_POWDER_WALLET_SEED=         # Seed for dry powder wallet
+COINBASE_DRY_POWDER_WALLET_ID=           # ID for dry powder wallet
+COINBASE_OPERATIONAL_CAPITAL_WALLET_SEED= # Seed for operational capital wallet
+COINBASE_OPERATIONAL_CAPITAL_WALLET_ID=   # ID for operational capital wallet
+
 
 # Coinbase AgentKit
 CDP_API_KEY_NAME=
@@ -536,6 +546,15 @@ CLOUDFLARE_AI_GATEWAY_ID= # Cloudflare AI Gateway ID - found in the Cloudflare D
 APTOS_PRIVATE_KEY= # Aptos private key
 APTOS_NETWORK=     # Must be one of mainnet, testnet
 
+# Github
+GITHUB_PLUGIN_ENABLED= # Enable this to run the GitHub plugin independently of the GitHub client
+GITHUB_CLIENT_ENABLED= # Enable this to run the GitHub client
+GITHUB_API_TOKEN= # from github developer portal
+
+GITHUB_USER_CHECK_INTERVAL_MS= # interval in milliseconds between github user check cycles (default: 5000)
+GITHUB_INFO_DISCOVERY_INTERVAL_MS= # interval in milliseconds between github info discovery cycles (default: 1000)
+GITHUB_OODA_INTERVAL_MS= # interval in milliseconds between OODA cycles (default: 60000)
+
 # MultiversX
 MVX_PRIVATE_KEY=                    # Multiversx private key
 MVX_NETWORK=                        # must be one of mainnet, devnet, testnet
@@ -682,15 +701,9 @@ DEEPGRAM_API_KEY=
 VERIFIABLE_INFERENCE_ENABLED=false    # Set to false to disable verifiable inference
 VERIFIABLE_INFERENCE_PROVIDER=opacity # Options: opacity
 
-# Qdrant
-# URL of your Qdrant instance (e.g., https://your-instance.qdrant.tech)
-QDRANT_URL=
-# API key for authentication (optional for local instances)
-QDRANT_KEY=
-# Qdrant service port (default: 443 for cloud, typically 6333 for local)
-QDRANT_PORT=443
-# Vector size matching your embedding model (default: 1536 for OpenAI embeddings)
-QDRANT_VECTOR_SIZE=1536
+# Set the conversation length for the agent runtime
+CONVERSATION_LENGTH=32
+
 
 # Autonome Configuration
 AUTONOME_JWT_TOKEN=
@@ -952,4 +965,7 @@ ARBITRAGE_EVM_PRIVATE_KEY=                  # Private key for the wallet executi
 FLASHBOTS_RELAY_SIGNING_KEY=      # Signing key for Flashbots relay interactions
 BUNDLE_EXECUTOR_ADDRESS=          # Address of the bundle executor contract
 
+# DESK Exchange Plugin Configration
+DESK_EXCHANGE_PRIVATE_KEY=                  # Required for trading and cancelling orders
+DESK_EXCHANGE_NETWORK=                      # "mainnet" or "testnet
 

.github/workflows/sync-upstream.yaml

@@ -0,0 +1,81 @@
+name: Sync Fork with Upstream
+
+on:
+    # Runs every 5 minutes
+    schedule:
+        - cron: "*/5 * * * *"
+
+    # Allow manual trigger
+    workflow_dispatch:
+
+jobs:
+    sync:
+        name: Sync with upstream
+        runs-on: ubuntu-latest
+
+        steps:
+            - name: Checkout repository
+              uses: actions/checkout@v4
+              with:
+                  fetch-depth: 0
+                  ref: main
+
+            - name: Add upstream remote
+              run: |
+                  git remote add upstream https://github.com/elizaOS/eliza.git
+                  git remote -v
+
+            - name: Fetch upstream
+              run: git fetch upstream
+
+            - name: Configure Git
+              run: |
+                  git config user.name "GitHub Actions"
+                  git config user.email "actions@github.com"
+                  git config pull.rebase true
+
+            # Sync main branch
+            - name: Sync main branch
+              run: |
+                  git checkout main
+                  git pull origin main
+                  git merge upstream/main
+                  git push origin main
+              env:
+                  GITHUB_TOKEN: ${{ secrets.WORKFLOW_TOKEN }}
+
+            # Add sync develop branch
+            - name: Sync develop branch
+              run: |
+                  git fetch origin develop
+                  git checkout develop || git checkout -b develop
+                  git pull origin develop
+                  git merge upstream/develop
+                  git push origin develop
+              env:
+                  GITHUB_TOKEN: ${{ secrets.WORKFLOW_TOKEN }}
+
+            # Updated to merge both main and develop into sif-dev
+            - name: Merge into sif-dev
+              run: |
+                  git fetch origin sif-dev
+                  git checkout sif-dev
+                  git pull origin sif-dev
+
+                  # Try to merge main into sif-dev
+                  git merge main --strategy-option ours || {
+                    git merge --abort
+                    git reset --hard
+                    git merge -X ours main
+                  }
+
+                  # Try to merge develop into sif-dev
+                  git merge develop --strategy-option ours || {
+                    git merge --abort
+                    git reset --hard
+                    git merge -X ours develop
+                  }
+
+                  git push origin sif-dev
+              env:
+                  GITHUB_TOKEN: ${{ secrets.WORKFLOW_TOKEN }}

.gitignore

@@ -16,6 +16,11 @@ node-compile-cache
 .zed
 .DS_Store
 
+# Build directories
+/dist
+/build
+/out
+
 dist/
 # Allow models directory but ignore model files
 models/*.gguf
@@ -72,6 +77,9 @@ eliza.manifest
 eliza.manifest.sgx
 eliza.sig
 
+all_files_content.txt
+repo_compiler.zsh
+
 packages/plugin-nvidia-nim/extra
 packages/plugin-nvidia-nim/old_code
 packages/plugin-nvidia-nim/docs
@@ -91,4 +99,4 @@ lit-config.json
 
 # Configuration to exclude the extra and local_docs directories
 extra
-**/dist/**
+**/dist/**

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "launch",
+            "name": "Launch via pnpm",
+            "runtimeExecutable": "pnpm",
+            "runtimeArgs": [
+                "run",
+                "cleanstart:debug",
+                "--character=characters/staff-engineer.character.json"
+            ],
+            "skipFiles": [
+                "<node_internals>/**"
+            ],
+            "console": "integratedTerminal",
+        }
+    ]
+}

README.md

@@ -22,7 +22,7 @@
 
 ## ✨ Features
 
-- 🛠️ Full-featured Discord, Twitter and Telegram connectors
+- 🛠️ Full-featured Discord, X (Twitter) and Telegram connectors
 - 🔗 Support for every model (Llama, Grok, OpenAI, Anthropic, Gemini, etc.)
 - 👥 Multi-agent and room support
 - 📚 Easily ingest and interact with your documents
@@ -108,11 +108,36 @@ pnpm start:client
 
 Then read the [Documentation](https://elizaos.github.io/eliza/) to learn how to customize your Eliza.
 
----
+### Manually Start Eliza (Only recommended if you know what you are doing)
+
+```bash
+# Clone the repository
+git clone https://github.com/elizaos/eliza.git
+
+# Checkout the latest release
+# This project iterates fast, so we recommend checking out the latest release
+git checkout $(git describe --tags --abbrev=0)
+# If the above doesn't checkout the latest release, this should work:
+# git checkout $(git describe --tags `git rev-list --tags --max-count=1`)
+```
+
+### Start Eliza with Gitpod
+
+[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/elizaos/eliza/tree/main)
+
+### Edit the .env file
+
+Copy .env.example to .env and fill in the appropriate values.
+
+```
+cp .env.example .env
+```
+
+Note: .env is optional. If your planning to run multiple distinct agents, you can pass secrets through the character JSON
 
 ### Automatically Start Eliza
 
-The start script provides an automated way to set up and run Eliza:
+This will run everything to setup the project and start the bot with the default character.
 
 ```bash
 sh scripts/start.sh

agent/package.json

@@ -55,8 +55,10 @@
         "@elizaos/plugin-coinmarketcap": "workspace:*",
         "@elizaos/plugin-conflux": "workspace:*",
         "@elizaos/plugin-cosmos": "workspace:*",
+        "@elizaos/plugin-desk-exchange": "workspace:*",
         "@elizaos/plugin-echochambers": "workspace:*",
         "@elizaos/plugin-evm": "workspace:*",
+        "@elizaos/plugin-edwin": "workspace:*",
         "@elizaos/plugin-flow": "workspace:*",
         "@elizaos/plugin-gelato": "workspace:*",
         "@elizaos/plugin-giphy": "workspace:*",
@@ -66,9 +68,7 @@
         "@elizaos/plugin-icp": "workspace:*",
         "@elizaos/plugin-initia": "workspace:*",
         "@elizaos/plugin-image-generation": "workspace:*",
-        "@elizaos/plugin-intiface": "workspace:*",
         "@elizaos/plugin-lens-network": "workspace:*",
-        "@elizaos/plugin-letzai": "workspace:*",
         "@elizaos/plugin-lit": "workspace:*",
         "@elizaos/plugin-massa": "workspace:*",
         "@elizaos/plugin-mind-network": "workspace:*",
@@ -152,6 +152,9 @@
         "@elizaos/plugin-near": "workspace:*",
         "@elizaos/plugin-stargaze": "workspace:*",
         "@elizaos/plugin-zksync-era": "workspace:*",
+        "@elizaos/plugin-github": "workspace:*",
+        "@elizaos/client-github": "workspace:*",
+        "@elizaos/client-coinbase": "workspace:*",
         "readline": "1.3.0",
         "ws": "8.18.0",
         "yargs": "17.7.2"
@@ -163,4 +166,4 @@
         "ts-node": "10.9.2",
         "tsup": "8.3.5"
     }
-}
+}