From 866abc2865ffc1628dadbe38cd31ca1f598a34ea Mon Sep 17 00:00:00 2001 From: Shakker Nerd Date: Thu, 6 Feb 2025 16:14:25 +0000 Subject: [PATCH] chore: remove remnant files/folders --- packages/plugin-ferePro/README.md | 238 ------------------- packages/plugin-solana-agentkit/src/index.ts | 12 - 2 files changed, 250 deletions(-) delete mode 100644 packages/plugin-ferePro/README.md delete mode 100644 packages/plugin-solana-agentkit/src/index.ts diff --git a/packages/plugin-ferePro/README.md b/packages/plugin-ferePro/README.md deleted file mode 100644 index e80265c0370..00000000000 --- a/packages/plugin-ferePro/README.md +++ /dev/null @@ -1,238 +0,0 @@ -# @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 -pnpm install @elizaos/plugin-ferepro -``` - -## Configuration - -### Required Environment Variables - -```env -# Required -FERE_USER_ID=your-user-id-here # Default: 1a5b4a29-9d95-44c8-aef3-05a8e515f43e -``` - -## Usage - -### Basic Message Structure - -```typescript -{ - "message": "Your market query here", - "stream": boolean, // Optional: Enable streaming responses - "debug": boolean // Optional: Enable debug mode -} -``` - -### 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 -pnpm install -``` - -3. Build the plugin: - -```bash -pnpm run build -``` - -4. Run in development mode: - -```bash -pnpm run dev -``` - -## API Reference - -### Core Components - -1. **FereProService** - - - Manages WebSocket connections - - Handles message sending/receiving - - Processes streaming responses - - Tracks credits and usage - -2. **Actions** - - SEND_FEREPRO_MESSAGE: Primary action for API communication - - Supports market queries and analysis requests - - Handles both streaming and non-streaming responses - -### Response Structure - -```typescript -interface ChatResponse { - answer: string; - chat_id: string; - representation?: Record[]; - 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 is valid and active - -2. **Message Timeout** - - - The connection might time out for long-running queries - - Consider using streaming mode for large data requests - - Implement retry logic for important queries - -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 FERE_USER_ID in public repositories - - Use environment variables 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 - -This plugin integrates with and builds upon several key technologies: - -- [IPFS](https://ipfs.tech/): InterPlanetary File System -- [Filecoin](https://filecoin.io/): Decentralized storage network -- [Web3.Storage](https://web3.storage/): Decentralized storage service - -Special thanks to: - -- The Protocol Labs team for IPFS and Filecoin -- The Web3.Storage team -- The decentralized storage community -- The Eliza community for their contributions and feedback - -For more information about Ferepro capabilities: - -- [IPFS Documentation](https://docs.ipfs.tech/) -- [Filecoin Documentation](https://docs.filecoin.io/) -- [Web3.Storage Documentation](https://web3.storage/docs/) - -## License - -This plugin is part of the Eliza project. See the main project repository for license information. diff --git a/packages/plugin-solana-agentkit/src/index.ts b/packages/plugin-solana-agentkit/src/index.ts deleted file mode 100644 index 0aa9dd0ba00..00000000000 --- a/packages/plugin-solana-agentkit/src/index.ts +++ /dev/null @@ -1,12 +0,0 @@ -import type { Plugin } from "@elizaos/core"; -import createToken from "./actions/createToken.ts"; - -export const solanaAgentkitPlugin: Plugin = { - name: "solana", - description: "Solana Plugin with solana agent kit for Eliza", - actions: [createToken], - evaluators: [], - providers: [], -}; - -export default solanaAgentkitPlugin;