# concordium/concordium-misc-tools architecture

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

- Interactive diagram: https://gitdiagram.com/concordium/concordium-misc-tools
- Repository: https://github.com/concordium/concordium-misc-tools

## Overview

##### Project Type and Purpose
- This is a monorepo (“Collection of miscellaneous tools”) containing a set of small, mostly independent command-line applications and light services, each written in Rust (with a few having light front-ends).
- The primary tools listed in the root README are:
- wallet-proxy-load-simulator
- state-compare
- genesis-creator
- kpi-tracker
- Additional utilities/services (not yet listed in root README) include chain-prometheus-exporter, company-id-gui (Tauri/React desktop app), id-verifier (Rust backend + JS frontend), notification-server, recover-id-object, generator, wallet-connect-test-bench, and common Rust SDKs under deps/.

##### High-Level Architecture
- There is no single “all-in-one” runtime. Instead each tool is a standalone binary (or binary + front end).
- Shared code lives under deps/ (git-submodules for concordium-dapp-libraries and concordium-rust-sdk).
- Each tool may interact with external systems such as:
- A Concordium blockchain node (via its JSON RPC API)
- Wallet-proxy service (for load simulation)
- PostgreSQL database (kpi-tracker) + Grafana (for metrics)
- File system (reading/writing genesis files or WASM artifacts)
- External cloud APIs (notification-server to Google Cloud, etc.)

##### Main Components
- **Shared Libraries** (deps/)
- wallet-proxy-load-simulator
- state-compare
- genesis-creator
- kpi-tracker
- chain-prometheus-exporter
- notification-server (with API & service binaries)
- recover-id-object
- id-verifier (Rust backend & JS/ESBuild frontend)
- company-id-gui (Tauri/Rust & React TypeScript)
- generator
- wallet-connect-test-bench (smart-contract lib & front-end)
- **External Services**:
- Concordium Node (RPC endpoint)
- Wallet-proxy API
- PostgreSQL DB
- Grafana UI
- Google Cloud Pub/Sub (or equivalent)
- Filesystem / S3 / local resource files

##### Relationships and Data Flows
- wallet-proxy-load-simulator → Wallet-proxy API
- state-compare → Concordium Node RPC (pull block states)
- genesis-creator → Local FS / resource files → Outputs genesis TOML
- kpi-tracker → Node RPC → PostgreSQL → Grafana
- chain-prometheus-exporter → Node RPC → Prometheus endpoint
- notification-server → HTTP clients (API) → DB → Google Cloud
- id-verifier frontend ↔ id-verifier Rust backend → Node RPC
- company-id-gui (Tauri) ↔ local Rust core → Node RPC / Wallet-proxy
- wallet-connect-test-bench front-end ↔ smart-contract lib → Node RPC
- Shared deps/ as a library layer that all Rust binaries link against.

##### Architectural Patterns & Principles
- Microservice / Polyglot CLI pattern: each tool is its own deployable unit.
- Clear separation of concerns:
- CLI tools focus on a single responsibility (load simulation, state diff, genesis file generation).
- Services with persistent state (kpi-tracker, notification-server) encapsulate API, database, and external integration.
- Reuse of common SDKs (concordium-rust-sdk) via Git submodules.

##### Detail Level
- For each tool, capture only its key external interactions—no need to show internal module structure.
- For services like kpi-tracker and notification-server, show sub-components if helpful:
- API layer vs Processor vs Database
- Every component from the file tree (especially any crate with a Cargo.toml at top level) is on the map.

## Diagram (Mermaid)

