Mining/pkg/node
Claude 0d1b20e177
ax(batch): replace prose comments with usage examples across all packages
Applies AX principle 2 (Comments as Usage Examples) — removes prose
descriptions that restate the function signature ("returns", "retrieves",
"creates", "wraps", etc.) and keeps or replaces with concrete usage
examples showing real calls with realistic values.

Co-Authored-By: Charon <charon@lethean.io>
2026-04-02 18:28:16 +01:00
..
bufpool.go ax(batch): expand abbreviated parameter and local variable names across all packages 2026-04-02 18:27:21 +01:00
bundle.go ax(batch): expand abbreviated parameter and local variable names across all packages 2026-04-02 18:27:21 +01:00
bundle_test.go ax(node): rename buf to buffer in bundle_test for predictable naming 2026-04-02 16:26:37 +01:00
controller.go ax(node): rename Controller.node field to nodeManager for AX Principle 1 2026-04-02 17:46:35 +01:00
dispatcher.go Implement STIM bundle decryption and installation 2026-02-02 06:07:05 +00:00
identity.go ax(batch): replace prose comments with usage examples across all packages 2026-04-02 18:28:16 +01:00
identity_test.go ax(node): rename cfg.json to config.json in test path 2026-04-02 17:07:55 +01:00
lethean.go ax(node): rename body to requestBody in lethean.go (AX Principle 1) 2026-04-02 17:47:53 +01:00
lethean_test.go ax(node): add Good and Ugly test variants for GetChainInfo, DiscoverPools, DiscoverGateways 2026-04-02 16:54:59 +01:00
message.go ax(node): rename msg to errorMessage in NewErrorMessage 2026-04-02 17:55:08 +01:00
message_test.go ax(node): add missing _Bad and _Ugly test variants for TestMessage_NewMessage 2026-04-02 17:38:04 +01:00
peer.go ax(node): replace direct json.MarshalIndent/Unmarshal with package wrappers in peer.go 2026-04-02 17:41:18 +01:00
peer_test.go ax(node): replace single-letter loop variables p and k with peer and key 2026-04-02 17:03:24 +01:00
protocol.go ax(node): rename resp parameter to response in ResponseHandler methods 2026-04-02 17:23:03 +01:00
protocol_test.go ax(node): fix TestProtocol_ValidateResponse_Ugly comment and assertion 2026-04-02 16:56:38 +01:00
transport.go ax(node): rename msg/smsgMsg to message/decryptedMessage in transport 2026-04-02 17:53:58 +01:00
worker.go ax(node): rename NewWorker param node→nodeManager for AX clarity 2026-04-02 17:56:22 +01:00
worker_test.go ax(node): rename tt to testCase in TestWorker_ConvertMinerStats_Good 2026-04-02 16:57:50 +01:00