# raccoon-mh/upbitgokit architecture

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

- Interactive diagram: https://gitdiagram.com/raccoon-mh/upbitgokit
- Repository: https://github.com/raccoon-mh/upbitgokit

## Overview

##### Project Type and Purpose
- This is an open-source Go library plus CLI tool (“upbitApi”) for interacting with the Upbit cryptocurrency exchange via its REST and WebSocket APIs.
- It exposes two main Go packages (upbitapi for REST, upbitws for WebSockets) and a standalone CLI under the `cli/` folder.

##### File-Structure Analysis
Top level:
- go.mod, go.sum – module definition for root (examples.go)
- examples.go – sample usage of both upbitapi & upbitws
- README.md – project description and feature list
cli/:
- upbitgokitcli.go – main() for the CLI binary
- build.sh – build script
- go.mod, go.sum – module definition for CLI
upbitapi/:
- REST client implementation files (accounts.go, candles.go, orders.go, etc.)
- config.go, common.go, const.go – shared constants and configuration
upbitws/:
- WebSocket client implementation (public.go, private.go)
- config.go, common.go, const.go – WS-specific settings

##### README Insights
- Describes core features: account management, market data, order management, deposit/withdraw status, trade history, shell completion
- Mentions both CLI commands and Go-library usage

##### Diagramming the Architecture
a. Main Components
- CLI Binary (`cli/upbitgokitcli`)
- Example Runner (`examples.go`)
- REST-API Package (`upbitapi`)
- WebSocket Package (`upbitws`)
- External Services:
– Upbit REST API endpoints (https://api.upbit.com)
– Upbit WebSocket API (wss://api.upbit.com/websocket/v1)

b. Relationships & Data Flows
- CLI & Examples → import & invoke → upbitapi package → HTTP requests → Upbit REST API
- CLI & Examples → import & invoke → upbitws package → WebSocket messages → Upbit WS API
- upbitapi: handles request construction, signing (via apikeys), response parsing
- upbitws: manages connection, subscription to public/private topics, message dispatch

c. Architectural Patterns & Principles
- Separation of Concerns – CLI layer vs. library layer vs. network layer
- Package Modularization – each API area (accounts, market, order, trades) in its own file
- Idempotent Build – separate go.mod in cli/ isolates CLI deps from library deps

d. Key Technologies & Frameworks
- Go modules for dependency management
- net/http (assumed) for REST calls
- gorilla/websocket (or similar) for WS connectivity
- Shell completion codegen for bash/zsh/fish/powershell

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Root Module
    subgraph "Root Module"
        direction TB
        MODR["go.mod, go.sum"] 
        click MODR "https://github.com/raccoon-mh/upbitgokit/blob/main/go.mod"
        README["README.md"] 
        click README "https://github.com/raccoon-mh/upbitgokit/blob/main/README.md"
        EXAMPLE["examples.go"]:::example
        click EXAMPLE "https://github.com/raccoon-mh/upbitgokit/blob/main/examples.go"
    end

    %% CLI Module
    subgraph "CLI Module"
        direction TB
        CLIMOD["cli/go.mod, cli/go.sum"]
        click CLIMOD "https://github.com/raccoon-mh/upbitgokit/blob/main/cli/go.mod"
        click CLIMOD "https://github.com/raccoon-mh/upbitgokit/blob/main/cli/go.sum"
        BUILD["build.sh"] 
        click BUILD "https://github.com/raccoon-mh/upbitgokit/blob/main/cli/build.sh"
        CLI["upbitgokitcli.go"]:::cli
        click CLI "https://github.com/raccoon-mh/upbitgokit/blob/main/cli/upbitgokitcli.go"
    end

    %% Libraries
    subgraph "Libraries"
        direction TB

        subgraph "REST Package (upbitapi)" 
            direction TB
            APIKEYS["apikeys.go"]
            click APIKEYS "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/apikeys.go"
            CONFIG_R["config.go"]
            click CONFIG_R "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/config.go"
            COMMON_R["common.go"]
            click COMMON_R "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/common.go"
            CONST_R["const.go"]
            click CONST_R "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/const.go"
            ACC["accounts.go"]
            click ACC "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/accounts.go"
            CAND["candles.go"]
            click CAND "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/candles.go"
            MKT["market.go"]
            click MKT "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/market.go"
            ORD["order.go"]
            click ORD "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/order.go"
            STAT["status.go"]
            click STAT "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/status.go"
            TRD["trades.go"]
            click TRD "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitapi/trades.go"
        end

        subgraph "WS Package (upbitws)"
            direction TB
            CONFIG_W["config.go"]
            click CONFIG_W "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitws/config.go"
            COMMON_W["common.go"]
            click COMMON_W "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitws/common.go"
            CONST_W["const.go"]
            click CONST_W "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitws/const.go"
            PUBWS["public.go"]
            click PUBWS "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitws/public.go"
            PRIVWS["private.go"]
            click PRIVWS "https://github.com/raccoon-mh/upbitgokit/blob/main/upbitws/private.go"
        end
    end

    %% External Services
    subgraph "External Upbit Services"
        direction TB
        UPBITREST["Upbit REST API\n(https://api.upbit.com)"]:::external
        UPBITWS["Upbit WebSocket API\n(wss://api.upbit.com/websocket/v1)"]:::external
    end

    %% Connections
    CLI -->|"Invoke()"| ACC
    CLI -->|"Invoke()"| PUBWS
    EXAMPLE -->|"Invoke()"| ACC
    EXAMPLE -->|"Invoke()"| PUBWS

    ACC -->|"HTTP GET/POST"| UPBITREST
    PUBWS -->|"WS Subscribe/Publish"| UPBITWS

    REST_PACKAGE(("REST Package")) --> ACC
    WS_PACKAGE(("WS Package")) --> PUBWS

    %% Styles
    classDef cli fill:#9f6,stroke:#393,stroke-width:1px;
    classDef example fill:#6cf,stroke:#069,stroke-width:1px;
    classDef rest fill:#f96,stroke:#c60,stroke-width:1px;
    classDef ws fill:#fc9,stroke:#c93,stroke-width:1px;
    classDef external fill:#ccc,stroke:#888,stroke-width:1px;

    class ACC,CAND,MKT,ORD,STAT,TRD,APIKEYS,CONFIG_R,COMMON_R,CONST_R rest
    class CONFIG_W,COMMON_W,CONST_W,PUBWS,PRIVWS ws
```
