From 031f0c0f17c62f370da303206c64c284a7bbb586 Mon Sep 17 00:00:00 2001 From: Virgil Date: Sun, 5 Apr 2026 03:10:41 +0000 Subject: [PATCH] docs(proxy): tighten AX-oriented comments Co-Authored-By: Virgil --- stats.go | 19 ++++++------------- worker.go | 14 +++++--------- 2 files changed, 11 insertions(+), 22 deletions(-) diff --git a/stats.go b/stats.go index 9186c27..8e70eaf 100644 --- a/stats.go +++ b/stats.go @@ -6,13 +6,11 @@ import ( "time" ) -// Stats tracks proxy-wide counters and rolling hashrate windows. -// -// stats := proxy.NewStats() -// bus.Subscribe(proxy.EventAccept, stats.OnAccept) -// bus.Subscribe(proxy.EventReject, stats.OnReject) -// stats.Tick() -// _ = stats.Summary() +// stats := proxy.NewStats() +// bus.Subscribe(proxy.EventAccept, stats.OnAccept) +// bus.Subscribe(proxy.EventReject, stats.OnReject) +// stats.Tick() +// _ = stats.Summary() type Stats struct { accepted atomic.Uint64 rejected atomic.Uint64 @@ -29,9 +27,6 @@ type Stats struct { mu sync.Mutex } -// HashrateWindow60s selects the 60-second hashrate window. -// -// proxy.HashrateWindow60s const ( HashrateWindow60s = 0 // 1 minute HashrateWindow600s = 1 // 10 minutes @@ -50,9 +45,7 @@ type tickWindow struct { size int // window size in seconds = len(buckets) } -// StatsSummary is the serialisable snapshot returned by Stats.Summary(). -// -// summary := proxy.NewStats().Summary() +// summary := proxy.NewStats().Summary() type StatsSummary struct { Accepted uint64 `json:"accepted"` Rejected uint64 `json:"rejected"` diff --git a/worker.go b/worker.go index f55aaac..3d09910 100644 --- a/worker.go +++ b/worker.go @@ -5,11 +5,9 @@ import ( "time" ) -// Workers tracks per-worker aggregates derived from miner login fields. -// -// workers := proxy.NewWorkers(proxy.WorkersByRigID, bus) -// workers.OnLogin(proxy.Event{Miner: &proxy.Miner{rigID: "rig-alpha", user: "WALLET", ip: "10.0.0.1"}}) -// _ = workers.List() +// workers := proxy.NewWorkers(proxy.WorkersByRigID, bus) +// workers.OnLogin(proxy.Event{Miner: &proxy.Miner{rigID: "rig-alpha", user: "WALLET", ip: "10.0.0.1"}}) +// _ = workers.List() type Workers struct { mode WorkersMode entries []WorkerRecord // ordered by first-seen (stable) @@ -19,10 +17,8 @@ type Workers struct { mu sync.RWMutex } -// WorkerRecord is the aggregate row returned by `Workers.List()`. -// -// record := proxy.WorkerRecord{Name: "rig-alpha"} -// _ = record.Hashrate(60) +// record := proxy.WorkerRecord{Name: "rig-alpha"} +// _ = record.Hashrate(60) type WorkerRecord struct { Name string LastIP string