# skywalker0803r/vedanta architecture

> Architecture diagram of the GitHub repository skywalker0803r/vedanta, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/skywalker0803r/vedanta
- Repository: https://github.com/skywalker0803r/vedanta

## Overview

##### Project type & purpose
- This is a domain-specific, Python-based trading platform (“Vedanta”) that provides
- Offline backtesting of crypto strategies
- Visualization of results
- Online (real-time) auto-trading via Binance’s API
- It’s not a traditional web app; it’s a library + CLI + Jupyter UI that integrates data ingestion, strategy plugins, execution engines, and notification services.

##### High-level architectural components
A. Entry-Point / UI Layer
- Jupyter Notebooks (backtest_usage.ipynb, online_usage.ipynb)
- CLI scripts (run.py, turtle_run.py, vegas_run.py, telegram_message_bot_*.py)
B. Strategy Layer (Plugin Pattern)
- Technicalindicatorstrategy/*.py – each file implements a `generate_signals()` interface
C. Data Ingestion Layer
- CCXT wrapper inside Backtest/backtest.py for historical K-lines
- CCXT wrapper inside online/auto_trade*.py for real-time K-lines & order execution
D. Core Engines
1. Backtesting Engine (Backtest/backtest.py)
2. Online Trading Engine (online/auto_trade.py for spot; auto_trade_future.py for futures)
E. Visualization Layer
- Plot/plot.py – renders equity curves, price charts with positions, P&L distributions
F. Notification / Messaging
- Telegram bots (telegram_message_bot_turtle.py, telegram_message_bot_vegas.py)
G. External Services
- Binance API (via CCXT)
- Telegram API
H. Configuration & Environment
- . env or python-dotenv (via requirements.txt)
- API keys & strategy parameters loaded in run.py or notebooks

##### Key interactions & data flows
1) User invokes a notebook or run.py
2) Entry-Point loads a specific strategy from Technicalindicatorstrategy
3) Engine (backtest or online) requests K-line data from Binance via CCXT
4) Data + Strategy → Signal generator → buy/sell signals
5a) (Backtest) Simulate trades, compute metrics → pass results to Plot module → rendered charts back to UI
5b) (Online) Submit real orders to Binance, track fills, risk control → send notifications to Telegram

##### Architectural patterns & principles
- Strategy Pattern: decouple “what” (signal logic) from “when/where” (engine)
- Layered Design: clear separation of Ingestion → Strategy → Engine → Output
- Reuse & DRY: same strategy modules under both backtest & online engines
- Single Responsibility: each package (Backtest, Plot, online, strategies) focuses on one concern

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% UI / Entry-Point Layer
    subgraph "UI / Entry-Point"
        direction TB
        NB1["backtest_usage.ipynb"]:::ui
        NB2["online_usage.ipynb"]:::ui
        CLI1["run.py"]:::ui
        CLI2["turtle_run.py"]:::ui
        CLI3["vegas_run.py"]:::ui
    end

    %% Strategy Layer
    subgraph "Strategy Plugins"
        direction TB
        S1["sma.py"]:::strategy
        S2["macd.py"]:::strategy
        S3["SmoothedMACDStrategy.py"]:::strategy
        S4["WhaleSignal_WBTC.py"]:::strategy
        S5["turtle_strategy.py"]:::strategy
        S6["vegas.py"]:::strategy
    end

    %% Core Engines Layer
    subgraph "Core Engines"
        direction TB
        BE["Backtest Engine\n(Backtest/backtest.py)"]:::core
        OE1["Online Spot Engine\n(online/auto_trade.py)"]:::core
        OE2["Online Futures Engine\n(online/auto_trade_future.py)"]:::core
    end

    %% Visualization Layer
    subgraph "Visualization"
        direction TB
        PLOT["Plot Module\n(Plot/plot.py)"]:::viz
    end

    %% Notification / Messaging
    subgraph "Notification / Messaging"
        direction TB
        TBOT1["telegram_message_bot_turtle.py"]:::notif
        TBOT2["telegram_message_bot_vegas.py"]:::notif
    end

    %% External Services
    subgraph "External Services"
        direction TB
        BIN["Binance API\n(via CCXT)"]:::external
        TELAPI["Telegram API"]:::external
    end

    %% Config
    ENV["Configuration & Env\n(requirements.txt,\nAPI keys)"]:::ui

    %% Data Flows
    NB1 -->|"invoke Offline Backtest"| BE
    CLI1 -->|"invoke Engine"| BE
    NB2 -->|"invoke Online Trading"| OE1
    CLI2 -->|"invoke Engine"| OE1
    CLI3 -->|"invoke Engine"| OE1

    BE -->|"load Strategy"| S1
    BE -->|"load Strategy"| S2
    BE -->|"load Strategy"| S3
    BE -->|"load Strategy"| S4
    BE -->|"load Strategy"| S5
    BE -->|"load Strategy"| S6

    OE1 -->|"load Strategy"| S1
    OE1 -->|"load Strategy"| S2
    OE1 -->|"load Strategy"| S3
    OE1 -->|"load Strategy"| S4
    OE1 -->|"load Strategy"| S5
    OE1 -->|"load Strategy"| S6

    BE -->|"K-line fetch"| BIN
    OE1 -->|"K-line fetch"| BIN
    OE1 -->|"Order execution"| BIN

    BE -->|"Metrics & charts"| PLOT
    OE1 -.->|"send notifications"| TBOT1
    OE1 -.->|"send notifications"| TBOT2

    TBOT1 -->|"call API"| TELAPI
    TBOT2 -->|"call API"| TELAPI

    ENV --> NB1
    ENV --> NB2
    ENV --> CLI1
    ENV --> OE1
    ENV --> BE

    %% Click Events
    click NB1 "https://github.com/skywalker0803r/vedanta/blob/main/backtest_usage.ipynb"
    click NB2 "https://github.com/skywalker0803r/vedanta/blob/main/online_usage.ipynb"
    click CLI1 "https://github.com/skywalker0803r/vedanta/blob/main/run.py"
    click CLI2 "https://github.com/skywalker0803r/vedanta/blob/main/turtle_run.py"
    click CLI3 "https://github.com/skywalker0803r/vedanta/blob/main/vegas_run.py"
    click S1 "https://github.com/skywalker0803r/vedanta/blob/main/Technicalindicatorstrategy/sma.py"
    click S2 "https://github.com/skywalker0803r/vedanta/blob/main/Technicalindicatorstrategy/macd.py"
    click S3 "https://github.com/skywalker0803r/vedanta/blob/main/Technicalindicatorstrategy/SmoothedMACDStrategy.py"
    click S4 "https://github.com/skywalker0803r/vedanta/blob/main/Technicalindicatorstrategy/WhaleSignal_WBTC.py"
    click S5 "https://github.com/skywalker0803r/vedanta/blob/main/Technicalindicatorstrategy/turtle_strategy.py"
    click S6 "https://github.com/skywalker0803r/vedanta/blob/main/Technicalindicatorstrategy/vegas.py"
    click BE "https://github.com/skywalker0803r/vedanta/blob/main/Backtest/backtest.py"
    click OE1 "https://github.com/skywalker0803r/vedanta/blob/main/online/auto_trade.py"
    click OE2 "https://github.com/skywalker0803r/vedanta/blob/main/online/auto_trade_future.py"
    click PLOT "https://github.com/skywalker0803r/vedanta/blob/main/Plot/plot.py"
    click TBOT1 "https://github.com/skywalker0803r/vedanta/blob/main/telegram_message_bot_turtle.py"
    click TBOT2 "https://github.com/skywalker0803r/vedanta/blob/main/telegram_message_bot_vegas.py"
    click ENV "https://github.com/skywalker0803r/vedanta/blob/main/requirements.txt"

    %% Styles
    classDef ui fill:#fef3c7,stroke:#f59e0b,color:#92400e
    classDef strategy fill:#dcfce7,stroke:#22c55e,color:#166534
    classDef core fill:#dbeafe,stroke:#3b82f6,color:#1e40af
    classDef external fill:#e5e7eb,stroke:#6b7280,color:#374151
    classDef viz fill:#fde68a,stroke:#f97316,color:#7c2d12
    classDef notif fill:#ede9fe,stroke:#a78bfa,color:#5b21b6
```
