# jammy928/coinexchange_cryptoexchange_java architecture

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

- Interactive diagram: https://gitdiagram.com/jammy928/coinexchange_cryptoexchange_java
- Repository: https://github.com/jammy928/coinexchange_cryptoexchange_java

## Overview

##### Project type and purpose
- This is a full-stack, Spring-Cloud-based microservice cryptocurrency exchange platform.
- It consists of multiple backend services (matching engine, market data, user center, OTC, chat, wallet, admin API), two Vue.js front-ends (trading UI & admin console), native mobile apps (Android/iOS, not open-source), and wallet RPC modules for various blockchains.

##### File structure
- 00_framework (core microservices):
- cloud – Eureka service registry
- admin – admin back-end API
- exchange – in-memory matching engine
- exchange-api & exchange-core – REST API and domain logic for orders
- market – market data service (K-line, depth, push)
- ucenter-api – user management API
- otc-api & otc-core – OTC trading API & logic
- chat – real-time chat (Netty + WebSocket)
- wallet – internal wallet microservice (finance, Kafka consumers)
- core – shared DTOs, entities, DAO, common config
- sql – SQL scripts and triggers
- 01_wallet_rpc – dozens of coin-specific RPC microservices (bitcoin, eth, erc-20, etc.) each exposing a REST/gRPC endpoint, invoking blockchain nodes or third-party explorers.
- 04_Web_Admin – Vue.js admin console (connects to admin API).
- 05_Web_Front – Vue.js trading UI (connects to exchange-api, ucenter‐api, otc-api, wallet).
- 02_App_Android & 03_APP_IOS – native mobile clients.

##### README insights
- Microservice architecture (Spring Cloud).
- Service discovery (Eureka).
- Message bus (Kafka) for decoupled events: order matching → market persistence → market push.
- Datastores: MySQL for relational data, MongoDB for order details & market persistence, Redis for cache & sessions.
- External dependencies: Alibaba OSS, Tencent Captcha.
- Wallet RPC services for on-chain transactions.

