# fluxastromeshlabs/sdk-ts architecture

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

- Interactive diagram: https://gitdiagram.com/fluxastromeshlabs/sdk-ts
- Repository: https://github.com/fluxastromeshlabs/sdk-ts

## Overview

##### Project Type and Purpose
- This is a monorepo for a blockchain SDK and UI toolkit targeting Cosmos-based networks.
- It provides:
- Protocol buffer definitions for on-chain modules (cosmos, ibc, flux, tendermint, etc.)
- gRPC and REST client libraries to interact with both full nodes (chain) and indexer nodes.
- A Vue/Nuxt UI component library (packages/ui) plus wallet adapters (Keplr, MetaMask, Phantom).
- Utilities (packages/utils) and network endpoint configurations (packages/networks).
- Example scripts demonstrating usage patterns (examples/chain, examples/indexer).

##### File Structure Analysis
- Top-level “chain” directory: Protobuf → TypeScript generated code for every Cosmos module, IBC, Tendermint, Flux, etc.
- “packages/client”:
- chain/…grpc, rest, stream clients to query on-chain data and broadcast transactions.
- indexer/…grpc, stream clients for block/indexer data.
- “packages/networks”: network endpoint definitions used by clients.
- “packages/utils”: Shared helpers (HTTP clients, big-number utils, local storage, stream managers, intent-parsing).
- “packages/wallet”: Wallet-adapter layer for various browser wallets.
- “packages/ui”:
- Vue/Nuxt application scaffold, Tailwind config, store modules (snackbar, theme).
- “examples”: Illustrative scripts showing how to use the chain and indexer clients.

##### Key Insights from README
- Relies on grpc-tools and protoc to generate JS/TS stubs from .proto files.
- Emphasis on grpc + TypeScript code generation pipeline.

a. Main Components
1. Protobuf Definitions (chain/, google/, ibc/, tendermint/, flux/, cosmwasm/)
2. Codegen Pipeline (grpc-tools + protoc plugin)
3. Chain Clients
- gRPC Client
- REST Client
- Streaming Client
4. Indexer Clients (gRPC + Streaming)
5. Utilities Layer
6. Networks Config
7. Wallet Adapters
8. UI Layer (Vue/Nuxt)
9. Example Scripts
b. Relationships & Data Flows
- Protobuf → Codegen Pipeline → Generates TS client stubs
- Clients fetch from or subscribe to:
- Full nodes (gRPC / REST endpoints)
- Indexer nodes (gRPC / WebSocket streams)
- Utils provide HTTP, streaming, local storage abstractions used by clients.
- Networks supply endpoint URLs into clients.
- Wallet adapters wrap client calls with user signing flows.
- UI imports client + wallet adapters + utils to build interactive dApp components.
- Examples illustrate end-to-end usage (client + wallet + utils).
c. Architectural Patterns
- Layered Architecture: Codegen → Client layer → Business logic (utils, wallets) → Presentation (UI)
- Adapter Pattern: Wallets adapt generic signing interface for different providers.
- Publish/Subscribe for real-time streams.
d. Technologies & Frameworks
- Protocol Buffers, gRPC, REST
- TypeScript, Node.js
- Vue.js / Nuxt.js, Tailwind CSS
- grpc_tools_node_protoc_plugin
- Browser wallets (Keplr, MetaMask, Phantom)

