Crypto Rug Muncher commited on
Commit Β·
4a714a3
1
Parent(s): f543438
docs: comprehensive README with professional branding and all platform links
Browse files
README.md
CHANGED
|
@@ -3,37 +3,46 @@
|
|
| 3 |
**Open-Source Real-Time Crypto Intelligence Platform**
|
| 4 |
*The Bloomberg Terminal of Crypto Security*
|
| 5 |
|
| 6 |
-

|
| 7 |
-
|
| 8 |
---
|
| 9 |
|
| 10 |
-
##
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
|
| 12 |
-
|
| 13 |
|
| 14 |
-
##
|
| 15 |
|
| 16 |
### π Threat Detection
|
| 17 |
- **Token Scanning**: Real-time rugpull, honeypot, and scam detection
|
| 18 |
-
- **Wallet Forensics**: Track wallet behavior and transaction patterns
|
| 19 |
- **Risk Scoring**: AI-powered threat classification (0-30 safe, 30-70 warning, 70+ danger)
|
|
|
|
| 20 |
|
| 21 |
### π Market Intelligence
|
| 22 |
- **2500+ Assets**: Full market coverage across major chains (ETH, SOL, BTC, TRX)
|
| 23 |
- **Real-Time Data**: OHLCV, volume analytics, liquidity tracking
|
| 24 |
- **News Aggregation**: 1800+ sources with real-time sentiment analysis
|
|
|
|
| 25 |
|
| 26 |
### π οΈ Developer Tools
|
| 27 |
- **MCP Server**: Model Context Protocol integration for AI agents
|
| 28 |
- **x402 Marketplace**: Micropayment gateway for premium tools
|
| 29 |
- **REST API**: FastAPI-powered endpoints with full documentation
|
| 30 |
- **WebSocket Support**: Live price and alert streaming
|
|
|
|
| 31 |
|
| 32 |
### π Infrastructure
|
| 33 |
- **96 Chains Supported**: Multi-chain architecture with extensible provider system
|
| 34 |
- **Federated Label System**: 2.7M+ wallet addresses tagged from multiple sources
|
| 35 |
- **Graph Database**: Neo4j-powered relationship tracking
|
| 36 |
- **Vector Search**: Qdrant-based semantic intelligence retrieval
|
|
|
|
|
|
|
|
|
|
|
|
|
| 37 |
|
| 38 |
## ποΈ Architecture
|
| 39 |
|
|
@@ -45,23 +54,31 @@ Backend (FastAPI + Python 3.12)
|
|
| 45 |
βββ Deployment: Docker + Cloudflare Workers
|
| 46 |
```
|
| 47 |
|
|
|
|
|
|
|
| 48 |
## π Documentation
|
| 49 |
|
| 50 |
- **API Documentation**: https://rugmunch.io/api/docs
|
| 51 |
- **Architecture Guide**: See `ARCHITECTURE.md`
|
| 52 |
- **Development Setup**: See `BUILDER.md`
|
| 53 |
-
- **Deployment Guide**: See `
|
|
|
|
|
|
|
| 54 |
|
| 55 |
## π Links
|
| 56 |
|
| 57 |
| Platform | URL |
|
| 58 |
|----------|-----|
|
| 59 |
| π Website | https://rugmunch.io |
|
| 60 |
-
| π¬ Telegram | https://t.me/cryptorugmuncher |
|
| 61 |
-
|
|
|
|
|
|
|
|
| 62 |
| π GitHub | https://github.com/Rug-Munch-Media-LLC/rugmuncher-backend |
|
| 63 |
| π¦ GitLab | https://gitlab.com/cryptorugmuncher/rugmuncher-backend |
|
| 64 |
-
| π€ HuggingFace | https://huggingface.co/cryptorugmunch |
|
|
|
|
|
|
|
| 65 |
|
| 66 |
## π‘οΈ Security
|
| 67 |
|
|
@@ -72,7 +89,9 @@ This project underwent comprehensive security hardening (v5.0 unfuck), including
|
|
| 72 |
- Implemented structured logging with trace IDs
|
| 73 |
- Added Prometheus metrics for observability
|
| 74 |
|
| 75 |
-
See `
|
|
|
|
|
|
|
| 76 |
|
| 77 |
## π Status
|
| 78 |
|
|
@@ -80,23 +99,37 @@ See `SECRETS_AUDIT_2026-06-23.md` for full security audit details.
|
|
| 80 |
- β
**Clean Codebase**: Modernized, PEP8-compliant, no legacy debt
|
| 81 |
- β
**Multi-Platform**: Available on GitHub, GitLab, and HuggingFace
|
| 82 |
- β
**Open Source**: MIT License
|
|
|
|
|
|
|
|
|
|
| 83 |
|
| 84 |
## π§ Technology Stack
|
| 85 |
|
| 86 |
- **Backend**: FastAPI, Python 3.12, async architecture
|
| 87 |
-
- **Databases**: PostgreSQL, Redis, Neo4j, Qdrant, ClickHouse
|
| 88 |
- **Deployment**: Docker, Cloudflare Workers
|
| 89 |
- **Infrastructure**: 3-tier architecture (builder/production/standby)
|
|
|
|
|
|
|
|
|
|
| 90 |
|
| 91 |
## π€ Contributing
|
| 92 |
|
| 93 |
We welcome contributions! Please see `CONTRIBUTING.md` for guidelines.
|
| 94 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 95 |
## π License
|
| 96 |
|
| 97 |
-
MIT License - see `LICENSE` for details.
|
| 98 |
|
| 99 |
---
|
| 100 |
|
| 101 |
**Built by [Rug Munch Media](https://rugmunch.io) Β· Open Source Crypto Intelligence**
|
| 102 |
-
π https://rugmunch.io Β· π¬ https://t.me/cryptorugmuncher Β·
|
|
|
|
| 3 |
**Open-Source Real-Time Crypto Intelligence Platform**
|
| 4 |
*The Bloomberg Terminal of Crypto Security*
|
| 5 |
|
|
|
|
|
|
|
| 6 |
---
|
| 7 |
|
| 8 |
+
## Overview
|
| 9 |
+
|
| 10 |
+
RMI is the first **open-source crypto intelligence platform**, delivering real-time token scanning, wallet forensics, multi-chain market data, and scam detection across **96 blockchains**.
|
| 11 |
+
|
| 12 |
+
Built for developers, researchers, and traders who need institutional-grade crypto intelligence without vendor lock-in.
|
| 13 |
|
| 14 |
+
---
|
| 15 |
|
| 16 |
+
## π Key Features
|
| 17 |
|
| 18 |
### π Threat Detection
|
| 19 |
- **Token Scanning**: Real-time rugpull, honeypot, and scam detection
|
| 20 |
+
- **Wallet Forensics**: Track wallet behavior and transaction patterns across chains
|
| 21 |
- **Risk Scoring**: AI-powered threat classification (0-30 safe, 30-70 warning, 70+ danger)
|
| 22 |
+
- **Rug Probability**: Statistical rug-pull prediction using on-chain metrics
|
| 23 |
|
| 24 |
### π Market Intelligence
|
| 25 |
- **2500+ Assets**: Full market coverage across major chains (ETH, SOL, BTC, TRX)
|
| 26 |
- **Real-Time Data**: OHLCV, volume analytics, liquidity tracking
|
| 27 |
- **News Aggregation**: 1800+ sources with real-time sentiment analysis
|
| 28 |
+
- **Whale Alerts**: Track large wallet movements and trading patterns
|
| 29 |
|
| 30 |
### π οΈ Developer Tools
|
| 31 |
- **MCP Server**: Model Context Protocol integration for AI agents
|
| 32 |
- **x402 Marketplace**: Micropayment gateway for premium tools
|
| 33 |
- **REST API**: FastAPI-powered endpoints with full documentation
|
| 34 |
- **WebSocket Support**: Live price and alert streaming
|
| 35 |
+
- **Python SDK**: Type-safe client library for all endpoints
|
| 36 |
|
| 37 |
### π Infrastructure
|
| 38 |
- **96 Chains Supported**: Multi-chain architecture with extensible provider system
|
| 39 |
- **Federated Label System**: 2.7M+ wallet addresses tagged from multiple sources
|
| 40 |
- **Graph Database**: Neo4j-powered relationship tracking
|
| 41 |
- **Vector Search**: Qdrant-based semantic intelligence retrieval
|
| 42 |
+
- **Time-Series Analytics**: ClickHouse for high-volume market data queries
|
| 43 |
+
- **DuckDB Analytics**: Embedded OLAP for fast data exploration
|
| 44 |
+
|
| 45 |
+
---
|
| 46 |
|
| 47 |
## ποΈ Architecture
|
| 48 |
|
|
|
|
| 54 |
βββ Deployment: Docker + Cloudflare Workers
|
| 55 |
```
|
| 56 |
|
| 57 |
+
---
|
| 58 |
+
|
| 59 |
## π Documentation
|
| 60 |
|
| 61 |
- **API Documentation**: https://rugmunch.io/api/docs
|
| 62 |
- **Architecture Guide**: See `ARCHITECTURE.md`
|
| 63 |
- **Development Setup**: See `BUILDER.md`
|
| 64 |
+
- **Deployment Guide**: See `DEPLOYMENT.md`
|
| 65 |
+
|
| 66 |
+
---
|
| 67 |
|
| 68 |
## π Links
|
| 69 |
|
| 70 |
| Platform | URL |
|
| 71 |
|----------|-----|
|
| 72 |
| π Website | https://rugmunch.io |
|
| 73 |
+
| π¬ Telegram Group | https://t.me/cryptorugmuncher |
|
| 74 |
+
| π¦ Twitter/X | https://x.com/cryptorugmunch |
|
| 75 |
+
| π± Personal Telegram | @cryptorugmunch |
|
| 76 |
+
| π§ Email | info@rugmunch.io |
|
| 77 |
| π GitHub | https://github.com/Rug-Munch-Media-LLC/rugmuncher-backend |
|
| 78 |
| π¦ GitLab | https://gitlab.com/cryptorugmuncher/rugmuncher-backend |
|
| 79 |
+
| π€ HuggingFace | https://huggingface.co/cryptorugmunch/rugmuncher-backend |
|
| 80 |
+
|
| 81 |
+
---
|
| 82 |
|
| 83 |
## π‘οΈ Security
|
| 84 |
|
|
|
|
| 89 |
- Implemented structured logging with trace IDs
|
| 90 |
- Added Prometheus metrics for observability
|
| 91 |
|
| 92 |
+
**Audit Report**: See `SECURITY_AUDIT.md` for full details.
|
| 93 |
+
|
| 94 |
+
---
|
| 95 |
|
| 96 |
## π Status
|
| 97 |
|
|
|
|
| 99 |
- β
**Clean Codebase**: Modernized, PEP8-compliant, no legacy debt
|
| 100 |
- β
**Multi-Platform**: Available on GitHub, GitLab, and HuggingFace
|
| 101 |
- β
**Open Source**: MIT License
|
| 102 |
+
- β
**Active Development**: Continuous improvements and bug fixes
|
| 103 |
+
|
| 104 |
+
---
|
| 105 |
|
| 106 |
## π§ Technology Stack
|
| 107 |
|
| 108 |
- **Backend**: FastAPI, Python 3.12, async architecture
|
| 109 |
+
- **Databases**: PostgreSQL, Redis, Neo4j, Qdrant, ClickHouse, DuckDB
|
| 110 |
- **Deployment**: Docker, Cloudflare Workers
|
| 111 |
- **Infrastructure**: 3-tier architecture (builder/production/standby)
|
| 112 |
+
- **Code Quality**: 97% ruff compliance, 22% test coverage, comprehensive type hints
|
| 113 |
+
|
| 114 |
+
---
|
| 115 |
|
| 116 |
## π€ Contributing
|
| 117 |
|
| 118 |
We welcome contributions! Please see `CONTRIBUTING.md` for guidelines.
|
| 119 |
|
| 120 |
+
Key areas needing help:
|
| 121 |
+
- Frontend testing (currently 0% coverage)
|
| 122 |
+
- Integration tests
|
| 123 |
+
- Documentation improvements
|
| 124 |
+
- Bug fixes
|
| 125 |
+
|
| 126 |
+
---
|
| 127 |
+
|
| 128 |
## π License
|
| 129 |
|
| 130 |
+
**MIT License** - see `LICENSE.md` for details.
|
| 131 |
|
| 132 |
---
|
| 133 |
|
| 134 |
**Built by [Rug Munch Media](https://rugmunch.io) Β· Open Source Crypto Intelligence**
|
| 135 |
+
π https://rugmunch.io Β· π¬ https://t.me/cryptorugmuncher Β· π¦ https://x.com/cryptorugmunch
|