forked from decred/dcrwallet
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathconfig.go
1107 lines (1006 loc) · 42 KB
/
config.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (c) 2013-2016 The btcsuite developers
// Copyright (c) 2015-2020 The Decred developers
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.
package main
import (
"context"
"fmt"
"net"
"os"
"os/user"
"path/filepath"
"runtime"
"sort"
"strconv"
"strings"
"decred.org/cspp/v2/solverrpc"
"decred.org/dcrwallet/v4/errors"
"decred.org/dcrwallet/v4/internal/cfgutil"
"decred.org/dcrwallet/v4/internal/loggers"
"decred.org/dcrwallet/v4/internal/netparams"
"decred.org/dcrwallet/v4/version"
"decred.org/dcrwallet/v4/wallet"
"decred.org/dcrwallet/v4/wallet/txrules"
"github.com/decred/dcrd/connmgr/v3"
"github.com/decred/dcrd/dcrutil/v4"
"github.com/decred/dcrd/txscript/v4/stdaddr"
"github.com/decred/go-socks/socks"
"github.com/decred/slog"
flags "github.com/jessevdk/go-flags"
)
const (
// Authorization types.
authTypeBasic = "basic"
authTypeClientCert = "clientcert"
)
const (
defaultCAFilename = "dcrd.cert"
defaultConfigFilename = "dcrwallet.conf"
defaultLogLevel = "info"
defaultLogDirname = "logs"
defaultLogFilename = "dcrwallet.log"
defaultLogSize = "10M"
defaultRPCMaxClients = 10
defaultRPCMaxWebsockets = 25
defaultAuthType = authTypeBasic
defaultEnableTicketBuyer = false
defaultEnableVoting = false
defaultPurchaseAccount = "default"
defaultPromptPass = false
defaultPass = ""
defaultPromptPublicPass = false
defaultGapLimit = wallet.DefaultGapLimit
defaultStakePoolColdExtKey = ""
defaultAllowHighFees = false
defaultAccountGapLimit = wallet.DefaultAccountGapLimit
defaultDisableCoinTypeUpgrades = false
defaultCircuitLimit = 32
defaultMixSplitLimit = 10
defaultVSPMaxFee = dcrutil.Amount(0.2e8)
// ticket buyer options
defaultBalanceToMaintainAbsolute = 0
defaultTicketbuyerLimit = 1
walletDbName = "wallet.db"
)
var (
dcrdDefaultCAFile = filepath.Join(dcrutil.AppDataDir("dcrd", false), "rpc.cert")
defaultAppDataDir = dcrutil.AppDataDir("dcrwallet", false)
defaultConfigFile = filepath.Join(defaultAppDataDir, defaultConfigFilename)
defaultRPCKeyFile = filepath.Join(defaultAppDataDir, "rpc.key")
defaultRPCCertFile = filepath.Join(defaultAppDataDir, "rpc.cert")
defaultDcrdClientCertFile = filepath.Join(defaultAppDataDir, "dcrd-client.cert")
defaultDcrdClientKeyFile = filepath.Join(defaultAppDataDir, "dcrd-client.key")
defaultRPCClientCAFile = filepath.Join(defaultAppDataDir, "clients.pem")
defaultLogDir = filepath.Join(defaultAppDataDir, defaultLogDirname)
)
type config struct {
// General application behavior
ConfigFile *cfgutil.ExplicitString `short:"C" long:"configfile" description:"Path to configuration file"`
ShowVersion bool `short:"V" long:"version" description:"Display version information and exit"`
Create bool `long:"create" description:"Create new wallet"`
CreateTemp bool `long:"createtemp" description:"Create simulation wallet in nonstandard --appdata; private passphrase is 'password'"`
CreateWatchingOnly bool `long:"createwatchingonly" description:"Create watching wallet from account extended pubkey"`
AppDataDir *cfgutil.ExplicitString `short:"A" long:"appdata" description:"Application data directory for wallet config, databases and logs"`
TestNet bool `long:"testnet" description:"Use the test network"`
SimNet bool `long:"simnet" description:"Use the simulation test network"`
NoInitialLoad bool `long:"noinitialload" description:"Defer wallet creation/opening on startup and enable loading wallets over RPC"`
DebugLevel string `short:"d" long:"debuglevel" description:"Logging level {trace, debug, info, warn, error, critical}"`
LogDir *cfgutil.ExplicitString `long:"logdir" description:"Directory to log output."`
LogSize string `long:"logsize" description:"Maximum size of log file before it is rotated"`
NoFileLogging bool `long:"nofilelogging" description:"Disable file logging"`
Profile []string `long:"profile" description:"Enable HTTP profiling this interface/port"`
MemProfile string `long:"memprofile" description:"Write mem profile to the specified file"`
CPUProfile string `long:"cpuprofile" description:"Write cpu profile to the specified file"`
// Wallet options
WalletPass string `long:"walletpass" default-mask:"-" description:"Public wallet password; required when created with one"`
PromptPass bool `long:"promptpass" description:"Prompt for private passphase from terminal and unlock without timeout"`
Pass string `long:"pass" description:"Unlock with private passphrase"`
PromptPublicPass bool `long:"promptpublicpass" description:"Prompt for public passphrase from terminal"`
EnableTicketBuyer bool `long:"enableticketbuyer" description:"Enable the automatic ticket buyer"`
EnableVoting bool `long:"enablevoting" description:"Automatically vote on winning tickets"`
PurchaseAccount string `long:"purchaseaccount" description:"Account to autobuy tickets from"`
PoolAddress *cfgutil.AddressFlag `long:"pooladdress" description:"VSP fee address"`
poolAddress stdaddr.StakeAddress
PoolFees float64 `long:"poolfees" description:"VSP fee percentage (1.00 equals 1.00% fee)"`
GapLimit uint32 `long:"gaplimit" description:"Allowed unused address gap between used addresses of accounts"`
WatchLast uint32 `long:"watchlast" description:"Limit watched previous addresses of each HD account branch"`
StakePoolColdExtKey string `long:"stakepoolcoldextkey" description:"xpub:maxindex for fee addresses (VSP-only option)"`
ManualTickets bool `long:"manualtickets" description:"Do not discover new tickets through network synchronization"`
AllowHighFees bool `long:"allowhighfees" description:"Do not perform high fee checks"`
RelayFee *cfgutil.AmountFlag `long:"txfee" description:"Transaction fee per kilobyte"`
AccountGapLimit int `long:"accountgaplimit" description:"Allowed gap of unused accounts"`
DisableCoinTypeUpgrades bool `long:"disablecointypeupgrades" description:"Never upgrade from legacy to SLIP0044 coin type keys"`
// RPC client options
RPCConnect string `short:"c" long:"rpcconnect" description:"Network address of dcrd RPC server"`
CAFile *cfgutil.ExplicitString `long:"cafile" description:"dcrd RPC Certificate Authority"`
ClientCAFile *cfgutil.ExplicitString `long:"clientcafile" description:"Certficate Authority to verify TLS client certificates"`
DisableClientTLS bool `long:"noclienttls" description:"Disable TLS for dcrd RPC; only allowed when connecting to localhost"`
DcrdUsername string `long:"dcrdusername" description:"dcrd RPC username; overrides --username"`
DcrdPassword string `long:"dcrdpassword" default-mask:"-" description:"dcrd RPC password; overrides --password"`
DcrdClientCert *cfgutil.ExplicitString `long:"dcrdclientcert" description:"TLS client certificate to present to authenticate RPC connections to dcrd"`
DcrdClientKey *cfgutil.ExplicitString `long:"dcrdclientkey" description:"Key for dcrd RPC client certificate"`
DcrdAuthType string `long:"dcrdauthtype" description:"Method for dcrd JSON-RPC client authentication (basic or clientcert)"`
// Proxy and Tor settings
Proxy string `long:"proxy" description:"Establish network connections and DNS lookups through a SOCKS5 proxy (e.g. 127.0.0.1:9050)"`
ProxyUser string `long:"proxyuser" description:"Proxy server username"`
ProxyPass string `long:"proxypass" default-mask:"-" description:"Proxy server password"`
CircuitLimit int `long:"circuitlimit" description:"Set maximum number of open Tor circuits; used only when --torisolation is enabled"`
TorIsolation bool `long:"torisolation" description:"Enable Tor stream isolation by randomizing user credentials for each connection"`
NoDcrdProxy bool `long:"nodcrdproxy" description:"Never use configured proxy to dial dcrd websocket connectons"`
dial func(ctx context.Context, network, address string) (net.Conn, error)
lookup func(name string) ([]net.IP, error)
// Offline mode.
Offline bool `long:"offline" description:"Do not sync the wallet"`
// SPV options
SPV bool `long:"spv" description:"Sync using simplified payment verification"`
SPVConnect []string `long:"spvconnect" description:"SPV sync only with specified peers; disables DNS seeding"`
SPVDisableRelayTx bool `long:"spvdisablerelaytx" description:"Disable receiving mempool transactions when in SPV mode"`
// RPC server options
RPCCert *cfgutil.ExplicitString `long:"rpccert" description:"RPC server TLS certificate"`
RPCKey *cfgutil.ExplicitString `long:"rpckey" description:"RPC server TLS key"`
TLSCurve *cfgutil.CurveFlag `long:"tlscurve" description:"Curve to use when generating TLS keypairs"`
OneTimeTLSKey bool `long:"onetimetlskey" description:"Generate self-signed TLS keypairs each startup; only write certificate file"`
DisableServerTLS bool `long:"noservertls" description:"Disable TLS for the RPC servers; only allowed when binding to localhost"`
GRPCListeners []string `long:"grpclisten" description:"Listen for gRPC connections on this interface"`
LegacyRPCListeners []string `long:"rpclisten" description:"Listen for JSON-RPC connections on this interface"`
NoGRPC bool `long:"nogrpc" description:"Disable gRPC server"`
NoLegacyRPC bool `long:"nolegacyrpc" description:"Disable JSON-RPC server"`
LegacyRPCMaxClients int64 `long:"rpcmaxclients" description:"Max JSON-RPC HTTP POST clients"`
LegacyRPCMaxWebsockets int64 `long:"rpcmaxwebsockets" description:"Max JSON-RPC websocket clients"`
Username string `short:"u" long:"username" description:"JSON-RPC username and default dcrd RPC username"`
Password string `short:"P" long:"password" default-mask:"-" description:"JSON-RPC password and default dcrd RPC password"`
JSONRPCAuthType string `long:"jsonrpcauthtype" description:"Method for JSON-RPC client authentication (basic or clientcert)"`
// IPC options
PipeTx *uint `long:"pipetx" description:"File descriptor or handle of write end pipe to enable child -> parent process communication"`
PipeRx *uint `long:"piperx" description:"File descriptor or handle of read end pipe to enable parent -> child process communication"`
RPCListenerEvents bool `long:"rpclistenerevents" description:"Notify JSON-RPC and gRPC listener addresses over the TX pipe"`
IssueClientCert bool `long:"issueclientcert" description:"Notify a client cert and key over the TX pipe for RPC authentication"`
// CSPP
CSPPServer string `long:"csppserver" description:"(deprecated) Network address of CoinShuffle++ server"`
CSPPServerCA string `long:"csppserver.ca" description:"(deprecated) CoinShuffle++ TLS Certificate Authority"`
Mixing bool `long:"mixing" description:"Enable mixing support"`
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
mixedBranch uint32
TicketSplitAccount string `long:"ticketsplitaccount" description:"Account to derive fresh addresses from for mixed ticket splits; uses mixedaccount if unset"`
ChangeAccount string `long:"changeaccount" description:"Account used to derive unmixed CoinJoin outputs in CoinShuffle++ protocol"`
MixChange bool `long:"mixchange" description:"Use CoinShuffle++ to mix change account outputs into mix account"`
MixSplitLimit int `long:"mixsplitlimit" description:"Connection limit to CoinShuffle++ server per change amount"`
TBOpts ticketBuyerOptions `group:"Ticket Buyer Options" namespace:"ticketbuyer"`
VSPOpts vspOptions `group:"VSP Options" namespace:"vsp"`
}
type ticketBuyerOptions struct {
BalanceToMaintainAbsolute *cfgutil.AmountFlag `long:"balancetomaintainabsolute" description:"Amount of funds to keep in wallet when purchasing tickets"`
VotingAddress *cfgutil.AddressFlag `long:"votingaddress" description:"Purchase tickets with voting rights assigned to this address"`
votingAddress stdaddr.StakeAddress
Limit uint `long:"limit" description:"Buy no more than specified number of tickets per block"`
VotingAccount string `long:"votingaccount" description:"Account used to derive addresses specifying voting rights"`
}
type vspOptions struct {
// VSP - TODO: VSPServer to a []string to support multiple VSPs
URL string `long:"url" description:"Base URL of the VSP server"`
PubKey string `long:"pubkey" description:"VSP server pubkey"`
Sync bool `long:"sync" description:"sync tickets to vsp"`
MaxFee *cfgutil.AmountFlag `long:"maxfee" description:"Maximum VSP fee"`
}
// cleanAndExpandPath expands environement variables and leading ~ in the
// passed path, cleans the result, and returns it.
func cleanAndExpandPath(path string) string {
// Do not try to clean the empty string
if path == "" {
return ""
}
// NOTE: The os.ExpandEnv doesn't work with Windows cmd.exe-style
// %VARIABLE%, but they variables can still be expanded via POSIX-style
// $VARIABLE.
path = os.ExpandEnv(path)
if !strings.HasPrefix(path, "~") {
return filepath.Clean(path)
}
// Expand initial ~ to the current user's home directory, or ~otheruser
// to otheruser's home directory. On Windows, both forward and backward
// slashes can be used.
path = path[1:]
var pathSeparators string
if runtime.GOOS == "windows" {
pathSeparators = string(os.PathSeparator) + "/"
} else {
pathSeparators = string(os.PathSeparator)
}
userName := ""
if i := strings.IndexAny(path, pathSeparators); i != -1 {
userName = path[:i]
path = path[i:]
}
homeDir := ""
var u *user.User
var err error
if userName == "" {
u, err = user.Current()
} else {
u, err = user.Lookup(userName)
}
if err == nil {
homeDir = u.HomeDir
}
// Fallback to CWD if user lookup fails or user has no home directory.
if homeDir == "" {
homeDir = "."
}
return filepath.Join(homeDir, path)
}
// validLogLevel returns whether or not logLevel is a valid debug log level.
func validLogLevel(logLevel string) bool {
_, ok := slog.LevelFromString(logLevel)
return ok
}
// supportedSubsystems returns a sorted slice of the supported subsystems for
// logging purposes.
func supportedSubsystems() []string {
// Convert the subsystemLoggers map keys to a slice.
subsystems := make([]string, 0, len(subsystemLoggers))
for subsysID := range subsystemLoggers {
subsystems = append(subsystems, subsysID)
}
// Sort the subsytems for stable display.
sort.Strings(subsystems)
return subsystems
}
// parseAndSetDebugLevels attempts to parse the specified debug level and set
// the levels accordingly. An appropriate error is returned if anything is
// invalid.
func parseAndSetDebugLevels(debugLevel string) error {
// When the specified string doesn't have any delimters, treat it as
// the log level for all subsystems.
if !strings.Contains(debugLevel, ",") && !strings.Contains(debugLevel, "=") {
// Validate debug log level.
if !validLogLevel(debugLevel) {
str := "The specified debug level [%v] is invalid"
return errors.Errorf(str, debugLevel)
}
// Change the logging level for all subsystems.
setLogLevels(debugLevel)
return nil
}
// Split the specified string into subsystem/level pairs while detecting
// issues and update the log levels accordingly.
for _, logLevelPair := range strings.Split(debugLevel, ",") {
if !strings.Contains(logLevelPair, "=") {
str := "The specified debug level contains an invalid " +
"subsystem/level pair [%v]"
return errors.Errorf(str, logLevelPair)
}
// Extract the specified subsystem and log level.
fields := strings.Split(logLevelPair, "=")
subsysID, logLevel := fields[0], fields[1]
// Validate subsystem.
if _, exists := subsystemLoggers[subsysID]; !exists {
str := "The specified subsystem [%v] is invalid -- " +
"supported subsytems %v"
return errors.Errorf(str, subsysID, supportedSubsystems())
}
// Validate log level.
if !validLogLevel(logLevel) {
str := "The specified debug level [%v] is invalid"
return errors.Errorf(str, logLevel)
}
setLogLevel(subsysID, logLevel)
}
return nil
}
// loadConfig initializes and parses the config using a config file and command
// line options.
//
// The configuration proceeds as follows:
// 1. Start with a default config with sane settings
// 2. Pre-parse the command line to check for an alternative config file
// 3. Load configuration file overwriting defaults with any specified options
// 4. Parse CLI options and overwrite/add any specified options
//
// The above results in dcrwallet functioning properly without any config
// settings while still allowing the user to override settings with config files
// and command line options. Command line options always take precedence.
// The bool returned indicates whether or not the wallet was recreated from a
// seed and needs to perform the initial resync. The []byte is the private
// passphrase required to do the sync for this special case.
func loadConfig(ctx context.Context) (*config, []string, error) {
loadConfigError := func(err error) (*config, []string, error) {
return nil, nil, err
}
// Default config.
cfg := config{
DebugLevel: defaultLogLevel,
ConfigFile: cfgutil.NewExplicitString(defaultConfigFile),
AppDataDir: cfgutil.NewExplicitString(defaultAppDataDir),
LogDir: cfgutil.NewExplicitString(defaultLogDir),
LogSize: defaultLogSize,
WalletPass: wallet.InsecurePubPassphrase,
CAFile: cfgutil.NewExplicitString(""),
ClientCAFile: cfgutil.NewExplicitString(defaultRPCClientCAFile),
DcrdClientCert: cfgutil.NewExplicitString(defaultDcrdClientCertFile),
DcrdClientKey: cfgutil.NewExplicitString(defaultDcrdClientKeyFile),
dial: new(net.Dialer).DialContext,
lookup: net.LookupIP,
PromptPass: defaultPromptPass,
Pass: defaultPass,
PromptPublicPass: defaultPromptPublicPass,
RPCKey: cfgutil.NewExplicitString(defaultRPCKeyFile),
RPCCert: cfgutil.NewExplicitString(defaultRPCCertFile),
TLSCurve: cfgutil.NewCurveFlag(cfgutil.PreferredCurve),
LegacyRPCMaxClients: defaultRPCMaxClients,
LegacyRPCMaxWebsockets: defaultRPCMaxWebsockets,
JSONRPCAuthType: defaultAuthType,
DcrdAuthType: defaultAuthType,
EnableTicketBuyer: defaultEnableTicketBuyer,
EnableVoting: defaultEnableVoting,
PurchaseAccount: defaultPurchaseAccount,
GapLimit: defaultGapLimit,
StakePoolColdExtKey: defaultStakePoolColdExtKey,
AllowHighFees: defaultAllowHighFees,
RelayFee: cfgutil.NewAmountFlag(txrules.DefaultRelayFeePerKb),
PoolAddress: cfgutil.NewAddressFlag(),
AccountGapLimit: defaultAccountGapLimit,
DisableCoinTypeUpgrades: defaultDisableCoinTypeUpgrades,
CircuitLimit: defaultCircuitLimit,
MixSplitLimit: defaultMixSplitLimit,
CSPPSolver: cfgutil.NewExplicitString(solverrpc.SolverProcess),
// Ticket Buyer Options
TBOpts: ticketBuyerOptions{
BalanceToMaintainAbsolute: cfgutil.NewAmountFlag(defaultBalanceToMaintainAbsolute),
VotingAddress: cfgutil.NewAddressFlag(),
Limit: defaultTicketbuyerLimit,
},
VSPOpts: vspOptions{
MaxFee: cfgutil.NewAmountFlag(defaultVSPMaxFee),
},
}
// Pre-parse the command line options to see if an alternative config
// file or the version flag was specified.
preCfg := cfg
preParser := flags.NewParser(&preCfg, flags.Default)
_, err := preParser.Parse()
if err != nil {
var e *flags.Error
if errors.As(err, &e) && e.Type == flags.ErrHelp {
os.Exit(0)
}
preParser.WriteHelp(os.Stderr)
return loadConfigError(err)
}
// Show the version and exit if the version flag was specified.
funcName := "loadConfig"
appName := filepath.Base(os.Args[0])
appName = strings.TrimSuffix(appName, filepath.Ext(appName))
usageMessage := fmt.Sprintf("Use %s -h to show usage", appName)
if preCfg.ShowVersion {
fmt.Printf("%s version %s (Go version %s %s/%s)\n", appName,
version.String(), runtime.Version(), runtime.GOOS, runtime.GOARCH)
os.Exit(0)
}
// Load additional config from file.
var configFileError error
parser := flags.NewParser(&cfg, flags.Default)
configFilePath := preCfg.ConfigFile.Value
if preCfg.ConfigFile.ExplicitlySet() {
configFilePath = cleanAndExpandPath(configFilePath)
} else {
appDataDir := preCfg.AppDataDir.Value
if appDataDir != defaultAppDataDir {
configFilePath = filepath.Join(appDataDir, defaultConfigFilename)
}
}
err = flags.NewIniParser(parser).ParseFile(configFilePath)
if err != nil {
var e *os.PathError
if !errors.As(err, &e) {
fmt.Fprintln(os.Stderr, err)
parser.WriteHelp(os.Stderr)
return loadConfigError(err)
}
configFileError = err
}
// Parse command line options again to ensure they take precedence.
remainingArgs, err := parser.Parse()
if err != nil {
var e *flags.Error
if !errors.As(err, &e) || e.Type != flags.ErrHelp {
parser.WriteHelp(os.Stderr)
}
return loadConfigError(err)
}
// If an alternate data directory was specified, and paths with defaults
// relative to the data dir are unchanged, modify each path to be
// relative to the new data dir.
if cfg.AppDataDir.ExplicitlySet() {
cfg.AppDataDir.Value = cleanAndExpandPath(cfg.AppDataDir.Value)
if !cfg.RPCKey.ExplicitlySet() {
cfg.RPCKey.Value = filepath.Join(cfg.AppDataDir.Value, "rpc.key")
}
if !cfg.RPCCert.ExplicitlySet() {
cfg.RPCCert.Value = filepath.Join(cfg.AppDataDir.Value, "rpc.cert")
}
if !cfg.ClientCAFile.ExplicitlySet() {
cfg.ClientCAFile.Value = filepath.Join(cfg.AppDataDir.Value, "clients.pem")
}
if !cfg.DcrdClientCert.ExplicitlySet() {
cfg.DcrdClientCert.Value = filepath.Join(cfg.AppDataDir.Value, "dcrd-client.cert")
}
if !cfg.DcrdClientKey.ExplicitlySet() {
cfg.DcrdClientKey.Value = filepath.Join(cfg.AppDataDir.Value, "dcrd-client.key")
}
if !cfg.LogDir.ExplicitlySet() {
cfg.LogDir.Value = filepath.Join(cfg.AppDataDir.Value, defaultLogDirname)
}
}
// Choose the active network params based on the selected network.
// Multiple networks can't be selected simultaneously.
numNets := 0
if cfg.TestNet {
activeNet = &netparams.TestNet3Params
numNets++
}
if cfg.SimNet {
activeNet = &netparams.SimNetParams
numNets++
}
if numNets > 1 {
str := "%s: The testnet and simnet params can't be used " +
"together -- choose one"
err := errors.Errorf(str, "loadConfig")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if !cfg.NoFileLogging {
// Append the network type to the log directory so it is
// "namespaced" per network.
cfg.LogDir.Value = cleanAndExpandPath(cfg.LogDir.Value)
cfg.LogDir.Value = filepath.Join(cfg.LogDir.Value,
activeNet.Params.Name)
var units int
for i, r := range cfg.LogSize {
if r < '0' || r > '9' {
units = i
break
}
}
invalidSize := func() error {
str := "%s: Invalid logsize: %v "
err := errors.Errorf(str, funcName, cfg.LogSize)
fmt.Fprintln(os.Stderr, err)
return err
}
if units == 0 {
return loadConfigError(invalidSize())
}
// Parsing a 32-bit number prevents 64-bit overflow after unit
// multiplication.
logsize, err := strconv.ParseInt(cfg.LogSize[:units], 10, 32)
if err != nil {
return loadConfigError(invalidSize())
}
switch cfg.LogSize[units:] {
case "k", "K", "KiB":
case "m", "M", "MiB":
logsize <<= 10
case "g", "G", "GiB":
logsize <<= 20
default:
return loadConfigError(invalidSize())
}
// Initialize log rotation. After log rotation has been initialized, the
// logger variables may be used.
loggers.InitLogRotator(filepath.Join(cfg.LogDir.Value, defaultLogFilename), logsize)
}
// Special show command to list supported subsystems and exit.
if cfg.DebugLevel == "show" {
fmt.Println("Supported subsystems", supportedSubsystems())
os.Exit(0)
}
// Check that no addresses were created for the wrong network
for _, a := range []struct {
flag *cfgutil.AddressFlag
addr *stdaddr.StakeAddress
}{
{cfg.PoolAddress, &cfg.poolAddress},
{cfg.TBOpts.VotingAddress, &cfg.TBOpts.votingAddress},
} {
addr, err := a.flag.StakeAddress(activeNet.Params)
if err != nil {
log.Error(err)
return loadConfigError(err)
}
*a.addr = addr
}
// Parse, validate, and set debug log level(s).
if err := parseAndSetDebugLevels(cfg.DebugLevel); err != nil {
err := errors.Errorf("%s: %v", "loadConfig", err.Error())
fmt.Fprintln(os.Stderr, err)
parser.WriteHelp(os.Stderr)
return loadConfigError(err)
}
// Error and shutdown if config file is specified on the command line
// but cannot be found.
if configFileError != nil && cfg.ConfigFile.ExplicitlySet() {
if preCfg.ConfigFile.ExplicitlySet() || cfg.ConfigFile.ExplicitlySet() {
log.Errorf("%v", configFileError)
return loadConfigError(configFileError)
}
}
// Warn about missing config file after the final command line parse
// succeeds. This prevents the warning on help messages and invalid
// options.
if configFileError != nil {
log.Warnf("%v", configFileError)
}
// Sanity check BalanceToMaintainAbsolute
if cfg.TBOpts.BalanceToMaintainAbsolute.ToCoin() < 0 {
str := "%s: balancetomaintainabsolute cannot be negative: %v"
err := errors.Errorf(str, funcName, cfg.TBOpts.BalanceToMaintainAbsolute)
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
// Exit if you try to use a simulation wallet with a standard
// data directory.
if !cfg.AppDataDir.ExplicitlySet() && cfg.CreateTemp {
fmt.Fprintln(os.Stderr, "Tried to create a temporary simulation "+
"wallet, but failed to specify data directory!")
os.Exit(0)
}
// Exit if you try to use a simulation wallet on anything other than
// simnet or testnet.
if !cfg.SimNet && cfg.CreateTemp {
fmt.Fprintln(os.Stderr, "Tried to create a temporary simulation "+
"wallet for network other than simnet!")
os.Exit(0)
}
// Ensure the wallet exists or create it when the create flag is set.
netDir := networkDir(cfg.AppDataDir.Value, activeNet.Params)
dbPath := filepath.Join(netDir, walletDbName)
if cfg.CreateTemp && cfg.Create {
err := errors.Errorf("The flags --create and --createtemp can not " +
"be specified together. Use --help for more information.")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
dbFileExists, err := cfgutil.FileExists(dbPath)
if err != nil {
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if cfg.CreateTemp {
tempWalletExists := false
if dbFileExists {
str := fmt.Sprintf("The wallet already exists. Loading this " +
"wallet instead.")
fmt.Fprintln(os.Stdout, str)
tempWalletExists = true
}
// Ensure the data directory for the network exists.
if err := checkCreateDir(netDir); err != nil {
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if !tempWalletExists {
// Perform the initial wallet creation wizard.
if err := createSimulationWallet(ctx, &cfg); err != nil {
fmt.Fprintln(os.Stderr, "Unable to create wallet:", err)
return loadConfigError(err)
}
}
} else if cfg.Create || cfg.CreateWatchingOnly {
// Error if the create flag is set and the wallet already
// exists.
if dbFileExists {
err := errors.Errorf("The wallet database file `%v` "+
"already exists.", dbPath)
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
// Ensure the data directory for the network exists.
if err := checkCreateDir(netDir); err != nil {
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
// Perform the initial wallet creation wizard.
os.Stdout.Sync()
if cfg.CreateWatchingOnly {
err = createWatchingOnlyWallet(ctx, &cfg)
} else {
err = createWallet(ctx, &cfg)
}
if err != nil {
fmt.Fprintln(os.Stderr, "Unable to create wallet:", err)
return loadConfigError(err)
}
// Created successfully, so exit now with success.
os.Exit(0)
} else if !dbFileExists && !cfg.NoInitialLoad {
err := errors.Errorf("The wallet does not exist. Run with the " +
"--create option to initialize and create it.")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if cfg.PoolFees != 0.0 {
if !txrules.ValidPoolFeeRate(cfg.PoolFees) {
err := errors.E(errors.Invalid, errors.Errorf("pool fee rate %v", cfg.PoolFees))
fmt.Fprintln(os.Stderr, err.Error())
fmt.Fprintln(os.Stderr, usageMessage)
return loadConfigError(err)
}
}
ipNet := func(cidr string) net.IPNet {
_, ipNet, err := net.ParseCIDR(cidr)
if err != nil {
panic(err)
}
return *ipNet
}
privNets := []net.IPNet{
// IPv4 loopback
ipNet("127.0.0.0/8"),
// IPv6 loopback
ipNet("::1/128"),
// RFC 1918
ipNet("10.0.0.0/8"),
ipNet("172.16.0.0/12"),
ipNet("192.168.0.0/16"),
// RFC 4193
ipNet("fc00::/7"),
}
// Set dialer and DNS lookup functions if proxy settings are provided.
if cfg.Proxy != "" {
proxy := socks.Proxy{
Addr: cfg.Proxy,
Username: cfg.ProxyUser,
Password: cfg.ProxyPass,
TorIsolation: cfg.TorIsolation,
}
var proxyDialer func(context.Context, string, string) (net.Conn, error)
var noproxyDialer net.Dialer
if cfg.TorIsolation {
proxyDialer = socks.NewPool(proxy, uint32(cfg.CircuitLimit)).DialContext
} else {
proxyDialer = proxy.DialContext
}
cfg.dial = func(ctx context.Context, network, address string) (net.Conn, error) {
host, _, err := net.SplitHostPort(address)
if err != nil {
host = address
}
if host == "localhost" {
return noproxyDialer.DialContext(ctx, network, address)
}
ip := net.ParseIP(host)
if len(ip) == 4 || len(ip) == 16 {
for i := range privNets {
if privNets[i].Contains(ip) {
return noproxyDialer.DialContext(ctx, network, address)
}
}
}
conn, err := proxyDialer(ctx, network, address)
if err != nil {
return nil, errors.Errorf("proxy dial %v %v: %w", network, address, err)
}
return conn, nil
}
cfg.lookup = func(host string) ([]net.IP, error) {
ip, err := connmgr.TorLookupIP(context.Background(), host, cfg.Proxy)
if err != nil {
return nil, errors.Errorf("proxy lookup for %v: %w", host, err)
}
return ip, nil
}
}
if cfg.CSPPServer != "" {
log.Warnf("--csppserver option is deprecated; set --mixing instead")
if !cfg.Mixing {
log.Warnf("Enabling --mixing option due to --csppserver being configured")
cfg.Mixing = true
}
}
var solverMustWork bool
if cfg.Mixing {
if cfg.CSPPSolver.ExplicitlySet() {
solverrpc.SolverProcess = cfg.CSPPSolver.Value
solverMustWork = true
} else if err := solverrpc.StartSolver(); err == nil {
solverMustWork = true
} else {
log.Warnf("Unable to start csppsolver; must rely on " +
"other peers publishing results")
}
}
if solverMustWork {
if err := testStartedSolverWorks(); err != nil {
err := errors.Errorf("csppsolver process is not operating properly: %v", err)
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
}
// Parse mixedaccount account/branch
if cfg.MixedAccount != "" {
indexSlash := strings.LastIndex(cfg.MixedAccount, "/")
if indexSlash == -1 {
err := errors.Errorf("--mixedaccount must have form 'accountname/branch'")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
cfg.mixedAccount = cfg.MixedAccount[:indexSlash]
switch cfg.MixedAccount[indexSlash+1:] {
case "0":
cfg.mixedBranch = 0
case "1":
cfg.mixedBranch = 1
default:
err := errors.Errorf("--mixedaccount branch must be 0 or 1")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
}
// Use mixedaccount as default ticketsplitaccount if unset.
if cfg.TicketSplitAccount == "" {
cfg.TicketSplitAccount = cfg.mixedAccount
}
if cfg.RPCConnect == "" {
cfg.RPCConnect = net.JoinHostPort("localhost", activeNet.JSONRPCClientPort)
}
// Add default port to connect flag if missing.
cfg.RPCConnect, err = cfgutil.NormalizeAddress(cfg.RPCConnect,
activeNet.JSONRPCClientPort)
if err != nil {
fmt.Fprintf(os.Stderr,
"Invalid rpcconnect network address: %v\n", err)
return loadConfigError(err)
}
localhostListeners := map[string]struct{}{
"localhost": {},
"127.0.0.1": {},
"::1": {},
}
RPCHost, _, err := net.SplitHostPort(cfg.RPCConnect)
if err != nil {
return loadConfigError(err)
}
if cfg.DisableClientTLS {
if _, ok := localhostListeners[RPCHost]; !ok {
str := "%s: the --noclienttls option may not be used " +
"when connecting RPC to non localhost " +
"addresses: %s"
err := errors.Errorf(str, funcName, cfg.RPCConnect)
fmt.Fprintln(os.Stderr, err)
fmt.Fprintln(os.Stderr, usageMessage)
return loadConfigError(err)
}
} else {
// If CAFile is unset, choose either the copy or local dcrd cert.
if !cfg.CAFile.ExplicitlySet() {
cfg.CAFile.Value = filepath.Join(cfg.AppDataDir.Value, defaultCAFilename)
// If the CA copy does not exist, check if we're connecting to
// a local dcrd and switch to its RPC cert if it exists.
certExists, err := cfgutil.FileExists(cfg.CAFile.Value)
if err != nil {
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if !certExists {
if _, ok := localhostListeners[RPCHost]; ok {
dcrdCertExists, err := cfgutil.FileExists(
dcrdDefaultCAFile)
if err != nil {
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if dcrdCertExists {
cfg.CAFile.Value = dcrdDefaultCAFile
}
}
}
}
}
if cfg.SPV && cfg.Offline {
err := errors.E("SPV and Offline mode cannot be specified at the same time")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if cfg.SPV && cfg.EnableVoting {
err := errors.E("SPV voting is not possible: disable --spv or --enablevoting")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
if !cfg.SPV && len(cfg.SPVConnect) > 0 {
err := errors.E("--spvconnect requires --spv")
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
for i, p := range cfg.SPVConnect {
cfg.SPVConnect[i], err = cfgutil.NormalizeAddress(p, activeNet.Params.DefaultPort)
if err != nil {
return loadConfigError(err)
}
}
// Default to localhost listen addresses if no listeners were manually
// specified. When the RPC server is configured to be disabled, remove all
// listeners so it is not started.
localhostAddrs, err := net.LookupHost("localhost")
if err != nil {
return loadConfigError(err)
}
if len(cfg.GRPCListeners) == 0 && !cfg.NoGRPC {
cfg.GRPCListeners = make([]string, 0, len(localhostAddrs))
for _, addr := range localhostAddrs {
cfg.GRPCListeners = append(cfg.GRPCListeners,
net.JoinHostPort(addr, activeNet.GRPCServerPort))
}
} else if cfg.NoGRPC {
cfg.GRPCListeners = nil
}
if len(cfg.LegacyRPCListeners) == 0 && !cfg.NoLegacyRPC {
cfg.LegacyRPCListeners = make([]string, 0, len(localhostAddrs))
for _, addr := range localhostAddrs {
cfg.LegacyRPCListeners = append(cfg.LegacyRPCListeners,
net.JoinHostPort(addr, activeNet.JSONRPCServerPort))
}
} else if cfg.NoLegacyRPC {
cfg.LegacyRPCListeners = nil
}
// Add default port to all rpc listener addresses if needed and remove
// duplicate addresses.
cfg.LegacyRPCListeners, err = cfgutil.NormalizeAddresses(
cfg.LegacyRPCListeners, activeNet.JSONRPCServerPort)
if err != nil {
fmt.Fprintf(os.Stderr,
"Invalid network address in legacy RPC listeners: %v\n", err)
return loadConfigError(err)
}
cfg.GRPCListeners, err = cfgutil.NormalizeAddresses(
cfg.GRPCListeners, activeNet.GRPCServerPort)
if err != nil {
fmt.Fprintf(os.Stderr,
"Invalid network address in RPC listeners: %v\n", err)
return loadConfigError(err)
}
// Both RPC servers may not listen on the same interface/port, with the
// exception of listeners using port 0.
if len(cfg.LegacyRPCListeners) > 0 && len(cfg.GRPCListeners) > 0 {
seenAddresses := make(map[string]struct{}, len(cfg.LegacyRPCListeners))
for _, addr := range cfg.LegacyRPCListeners {
seenAddresses[addr] = struct{}{}
}
for _, addr := range cfg.GRPCListeners {
_, seen := seenAddresses[addr]
if seen && !strings.HasSuffix(addr, ":0") {
err := errors.Errorf("Address `%s` may not be "+
"used as a listener address for both "+
"RPC servers", addr)
fmt.Fprintln(os.Stderr, err)
return loadConfigError(err)
}
}
}
// Only allow server TLS to be disabled if the RPC server is bound to
// localhost addresses.
if cfg.DisableServerTLS {
allListeners := append(cfg.LegacyRPCListeners, cfg.GRPCListeners...)
for _, addr := range allListeners {
host, _, err := net.SplitHostPort(addr)
if err != nil {
str := "%s: RPC listen interface '%s' is " +
"invalid: %v"
err := errors.Errorf(str, funcName, addr, err)
fmt.Fprintln(os.Stderr, err)
fmt.Fprintln(os.Stderr, usageMessage)
return loadConfigError(err)
}
if _, ok := localhostListeners[host]; !ok {
str := "%s: the --noservertls option may not be used " +
"when binding RPC to non localhost " +
"addresses: %s"
err := errors.Errorf(str, funcName, addr)
fmt.Fprintln(os.Stderr, err)
fmt.Fprintln(os.Stderr, usageMessage)
return loadConfigError(err)
}
}
}