multi: Misc error simplification and cleanup.

davecgh · davecgh · commit 04c4e2d4a95d · 2025-06-12T16:55:55.000-05:00
This does some basic error-related housekeeping to simplify all
print-related formatting as follows:

- Use the error directly as opposed to unnecessarily manually invoking
  the Error method
- Avoid unneeded formatting directives when the output only consists of
  the error itself
- Use const strings when matching on fixed error strings
- Wrap errors when using fmt.Errorf
diff --git a/addrmgr/addrmanager_test.go b/addrmgr/addrmanager_test.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2014 The btcsuite developers
-// Copyright (c) 2015-2024 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -605,7 +605,7 @@ func TestGood(t *testing.T) {
 
 	expectedErrMsg := fmt.Sprintf("%s is not marked as a new address", addrA)
 	if err.Error() != expectedErrMsg {
-		t.Fatalf("unexpected error str: got %s, want %s", err.Error(), expectedErrMsg)
+		t.Fatalf("unexpected error str: got %s, want %s", err, expectedErrMsg)
 	}
 }
 
diff --git a/blockchain/stake/internal/ticketdb/chainio_test.go b/blockchain/stake/internal/ticketdb/chainio_test.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2016-2022 The Decred developers
+// Copyright (c) 2016-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -398,7 +398,7 @@ func TestLiveDatabase(t *testing.T) {
 	// Initialize the database, then try to read the version.
 	err = testDb.Update(DbCreate)
 	if err != nil {
-		t.Fatalf("%v", err.Error())
+		t.Fatal(err)
 	}
 
 	var dbi *DatabaseInfo
@@ -407,7 +407,7 @@ func TestLiveDatabase(t *testing.T) {
 		return err
 	})
 	if err != nil {
-		t.Fatalf("%v", err.Error())
+		t.Fatal(err)
 	}
 	if dbi.Version != currentDatabaseVersion {
 		t.Fatalf("bad version after reading from DB; want %v, got %v",
@@ -442,7 +442,7 @@ func TestLiveDatabase(t *testing.T) {
 		return nil
 	})
 	if err != nil {
-		t.Fatalf("%v", err.Error())
+		t.Fatal(err)
 	}
 
 	var treap *tickettreap.Immutable
@@ -452,7 +452,7 @@ func TestLiveDatabase(t *testing.T) {
 		return err
 	})
 	if err != nil {
-		t.Fatalf("%v", err.Error())
+		t.Fatal(err)
 	}
 	treap.ForEach(func(k tickettreap.Key, v *tickettreap.Value) bool {
 		ticketMap2[k] = v
@@ -461,6 +461,6 @@ func TestLiveDatabase(t *testing.T) {
 	})
 
 	if !reflect.DeepEqual(ticketMap, ticketMap2) {
-		t.Fatalf("not same ticket maps")
+		t.Fatal("not same ticket maps")
 	}
 }
diff --git a/blockchain/stake/staketx_test.go b/blockchain/stake/staketx_test.go
@@ -1,4 +1,4 @@
-// Copyright (c) 2015-2024 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -1163,8 +1163,7 @@ func TestGetSStxNullOutputAmounts(t *testing.T) {
 		amtTicket)
 
 	// len commit to amts != len change amts
-	lenErrStr := "amounts was not equal in length " +
-		"to change amounts!"
+	const lenErrStr = "amounts was not equal in length to change amounts!"
 	if err == nil || err.Error() != lenErrStr {
 		t.Errorf("TestGetSStxNullOutputAmounts unexpected error: %v", err)
 	}
@@ -1174,7 +1173,7 @@ func TestGetSStxNullOutputAmounts(t *testing.T) {
 		commitAmts,
 		changeAmts,
 		int64(0x00000000))
-	tooSmallErrStr := "committed amount was too small!"
+	const tooSmallErrStr = "committed amount was too small!"
 	if err == nil || err.Error() != tooSmallErrStr {
 		t.Errorf("TestGetSStxNullOutputAmounts unexpected error: %v", err)
 	}
