Snider/Mining
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

ax(batch): remove banned import references from comment examples

Browse source 
Replace all fmt.Println, fmt.Sprintf, log.Printf, log.Println, and
json.Unmarshal references in doc comments with logging.Info/logging.Warn
or direct value access patterns. Comments are examples that agents
learn from -- they must not demonstrate banned imports.

Co-Authored-By: Charon <charon@lethean.io>
This commit is contained in:
Claude 2026-04-02 18:07:35 +01:00
parent 93a825c7da
commit 43e4b447ac
No known key found for this signature in database
GPG key ID: AF404715446AEB41
10 changed files with 18 additions and 18 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pkg/database/hashrate.go
View file

@ -114,7 +114,7 @@ func GetHashrateHistory(minerName string, resolution Resolution, since, until ti
// HashrateStats holds aggregated performance data for a single miner.
// stats, err := database.GetHashrateStats("xmrig")
// if stats != nil { fmt.Println(stats.AverageRate) }
// if stats != nil { logging.Info("stats", logging.Fields{"average": stats.AverageRate}) }
type HashrateStats struct {
MinerName string `json:"minerName"`
TotalPoints int `json:"totalPoints"`
@ -127,7 +127,7 @@ type HashrateStats struct {
// GetHashrateStats retrieves aggregated statistics for a specific miner.
// stats, err := database.GetHashrateStats("xmrig")
// if stats != nil { log.Printf("avg: %d", stats.AverageRate) }
// if stats != nil { logging.Info("stats", logging.Fields{"miner": minerName, "average": stats.AverageRate}) }
func GetHashrateStats(minerName string) (*HashrateStats, error) {
databaseMutex.RLock()
defer databaseMutex.RUnlock()
@ -187,7 +187,7 @@ func GetHashrateStats(minerName string) (*HashrateStats, error) {
// GetAllMinerStats returns aggregated performance data for every known miner.
// allStats, err := database.GetAllMinerStats()
// for _, stats := range allStats { fmt.Println(stats.MinerName, stats.AverageRate) }
// for _, stats := range allStats { logging.Info("stats", logging.Fields{"miner": stats.MinerName, "average": stats.AverageRate}) }
func GetAllMinerStats() ([]HashrateStats, error) {
databaseMutex.RLock()
defer databaseMutex.RUnlock()

4
pkg/database/interface.go
View file

@ -16,11 +16,11 @@ type HashrateStore interface {
GetHashrateHistory(minerName string, resolution Resolution, since, until time.Time) ([]HashratePoint, error)
// stats, err := store.GetHashrateStats("xmrig")
// if stats != nil { log.Printf("avg: %d H/s", stats.AverageRate) }
// if stats != nil { logging.Info("stats", logging.Fields{"average": stats.AverageRate}) }
GetHashrateStats(minerName string) (*HashrateStats, error)
// allStats, err := store.GetAllMinerStats()
// for _, stats := range allStats { log.Printf("%s avg: %d H/s", stats.MinerName, stats.AverageRate) }
// for _, stats := range allStats { logging.Info("stats", logging.Fields{"miner": stats.MinerName}) }
GetAllMinerStats() ([]HashrateStats, error)
// store.Cleanup(30) // remove data older than 30 days

2
pkg/mining/errors.go
View file

@ -38,7 +38,7 @@ type MiningError struct {
Cause error // Underlying error
}
// fmt.Println(e.Error()) // "START_FAILED: failed to start miner 'xmrig' (exec: not found)"
// e.Error() // "START_FAILED: failed to start miner 'xmrig' (exec: not found)"
func (e *MiningError) Error() string {
if e.Cause != nil {
return e.Code + ": " + e.Message + " (" + e.Cause.Error() + ")"

8
pkg/mining/manager.go
View file

@ -512,7 +512,7 @@ func (m *Manager) GetMiner(name string) (Miner, error) {
}
// miners := m.ListMiners()
// for _, miner := range miners { fmt.Println(miner.GetName()) }
// for _, miner := range miners { logging.Info(miner.GetName()) }
func (m *Manager) ListMiners() []Miner {
m.mutex.RLock()
defer m.mutex.RUnlock()
@ -715,7 +715,7 @@ func (m *Manager) collectSingleMinerStats(miner Miner, minerType string, now tim
}
// points, err := manager.GetMinerHashrateHistory("xmrig")
// for _, p := range points { fmt.Println(p.Timestamp, p.Hashrate) }
// for _, point := range points { logging.Info("hashrate", logging.Fields{"time": point.Timestamp, "rate": point.Hashrate}) }
func (m *Manager) GetMinerHashrateHistory(name string) ([]HashratePoint, error) {
m.mutex.RLock()
defer m.mutex.RUnlock()
@ -767,7 +767,7 @@ func (m *Manager) Stop() {
}
// stats, err := manager.GetMinerHistoricalStats("xmrig")
// if err == nil { fmt.Println(stats.AverageHashrate) }
// if err == nil { logging.Info("stats", logging.Fields{"average": stats.AverageRate}) }
func (m *Manager) GetMinerHistoricalStats(minerName string) (*database.HashrateStats, error) {
if !m.databaseEnabled {
return nil, ErrDatabaseError("database persistence is disabled")
@ -798,7 +798,7 @@ func (m *Manager) GetMinerHistoricalHashrate(minerName string, since, until time
}
// allStats, err := manager.GetAllMinerHistoricalStats()
// for _, s := range allStats { fmt.Println(s.MinerName, s.AverageHashrate) }
// for _, stats := range allStats { logging.Info("stats", logging.Fields{"miner": stats.MinerName, "average": stats.AverageRate}) }
func (m *Manager) GetAllMinerHistoricalStats() ([]database.HashrateStats, error) {
if !m.databaseEnabled {
return nil, ErrDatabaseError("database persistence is disabled")

2
pkg/mining/miner.go
View file

@ -386,7 +386,7 @@ func (b *BaseMiner) findMinerBinary() (string, error) {
}
// details, err := miner.CheckInstallation()
// if !details.IsInstalled { log.Printf("xmrig not found: %v", err) }
// if !details.IsInstalled { logging.Warn("xmrig not found", logging.Fields{"error": err}) }
func (b *BaseMiner) CheckInstallation() (*InstallationDetails, error) {
binaryPath, err := b.findMinerBinary()
if err != nil {

6
pkg/mining/mining.go
View file

@ -46,7 +46,7 @@ type Miner interface {
}
// details, err := miner.CheckInstallation()
// if details.IsInstalled { fmt.Println(details.Version, details.Path) }
// if details.IsInstalled { logging.Info("installed", logging.Fields{"version": details.Version}) }
type InstallationDetails struct {
IsInstalled bool `json:"is_installed"`
Version string `json:"version"`
@ -233,7 +233,7 @@ func isValidAlgo(algo string) bool {
}
// metrics, err := miner.GetStats(ctx)
// if metrics.Hashrate > 0 { log.Printf("%.2f H/s", float64(metrics.Hashrate)) }
// if metrics.Hashrate > 0 { logging.Info("mining", logging.Fields{"hashrate": metrics.Hashrate}) }
type PerformanceMetrics struct {
Hashrate int `json:"hashrate"`
Shares int `json:"shares"`
@ -259,7 +259,7 @@ type API struct {
ListenPort int `json:"listenPort"`
}
// summary := XMRigSummary{}; json.Unmarshal(body, &summary); fmt.Println(summary.Hashrate.Highest)
// var summary XMRigSummary; UnmarshalJSON(body, &summary); _ = summary.Hashrate.Highest
type XMRigSummary struct {
ID string `json:"id"`
WorkerID string `json:"worker_id"`

2
pkg/mining/ttminer.go
View file

@ -139,7 +139,7 @@ func (m *TTMiner) Uninstall() error {
// details, err := ttminer.CheckInstallation()
// if err != nil { return nil, err }
// log.Println(details.Version, details.MinerBinary)
// logging.Info("installed", logging.Fields{"version": details.Version, "binary": details.MinerBinary})
func (m *TTMiner) CheckInstallation() (*InstallationDetails, error) {
binaryPath, err := m.findMinerBinary()
if err != nil {

2
pkg/mining/xmrig.go
View file

@ -150,7 +150,7 @@ func (m *XMRigMiner) Uninstall() error {
// details, err := xmrig.CheckInstallation()
// if err != nil { return nil, err }
// log.Println(details.Version, details.MinerBinary)
// logging.Info("installed", logging.Fields{"version": details.Version, "binary": details.MinerBinary})
func (m *XMRigMiner) CheckInstallation() (*InstallationDetails, error) {
binaryPath, err := m.findMinerBinary()
if err != nil {

2
pkg/mining/xmrig_start.go
View file

@ -151,7 +151,7 @@ func (m *XMRigMiner) Start(config *Config) error {
}
// miner.Stop()
// if err := miner.Stop(); err != nil { log.Printf("stop failed: %v", err) }
// if err := miner.Stop(); err != nil { logging.Warn("stop failed", logging.Fields{"error": err}) }
func (m *XMRigMiner) Stop() error {
// Call the base Stop to kill the process
if err := m.BaseMiner.Stop(); err != nil {

2
pkg/mining/xmrig_stats.go
View file

@ -9,7 +9,7 @@ import (
const statsTimeout = 5 * time.Second
// metrics, err := miner.GetStats(ctx)
// if err == nil { log.Printf("hashrate: %d", metrics.Hashrate) }
// if err == nil { logging.Info("hashrate", logging.Fields{"rate": metrics.Hashrate}) }
func (m *XMRigMiner) GetStats(ctx context.Context) (*PerformanceMetrics, error) {
// Read state under RLock, then release before HTTP call
m.mutex.RLock()