coinstackNoIndexer.drawio.svg

Overview

This file is an SVG (Scalable Vector Graphics) diagram representing the architecture and data flow of the **"Unchained Coinstack Without Indexer"** system. It visually describes the components, their interactions, and communication protocols involved in a blockchain client stack setup that operates without an indexing service. The diagram illustrates multiple blockchain node types, clients, APIs, and communication methods, providing a high-level architectural overview rather than executable code or functional logic.

The primary purpose of this file is to serve as an architectural reference or documentation artifact that helps developers, architects, or stakeholders understand how different elements in the coinstack ecosystem communicate and interact in a no-indexer configuration.

Detailed Explanation of Diagram Components

While the file contains no classes or functions (being an SVG image), the visual elements represent conceptual "components" and their relationships:

Main Components

1. Blockchain Nodes

   • Represented as boxes labeled:

     • Hornet/Bee Node (IOTA nodes)

     • Simd Node (Cosmos SDK-based nodes)

     • Blockchain Node (Generic blockchain nodes)

   • These can be either self-hosted or third-party nodes.

   • They are responsible for directly interacting with the blockchain network.

2. Clients

   • Boxes labeled Client connect with the APIs of the blockchain nodes.

   • Clients represent applications or services that interact with the blockchain nodes to query or send data.

3. APIs

   • Each node exposes APIs to facilitate interaction.

   • APIs are shown connected to Clients and Nodes, representing the communication layer.

4. Communication Protocols

   • REST (Representational State Transfer)

   • WS (WebSocket)

   • MQTT (Message Queuing Telemetry Transport)

   • RPC / gRPC (Remote Procedure Call / Google Remote Procedure Call)

   • These are shown as labels on arrows or between components, illustrating supported communication channels.

5. Core Technologies/Stacks

   • IOTA Stack: Hornet/Bee node, REST, WS, MQTT protocols.

   • COIN Stack: Generic blockchain node, REST, WS protocols.

   • COSMOS Stack: Simd node, REST, RPC, gRPC, WS protocols.

Relationships and Workflow

• Clients communicate with blockchain nodes primarily via REST APIs and WebSocket or MQTT for real-time or event-driven messaging.

• The nodes themselves connect to the blockchain network and provide data/services back to the clients.

• The diagram shows arrows indicating the direction of communication and supported protocols.

• The absence of an indexer implies that clients interact directly with the nodes without an intermediate indexing service to speed up or organize queries.

Important Implementation Details / Algorithms

• No Indexer Architecture: This approach means that the system relies on direct queries to blockchain nodes without a separate indexing service layer. This impacts performance and functionality because indexing services typically preprocess blockchain data for faster and richer queries.

• Multiple Protocol Support: Nodes support multiple communication protocols (REST, WS, MQTT, RPC, gRPC), enabling flexibility in client implementation and integration.

• Modular Node Support: The design supports different node implementations (Hornet/Bee for IOTA, Simd for Cosmos, generic blockchain nodes), demonstrating a modular and extensible architecture.

Interaction with Other Parts of the System

• This diagram focuses on the interaction between blockchain nodes and clients without indexing.

• It is likely part of a broader system where other files/components handle indexing, database management, or UI layers.

• Clients depicted here might be part of frontends, middleware, or backend services that require blockchain data.

• Nodes interact with the underlying blockchain network and provide blockchain data and transaction submission capabilities.

• The file could be used in documentation or design discussions to contrast this setup with indexed solutions.

Visual Diagram: Component Interaction Flowchart

flowchart TD
    subgraph IOTA Stack
        IOTA_Node["Hornet/Bee Node\n(Self hosted or 3rd Party)"]
        IOTA_API["API"]
        IOTA_Client["Client"]
        IOTA_REST["REST"]
        IOTA_WS["WS"]
        IOTA_MQTT["MQTT"]
    end

    subgraph COIN Stack
        COIN_Node["Blockchain Node\n(Self hosted or 3rd Party)"]
        COIN_API["API"]
        COIN_Client["Client"]
        COIN_REST["REST"]
        COIN_WS["WS"]
    end

    subgraph COSMOS Stack
        COSMOS_Node["Simd Node\n(Self hosted or 3rd Party)"]
        COSMOS_API["API"]
        COSMOS_Client["Client"]
        COSMOS_REST["REST / RPC / gRPC"]
        COSMOS_WS["WS"]
    end

    %% IOTA connections
    IOTA_Client -->|REST| IOTA_API
    IOTA_Client -->|WS| IOTA_API
    IOTA_Client -->|MQTT| IOTA_API
    IOTA_API --> IOTA_Node

    %% COIN connections
    COIN_Client -->|REST| COIN_API
    COIN_Client -->|WS| COIN_API
    COIN_API --> COIN_Node

    %% COSMOS connections
    COSMOS_Client -->|REST / RPC / gRPC| COSMOS_API
    COSMOS_Client -->|WS| COSMOS_API
    COSMOS_API --> COSMOS_Node

Usage Example (Conceptual)

This diagram is used by development and architecture teams to:

• Understand how clients interact with different blockchain nodes without relying on indexing services.

• Design client applications that communicate via REST, WS, MQTT, or RPC/gRPC protocols.

• Choose appropriate node implementations and protocols for specific blockchain networks (IOTA, Cosmos, generic blockchains).

• Identify how to deploy or connect to self-hosted or third-party nodes.

• Discuss trade-offs of no-indexer architecture versus indexed solutions.

Summary

• File Type: SVG diagram for architectural documentation.

• Purpose: Illustrates the "Unchained Coinstack Without Indexer" architecture.

• Functionality: Shows blockchain nodes, clients, APIs, and communication protocols.

• Key Insight: Direct client-to-node interaction without indexing, supporting multiple protocols and blockchain node types.

• Use Case: Reference for developers and architects designing blockchain client stacks and integrations.

If you need further assistance generating similar documentation for executable code files or detailed API specifications, please provide the relevant source code or descriptions.