@elizaos/plugin-ferepro 1.0.5

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Eliza
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,228 @@
+# @elizaos/plugin-ferepro
+
+A plugin for enabling WebSocket communication with FerePro API to provide AI-driven market insights within the ElizaOS ecosystem.
+
+## Description
+
+The FerePro plugin enables real-time communication with the FerePro API through WebSocket connections, providing market analysis, cryptocurrency comparisons, and financial insights.
+
+## Features
+
+- Real-time WebSocket communication
+- Streaming and non-streaming response support
+- Market data analysis and comparisons
+- Cryptocurrency insights
+- Debug mode for detailed responses
+- Automatic connection management
+- Comprehensive error handling
+- Credit tracking and management
+
+## Installation
+
+```bash
+bun install @elizaos/plugin-ferepro
+```
+
+## Configuration
+
+### Required Environment Variables
+
+```env
+# Required
+Ensure that FEREAI_USER_ID and FEREAI_API_KEY are correctly set in the character secrets 
+sections or as environment variables.
+
+FEREAI_USER_ID: FereAI User ID
+FEREAI_API_KEY: FereAI API key
+
+# Optional
+FereAI pro take some time to respond. Set REQUEST_TIMEOUT to avoid response timeouts 
+in the character settings section or as environment variable.
+
+REQUEST_TIMEOUT: Number of milliseconds before a request times out
+
+```
+
+## Usage
+
+### Example Queries
+
+1. Basic Market Query:
+
+```typescript
+// Get top cryptocurrencies
+"What are the top 5 cryptocurrencies?";
+```
+
+2. Comparison Analysis:
+
+```typescript
+// Compare specific cryptocurrencies
+"Compare Ethereum and Bitcoin for the past 6 months";
+```
+
+3. Historical Data:
+
+```typescript
+// Get historical performance
+"Compare top 3 coins against Bitcoin in the last 3 months";
+```
+
+## Development
+
+1. Clone the repository
+2. Install dependencies:
+
+```bash
+bun install
+```
+
+3. Build the plugin:
+
+```bash
+bun run build
+```
+
+4. Run in development mode:
+
+```bash
+bun run dev
+```
+
+## API Reference
+
+### Core Components
+
+1. **FereProService**
+
+    - Manages WebSocket connections
+    - Handles message sending/receiving
+    - Processes streaming responses
+    - Tracks credits and usage
+
+2. **Actions**
+    - EXECUTE_FEREPRO: Primary action for API communication
+    - Supports market queries and analysis requests
+    - Handles both streaming and non-streaming responses
+
+### Response Structure
+
+```typescript
+export interface FereAIChatResponse {
+  answer: string;
+  chat_id: string;
+  representation: any[];
+  agent_api_name: string;
+  query_summary: string;
+  agent_credits: number;
+  credits_available: number;
+}
+```
+
+## Error Handling
+
+The plugin includes comprehensive error handling for:
+
+- WebSocket connection issues
+- Invalid message formats
+- API response errors
+- Credit limitation issues
+
+## Common Issues & Troubleshooting
+
+### Connection Issues
+
+1. **WebSocket Connection Failures**
+
+    - Verify your internet connection
+    - Check if the FerePro API service is available
+    - Ensure your FERE_USER_ID and FERE_API_KEY is valid and active
+
+2. **Message Timeout**
+
+    - The connection might time out for long-running queries
+    - Consider setting REQUEST_TIMEOUT to avoid response timeouts in the character settings section or as environment variable.
+
+3. **Credit Depletion**
+    - Monitor credits_available in responses
+    - Set up alerts for low credit situations
+    - Contact FerePro support for credit top-up
+
+### Response Parsing
+
+1. **Invalid Response Format**
+
+    - Check if the query is properly formatted
+    - Verify the message structure matches the API requirements
+    - Enable debug mode for detailed error information
+
+2. **Missing Data**
+    - Ensure the requested timeframe is valid
+    - Verify the cryptocurrencies exist in the database
+    - Check if you have access to the requested data tier
+
+## Safety & Best Practices
+
+### Security
+
+1. **API Credentials**
+
+    - Never expose your FEREAI_USER_ID and FEREAI_API_KEY in public repositories
+    - Use environment variables or secrets sections in the character settings section for sensitive data
+    - Rotate credentials periodically if possible
+
+2. **Rate Limiting**
+    - Implement appropriate delays between requests
+    - Monitor credit usage to prevent unexpected depletion
+    - Cache responses when appropriate
+
+### Data Handling
+
+1. **Response Validation**
+
+    - Always validate response data before processing
+    - Implement proper error handling for malformed data
+    - Log unexpected response formats for debugging
+
+2. **Stream Management**
+    - Close WebSocket connections properly after use
+    - Implement reconnection logic for dropped connections
+    - Handle partial responses in streaming mode
+
+### Best Practices
+
+1. **Query Optimization**
+
+    - Keep queries focused and specific
+    - Use streaming for large data requests
+    - Implement caching for frequently requested data
+
+2. **Error Handling**
+
+    - Implement comprehensive error catching
+    - Log errors with appropriate context
+    - Provide meaningful error messages to users
+
+3. **Resource Management**
+    - Monitor WebSocket connection status
+    - Implement connection pooling for high-volume usage
+    - Clean up resources properly on service shutdown
+
+## Contributing
+
+Contributions are welcome! Please see the [CONTRIBUTING.md](CONTRIBUTING.md) file for more information.
+
+## Credits
+
+Special thanks to:
+
+- The Eliza community for their contributions and feedback
+
+For more information about FerePro capabilities:
+
+- [FereAI Website](https://www.fereai.xyz/)
+- [FereAI Agents Documentation](https://docs.fereai.xyz/docs/product/ai-versions)
+
+## License
+
+This plugin is part of the Eliza project. See the main project repository for license information.

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { Plugin } from '@elizaos/core';
+
+declare const fereProPlugin: Plugin;
+
+export { fereProPlugin as default, fereProPlugin };

package/dist/index.js

@@ -0,0 +1,301 @@
+import { Service, ServiceType, logger } from '@elizaos/core';
+import WebSocket from 'ws';
+import dayjs from 'dayjs';
+
+var __require = /* @__PURE__ */ ((x) => typeof require !== "undefined" ? require : typeof Proxy !== "undefined" ? new Proxy(x, {
+  get: (a, b) => (typeof require !== "undefined" ? require : a)[b]
+}) : x)(function(x) {
+  if (typeof require !== "undefined") return require.apply(this, arguments);
+  throw Error('Dynamic require of "' + x + '" is not supported');
+});
+var FereProAgentService = class _FereProAgentService extends Service {
+  apiKey;
+  userId;
+  baseUrl;
+  agentId;
+  settings;
+  static serviceType = ServiceType.WEB_SEARCH;
+  get serviceType() {
+    return _FereProAgentService.serviceType;
+  }
+  // Override the instance property for singleton pattern
+  static instance;
+  // Implement required static method from Service class
+  static getInstance() {
+    if (!this.instance) {
+      this.instance = new this();
+    }
+    return this.instance;
+  }
+  constructor(runtime) {
+    super(runtime);
+  }
+  // Implement required abstract properties
+  capabilityDescription = "Provides blockchain and cryptocurrency insights using FereAI API";
+  // Implement required abstract methods
+  async stop() {
+    console.log("FereProAgentService stopped");
+  }
+  // Implement required static methods
+  static async start(runtime) {
+    const service = new _FereProAgentService(runtime);
+    await service.initialize(runtime);
+    return service;
+  }
+  static async stop(_runtime) {
+    return Promise.resolve(true);
+  }
+  async initialize(runtime) {
+    this.apiKey = runtime.getSetting("FEREAI_API_KEY");
+    this.userId = runtime.getSetting("FEREAI_USER_ID");
+    this.baseUrl = "api.fereai.xyz";
+    this.agentId = "ProAgent";
+    this.settings = {
+      stream: true,
+      contextDuration: 1,
+      parentId: "0",
+      debug: false
+    };
+    if (!this.apiKey || !this.userId) {
+      throw new Error("FEREAI_API_KEY or FEREAI_USER_ID is required");
+    }
+  }
+  getWebSocketUrl(userPrompt) {
+    const apiKey = this.apiKey;
+    const userId = this.userId;
+    const baseUrl = this.baseUrl;
+    if (!apiKey || !userId || !baseUrl) {
+      throw new Error("Missing required API configuration");
+    }
+    switch (this.agentId) {
+      case "ProAgent":
+        return `wss://${baseUrl}/chat/v2/ws/${userId}?X-FRIDAY-KEY=${apiKey}`;
+      case "MarketAnalyzerAgent":
+        return `wss://${baseUrl}/ws/generate_summary/${userId}?X-FRIDAY-KEY=${apiKey}`;
+      default:
+        throw new Error(`Unsupported agent: ${this.agentId}`);
+    }
+  }
+  createPayload(message) {
+    const userTime = this.getUserTime();
+    return {
+      agent: this.agentId,
+      stream: this.settings.stream ?? true,
+      user_time: userTime.format(),
+      x_hours: this.settings.contextDuration ?? 1,
+      parent: this.settings.parentId === "0" ? 0 : this.settings.parentId ?? 0,
+      message
+    };
+  }
+  getUserTime() {
+    const utc = __require("dayjs/plugin/utc");
+    const timezone = __require("dayjs/plugin/timezone");
+    dayjs.extend(utc);
+    dayjs.extend(timezone);
+    const userTimezone = Intl.DateTimeFormat().resolvedOptions().timeZone;
+    const currentTimestamp = Date.now();
+    return dayjs(currentTimestamp).tz(userTimezone);
+  }
+  isValidResponse(value) {
+    return typeof value === "object" && value !== null && "answer" in value && typeof value.answer === "string";
+  }
+  async getFereproResponse(userPrompt) {
+    return new Promise((resolve, reject) => {
+      const wsUrl = this.getWebSocketUrl(userPrompt);
+      const websocket = new WebSocket(wsUrl);
+      let responseData;
+      websocket.on("open", () => {
+        logger.debug("WebSocket connection opened [Prompt]:", userPrompt);
+        const payload = this.createPayload(userPrompt);
+        logger.debug("Sending payload:", JSON.stringify(payload, null, 2));
+        websocket.send(JSON.stringify(payload));
+      });
+      websocket.on("message", (data) => {
+        try {
+          const message = data.toString();
+          if (message.trim().startsWith("{")) {
+            const response = JSON.parse(message);
+            if (this.isValidResponse(response)) {
+              responseData = response;
+            }
+          }
+          logger.debug("Received message:", message, "\n");
+        } catch (error) {
+          reject(error);
+          websocket.close();
+        }
+      });
+      websocket.on("error", (error) => {
+        reject(error);
+        websocket.close();
+      });
+      websocket.on("close", () => {
+        if (responseData) {
+          logger.debug("Received response:", responseData, "\n");
+          let result = null;
+          const responseDataChat = responseData;
+          logger.debug("Received response chat:", responseDataChat, "\n");
+          result = responseDataChat;
+          logger.debug("Returning result:", result, "\n");
+          resolve(result);
+        } else {
+          reject(new Error("WebSocket closed without receiving valid response"));
+        }
+      });
+    });
+  }
+};
+var executeFerePro = {
+  name: "EXECUTE_FEREPRO",
+  similes: [
+    "BLOCKCHAIN_INFO",
+    "CRYPTO_INFO",
+    "DEFI_DETAILS",
+    "NFT_DETAILS",
+    "WEB3_INSIGHTS",
+    "BLOCKCHAIN_RESEARCH",
+    "CRYPTO_RESEARCH",
+    "FIND_BLOCKCHAIN_INFO",
+    "GET_CRYPTO_DATA"
+  ],
+  description: "Answer questions related to blockchain technology, cryptocurrencies, DeFi, NFTs, and Web3.",
+  validate: async (runtime, _message) => {
+    const apiKey = runtime.getSetting("FEREAI_API_KEY");
+    const userId = runtime.getSetting("FEREAI_USER_ID");
+    if (!apiKey || !userId) {
+      logger.error("FEREAI_API_KEY or FEREAI_USER_ID is required");
+      return false;
+    }
+    return true;
+  },
+  handler: async (runtime, message, state, options, callback) => {
+    logger.log("Fere Pro prompt received:", message.content.text);
+    try {
+      const fereproService = new FereProAgentService();
+      await fereproService.initialize(runtime);
+      if (!state) {
+        state = await runtime.composeState(message);
+      } else {
+        state = await runtime.composeState(message);
+      }
+      const response = await fereproService.getFereproResponse(message.content.text || "");
+      if (response.answer && response.answer !== "") {
+        if (callback) {
+          callback({
+            text: response.answer,
+            content: { ...response }
+          });
+        }
+        return true;
+      } else {
+        logger.error("Invalid FerePro response:", response);
+        if (callback) {
+          callback({
+            text: "Unable to process ferePro request. Please try again later.",
+            content: { error: "Invalid FerePro response" }
+          });
+        }
+        return false;
+      }
+    } catch (error) {
+      console.error("Invalid FerePro response:", error);
+      const errorMessage = error instanceof Error ? error.message : "Unknown error";
+      if (callback) {
+        callback({
+          text: `Error processing message: ${errorMessage}`,
+          content: { error: errorMessage }
+        });
+      }
+      return false;
+    }
+  },
+  examples: [
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Tell me Solana memecoins which are greater than $100 million marketcap"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Tell me Base memecoins which are greater than $100 million marketcap"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Please tell me which ones would be a good buy in the current environment"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Compare the performance and social sentiment of the top 5 memecoins on Solana vs. Base. Highlight any significant differences and potential reasons"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Analyze the risk-adjusted returns of the top 10 trending tokens. Provide insights on which tokens offer the best risk-to-reward ratio"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Using historical data and current trends, predict the potential performance of the top 5 AI tokens over the next week. Provide the rationale behind each prediction"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Top KOLs for DEGEN on Base"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Give me a detailed analysis of $degen token"
+        }
+      }
+    ],
+    [
+      {
+        name: "{{user1}}",
+        content: {
+          text: "Give me a summary of the latest crypto news today"
+        }
+      }
+    ]
+  ]
+};
+
+// src/index.ts
+var fereProPlugin = {
+  name: "Fere Pro",
+  description: "Answer questions about blockchain, cryptocurrencies, and related topics using a dedicated API.",
+  actions: [executeFerePro],
+  evaluators: [],
+  providers: [],
+  services: [FereProAgentService]
+};
+var index_default = fereProPlugin;
+
+export { index_default as default, fereProPlugin };
+//# sourceMappingURL=index.js.map
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/services/ferepro.service.ts","../src/actions/ferePro.ts","../src/index.ts"],"names":["logger"],"mappings":";;;;;;;;;;AAeO,IAAM,mBAAA,GAAN,MAAM,oBAAA,SAA4B,OAAA,CAAmC;AAAA,EACxE,MAAA;AAAA,EACA,MAAA;AAAA,EACA,OAAA;AAAA,EACA,OAAA;AAAA,EACA,QAAA;AAAA,EAOA,OAAO,cAA+B,WAAA,CAAY,UAAA;AAAA,EAElD,IAAI,WAAA,GAA+B;AAC/B,IAAA,OAAO,oBAAA,CAAoB,WAAA;AAAA;AAC/B;AAAA,EAGA,OAAe,QAAA;AAAA;AAAA,EAGf,OAAO,WAAA,GAAoC;AACvC,IAAA,IAAI,CAAC,KAAK,QAAA,EAAU;AAChB,MAAA,IAAA,CAAK,QAAA,GAAW,IAAI,IAAA,EAAK;AAAA;AAE7B,IAAA,OAAO,IAAA,CAAK,QAAA;AAAA;AAChB,EAEA,YAAY,OAAA,EAAyB;AACjC,IAAA,KAAA,CAAM,OAAO,CAAA;AAAA;AACjB;AAAA,EAGA,qBAAA,GAAwB,kEAAA;AAAA;AAAA,EAGxB,MAAM,IAAA,GAAsB;AAExB,IAAA,OAAA,CAAQ,IAAI,6BAA6B,CAAA;AAAA;AAC7C;AAAA,EAGA,aAAa,MAAM,OAAA,EAA0C;AACzD,IAAA,MAAM,OAAA,GAAU,IAAI,oBAAA,CAAoB,OAAO,CAAA;AAC/C,IAAA,MAAM,OAAA,CAAQ,WAAW,OAAO,CAAA;AAChC,IAAA,OAAO,OAAA;AAAA;AACX,EAEA,aAAa,KAAK,QAAA,EAA2C;AAEzD,IAAA,OAAO,OAAA,CAAQ,QAAQ,IAAI,CAAA;AAAA;AAC/B,EAEA,MAAM,WAAW,OAAA,EAAuC;AACpD,IAAA,IAAA,CAAK,MAAA,GAAS,OAAA,CAAQ,UAAA,CAAW,gBAAgB,CAAA;AACjD,IAAA,IAAA,CAAK,MAAA,GAAS,OAAA,CAAQ,UAAA,CAAW,gBAAgB,CAAA;AACjD,IAAA,IAAA,CAAK,OAAA,GAAU,gBAAA;AACf,IAAA,IAAA,CAAK,OAAA,GAAU,UAAA;AACf,IAAA,IAAA,CAAK,QAAA,GAAW;AAAA,MACZ,MAAA,EAAQ,IAAA;AAAA,MACR,eAAA,EAAiB,CAAA;AAAA,MACjB,QAAA,EAAU,GAAA;AAAA,MACV,KAAA,EAAO;AAAA,KACX;AAEA,IAAA,IAAI,CAAC,IAAA,CAAK,MAAA,IAAU,CAAC,KAAK,MAAA,EAAQ;AAC9B,MAAA,MAAM,IAAI,MAAM,8CAA8C,CAAA;AAAA;AAClE;AACJ,EAEQ,gBAAgB,UAAA,EAA4B;AAChD,IAAA,MAAM,SAAS,IAAA,CAAK,MAAA;AACpB,IAAA,MAAM,SAAS,IAAA,CAAK,MAAA;AACpB,IAAA,MAAM,UAAU,IAAA,CAAK,OAAA;AAErB,IAAA,IAAI,CAAC,MAAA,IAAU,CAAC,MAAA,IAAU,CAAC,OAAA,EAAS;AAChC,MAAA,MAAM,IAAI,MAAM,oCAAoC,CAAA;AAAA;AAGxD,IAAA,QAAQ,KAAK,OAAA;AAAS,MAClB,KAAK,UAAA;AACD,QAAA,OAAO,CAAA,MAAA,EAAS,OAAO,CAAA,YAAA,EAAe,MAAM,iBAAiB,MAAM,CAAA,CAAA;AAAA,MACvE,KAAK,qBAAA;AACD,QAAA,OAAO,CAAA,MAAA,EAAS,OAAO,CAAA,qBAAA,EAAwB,MAAM,iBAAiB,MAAM,CAAA,CAAA;AAAA,MAChF;AACI,QAAA,MAAM,IAAI,KAAA,CAAM,CAAA,mBAAA,EAAsB,IAAA,CAAK,OAAO,CAAA,CAAE,CAAA;AAAA;AAC5D;AACJ,EAEQ,cAAc,OAAA,EAAiB;AACnC,IAAA,MAAM,QAAA,GAAW,KAAK,WAAA,EAAY;AAElC,IAAA,OAAO;AAAA,MACH,OAAO,IAAA,CAAK,OAAA;AAAA,MACZ,MAAA,EAAQ,IAAA,CAAK,QAAA,CAAS,MAAA,IAAU,IAAA;AAAA,MAChC,SAAA,EAAW,SAAS,MAAA,EAAO;AAAA,MAC3B,OAAA,EAAS,IAAA,CAAK,QAAA,CAAS,eAAA,IAAmB,CAAA;AAAA,MAC1C,MAAA,EAAQ,KAAK,QAAA,CAAS,QAAA,KAAa,MAAM,CAAA,GAAK,IAAA,CAAK,SAAS,QAAA,IAAY,CAAA;AAAA,MACxE;AAAA,KACJ;AAAA;AACJ,EAEQ,WAAA,GAAc;AAElB,IAAA,MAAM,GAAA,GAAM,UAAQ,kBAAkB,CAAA;AACtC,IAAA,MAAM,QAAA,GAAW,UAAQ,uBAAuB,CAAA;AAChD,IAAA,KAAA,CAAM,OAAO,GAAG,CAAA;AAChB,IAAA,KAAA,CAAM,OAAO,QAAQ,CAAA;AACrB,IAAA,MAAM,YAAA,GAAe,IAAA,CAAK,cAAA,EAAe,CAAE,iBAAgB,CAAE,QAAA;AAC7D,IAAA,MAAM,gBAAA,GAAmB,KAAK,GAAA,EAAI;AAClC,IAAA,OAAO,KAAA,CAAM,gBAAgB,CAAA,CAAE,EAAA,CAAG,YAAY,CAAA;AAAA;AAClD,EAEQ,gBAAgB,KAAA,EAA6C;AACjE,IAAA,OACI,OAAO,UAAU,QAAA,IACjB,KAAA,KAAU,QACV,QAAA,IAAY,KAAA,IACZ,OAAQ,KAAA,CAAc,MAAA,KAAW,QAAA;AAAA;AAEzC,EAEA,MAAM,mBAAmB,UAAA,EAAiD;AACtE,IAAA,OAAO,IAAI,OAAA,CAAQ,CAAC,OAAA,EAAS,MAAA,KAAW;AACpC,MAAA,MAAM,KAAA,GAAQ,IAAA,CAAK,eAAA,CAAgB,UAAU,CAAA;AAC7C,MAAA,MAAM,SAAA,GAAY,IAAI,SAAA,CAAU,KAAK,CAAA;AACrC,MAAA,IAAI,YAAA;AAEJ,MAAA,SAAA,CAAU,EAAA,CAAG,QAAQ,MAAM;AACvB,QAAA,MAAA,CAAO,KAAA,CAAM,yCAAyC,UAAU,CAAA;AAEhE,QAAA,MAAM,OAAA,GAAU,IAAA,CAAK,aAAA,CAAc,UAAU,CAAA;AAC7C,QAAA,MAAA,CAAO,MAAM,kBAAA,EAAoB,IAAA,CAAK,UAAU,OAAA,EAAS,IAAA,EAAM,CAAC,CAAC,CAAA;AAEjE,QAAA,SAAA,CAAU,IAAA,CAAK,IAAA,CAAK,SAAA,CAAU,OAAO,CAAC,CAAA;AAAA,OACzC,CAAA;AAED,MAAA,SAAA,CAAU,EAAA,CAAG,SAAA,EAAW,CAAC,IAAA,KAAyB;AAC9C,QAAA,IAAI;AACA,UAAA,MAAM,OAAA,GAAU,KAAK,QAAA,EAAS;AAC9B,UAAA,IAAI,OAAA,CAAQ,IAAA,EAAK,CAAE,UAAA,CAAW,GAAG,CAAA,EAAG;AAChC,YAAA,MAAM,QAAA,GAAW,IAAA,CAAK,KAAA,CAAM,OAAO,CAAA;AACnC,YAAA,IAAI,IAAA,CAAK,eAAA,CAAgB,QAAQ,CAAA,EAAG;AAChC,cAAA,YAAA,GAAe,QAAA;AAAA;AACnB;AAGJ,UAAA,MAAA,CAAO,KAAA,CAAM,mBAAA,EAAqB,OAAA,EAAS,IAAI,CAAA;AAAA,iBAC1C,KAAA,EAAO;AACZ,UAAA,MAAA,CAAO,KAAK,CAAA;AACZ,UAAA,SAAA,CAAU,KAAA,EAAM;AAAA;AACpB,OACH,CAAA;AAED,MAAA,SAAA,CAAU,EAAA,CAAG,OAAA,EAAS,CAAC,KAAA,KAAiB;AACpC,QAAA,MAAA,CAAO,KAAK,CAAA;AACZ,QAAA,SAAA,CAAU,KAAA,EAAM;AAAA,OACnB,CAAA;AAED,MAAA,SAAA,CAAU,EAAA,CAAG,SAAS,MAAM;AACxB,QAAA,IAAI,YAAA,EAAc;AACd,UAAA,MAAA,CAAO,KAAA,CAAM,oBAAA,EAAsB,YAAA,EAAc,IAAI,CAAA;AACrD,UAAA,IAAI,MAAA,GAAc,IAAA;AAElB,UAAA,MAAM,gBAAA,GAAmB,YAAA;AACzB,UAAA,MAAA,CAAO,KAAA,CAAM,yBAAA,EAA2B,gBAAA,EAAkB,IAAI,CAAA;AAE9D,UAAA,MAAA,GAAS,gBAAA;AAET,UAAA,MAAA,CAAO,KAAA,CAAM,mBAAA,EAAqB,MAAA,EAAQ,IAAI,CAAA;AAG9C,UAAA,OAAA,CAAQ,MAAM,CAAA;AAAA,SAClB,MAAO;AACH,UAAA,MAAA,CAAO,IAAI,KAAA,CAAM,mDAAmD,CAAC,CAAA;AAAA;AACzE,OACH,CAAA;AAAA,KACJ,CAAA;AAAA;AAET,CAAA;ACxLO,IAAM,cAAA,GAAyB;AAAA,EAClC,IAAA,EAAM,iBAAA;AAAA,EACN,OAAA,EAAS;AAAA,IACL,iBAAA;AAAA,IACA,aAAA;AAAA,IACA,cAAA;AAAA,IACA,aAAA;AAAA,IACA,eAAA;AAAA,IACA,qBAAA;AAAA,IACA,iBAAA;AAAA,IACA,sBAAA;AAAA,IACA;AAAA,GACJ;AAAA,EACA,WAAA,EACI,4FAAA;AAAA,EACJ,QAAA,EAAU,OAAO,OAAA,EAAwB,QAAA,KAAqB;AAC1D,IAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,UAAA,CAAW,gBAAgB,CAAA;AAClD,IAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,UAAA,CAAW,gBAAgB,CAAA;AAClD,IAAA,IAAI,CAAC,MAAA,IAAU,CAAC,MAAA,EAAQ;AACpB,MAAAA,MAAAA,CAAO,MAAM,8CAA8C,CAAA;AAC3D,MAAA,OAAO,KAAA;AAAA;AAEX,IAAA,OAAO,IAAA;AAAA,GACX;AAAA,EACA,SAAS,OACL,OAAA,EACA,OAAA,EACA,KAAA,EACA,SACA,QAAA,KACC;AACD,IAAAA,MAAAA,CAAO,GAAA,CAAI,2BAAA,EAA6B,OAAA,CAAQ,QAAQ,IAAI,CAAA;AAE5D,IAAA,IAAI;AAEA,MAAA,MAAM,cAAA,GAAiB,IAAI,mBAAA,EAAoB;AAC/C,MAAA,MAAM,cAAA,CAAe,WAAW,OAAO,CAAA;AAGvC,MAAA,IAAI,CAAC,KAAA,EAAO;AACR,QAAA,KAAA,GAAS,MAAM,OAAA,CAAQ,YAAA,CAAa,OAAO,CAAA;AAAA,OAC/C,MAAO;AAEH,QAAA,KAAA,GAAQ,MAAM,OAAA,CAAQ,YAAA,CAAa,OAAO,CAAA;AAAA;AAG9C,MAAA,MAAM,WAAW,MAAM,cAAA,CAAe,mBAAmB,OAAA,CAAQ,OAAA,CAAQ,QAAQ,EAAE,CAAA;AAEnF,MAAA,IAAI,QAAA,CAAS,MAAA,IAAU,QAAA,CAAS,MAAA,KAAW,EAAA,EAAI;AAC3C,QAAA,IAAI,QAAA,EAAU;AACV,UAAA,QAAA,CAAS;AAAA,YACL,MAAM,QAAA,CAAS,MAAA;AAAA,YACf,OAAA,EAAS,EAAE,GAAG,QAAA;AAAS,WAC1B,CAAA;AAAA;AAEL,QAAA,OAAO,IAAA;AAAA,OACX,MAAO;AACH,QAAAA,MAAAA,CAAO,KAAA,CAAM,2BAAA,EAA6B,QAAQ,CAAA;AAClD,QAAA,IAAI,QAAA,EAAU;AACV,UAAA,QAAA,CAAS;AAAA,YACL,IAAA,EAAM,4DAAA;AAAA,YACN,OAAA,EAAS,EAAE,KAAA,EAAO,0BAAA;AAA2B,WAChD,CAAA;AAAA;AAEL,QAAA,OAAO,KAAA;AAAA;AACX,aACK,KAAA,EAAO;AACZ,MAAA,OAAA,CAAQ,KAAA,CAAM,6BAA6B,KAAK,CAAA;AAChD,MAAA,MAAM,YAAA,GAAe,KAAA,YAAiB,KAAA,GAAQ,KAAA,CAAM,OAAA,GAAU,eAAA;AAC9D,MAAA,IAAI,QAAA,EAAU;AACV,QAAA,QAAA,CAAS;AAAA,UACL,IAAA,EAAM,6BAA6B,YAAY,CAAA,CAAA;AAAA,UAC/C,OAAA,EAAS,EAAE,KAAA,EAAO,YAAA;AAAa,SAClC,CAAA;AAAA;AAEL,MAAA,OAAO,KAAA;AAAA;AACX,GACJ;AAAA,EACA,QAAA,EAAU;AAAA,IACN;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ,KACJ;AAAA,IACA;AAAA,MACI;AAAA,QACI,IAAA,EAAM,WAAA;AAAA,QACN,OAAA,EAAS;AAAA,UACL,IAAA,EAAM;AAAA;AACV;AACJ;AACJ;AAER,CAAA;;;AC/JO,IAAM,aAAA,GAAwB;AAAA,EACjC,IAAA,EAAM,UAAA;AAAA,EACN,WAAA,EACI,gGAAA;AAAA,EACJ,OAAA,EAAS,CAAC,cAAc,CAAA;AAAA,EACxB,YAAY,EAAC;AAAA,EACb,WAAW,EAAC;AAAA,EACZ,QAAA,EAAU,CAAC,mBAAmB;AAClC;AAEA,IAAO,aAAA,GAAQ","file":"index.js","sourcesContent":["import {\n    logger,\n    Service,\n    IAgentRuntime,\n    ServiceType,\n    ServiceTypeName,\n    Memory,\n    stringToUuid,\n} from '@elizaos/core';\n\nimport WebSocket from 'ws';\nimport dayjs from 'dayjs';\n\nimport { FereAIChatResponse, IFereProService, FereAIAgentId } from '../types/ferepro-types';\n\nexport class FereProAgentService extends Service implements IFereProService {\n    apiKey!: string;\n    userId!: string;\n    baseUrl!: string;\n    agentId!: FereAIAgentId;\n    settings!: {\n        stream: boolean;\n        contextDuration: number;\n        parentId: string;\n        debug: boolean;\n    };\n\n    static serviceType: ServiceTypeName = ServiceType.WEB_SEARCH;\n\n    get serviceType(): ServiceTypeName {\n        return FereProAgentService.serviceType;\n    }\n\n    // Override the instance property for singleton pattern\n    private static instance: FereProAgentService;\n\n    // Implement required static method from Service class\n    static getInstance<T extends Service>(): T {\n        if (!this.instance) {\n            this.instance = new this() as FereProAgentService;\n        }\n        return this.instance as unknown as T;\n    }\n\n    constructor(runtime?: IAgentRuntime) {\n        super(runtime);\n    }\n\n    // Implement required abstract properties\n    capabilityDescription = 'Provides blockchain and cryptocurrency insights using FereAI API';\n\n    // Implement required abstract methods\n    async stop(): Promise<void> {\n        // Clean up any resources if needed\n        console.log('FereProAgentService stopped');\n    }\n\n    // Implement required static methods\n    static async start(runtime: IAgentRuntime): Promise<Service> {\n        const service = new FereProAgentService(runtime);\n        await service.initialize(runtime);\n        return service;\n    }\n\n    static async stop(_runtime: IAgentRuntime): Promise<unknown> {\n        // Clean up static resources if needed\n        return Promise.resolve(true);\n    }\n\n    async initialize(runtime: IAgentRuntime): Promise<void> {\n        this.apiKey = runtime.getSetting('FEREAI_API_KEY');\n        this.userId = runtime.getSetting('FEREAI_USER_ID');\n        this.baseUrl = 'api.fereai.xyz';\n        this.agentId = 'ProAgent';\n        this.settings = {\n            stream: true,\n            contextDuration: 1,\n            parentId: '0',\n            debug: false,\n        };\n\n        if (!this.apiKey || !this.userId) {\n            throw new Error('FEREAI_API_KEY or FEREAI_USER_ID is required');\n        }\n    }\n\n    private getWebSocketUrl(userPrompt: string): string {\n        const apiKey = this.apiKey;\n        const userId = this.userId;\n        const baseUrl = this.baseUrl;\n\n        if (!apiKey || !userId || !baseUrl) {\n            throw new Error('Missing required API configuration');\n        }\n\n        switch (this.agentId) {\n            case 'ProAgent':\n                return `wss://${baseUrl}/chat/v2/ws/${userId}?X-FRIDAY-KEY=${apiKey}`;\n            case 'MarketAnalyzerAgent':\n                return `wss://${baseUrl}/ws/generate_summary/${userId}?X-FRIDAY-KEY=${apiKey}`;\n            default:\n                throw new Error(`Unsupported agent: ${this.agentId}`);\n        }\n    }\n\n    private createPayload(message: string) {\n        const userTime = this.getUserTime();\n\n        return {\n            agent: this.agentId,\n            stream: this.settings.stream ?? true,\n            user_time: userTime.format(),\n            x_hours: this.settings.contextDuration ?? 1,\n            parent: this.settings.parentId === '0' ? 0 : (this.settings.parentId ?? 0),\n            message,\n        };\n    }\n\n    private getUserTime() {\n        // Load plugins dynamically to avoid import issues in tests\n        const utc = require('dayjs/plugin/utc');\n        const timezone = require('dayjs/plugin/timezone');\n        dayjs.extend(utc);\n        dayjs.extend(timezone);\n        const userTimezone = Intl.DateTimeFormat().resolvedOptions().timeZone;\n        const currentTimestamp = Date.now();\n        return dayjs(currentTimestamp).tz(userTimezone);\n    }\n\n    private isValidResponse(value: unknown): value is FereAIChatResponse {\n        return (\n            typeof value === 'object' &&\n            value !== null &&\n            'answer' in value &&\n            typeof (value as any).answer === 'string'\n        );\n    }\n\n    async getFereproResponse(userPrompt: string): Promise<FereAIChatResponse> {\n        return new Promise((resolve, reject) => {\n            const wsUrl = this.getWebSocketUrl(userPrompt);\n            const websocket = new WebSocket(wsUrl);\n            let responseData: FereAIChatResponse | null;\n\n            websocket.on('open', () => {\n                logger.debug('WebSocket connection opened [Prompt]:', userPrompt);\n\n                const payload = this.createPayload(userPrompt);\n                logger.debug('Sending payload:', JSON.stringify(payload, null, 2));\n\n                websocket.send(JSON.stringify(payload));\n            });\n\n            websocket.on('message', (data: WebSocket.Data) => {\n                try {\n                    const message = data.toString();\n                    if (message.trim().startsWith('{')) {\n                        const response = JSON.parse(message);\n                        if (this.isValidResponse(response)) {\n                            responseData = response as FereAIChatResponse;\n                        }\n                    }\n\n                    logger.debug('Received message:', message, '\\n');\n                } catch (error) {\n                    reject(error);\n                    websocket.close();\n                }\n            });\n\n            websocket.on('error', (error: Error) => {\n                reject(error);\n                websocket.close();\n            });\n\n            websocket.on('close', () => {\n                if (responseData) {\n                    logger.debug('Received response:', responseData, '\\n');\n                    let result: any = null;\n\n                    const responseDataChat = responseData as FereAIChatResponse;\n                    logger.debug('Received response chat:', responseDataChat, '\\n');\n\n                    result = responseDataChat;\n\n                    logger.debug('Returning result:', result, '\\n');\n\n                    // Return the response\n                    resolve(result);\n                } else {\n                    reject(new Error('WebSocket closed without receiving valid response'));\n                }\n            });\n        });\n    }\n}\n","import {\n    logger,\n    ActionExample,\n    Memory,\n    IAgentRuntime,\n    State,\n    type Action,\n    HandlerCallback,\n} from '@elizaos/core';\nimport { FereProAgentService } from '../services/ferepro.service';\n\nexport const executeFerePro: Action = {\n    name: 'EXECUTE_FEREPRO',\n    similes: [\n        'BLOCKCHAIN_INFO',\n        'CRYPTO_INFO',\n        'DEFI_DETAILS',\n        'NFT_DETAILS',\n        'WEB3_INSIGHTS',\n        'BLOCKCHAIN_RESEARCH',\n        'CRYPTO_RESEARCH',\n        'FIND_BLOCKCHAIN_INFO',\n        'GET_CRYPTO_DATA',\n    ],\n    description:\n        'Answer questions related to blockchain technology, cryptocurrencies, DeFi, NFTs, and Web3.',\n    validate: async (runtime: IAgentRuntime, _message: Memory) => {\n        const apiKey = runtime.getSetting('FEREAI_API_KEY');\n        const userId = runtime.getSetting('FEREAI_USER_ID');\n        if (!apiKey || !userId) {\n            logger.error('FEREAI_API_KEY or FEREAI_USER_ID is required');\n            return false;\n        }\n        return true;\n    },\n    handler: async (\n        runtime: IAgentRuntime,\n        message: Memory,\n        state?: State,\n        options?: { [key: string]: unknown },\n        callback?: HandlerCallback\n    ) => {\n        logger.log('Fere Pro prompt received:', message.content.text);\n\n        try {\n            // Initialize the FerePro service\n            const fereproService = new FereProAgentService();\n            await fereproService.initialize(runtime);\n\n            // Ensure state exists or generate a new one\n            if (!state) {\n                state = (await runtime.composeState(message)) as State;\n            } else {\n                // Update existing state with new message context\n                state = await runtime.composeState(message);\n            }\n\n            const response = await fereproService.getFereproResponse(message.content.text || '');\n\n            if (response.answer && response.answer !== '') {\n                if (callback) {\n                    callback({\n                        text: response.answer,\n                        content: { ...response },\n                    });\n                }\n                return true;\n            } else {\n                logger.error('Invalid FerePro response:', response);\n                if (callback) {\n                    callback({\n                        text: 'Unable to process ferePro request. Please try again later.',\n                        content: { error: 'Invalid FerePro response' },\n                    });\n                }\n                return false;\n            }\n        } catch (error) {\n            console.error('Invalid FerePro response:', error);\n            const errorMessage = error instanceof Error ? error.message : 'Unknown error';\n            if (callback) {\n                callback({\n                    text: `Error processing message: ${errorMessage}`,\n                    content: { error: errorMessage },\n                });\n            }\n            return false;\n        }\n    },\n    examples: [\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Tell me Solana memecoins which are greater than $100 million marketcap',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Tell me Base memecoins which are greater than $100 million marketcap',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Please tell me which ones would be a good buy in the current environment',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Compare the performance and social sentiment of the top 5 memecoins on Solana vs. Base. Highlight any significant differences and potential reasons',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Analyze the risk-adjusted returns of the top 10 trending tokens. Provide insights on which tokens offer the best risk-to-reward ratio',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Using historical data and current trends, predict the potential performance of the top 5 AI tokens over the next week. Provide the rationale behind each prediction',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Top KOLs for DEGEN on Base',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Give me a detailed analysis of $degen token',\n                },\n            },\n        ],\n        [\n            {\n                name: '{{user1}}',\n                content: {\n                    text: 'Give me a summary of the latest crypto news today',\n                },\n            },\n        ],\n    ],\n};\n","import { Plugin } from '@elizaos/core';\nimport { FereProAgentService } from './services/ferepro.service';\nimport { executeFerePro } from './actions/ferePro';\n\nexport const fereProPlugin: Plugin = {\n    name: 'Fere Pro',\n    description:\n        'Answer questions about blockchain, cryptocurrencies, and related topics using a dedicated API.',\n    actions: [executeFerePro],\n    evaluators: [],\n    providers: [],\n    services: [FereProAgentService],\n};\n\nexport default fereProPlugin;\n"]}

package/package.json

@@ -0,0 +1,85 @@
+{
+    "name": "@elizaos/plugin-ferepro",
+    "version": "1.0.5",
+    "description": "FerePro plugin for ElizaOS - Enables FereAI API integration and interactions",
+    "type": "module",
+    "author": "elizaOS Contributors",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/elizaos/elizaos-plugins"
+    },
+    "keywords": [
+        "elizaos",
+        "plugin",
+        "fereai",
+        "api"
+    ],
+    "main": "dist/index.js",
+    "module": "dist/index.js",
+    "types": "dist/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "import": {
+                "@elizaos/source": "./src/index.ts",
+                "types": "./dist/index.d.ts",
+                "default": "./dist/index.js"
+            }
+        }
+    },
+    "files": [
+        "dist"
+    ],
+    "dependencies": {
+        "@elizaos/core": "^1.0.0",
+        "dayjs": "^1.11.13",
+        "ws": "^8.14.2"
+    },
+    "devDependencies": {
+        "@biomejs/biome": "1.5.3",
+        "@types/bun": "^1.2.18",
+        "@types/ws": "^8.5.10",
+        "prettier": "^3.6.2",
+        "tsup": "^8.3.5",
+        "typescript": "^5.3.0"
+    },
+    "peerDependencies": {
+        "@elizaos/core": "^1.0.0",
+        "whatwg-url": "7.1.0"
+    },
+    "scripts": {
+        "build": "bun run clean && bun run build:esm",
+        "build:esm": "tsup --format esm --dts",
+        "clean": "rm -rf dist",
+        "dev": "bun run build:esm --watch",
+        "test": "bun test",
+        "test:coverage": "bun test --coverage",
+        "format": "prettier --write \"src/**/*.{ts,tsx,js,jsx,json,md}\"",
+        "format:check": "prettier --check \"src/**/*.{ts,tsx,js,jsx,json,md}\""
+    },
+    "publishConfig": {
+        "access": "public"
+    },
+    "agentConfig": {
+        "pluginType": "elizaos:plugin:1.0.0",
+        "pluginParameters": {
+            "REQUEST_TIMEOUT": {
+                "type": "number",
+                "minLength": 90000,
+                "description": "Request timeout is required",
+                "optional": true
+            },
+            "FEREAI_USER_ID": {
+                "type": "string",
+                "minLength": 1,
+                "description": "FereAI user id is required"
+            },
+            "FEREAI_API_KEY": {
+                "type": "string",
+                "minLength": 1,
+                "description": "FereAI API key is required"
+            }
+        }
+    }
+}