Skip to content

diagram.md

Latest commit

 

History

History
135 lines (111 loc) · 5.52 KB

diagram.md

File metadata and controls

135 lines (111 loc) · 5.52 KB
Raw

Gateway Diagrams

Flow Chart

graph LR
    subgraph "dRPC ecosystem"
        A[dRPC Client] <-- HTTP/gRPC/cRPC --> B(Listener)
        A <-- libp2p --> E([Host libp2p Peer])
        B <-- HTTP --> D[Gateway Handler]
        E <----> F((dRPC Handler))
        B <-- libp2p --> E
        A <-- libp2p --> M
    end

    M([Relay libp2p Peer])
    D <-- libp2p --> M
    M <-- libp2p --> E

    subgraph "Clients"
        C[HTTP Client] <-- HTTP --> B
        G[gRPC Client] <-- gRPC --> B
        H[ConnectRPC Client] <-- cRPC --> B
    end
Loading

Communication paths for dRPC client

Here are the possible communication paths from "dRPC Client" to "dRPC Handler":

  1. dRPC Client -> Listener -> Gateway Handler -> Host libp2p Peer -> dRPC Handler
  2. dRPC Client -> Listener -> Gateway Handler -> Relay libp2p Peer -> Host libp2p Peer -> dRPC Handler
  3. dRPC Client -> Host libp2p Peer -> dRPC Handler
  4. dRPC Client -> Relay libp2p Peer -> Host libp2p Peer -> dRPC Handler

Sequence Diagram

sequenceDiagram
    participant DRPCClient as dRPC Client
    participant Listener as Listener (HTTP/gRPC/cRPC)
    participant GatewayHandler as Gateway Handler
    participant HostLibp2pPeer as Host libp2p Peer
    participant RelayLibp2pPeer as Relay libp2p Peer
    participant dRPCHandler as dRPC Handler
    participant HTTPClient as HTTP Client

    alt dRPC Client (HTTP)
        DRPCClient->>Listener: HTTP Request
        activate Listener
        Listener->>GatewayHandler: Request
        activate GatewayHandler
        GatewayHandler->>RelayLibp2pPeer: Request (via Host libp2p Peer)
        activate RelayLibp2pPeer
        RelayLibp2pPeer->>HostLibp2pPeer: Request
        activate HostLibp2pPeer
        HostLibp2pPeer->>dRPCHandler: Request
        activate dRPCHandler
        dRPCHandler-->>HostLibp2pPeer: Response
        HostLibp2pPeer-->>RelayLibp2pPeer: Response
        RelayLibp2pPeer-->>GatewayHandler: Response
        GatewayHandler-->>Listener: Response
        Listener-->>DRPCClient: HTTP Response
    end

    alt dRPC Client (libp2p)
        DRPCClient->>HostLibp2pPeer: Request
        activate HostLibp2pPeer
        HostLibp2pPeer->>RelayLibp2pPeer: Request
        activate RelayLibp2pPeer
        RelayLibp2pPeer->>HostLibp2pPeer: Request
        HostLibp2pPeer->>dRPCHandler: Request
        activate dRPCHandler
        dRPCHandler-->>HostLibp2pPeer: Response
        HostLibp2pPeer-->>RelayLibp2pPeer: Response
        RelayLibp2pPeer-->>HostLibp2pPeer: Response
        HostLibp2pPeer-->>DRPCClient: Response
    end

    alt HTTP Client
        HTTPClient->>Listener: HTTP Request
        activate Listener
        Listener->>GatewayHandler: Request
        activate GatewayHandler
        GatewayHandler->>RelayLibp2pPeer: Request (via Host libp2p Peer)
        activate RelayLibp2pPeer
        RelayLibp2pPeer->>HostLibp2pPeer: Request
        activate HostLibp2pPeer
        HostLibp2pPeer->>dRPCHandler: Request
        activate dRPCHandler
        dRPCHandler-->>HostLibp2pPeer: Response
        HostLibp2pPeer-->>RelayLibp2pPeer: Response
        RelayLibp2pPeer-->>GatewayHandler: Response
        GatewayHandler-->>Listener: Response
        Listener-->>HTTPClient: HTTP Response
    end
Loading

Description

The diagrams above illustrate the request flow in dRPC. There are multiple entry points for clients:

  1. dRPC Client: This client is specifically designed to work with the dRPC library. It can connect via:

    • HTTP, gRPC, or ConnectRPC: The dRPC client can send requests to the Listener using any of these protocols.
    • libp2p Multiaddresses: The dRPC client can directly connect to the libp2p network using the provided multiaddress.

  2. Generic Clients:

    • HTTP Client: Represents any standard HTTP client (like cURL) that can make requests to the dRPC gateway.
    • gRPC Client: A client using the gRPC protocol.
    • ConnectRPC Client: A client using the ConnectRPC protocol.

Gateway and Relay:

The Gateway Handler forwards requests to the dRPC Handler via a Relay libp2p Peer, which helps in routing requests through the libp2p network.

Transport Prioritization:

When the dRPC client uses libp2p, it prioritizes transports in the following order:

  1. WebTransport/Quick
  2. WebRTC
  3. TCP/WS

Comparison Table

Feature dRPC ConnectRPC gRPC
Transport libp2p, HTTP (with streaming) HTTP/1.1, HTTP/2 HTTP/2
Protocol ConnectRPC, Custom ConnectRPC, gRPC gRPC
Network Peer-to-peer (libp2p), Client-Server Client-Server Client-Server
Streaming Client, Server, Bidirectional Client, Server, Bidirectional Client, Server, Bidirectional
Gateway Built-in (libp2p forwarding) Separate gateway required Separate gateway required
Address Format Multiaddr (libp2p), HTTP URL HTTP URL HTTP URL
Client-side Streaming over HTTP Yes (WebTransport, WebRTC, WS) Yes (using WebSockets for Connect) No (Requires HTTP/2)