satoshi/KamadoPool
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Phase 2a: kamado-api Go middleware (core MVP)

Browse Source 
Go 1.22 module that polls CKPool's Unix socket control API, queries
Bitcoin Core over JSON-RPC, merges both into a thread-safe snapshot, and
serves it over REST. Layout:

  api/
  ├── cmd/kamado-api/main.go              signal-aware entrypoint
  └── internal/
      ├── config/       env var loader with validation
      ├── ckpool/       socket client (4-byte LE length-prefixed wire
      │                 protocol verified against libckpool.c), typed
      │                 response models for poolstats/users/workers/
      │                 clients/uptime, + unit tests using a fake
      │                 unix socket server
      ├── bitcoind/     minimal JSON-RPC client, getblockchaininfo
      │                 and getnetworkhashps
      ├── state/        Aggregator that refreshes a merged Snapshot
      │                 on a ticker; readers get a copy under RWMutex
      └── httpapi/      REST handlers on Go 1.22 ServeMux:
                        /api/health /api/pool /api/users
                        /api/workers /api/clients /api/snapshot

CKPool stores hashrate as "dsps" (diff shares per second); we convert
to H/s via the 2^32 constant used by GoBrrr-Pool and other clients.
Every stat CKPool exposes to its socket API is surfaced — useragent,
IP, per-client diff, per-worker best diff — closing the gap against
Bassin which only reads the 60-second stats files.

Dockerfile does a CGO_ENABLED=0 static build on golang:1.22-bookworm
with -trimpath -ldflags=-s -w. docker-compose now runs both ckpool and
kamado-api, sharing a named volume for /run/ckpool so the API can
dial the stratifier socket directly.

Deferred to Phase 2b (called out in README):
  - Bitcoin Core ZMQ hashblock subscriber
  - WebSocket push for real-time UI updates
  - SQLite persistence (block history, best-share history)
  - CKPool log tailer for "Solved and confirmed block" detection

Tests and build NOT run in this commit — Go isn't installed in the
dev environment. Run `make api-test` or `make api` to verify.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
satoshi
2026-04-12 19:52:27 +03:00
co-authored by Claude Opus 4.6
parent d48035b366
commit bd0b1b0318
13 changed files with 1040 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Makefile
+13 -5
View File
@@ -1,20 +1,28 @@
# ----------------------------------------------------------------------------
# Kamado Pool — top-level Makefile
# ----------------------------------------------------------------------------
.PHONY: help ckpool ckpool-shell up down logs clean
.PHONY: help ckpool api api-test ckpool-shell up down logs clean
help:
@echo "Kamado Pool targets:"
@echo " make ckpool Build the ckpool-solo docker image"
@echo " make api Build the kamado-api docker image"
@echo " make api-test Run Go tests for kamado-api (requires Go installed)"
@echo " make ckpool-shell Open a shell in the built ckpool image"
@echo " make up docker compose up -d"
@echo " make up docker compose up -d --build"
@echo " make down docker compose down"
@echo " make logs Tail ckpool logs"
@echo " make clean Remove build artifacts and data"
@echo " make logs Tail ckpool + api logs"
@echo " make clean Remove build artifacts, data, and volumes"
ckpool:
docker build -t kamado/ckpool:dev ./ckpool
api:
docker build -t kamado/api:dev ./api
api-test:
cd api && go test ./... -race
ckpool-shell: ckpool
docker run --rm -it --entrypoint /bin/sh kamado/ckpool:dev
@@ -25,7 +33,7 @@ down:
docker compose down
logs:
docker compose logs -f ckpool
docker compose logs -f
clean:
docker compose down -v || true