Minor cleanups for new helpers.

- Ensure errors are properly wrapped with `%w`
- Error strings should not starts with caps.
- Add missing params to "Bad signature" error log

Author: jholdstock

webapi/helpers.go

@@ -112,7 +112,7 @@ func validateSignature(hash, commitmentAddress, signature, message string) error
 		// first check if we have an alternate sign address for this ticket.
 		altSigData, err := db.AltSignAddrData(hash)
 		if err != nil {
-			return fmt.Errorf("db.AltSignAddrData failed: %v", err)
+			return fmt.Errorf("db.AltSignAddrData failed: %w", err)
 		}
 
 		// If we have no alternate sign address, or if validating with the
@@ -158,7 +158,7 @@ func validateTicketHash(hash string) error {
 	}
 	_, err := chainhash.NewHashFromStr(hash)
 	if err != nil {
-		return fmt.Errorf("invalid hash: %v", err)
+		return fmt.Errorf("invalid hash: %w", err)
 
 	}
 
@@ -168,31 +168,25 @@ func validateTicketHash(hash string) error {
 // getCommitmentAddress gets the commitment address of the provided ticket hash
 // from the chain.
 func getCommitmentAddress(hash string, dcrdClient *rpc.DcrdRPC) (string, error) {
-	var commitmentAddress string
 	resp, err := dcrdClient.GetRawTransaction(hash)
 	if err != nil {
-		return commitmentAddress, fmt.Errorf("dcrd.GetRawTransaction for ticket failed: %v", err)
-
+		return "", fmt.Errorf("dcrd.GetRawTransaction for ticket failed: %w", err)
 	}
 
 	msgTx, err := decodeTransaction(resp.Hex)
 	if err != nil {
-		return commitmentAddress, fmt.Errorf("Failed to decode ticket hex: %v", err)
-
+		return "", fmt.Errorf("failed to decode ticket hex: %w", err)
 	}
 
 	err = isValidTicket(msgTx)
 	if err != nil {
-		return commitmentAddress, fmt.Errorf("Invalid ticket: %w", errInvalidTicket)
-
+		return "", fmt.Errorf("invalid ticket: %w", errInvalidTicket)
 	}
 
 	addr, err := stake.AddrFromSStxPkScrCommitment(msgTx.TxOut[1].PkScript, cfg.NetParams)
 	if err != nil {
-		return commitmentAddress, fmt.Errorf("AddrFromSStxPkScrCommitment error: %v", err)
-
+		return "", fmt.Errorf("AddrFromSStxPkScrCommitment error: %w", err)
 	}
 
-	commitmentAddress = addr.String()
-	return commitmentAddress, nil
+	return addr.String(), nil
 }

webapi/middleware.go

@@ -143,7 +143,8 @@ func broadcastTicket() gin.HandlerFunc {
 		// Ensure the provided ticket hex is a valid ticket.
 		msgTx, err := decodeTransaction(request.TicketHex)
 		if err != nil {
-			log.Errorf("%s: Failed to decode ticket hex (ticketHash=%s): %v", funcName, request.TicketHash, err)
+			log.Errorf("%s: Failed to decode ticket hex (ticketHash=%s): %v",
+				funcName, request.TicketHash, err)
 			sendErrorWithMsg("cannot decode ticket hex", errBadRequest, c)
 			return
 		}
@@ -302,7 +303,6 @@ func vspAuth() gin.HandlerFunc {
 
 		// If the ticket was found in the database, we already know its
 		// commitment address. Otherwise we need to get it from the chain.
-		var commitmentAddress string
 		dcrdClient := c.MustGet(dcrdKey).(*rpc.DcrdRPC)
 		dcrdErr := c.MustGet(dcrdErrorKey)
 		if dcrdErr != nil {
@@ -311,34 +311,39 @@ func vspAuth() gin.HandlerFunc {
 			return
 		}
 
+		var commitmentAddress string
 		if ticketFound {
 			commitmentAddress = ticket.CommitmentAddress
 		} else {
 			commitmentAddress, err = getCommitmentAddress(hash, dcrdClient)
 			if err != nil {
+				log.Errorf("%s: Failed to get commitment address (clientIP=%s, ticketHash=%s): %v",
+					funcName, c.ClientIP(), hash, err)
+
 				var apiErr *apiError
 				if errors.Is(err, apiErr) {
 					sendError(errInvalidTicket, c)
 				} else {
 					sendError(errInternalError, c)
 				}
-				log.Errorf("%s: (clientIP: %s, ticketHash: %s): %v", funcName, c.ClientIP(), hash, err)
+
 				return
 			}
 		}
 
 		// Ensure a signature is provided.
 		signature := c.GetHeader("VSP-Client-Signature")
 		if signature == "" {
-			log.Warnf("%s: Bad request (clientIP=%s): %v", funcName, c.ClientIP(), err)
+			log.Warnf("%s: No VSP-Client-Signature header (clientIP=%s)", funcName, c.ClientIP())
 			sendErrorWithMsg("no VSP-Client-Signature header", errBadRequest, c)
 			return
 		}
 
 		// Validate request signature to ensure ticket ownership.
 		err = validateSignature(hash, commitmentAddress, signature, string(reqBytes))
 		if err != nil {
-			log.Errorf("%s: Bad signature (clientIP=%s, ticketHash=%s): %v", funcName, err)
+			log.Errorf("%s: Couldn't validate signature (clientIP=%s, ticketHash=%s): %v",
+				funcName, c.ClientIP(), hash, err)
 			sendError(errBadSignature, c)
 			return
 		}