vspd/internal/webapi/setvotechoices.go

// Copyright (c) 2020-2024 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.

package webapi

import (
	"encoding/json"
	"fmt"
	"time"

	"github.com/decred/vspd/database"
	"github.com/decred/vspd/rpc"
	"github.com/decred/vspd/types/v3"
	"github.com/gin-gonic/gin"
	"github.com/gin-gonic/gin/binding"
)

// setVoteChoices is the handler for "POST /api/v3/setvotechoices".
func (w *WebAPI) setVoteChoices(c *gin.Context) {
	const funcName = "setVoteChoices"

	// Get values which have been added to context by middleware.
	ticket := c.MustGet(ticketKey).(database.Ticket)
	knownTicket := c.MustGet(knownTicketKey).(bool)
	walletClients := c.MustGet(walletsKey).([]*rpc.WalletRPC)
	reqBytes := c.MustGet(requestBytesKey).([]byte)

	// If we cannot set the vote choices on at least one voting wallet right
	// now, don't update the database, just return an error.
	if len(walletClients) == 0 {
		w.sendError(types.ErrInternalError, c)
		return
	}

	if !knownTicket {
		w.log.Warnf("%s: Unknown ticket (clientIP=%s)", funcName, c.ClientIP())
		w.sendError(types.ErrUnknownTicket, c)
		return
	}

	if ticket.FeeTxStatus == database.NoFee {
		w.log.Warnf("%s: No fee tx for ticket (clientIP=%s, ticketHash=%s)",
			funcName, c.ClientIP(), ticket.Hash)
		w.sendError(types.ErrFeeNotReceived, c)
		return
	}

	// Only allow vote choices to be updated for mempool/immature/live tickets.
	if ticket.Outcome != "" {
		w.log.Warnf("%s: Ticket not eligible to vote (clientIP=%s, ticketHash=%s)",
			funcName, c.ClientIP(), ticket.Hash)
		w.sendErrorWithMsg(fmt.Sprintf("ticket not eligible to vote (status=%s)", ticket.Outcome),
			types.ErrTicketCannotVote, c)
		return
	}

	var request types.SetVoteChoicesRequest
	if err := binding.JSON.BindBody(reqBytes, &request); err != nil {
		w.log.Warnf("%s: Bad request (clientIP=%s): %v", funcName, c.ClientIP(), err)
		w.sendErrorWithMsg(err.Error(), types.ErrBadRequest, c)
		return
	}

	// Return an error if this request has a timestamp older than any previous
	// vote change requests. This is to prevent requests from being replayed.
	previousChanges, err := w.db.GetVoteChanges(ticket.Hash)
	if err != nil {
		w.log.Errorf("%s: db.GetVoteChanges error (ticketHash=%s): %v",
			funcName, ticket.Hash, err)
		w.sendError(types.ErrInternalError, c)
		return
	}

	for _, change := range previousChanges {
		var prevReq struct {
			Timestamp int64 `json:"timestamp" binding:"required"`
		}
		err := json.Unmarshal([]byte(change.Request), &prevReq)
		if err != nil {
			w.log.Errorf("%s: Could not unmarshal vote change record (ticketHash=%s): %v",
				funcName, ticket.Hash, err)
			w.sendError(types.ErrInternalError, c)
			return
		}

		if request.Timestamp <= prevReq.Timestamp {
			w.log.Warnf("%s: Request uses invalid timestamp, %d is not greater "+
				"than %d (ticketHash=%s)",
				funcName, request.Timestamp, prevReq.Timestamp, ticket.Hash)
			w.sendError(types.ErrInvalidTimestamp, c)
			return
		}
	}

	// Validate vote choices (consensus, tspend policy and treasury policy).

	err = validConsensusVoteChoices(w.cfg.Network, w.cfg.Network.CurrentVoteVersion(), request.VoteChoices)
	if err != nil {
		w.log.Warnf("%s: Invalid consensus vote choices (clientIP=%s, ticketHash=%s): %v",
			funcName, c.ClientIP(), ticket.Hash, err)
		w.sendErrorWithMsg(err.Error(), types.ErrInvalidVoteChoices, c)
		return
	}

	err = validTreasuryPolicy(request.TreasuryPolicy)
	if err != nil {
		w.log.Warnf("%s: Invalid treasury policy (clientIP=%s, ticketHash=%s): %v",
			funcName, c.ClientIP(), ticket.Hash, err)
		w.sendErrorWithMsg(err.Error(), types.ErrInvalidVoteChoices, c)
	}

	err = validTSpendPolicy(request.TSpendPolicy)
	if err != nil {
		w.log.Warnf("%s: Invalid tspend policy (clientIP=%s, ticketHash=%s): %v",
			funcName, c.ClientIP(), ticket.Hash, err)
		w.sendErrorWithMsg(err.Error(), types.ErrInvalidVoteChoices, c)
	}

	// Update voting preferences in the database before updating the wallets. DB
	// is the source of truth, and also is less likely to error.

	for newAgenda, newChoice := range request.VoteChoices {
		ticket.VoteChoices[newAgenda] = newChoice
	}

	for newTSpend, newChoice := range request.TSpendPolicy {
		ticket.TSpendPolicy[newTSpend] = newChoice
	}

	for newTreasuryKey, newChoice := range request.TreasuryPolicy {
		ticket.TreasuryPolicy[newTreasuryKey] = newChoice
	}

	err = w.db.UpdateTicket(ticket)
	if err != nil {
		w.log.Errorf("%s: db.UpdateTicket error, failed to set consensus vote choices (ticketHash=%s): %v",
			funcName, ticket.Hash, err)
		w.sendError(types.ErrInternalError, c)
		return
	}

	// Update vote choices on voting wallets. Tickets are only added to voting
	// wallets if their fee is confirmed.
	if ticket.FeeTxStatus == database.FeeConfirmed {

		// Just log any errors which occur while setting vote choices. We want
		// to attempt to update as much as possible regardless of any errors.
		for _, walletClient := range walletClients {

			// Set consensus vote choices.
			for agenda, choice := range ticket.VoteChoices {
				err = walletClient.SetVoteChoice(agenda, choice, ticket.Hash)
				if err != nil {
					w.log.Errorf("%s: dcrwallet.SetVoteChoice failed (wallet=%s, ticketHash=%s): %v",
						funcName, walletClient.String(), ticket.Hash, err)
				}
			}

			// Update tspend policy.
			for tspend, policy := range ticket.TSpendPolicy {
				err = walletClient.SetTSpendPolicy(tspend, policy, ticket.Hash)
				if err != nil {
					w.log.Errorf("%s: dcrwallet.SetTSpendPolicy failed (wallet=%s, ticketHash=%s): %v",
						funcName, walletClient.String(), ticket.Hash, err)
				}
			}

			// Update treasury policy.
			for key, policy := range ticket.TreasuryPolicy {
				err = walletClient.SetTreasuryPolicy(key, policy, ticket.Hash)
				if err != nil {
					w.log.Errorf("%s: dcrwallet.SetTreasuryPolicy failed (wallet=%s, ticketHash=%s): %v",
						funcName, walletClient.String(), ticket.Hash, err)
				}
			}
		}
	}

	w.log.Debugf("%s: Vote choices updated (ticketHash=%s)", funcName, ticket.Hash)

	// Send success response to client.
	resp, respSig := w.sendJSONResponse(types.SetVoteChoicesResponse{
		Timestamp: time.Now().Unix(),
		Request:   reqBytes,
	}, c)

	// Store a record of the vote choice change.
	err = w.db.SaveVoteChange(
		ticket.Hash,
		database.VoteChangeRecord{
			Request:           string(reqBytes),
			RequestSignature:  c.GetHeader("VSP-Client-Signature"),
			Response:          resp,
			ResponseSignature: respSig,
		})
	if err != nil {
		w.log.Errorf("%s: Failed to store vote change record (ticketHash=%s): %v", err)
	}
}