Standardize on "mixingEnabled" and explain --config more thoroughly.

config.go

@@ -168,7 +168,7 @@ type config struct {
 	IssueClientCert   bool  `long:"issueclientcert" description:"Notify a client cert and key over the TX pipe for RPC authentication"`
 
 	// CSPP
-	Mixing             bool                    `long:"mixing" description:"Enable mixing support"`
+	MixingEnabled      bool                    `long:"mixing" description:"Enable creation of mixed transactions and participation in the peer-to-peer mixing network"`
 	CSPPSolver         *cfgutil.ExplicitString `long:"csppsolver" description:"Path to CSPP solver executable (if not in PATH)"`
 	MixedAccount       string                  `long:"mixedaccount" description:"Account/branch used to derive CoinShuffle++ mixed outputs and voting rewards"`
 	mixedAccount       string
@@ -738,7 +738,7 @@ func loadConfig(ctx context.Context) (*config, []string, error) {
 	}
 
 	var solverMustWork bool
-	if cfg.Mixing {
+	if cfg.MixingEnabled {
 		if cfg.CSPPSolver.ExplicitlySet() {
 			solverrpc.SolverProcess = cfg.CSPPSolver.Value
 			solverMustWork = true

dcrwallet.go

@@ -168,7 +168,7 @@ func run(ctx context.Context) error {
 
 	loader := ldr.NewLoader(activeNet.Params, dbDir, cfg.EnableVoting,
 		cfg.GapLimit, cfg.WatchLast, cfg.AllowHighFees, cfg.RelayFee.Amount,
-		cfg.AccountGapLimit, cfg.DisableCoinTypeUpgrades, !cfg.Mixing,
+		cfg.AccountGapLimit, cfg.DisableCoinTypeUpgrades, cfg.MixingEnabled,
 		cfg.ManualTickets, cfg.MixSplitLimit, cfg.dial)
 
 	// Stop any services started by the loader after the shutdown procedure is
@@ -251,7 +251,7 @@ func run(ctx context.Context) error {
 
 		if cfg.VSPOpts.URL != "" {
 			changeAccountName := cfg.ChangeAccount
-			if changeAccountName == "" && !cfg.Mixing {
+			if changeAccountName == "" && !cfg.MixingEnabled {
 				log.Warnf("Change account not set, using "+
 					"purchase account %q", cfg.PurchaseAccount)
 				changeAccountName = cfg.PurchaseAccount
@@ -307,7 +307,7 @@ func run(ctx context.Context) error {
 			if cfg.EnableTicketBuyer {
 				purchaseAccount = lookup("purchaseaccount", cfg.PurchaseAccount)
 
-				if cfg.Mixing && cfg.TBOpts.VotingAccount == "" {
+				if cfg.MixingEnabled && cfg.TBOpts.VotingAccount == "" {
 					err := errors.New("cannot run mixed ticketbuyer without --votingaccount")
 					log.Error(err)
 					return err
@@ -316,11 +316,11 @@ func run(ctx context.Context) error {
 					votingAccount = lookup("ticketbuyer.votingaccount", cfg.TBOpts.VotingAccount)
 				}
 			}
-			if (cfg.EnableTicketBuyer && cfg.Mixing) || cfg.MixChange {
+			if (cfg.EnableTicketBuyer && cfg.MixingEnabled) || cfg.MixChange {
 				mixedAccount = lookup("mixedaccount", cfg.mixedAccount)
 				changeAccount = lookup("changeaccount", cfg.ChangeAccount)
 			}
-			if cfg.EnableTicketBuyer && cfg.Mixing {
+			if cfg.EnableTicketBuyer && cfg.MixingEnabled {
 				ticketSplitAccount = lookup("ticketsplitaccount", cfg.TicketSplitAccount)
 			}
 
@@ -337,7 +337,7 @@ func run(ctx context.Context) error {
 				Maintain:           cfg.TBOpts.BalanceToMaintainAbsolute.Amount,
 				Limit:              int(cfg.TBOpts.Limit),
 				VotingAccount:      votingAccount,
-				Mixing:             cfg.Mixing,
+				Mixing:             cfg.MixingEnabled,
 				MixChange:          cfg.MixChange,
 				MixedAccount:       mixedAccount,
 				MixedAccountBranch: cfg.mixedBranch,

internal/loader/loader.go

@@ -42,7 +42,7 @@ type Loader struct {
 	watchLast               uint32
 	accountGapLimit         int
 	disableCoinTypeUpgrades bool
-	disableMixing           bool
+	mixingEnabled           bool
 	allowHighFees           bool
 	manualTickets           bool
 	relayFee                dcrutil.Amount
@@ -55,7 +55,7 @@ type Loader struct {
 // NewLoader constructs a Loader.
 func NewLoader(chainParams *chaincfg.Params, dbDirPath string, votingEnabled bool, gapLimit uint32,
 	watchLast uint32, allowHighFees bool, relayFee dcrutil.Amount, accountGapLimit int,
-	disableCoinTypeUpgrades bool, disableMixing bool, manualTickets bool, mixSplitLimit int, dialer wallet.DialFunc) *Loader {
+	disableCoinTypeUpgrades bool, mixingEnabled bool, manualTickets bool, mixSplitLimit int, dialer wallet.DialFunc) *Loader {
 
 	return &Loader{
 		chainParams:             chainParams,
@@ -65,7 +65,7 @@ func NewLoader(chainParams *chaincfg.Params, dbDirPath string, votingEnabled boo
 		watchLast:               watchLast,
 		accountGapLimit:         accountGapLimit,
 		disableCoinTypeUpgrades: disableCoinTypeUpgrades,
-		disableMixing:           disableMixing,
+		mixingEnabled:           mixingEnabled,
 		allowHighFees:           allowHighFees,
 		manualTickets:           manualTickets,
 		relayFee:                relayFee,
@@ -172,7 +172,7 @@ func (l *Loader) CreateWatchingOnlyWallet(ctx context.Context, extendedPubKey st
 		WatchLast:               l.watchLast,
 		AccountGapLimit:         l.accountGapLimit,
 		DisableCoinTypeUpgrades: l.disableCoinTypeUpgrades,
-		DisableMixing:           l.disableMixing,
+		MixingEnabled:           l.mixingEnabled,
 		ManualTickets:           l.manualTickets,
 		AllowHighFees:           l.allowHighFees,
 		RelayFee:                l.relayFee,

internal/rpc/jsonrpc/config.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2013-2015 The btcsuite developers
+// Copyright (c) 2013-2024 The btcsuite developers
 // Use of this source code is governed by an ISC
 // license that can be found in the LICENSE file.
 
@@ -19,7 +19,7 @@ type Options struct {
 	MaxPOSTClients      int64
 	MaxWebsocketClients int64
 
-	Mixing             bool
+	MixingEnabled      bool
 	MixAccount         string
 	MixBranch          uint32
 	MixChangeAccount   string

internal/rpc/jsonrpc/methods.go

@@ -3319,7 +3319,7 @@ func (s *Server) purchaseTicket(ctx context.Context, icmd any) (any, error) {
 	// mixing is enabled).
 	var changeAccount = account
 
-	if s.cfg.Mixing {
+	if s.cfg.MixingEnabled {
 		mixedAccount, err = w.AccountNumber(ctx, s.cfg.MixAccount)
 		if err != nil {
 			return nil, rpcErrorf(dcrjson.ErrRPCInvalidParameter,
@@ -3368,7 +3368,7 @@ func (s *Server) purchaseTicket(ctx context.Context, icmd any) (any, error) {
 		DontSignTx:    dontSignTx,
 
 		// CSPP
-		Mixing:             s.cfg.Mixing,
+		Mixing:             s.cfg.MixingEnabled,
 		MixedAccount:       mixedAccount,
 		MixedAccountBranch: mixedAccountBranch,
 		MixedSplitAccount:  mixedSplitAccount,
@@ -3495,7 +3495,7 @@ func makeOutputs(pairs map[string]dcrutil.Amount, chainParams *chaincfg.Params)
 // All errors are returned in dcrjson.RPCError format
 func (s *Server) sendPairs(ctx context.Context, w *wallet.Wallet, amounts map[string]dcrutil.Amount, account uint32, minconf int32) (string, error) {
 	changeAccount := account
-	if s.cfg.Mixing && s.cfg.MixAccount != "" && s.cfg.MixChangeAccount != "" {
+	if s.cfg.MixingEnabled && s.cfg.MixAccount != "" && s.cfg.MixChangeAccount != "" {
 		mixAccount, err := w.AccountNumber(ctx, s.cfg.MixAccount)
 		if err != nil {
 			return "", err
@@ -3531,7 +3531,7 @@ func (s *Server) sendPairs(ctx context.Context, w *wallet.Wallet, amounts map[st
 // returned in dcrjson.RPCError format
 func (s *Server) sendAmountToTreasury(ctx context.Context, w *wallet.Wallet, amount dcrutil.Amount, account uint32, minconf int32) (string, error) {
 	changeAccount := account
-	if s.cfg.Mixing {
+	if s.cfg.MixingEnabled {
 		mixAccount, err := w.AccountNumber(ctx, s.cfg.MixAccount)
 		if err != nil {
 			return "", err
@@ -5505,7 +5505,7 @@ func (s *Server) mixOutput(ctx context.Context, icmd any) (any, error) {
 }
 
 func (s *Server) mixAccount(ctx context.Context, icmd any) (any, error) {
-	if !s.cfg.Mixing {
+	if !s.cfg.MixingEnabled {
 		return nil, errors.E("Mixing is not configured")
 	}
 	w, ok := s.walletLoader.LoadedWallet()

rpcserver.go

@@ -357,7 +357,7 @@ func startRPCServers(walletLoader *loader.Loader) (*grpc.Server, *jsonrpc.Server
 			Password:            pass,
 			MaxPOSTClients:      cfg.LegacyRPCMaxClients,
 			MaxWebsocketClients: cfg.LegacyRPCMaxWebsockets,
-			Mixing:              cfg.Mixing,
+			MixingEnabled:       cfg.MixingEnabled,
 			MixAccount:          cfg.mixedAccount,
 			MixBranch:           cfg.mixedBranch,
 			MixChangeAccount:    cfg.ChangeAccount,

wallet/mixing.go

@@ -270,7 +270,7 @@ func (w *Wallet) MixOutput(ctx context.Context, output *wire.OutPoint, changeAcc
 	op := errors.Opf("wallet.MixOutput(%v)", output)
 
 	// Mixing requests require wallet mixing support.
-	if !w.mixing {
+	if !w.mixingEnabled {
 		s := "wallet mixing support is disabled"
 		return errors.E(op, errors.Invalid, s)
 	}
@@ -454,7 +454,7 @@ func (w *Wallet) MixAccount(ctx context.Context, changeAccount, mixAccount,
 	const op errors.Op = "wallet.MixAccount"
 
 	// Mixing requests require wallet mixing support.
-	if !w.mixing {
+	if !w.mixingEnabled {
 		s := "wallet mixing support is disabled"
 		return errors.E(op, errors.Invalid, s)
 	}

wallet/setup_test.go

@@ -22,6 +22,7 @@ var basicWalletConfig = Config{
 	GapLimit:      20,
 	RelayFee:      dcrutil.Amount(1e5),
 	Params:        chaincfg.SimNetParams(),
+	MixingEnabled: true,
 }
 
 func testWallet(ctx context.Context, t *testing.T, cfg *Config, seed []byte) (w *Wallet, teardown func()) {

wallet/wallet.go

@@ -155,10 +155,10 @@ type Wallet struct {
 	passphraseTimeoutCancel chan struct{}
 
 	// Mixing
-	mixing    bool
-	mixpool   *mixpool.Pool
-	mixSems   mixSemaphores
-	mixClient *mixclient.Client
+	mixingEnabled bool
+	mixpool       *mixpool.Pool
+	mixSems       mixSemaphores
+	mixClient     *mixclient.Client
 
 	// Cached Blake3 anchor candidate
 	cachedBlake3WorkDiffCandidateAnchor   *wire.BlockHeader
@@ -190,7 +190,7 @@ type Config struct {
 	AccountGapLimit         int
 	MixSplitLimit           int
 	DisableCoinTypeUpgrades bool
-	DisableMixing           bool
+	MixingEnabled           bool
 
 	ManualTickets bool
 	AllowHighFees bool
@@ -1599,7 +1599,7 @@ func (w *Wallet) PurchaseTickets(ctx context.Context, n NetworkBackend,
 	// Do not attempt to split utxos for a fee payment when spending from
 	// the mixed account.  This error is rather unlikely anyways, as mixed
 	// accounts probably have very many outputs.
-	if req.Mixing && !w.mixing {
+	if req.Mixing && !w.mixingEnabled {
 		s := "wallet mixing support is disabled"
 		return nil, errors.E(op, errors.Invalid, s)
 	}
@@ -5409,8 +5409,8 @@ func Open(ctx context.Context, cfg *Config) (*Wallet, error) {
 
 		addressBuffers: make(map[uint32]*bip0044AccountData),
 
-		mixSems: newMixSemaphores(cfg.MixSplitLimit),
-		mixing:  !cfg.DisableMixing,
+		mixSems:       newMixSemaphores(cfg.MixSplitLimit),
+		mixingEnabled: cfg.MixingEnabled,
 
 		vspClients: make(map[string]*VSPClient),
 
@@ -5515,7 +5515,7 @@ func Open(ctx context.Context, cfg *Config) (*Wallet, error) {
 	// Record current tip as initialHeight.
 	_, w.initialHeight = w.MainChainTip(ctx)
 
-	if w.mixing {
+	if w.mixingEnabled {
 		w.mixpool = mixpool.NewPool((*mixpoolBlockchain)(w))
 		w.mixClient = mixclient.NewClient((*mixingWallet)(w))
 		w.mixClient.SetLogger(loggers.MixcLog)
@@ -5527,12 +5527,12 @@ func Open(ctx context.Context, cfg *Config) (*Wallet, error) {
 // MixingEnabled returns whether the wallet is enabled for mixing and is
 // running the mixing client.
 func (w *Wallet) MixingEnabled() bool {
-	return w.mixing
+	return w.mixingEnabled
 }
 
 // Run executes any necessary background goroutines for the wallet.
 func (w *Wallet) Run(ctx context.Context) error {
-	if w.mixing {
+	if w.mixingEnabled {
 		return w.mixClient.Run(ctx)
 	}
 	return nil

walletsetup.go

@@ -114,7 +114,7 @@ func createWallet(ctx context.Context, cfg *config) error {
 	dbDir := networkDir(cfg.AppDataDir.Value, activeNet.Params)
 	loader := loader.NewLoader(activeNet.Params, dbDir, cfg.EnableVoting,
 		cfg.GapLimit, cfg.WatchLast, cfg.AllowHighFees, cfg.RelayFee.Amount,
-		cfg.AccountGapLimit, cfg.DisableCoinTypeUpgrades, !cfg.Mixing,
+		cfg.AccountGapLimit, cfg.DisableCoinTypeUpgrades, cfg.MixingEnabled,
 		cfg.ManualTickets, cfg.MixSplitLimit, cfg.dial)
 
 	var privPass, pubPass, seed []byte