Skip to content

fix(graph): Switch to BuchheimWalkerAlgorithm & update docs #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Anandb71 merged 1 commit into from
Feb 8, 2026
Merged

fix(graph): Switch to BuchheimWalkerAlgorithm & update docs #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
109 changes: 29 additions & 80 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,83 +1,32 @@
# FinShield Development Changelog 📋

> **Auto-updated progress log for team members**
> Last Updated: 2026-02-08 22:21 IST

---

## 🚀 Sprint 1: Project Foundation (Current)

### ✅ 2026-02-08 | Initial Project Setup

#### Monorepo Structure
- Created clean folder structure separating `frontend/` (Flutter) and `backend/` (FastAPI)
- Added comprehensive `.gitignore` for Python + Flutter + Docker
- Created project `README.md` with architecture overview and quickstart guide

#### Backend (FastAPI) - COMPLETE ✅
| Component | Status | Description |
|-----------|--------|-------------|
| `pyproject.toml` | ✅ | Modern Python packaging with FastAPI deps |
| `app/core/config.py` | ✅ | Pydantic settings with env support |
| `app/services/audio_analyzer.py` | ✅ | Abstract + Mock implementation for Hotfoot Audio |
| `app/services/document_scanner.py` | ✅ | Abstract + Mock implementation for Hotfoot Docs |
| `app/services/context_engine.py` | ✅ | Abstract + Mock implementation for Backboard RAG |
| `app/api/v1/health.py` | ✅ | Health check with readiness/liveness probes |
| `app/api/v1/analyze.py` | ✅ | Unified analysis endpoint (audio/doc/cross-ref) |
| `app/main.py` | ✅ | FastAPI app factory with CORS for Flutter |
| `scripts/dev.py` | ✅ | Dev server launcher with hot-reload |
| `Dockerfile` | ✅ | Multi-stage production build |
| `.env.example` | ✅ | Environment template |

#### Frontend (Flutter) - IN PROGRESS 🔄
| Component | Status | Description |
|-----------|--------|-------------|
| `pubspec.yaml` | ✅ | Riverpod, Dio, UI packages configured |
| `lib/core/theme/app_theme.dart` | ✅ | Dark theme with neon cyan/magenta accents |
| `lib/core/constants/api_constants.dart` | ✅ | API endpoint configuration |
| `lib/services/api_client.dart` | ✅ | Modular HTTP client with health check |
| `lib/features/home/providers/` | ✅ | Riverpod state management |
| `lib/features/home/widgets/glass_card.dart` | ✅ | Glassmorphism cards |
| `lib/features/home/widgets/connection_status.dart` | ✅ | Animated status indicator |
| `lib/features/home/widgets/shield_logo.dart` | ✅ | Custom painted animated shield |
| `lib/features/home/home_screen.dart` | ✅ | Main cybersecurity home screen |
| `lib/main.dart` | ✅ | App entry point |

#### Infrastructure
| Component | Status | Description |
|-----------|--------|-------------|
| `docker-compose.yml` | ✅ | Full-stack orchestration |
| `CHANGELOG.md` | ✅ | Team progress tracking |

#### Git
- ✅ Pushed to `github.com/anandb71/FinShield`

---

## 📊 Progress Summary

```
Backend: ████████████████████ 100%
Frontend: ████████████████████ 100%
Integration: ██████████░░░░░░░░░░ 50%
```

---

## 🔜 Next Steps
1. Install backend dependencies (`pip install -e .`)
2. Test backend server (`python scripts/dev.py`)
3. Install Flutter dependencies (`flutter pub get`)
4. Run Flutter app (`flutter run`)
5. Verify frontend-backend connectivity

---

## 👥 Team Notes
- **State Management**: Using Riverpod (better async handling than Bloc for real-time audio)
- **Architecture**: Service layer is abstracted - swap Mock → Hotfoot/Backboard with one line change
- **Theme**: Cybersecurity aesthetic with glassmorphism + neon glow effects
# Changelog

All notable changes to the "Finsight: Autonomous Auditor" project will be documented in this file.

## [2.0.0] - 2026-02-09

### 🚀 Major Pivot: Forensic Knowledge Graph
- **Rebrand**: Renamed from "FinShield" to **"Finsight"**.
- **New Home**: Replaced list view with **Investigation Board** (Force-Directed Graph).
- **Core Feature**: **Multi-Document Reconciliation** (Invoice vs Bank Statement).

### ✨ New Features
- **Investigation Board**:
- Interactive Graph with Blue (Docs), Yellow (Entities), and Red (Risks) nodes.
- Conflict of Interest detection (Red edges).
- Time Slider for temporal filtering.
- **X-Ray Viewer v2**:
- **Reconciliation Tab**: Smart Match logic (Exact/Fuzzy) for payment verification.
- **Learning Loop**: Human-in-the-loop "Force Match" for model retraining.
- **Status Banners**: "PAYMENT VERIFIED" vs "GHOST INVOICE".
- **Backend**:
- `ConsistencyEngine`: Cross-document knowledge graph.
- `ReconciliationEngine`: Payment matching algorithm.

