@teneo-protocol/sdk 2.0.0 → 2.2.0

package/examples/claude-agent-x-follower/index.ts

@@ -7,31 +7,36 @@
  * 3. Return structured results to Claude
  */
 
-import 'dotenv/config';
-import { query, tool, createSdkMcpServer } from '@anthropic-ai/claude-agent-sdk';
-import { z } from 'zod';
-import { SDKConfigBuilder, TeneoSDK } from '../../dist/index.js';
+import "dotenv/config";
+import { query, tool, createSdkMcpServer } from "@anthropic-ai/claude-agent-sdk";
+import { z } from "zod";
+import { SDKConfigBuilder, TeneoSDK } from "../../dist/index.js";
 
 // Load environment variables
-const WS_URL = process.env.WS_URL || '';
-const PRIVATE_KEY = process.env.PRIVATE_KEY || '';
-const WALLET_ADDRESS = process.env.WALLET_ADDRESS || '';
-const DEFAULT_ROOM = process.env.DEFAULT_ROOM || 'general';
-const LOG_LEVEL = (process.env.LOG_LEVEL || 'info') as 'debug' | 'info' | 'warn' | 'error' | 'silent';
-const ENABLE_SIG_VERIFICATION = process.env.ENABLE_SIGNATURE_VERIFICATION === 'true';
-const TRUSTED_ADDRESSES = process.env.TRUSTED_ADDRESSES?.split(',').filter(Boolean) || [];
-const ENABLE_CACHE = process.env.ENABLE_CACHE !== 'false';
-const CACHE_TIMEOUT = parseInt(process.env.CACHE_TIMEOUT || '300000');
-const MAX_CACHE_SIZE = parseInt(process.env.MAX_CACHE_SIZE || '100');
-const ENABLE_RECONNECTION = process.env.ENABLE_RECONNECTION !== 'false';
-const RECONNECT_DELAY = parseInt(process.env.RECONNECT_DELAY || '5000');
-const MAX_RECONNECT_ATTEMPTS = parseInt(process.env.MAX_RECONNECT_ATTEMPTS || '10');
+const WS_URL = process.env.WS_URL || "";
+const PRIVATE_KEY = process.env.PRIVATE_KEY || "";
+const WALLET_ADDRESS = process.env.WALLET_ADDRESS || "";
+const DEFAULT_ROOM = process.env.DEFAULT_ROOM || "general";
+const LOG_LEVEL = (process.env.LOG_LEVEL || "info") as
+  | "debug"
+  | "info"
+  | "warn"
+  | "error"
+  | "silent";
+const ENABLE_SIG_VERIFICATION = process.env.ENABLE_SIGNATURE_VERIFICATION === "true";
+const TRUSTED_ADDRESSES = process.env.TRUSTED_ADDRESSES?.split(",").filter(Boolean) || [];
+const ENABLE_CACHE = process.env.ENABLE_CACHE !== "false";
+const CACHE_TIMEOUT = parseInt(process.env.CACHE_TIMEOUT || "300000");
+const MAX_CACHE_SIZE = parseInt(process.env.MAX_CACHE_SIZE || "100");
+const ENABLE_RECONNECTION = process.env.ENABLE_RECONNECTION !== "false";
+const RECONNECT_DELAY = parseInt(process.env.RECONNECT_DELAY || "5000");
+const MAX_RECONNECT_ATTEMPTS = parseInt(process.env.MAX_RECONNECT_ATTEMPTS || "10");
 
 // Validate required environment variables
 if (!WS_URL || !PRIVATE_KEY) {
-  console.error('Missing required environment variables');
-  console.error('Required: WS_URL, PRIVATE_KEY');
-  console.error('Note: ANTHROPIC_API_KEY is optional if Claude CLI is authenticated');
+  console.error("Missing required environment variables");
+  console.error("Required: WS_URL, PRIVATE_KEY");
+  console.error("Note: ANTHROPIC_API_KEY is optional if Claude CLI is authenticated");
   process.exit(1);
 }
 
