multi: Introduce AgendaChoices type.

Replaces []AgendaChoice. This makes it easy to pass choices into vspd client as a map[string]string instead of a wallet type.

Author: jholdstock

internal/rpc/jsonrpc/methods.go

@@ -4691,7 +4691,7 @@ func (s *Server) setVoteChoice(ctx context.Context, icmd interface{}) (interface
 		ticketHash = hash
 	}
 
-	choice := []wallet.AgendaChoice{
+	choice := wallet.AgendaChoices{
 		{
 			AgendaID: cmd.AgendaID,
 			ChoiceID: cmd.ChoiceID,
@@ -4708,7 +4708,8 @@ func (s *Server) setVoteChoice(ctx context.Context, icmd interface{}) (interface
 }
 
 func (s *Server) updateVSPVoteChoices(ctx context.Context, w *wallet.Wallet, ticketHash *chainhash.Hash,
-	choices []wallet.AgendaChoice, tspendPolicy map[string]string, treasuryPolicy map[string]string) error {
+	choices wallet.AgendaChoices, tspendPolicy map[string]string, treasuryPolicy map[string]string) error {
+
 	if ticketHash != nil {
 		vspHost, err := w.VSPHostForTicket(ctx, ticketHash)
 		if err != nil {
@@ -4722,7 +4723,7 @@ func (s *Server) updateVSPVoteChoices(ctx context.Context, w *wallet.Wallet, tic
 		if err != nil {
 			return err
 		}
-		err = vspClient.SetVoteChoice(ctx, ticketHash, choices, tspendPolicy, treasuryPolicy)
+		err = vspClient.SetVoteChoice(ctx, ticketHash, choices.Map(), tspendPolicy, treasuryPolicy)
 		return err
 	}
 	var firstErr error
@@ -4743,7 +4744,7 @@ func (s *Server) updateVSPVoteChoices(ctx context.Context, w *wallet.Wallet, tic
 		}
 		// Never return errors here, so all tickets are tried.
 		// The first error will be returned to the user.
-		err = vspClient.SetVoteChoice(ctx, hash, choices, tspendPolicy, treasuryPolicy)
+		err = vspClient.SetVoteChoice(ctx, hash, choices.Map(), tspendPolicy, treasuryPolicy)
 		if err != nil && firstErr == nil {
 			firstErr = err
 		}

internal/rpc/rpcserver/server.go

@@ -3354,7 +3354,7 @@ func (s *votingServer) SetVoteChoices(ctx context.Context, req *pb.SetVoteChoice
 			return nil, status.Errorf(codes.InvalidArgument, "%v", err)
 		}
 	}
-	choices := make([]wallet.AgendaChoice, len(req.Choices))
+	choices := make(wallet.AgendaChoices, len(req.Choices))
 	for i, c := range req.Choices {
 		choices[i] = wallet.AgendaChoice{
 			AgendaID: c.AgendaId,
@@ -4312,7 +4312,7 @@ func (s *walletServer) SetVspdVoteChoices(ctx context.Context, req *pb.SetVspdVo
 			return err
 		}
 		if ticketHost == vspHost {
-			_ = vspClient.SetVoteChoice(ctx, hash, choices, tSpendChoices, treasuryChoices)
+			_ = vspClient.SetVoteChoice(ctx, hash, choices.Map(), tSpendChoices, treasuryChoices)
 		}
 		return nil
 	})

internal/vsp/feepayment.go

@@ -629,7 +629,7 @@ func (c *Client) status(ctx context.Context, ticketHash *chainhash.Hash) (*types
 }
 
 func (c *Client) setVoteChoices(ctx context.Context, ticketHash *chainhash.Hash,
-	choices []wallet.AgendaChoice, tspendPolicy map[string]string, treasuryPolicy map[string]string) error {
+	choices map[string]string, tspendPolicy map[string]string, treasuryPolicy map[string]string) error {
 	w := c.wallet
 	params := w.ChainParams()
 
@@ -651,17 +651,10 @@ func (c *Client) setVoteChoices(ctx context.Context, ticketHash *chainhash.Hash,
 			ticketHash, err)
 	}
 
-	agendaChoices := make(map[string]string, len(choices))
-
-	// Prepare agenda choice
-	for _, c := range choices {
-		agendaChoices[c.AgendaID] = c.ChoiceID
-	}
-
 	req := types.SetVoteChoicesRequest{
 		Timestamp:      time.Now().Unix(),
 		TicketHash:     ticketHash.String(),
-		VoteChoices:    agendaChoices,
+		VoteChoices:    choices,
 		TSpendPolicy:   tspendPolicy,
 		TreasuryPolicy: treasuryPolicy,
 	}

internal/vsp/vsp.go

@@ -292,7 +292,7 @@ func (c *Client) Process(ctx context.Context, ticketHash *chainhash.Hash, feeTx
 // the connected VSP. The status provides the current voting preferences so we
 // can just update from there if need be.
 func (c *Client) SetVoteChoice(ctx context.Context, hash *chainhash.Hash,
-	choices []wallet.AgendaChoice, tspendPolicy map[string]string, treasuryPolicy map[string]string) error {
+	choices map[string]string, tspendPolicy map[string]string, treasuryPolicy map[string]string) error {
 
 	// Retrieve current voting preferences from VSP.
 	status, err := c.status(ctx, hash)
@@ -309,20 +309,18 @@ func (c *Client) SetVoteChoice(ctx context.Context, hash *chainhash.Hash,
 	update := false
 
 	// Check consensus vote choices.
-	for _, newChoice := range choices {
-		vspChoice, ok := status.VoteChoices[newChoice.AgendaID]
+	for newAgenda, newChoice := range choices {
+		vspChoice, ok := status.VoteChoices[newAgenda]
 		if !ok {
 			update = true
 			break
 		}
-		if vspChoice != newChoice.ChoiceID {
+		if vspChoice != newChoice {
 			update = true
 			break
 		}
 	}
 
-	// Apply the above changes to the two checks below.
-
 	// Check tspend policies.
 	for newTSpend, newChoice := range tspendPolicy {
 		vspChoice, ok := status.TSpendPolicy[newTSpend]

wallet/wallet.go

@@ -398,18 +398,30 @@ type AgendaChoice struct {
 	ChoiceID string
 }
 
+type AgendaChoices []AgendaChoice
+
+// Map returns the agenda choices formatted as map["AgendaID"] = "ChoiceID".
+func (a AgendaChoices) Map() map[string]string {
+	choices := make(map[string]string, len(a))
+
+	for _, c := range a {
+		choices[c.AgendaID] = c.ChoiceID
+	}
+	return choices
+}
+
 // AgendaChoices returns the choice IDs for every agenda of the supported stake
 // version.  Abstains are included.  Returns choice IDs set for the specified
 // non-nil ticket hash, or the default choice IDs if the ticket hash is nil or
 // there are no choices set for the ticket.
-func (w *Wallet) AgendaChoices(ctx context.Context, ticketHash *chainhash.Hash) (choices []AgendaChoice, voteBits uint16, err error) {
+func (w *Wallet) AgendaChoices(ctx context.Context, ticketHash *chainhash.Hash) (choices AgendaChoices, voteBits uint16, err error) {
 	const op errors.Op = "wallet.AgendaChoices"
 	version, deployments := CurrentAgendas(w.chainParams)
 	if len(deployments) == 0 {
 		return nil, 0, nil
 	}
 
-	choices = make([]AgendaChoice, len(deployments))
+	choices = make(AgendaChoices, len(deployments))
 	for i := range choices {
 		choices[i].AgendaID = deployments[i].Vote.Id
 		choices[i].ChoiceID = "abstain"