# relaystr/ndk architecture

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

- Interactive diagram: https://gitdiagram.com/relaystr/ndk
- Repository: https://github.com/relaystr/ndk

## Overview

##### High-Level Architecture Overview

**┌─ NDK Core ─────────────────────────────────────────┐**

- ┌─ Domain Layer ─┐  ┌─ Data Layer ──┐            │

- Use Cases    │◄─►│  Repositories │            │
- Entities     │  │  Data Sources │            │
- ┘  └───────────────┘            │

- ┘

**┌─ Implementation Packages ───────────────────────────┐**

- ┌─ Amber ─────┐  ┌─ Storage ────┐  ┌─ Rust ────┐ │
- ObjectBox  │  │           │ │
- Signer     │  │  - Isar      │  │ Verifier  │ │
- ┘  └─────────────┘   └───────────┘ │

- ┘

##### Detailed Component Breakdown

a. Domain Layer:
**┌─ Domain Layer ──────────────────────────────────┐**

- ┌─ Entities ───┐   ┌─ Use Cases ────────────┐ │
- Events     │   │ - Broadcast            │ │
- Metadata   │   │ - Cache Read/Write     │ │
- Filters    │   │ - JIT Engine          │ │
- Relays     │   │ - Metadata Management │ │
- ┘   └────────────────────────┘ │

- ┌─ Repositories (Interfaces) ───────────────┐ │
- EventSigner                            │ │
- EventVerifier                          │ │
- CacheManager                           │ │
- NostrTransport                         │ │
- ┘ │
- ┘

b. Data Layer:
**┌─ Data Layer ───────────────────────────────────┐**

- ┌─ Data Sources ─┐   ┌─ Repositories ───────┐ │
- WebSocket    │   │ - WebSocketTransport │ │
- HTTP Request │   │ - MemCacheManager    │ │
- ┘   └───────────────────────┘ │

- ┌─ Implementation Bridges ──────────────────┐ │
- Amber Signer                           │ │
- Rust Verifier                          │ │
- ObjectBox/Isar Storage                 │ │
- ┘ │
- ┘

##### Implementation Details

- Database implementations:
**┌─ Storage Implementations ─────────────────────┐**

- ┌─ ObjectBox ──┐    ┌─ Isar ─────────────┐ │
- DB Schema    │    │ DB Schema          │ │
- Cache Manager│    │ Cache Manager      │ │
- ┘    └──────────────────────┘ │
- ┘

##### Deployment View

**┌─ Application Integration ──────────────────────┐**

- ┌─ Flutter App ─┐                            │

- NDK Core     │──► Nostr Network          │
- Storage      │                           │
- Signer       │                           │
- ┘                           │
- ┘

Remember to:
- Use consistent notation throughout
- Clear boundaries between components
- Both synchronous and asynchronous interactions
- Document any important architectural decisions

This structure reflects the project's clean architecture approach while showing how the different packages interact to provide a complete Nostr development solution.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph NDK["NDK Core"]
        subgraph DL["Domain Layer"]
            Entities["Entities"]
            UseCases["Use Cases"]
            RepoInterfaces["Repository Interfaces"]
            
            subgraph Entities
                Events["Events"]
                Metadata["Metadata"]
                Filters["Filters"]
                Relays["Relays"]
            end
            
            subgraph UseCases
                Broadcast["Broadcast"]
                CacheOps["Cache Read/Write"]
                JITEngine["JIT Engine"]
                MetadataMgmt["Metadata Management"]
            end
            
            subgraph RepoInterfaces
                EventSigner["Event Signer"]
                EventVerifier["Event Verifier"]
                CacheManager["Cache Manager"]
                NostrTransport["Nostr Transport"]
            end
        end
        
        subgraph DataL["Data Layer"]
            DataSources["Data Sources"]
            Repositories["Repositories"]
            
            subgraph DataSources
                WebSocket["WebSocket"]
                HTTPRequest["HTTP Request"]
            end
            
            subgraph Repositories
                WSTransport["WebSocket Transport"]
                MemCache["Memory Cache Manager"]
            end
        end
    end
    
    subgraph Impl["Implementation Packages"]
        subgraph Amber
            AmberSigner["Amber Signer"]
        end
        
        subgraph Storage
            subgraph ObjectBox
                OBSchema["ObjectBox Schema"]
                OBCache["ObjectBox Cache"]
            end
            
            subgraph Isar
                IsarSchema["Isar Schema"]
                IsarCache["Isar Cache"]
            end
        end
        
        subgraph Rust
            RustVerifier["Rust Verifier"]
        end
    end
    
    %% Relationships
    DL --> DataL
    DataSources --> Repositories
    RepoInterfaces --> DataL
    Impl --> NDK
    
    %% Click events
    click Entities "https://github.com/relaystr/ndk/tree/master/packages/ndk/lib/domain_layer/entities/"
    click UseCases "https://github.com/relaystr/ndk/tree/master/packages/ndk/lib/domain_layer/usecases/"
    click RepoInterfaces "https://github.com/relaystr/ndk/tree/master/packages/ndk/lib/domain_layer/repositories/"
    click DataSources "https://github.com/relaystr/ndk/tree/master/packages/ndk/lib/data_layer/data_sources/"
    click Repositories "https://github.com/relaystr/ndk/tree/master/packages/ndk/lib/data_layer/repositories/"
    click WebSocket "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/data_layer/data_sources/websocket.dart"
    click HTTPRequest "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/data_layer/data_sources/http_request.dart"
    click AmberSigner "https://github.com/relaystr/ndk/blob/master/packages/amber/lib/data_layer/repositories/signers/amber_event_signer.dart"
    click RustVerifier "https://github.com/relaystr/ndk/blob/master/packages/rust_verifier/lib/data_layer/repositories/verifiers/rust_event_verifier.dart"
    click IsarCache "https://github.com/relaystr/ndk/blob/master/packages/isar/lib/data_layer/repositories/cache_manager/isar_cache_manager.dart"
    click OBCache "https://github.com/relaystr/ndk/blob/master/packages/objectbox/lib/data_layer/db/object_box/db_object_box.dart"
    click JITEngine "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/domain_layer/usecases/jit_engine/jit_engine.dart"
    click CacheOps "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/domain_layer/usecases/cache_read/cache_read.dart"
    click Broadcast "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/domain_layer/usecases/broadcast/broadcast.dart"
    click MetadataMgmt "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/domain_layer/usecases/metadatas/metadatas.dart"
    click WSTransport "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/data_layer/repositories/nostr_transport/websocket_nostr_transport.dart"
    click NostrTransport "https://github.com/relaystr/ndk/blob/master/packages/ndk/lib/domain_layer/repositories/nostr_transport.dart"

    %% Styling
    classDef core fill:#e1f5fe,stroke:#01579b
    classDef domain fill:#e8f5e9,stroke:#2e7d32
    classDef data fill:#fff3e0,stroke:#ef6c00
    classDef impl fill:#f3e5f5,stroke:#7b1fa2
    
    class NDK core
    class DL,Entities,UseCases,RepoInterfaces domain
    class DataL,DataSources,Repositories data
    class Impl,Amber,Storage,Rust impl
    
    %% Legend
    subgraph Legend
        CoreL["Core Components"]:::core
        DomainL["Domain Layer"]:::domain
        DataLL["Data Layer"]:::data
        ImplL["Implementation"]:::impl
    end
```
