Skip to content

Commit 54b3f5d

Browse files
authored
Revise README for AuditorSEC branding and features
docs: sync README.md with safe-improvements branch to resolve merge conflict Signed-off-by: Igor <romanchaa997@gmail.com>
1 parent cea1dda commit 54b3f5d

1 file changed

Lines changed: 190 additions & 54 deletions

File tree

README.md

Lines changed: 190 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,84 +1,220 @@
1-
# Audityzer AI-powered multi-chain Web3 security toolkit
1+
# Audityzer AI-Powered Web3 Security Platform
22

3-
[![GitHub stars](https://img.shields.io/github/stars/romanchaa997/Audityzer?style=social)](https://github.com/romanchaa997/Audityzer)
4-
[![CI](https://img.shields.io/github/actions/workflow/status/romanchaa997/Audityzer/ci.yml?label=CI)](https://github.com/romanchaa997/Audityzer/actions)
5-
[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
3+
## 🛡️ AuditorSEC — Enterprise Web3 Security Auditing Platform
64

7-
Multi-chain smart contract auditing with 20+ detection algorithms. Audityzer combines AI/ML detection with static analysis to find vulnerabilities across 6 EVM chains (Ethereum, BSC, Polygon, Arbitrum, Optimism, Avalanche).
5+
> **TRL4 PoC** | BRAVE1 Cybersecurity Track | Deadline: 30.04.2026
6+
7+
[![Railway](https://img.shields.io/badge/Railway-deployed-success)](https://audityzer-production-5112.up.railway.app)
8+
[![BRAVE1 Tier](https://img.shields.io/badge/BRAVE1-Tier%202%20(UAH%208M%20total)-blue)](https://brave1.gov.ua)
9+
[![GTM Strategy](https://img.shields.io/badge/docs-GTM%20Strategy-informational)](docs/GTM_STRATEGY.md)
10+
[![API](https://img.shields.io/badge/FastAPI-/api/v1/audit-green)](https://audityzer.onrender.com/health)
11+
12+
### What is AuditorSEC?
13+
14+
AuditorSEC is a security auditing platform for Web3/dApp smart contracts, built on top of Audityzer. It provides:
15+
16+
- 🔍 **Automated vulnerability scanning** via Slither + Foundry (Optimism, EVM chains)
17+
- 📄 **PDF audit reports** with MinIO-backed storage and presigned URLs
18+
- 🧠 **AI-powered analysis** (GPT-4) for log interpretation and anomaly detection
19+
- 🌐 **Multi-chain support**: Optimism, Ethereum, Polygon (UHIP-2A schema)
20+
- 🇺🇦 **BRAVE1 / DIANA compliant**: dual-use security tooling for Ukrainian defense sector
21+
22+
### Quick Start
23+
24+
```bash
25+
# API (FastAPI)
26+
curl -X POST https://audityzer.onrender.com/api/v1/audit \
27+
-H "Content-Type: application/json" \
28+
-d '{"project_name": "MyDeFiProtocol", "log_text": "transfer(0x..., 1000000)"}'
29+
30+
# Health check
31+
curl https://audityzer.onrender.com/health
32+
```
833

934
---
1035

11-
## Why Audityzer
36+
[![npm version](https://badge.fury.io/js/audityzer.svg)](https://www.npmjs.com/package/audityzer)
37+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
38+
[![Build Status](https://github.com/romanchaa997/Audityzer/actions/workflows/ci.yml/badge.svg)](https://github.com/romanchaa997/Audityzer/actions)
39+
[![HF Spaces](https://img.shields.io/badge/HuggingFace-Spaces-blue)](https://huggingface.co/Audityzer)
40+
[![BRAVE1](https://img.shields.io/badge/BRAVE1-Cybersecurity%20Track-red)](https://brave1.gov.ua)
41+
[![NIS2](https://img.shields.io/badge/NIS2-Compliant%20Design-green)](https://www.nis2directive.eu)
42+
[![PQC](https://img.shields.io/badge/PQC-ML--KEM--768%20Ready-purple)](https://audityzer.com)
43+
44+
**The most advanced open-source Web3 security testing toolkit**
45+
Smart contract auditing · AI vulnerability detection · Post-Quantum Cryptography · Defense-grade compliance
46+
47+
[Live Demo](https://audityzer.com) · [HF Spaces](https://huggingface.co/spaces/Audityzer/audityzer-demo) · [BRAVE1 PoC](https://brave1.gov.ua) · [Documentation](https://audityzer.com/docs)
1248

13-
- 3.7B+ lost to smart contract exploits in 2024 (Chainalysis).
14-
- Traditional audits cost 20K–150K and take 4–8 weeks.
15-
- 85% of Web3 projects launch without proper security audits.
49+
---
1650

17-
Audityzer automates security reviews from weeks to minutes, so you can ship faster without sacrificing security.
51+
## What is Audityzer?
1852

19-
## Key features
53+
Audityzer is a **production-grade, AI-enhanced Web3 security testing platform** built for DeFi protocols, smart contract auditors, and defense-adjacent cybersecurity teams.
2054

21-
- **20+ detection algorithms**: reentrancy, integer overflow/underflow, access control flaws, oracle manipulation, flash loan exploits, front-running and more.
22-
- **Multi-chain native**: Ethereum, BSC, Polygon, Arbitrum, Optimism, Avalanche.
23-
- **AI-assisted analysis**: pattern recognition trained on tens of thousands of real exploits.
24-
- **CI/CD friendly**: CLI-first design, easy to plug into GitHub Actions and other pipelines.
55+
Built under the AuditorSEC initiative, it combines:
2556

26-
## Quick start
57+
- **AI-powered vulnerability detection** with Playwright-based browser automation
58+
- **Post-Quantum Cryptography (PQC)** readiness — ML-KEM-768, ML-DSA-87, hybrid X25519+PQC
59+
- **Multi-tenant Kubernetes deployment** on DigitalOcean (fra1) with ArgoCD GitOps
60+
- **NATS JetStream event bus** for real-time security telemetry
61+
- **BRAVE1 defense PoC** — Bakhmach cybersecurity overlay, TRL-4→TRL-6
62+
- **NIS2 / DORA compliance** framework with automated audit trails
2763

28-
1. Install CLI:
29-
```bash
30-
npm install -g audityzer
31-
# or
32-
pip install audityzer-cli
33-
```
34-
2. Scan a Solidity project:
35-
```bash
36-
audityzer scan ./contracts --chain ethereum
37-
# or npm variant
38-
npx audityzer scan --target ./contracts --mode advanced
39-
```
40-
3. Review report:
41-
- High / Medium / Low findings
42-
- Suggested fixes
43-
- Links to docs and best practices.
64+
---
4465

4566
## Architecture
4667

4768
```
4869
Audityzer Platform
49-
├── AI Security Engine (Playwright + OpenAI + SARIF scanner)
50-
├── Smart Contract Scanner (Slither, Mythril, Echidna, Foundry fuzz)
51-
├── Multi-chain API (FastAPI + PostgreSQL)
52-
├── NATS JetStream (real-time events)
53-
└── K8s (DigitalOcean fra1, ArgoCD)
70+
├── AI Security Engine # Playwright + OpenAI + custom SARIF scanner
71+
├── Smart Contract Scanner # Slither, Mythril, Echidna, Foundry fuzz
72+
├── PQC Module # ML-KEM-768, ML-DSA-87, hybrid TLS
73+
├── Multi-tenant API # FastAPI + PostgreSQL RLS + Cloudflare Hyperdrive
74+
├── NATS JetStream Bus # Real-time event streaming (3 topics)
75+
├── K8s Orchestration # DigitalOcean fra1, ArgoCD, Prometheus/Grafana
76+
├── Defense Branch # BRAVE1 SPRINT-BAK-COR-001, drone cybersecurity
77+
└── Compliance Layer # NIS2 Art.20/21/23, DORA, SOC/MDR
78+
```
79+
80+
---
81+
82+
## Features
83+
84+
### Security Testing
85+
86+
- 20+ vulnerability detection algorithms (reentrancy, flash loans, access control, oracle manipulation, MEV)
87+
- Cross-chain support: Ethereum, Solana, Optimism L2, Arbitrum, BSC
88+
- AI-powered SARIF report generation with severity scoring
89+
- OWASP / NIST CSF / SCA / DAST / SAST pipelines
90+
- Web3 wallet integration: MetaMask, WalletConnect, Coinbase Wallet
91+
92+
### Infrastructure & DevSecOps
93+
94+
- Kubernetes (DigitalOcean neuralinfra-k8s, fra1) + ArgoCD GitOps
95+
- GitHub Actions CI/CD with CodeQL, Semgrep, dependency audit
96+
- Multi-tenant PostgreSQL with Row Level Security (RLS)
97+
- Apache SeaTunnel CDC sync + NATS JetStream streaming
98+
- Cloudflare DNS / Workers / Hyperdrive connection pooling
99+
- Telegram bot ecosystem: `audityzerbot`, `AuditorSECAlertBot`, `audityzeralertsbot`
100+
101+
### Post-Quantum Cryptography (PQC)
102+
103+
- ML-KEM-768 (CRYSTALS-Kyber) key encapsulation
104+
- ML-DSA-87 (CRYSTALS-Dilithium) digital signatures
105+
- Hybrid X25519 + PQC for backwards-compatible TLS
106+
- NIS2-aligned crypto-agility policy engine
107+
- IoT edge PQC (ESP32/RPi) via BRAVE1 defense track
108+
109+
### Compliance & Governance
110+
111+
- NIS2 Directive (EU 2022/2555) — Art. 20 management, Art. 21 risk/crypto, Art. 23 incident reporting
112+
- DORA-aligned incident response workflows
113+
- ForestESG governance layer — ESG risk scoring, resource tracking
114+
- SOC/MDR telemetry with Grafana + ClickHouse dashboards
115+
- UHIP-2A justice/compliance integration
116+
117+
---
118+
119+
## Quick Start
120+
121+
```bash
122+
# Install
123+
npm install audityzer
124+
125+
# Run security scan
126+
npx audityzer scan --target https://your-protocol.com --mode advanced
127+
128+
# Docker
129+
docker run -p 3000:3000 audityzer/platform:latest
130+
131+
# Helm (K8s)
132+
helm install audityzer ./charts/audityzer -n audityzer
133+
helm install nats nats/nats -n audityzer --set nats.jetstream.enabled=true
54134
```
55135

56-
CLI integrates Slither/Foundry for static+fuzz analysis; AI layer flags patterns like reentrancy (external calls before state updates).
136+
---
57137

58-
## Installation
138+
## Live Infrastructure
59139

60-
- **NPM**: `npm install audityzer`
61-
- **Docker**: `docker run -p 3000:3000 audityzer/platform:latest`
62-
- **From source**: `git clone https://github.com/romanchaa997/Audityzer && npm install && npm run dev`
140+
| Service | Status | URL |
141+
|---------|--------|-----|
142+
| Main Platform | Production | [audityzer.com](https://audityzer.com) |
143+
| Grafana Dashboard | Live | [bbbhhai.com](https://bbbhhai.com) |
144+
| HF Demo Space | Running | [audityzer-demo](https://huggingface.co/spaces/Audityzer/audityzer-demo) |
145+
| BRAVE1 Risk Assistant | Running | [brave1-risk-assistant](https://huggingface.co/spaces/Audityzer/brave1-risk-assistant) |
146+
| K8s Cluster | fra1 DO | neuralinfra-k8s |
147+
| Load Balancer | Active | 129.212.254.79 |
63148

64-
## Live Demo
149+
---
65150

66-
- Platform: [https://audityzer.com](https://audityzer.com)
67-
- HF Spaces: https://huggingface.co/spaces/Audityzer/audityzer-demo
151+
## Grant & Program Track
68152

69-
## Tech Stack
153+
- **BRAVE1** — Cybersecurity track, 8,000,000 UAH, 2026 (SPRINT-BAK-COR-001 Bakhmach PoC)
154+
- **Diia.City** — R&D grant matching, innovation track 2026
155+
- **USF Startup EDGE** — 2026 program
156+
- **Horizon Europe** — Civic-Tech / Quantum-Safe Governance track
157+
- **EU4UA / WNISEF** — Defense-adjacent technology
70158

71-
Python, TypeScript/Node.js, Solidity, FastAPI, Kubernetes, Docker, Slither, Foundry, OpenAI.
159+
---
72160

73161
## Contributing
74162

75-
See [CONTRIBUTING.md](CONTRIBUTING.md). Focus: new detectors, chain support, CLI plugins.
163+
We welcome contributions! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines.
164+
165+
```bash
166+
git clone https://github.com/romanchaa997/Audityzer
167+
cd Audityzer
168+
npm install
169+
npm run dev
170+
```
171+
172+
---
173+
174+
Built in Ukraine with love and resilience. Bakhmach, Chernihiv Oblast — AuditorSEC Initiative 2024-2026
175+
176+
[![GitHub stars](https://img.shields.io/github/stars/romanchaa997/Audityzer?style=social)](https://github.com/romanchaa997/Audityzer/stargazers)
177+
[![GitHub forks](https://img.shields.io/github/forks/romanchaa997/Audityzer?style=social)](https://github.com/romanchaa997/Audityzer/network)
178+
179+
---
180+
181+
## 🌐 Infrastructure Status
182+
183+
> **Last Updated:** April 2026
184+
185+
### Site Status
186+
187+
| Site | Status | Issue | Fix |
188+
|------|--------|-------|-----|
189+
| auditorsec.com | ❌ Error 525 | Cloudflare SSL handshake failed | Generate Origin CA cert via Terraform |
190+
| audityzer.io | ❌ NXDOMAIN | Domain not in Cloudflare | Add domain to Cloudflare, configure DNS |
191+
| romanchaa997.github.io/Audityzer | ✅ Active || GitHub Pages (fallback) |
192+
193+
### Immediate Actions (Week 1)
194+
195+
1. **Fix auditorsec.com SSL (Error 525)**
196+
- Generate Cloudflare Origin CA certificate
197+
- Install cert on origin server
198+
- Workflow: `.github/workflows/origin-ca-monitor.yml`
199+
200+
2. **Fix audityzer.io DNS (NXDOMAIN)**
201+
- Add `audityzer.io` to Cloudflare account manually
202+
- Run workflow: `.github/workflows/add-audityzer-io-dns.yml`
203+
- Adds: 4x GitHub Pages A records + CNAME www
204+
205+
3. **Monitoring & Alerts**
206+
- UptimeRobot + Telegram + ClickUp integration
207+
- n8n workflow: `.github/n8n/uptimerobot-telegram-clickup.json`
208+
- Workflow: `.github/workflows/uptimerobot-telegram-clickup.yml`
76209

77-
## Community & support
210+
### Required GitHub Secrets
78211

79-
- Star this repo to support the project 💫
80-
- Join the Discord: [link soon]
81-
- Follow on X/Twitter: [https://twitter.com/audityzer](https://twitter.com/audityzer)
82-
- Docs: [https://audityzer.com/docs](https://audityzer.com/docs)
212+
See [`docs/SECRETS_SETUP.md`](docs/SECRETS_SETUP.md) for full setup guide.
83213

84-
Together, we're making Web3 safer for everyone.
214+
| Secret | Purpose |
215+
|--------|----------|
216+
| `CLOUDFLARE_API_TOKEN` | Cloudflare DNS + Zone management |
217+
| `CLOUDFLARE_ZONE_ID` | auditorsec.com zone ID |
218+
| `TELEGRAM_BOT_TOKEN` | Downtime alert notifications |
219+
| `TELEGRAM_CHAT_ID` | Target Telegram chat |
220+
| `UPTIMEROBOT_API_KEY` | UptimeRobot monitor management |

0 commit comments

Comments
 (0)