diff --git a/cmd/addblock/import.go b/cmd/addblock/import.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2016 The btcsuite developers
-// Copyright (c) 2015-2022 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -159,8 +159,7 @@ out:
 		// notify the status handler with the error and bail.
 		serializedBlock, err := bi.readBlock()
 		if err != nil {
-			bi.errChan <- fmt.Errorf("error reading from input "+
-				"file: %v", err.Error())
+			bi.errChan <- fmt.Errorf("error reading from input file: %w", err)
 			break out
 		}
 
diff --git a/database/cmd/dbtool/insecureimport.go b/database/cmd/dbtool/insecureimport.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2015-2016 The btcsuite developers
-// Copyright (c) 2016-2020 The Decred developers
+// Copyright (c) 2016-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -171,8 +171,7 @@ out:
 		// notify the status handler with the error and bail.
 		serializedBlock, err := bi.readBlock()
 		if err != nil {
-			bi.errChan <- fmt.Errorf("error reading from input "+
-				"file: %v", err.Error())
+			bi.errChan <- fmt.Errorf("error reading from input file: %w", err)
 			break out
 		}
 
diff --git a/database/ffldb/interface_test.go b/database/ffldb/interface_test.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2015-2016 The btcsuite developers
-// Copyright (c) 2016-2023 The Decred developers
+// Copyright (c) 2016-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -74,15 +74,15 @@ func loadBlocks(t *testing.T, dataFile string, network wire.CurrencyNet) ([]*dcr
 
 	// Decode the blockchain into the map.
 	if err := bcDecoder.Decode(&blockChain); err != nil {
-		t.Errorf("error decoding test blockchain: %v", err.Error())
+		t.Errorf("error decoding test blockchain: %v", err)
 	}
 
 	// Fetch blocks 1 to 168 and perform various tests.
 	blocks := make([]*dcrutil.Block, 169)
 	for i := 0; i <= 168; i++ {
 		bl, err := dcrutil.NewBlockFromBytes(blockChain[int64(i)])
 		if err != nil {
-			t.Errorf("NewBlockFromBytes error: %v", err.Error())
+			t.Errorf("NewBlockFromBytes error: %v", err)
 		}
 
 		blocks[i] = bl
diff --git a/database/ffldb/whitebox_test.go b/database/ffldb/whitebox_test.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2015-2016 The btcsuite developers
-// Copyright (c) 2016-2023 The Decred developers
+// Copyright (c) 2016-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -69,15 +69,15 @@ func loadBlocks(t *testing.T, dataFile string, network wire.CurrencyNet) ([]*dcr
 
 	// Decode the blockchain into the map.
 	if err := bcDecoder.Decode(&blockChain); err != nil {
-		t.Errorf("error decoding test blockchain: %v", err.Error())
+		t.Errorf("error decoding test blockchain: %v", err)
 	}
 
 	// Fetch blocks 1 to 168 and perform various tests.
 	blocks := make([]*dcrutil.Block, 169)
 	for i := 0; i <= 168; i++ {
 		bl, err := dcrutil.NewBlockFromBytes(blockChain[int64(i)])
 		if err != nil {
-			t.Errorf("NewBlockFromBytes error: %v", err.Error())
+			t.Errorf("NewBlockFromBytes error: %v", err)
 		}
 
 		blocks[i] = bl
diff --git a/dcrd.go b/dcrd.go
@@ -123,7 +123,7 @@ func dcrdMain() error {
 	if cfg.CPUProfile != "" {
 		f, err := os.Create(cfg.CPUProfile)
 		if err != nil {
-			dcrdLog.Errorf("Unable to create cpu profile: %v", err.Error())
+			dcrdLog.Errorf("Unable to create cpu profile: %v", err)
 			return err
 		}
 		pprof.StartCPUProfile(f)
diff --git a/internal/blockchain/chain_test.go b/internal/blockchain/chain_test.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2016 The btcsuite developers
-// Copyright (c) 2015-2023 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -331,19 +331,19 @@ func TestBlockchainFunctions(t *testing.T) {
 
 	// Decode the blockchain into the map.
 	if err := bcDecoder.Decode(&blockChain); err != nil {
-		t.Errorf("error decoding test blockchain: %v", err.Error())
+		t.Errorf("error decoding test blockchain: %v", err)
 	}
 
 	// Insert blocks 1 to 168 and perform various tests.
 	for i := 1; i <= 168; i++ {
 		bl, err := dcrutil.NewBlockFromBytes(blockChain[int64(i)])
 		if err != nil {
-			t.Errorf("NewBlockFromBytes error: %v", err.Error())
+			t.Errorf("NewBlockFromBytes error: %v", err)
 		}
 
 		_, err = chain.ProcessBlock(bl)
 		if err != nil {
-			t.Fatalf("ProcessBlock error at height %v: %v", i, err.Error())
+			t.Fatalf("ProcessBlock error at height %v: %v", i, err)
 		}
 	}
 
diff --git a/internal/blockchain/chainio_test.go b/internal/blockchain/chainio_test.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2015-2016 The btcsuite developers
-// Copyright (c) 2015-2022 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -69,13 +69,13 @@ func isNotInMainChainErr(err error) bool {
 // TestErrNotInMainChain ensures the functions related to errNotInMainChain work
 // as expected.
 func TestErrNotInMainChain(t *testing.T) {
-	errStr := "no block at height 1 exists"
+	const errStr = "no block at height 1 exists"
 	err := error(errNotInMainChain(errStr))
 
 	// Ensure the stringized output for the error is as expected.
 	if err.Error() != errStr {
 		t.Fatalf("errNotInMainChain returned unexpected error string - "+
-			"got %q, want %q", err.Error(), errStr)
+			"got %q, want %q", err, errStr)
 	}
 
 	// Ensure error is detected as the correct type.
diff --git a/internal/blockchain/validate_test.go b/internal/blockchain/validate_test.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2016 The btcsuite developers
-// Copyright (c) 2015-2023 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -86,20 +86,20 @@ func TestBlockchainSpendJournal(t *testing.T) {
 
 	// Decode the blockchain into the map
 	if err := bcDecoder.Decode(&blockChain); err != nil {
-		t.Errorf("error decoding test blockchain: %v", err.Error())
+		t.Errorf("error decoding test blockchain: %v", err)
 	}
 
 	// Load up the short chain
 	finalIdx1 := 179
 	for i := 1; i < finalIdx1+1; i++ {
 		bl, err := dcrutil.NewBlockFromBytes(blockChain[int64(i)])
 		if err != nil {
-			t.Fatalf("NewBlockFromBytes error: %v", err.Error())
+			t.Fatalf("NewBlockFromBytes error: %v", err)
 		}
 
 		forkLen, err := chain.ProcessBlock(bl)
 		if err != nil {
-			t.Fatalf("ProcessBlock error at height %v: %v", i, err.Error())
+			t.Fatalf("ProcessBlock error at height %v: %v", i, err)
 		}
 		isMainChain := forkLen == 0
 		if !isMainChain {
diff --git a/internal/mempool/mempool.go b/internal/mempool/mempool.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2016 The btcsuite developers
-// Copyright (c) 2015-2024 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -2168,8 +2168,7 @@ func (mp *TxPool) ProcessTransaction(tx *dcrutil.Tx, allowOrphan, allowHighFees
 	defer mp.mtx.Unlock()
 	defer func() {
 		if err != nil {
-			log.Tracef("Failed to process transaction %v: %s",
-				tx.Hash(), err.Error())
+			log.Tracef("Failed to process transaction %v: %s", tx.Hash(), err)
 		}
 	}()
 
diff --git a/internal/mining/mining.go b/internal/mining/mining.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2014-2016 The btcsuite developers
-// Copyright (c) 2015-2024 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -931,7 +931,7 @@ func (g *BlkTmplGenerator) handleTooFewVoters(nextHeight int64,
 		err = g.cfg.CheckConnectBlockTemplate(btBlock)
 		if err != nil {
 			str := fmt.Sprintf("failed to check template: %v while "+
-				"constructing a new parent", err.Error())
+				"constructing a new parent", err)
 			return nil, makeError(ErrCheckConnectBlock, str)
 		}
 
@@ -2186,7 +2186,7 @@ nextPriorityQueueItem:
 		view, err := g.cfg.FetchUtxoView(tx, !knownDisapproved)
 		if err != nil {
 			str := fmt.Sprintf("failed to fetch utxo view for tx %v: %s",
-				tx.Hash(), err.Error())
+				tx.Hash(), err)
 			return nil, makeError(ErrFetchTxStore, str)
 		}
 
diff --git a/internal/netsync/manager.go b/internal/netsync/manager.go
@@ -1958,8 +1958,7 @@ func (m *SyncManager) requestFromPeer(peer *Peer, blocks, voteHashes,
 		err := msgResp.AddInvVect(wire.NewInvVect(wire.InvTypeBlock, bh))
 		if err != nil {
 			return fmt.Errorf("unexpected error encountered building request "+
-				"for mining state block %v: %v",
-				bh, err.Error())
+				"for mining state block %v: %w", bh, err)
 		}
 
 		peer.requestedBlocks[*bh] = struct{}{}
@@ -2020,8 +2019,7 @@ func (m *SyncManager) requestFromPeer(peer *Peer, blocks, voteHashes,
 			err = msgResp.AddInvVect(wire.NewInvVect(wire.InvTypeTx, tx))
 			if err != nil {
 				return fmt.Errorf("unexpected error encountered building request "+
-					"for mining state vote %v: %v",
-					tx, err.Error())
+					"for mining state vote %v: %w", tx, err)
 			}
 
 			peer.requestedTxns[*tx] = struct{}{}
@@ -2061,8 +2059,7 @@ func (m *SyncManager) requestFromPeer(peer *Peer, blocks, voteHashes,
 		err := msgResp.AddInvVect(wire.NewInvVect(wire.InvTypeMix, mh))
 		if err != nil {
 			return fmt.Errorf("unexpected error encountered building request "+
-				"for inv vect mix hash %v: %v",
-				mh, err.Error())
+				"for inv vect mix hash %v: %w", mh, err)
 		}
 
 		peer.requestedMixMsgs[*mh] = struct{}{}
diff --git a/internal/rpcserver/rpcwebsocket.go b/internal/rpcserver/rpcwebsocket.go
@@ -1,5 +1,5 @@
 // Copyright (c) 2013-2016 The btcsuite developers
-// Copyright (c) 2015-2024 The Decred developers
+// Copyright (c) 2015-2025 The Decred developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -1086,8 +1086,7 @@ func (m *wsNotificationManager) notifyForNewTx(clients map[chan struct{}]*wsClie
 		dcrutil.Amount(amount).ToCoin())
 	marshalledJSON, err := dcrjson.MarshalCmd("1.0", nil, ntfn)
 	if err != nil {
-		log.Errorf("Failed to marshal tx notification: %s",
-			err.Error())
+		log.Errorf("Failed to marshal tx notification: %s", err)
 		return
 	}
 
@@ -1119,8 +1118,7 @@ func (m *wsNotificationManager) notifyForNewTx(clients map[chan struct{}]*wsClie
 			marshalledJSONVerbose, err = dcrjson.MarshalCmd("1.0", nil,
 				verboseNtfn)
 			if err != nil {
-				log.Errorf("Failed to marshal verbose tx "+
-					"notification: %s", err.Error())
+				log.Errorf("Failed to marshal verbose tx notification: %v", err)
 				return
 			}
 			wsc.QueueNotification(marshalledJSONVerbose)
@@ -1501,8 +1499,7 @@ out:
 				// Marshal and send response.
 				reply, err = createMarshalledReply(cmd.jsonrpc, cmd.id, nil, nil)
 				if err != nil {
-					log.Errorf("Failed to marshal authenticate reply: "+
-						"%v", err.Error())
+					log.Errorf("Failed to marshal authenticate reply: %v", err)
 					continue
 				}
 				c.SendMessage(reply, nil)
@@ -1708,7 +1705,7 @@ out:
 							reply, err = createMarshalledReply(cmd.jsonrpc, cmd.id, nil, nil)
 							if err != nil {
 								log.Errorf("Failed to marshal authenticate reply: "+
-									"%v", err.Error())
+									"%v", err)
 								continue
 							}
 
diff --git a/server.go b/server.go
diff --git a/txscript/sighash_test.go b/txscript/sighash_test.go
diff --git a/wire/bench_test.go b/wire/bench_test.go
diff --git a/wire/msgminingstate_test.go b/wire/msgminingstate_test.go

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`// Copyright (c) 2013-2014 The btcsuite developers`
`2`		`-// Copyright (c) 2015-2024 The Decred developers`
	`2`	`+// Copyright (c) 2015-2025 The Decred developers`
`3`	`3`	`// Use of this source code is governed by an ISC`
`4`	`4`	`// license that can be found in the LICENSE file.`
`5`	`5`
`@@ -605,7 +605,7 @@ func TestGood(t *testing.T) {`
`605`	`605`
`606`	`606`	`expectedErrMsg := fmt.Sprintf("%s is not marked as a new address", addrA)`
`607`	`607`	`if err.Error() != expectedErrMsg {`
`608`		`- t.Fatalf("unexpected error str: got %s, want %s", err.Error(), expectedErrMsg)`
	`608`	`+ t.Fatalf("unexpected error str: got %s, want %s", err, expectedErrMsg)`
`609`	`609`	`}`
`610`	`610`	`}`
`611`	`611`
Original file line number	Diff line number	Diff line change
`@@ -123,7 +123,7 @@ func dcrdMain() error {`
`123`	`123`	`if cfg.CPUProfile != "" {`
`124`	`124`	`f, err := os.Create(cfg.CPUProfile)`
`125`	`125`	`if err != nil {`
`126`		`- dcrdLog.Errorf("Unable to create cpu profile: %v", err.Error())`
	`126`	`+ dcrdLog.Errorf("Unable to create cpu profile: %v", err)`
`127`	`127`	`return err`
`128`	`128`	`}`
`129`	`129`	`pprof.StartCPUProfile(f)`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`// Copyright (c) 2013-2016 The btcsuite developers`
`2`		`-// Copyright (c) 2015-2023 The Decred developers`
	`2`	`+// Copyright (c) 2015-2025 The Decred developers`
`3`	`3`	`// Use of this source code is governed by an ISC`
`4`	`4`	`// license that can be found in the LICENSE file.`
`5`	`5`
`@@ -331,19 +331,19 @@ func TestBlockchainFunctions(t *testing.T) {`
`331`	`331`
`332`	`332`	`// Decode the blockchain into the map.`
`333`	`333`	`if err := bcDecoder.Decode(&blockChain); err != nil {`
`334`		`- t.Errorf("error decoding test blockchain: %v", err.Error())`
	`334`	`+ t.Errorf("error decoding test blockchain: %v", err)`
`335`	`335`	`}`
`336`	`336`
`337`	`337`	`// Insert blocks 1 to 168 and perform various tests.`
`338`	`338`	`for i := 1; i <= 168; i++ {`
`339`	`339`	`bl, err := dcrutil.NewBlockFromBytes(blockChain[int64(i)])`
`340`	`340`	`if err != nil {`
`341`		`- t.Errorf("NewBlockFromBytes error: %v", err.Error())`
	`341`	`+ t.Errorf("NewBlockFromBytes error: %v", err)`
`342`	`342`	`}`
`343`	`343`
`344`	`344`	`_, err = chain.ProcessBlock(bl)`
`345`	`345`	`if err != nil {`
`346`		`- t.Fatalf("ProcessBlock error at height %v: %v", i, err.Error())`
	`346`	`+ t.Fatalf("ProcessBlock error at height %v: %v", i, err)`
`347`	`347`	`}`
`348`	`348`	`}`
`349`	`349`