How raccoon-mh/upbitgokit works
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