Interact with the Framework

ChainMind (CMD) Framework Documentation

---

The ChainMind (CMD) Framework enables real-time monitoring and analysis of Solana blockchain activity using AI-powered agents. Each agent provides unique insights and perspectives on blockchain events, helping you track token creations, trading activity, liquidity events, and more.

---

🤖 Default Agents

Available AI Agents

1. Lumina: Optimistic and enthusiastic analyst focusing on emerging opportunities.

2. Stella: Technical and precise observer with deep protocol knowledge.

3. Matrix: Cyberpunk-style analyst specializing in pattern recognition.

4. Nebula: Strategic and long-term focused market philosopher.

---

🚀 Quick Start

Prerequisites

Before getting started with the ChainMind Framework, make sure you have the following:

• Node.js (v16 or higher)

• npm (Node Package Manager)

• OpenAI API key for AI interaction

• Internet connection to fetch real-time data

---

Installation

1. Clone the repository:

   bashCopygit clone https://github.com/ChainMindNetwork/cmd-fw-v1

2. Change into the project directory:

   bashCopycd cmd-fw-v1

3. Install the necessary dependencies:

   bashCopynpm install

---

Configuration

1. Create a .env file in the root directory of the project.

2. Add the following configuration values to the .env file:

   OPENAI_API_KEY=your_openai_api_key
   API_URL=https://api.chainmind.network

Replace your_openai_api_key with your actual OpenAI API key.

---

📋 Available Commands

The CMD Framework provides several commands for interacting with blockchain activity. Below are the available commands and examples of usage:

1. List Available Agents

View all configured AI agents and their personalities:

npm run list-agents

2. Monitor New Token Creations

Watch for new token creations with AI commentary. Specify the agent name to use.

npm run watch-tokens <agent-name>

Example:

npm run watch-tokens Nebula

3. Monitor Token Trading Activity

Track specific token trades with AI insights. Provide the agent name and token address.

npm run watch-token-trades <agent-name> <token-address>

Example:

npm run watch-token-trades Matrix SOL_TOKEN_ADDRESS

4. Monitor Account Trading Activity

Track account-specific trading with AI analysis. Specify the agent name and account address.

npm run watch-account-trades <agent-name> <account-address>

Example:

npm run watch-account-trades Stella WALLET_ADDRESS

5. Monitor Raydium Liquidity Events

Track liquidity pool activities with AI commentary. Use an agent to analyze these events.

npm run watch-liquidity <agent-name>

Example:

npm run watch-liquidity Lumina

6. Agent Interaction

Engage in direct conversation with an agent. Specify the agent name to start a chat.

npm run agent-talk <agent-name>

Example:

npm run agent-talk Matrix

---

🔍 Output Format

Each monitoring command provides:

• AI agent commentary

• Timestamp information

• Relevant blockchain data

• Formatted JSON output

Example output:

jsonCopy{
  "analysis": {
    "agent": "Lumina",
    "commentary": "Fascinating movement! This token is showing strong accumulation patterns...",
    "timestamp": "2024-01-20 15:30:45"
  },
  "data": {
    "token": "SOL",
    "action": "buy",
    "amount": "1000",
    "price": "100.50"
  }
}

---

⚡ Features

• Real-time blockchain monitoring

• AI-enhanced analysis

• Rate-limited API calls (2-second cooldown)

• Multiple monitoring modes

• Clean data presentation

• Graceful error handling

---

🛠 Technical Details

Dependencies

• WebSocket for real-time data

• TypeScript for type safety

• Express for API endpoints

Rate Limiting

• 2-second cooldown between AI analyses to prevent API spam and maintain performance.

---

🤝 Error Handling

The CMD Framework handles the following errors:

• Network disconnections

• Invalid agent names

• API rate limits

• Malformed data

• Connection timeouts

---

📝 Notes

• All timestamps are in local time.

• Data updates in real-time.

• AI responses are rate-limited.

• Use Ctrl+C for graceful shutdown.

• An active internet connection is required for data fetching and agent interaction.

---

🔐 Security

• Keep your API keys secure and never expose them in public.

• Monitor API usage to prevent abuse.

• Use environment variables to manage sensitive data securely.

• Avoid sharing agent outputs publicly unless needed.

---

📚 Support

If you have any issues or questions, please refer to the following steps for troubleshooting:

• Check error messages.

• Verify your .env configuration.

• Confirm agent availability.

• Check your network connection.

• Verify input parameters for the commands.

For more detailed support, visit our GitHub repository or contact the community.

---

📄 License

The ChainMind Framework is released under the MIT License. For more details, please check the LICENSE file in the repository.

---

About

The ChainMind Framework (cmd-fw-v1) is designed to help developers and traders interact with the Solana blockchain using AI agents. With the framework, you can monitor token activity, track market movements, and analyze blockchain data with ease.