- Clients: Web Front-End, Web Admin, Mobile Apps
- API Gateway / Load Balancer (optional if in use)
- Service Discovery (Eureka)
- Microservices: Admin, Exchange-API, Exchange Core, Exchange (matching engine), Market, UCenter, OTC API, Chat, Wallet
- Wallet RPC Cluster (multiple coin services)
- Messaging Layer (Kafka cluster)
- Databases/Caches: MySQL, MongoDB, Redis
- External Services: Blockchain nodes / explorers, OSS, Captcha, Email/SMS gateways
b. Relationships & data flows:
- Clients → API Gateway → relevant microservice (e.g., trading UI → Exchange-API; admin UI → Admin service)
- Microservices register with Eureka (cloud).
- Exchange-API forwards orders to Exchange (matching engine).
- Exchange publishes match events to Kafka → Market service consumes to persist trades and generate K-lines → push via WebSocket or HTTP to clients.
- Chat service uses WebSocket & Netty, persists history in MongoDB.
- UCenter handles user/account actions, writes to MySQL, caches sessions in Redis.
- OTC API uses Kafka for asynchronous tasks (order checking, settlement).
- Wallet microservice and wallet-rpc services listen to Kafka/deposit events, call blockchain RPCs and persist deposit/withdraw records in MongoDB/MySQL, then publish events back onto Kafka.
c. Architectural patterns & design principles:
- Microservices with single responsibility, discoverable via Eureka
- Event-driven asynchronous communication (Kafka topics for orders, trades, deposits)
- Shared core library for common entities/DAOs (promotes code reuse)
- Domain-driven: separate modules for Exchange domain, Market domain, OTC, UCenter, Wallet
- CQRS-style separation: Exchange engine (write), Market service (read & BI)
d. Key technologies:
- Java 8, Spring Boot, Spring Cloud (Eureka, Config, Zuul? if used)
- Spring Data JPA (MySQL), Spring Data MongoDB, Redis (Spring Cache/Shiro session store)
- Kafka (Spring Kafka)
- Netty & WebSocket for chat & market push
- Vue.js + iView + Less for front-ends
- REST controllers for APIs

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients Layer
    subgraph "Clients" 
        direction TB
        WebAdmin["Web Admin Front-End"]:::client
        WebFront["Trading Front-End"]:::client
        AndroidApp["Android Mobile App"]:::client
        iOSApp["iOS Mobile App"]:::client
    end

    %% API & Discovery Layer
    subgraph "API & Discovery"
        direction TB
        Eureka["Eureka Service Registry"]:::discovery
    end

    %% Core Microservices Layer
    subgraph "Core Microservices"
        direction TB
        AdminAPI["Admin Back-end API"]:::service
        ExchangeAPI["Exchange REST API"]:::service
        ExchangeCore["Exchange Domain Logic (CQRS Core)"]:::service
        MatchingEngine["Matching Engine"]:::service
        MarketService["Market Data Service"]:::service
        UCenterAPI["User Center API"]:::service
        OTCAPI["OTC Trading API"]:::service
        OTCCore["OTC Domain Logic Core"]:::service
        ChatService["Real-time Chat Service"]:::service
        WalletService["Internal Wallet Microservice"]:::service
    end

    %% Wallet RPC Cluster
    subgraph "Wallet RPC Services Cluster"
        direction TB
        WalletRPCCluster["Wallet RPC Cluster"]:::service
    end

    %% Messaging Layer
    subgraph "Messaging"
        direction TB
        Kafka["Kafka Cluster"]:::message
    end

    %% Persistence Layer
    subgraph "Databases & Caches"
        direction TB
        MySQL["MySQL"]:::db
        MongoDB["MongoDB"]:::db
        Redis["Redis"]:::db
    end

    %% External Dependencies
    subgraph "External Services"
        direction TB
        BlockchainNodes["Blockchain Nodes / Explorers"]:::external
        OSS["Alibaba OSS"]:::external
        Captcha["Tencent Captcha"]:::external
        EmailSMS["Email/SMS Gateway"]:::external
    end

    %% Client to API calls
    WebFront -->|"POST /order"| ExchangeAPI
    WebFront -->|"GET /market-data"| MarketService
    WebFront -->|"GET /user-info"| UCenterAPI
    WebFront -->|"POST /otc-order"| OTCAPI
    WebFront -->|"GET /wallet-balance"| WalletService

    WebAdmin -->|"UI Calls"| AdminAPI
    AndroidApp -->|"Mobile API Calls"| ExchangeAPI
    AndroidApp -->|"Mobile API Calls"| UCenterAPI
    AndroidApp -->|"Mobile API Calls"| OTCAPI
    AndroidApp -->|"Mobile API Calls"| WalletService
    iOSApp -->|"Mobile API Calls"| ExchangeAPI
    iOSApp -->|"Mobile API Calls"| UCenterAPI
    iOSApp -->|"Mobile API Calls"| OTCAPI
    iOSApp -->|"Mobile API Calls"| WalletService

    %% Service Discovery
    AdminAPI -->|registers| Eureka
    ExchangeAPI -->|registers| Eureka
    ExchangeCore -->|registers| Eureka
    MatchingEngine -->|registers| Eureka
    MarketService -->|registers| Eureka
    UCenterAPI -->|registers| Eureka
    OTCAPI -->|registers| Eureka
    OTCCore -->|registers| Eureka
    ChatService -->|registers| Eureka
    WalletService -->|registers| Eureka
    WalletRPCCluster -->|registers| Eureka

    %% Exchange Flow
    ExchangeAPI -->|"forward order"| MatchingEngine
    MatchingEngine -->|"Kafka: trade-topic"| Kafka
    Kafka -->|"consume trade-topic"| MarketService
    MarketService -->|"persist trades"| MongoDB
    MarketService -->|"WebSocket Push"| WebFront

    %% Chat Flow
    ChatService -->|"persist chat"| MongoDB

    %% UCenter Persistence
    UCenterAPI -->|"write/read"| MySQL
    UCenterAPI -->|"cache sessions"| Redis

    %% OTC Flow
    OTCAPI -->|"Kafka: otc-topic"| Kafka
    Kafka -->|"consume otc-topic"| OTCCore

    %% Wallet Flow
    WalletService -->|"Kafka: deposit-topic"| Kafka
    Kafka -->|"consume deposit-topic"| WalletService
    WalletService -->|"invoke RPC"| WalletRPCCluster
    WalletRPCCluster -->|"call on-chain"| BlockchainNodes
    WalletRPCCluster -->|"persist tx"| MongoDB
    WalletRPCCluster -->|"Kafka: withdraw-topic"| Kafka

    %% External Integrations
    OSS -->|used by| AdminAPI
    Captcha -->|used by| UCenterAPI
    EmailSMS -->|used by| UCenterAPI

    %% Click Events
    click WebAdmin "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/04_Web_Admin"
    click WebFront "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/05_Web_Front"
    click AndroidApp "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/02_App_Android"
    click iOSApp "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/03_APP_IOS"
    click Eureka "https://github.com/jammy928/coinexchange_cryptoexchange_java/blob/master/00_framework/cloud/src/main/java/com/bizzan/bitrade/CloudApplication.java"
    click AdminAPI "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/admin"
    click MatchingEngine "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/exchange"
    click ExchangeAPI "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/exchange-api"
    click ExchangeCore "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/exchange-core"
    click MarketService "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/market"
    click UCenterAPI "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/ucenter-api"
    click OTCAPI "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/otc-api"
    click OTCCore "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/otc-core"
    click ChatService "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/chat"
    click WalletService "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/wallet"
    click WalletRPCCluster "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/01_wallet_rpc"
    click SQL "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/sql"
    click CoreLib "https://github.com/jammy928/coinexchange_cryptoexchange_java/tree/master/00_framework/core"
    click Pom "https://github.com/jammy928/coinexchange_cryptoexchange_java/blob/master/00_framework/pom.xml"

    %% Styles
    classDef client fill:#D6EAF8,stroke:#2980B9,color:#1B4F72;
    classDef service fill:#E8F8F5,stroke:#1ABC9C,color:#117A65;
    classDef db fill:#FCF3CF,stroke:#F1C40F,color:#7D6608;
    classDef message fill:#E8DAEF,stroke:#8E44AD,color:#512E5F;
    classDef discovery fill:#FDEDEC,stroke:#E74C3C,color:#641E16;
    classDef external fill:#FDEBD0,stroke:#D35400,color:#7E5109;
```
