# affinidi/affinidi-did-resolver architecture

> Architecture diagram of the GitHub repository affinidi/affinidi-did-resolver, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/affinidi/affinidi-did-resolver
- Repository: https://github.com/affinidi/affinidi-did-resolver

## Overview

Key Components to Include:

##### Core Architecture Components
- DID Resolver Cache SDK
- DID Resolver Cache Server
- DID Resolver Methods
- External DID Networks/Services

##### Main System Relationships

A. SDK Layer:
- Networking module (request handling)
- Document caching system
- Resolver interface
- Configuration management
- Error handling system

B. Server Layer:
- HTTP and WebSocket handlers
- Session management
- Statistics collection
- Cache configuration
- Server core functionality

C. Methods Layer:
- DID method implementations (e.g., did-peer)
- Method-specific resolvers
- Custom implementations

- [Client Applications]
- ↓
- [SDK Layer (Local Cache)]
- ↓
- [Server Layer (Remote Cache)]
- ↓
- [DID Methods Layer]
- ↓
- [External DID Networks]

##### Component Relationships
- Bidirectional communication where applicable

##### Specific Elements

a. SDK Components:
- [Configuration Manager] → [Resolver Interface]
- ↓
- [Document Cache] ← → [Networking Module]
- ↓
- [Request Queue] → [Error Handler]

b. Server Components:
- [HTTP Handler] → [Session Manager]
- [WebSocket Handler] → [Cache Controller]
- ↓
- [Statistics Collector] ← [Server Core]

c. Method Implementation:
- [Method Registry]
- ↓
- [Individual Method Implementations]
- ↓
- [External DID Networks]

##### Additional Details
- Configuration nodes showing TOML file inputs
- Error handling paths
- Cache invalidation flows
- Scaling points
- Security boundaries

##### Integration Points
- Client application entry points
- External service connections
- Plugin/extension points

Remember to:
- Keep the main flow clear and centered
- Related components visually
- Notes for important configuration options
- Version compatibility where relevant
- Security boundaries and authentication points

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Style definitions
    classDef core fill:#b3d1ff,stroke:#333,stroke-width:2px
    classDef interface fill:#90EE90,stroke:#333,stroke-width:2px
    classDef cache fill:#FFE5B4,stroke:#333,stroke-width:2px
    classDef method fill:#DDA0DD,stroke:#333,stroke-width:2px
    classDef external fill:#D3D3D3,stroke:#333,stroke-width:2px
    classDef error fill:#FFB6C1,stroke:#333,stroke-width:2px

    %% Client Applications Layer
    subgraph ClientApps
        CA[Client Applications]
    end

    %% SDK Layer
    subgraph SDKLayer
        SDKC[SDK Core]:::core
        CM[Configuration Manager]:::core
        RI[Resolver Interface]:::interface
        DC[Document Cache]:::cache
        NM[Networking Module]:::core
        RQ[Request Queue]:::core
        EH[Error Handler]:::error
    end

    %% Server Layer
    subgraph ServerLayer
        SC[Server Core]:::core
        HH[HTTP Handler]:::interface
        WH[WebSocket Handler]:::interface
        SM[Session Manager]:::core
        CC[Cache Controller]:::cache
        ST[Statistics Collector]:::core
        SE[Server Error Handler]:::error
    end

    %% Methods Layer
    subgraph MethodsLayer
        MC[Methods Core]:::method
        DPI["DID Peer Implementation"]:::method
        MR[Method Registry]:::method
    end

    %% External Layer
    subgraph ExternalLayer
        EN[External DID Networks]:::external
    end

    %% Relationships
    CA --> SDKC
    SDKC --> CM
    CM --> RI
    RI --> DC
    DC <--> NM
    NM --> RQ
    RQ --> EH
    
    SDKC --> SC
    SC --> HH & WH
    HH & WH --> SM
    SM --> CC
    CC --> ST
    SC --> SE
    
    SC --> MC
    MC --> MR
    MR --> DPI
    DPI --> EN

    %% Click events
    click SDKC "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-sdk/src/lib.rs"
    click NM "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-sdk/src/networking/network.rs"
    click RQ "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-sdk/src/networking/request_queue.rs"
    click DC "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-sdk/src/document.rs"
    click CM "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-sdk/src/config.rs"
    click EH "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-sdk/src/errors.rs"
    click RI "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-sdk/src/resolver/mod.rs"
    
    click SC "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-server/src/server.rs"
    click HH "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-server/src/handlers/http.rs"
    click WH "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-server/src/handlers/websocket.rs"
    click SM "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-server/src/session.rs"
    click ST "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-server/src/statistics.rs"
    click CC "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-server/src/config.rs"
    click SE "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-cache-server/src/errors.rs"
    
    click MC "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-methods/src/lib.rs"
    click DPI "https://github.com/affinidi/affinidi-did-resolver/blob/main/affinidi-did-resolver-methods/did-peer/src/lib.rs"

    %% Legend
    subgraph Legend
        L1[Core Components]:::core
        L2[Interfaces]:::interface
        L3[Cache Components]:::cache
        L4[Method Components]:::method
        L5[External Systems]:::external
        L6[Error Handling]:::error
    end
```
