XplainCrypto - Advanced Cryptocurrency Research Platform

XplainCrypto is a powerful platform that produces comprehensive, factual, and real-time research reports on any cryptocurrency or blockchain project.

🚀 Key Features

• Hierarchical Research System - Breaks down research queries into strategic and tactical questions for in-depth exploration
• Specialized Research Agents - Domain-specific agents focus on technical aspects, tokenomics, market analysis, and ecosystem mapping
• Real-Time Data Integration - Up-to-date market data from CoinGecko, CoinMarketCap, and DeFiLlama
• LangGraph Workflow - Advanced state management and orchestration of the research process
• Comprehensive Reports - Detailed analysis with specific facts, figures, and technical details
• Customizable Reports - Configurable report structure and content via report_config.json
• Dynamic Visualizations - Automated generation of charts and tables based on research data

🏗️ Architecture

The system implements a multi-agent research approach:

1. Research Planning - Creates a hierarchical tree of research questions
2. Specialized Research - Different agents handle technical, tokenomics, market, and ecosystem research
3. Data Gathering - Real-time API integration for cryptocurrency data
4. Visualization - Generates charts, graphs and tables from the collected data
5. Report Generation - Synthesizes findings into a cohesive report

📝 Report Structure

Each report includes customizable sections defined in the report configuration:

• Executive Summary
• Introduction and background
• Technical features and capabilities
• Tokenomics and economic model
• Price and Market Analysis
• Governance structure
• Risks and Opportunities
• Team Assessment
• Partnerships and Ecosystem
• SWOT Analysis
• Conclusion and References

🎨 Visualization System

The platform includes a dedicated visualization agent that creates:

• Price trend charts
• Volume analysis charts
• TVL (Total Value Locked) visualizations
• Token distribution pie charts
• Competitive comparison bar charts
• Key metrics tables
• Development roadmap timelines

🛠️ Customization

Reports can be customized through the report_config.json file:

• Define report sections and their order
• Specify which visualizations appear in each section
• Configure data sources for different sections
• Customize visualization styles and formats
• Define description templates for automated text generation

🔧 Setup

1. Clone the repository
2. Install dependencies: pip install -r requirements.txt
3. Set up environment variables:
   • OPENAI_API_KEY - Required for LLM operations
   • TAVILY_API_KEY - Required for web search
   • COINMARKETCAP_API_KEY - Optional for additional market data
4. Customize report_config.json (optional)
5. Run the server: python -m uvicorn main:app --reload

📊 Using the System

The platform can be accessed through:

1. Web UI - Available at http://localhost:3000 when running locally
2. REST API - Endpoints documented in the API reference
3. Programmatic Access - Import and use the research modules directly

🔬 Research Methodology

The system employs a hierarchical approach similar to GPT-Researcher, but with specialized domain agents and real-time data integration:

1. Strategic Questions - High-level research areas specific to cryptocurrency analysis
2. Tactical Questions - Specific sub-topics that explore details within each strategic area
3. Multi-Source Verification - Cross-references information across multiple sources
4. Real-Time Data - Integrates live market data alongside research findings
5. Visualization Analysis - Automated generation of insights from data visualizations

🌟 Future Development

• Expanded API integrations for on-chain data
• Support for automated updating of research reports
• Comparative analysis between multiple projects
• Integration with trading signals and market indicators
• Additional visualization types and interactive elements

Project Structure

xplaincrypto/
├── backend/              # FastAPI server
│   ├── agents/           # AI agents for different tasks
│   │   ├── enhanced_researcher.py # Main research agent
│   │   ├── visualization_agent.py # Data visualization agent
│   │   ├── writer.py     # Report writing agent
│   │   ├── editor.py     # Report editing agent
│   │   ├── reviewer.py   # Report review agent
│   │   └── publisher.py  # Report publishing agent
│   ├── config/           # Configuration files
│   │   └── report_config.json # Report customization settings
│   ├── research/         # Research system components
│   │   ├── orchestrator.py # Orchestrates the research workflow
│   │   ├── data_modules.py # Data gathering modules
│   │   └── core.py       # Core research components
│   └── main.py           # Server entry point
├── frontend/             # Next.js frontend
│   ├── pages/            # React components and pages
│   └── styles/           # CSS and styling
└── docs/                 # Generated reports and visualizations

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.