core/go-proxy
8
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(proxy): align public entry points with AX examples

Browse source 
Co-Authored-By: Virgil <virgil@lethean.io>
This commit is contained in:
Virgil 2026-04-05 00:07:27 +00:00
parent 96f7f18c96
commit a76e6be1c7
4 changed files with 24 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
api/router.go
View file

@ -1,12 +1,7 @@
// Package api implements the HTTP monitoring endpoints for the proxy.
//
// Registered routes:
//
// GET /1/summary — aggregated proxy stats
// GET /1/workers — per-worker hashrate table
// GET /1/miners — per-connection state table
//
// proxyapi.RegisterRoutes(apiRouter, p)
// mux := http.NewServeMux()
// RegisterRoutes(mux, p)
package api
import (

18
core_impl.go
View file

@ -116,10 +116,8 @@ func isValidWorkersMode(mode WorkersMode) bool {
}
}
// NewEventBus creates an empty synchronous event dispatcher.
//
// bus := proxy.NewEventBus()
// bus.Subscribe(proxy.EventLogin, func(e proxy.Event) { _ = e.Miner })
// bus := proxy.NewEventBus()
// bus.Subscribe(proxy.EventLogin, func(e proxy.Event) { _ = e.Miner })
func NewEventBus() *EventBus {
return &EventBus{listeners: make(map[EventType][]EventHandler)}
}
@ -231,10 +229,8 @@ func (cd *CustomDiff) OnLogin(e Event) {
e.Miner.customDiffResolved = true
}
// NewRateLimiter creates a per-IP token bucket limiter.
//
// limiter := NewRateLimiter(RateLimit{MaxConnectionsPerMinute: 30, BanDurationSeconds: 300})
// limiter.Allow("203.0.113.42:3333")
// limiter := NewRateLimiter(RateLimit{MaxConnectionsPerMinute: 30, BanDurationSeconds: 300})
// limiter.Allow("203.0.113.42:3333")
func NewRateLimiter(config RateLimit) *RateLimiter {
return &RateLimiter{
config: config,
@ -306,10 +302,8 @@ func (rl *RateLimiter) Tick() {
}
}
// NewConfigWatcher creates a polling watcher for a config file.
//
// watcher := NewConfigWatcher("config.json", func(cfg *Config) { _ = cfg })
// watcher.Start()
// watcher := NewConfigWatcher("config.json", func(cfg *Config) { _ = cfg })
// watcher.Start()
func NewConfigWatcher(configPath string, onChange func(*Config)) *ConfigWatcher {
watcher := &ConfigWatcher{
path: configPath,

9
events.go
View file

@ -2,12 +2,9 @@ package proxy
import "sync"
// EventBus dispatches proxy lifecycle events to registered listeners.
// Dispatch is synchronous on the calling goroutine. Listeners must not block.
//
// bus := proxy.NewEventBus()
// bus.Subscribe(proxy.EventLogin, func(e proxy.Event) { fmt.Println(e.Miner.User()) })
// bus.Subscribe(proxy.EventAccept, stats.OnAccept)
// bus := proxy.NewEventBus()
// bus.Subscribe(proxy.EventLogin, func(e proxy.Event) { fmt.Println(e.Miner.User()) })
// bus.Subscribe(proxy.EventAccept, stats.OnAccept)
type EventBus struct {
listeners map[EventType][]EventHandler
mu sync.RWMutex

35
state_impl.go
View file

@ -32,10 +32,9 @@ type MinerSnapshot struct {
Agent string
}
// New creates the proxy and wires the default event handlers.
// cfg := &proxy.Config{Mode: "nicehash", Bind: []proxy.BindAddr{{Host: "0.0.0.0", Port: 3333}}, Pools: []proxy.PoolConfig{{URL: "pool.example:3333", Enabled: true}}}
// p, result := proxy.New(cfg)
//
// cfg := &proxy.Config{Mode: "nicehash", Bind: []proxy.BindAddr{{Host: "0.0.0.0", Port: 3333}}, Pools: []proxy.PoolConfig{{URL: "pool.example:3333", Enabled: true}}}
// p, result := proxy.New(cfg)
// if !result.OK {
// return result.Error
// }
@ -93,7 +92,7 @@ func New(config *Config) (*Proxy, Result) {
return p, successResult()
}
// Mode returns the active proxy mode.
// p.Mode()
func (p *Proxy) Mode() string {
if p == nil || p.config == nil {
return ""
@ -101,7 +100,7 @@ func (p *Proxy) Mode() string {
return p.config.Mode
}
// WorkersMode returns the worker naming strategy.
// p.WorkersMode()
func (p *Proxy) WorkersMode() WorkersMode {
if p == nil || p.config == nil {
return WorkersDisabled
@ -109,7 +108,7 @@ func (p *Proxy) WorkersMode() WorkersMode {
return p.config.Workers
}
// Summary returns the current global stats snapshot.
// summary := p.Summary()
func (p *Proxy) Summary() StatsSummary {
if p == nil || p.stats == nil {
return StatsSummary{}
@ -121,7 +120,7 @@ func (p *Proxy) Summary() StatsSummary {
return summary
}
// WorkerRecords returns a stable snapshot of worker rows.
// workers := p.WorkerRecords()
func (p *Proxy) WorkerRecords() []WorkerRecord {
if p == nil || p.workers == nil {
return nil
@ -129,7 +128,7 @@ func (p *Proxy) WorkerRecords() []WorkerRecord {
return p.workers.List()
}
// MinerSnapshots returns a stable snapshot of connected miners.
// miners := p.MinerSnapshots()
func (p *Proxy) MinerSnapshots() []MinerSnapshot {
if p == nil {
return nil
@ -159,7 +158,7 @@ func (p *Proxy) MinerSnapshots() []MinerSnapshot {
return rows
}
// MinerCount returns current and peak connected miner counts.
// now, max := p.MinerCount()
func (p *Proxy) MinerCount() (now, max uint64) {
if p == nil || p.stats == nil {
return 0, 0
@ -167,7 +166,7 @@ func (p *Proxy) MinerCount() (now, max uint64) {
return p.stats.miners.Load(), p.stats.maxMiners.Load()
}
// Upstreams returns splitter upstream counts.
// upstreams := p.Upstreams()
func (p *Proxy) Upstreams() UpstreamStats {
if p == nil || p.splitter == nil {
return UpstreamStats{}
@ -175,9 +174,7 @@ func (p *Proxy) Upstreams() UpstreamStats {
return p.splitter.Upstreams()
}
// Events returns the proxy event bus for external composition.
//
// bus := p.Events()
// bus := p.Events()
func (p *Proxy) Events() *EventBus {
if p == nil {
return nil
@ -185,9 +182,7 @@ func (p *Proxy) Events() *EventBus {
return p.events
}
// Start starts the TCP listeners, ticker loop, and optional HTTP API.
//
// p.Start()
// p.Start()
func (p *Proxy) Start() {
if p == nil {
return
@ -260,9 +255,7 @@ func (p *Proxy) Start() {
p.Stop()
}
// Stop shuts down listeners, background tasks, and HTTP.
//
// p.Stop()
// p.Stop()
func (p *Proxy) Stop() {
if p == nil {
return
@ -317,9 +310,7 @@ func (p *Proxy) closeAllMiners() {
}
}
// Reload swaps the live configuration and updates dependent state.
//
// p.Reload(&proxy.Config{Mode: "simple", Pools: []proxy.PoolConfig{{URL: "pool.example:3333", Enabled: true}}})
// p.Reload(&proxy.Config{Mode: "simple", Pools: []proxy.PoolConfig{{URL: "pool.example:3333", Enabled: true}}})
func (p *Proxy) Reload(config *Config) {
if p == nil || config == nil {
return