2017-01-11 16:00:16 +01:00
// Copyright (c) 2013-2017 The btcsuite developers
2013-08-06 23:55:22 +02:00
// Use of this source code is governed by an ISC
// license that can be found in the LICENSE file.
package main
import (
2016-06-04 04:14:15 +02:00
"bufio"
"crypto/rand"
"encoding/base64"
2021-02-14 15:49:11 +01:00
"encoding/hex"
2013-12-17 16:10:59 +01:00
"errors"
2013-08-06 23:55:22 +02:00
"fmt"
2016-06-04 04:14:15 +02:00
"io"
2013-08-06 23:55:22 +02:00
"net"
"os"
"path/filepath"
2013-11-20 16:35:14 +01:00
"runtime"
2013-11-22 00:03:01 +01:00
"sort"
2013-09-17 23:40:27 +02:00
"strconv"
2013-08-08 01:53:01 +02:00
"strings"
2013-08-06 23:55:22 +02:00
"time"
2014-07-02 15:50:08 +02:00
2016-10-19 18:57:23 +02:00
"github.com/btcsuite/btcd/blockchain"
2016-12-02 00:54:41 +01:00
"github.com/btcsuite/btcd/chaincfg"
"github.com/btcsuite/btcd/chaincfg/chainhash"
2016-05-12 11:06:07 +02:00
"github.com/btcsuite/btcd/connmgr"
2015-08-26 11:54:55 +02:00
"github.com/btcsuite/btcd/database"
_ "github.com/btcsuite/btcd/database/ffldb"
2016-08-19 18:08:37 +02:00
"github.com/btcsuite/btcd/mempool"
2018-08-24 07:49:26 +02:00
"github.com/btcsuite/btcd/peer"
2015-01-15 17:30:38 +01:00
"github.com/btcsuite/btcutil"
2015-01-16 08:21:57 +01:00
"github.com/btcsuite/go-socks/socks"
2016-12-09 18:54:33 +01:00
flags "github.com/jessevdk/go-flags"
2013-08-06 23:55:22 +02:00
)
const (
2018-05-23 23:25:07 +02:00
defaultConfigFilename = "chain.conf"
2016-04-11 23:37:52 +02:00
defaultDataDirname = "data"
defaultLogLevel = "info"
defaultLogDirname = "logs"
2018-05-23 23:25:07 +02:00
defaultLogFilename = "chain.log"
2016-04-11 23:37:52 +02:00
defaultMaxPeers = 125
defaultBanDuration = time . Hour * 24
defaultBanThreshold = 100
2017-01-11 22:54:37 +01:00
defaultConnectTimeout = time . Second * 30
2016-04-11 23:37:52 +02:00
defaultMaxRPCClients = 10
defaultMaxRPCWebsockets = 25
2016-04-26 00:51:42 +02:00
defaultMaxRPCConcurrentReqs = 20
2015-08-26 06:03:18 +02:00
defaultDbType = "ffldb"
2016-04-11 23:37:52 +02:00
defaultFreeTxRelayLimit = 15.0
2018-08-24 07:49:26 +02:00
defaultTrickleInterval = peer . DefaultTrickleInterval
2016-04-11 23:37:52 +02:00
defaultBlockMinSize = 0
defaultBlockMaxSize = 750000
2016-10-19 18:57:23 +02:00
defaultBlockMinWeight = 0
defaultBlockMaxWeight = 3000000
2016-04-11 23:37:52 +02:00
blockMaxSizeMin = 1000
2016-10-19 18:57:23 +02:00
blockMaxSizeMax = blockchain . MaxBlockBaseSize - 1000
blockMaxWeightMin = 4000
blockMaxWeightMax = blockchain . MaxBlockWeight - 4000
2016-04-11 23:37:52 +02:00
defaultGenerate = false
2016-10-25 07:07:21 +02:00
defaultMaxOrphanTransactions = 100
2016-10-19 04:21:55 +02:00
defaultMaxOrphanTxSize = 100000
2016-04-14 04:56:10 +02:00
defaultSigCacheMaxSize = 100000
2018-05-23 23:25:07 +02:00
sampleConfigFilename = "sample-chain.conf"
2016-02-19 05:51:18 +01:00
defaultTxIndex = false
defaultAddrIndex = false
2013-08-06 23:55:22 +02:00
)
var (
2018-05-23 23:25:07 +02:00
defaultHomeDir = btcutil . AppDataDir ( "chain" , false )
2016-09-12 21:58:28 +02:00
defaultConfigFile = filepath . Join ( defaultHomeDir , defaultConfigFilename )
defaultDataDir = filepath . Join ( defaultHomeDir , defaultDataDirname )
2015-08-26 06:03:18 +02:00
knownDbTypes = database . SupportedDrivers ( )
2016-09-12 21:58:28 +02:00
defaultRPCKeyFile = filepath . Join ( defaultHomeDir , "rpc.key" )
defaultRPCCertFile = filepath . Join ( defaultHomeDir , "rpc.cert" )
defaultLogDir = filepath . Join ( defaultHomeDir , defaultLogDirname )
2013-08-06 23:55:22 +02:00
)
2013-11-26 03:58:18 +01:00
// runServiceCommand is only set to a real function on Windows. It is used
// to parse and execute service commands specified via the -s flag.
var runServiceCommand func ( string ) error
peer: Refactor peer code into its own package.
This commit introduces package peer which contains peer related features
refactored from peer.go.
The following is an overview of the features the package provides:
- Provides a basic concurrent safe bitcoin peer for handling bitcoin
communications via the peer-to-peer protocol
- Full duplex reading and writing of bitcoin protocol messages
- Automatic handling of the initial handshake process including protocol
version negotiation
- Automatic periodic keep-alive pinging and pong responses
- Asynchronous message queueing of outbound messages with optional
channel for notification when the message is actually sent
- Inventory message batching and send trickling with known inventory
detection and avoidance
- Ability to wait for shutdown/disconnect
- Flexible peer configuration
- Caller is responsible for creating outgoing connections and listening
for incoming connections so they have flexibility to establish
connections as they see fit (proxies, etc.)
- User agent name and version
- Bitcoin network
- Service support signalling (full nodes, bloom filters, etc.)
- Maximum supported protocol version
- Ability to register callbacks for handling bitcoin protocol messages
- Proper handling of bloom filter related commands when the caller does
not specify the related flag to signal support
- Disconnects the peer when the protocol version is high enough
- Does not invoke the related callbacks for older protocol versions
- Snapshottable peer statistics such as the total number of bytes read
and written, the remote address, user agent, and negotiated protocol
version
- Helper functions for pushing addresses, getblocks, getheaders, and
reject messages
- These could all be sent manually via the standard message output
function, but the helpers provide additional nice functionality such
as duplicate filtering and address randomization
- Full documentation with example usage
- Test coverage
In addition to the addition of the new package, btcd has been refactored
to make use of the new package by extending the basic peer it provides to
work with the blockmanager and server to act as a full node. The
following is a broad overview of the changes to integrate the package:
- The server is responsible for all connection management including
persistent peers and banning
- Callbacks for all messages that are required to implement a full node
are registered
- Logic necessary to serve data and behave as a full node is now in the
callback registered with the peer
Finally, the following peer-related things have been improved as a part
of this refactor:
- Don't log or send reject message due to peer disconnects
- Remove trace logs that aren't particularly helpful
- Finish an old TODO to switch the queue WaitGroup over to a channel
- Improve various comments and fix some code consistency cases
- Improve a few logging bits
- Implement a most-recently-used nonce tracking for detecting self
connections and generate a unique nonce for each peer
2015-10-02 08:03:20 +02:00
// minUint32 is a helper function to return the minimum of two uint32s.
// This avoids a math import and the need to cast to floats.
func minUint32 ( a , b uint32 ) uint32 {
if a < b {
return a
}
return b
}
2013-08-06 23:55:22 +02:00
// config defines the configuration options for btcd.
//
// See loadConfig for details on the configuration load process.
type config struct {
2020-04-14 10:58:45 +02:00
AddCheckpoints [ ] string ` long:"addcheckpoint" description:"Add a custom checkpoint. Format: '<height>:<hash>'" `
2016-04-26 00:51:42 +02:00
AddPeers [ ] string ` short:"a" long:"addpeer" description:"Add a peer to connect with at startup" `
2020-04-14 10:58:45 +02:00
AddrIndex bool ` long:"addrindex" description:"Maintain a full address-based transaction index which makes the searchrawtransactions RPC available" `
2020-04-14 13:35:22 +02:00
AgentBlacklist [ ] string ` long:"agentblacklist" description:"A comma separated list of user-agent substrings which will cause btcd to reject any peers whose user-agent contains any of the blacklisted substrings." `
AgentWhitelist [ ] string ` long:"agentwhitelist" description:"A comma separated list of user-agent substrings which will cause btcd to require all peers' user-agents to contain one of the whitelisted substrings. The blacklist is applied before the blacklist, and an empty whitelist will allow all agents that do not fail the blacklist." `
2020-04-14 10:58:45 +02:00
BanDuration time . Duration ` long:"banduration" description:"How long to ban misbehaving peers. Valid time units are { s, m, h}. Minimum 1 second" `
BanThreshold uint32 ` long:"banthreshold" description:"Maximum allowed ban score before disconnecting and banning misbehaving peers." `
BlockMaxSize uint32 ` long:"blockmaxsize" description:"Maximum block size in bytes to be used when creating a block" `
BlockMinSize uint32 ` long:"blockminsize" description:"Mininum block size in bytes to be used when creating a block" `
BlockMaxWeight uint32 ` long:"blockmaxweight" description:"Maximum block weight to be used when creating a block" `
BlockMinWeight uint32 ` long:"blockminweight" description:"Mininum block weight to be used when creating a block" `
BlockPrioritySize uint32 ` long:"blockprioritysize" description:"Size in bytes for high-priority/low-fee transactions when creating a block" `
BlocksOnly bool ` long:"blocksonly" description:"Do not accept transactions from remote peers." `
ConfigFile string ` short:"C" long:"configfile" description:"Path to configuration file" `
2021-07-12 22:09:32 +02:00
ClaimTrieImpl string ` long:"clmtimpl" description:"Implementation of ClaimTrie" `
ClaimTrieRecord bool ` long:"clmtrecord" description:"Record claim operations made to ClaimTrie" `
ClaimTrieHeight uint32 ` long:"clmtheight" description:"Reset height of ClaimTrie" `
2016-04-26 00:51:42 +02:00
ConnectPeers [ ] string ` long:"connect" description:"Connect only to the specified peers at startup" `
2020-04-14 10:58:45 +02:00
CPUProfile string ` long:"cpuprofile" description:"Write CPU profile to the specified file" `
DataDir string ` short:"b" long:"datadir" description:"Directory to store data" `
DbType string ` long:"dbtype" description:"Database backend to use for the Block Chain" `
DebugLevel string ` short:"d" long:"debuglevel" description:"Logging level for all subsystems { trace, debug, info, warn, error, critical} -- You may also specify <subsystem>=<level>,<subsystem2>=<level>,... to set the log level for individual subsystems -- Use show to list available subsystems" `
DropAddrIndex bool ` long:"dropaddrindex" description:"Deletes the address-based transaction index from the database on start up and then exits." `
DropCfIndex bool ` long:"dropcfindex" description:"Deletes the index used for committed filtering (CF) support from the database on start up and then exits." `
DropTxIndex bool ` long:"droptxindex" description:"Deletes the hash-based transaction index from the database on start up and then exits." `
ExternalIPs [ ] string ` long:"externalip" description:"Add an ip to the list of local addresses we claim to listen on to peers" `
Generate bool ` long:"generate" description:"Generate (mine) bitcoins using the CPU" `
FreeTxRelayLimit float64 ` long:"limitfreerelay" description:"Limit relay of transactions with no transaction fee to the given amount in thousands of bytes per minute" `
2016-04-26 00:51:42 +02:00
Listeners [ ] string ` long:"listen" description:"Add an interface/port to listen for connections (default all interfaces port: 8333, testnet: 18333)" `
2020-04-14 10:58:45 +02:00
LogDir string ` long:"logdir" description:"Directory to log output." `
MaxOrphanTxs int ` long:"maxorphantx" description:"Max number of orphan transactions to keep in memory" `
2016-04-26 00:51:42 +02:00
MaxPeers int ` long:"maxpeers" description:"Max number of inbound and outbound peers" `
2020-04-14 10:58:45 +02:00
MiningAddrs [ ] string ` long:"miningaddr" description:"Add the specified payment address to the list of addresses to use for generated blocks -- At least one address is required if the generate option is set" `
MinRelayTxFee float64 ` long:"minrelaytxfee" description:"The minimum transaction fee in BTC/kB to be considered a non-zero fee." `
2016-04-26 00:51:42 +02:00
DisableBanning bool ` long:"nobanning" description:"Disable banning of misbehaving peers" `
2020-04-14 10:58:45 +02:00
NoCFilters bool ` long:"nocfilters" description:"Disable committed filtering (CF) support" `
DisableCheckpoints bool ` long:"nocheckpoints" description:"Disable built-in checkpoints. Don't do this unless you know what you're doing." `
DisableDNSSeed bool ` long:"nodnsseed" description:"Disable DNS seeding for peers" `
DisableListen bool ` long:"nolisten" description:"Disable listening for incoming connections -- NOTE: Listening is automatically disabled if the --connect or --proxy options are used without also specifying listen interfaces via --listen" `
NoOnion bool ` long:"noonion" description:"Disable connecting to tor hidden services" `
NoPeerBloomFilters bool ` long:"nopeerbloomfilters" description:"Disable bloom filtering support" `
NoRelayPriority bool ` long:"norelaypriority" description:"Do not require free or low-fee transactions to have high priority for relaying" `
2020-07-22 09:57:15 +02:00
NoWinService bool ` long:"nowinservice" description:"Do not start as a background service on Windows -- NOTE: This flag only works on the command line, not in the config file" `
2016-04-26 00:51:42 +02:00
DisableRPC bool ` long:"norpc" description:"Disable built-in RPC server -- NOTE: The RPC server is disabled by default if no rpcuser/rpcpass or rpclimituser/rpclimitpass is specified" `
DisableTLS bool ` long:"notls" description:"Disable TLS for the RPC server -- NOTE: This is only allowed if the RPC server is bound to localhost" `
OnionProxy string ` long:"onion" description:"Connect to tor hidden services via SOCKS5 proxy (eg. 127.0.0.1:9050)" `
OnionProxyPass string ` long:"onionpass" default-mask:"-" description:"Password for onion proxy server" `
2020-04-14 10:58:45 +02:00
OnionProxyUser string ` long:"onionuser" description:"Username for onion proxy server" `
Profile string ` long:"profile" description:"Enable HTTP profiling on given port -- NOTE port must be between 1024 and 65536" `
Proxy string ` long:"proxy" description:"Connect via SOCKS5 proxy (eg. 127.0.0.1:9050)" `
ProxyPass string ` long:"proxypass" default-mask:"-" description:"Password for proxy server" `
ProxyUser string ` long:"proxyuser" description:"Username for proxy server" `
2016-04-26 00:51:42 +02:00
RegressionTest bool ` long:"regtest" description:"Use the regression test network" `
2020-04-14 10:58:45 +02:00
RejectNonStd bool ` long:"rejectnonstd" description:"Reject non-standard transactions regardless of the default settings for the active network." `
RejectReplacement bool ` long:"rejectreplacement" description:"Reject transactions that attempt to replace existing transactions within the mempool through the Replace-By-Fee (RBF) signaling policy." `
RelayNonStd bool ` long:"relaynonstd" description:"Relay non-standard transactions regardless of the default settings for the active network." `
RPCCert string ` long:"rpccert" description:"File containing the certificate file" `
RPCKey string ` long:"rpckey" description:"File containing the certificate key" `
RPCLimitPass string ` long:"rpclimitpass" default-mask:"-" description:"Password for limited RPC connections" `
RPCLimitUser string ` long:"rpclimituser" description:"Username for limited RPC connections" `
RPCListeners [ ] string ` long:"rpclisten" description:"Add an interface/port to listen for RPC connections (default port: 8334, testnet: 18334)" `
RPCMaxClients int ` long:"rpcmaxclients" description:"Max number of RPC clients for standard connections" `
RPCMaxConcurrentReqs int ` long:"rpcmaxconcurrentreqs" description:"Max number of concurrent RPC requests that may be processed concurrently" `
RPCMaxWebsockets int ` long:"rpcmaxwebsockets" description:"Max number of RPC websocket connections" `
RPCQuirks bool ` long:"rpcquirks" description:"Mirror some JSON-RPC quirks of Bitcoin Core -- NOTE: Discouraged unless interoperability issues need to be worked around" `
RPCPass string ` short:"P" long:"rpcpass" default-mask:"-" description:"Password for RPC connections" `
RPCUser string ` short:"u" long:"rpcuser" description:"Username for RPC connections" `
SigCacheMaxSize uint ` long:"sigcachemaxsize" description:"The maximum number of entries in the signature verification cache" `
2016-04-26 00:51:42 +02:00
SimNet bool ` long:"simnet" description:"Use the simulation test network" `
2021-02-14 15:49:11 +01:00
SigNet bool ` long:"signet" description:"Use the signet test network" `
SigNetChallenge string ` long:"signetchallenge" description:"Connect to a custom signet network defined by this challenge instead of using the global default signet test network -- Can be specified multiple times" `
SigNetSeedNode [ ] string ` long:"signetseednode" description:"Specify a seed node for the signet network instead of using the global default signet network seed nodes" `
2020-04-14 10:58:45 +02:00
TestNet3 bool ` long:"testnet" description:"Use the test network" `
TorIsolation bool ` long:"torisolation" description:"Enable Tor stream isolation by randomizing user credentials for each connection." `
2018-08-24 07:49:26 +02:00
TrickleInterval time . Duration ` long:"trickleinterval" description:"Minimum time between attempts to send new inventory to a connected peer" `
2016-04-26 00:51:42 +02:00
TxIndex bool ` long:"txindex" description:"Maintain a full hash-based transaction index which makes all transactions available via the getrawtransaction RPC" `
2020-04-14 10:58:45 +02:00
UserAgentComments [ ] string ` long:"uacomment" description:"Comment to add to the user agent -- See BIP 14 for more information." `
Upnp bool ` long:"upnp" description:"Use UPnP to map our listening port outside of NAT" `
ShowVersion bool ` short:"V" long:"version" description:"Display version information and exit" `
Whitelists [ ] string ` long:"whitelist" description:"Add an IP network or IP that will not be banned. (eg. 192.168.1.0/24 or ::1)" `
2016-04-26 00:51:42 +02:00
lookup func ( string ) ( [ ] net . IP , error )
2017-01-11 22:54:37 +01:00
oniondial func ( string , string , time . Duration ) ( net . Conn , error )
dial func ( string , string , time . Duration ) ( net . Conn , error )
2016-12-02 00:54:41 +01:00
addCheckpoints [ ] chaincfg . Checkpoint
2016-04-26 00:51:42 +02:00
miningAddrs [ ] btcutil . Address
minRelayTxFee btcutil . Amount
2017-08-31 15:59:43 +02:00
whitelists [ ] * net . IPNet
2013-08-06 23:55:22 +02:00
}
2016-09-12 21:58:28 +02:00
// serviceOptions defines the configuration options for the daemon as a service on
2013-11-20 16:35:14 +01:00
// Windows.
type serviceOptions struct {
ServiceCommand string ` short:"s" long:"service" description:"Service command { install, remove, start, stop}" `
}
2014-09-08 21:19:47 +02:00
// cleanAndExpandPath expands environment variables and leading ~ in the
2013-09-18 07:13:36 +02:00
// passed path, cleans the result, and returns it.
func cleanAndExpandPath ( path string ) string {
// Expand initial ~ to OS specific home directory.
if strings . HasPrefix ( path , "~" ) {
2016-09-12 21:58:28 +02:00
homeDir := filepath . Dir ( defaultHomeDir )
2013-09-18 07:13:36 +02:00
path = strings . Replace ( path , "~" , homeDir , 1 )
}
// NOTE: The os.ExpandEnv doesn't work with Windows-style %VARIABLE%,
// but they variables can still be expanded via POSIX-style $VARIABLE.
return filepath . Clean ( os . ExpandEnv ( path ) )
}
2013-08-06 23:55:22 +02:00
// validLogLevel returns whether or not logLevel is a valid debug log level.
func validLogLevel ( logLevel string ) bool {
switch logLevel {
case "trace" :
fallthrough
case "debug" :
fallthrough
case "info" :
fallthrough
case "warn" :
fallthrough
case "error" :
fallthrough
case "critical" :
return true
}
return false
}
2013-11-22 00:03:01 +01:00
// 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 )
}
2016-02-25 18:17:12 +01:00
// Sort the subsystems for stable display.
2013-11-22 00:03:01 +01:00
sort . Strings ( subsystems )
return subsystems
}
2013-11-22 17:46:56 +01:00
// 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 {
2013-11-22 00:03:01 +01:00
// 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 fmt . Errorf ( str , debugLevel )
}
2013-11-22 19:44:49 +01:00
// Change the logging level for all subsystems.
setLogLevels ( debugLevel )
2013-11-22 00:03:01 +01:00
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 fmt . 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 {
2013-11-22 17:46:56 +01:00
str := "The specified subsystem [%v] is invalid -- " +
"supported subsytems %v"
return fmt . Errorf ( str , subsysID , supportedSubsystems ( ) )
2013-11-22 00:03:01 +01:00
}
// Validate log level.
if ! validLogLevel ( logLevel ) {
str := "The specified debug level [%v] is invalid"
return fmt . Errorf ( str , logLevel )
}
setLogLevel ( subsysID , logLevel )
}
return nil
}
2013-09-15 19:08:42 +02:00
// validDbType returns whether or not dbType is a supported database type.
func validDbType ( dbType string ) bool {
for _ , knownType := range knownDbTypes {
if dbType == knownType {
return true
}
}
return false
}
2013-08-06 23:55:22 +02:00
// removeDuplicateAddresses returns a new slice with all duplicate entries in
// addrs removed.
func removeDuplicateAddresses ( addrs [ ] string ) [ ] string {
2014-07-02 17:14:36 +02:00
result := make ( [ ] string , 0 , len ( addrs ) )
2014-07-02 16:45:17 +02:00
seen := map [ string ] struct { } { }
2013-08-06 23:55:22 +02:00
for _ , val := range addrs {
if _ , ok := seen [ val ] ; ! ok {
result = append ( result , val )
2014-07-02 16:45:17 +02:00
seen [ val ] = struct { } { }
2013-08-06 23:55:22 +02:00
}
}
return result
}
2013-09-19 17:46:33 +02:00
// normalizeAddress returns addr with the passed default port appended if
// there is not already a port specified.
func normalizeAddress ( addr , defaultPort string ) string {
_ , _ , err := net . SplitHostPort ( addr )
if err != nil {
return net . JoinHostPort ( addr , defaultPort )
}
return addr
}
// normalizeAddresses returns a new slice with all the passed peer addresses
// normalized with the given default port, and all duplicates removed.
func normalizeAddresses ( addrs [ ] string , defaultPort string ) [ ] string {
2013-08-06 23:55:22 +02:00
for i , addr := range addrs {
2013-09-19 17:46:33 +02:00
addrs [ i ] = normalizeAddress ( addr , defaultPort )
2013-08-06 23:55:22 +02:00
}
2013-09-19 17:46:33 +02:00
return removeDuplicateAddresses ( addrs )
}
2016-12-02 00:54:41 +01:00
// newCheckpointFromStr parses checkpoints in the '<height>:<hash>' format.
func newCheckpointFromStr ( checkpoint string ) ( chaincfg . Checkpoint , error ) {
parts := strings . Split ( checkpoint , ":" )
if len ( parts ) != 2 {
2017-01-18 23:58:38 +01:00
return chaincfg . Checkpoint { } , fmt . Errorf ( "unable to parse " +
"checkpoint %q -- use the syntax <height>:<hash>" ,
checkpoint )
2016-12-02 00:54:41 +01:00
}
height , err := strconv . ParseInt ( parts [ 0 ] , 10 , 32 )
if err != nil {
2017-01-18 23:58:38 +01:00
return chaincfg . Checkpoint { } , fmt . Errorf ( "unable to parse " +
"checkpoint %q due to malformed height" , checkpoint )
2016-12-02 00:54:41 +01:00
}
2017-01-18 23:58:38 +01:00
if len ( parts [ 1 ] ) == 0 {
return chaincfg . Checkpoint { } , fmt . Errorf ( "unable to parse " +
"checkpoint %q due to missing hash" , checkpoint )
}
2016-12-02 00:54:41 +01:00
hash , err := chainhash . NewHashFromStr ( parts [ 1 ] )
if err != nil {
2017-01-18 23:58:38 +01:00
return chaincfg . Checkpoint { } , fmt . Errorf ( "unable to parse " +
"checkpoint %q due to malformed hash" , checkpoint )
2016-12-02 00:54:41 +01:00
}
return chaincfg . Checkpoint {
Height : int32 ( height ) ,
Hash : hash ,
} , nil
}
// parseCheckpoints checks the checkpoint strings for valid syntax
// ('<height>:<hash>') and parses them to chaincfg.Checkpoint instances.
func parseCheckpoints ( checkpointStrings [ ] string ) ( [ ] chaincfg . Checkpoint , error ) {
if len ( checkpointStrings ) == 0 {
return nil , nil
}
checkpoints := make ( [ ] chaincfg . Checkpoint , len ( checkpointStrings ) )
for i , cpString := range checkpointStrings {
checkpoint , err := newCheckpointFromStr ( cpString )
if err != nil {
return nil , err
}
checkpoints [ i ] = checkpoint
}
return checkpoints , nil
}
2013-08-06 23:55:22 +02:00
// filesExists reports whether the named file or directory exists.
func fileExists ( name string ) bool {
if _ , err := os . Stat ( name ) ; err != nil {
if os . IsNotExist ( err ) {
return false
}
}
return true
}
2013-11-20 16:35:14 +01:00
// newConfigParser returns a new command line flags parser.
func newConfigParser ( cfg * config , so * serviceOptions , options flags . Options ) * flags . Parser {
parser := flags . NewParser ( cfg , options )
if runtime . GOOS == "windows" {
parser . AddGroup ( "Service Options" , "Service Options" , so )
}
return parser
}
2013-08-06 23:55:22 +02:00
// 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 btcd 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.
func loadConfig ( ) ( * config , [ ] string , error ) {
// Default config.
cfg := config {
2016-04-26 00:51:42 +02:00
ConfigFile : defaultConfigFile ,
DebugLevel : defaultLogLevel ,
MaxPeers : defaultMaxPeers ,
BanDuration : defaultBanDuration ,
BanThreshold : defaultBanThreshold ,
RPCMaxClients : defaultMaxRPCClients ,
RPCMaxWebsockets : defaultMaxRPCWebsockets ,
RPCMaxConcurrentReqs : defaultMaxRPCConcurrentReqs ,
DataDir : defaultDataDir ,
LogDir : defaultLogDir ,
DbType : defaultDbType ,
RPCKey : defaultRPCKeyFile ,
RPCCert : defaultRPCCertFile ,
MinRelayTxFee : mempool . DefaultMinRelayTxFee . ToBTC ( ) ,
FreeTxRelayLimit : defaultFreeTxRelayLimit ,
2018-08-24 07:49:26 +02:00
TrickleInterval : defaultTrickleInterval ,
2016-04-26 00:51:42 +02:00
BlockMinSize : defaultBlockMinSize ,
BlockMaxSize : defaultBlockMaxSize ,
2016-10-19 18:57:23 +02:00
BlockMinWeight : defaultBlockMinWeight ,
BlockMaxWeight : defaultBlockMaxWeight ,
2016-04-26 00:51:42 +02:00
BlockPrioritySize : mempool . DefaultBlockPrioritySize ,
MaxOrphanTxs : defaultMaxOrphanTransactions ,
SigCacheMaxSize : defaultSigCacheMaxSize ,
Generate : defaultGenerate ,
TxIndex : defaultTxIndex ,
AddrIndex : defaultAddrIndex ,
2013-08-06 23:55:22 +02:00
}
2013-11-20 16:35:14 +01:00
// Service options which are only added on Windows.
serviceOpts := serviceOptions { }
2013-08-06 23:55:22 +02:00
// Pre-parse the command line options to see if an alternative config
2014-08-20 03:06:03 +02:00
// file or the version flag was specified. Any errors aside from the
// help message error can be ignored here since they will be caught by
// the final parse below.
2013-08-06 23:55:22 +02:00
preCfg := cfg
2014-08-20 03:06:03 +02:00
preParser := newConfigParser ( & preCfg , & serviceOpts , flags . HelpFlag )
2014-12-21 22:53:33 +01:00
_ , err := preParser . Parse ( )
2014-08-20 03:06:03 +02:00
if err != nil {
if e , ok := err . ( * flags . Error ) ; ok && e . Type == flags . ErrHelp {
fmt . Fprintln ( os . Stderr , err )
return nil , nil , err
}
}
2013-08-06 23:55:22 +02:00
2013-08-08 01:53:01 +02:00
// Show the version and exit if the version flag was specified.
2014-07-15 03:27:22 +02:00
appName := filepath . Base ( os . Args [ 0 ] )
appName = strings . TrimSuffix ( appName , filepath . Ext ( appName ) )
usageMessage := fmt . Sprintf ( "Use %s -h to show usage" , appName )
2013-08-08 01:53:01 +02:00
if preCfg . ShowVersion {
fmt . Println ( appName , "version" , version ( ) )
os . Exit ( 0 )
}
2013-11-20 16:35:14 +01:00
// Perform service command and exit if specified. Invalid service
// commands show an appropriate error. Only runs on Windows since
// the runServiceCommand function will be nil when not on Windows.
if serviceOpts . ServiceCommand != "" && runServiceCommand != nil {
err := runServiceCommand ( serviceOpts . ServiceCommand )
if err != nil {
fmt . Fprintln ( os . Stderr , err )
}
os . Exit ( 0 )
}
2013-08-06 23:55:22 +02:00
// Load additional config from file.
2013-11-24 19:33:36 +01:00
var configFileError error
2013-11-20 16:35:14 +01:00
parser := newConfigParser ( & cfg , & serviceOpts , flags . Default )
2021-02-14 15:49:11 +01:00
if ! ( preCfg . RegressionTest || preCfg . SimNet || preCfg . SigNet ) ||
preCfg . ConfigFile != defaultConfigFile {
2014-05-28 22:19:38 +02:00
2016-06-04 04:14:15 +02:00
if _ , err := os . Stat ( preCfg . ConfigFile ) ; os . IsNotExist ( err ) {
err := createDefaultConfigFile ( preCfg . ConfigFile )
if err != nil {
2016-09-12 09:21:37 +02:00
fmt . Fprintf ( os . Stderr , "Error creating a " +
"default config file: %v\n" , err )
2016-06-04 04:14:15 +02:00
}
}
2013-11-24 19:33:36 +01:00
err := flags . NewIniParser ( parser ) . ParseFile ( preCfg . ConfigFile )
2013-11-15 21:42:53 +01:00
if err != nil {
if _ , ok := err . ( * os . PathError ) ; ! ok {
2014-07-15 03:27:22 +02:00
fmt . Fprintf ( os . Stderr , "Error parsing config " +
"file: %v\n" , err )
fmt . Fprintln ( os . Stderr , usageMessage )
2013-11-15 21:42:53 +01:00
return nil , nil , err
}
2013-11-24 19:33:36 +01:00
configFileError = err
2013-08-06 23:55:22 +02:00
}
}
2013-08-17 21:44:43 +02:00
// Don't add peers from the config file when in regression test mode.
if preCfg . RegressionTest && len ( cfg . AddPeers ) > 0 {
cfg . AddPeers = nil
}
2013-08-06 23:55:22 +02:00
// Parse command line options again to ensure they take precedence.
remainingArgs , err := parser . Parse ( )
if err != nil {
if e , ok := err . ( * flags . Error ) ; ! ok || e . Type != flags . ErrHelp {
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2013-08-06 23:55:22 +02:00
}
return nil , nil , err
}
2014-12-21 22:53:33 +01:00
// Create the home directory if it doesn't already exist.
2014-06-07 21:42:54 +02:00
funcName := "loadConfig"
2016-09-12 21:58:28 +02:00
err = os . MkdirAll ( defaultHomeDir , 0700 )
2014-12-21 22:53:33 +01:00
if err != nil {
// Show a nicer error message if it's because a symlink is
// linked to a directory that does not exist (probably because
// it's not mounted).
if e , ok := err . ( * os . PathError ) ; ok && os . IsExist ( err ) {
if link , lerr := os . Readlink ( e . Path ) ; lerr == nil {
str := "is symlink %s -> %s mounted?"
err = fmt . Errorf ( str , e . Path , link )
}
}
str := "%s: Failed to create home directory: %v"
err := fmt . Errorf ( str , funcName , err )
fmt . Fprintln ( os . Stderr , err )
return nil , nil , err
}
// Multiple networks can't be selected simultaneously.
2014-05-28 22:19:38 +02:00
numNets := 0
2014-07-21 07:42:41 +02:00
// Count number of network flags passed; assign active network params
// while we're at it
2014-05-28 22:19:38 +02:00
if cfg . TestNet3 {
numNets ++
2014-07-21 07:42:41 +02:00
activeNetParams = & testNet3Params
2014-05-28 22:19:38 +02:00
}
if cfg . RegressionTest {
numNets ++
2014-07-21 07:42:41 +02:00
activeNetParams = & regressionNetParams
2014-05-28 22:19:38 +02:00
}
if cfg . SimNet {
numNets ++
2014-07-21 07:42:41 +02:00
// Also disable dns seeding on the simulation test network.
activeNetParams = & simNetParams
cfg . DisableDNSSeed = true
2014-05-28 22:19:38 +02:00
}
2021-02-14 15:49:11 +01:00
if cfg . SigNet {
numNets ++
activeNetParams = & sigNetParams
// Let the user overwrite the default signet parameters. The
// challenge defines the actual signet network to join and the
// seed nodes are needed for network discovery.
sigNetChallenge := chaincfg . DefaultSignetChallenge
sigNetSeeds := chaincfg . DefaultSignetDNSSeeds
if cfg . SigNetChallenge != "" {
challenge , err := hex . DecodeString ( cfg . SigNetChallenge )
if err != nil {
str := "%s: Invalid signet challenge, hex " +
"decode failed: %v"
err := fmt . Errorf ( str , funcName , err )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
sigNetChallenge = challenge
}
if len ( cfg . SigNetSeedNode ) > 0 {
sigNetSeeds = make (
[ ] chaincfg . DNSSeed , len ( cfg . SigNetSeedNode ) ,
)
for idx , seed := range cfg . SigNetSeedNode {
sigNetSeeds [ idx ] = chaincfg . DNSSeed {
Host : seed ,
HasFiltering : false ,
}
}
}
chainParams := chaincfg . CustomSignetParams (
sigNetChallenge , sigNetSeeds ,
)
activeNetParams . Params = & chainParams
}
2014-05-28 22:19:38 +02:00
if numNets > 1 {
2021-02-14 15:49:11 +01:00
str := "%s: The testnet, regtest, segnet, signet and simnet " +
"params can't be used together -- choose one of the " +
"five"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName )
2013-08-06 23:55:22 +02:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2013-08-06 23:55:22 +02:00
return nil , nil , err
}
2016-08-23 03:02:53 +02:00
// Set the default policy for relaying non-standard transactions
// according to the default of the active network. The set
// configuration value takes precedence over the default value for the
// selected network.
relayNonStd := activeNetParams . RelayNonStdTxs
switch {
case cfg . RelayNonStd && cfg . RejectNonStd :
str := "%s: rejectnonstd and relaynonstd cannot be used " +
"together -- choose only one"
err := fmt . Errorf ( str , funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
case cfg . RejectNonStd :
relayNonStd = false
case cfg . RelayNonStd :
relayNonStd = true
}
cfg . RelayNonStd = relayNonStd
2014-02-12 22:43:27 +01:00
// Append the network type to the data directory so it is "namespaced"
// per network. In addition to the block database, there are other
// pieces of data that are saved to disk such as address manager state.
// All data is specific to a network, so namespacing the data directory
// means each individual piece of serialized data does not have to
// worry about changing names per network and such.
cfg . DataDir = cleanAndExpandPath ( cfg . DataDir )
2014-05-23 06:14:36 +02:00
cfg . DataDir = filepath . Join ( cfg . DataDir , netName ( activeNetParams ) )
2014-02-12 22:43:27 +01:00
// Append the network type to the log directory so it is "namespaced"
// per network in the same fashion as the data directory.
cfg . LogDir = cleanAndExpandPath ( cfg . LogDir )
2014-05-23 06:14:36 +02:00
cfg . LogDir = filepath . Join ( cfg . LogDir , netName ( activeNetParams ) )
2014-02-12 22:43:27 +01:00
2013-11-22 17:46:56 +01:00
// Special show command to list supported subsystems and exit.
if cfg . DebugLevel == "show" {
fmt . Println ( "Supported subsystems" , supportedSubsystems ( ) )
os . Exit ( 0 )
}
2017-05-24 23:24:06 +02:00
// Initialize log rotation. After log rotation has been initialized, the
// logger variables may be used.
initLogRotator ( filepath . Join ( cfg . LogDir , defaultLogFilename ) )
2014-02-12 22:43:27 +01:00
2013-11-22 00:03:01 +01:00
// Parse, validate, and set debug log level(s).
2013-11-22 17:46:56 +01:00
if err := parseAndSetDebugLevels ( cfg . DebugLevel ) ; err != nil {
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( "%s: %v" , funcName , err . Error ( ) )
2013-08-06 23:55:22 +02:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2013-08-06 23:55:22 +02:00
return nil , nil , err
}
2013-09-15 19:08:42 +02:00
// Validate database type.
if ! validDbType ( cfg . DbType ) {
str := "%s: The specified database type [%v] is invalid -- " +
"supported types %v"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName , cfg . DbType , knownDbTypes )
2013-09-15 19:08:42 +02:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2013-09-15 19:08:42 +02:00
return nil , nil , err
}
2013-09-17 23:40:27 +02:00
// Validate profile port number
2013-09-17 23:46:03 +02:00
if cfg . Profile != "" {
2013-09-18 00:04:40 +02:00
profilePort , err := strconv . Atoi ( cfg . Profile )
if err != nil || profilePort < 1024 || profilePort > 65535 {
str := "%s: The profile port must be between 1024 and 65535"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName )
2013-09-18 00:04:40 +02:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2013-09-18 00:04:40 +02:00
return nil , nil , err
}
2013-09-17 23:40:27 +02:00
}
2013-08-06 23:55:22 +02:00
// Don't allow ban durations that are too short.
2016-11-03 00:18:48 +01:00
if cfg . BanDuration < time . Second {
2013-08-06 23:55:22 +02:00
str := "%s: The banduration option may not be less than 1s -- parsed [%v]"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName , cfg . BanDuration )
2013-08-06 23:55:22 +02:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2013-08-06 23:55:22 +02:00
return nil , nil , err
}
2017-08-31 15:59:43 +02:00
// Validate any given whitelisted IP addresses and networks.
if len ( cfg . Whitelists ) > 0 {
var ip net . IP
cfg . whitelists = make ( [ ] * net . IPNet , 0 , len ( cfg . Whitelists ) )
for _ , addr := range cfg . Whitelists {
_ , ipnet , err := net . ParseCIDR ( addr )
if err != nil {
ip = net . ParseIP ( addr )
if ip == nil {
str := "%s: The whitelist value of '%s' is invalid"
err = fmt . Errorf ( str , funcName , addr )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
var bits int
if ip . To4 ( ) == nil {
// IPv6
bits = 128
} else {
bits = 32
}
ipnet = & net . IPNet {
IP : ip ,
Mask : net . CIDRMask ( bits , bits ) ,
}
}
cfg . whitelists = append ( cfg . whitelists , ipnet )
}
}
2013-08-06 23:55:22 +02:00
// --addPeer and --connect do not mix.
if len ( cfg . AddPeers ) > 0 && len ( cfg . ConnectPeers ) > 0 {
str := "%s: the --addpeer and --connect options can not be " +
"mixed"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName )
2013-08-06 23:55:22 +02:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2013-08-06 23:55:22 +02:00
return nil , nil , err
}
2013-09-19 17:46:33 +02:00
// --proxy or --connect without --listen disables listening.
if ( cfg . Proxy != "" || len ( cfg . ConnectPeers ) > 0 ) &&
len ( cfg . Listeners ) == 0 {
2013-08-08 18:11:39 +02:00
cfg . DisableListen = true
}
2013-09-19 17:46:33 +02:00
// Connect means no DNS seeding.
2013-08-06 23:55:22 +02:00
if len ( cfg . ConnectPeers ) > 0 {
cfg . DisableDNSSeed = true
2013-09-19 17:46:33 +02:00
}
// Add the default listener if none were specified. The default
// listener is all addresses on the listen port for the network
// we are to connect to.
if len ( cfg . Listeners ) == 0 {
cfg . Listeners = [ ] string {
2014-05-29 19:35:09 +02:00
net . JoinHostPort ( "" , activeNetParams . DefaultPort ) ,
2013-09-19 17:46:33 +02:00
}
2013-08-06 23:55:22 +02:00
}
2015-03-30 19:45:31 +02:00
// Check to make sure limited and admin users don't have the same username
if cfg . RPCUser == cfg . RPCLimitUser && cfg . RPCUser != "" {
str := "%s: --rpcuser and --rpclimituser must not specify the " +
"same username"
err := fmt . Errorf ( str , funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
// Check to make sure limited and admin users don't have the same password
if cfg . RPCPass == cfg . RPCLimitPass && cfg . RPCPass != "" {
str := "%s: --rpcpass and --rpclimitpass must not specify the " +
"same password"
err := fmt . Errorf ( str , funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2013-08-07 18:02:31 +02:00
// The RPC server is disabled if no username or password is provided.
2015-03-30 19:45:31 +02:00
if ( cfg . RPCUser == "" || cfg . RPCPass == "" ) &&
( cfg . RPCLimitUser == "" || cfg . RPCLimitPass == "" ) {
2013-09-18 07:36:40 +02:00
cfg . DisableRPC = true
2017-08-19 09:43:10 +02:00
}
if cfg . DisableRPC {
btcdLog . Infof ( "RPC service is disabled" )
2013-08-07 18:02:31 +02:00
}
2013-11-20 00:33:07 +01:00
// Default RPC to listen on localhost only.
if ! cfg . DisableRPC && len ( cfg . RPCListeners ) == 0 {
addrs , err := net . LookupHost ( "localhost" )
if err != nil {
return nil , nil , err
2013-11-14 02:51:37 +01:00
}
2013-11-20 00:33:07 +01:00
cfg . RPCListeners = make ( [ ] string , 0 , len ( addrs ) )
for _ , addr := range addrs {
addr = net . JoinHostPort ( addr , activeNetParams . rpcPort )
cfg . RPCListeners = append ( cfg . RPCListeners , addr )
}
2013-11-14 02:51:37 +01:00
}
2016-04-26 00:51:42 +02:00
if cfg . RPCMaxConcurrentReqs < 0 {
str := "%s: The rpcmaxwebsocketconcurrentrequests option may " +
"not be less than 0 -- parsed [%d]"
err := fmt . Errorf ( str , funcName , cfg . RPCMaxConcurrentReqs )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2015-10-19 22:21:31 +02:00
// Validate the the minrelaytxfee.
cfg . minRelayTxFee , err = btcutil . NewAmount ( cfg . MinRelayTxFee )
if err != nil {
str := "%s: invalid minrelaytxfee: %v"
err := fmt . Errorf ( str , funcName , err )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2014-03-02 11:33:56 +01:00
// Limit the max block size to a sane value.
if cfg . BlockMaxSize < blockMaxSizeMin || cfg . BlockMaxSize >
blockMaxSizeMax {
str := "%s: The blockmaxsize option must be in between %d " +
"and %d -- parsed [%d]"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName , blockMaxSizeMin ,
2014-03-02 11:33:56 +01:00
blockMaxSizeMax , cfg . BlockMaxSize )
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2015-05-05 16:53:15 +02:00
return nil , nil , err
}
2016-10-19 18:57:23 +02:00
// Limit the max block weight to a sane value.
if cfg . BlockMaxWeight < blockMaxWeightMin ||
cfg . BlockMaxWeight > blockMaxWeightMax {
str := "%s: The blockmaxweight option must be in between %d " +
"and %d -- parsed [%d]"
err := fmt . Errorf ( str , funcName , blockMaxWeightMin ,
blockMaxWeightMax , cfg . BlockMaxWeight )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
// Limit the max orphan count to a sane vlue.
2015-05-05 16:53:15 +02:00
if cfg . MaxOrphanTxs < 0 {
str := "%s: The maxorphantx option may not be less than 0 " +
"-- parsed [%d]"
err := fmt . Errorf ( str , funcName , cfg . MaxOrphanTxs )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
2014-03-02 11:33:56 +01:00
return nil , nil , err
}
// Limit the block priority and minimum block sizes to max block size.
cfg . BlockPrioritySize = minUint32 ( cfg . BlockPrioritySize , cfg . BlockMaxSize )
cfg . BlockMinSize = minUint32 ( cfg . BlockMinSize , cfg . BlockMaxSize )
2016-10-19 18:57:23 +02:00
cfg . BlockMinWeight = minUint32 ( cfg . BlockMinWeight , cfg . BlockMaxWeight )
switch {
// If the max block size isn't set, but the max weight is, then we'll
// set the limit for the max block size to a safe limit so weight takes
// precedence.
case cfg . BlockMaxSize == defaultBlockMaxSize &&
cfg . BlockMaxWeight != defaultBlockMaxWeight :
cfg . BlockMaxSize = blockchain . MaxBlockBaseSize - 1000
// If the max block weight isn't set, but the block size is, then we'll
// scale the set weight accordingly based on the max block size value.
case cfg . BlockMaxSize != defaultBlockMaxSize &&
cfg . BlockMaxWeight == defaultBlockMaxWeight :
cfg . BlockMaxWeight = cfg . BlockMaxSize * blockchain . WitnessScaleFactor
}
2014-03-02 11:33:56 +01:00
2017-04-14 03:08:05 +02:00
// Look for illegal characters in the user agent comments.
for _ , uaComment := range cfg . UserAgentComments {
if strings . ContainsAny ( uaComment , "/:()" ) {
err := fmt . Errorf ( "%s: The following characters must not " +
"appear in user agent comments: '/', ':', '(', ')'" ,
funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
}
2016-02-19 05:51:18 +01:00
// --txindex and --droptxindex do not mix.
if cfg . TxIndex && cfg . DropTxIndex {
err := fmt . Errorf ( "%s: the --txindex and --droptxindex " +
"options may not be activated at the same time" ,
funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
// --addrindex and --dropaddrindex do not mix.
if cfg . AddrIndex && cfg . DropAddrIndex {
err := fmt . Errorf ( "%s: the --addrindex and --dropaddrindex " +
"options may not be activated at the same time" ,
funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
// --addrindex and --droptxindex do not mix.
if cfg . AddrIndex && cfg . DropTxIndex {
err := fmt . Errorf ( "%s: the --addrindex and --droptxindex " +
"options may not be activated at the same time " +
"because the address index relies on the transaction " +
"index" ,
funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2014-06-12 03:09:38 +02:00
// Check mining addresses are valid and saved parsed versions.
2017-01-11 16:00:16 +01:00
cfg . miningAddrs = make ( [ ] btcutil . Address , 0 , len ( cfg . MiningAddrs ) )
2014-06-12 03:09:38 +02:00
for _ , strAddr := range cfg . MiningAddrs {
2014-05-28 00:44:55 +02:00
addr , err := btcutil . DecodeAddress ( strAddr , activeNetParams . Params )
2014-03-20 08:06:10 +01:00
if err != nil {
2014-06-12 03:09:38 +02:00
str := "%s: mining address '%s' failed to decode: %v"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName , strAddr , err )
2014-03-20 08:06:10 +01:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2014-03-20 08:06:10 +01:00
return nil , nil , err
}
2014-05-28 00:44:55 +02:00
if ! addr . IsForNet ( activeNetParams . Params ) {
2014-06-12 03:09:38 +02:00
str := "%s: mining address '%s' is on the wrong network"
2014-06-07 21:42:54 +02:00
err := fmt . Errorf ( str , funcName , strAddr )
2014-03-20 08:06:10 +01:00
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2014-03-20 08:06:10 +01:00
return nil , nil , err
}
2014-06-12 03:09:38 +02:00
cfg . miningAddrs = append ( cfg . miningAddrs , addr )
}
// Ensure there is at least one mining address when the generate flag is
// set.
if cfg . Generate && len ( cfg . MiningAddrs ) == 0 {
str := "%s: the generate flag is set, but there are no mining " +
"addresses specified "
err := fmt . Errorf ( str , funcName )
fmt . Fprintln ( os . Stderr , err )
2014-07-15 03:27:22 +02:00
fmt . Fprintln ( os . Stderr , usageMessage )
2014-06-12 03:09:38 +02:00
return nil , nil , err
2014-03-20 08:06:10 +01:00
}
2013-11-14 02:51:37 +01:00
// Add default port to all listener addresses if needed and remove
// duplicate addresses.
cfg . Listeners = normalizeAddresses ( cfg . Listeners ,
2014-05-29 19:35:09 +02:00
activeNetParams . DefaultPort )
2013-11-14 02:51:37 +01:00
// Add default port to all rpc listener addresses if needed and remove
2013-09-19 17:46:33 +02:00
// duplicate addresses.
2013-11-14 02:51:37 +01:00
cfg . RPCListeners = normalizeAddresses ( cfg . RPCListeners ,
activeNetParams . rpcPort )
2013-09-19 17:46:33 +02:00
2014-12-21 01:04:07 +01:00
// Only allow TLS to be disabled if the RPC is bound to localhost
// addresses.
if ! cfg . DisableRPC && cfg . DisableTLS {
allowedTLSListeners := map [ string ] struct { } {
2016-02-25 17:47:46 +01:00
"localhost" : { } ,
"127.0.0.1" : { } ,
"::1" : { } ,
2014-12-21 01:04:07 +01:00
}
for _ , addr := range cfg . RPCListeners {
host , _ , err := net . SplitHostPort ( addr )
if err != nil {
str := "%s: RPC listen interface '%s' is " +
"invalid: %v"
err := fmt . Errorf ( str , funcName , addr , err )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
if _ , ok := allowedTLSListeners [ host ] ; ! ok {
str := "%s: the --notls option may not be used " +
"when binding RPC to non localhost " +
"addresses: %s"
err := fmt . Errorf ( str , funcName , addr )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
}
}
2013-08-06 23:55:22 +02:00
// Add default port to all added peer addresses if needed and remove
// duplicate addresses.
2013-11-14 02:51:37 +01:00
cfg . AddPeers = normalizeAddresses ( cfg . AddPeers ,
2014-05-29 19:35:09 +02:00
activeNetParams . DefaultPort )
2013-11-14 02:51:37 +01:00
cfg . ConnectPeers = normalizeAddresses ( cfg . ConnectPeers ,
2014-05-29 19:35:09 +02:00
activeNetParams . DefaultPort )
2013-08-06 23:55:22 +02:00
2016-12-06 18:35:55 +01:00
// --noonion and --onion do not mix.
if cfg . NoOnion && cfg . OnionProxy != "" {
err := fmt . Errorf ( "%s: the --noonion and --onion options may " +
"not be activated at the same time" , funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2016-12-02 00:54:41 +01:00
// Check the checkpoints for syntax errors.
cfg . addCheckpoints , err = parseCheckpoints ( cfg . AddCheckpoints )
if err != nil {
str := "%s: Error parsing checkpoints: %v"
err := fmt . Errorf ( str , funcName , err )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2015-05-13 22:34:33 +02:00
// Tor stream isolation requires either proxy or onion proxy to be set.
if cfg . TorIsolation && cfg . Proxy == "" && cfg . OnionProxy == "" {
str := "%s: Tor stream isolation requires either proxy or " +
"onionproxy to be set"
err := fmt . Errorf ( str , funcName )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2014-01-10 08:52:15 +01:00
// Setup dial and DNS resolution (lookup) functions depending on the
2017-01-11 22:54:37 +01:00
// specified options. The default is to use the standard
// net.DialTimeout function as well as the system DNS resolver. When a
// proxy is specified, the dial function is set to the proxy specific
// dial function and the lookup is set to use tor (unless --noonion is
2014-01-10 08:52:15 +01:00
// specified in which case the system DNS resolver is used).
2017-01-11 22:54:37 +01:00
cfg . dial = net . DialTimeout
2013-12-17 16:10:59 +01:00
cfg . lookup = net . LookupIP
if cfg . Proxy != "" {
2015-05-13 22:34:33 +02:00
_ , _ , err := net . SplitHostPort ( cfg . Proxy )
if err != nil {
str := "%s: Proxy address '%s' is invalid: %v"
err := fmt . Errorf ( str , funcName , cfg . Proxy , err )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2016-12-06 18:35:55 +01:00
// Tor isolation flag means proxy credentials will be overridden
// unless there is also an onion proxy configured in which case
// that one will be overridden.
torIsolation := false
if cfg . TorIsolation && cfg . OnionProxy == "" &&
2015-05-13 22:34:33 +02:00
( cfg . ProxyUser != "" || cfg . ProxyPass != "" ) {
2016-12-06 18:35:55 +01:00
torIsolation = true
2016-09-12 09:21:37 +02:00
fmt . Fprintln ( os . Stderr , "Tor isolation set -- " +
"overriding specified proxy user credentials" )
2015-05-13 22:34:33 +02:00
}
2013-12-17 16:10:59 +01:00
proxy := & socks . Proxy {
2015-05-13 22:34:33 +02:00
Addr : cfg . Proxy ,
Username : cfg . ProxyUser ,
Password : cfg . ProxyPass ,
2016-12-06 18:35:55 +01:00
TorIsolation : torIsolation ,
2013-12-17 16:10:59 +01:00
}
2017-01-11 22:54:37 +01:00
cfg . dial = proxy . DialTimeout
2016-12-06 18:35:55 +01:00
// Treat the proxy as tor and perform DNS resolution through it
// unless the --noonion flag is set or there is an
// onion-specific proxy configured.
if ! cfg . NoOnion && cfg . OnionProxy == "" {
2013-12-17 16:10:59 +01:00
cfg . lookup = func ( host string ) ( [ ] net . IP , error ) {
2016-05-12 11:06:07 +02:00
return connmgr . TorLookupIP ( host , cfg . Proxy )
2013-12-17 16:10:59 +01:00
}
}
}
2014-01-10 08:52:15 +01:00
2016-12-06 18:35:55 +01:00
// Setup onion address dial function depending on the specified options.
// The default is to use the same dial function selected above. However,
// when an onion-specific proxy is specified, the onion address dial
// function is set to use the onion-specific proxy while leaving the
// normal dial function as selected above. This allows .onion address
// traffic to be routed through a different proxy than normal traffic.
2013-12-17 16:10:59 +01:00
if cfg . OnionProxy != "" {
2015-05-13 22:34:33 +02:00
_ , _ , err := net . SplitHostPort ( cfg . OnionProxy )
if err != nil {
str := "%s: Onion proxy address '%s' is invalid: %v"
err := fmt . Errorf ( str , funcName , cfg . OnionProxy , err )
fmt . Fprintln ( os . Stderr , err )
fmt . Fprintln ( os . Stderr , usageMessage )
return nil , nil , err
}
2016-12-06 18:35:55 +01:00
// Tor isolation flag means onion proxy credentials will be
// overridden.
2015-05-13 22:34:33 +02:00
if cfg . TorIsolation &&
( cfg . OnionProxyUser != "" || cfg . OnionProxyPass != "" ) {
2016-09-12 09:21:37 +02:00
fmt . Fprintln ( os . Stderr , "Tor isolation set -- " +
"overriding specified onionproxy user " +
"credentials " )
2015-05-13 22:34:33 +02:00
}
2016-12-06 18:35:55 +01:00
cfg . oniondial = func ( network , addr string , timeout time . Duration ) ( net . Conn , error ) {
2013-12-17 16:10:59 +01:00
proxy := & socks . Proxy {
2015-05-13 22:34:33 +02:00
Addr : cfg . OnionProxy ,
Username : cfg . OnionProxyUser ,
Password : cfg . OnionProxyPass ,
TorIsolation : cfg . TorIsolation ,
2013-12-17 16:10:59 +01:00
}
2016-12-06 18:35:55 +01:00
return proxy . DialTimeout ( network , addr , timeout )
2013-12-17 16:10:59 +01:00
}
2016-12-06 18:35:55 +01:00
// When configured in bridge mode (both --onion and --proxy are
// configured), it means that the proxy configured by --proxy is
// not a tor proxy, so override the DNS resolution to use the
// onion-specific proxy.
if cfg . Proxy != "" {
cfg . lookup = func ( host string ) ( [ ] net . IP , error ) {
return connmgr . TorLookupIP ( host , cfg . OnionProxy )
}
2013-12-17 16:10:59 +01:00
}
} else {
cfg . oniondial = cfg . dial
}
2016-12-06 18:35:55 +01:00
// Specifying --noonion means the onion address dial function results in
// an error.
2013-12-17 16:10:59 +01:00
if cfg . NoOnion {
2017-01-11 22:54:37 +01:00
cfg . oniondial = func ( a , b string , t time . Duration ) ( net . Conn , error ) {
2013-12-17 16:10:59 +01:00
return nil , errors . New ( "tor has been disabled" )
}
}
2014-01-10 08:34:50 +01:00
// Warn about missing config file only after all other configuration is
// done. This prevents the warning on help messages and invalid
// options. Note this should go directly before the return.
if configFileError != nil {
btcdLog . Warnf ( "%v" , configFileError )
}
2013-08-06 23:55:22 +02:00
return & cfg , remainingArgs , nil
}
2013-12-17 16:10:59 +01:00
2016-06-04 04:14:15 +02:00
// createDefaultConfig copies the file sample-btcd.conf to the given destination path,
// and populates it with some randomly generated RPC username and password.
func createDefaultConfigFile ( destinationPath string ) error {
// Create the destination directory if it does not exists
2016-09-12 21:58:28 +02:00
err := os . MkdirAll ( filepath . Dir ( destinationPath ) , 0700 )
if err != nil {
return err
}
2016-06-04 04:14:15 +02:00
2016-09-12 21:58:28 +02:00
// We assume sample config file path is same as binary
path , err := filepath . Abs ( filepath . Dir ( os . Args [ 0 ] ) )
if err != nil {
return err
}
sampleConfigPath := filepath . Join ( path , sampleConfigFilename )
2016-06-04 04:14:15 +02:00
// We generate a random user and password
randomBytes := make ( [ ] byte , 20 )
2016-09-12 21:58:28 +02:00
_ , err = rand . Read ( randomBytes )
2016-06-04 04:14:15 +02:00
if err != nil {
return err
}
generatedRPCUser := base64 . StdEncoding . EncodeToString ( randomBytes )
_ , err = rand . Read ( randomBytes )
if err != nil {
return err
}
generatedRPCPass := base64 . StdEncoding . EncodeToString ( randomBytes )
src , err := os . Open ( sampleConfigPath )
if err != nil {
return err
}
defer src . Close ( )
2016-09-12 21:58:28 +02:00
dest , err := os . OpenFile ( destinationPath ,
os . O_RDWR | os . O_CREATE | os . O_TRUNC , 0600 )
2016-06-04 04:14:15 +02:00
if err != nil {
return err
}
defer dest . Close ( )
// We copy every line from the sample config file to the destination,
// only replacing the two lines for rpcuser and rpcpass
reader := bufio . NewReader ( src )
for err != io . EOF {
var line string
line , err = reader . ReadString ( '\n' )
if err != nil && err != io . EOF {
return err
}
if strings . Contains ( line , "rpcuser=" ) {
2016-11-03 00:18:48 +01:00
line = "rpcuser=" + generatedRPCUser + "\n"
2016-06-04 04:14:15 +02:00
} else if strings . Contains ( line , "rpcpass=" ) {
2016-11-03 00:18:48 +01:00
line = "rpcpass=" + generatedRPCPass + "\n"
2016-06-04 04:14:15 +02:00
}
if _ , err := dest . WriteString ( line ) ; err != nil {
return err
}
}
return nil
}
2014-01-10 08:31:20 +01:00
// btcdDial connects to the address on the named network using the appropriate
// dial function depending on the address and configuration options. For
// example, .onion addresses will be dialed using the onion specific proxy if
// one was specified, but will otherwise use the normal dial function (which
// could itself use a proxy or not).
2016-11-03 22:23:13 +01:00
func btcdDial ( addr net . Addr ) ( net . Conn , error ) {
if strings . Contains ( addr . String ( ) , ".onion:" ) {
2017-01-11 22:54:37 +01:00
return cfg . oniondial ( addr . Network ( ) , addr . String ( ) ,
defaultConnectTimeout )
2013-12-17 16:10:59 +01:00
}
2017-01-11 22:54:37 +01:00
return cfg . dial ( addr . Network ( ) , addr . String ( ) , defaultConnectTimeout )
2013-12-17 16:10:59 +01:00
}
2016-12-06 18:35:55 +01:00
// btcdLookup resolves the IP of the given host using the correct DNS lookup
// function depending on the configuration options. For example, addresses will
// be resolved using tor when the --proxy flag was specified unless --noonion
// was also specified in which case the normal system DNS resolver will be used.
//
// Any attempt to resolve a tor address (.onion) will return an error since they
// are not intended to be resolved outside of the tor proxy.
2014-01-10 08:31:20 +01:00
func btcdLookup ( host string ) ( [ ] net . IP , error ) {
2013-12-17 16:10:59 +01:00
if strings . HasSuffix ( host , ".onion" ) {
2016-12-06 18:35:55 +01:00
return nil , fmt . Errorf ( "attempt to resolve tor address %s" , host )
2013-12-17 16:10:59 +01:00
}
2016-12-06 18:35:55 +01:00
2013-12-17 16:10:59 +01:00
return cfg . lookup ( host )
}