@@ -45,13 +50,13 @@ const config = new SDKConfigBuilder()
     delay: RECONNECT_DELAY,
     maxAttempts: MAX_RECONNECT_ATTEMPTS
   })
-  .withResponseFormat({ format: 'both', includeMetadata: true })
+  .withResponseFormat({ format: "both", includeMetadata: true })
   .withLogging(LOG_LEVEL)
   .withCache(ENABLE_CACHE, CACHE_TIMEOUT, MAX_CACHE_SIZE)
   .withSignatureVerification({
     enabled: ENABLE_SIG_VERIFICATION,
     trustedAddresses: TRUSTED_ADDRESSES,
-    requireFor: ['task_response', 'agent_selected'],
+    requireFor: ["task_response", "agent_selected"],
     strictMode: false
   })
   .build();
@@ -61,18 +66,18 @@ const teneoSDK = new TeneoSDK(config);
 // Define the tool for Claude Agent
 // Note: Pass Zod shape directly (ZodRawShape), not z.object()
 const getXTimelineTool = tool(
-  'get_x_timeline',
-  'Fetch X/Twitter timeline for a given username using Teneo X-Agent. Returns recent tweets and engagement data.',
+  "get_x_timeline",
+  "Fetch X/Twitter timeline for a given username using Teneo X-Agent. Returns recent tweets and engagement data.",
   {
-    username: z.string().describe('X/Twitter username (without @)'),
-    count: z.number().min(1).max(100).default(20).describe('Number of tweets to fetch')
+    username: z.string().describe("X/Twitter username (without @)"),
+    count: z.number().min(1).max(100).default(20).describe("Number of tweets to fetch")
   },
   async (args) => {
     const { username, count } = args;
 
-    console.log('\n' + '='.repeat(60));
-    console.log('🔧 TOOL INVOKED: get_x_timeline');
-    console.log('='.repeat(60));
+    console.log("\n" + "=".repeat(60));
+    console.log("🔧 TOOL INVOKED: get_x_timeline");
+    console.log("=".repeat(60));
     console.log(`📥 Input: username="${username}", count=${count}`);
     console.log(`\n🔍 Fetching timeline for @${username} (${count} tweets)...\n`);
 
@@ -82,22 +87,30 @@ const getXTimelineTool = tool(
       console.log(`📋 Found ${agents.length} available agents`);
 
       // Find X Platform Agent by name or ID
-      const xAgent = agents.find(a =>
-        a.name?.toLowerCase().includes('x platform agent') ||
-        a.id?.toLowerCase().includes('x-agent-enterprise-v2')
+      const xAgent = agents.find(
+        (a) =>
+          a.name?.toLowerCase().includes("x platform agent") ||
+          a.id?.toLowerCase().includes("x-agent-enterprise-v2")
       );
 
       if (!xAgent) {
-        console.error('❌ X Platform Agent not found in available agents');
-        console.log('Available agents:', agents.map(a => ({ id: a.id, name: a.name })));
+        console.error("❌ X Platform Agent not found in available agents");
+        console.log(
+          "Available agents:",
+          agents.map((a) => ({ id: a.id, name: a.name }))
+        );
         return {
-          content: [{
-            type: 'text' as const,
-            text: JSON.stringify({
-              success: false,
-              error: 'X Platform Agent not found. Available agents: ' + agents.map(a => a.name || a.id).join(', ')
-            })
-          }]
+          content: [
+            {
+              type: "text" as const,
+              text: JSON.stringify({
+                success: false,
+                error:
+                  "X Platform Agent not found. Available agents: " +
+                  agents.map((a) => a.name || a.id).join(", ")
+              })
+            }
+          ]
         };
       }
 
@@ -107,23 +120,28 @@ const getXTimelineTool = tool(
       // We pre-selected the X Platform Agent, so we use sendDirectCommand()
       // instead of sendMessage() to send directly to this specific agent
       const waitForResponse = true;
-      const response = await teneoSDK.sendDirectCommand({
-        agent: xAgent.id,
-        command: `timeline @${username} ${count}`,
-        room: DEFAULT_ROOM
-      }, waitForResponse);
+      const response = await teneoSDK.sendDirectCommand(
+        {
+          agent: xAgent.id,
+          command: `timeline @${username} ${count}`,
+          room: DEFAULT_ROOM
+        },
+        waitForResponse
+      );
 
-      console.log('📨 Received response from Teneo:', response ? 'Yes' : 'No');
+      console.log("📨 Received response from Teneo:", response ? "Yes" : "No");
 
       if (!response?.humanized) {
         return {
-          content: [{
-            type: 'text' as const,
-            text: JSON.stringify({
-              success: false,
-              error: 'No response from X-Agent'
-            })
-          }]
+          content: [
+            {
+              type: "text" as const,
+              text: JSON.stringify({
+                success: false,
+                error: "No response from X-Agent"
+              })
+            }
+          ]
         };
       }
 
@@ -131,28 +149,35 @@ const getXTimelineTool = tool(
 
       // Return the timeline data in Claude's expected format
       return {
-        content: [{
-          type: 'text' as const,
-          text: JSON.stringify({
-            success: true,
-            username: username,
-            count: count,
-            timeline: response.humanized,
-            raw_data: response.raw
-          }, null, 2)
-        }]
+        content: [
+          {
+            type: "text" as const,
+            text: JSON.stringify(
+              {
+                success: true,
+                username: username,
+                count: count,
+                timeline: response.humanized,
+                raw_data: response.raw
+              },
+              null,
+              2
+            )
+          }
+        ]
       };
-
     } catch (error) {
-      console.error('Error fetching timeline:', error);
+      console.error("Error fetching timeline:", error);
       return {
-        content: [{
-          type: 'text' as const,
-          text: JSON.stringify({
-            success: false,
-            error: error instanceof Error ? error.message : 'Unknown error'
-          })
-        }]
+        content: [
+          {
+            type: "text" as const,
+            text: JSON.stringify({
+              success: false,
+              error: error instanceof Error ? error.message : "Unknown error"
+            })
+          }
+        ]
       };
     }
   }
@@ -160,26 +185,26 @@ const getXTimelineTool = tool(
 
 // Create MCP server with the tool
 const teneoMcpServer = createSdkMcpServer({
-  name: 'TeneoXAgent',
-  version: '1.0.0',
+  name: "TeneoXAgent",
+  version: "1.0.0",
   tools: [getXTimelineTool]
 });
 
 // Main function
 async function main() {
-  console.log('🤖 Claude Agent + Teneo SDK - X Timeline Follower\n');
+  console.log("🤖 Claude Agent + Teneo SDK - X Timeline Follower\n");
 
   // Connect to Teneo
-  console.log('📡 Connecting to Teneo network...');
+  console.log("📡 Connecting to Teneo Protocol...");
   await teneoSDK.connect();
-  console.log('✅ Connected to Teneo\n');
+  console.log("✅ Connected to Teneo\n");
 
   // Get prompt from command line or use default
-  const userPrompt = process.argv[2] ||
-    'Use the get_x_timeline tool to get the timeline for elonmusk for 5 tweets';
+  const userPrompt =
+    process.argv[2] || "Use the get_x_timeline tool to get the timeline for elonmusk for 5 tweets";
 
   console.log(`💬 Prompt: "${userPrompt}"\n`);
-  console.log('🧠 Claude is processing...\n');
+  console.log("🧠 Claude is processing...\n");
 
   try {
     // Query Claude with the custom tool
@@ -187,32 +212,32 @@ async function main() {
     const result = query({
       prompt: userPrompt,
       options: {
-        model: 'claude-3-5-haiku-20241022',
-        pathToClaudeCodeExecutable: process.env.HOME + '/.claude/local/claude',
-        permissionMode: 'bypassPermissions',  // Allow tool use without asking
+        model: "claude-3-5-haiku-20241022",
+        pathToClaudeCodeExecutable: process.env.HOME + "/.claude/local/claude",
+        permissionMode: "bypassPermissions", // Allow tool use without asking
         mcpServers: {
           teneo: teneoMcpServer
         }
       }
     });
 
-    console.log('\n' + '='.repeat(60));
-    console.log('📝 CLAUDE RESPONSE:');
-    console.log('='.repeat(60));
+    console.log("\n" + "=".repeat(60));
+    console.log("📝 CLAUDE RESPONSE:");
+    console.log("=".repeat(60));
 
     // Stream the response
     for await (const message of result) {
-      if (message.type === 'result') {
+      if (message.type === "result") {
         // Show the final result in a readable format
-        console.log('\n📊 Final Result:');
+        console.log("\n📊 Final Result:");
 
         // Check if it's an error result
         if (message.is_error) {
-          console.log('❌ Error occurred during execution');
+          console.log("❌ Error occurred during execution");
           console.log(message);
         } else {
           // Success result - TypeScript narrows the type here
-          console.log((message as any).result || 'No result returned');
+          console.log((message as any).result || "No result returned");
         }
 
         console.log(`\n⏱️  Duration: ${message.duration_ms}ms`);
@@ -224,15 +249,14 @@ async function main() {
       }
     }
 
-    console.log('='.repeat(60) + '\n');
-
+    console.log("=".repeat(60) + "\n");
   } catch (error) {
-    console.error('\n❌ Claude query error:', error);
+    console.error("\n❌ Claude query error:", error);
   } finally {
     // Cleanup
     teneoSDK.disconnect();
     teneoSDK.destroy();
-    console.log('✅ Done!\n');
+    console.log("✅ Done!\n");
 
     // Force exit to prevent hanging
     setTimeout(() => process.exit(0), 500);
@@ -241,7 +265,7 @@ async function main() {
 
 // Run with error handling
 main().catch((error) => {
-  console.error('\n❌ Error:', error);
+  console.error("\n❌ Error:", error);
   teneoSDK.disconnect();
   teneoSDK.destroy();
   process.exit(1);

package/examples/n8n-teneo/.env.example

@@ -2,7 +2,7 @@
 # Copy this file to .env and fill in your values
 
 # ============================================================================
-# REQUIRED: Teneo Network Connection
+# REQUIRED: Teneo Protocol Connection
 # ============================================================================
 
 # WebSocket URL for Teneo AI Network

package/examples/n8n-teneo/README.md

@@ -44,7 +44,7 @@ Query Teneo agents (like X-Agent for Twitter/X data) from visual n8n workflows f
            │ WebSocket
            │
 ┌──────────▼───────────────┐
-│   Teneo Network          │
+│   Teneo Protocol          │
 │   (X-Agent, etc.)        │
 └──────────────────────────┘
 ```

package/examples/n8n-teneo/index.ts

@@ -14,28 +14,33 @@
  * - Event-based response handling for reliable message delivery
  */
 
-import 'dotenv/config';
-import express from 'express';
-import { SDKConfigBuilder, TeneoSDK } from '../../dist/index.js';
+import "dotenv/config";
+import express from "express";
+import { SDKConfigBuilder, TeneoSDK } from "../../dist/index.js";
 
 // Load environment variables
-const WS_URL = process.env.WS_URL || '';
-const PRIVATE_KEY = process.env.PRIVATE_KEY || '';
-const WALLET_ADDRESS = process.env.WALLET_ADDRESS || '';
-const DEFAULT_ROOM = process.env.DEFAULT_ROOM || 'general';
-const LOG_LEVEL = (process.env.LOG_LEVEL || 'info') as 'debug' | 'info' | 'warn' | 'error' | 'silent';
-const ENABLE_SIG_VERIFICATION = process.env.ENABLE_SIGNATURE_VERIFICATION === 'true';
-const TRUSTED_ADDRESSES = process.env.TRUSTED_ADDRESSES?.split(',').filter(Boolean) || [];
-const ENABLE_CACHE = process.env.ENABLE_CACHE !== 'false';
-const CACHE_TIMEOUT = parseInt(process.env.CACHE_TIMEOUT || '300000');
-const MAX_CACHE_SIZE = parseInt(process.env.MAX_CACHE_SIZE || '100');
-const ENABLE_RECONNECTION = process.env.ENABLE_RECONNECTION !== 'false';
-const RECONNECT_DELAY = parseInt(process.env.RECONNECT_DELAY || '5000');
-const MAX_RECONNECT_ATTEMPTS = parseInt(process.env.MAX_RECONNECT_ATTEMPTS || '10');
+const WS_URL = process.env.WS_URL || "";
+const PRIVATE_KEY = process.env.PRIVATE_KEY || "";
+const WALLET_ADDRESS = process.env.WALLET_ADDRESS || "";
+const DEFAULT_ROOM = process.env.DEFAULT_ROOM || "general";
+const LOG_LEVEL = (process.env.LOG_LEVEL || "info") as
+  | "debug"
+  | "info"
+  | "warn"
+  | "error"
+  | "silent";
+const ENABLE_SIG_VERIFICATION = process.env.ENABLE_SIGNATURE_VERIFICATION === "true";
+const TRUSTED_ADDRESSES = process.env.TRUSTED_ADDRESSES?.split(",").filter(Boolean) || [];
+const ENABLE_CACHE = process.env.ENABLE_CACHE !== "false";
+const CACHE_TIMEOUT = parseInt(process.env.CACHE_TIMEOUT || "300000");
+const MAX_CACHE_SIZE = parseInt(process.env.MAX_CACHE_SIZE || "100");
+const ENABLE_RECONNECTION = process.env.ENABLE_RECONNECTION !== "false";
+const RECONNECT_DELAY = parseInt(process.env.RECONNECT_DELAY || "5000");
+const MAX_RECONNECT_ATTEMPTS = parseInt(process.env.MAX_RECONNECT_ATTEMPTS || "10");
 
 // Validate required environment variables
 if (!WS_URL || !PRIVATE_KEY) {
-  console.error('Missing required environment variables: WS_URL, PRIVATE_KEY');
+  console.error("Missing required environment variables: WS_URL, PRIVATE_KEY");
   process.exit(1);
 }
 
@@ -45,20 +50,20 @@ app.use(express.json());
 // Initialize Teneo SDK using SDKConfigBuilder pattern
 const config = new SDKConfigBuilder()
   .withWebSocketUrl(WS_URL)
-  .withAuthentication(PRIVATE_KEY, WALLET_ADDRESS)  // Wallet auto-derived if not provided
+  .withAuthentication(PRIVATE_KEY, WALLET_ADDRESS) // Wallet auto-derived if not provided
   .withRoom(DEFAULT_ROOM)
   .withReconnection({
     enabled: ENABLE_RECONNECTION,
     delay: RECONNECT_DELAY,
     maxAttempts: MAX_RECONNECT_ATTEMPTS
   })
-  .withResponseFormat({ format: 'both', includeMetadata: true })
+  .withResponseFormat({ format: "both", includeMetadata: true })
   .withLogging(LOG_LEVEL)
   .withCache(ENABLE_CACHE, CACHE_TIMEOUT, MAX_CACHE_SIZE)
   .withSignatureVerification({
     enabled: ENABLE_SIG_VERIFICATION,
     trustedAddresses: TRUSTED_ADDRESSES,
-    requireFor: ['task_response', 'agent_selected'],
+    requireFor: ["task_response", "agent_selected"],
     strictMode: false
   })
   .build();
@@ -66,35 +71,35 @@ const config = new SDKConfigBuilder()
 const teneoSDK = new TeneoSDK(config);
 
 // Connect to Teneo
-console.log('📡 Connecting to Teneo network...');
+console.log("📡 Connecting to Teneo Protocol...");
 await teneoSDK.connect();
-console.log('✅ Connected to Teneo\n');
+console.log("✅ Connected to Teneo\n");
 
 // Health endpoint
-app.get('/health', (req, res) => {
+app.get("/health", (req, res) => {
   const health = teneoSDK.getHealth();
   res.json({
-    status: 'ok',
+    status: "ok",
     teneo: {
-      connected: health.connection.status === 'connected',
+      connected: health.connection.status === "connected",
       authenticated: health.connection.authenticated
     }
   });
 });
 
 // Query endpoint - send message to Teneo coordinator or specific agent
-app.post('/query', async (req, res) => {
+app.post("/query", async (req, res) => {
   try {
     const { message, agent, timeout = 30000 } = req.body;
 
     if (!message) {
       return res.status(400).json({
         success: false,
-        error: 'Message is required'
+        error: "Message is required"
       });
     }
 
-    console.log(`\n🔍 Query: ${message}${agent ? ` (to agent: ${agent})` : ' (via coordinator)'}`);
+    console.log(`\n🔍 Query: ${message}${agent ? ` (to agent: ${agent})` : " (via coordinator)"}`);
 
     let response: any;
 
@@ -103,14 +108,17 @@ app.post('/query', async (req, res) => {
     if (agent) {
       // Direct command to specific agent
       console.log(`🎯 Sending direct command to agent: ${agent}`);
-      response = await teneoSDK.sendDirectCommand({
-        agent,
-        command: message,
-        room: DEFAULT_ROOM
-      }, true);  // waitForResponse = true
+      response = await teneoSDK.sendDirectCommand(
+        {
+          agent,
+          command: message,
+          room: DEFAULT_ROOM
+        },
+        true
+      ); // waitForResponse = true
     } else {
       // Send via coordinator (coordinator will select best agent)
-      console.log('📡 Sending message via coordinator');
+      console.log("📡 Sending message via coordinator");
       response = await teneoSDK.sendMessage(message, {
         waitForResponse: true,
         timeout
@@ -118,14 +126,14 @@ app.post('/query', async (req, res) => {
     }
 
     if (!response || !response.humanized) {
-      console.log('⚠️  No response data received');
+      console.log("⚠️  No response data received");
       return res.json({
         success: false,
-        error: 'No response from agent'
+        error: "No response from agent"
       });
     }
 
-    console.log('📨 Response received from agent');
+    console.log("📨 Response received from agent");
     console.log(`✅ Response successfully processed\n`);
 
     res.json({
@@ -137,20 +145,20 @@ app.post('/query', async (req, res) => {
       }
     });
   } catch (error) {
-    console.error('❌ Query error:', error);
+    console.error("❌ Query error:", error);
     res.status(500).json({
       success: false,
-      error: error instanceof Error ? error.message : 'Unknown error'
+      error: error instanceof Error ? error.message : "Unknown error"
     });
   }
 });
 
 // List agents endpoint
-app.get('/agents', (_req, res) => {
+app.get("/agents", (_req, res) => {
   const agents = teneoSDK.getAgents();
   res.json({
     success: true,
-    agents: agents.map(a => ({
+    agents: agents.map((a) => ({
       id: a.id,
       name: a.name,
       description: a.description,
@@ -164,13 +172,15 @@ app.listen(PORT, () => {
   console.log(`🚀 Teneo Service running on http://localhost:${PORT}`);
   console.log(`   Health: GET  http://localhost:${PORT}/health`);
   console.log(`   Query:  POST http://localhost:${PORT}/query`);
-  console.log(`           Body: { "message": "your query", "agent": "optional-agent-id", "timeout": 30000 }`);
+  console.log(
+    `           Body: { "message": "your query", "agent": "optional-agent-id", "timeout": 30000 }`
+  );
   console.log(`   Agents: GET  http://localhost:${PORT}/agents\n`);
 });
 
 // Graceful shutdown
-process.on('SIGINT', () => {
-  console.log('\n👋 Shutting down...');
+process.on("SIGINT", () => {
+  console.log("\n👋 Shutting down...");
   teneoSDK.disconnect();
   teneoSDK.destroy();
   process.exit(0);

package/examples/nestjs-dashboard/.env.example

@@ -0,0 +1,11 @@
+# Teneo SDK Configuration
+WS_URL=wss://your-teneo-server.com/ws
+PRIVATE_KEY=your_ethereum_private_key_here_without_0x_prefix
+WALLET_ADDRESS=your_ethereum_wallet_address_here_with_0x_prefix(optional)
+
+# Signature Verification (optional)
+ENABLE_SIGNATURE_VERIFICATION=false
+TRUSTED_ADDRESSES=0x1234...,0x5678...
+
+# Server Configuration
+PORT=3000