##### Final Advice
- Data flow: show how a UI action → wallet signing → client broadcast → node → chain state.
- This level of detail ensures stakeholders understand both the developer experience (codegen → client) and runtime interactions (dApp → node).

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Offline Codegen Layer
    subgraph "Offline Codegen"
        direction TB
        Protos["Protobuf Definitions\n(chain/, google/, ibc/, cosmwasm/, flux/, tendermint/, gogoproto/)"]:::client
        Codegen["Codegen Pipeline\n(grpc-tools + protoc)"]:::client
    end

    %% Backends
    subgraph "Backends"
        direction TB
        FullNode["Full Node\n(gRPC / REST)"]:::backend
        IndexerNode["Indexer Node\n(gRPC / WebSocket)"]:::backend
    end

    %% SDK Layer
    subgraph "Client SDK Layer"
        direction TB
        ChainClients["Chain Clients\n• ChainGrpcClient\n• REST Client\n• Stream Client"]:::client
        IndexerClients["Indexer Clients\n• IndexerGrpcClient\n• Stream Client"]:::client
        Utils["Utilities Layer"]:::util
        Networks["Networks Config"]:::util
        Wallets["Wallet Adapters"]:::util
    end

    %% UI Layer
    subgraph "UI Layer"
        direction TB
        UIApp["Vue/Nuxt App"]:::ui
        Components["UI Components"]:::ui
        Store["Store Modules\n(snackbar, theme)"]:::ui
        Tailwind["Tailwind Config"]:::ui
    end

    %% Examples
    Examples["Example Scripts\n(chain, indexer)"]:::client

    %% Connections
    Protos -->|generates| Codegen
    Codegen -->|outputs TS stubs| ChainClients
    Codegen -->|outputs TS stubs| IndexerClients

    ChainClients -->|request/response| FullNode
    ChainClients -->|subscribe/stream| FullNode
    IndexerClients -->|request/response| IndexerNode
    IndexerClients -->|subscribe/stream| IndexerNode

    Utils --> ChainClients
    Utils --> IndexerClients
    Networks --> ChainClients
    Networks --> IndexerClients

    Wallets --> ChainClients
    Wallets --> IndexerClients
    UIApp --> ChainClients
    UIApp --> Wallets
    UIApp --> Utils
    UIApp --> Components
    UIApp --> Store
    UIApp --> Tailwind

    Examples --> ChainClients
    Examples --> Wallets
    Examples --> Utils

    %% Click Events - Protobuf Definitions
    click Protos "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/chain/"
    click Protos "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/chain/google/"
    click Protos "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/chain/ibc/"
    click Protos "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/chain/cosmwasm/"
    click Protos "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/chain/flux/"
    click Protos "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/chain/tendermint/"
    click Protos "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/chain/gogoproto/"

    %% Click Events - Codegen Pipeline
    click Codegen "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/Makefile"
    click Codegen "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/README.md"

    %% Click Events - Chain Clients
    click ChainClients "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/client/chain/ChainGrpcClient.ts"
    click ChainClients "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/client/chain/grpc/"
    click ChainClients "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/client/chain/rest/"
    click ChainClients "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/client/chain/stream/"

    %% Click Events - Indexer Clients
    click IndexerClients "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/client/indexer/IndexerGrpcClient.ts"
    click IndexerClients "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/client/indexer/grpc/"
    click IndexerClients "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/client/indexer/stream/"

    %% Click Events - Utilities
    click Utils "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/utils/"
    click Utils "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/utils/classes/"
    click Utils "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/utils/intent-parser/parser.ts"
    click Utils "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/utils/helpers.ts"
    click Utils "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/utils/grpc.ts"

    %% Click Events - Networks Config
    click Networks "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/networks/endpoints.ts"
    click Networks "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/networks/network.ts"
    click Networks "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/networks/types.ts"

    %% Click Events - Wallet Adapters
    click Wallets "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/wallet/index.ts"
    click Wallets "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/wallet/wallets/Keplr.ts"
    click Wallets "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/wallet/wallets/Metamask.ts"
    click Wallets "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/wallet/wallets/Phantom.ts"

    %% Click Events - UI Layer
    click UIApp "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/ui/nuxt.js"
    click UIApp "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/ui/main.js"
    click Components "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/packages/ui/components/"
    click Store "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/ui/store/snackbar.ts"
    click Store "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/ui/store/theme.ts"
    click Tailwind "https://github.com/fluxastromeshlabs/sdk-ts/blob/main/packages/ui/tailwindConfig.js"

    %% Click Events - Examples
    click Examples "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/examples/chain/"
    click Examples "https://github.com/fluxastromeshlabs/sdk-ts/tree/main/examples/indexer/"

    %% Styles
    classDef backend fill:#bbdefb,stroke:#1e88e5,color:#0d47a1;
    classDef client fill:#c8e6c9,stroke:#2e7d32,color:#1b5e20;
    classDef util fill:#ffe0b2,stroke:#f57c00,color:#e65100;
    classDef ui fill:#e1bee7,stroke:#8e24aa,color:#4a148c;
```