```mermaid
graph TD
    %% Shared Libraries
    subgraph "Shared Libraries"
        DappLibs["concordium-dapp-libraries"]:::shared
        RustSDK["concordium-rust-sdk"]:::shared
    end

    %% CLI Tools
    subgraph "Tools" 
        WalletSim["wallet-proxy-load-simulator"]:::cli
        StateCompare["state-compare"]:::cli
        GenesisCreator["genesis-creator"]:::cli
        RecoverId["recover-id-object"]:::cli
        Generator["generator"]:::cli
        SC_Lib["wallet-connect-test-bench smart-contract lib"]:::cli
    end

    %% Services
    subgraph "Services"
        KPITracker["kpi-tracker"]:::service
        ChainExporter["chain-prometheus-exporter"]:::service
        NotificationAPI["notification-server API"]:::service
        NotificationSvc["notification-server Processor"]:::service
        IdVerifierBE["id-verifier Rust backend"]:::service
        CompanyIDBE["company-id-gui Rust core"]:::service
    end

    %% Front-end UIs
    subgraph "Frontends"
        IdVerifierFE["id-verifier JS frontend"]:::frontend
        CompanyIDFE["company-id-gui React UI"]:::frontend
        WCTBFE["wallet-connect-test-bench front-end"]:::frontend
    end

    %% External Systems
    subgraph "External Systems"
        Node["Concordium Node (JSON-RPC)"]:::external
        WalletProxyAPI["Wallet-proxy API"]:::external
        Postgres["PostgreSQL"]:::external
        Grafana["Grafana UI"]:::external
        Prometheus["Prometheus endpoint"]:::external
        GoogleCloud["Google Cloud Pub/Sub"]:::external
        FS["Filesystem / S3"]:::external
    end

    %% Dependencies
    WalletSim -->|links against| DappLibs
    WalletSim -->|links against| RustSDK
    StateCompare -->|links against| DappLibs
    StateCompare -->|links against| RustSDK
    GenesisCreator -->|links against| RustSDK
    RecoverId -->|links against| RustSDK
    Generator -->|links against| RustSDK
    SC_Lib -->|links against| RustSDK

    KPITracker -->|links against| RustSDK
    ChainExporter -->|links against| RustSDK
    NotificationAPI -->|links against| RustSDK
    NotificationSvc -->|links against| RustSDK
    IdVerifierBE -->|links against| RustSDK
    CompanyIDBE -->|links against| RustSDK

    %% Tool interactions
    WalletSim -->|HTTP/REST| WalletProxyAPI
    StateCompare -->|JSON-RPC| Node
    GenesisCreator -->|writes| FS
    RecoverId -->|JSON-RPC| Node
    Generator -->|reads WASM| FS

    %% Service interactions
    KPITracker -->|JSON-RPC| Node
    KPITracker -->|SQL| Postgres
    KPITracker -->|metrics| Grafana

    ChainExporter -->|JSON-RPC| Node
    ChainExporter -->|exposes| Prometheus

    NotificationAPI -->|HTTP clients| NotificationSvc
    NotificationSvc -->|SQL| Postgres
    NotificationSvc -->|publishes| GoogleCloud

    %% Frontend interactions
    IdVerifierFE ---|HTTP| IdVerifierBE
    IdVerifierBE -->|JSON-RPC| Node

    CompanyIDFE ---|IPC| CompanyIDBE
    CompanyIDBE -->|JSON-RPC| Node
    CompanyIDBE -->|HTTP/REST| WalletProxyAPI

    WCTBFE ---|API| SC_Lib
    SC_Lib -->|JSON-RPC| Node

    %% Shared deps usage
    class DappLibs,RustSDK shared
    class WalletSim,StateCompare,GenesisCreator,RecoverId,Generator,SC_Lib cli
    class KPITracker,ChainExporter,NotificationAPI,NotificationSvc,IdVerifierBE,CompanyIDBE service
    class IdVerifierFE,CompanyIDFE,WCTBFE frontend
    class Node,WalletProxyAPI,Postgres,Grafana,Prometheus,GoogleCloud,FS external

    %% Click Events
    click DappLibs "https://github.com/concordium/concordium-misc-tools/tree/main/deps/concordium-dapp-libraries"
    click RustSDK "https://github.com/concordium/concordium-misc-tools/tree/main/deps/concordium-rust-sdk"
    click WalletSim "https://github.com/concordium/concordium-misc-tools/blob/main/wallet-proxy-load-simulator/src/main.rs"
    click StateCompare "https://github.com/concordium/concordium-misc-tools/blob/main/state-compare/src/main.rs"
    click GenesisCreator "https://github.com/concordium/concordium-misc-tools/blob/main/genesis-creator/src/main.rs"
    click KPITracker "https://github.com/concordium/concordium-misc-tools/blob/main/kpi-tracker/src/main.rs"
    click ChainExporter "https://github.com/concordium/concordium-misc-tools/blob/main/chain-prometheus-exporter/src/main.rs"
    click NotificationAPI "https://github.com/concordium/concordium-misc-tools/blob/main/notification-server/src/bin/api.rs"
    click NotificationSvc "https://github.com/concordium/concordium-misc-tools/blob/main/notification-server/src/bin/service.rs"
    click RecoverId "https://github.com/concordium/concordium-misc-tools/blob/main/recover-id-object/src/main.rs"
    click IdVerifierBE "https://github.com/concordium/concordium-misc-tools/blob/main/id-verifier/src/main.rs"
    click IdVerifierFE "https://github.com/concordium/concordium-misc-tools/tree/main/id-verifier/frontend/"
    click CompanyIDBE "https://github.com/concordium/concordium-misc-tools/blob/main/company-id-gui/src-tauri/src/main.rs"
    click CompanyIDFE "https://github.com/concordium/concordium-misc-tools/tree/main/company-id-gui/src/"
    click Generator "https://github.com/concordium/concordium-misc-tools/blob/main/generator/src/main.rs"
    click SC_Lib "https://github.com/concordium/concordium-misc-tools/blob/main/wallet-connect-test-bench/smart-contract/src/lib.rs"
    click WCTBFE "https://github.com/concordium/concordium-misc-tools/tree/main/wallet-connect-test-bench/front-end/"

    %% Styles
    classDef cli fill:#aaf,stroke:#000
    classDef service fill:#afa,stroke:#000
    classDef frontend fill:#faa,stroke:#000
    classDef shared fill:#ddd,stroke:#000
    classDef external stroke-dasharray: 5 5,stroke:#333,fill:none
```