### � Fixes
- Fixed build errors in Graph View algorithm.
- Resolved dependency conflicts (lucide_icons).

---

*This file is updated with each major commit. Check git log for granular changes.*
## [1.0.0] - 2026-02-08 (Archived)
- Initial FinShield release (Text & Audio Intelligence).
116 changes: 33 additions & 83 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,103 +1,53 @@
# 🛡️ FinShield - The Financial Flight Recorder
# Finsight: Autonomous Auditor 🛡️

> **Autonomous, real-time defense system for mobile users that detects financial fraud during live calls and scans contracts for predatory clauses.**
> **The Forensic Knowledge Graph for Financial Intelligence.**
> *Formerly "FinShield"*

![License](https://img.shields.io/badge/license-MIT-blue.svg)
![Python](https://img.shields.io/badge/python-3.11+-green.svg)
![Flutter](https://img.shields.io/badge/flutter-3.16+-blue.svg)
![Finsight Banner](https://via.placeholder.com/1200x600.png?text=Finsight:+Forensic+Knowledge+Graph)

---

## 🎯 Mission

FinShield acts as your personal financial bodyguard:

- **📞 Call Shield**: Real-time analysis of phone calls to detect urgency manipulation, fear tactics, and pressure techniques used by scammers
- **📄 Contract Scanner**: Instant detection of predatory clauses, hidden fees, and exploitative terms in financial documents
- **🧠 Context Engine**: Cross-references audio patterns against document analysis for comprehensive threat assessment
Finsight is an autonomous auditing system that uses a **Forensic Knowledge Graph** to detect fraud, verify payments, and uncover hidden conflicts of interest across thousands of documents.

---

## 🏗️ Architecture
## 🚀 Key Features

```
FinShield/
├── backend/ # FastAPI Python service
│ ├── app/
│ │ ├── api/v1/ # Versioned REST endpoints
│ │ ├── services/ # AI service abstractions
│ │ └── core/ # Configuration & security
│ └── Dockerfile
│
├── frontend/ # Flutter mobile app
│ ├── lib/
│ │ ├── core/ # Theme, constants
│ │ ├── features/ # Feature modules
│ │ └── services/ # API clients
│ └── pubspec.yaml
│
└── docker-compose.yml
```
### 1. Investigation Board (The Graph)
No more lists. Visualize your financial network.
- **Interactive Graph**: Navigate Invoices (Blue), Vendors (Yellow), and Risks (Red).
- **Conflict Hunter**: Automatically detects shared addresses/phones between Vendors and Employees.
- **Time Travel**: Filter the graph timeline with a slider.

---
### 2. X-Ray Reconciliation
Verify if an invoice was *actually* paid.
- **Smart Match**: Auto-links Invoices to Bank Transactions (Exact & Fuzzy Matching).
- **Ghost Detection**: Flags "Ghost Invoices" (No payment found).
- **Human-in-the-Loop**: "Force Match" logic feeds the learning loop.

## 🚀 Quick Start
### 3. Visual Nervous System
- **Deep Document Understanding**: X-Ray overlays for Tables, Entities, and Anomalies.
- **Consistency Engine**: Checks historical patterns (e.g., "Invoice amount is 20% higher than average").

### Backend
---

```bash
cd backend
python -m venv .venv
.venv\Scripts\activate # Windows
pip install -e .
python scripts/dev.py
```
## 🛠️ Tech Stack
- **Frontend**: Flutter (GraphView, Animate_Do, Riverpod)
- **Design**: "Government-Grade" Dark Mode UI
- **Backend Logic**: Python (Consistency & Reconciliation Engines)

API available at: `http://localhost:8000`
---

### Frontend
## 🏃‍♂️ Quick Start

```bash
# Frontend
cd frontend
flutter pub get
flutter run
flutter run -d chrome
```

---

## 🔌 API Endpoints

| Endpoint | Method | Description |
|----------|--------|-------------|
| `/api/v1/health` | GET | Service health check |
| `/api/v1/analyze` | POST | Analyze audio/document for threats |

---

## 🧠 Core Intelligence Stack

| Component | Technology | Purpose |
|-----------|------------|---------|
| Audio Analysis | Hotfoot Audio | Real-time intent/urgency detection |
| Document Scanning | Hotfoot Docs | Entity & clause extraction |
| Context Engine | Backboard.io RAG | Cross-reference audio vs documents |

---

## 🎨 Design Philosophy

- **Dark Mode First**: Cyber-security aesthetic with neon accents
- **Privacy Focused**: All processing can run on-device
- **Modular AI**: Plug-and-play service abstractions

---

## 📜 License

MIT License - Built for protection, not profit.

---

<p align="center">
<strong>🛡️ Your Financial Guardian Angel 🛡️</strong>
</p>
## 📍 Roadmap
- [x] Phase 1: Audio Intelligence (Archived)
- [x] Phase 2: Document X-Ray
- [x] Phase 3: Forensic Knowledge Graph (Current)
- [ ] Phase 4: Automated Subpoena Generation