vendor/github.com/btcsuite/btcd/sample-btcd.conf

   1 [Application Options]
   2
   3 ; ------------------------------------------------------------------------------
   4 ; Data settings
   5 ; ------------------------------------------------------------------------------
   6
   7 ; The directory to store data such as the block chain and peer addresses.  The
   8 ; block chain takes several GB, so this location must have a lot of free space.
   9 ; The default is ~/.btcd/data on POSIX OSes, $LOCALAPPDATA/Btcd/data on Windows,
  10 ; ~/Library/Application Support/Btcd/data on Mac OS, and $home/btcd/data on
  11 ; Plan9.  Environment variables are expanded so they may be used.  NOTE: Windows
  12 ; environment variables are typically %VARIABLE%, but they must be accessed with
  13 ; $VARIABLE here.  Also, ~ is expanded to $LOCALAPPDATA on Windows.
  14 ; datadir=~/.btcd/data
  15
  16
  17 ; ------------------------------------------------------------------------------
  18 ; Network settings
  19 ; ------------------------------------------------------------------------------
  20
  21 ; Use testnet.
  22 ; testnet=1
  23
  24 ; Connect via a SOCKS5 proxy.  NOTE: Specifying a proxy will disable listening
  25 ; for incoming connections unless listen addresses are provided via the 'listen'
  26 ; option.
  27 ; proxy=127.0.0.1:9050
  28 ; proxyuser=
  29 ; proxypass=
  30
  31 ; The SOCKS5 proxy above is assumed to be Tor (https://www.torproject.org).
  32 ; If the proxy is not tor the following may be used to prevent using tor
  33 ; specific SOCKS queries to lookup addresses (this increases anonymity when tor
  34 ; is used by preventing your IP being leaked via DNS).
  35 ; noonion=1
  36
  37 ; Use an alternative proxy to connect to .onion addresses. The proxy is assumed
  38 ; to be a Tor node. Non .onion addresses will be contacted with the main proxy
  39 ; or without a proxy if none is set.
  40 ; onion=127.0.0.1:9051
  41 ; onionuser=
  42 ; onionpass=
  43
  44 ; Enable Tor stream isolation by randomizing proxy user credentials resulting in
  45 ; Tor creating a new circuit for each connection.  This makes it more difficult
  46 ; to correlate connections.
  47 ; torisolation=1
  48
  49 ; Use Universal Plug and Play (UPnP) to automatically open the listen port
  50 ; and obtain the external IP address from supported devices.  NOTE: This option
  51 ; will have no effect if exernal IP addresses are specified.
  52 ; upnp=1
  53
  54 ; Specify the external IP addresses your node is listening on.  One address per
  55 ; line.  btcd will not contact 3rd-party sites to obtain external ip addresses.
  56 ; This means if you are behind NAT, your node will not be able to advertise a
  57 ; reachable address unless you specify it here or enable the 'upnp' option (and
  58 ; have a supported device).
  59 ; externalip=1.2.3.4
  60 ; externalip=2002::1234
  61
  62 ; ******************************************************************************
  63 ; Summary of 'addpeer' versus 'connect'.
  64 ;
  65 ; Only one of the following two options, 'addpeer' and 'connect', may be
  66 ; specified.  Both allow you to specify peers that you want to stay connected
  67 ; with, but the behavior is slightly different.  By default, btcd will query DNS
  68 ; to find peers to connect to, so unless you have a specific reason such as
  69 ; those described below, you probably won't need to modify anything here.
  70 ;
  71 ; 'addpeer' does not prevent connections to other peers discovered from
  72 ; the peers you are connected to and also lets the remote peers know you are
  73 ; available so they can notify other peers they can to connect to you.  This
  74 ; option might be useful if you are having problems finding a node for some
  75 ; reason (perhaps due to a firewall).
  76 ;
  77 ; 'connect', on the other hand, will ONLY connect to the specified peers and
  78 ; no others.  It also disables listening (unless you explicitly set listen
  79 ; addresses via the 'listen' option) and DNS seeding, so you will not be
  80 ; advertised as an available peer to the peers you connect to and won't accept
  81 ; connections from any other peers.  So, the 'connect' option effectively allows
  82 ; you to only connect to "trusted" peers.
  83 ; ******************************************************************************
  84
  85 ; Add persistent peers to connect to as desired.  One peer per line.
  86 ; You may specify each IP address with or without a port.  The default port will
  87 ; be added automatically if one is not specified here.
  88 ; addpeer=192.168.1.1
  89 ; addpeer=10.0.0.2:8333
  90 ; addpeer=fe80::1
  91 ; addpeer=[fe80::2]:8333
  92
  93 ; Add persistent peers that you ONLY want to connect to as desired.  One peer
  94 ; per line.  You may specify each IP address with or without a port.  The
  95 ; default port will be added automatically if one is not specified here.
  96 ; NOTE: Specifying this option has other side effects as described above in
  97 ; the 'addpeer' versus 'connect' summary section.
  98 ; connect=192.168.1.1
  99 ; connect=10.0.0.2:8333
 100 ; connect=fe80::1
 101 ; connect=[fe80::2]:8333
 102
 103 ; Maximum number of inbound and outbound peers.
 104 ; maxpeers=125
 105
 106 ; Disable banning of misbehaving peers.
 107 ; nobanning=1
 108
 109 ; Maximum allowed ban score before disconnecting and banning misbehaving peers.`
 110 ; banthreshold=100
 111
 112 ; How long to ban misbehaving peers. Valid time units are {s, m, h}.
 113 ; Minimum 1s.
 114 ; banduration=24h
 115 ; banduration=11h30m15s
 116
 117 ; Add whitelisted IP networks and IPs. Connected peers whose IP matches a
 118 ; whitelist will not have their ban score increased.
 119 ; whitelist=127.0.0.1
 120 ; whitelist=::1
 121 ; whitelist=192.168.0.0/24
 122 ; whitelist=fd00::/16
 123
 124 ; Disable DNS seeding for peers.  By default, when btcd starts, it will use
 125 ; DNS to query for available peers to connect with.
 126 ; nodnsseed=1
 127
 128 ; Specify the interfaces to listen on.  One listen address per line.
 129 ; NOTE: The default port is modified by some options such as 'testnet', so it is
 130 ; recommended to not specify a port and allow a proper default to be chosen
 131 ; unless you have a specific reason to do otherwise.
 132 ; All interfaces on default port (this is the default):
 133 ;  listen=
 134 ; All ipv4 interfaces on default port:
 135 ;  listen=0.0.0.0
 136 ; All ipv6 interfaces on default port:
 137 ;   listen=::
 138 ; All interfaces on port 8333:
 139 ;   listen=:8333
 140 ; All ipv4 interfaces on port 8333:
 141 ;   listen=0.0.0.0:8333
 142 ; All ipv6 interfaces on port 8333:
 143 ;   listen=[::]:8333
 144 ; Only ipv4 localhost on port 8333:
 145 ;   listen=127.0.0.1:8333
 146 ; Only ipv6 localhost on port 8333:
 147 ;   listen=[::1]:8333
 148 ; Only ipv4 localhost on non-standard port 8336:
 149 ;   listen=127.0.0.1:8336
 150 ; All interfaces on non-standard port 8336:
 151 ;   listen=:8336
 152 ; All ipv4 interfaces on non-standard port 8336:
 153 ;   listen=0.0.0.0:8336
 154 ; All ipv6 interfaces on non-standard port 8336:
 155 ;   listen=[::]:8336
 156
 157 ; Disable listening for incoming connections.  This will override all listeners.
 158 ; nolisten=1
 159
 160 ; Disable peer bloom filtering.  See BIP0111.
 161 ; nopeerbloomfilters=1
 162
 163 ; Add additional checkpoints. Format: '<height>:<hash>'
 164 ; addcheckpoint=<height>:<hash>
 165
 166 ; Add comments to the user agent that is advertised to peers.
 167 ; Must not include characters '/', ':', '(' and ')'.
 168 ; uacomment=
 169
 170 ; ------------------------------------------------------------------------------
 171 ; RPC server options - The following options control the built-in RPC server
 172 ; which is used to control and query information from a running btcd process.
 173 ;
 174 ; NOTE: The RPC server is disabled by default if rpcuser AND rpcpass, or
 175 ; rpclimituser AND rpclimitpass, are not specified.
 176 ; ------------------------------------------------------------------------------
 177
 178 ; Secure the RPC API by specifying the username and password.  You can also
 179 ; specify a limited username and password.  You must specify at least one
 180 ; full set of credentials - limited or admin - or the RPC server will
 181 ; be disabled.
 182 ; rpcuser=whatever_admin_username_you_want
 183 ; rpcpass=
 184 ; rpclimituser=whatever_limited_username_you_want
 185 ; rpclimitpass=
 186
 187 ; Specify the interfaces for the RPC server listen on.  One listen address per
 188 ; line.  NOTE: The default port is modified by some options such as 'testnet',
 189 ; so it is recommended to not specify a port and allow a proper default to be
 190 ; chosen unless you have a specific reason to do otherwise.  By default, the
 191 ; RPC server will only listen on localhost for IPv4 and IPv6.
 192 ; All interfaces on default port:
 193 ;   rpclisten=
 194 ; All ipv4 interfaces on default port:
 195 ;   rpclisten=0.0.0.0
 196 ; All ipv6 interfaces on default port:
 197 ;   rpclisten=::
 198 ; All interfaces on port 8334:
 199 ;   rpclisten=:8334
 200 ; All ipv4 interfaces on port 8334:
 201 ;   rpclisten=0.0.0.0:8334
 202 ; All ipv6 interfaces on port 8334:
 203 ;   rpclisten=[::]:8334
 204 ; Only ipv4 localhost on port 8334:
 205 ;   rpclisten=127.0.0.1:8334
 206 ; Only ipv6 localhost on port 8334:
 207 ;   rpclisten=[::1]:8334
 208 ; Only ipv4 localhost on non-standard port 8337:
 209 ;   rpclisten=127.0.0.1:8337
 210 ; All interfaces on non-standard port 8337:
 211 ;   rpclisten=:8337
 212 ; All ipv4 interfaces on non-standard port 8337:
 213 ;   rpclisten=0.0.0.0:8337
 214 ; All ipv6 interfaces on non-standard port 8337:
 215 ;   rpclisten=[::]:8337
 216
 217 ; Specify the maximum number of concurrent RPC clients for standard connections.
 218 ; rpcmaxclients=10
 219
 220 ; Specify the maximum number of concurrent RPC websocket clients.
 221 ; rpcmaxwebsockets=25
 222
 223 ; Mirror some JSON-RPC quirks of Bitcoin Core -- NOTE: Discouraged unless
 224 ; interoperability issues need to be worked around
 225 ; rpcquirks=1
 226
 227 ; Use the following setting to disable the RPC server even if the rpcuser and
 228 ; rpcpass are specified above.  This allows one to quickly disable the RPC
 229 ; server without having to remove credentials from the config file.
 230 ; norpc=1
 231
 232 ; Use the following setting to disable TLS for the RPC server.  NOTE: This
 233 ; option only works if the RPC server is bound to localhost interfaces (which is
 234 ; the default).
 235 ; notls=1
 236
 237
 238 ; ------------------------------------------------------------------------------
 239 ; Mempool Settings - The following options
 240 ; ------------------------------------------------------------------------------
 241
 242 ; Set the minimum transaction fee to be considered a non-zero fee,
 243 ; minrelaytxfee=0.00001
 244
 245 ; Rate-limit free transactions to the value 15 * 1000 bytes per
 246 ; minute.
 247 ; limitfreerelay=15
 248
 249 ; Require high priority for relaying free or low-fee transactions.
 250 ; norelaypriority=0
 251
 252 ; Limit orphan transaction pool to 100 transactions.
 253 ; maxorphantx=100
 254
 255 ; Do not accept transactions from remote peers.
 256 ; blocksonly=1
 257
 258 ; Relay non-standard transactions regardless of default network settings.
 259 ; relaynonstd=1
 260
 261 ; Reject non-standard transactions regardless of default network settings.
 262 ; rejectnonstd=1
 263
 264
 265 ; ------------------------------------------------------------------------------
 266 ; Optional Transaction Indexes
 267 ; ------------------------------------------------------------------------------
 268
 269 ; Build and maintain a full address-based transaction index.
 270 ; addrindex=1
 271 ; Delete the entire address index on start up, then exit.
 272 ; dropaddrindex=0
 273
 274
 275 ; ------------------------------------------------------------------------------
 276 ; Optional Indexes
 277 ; ------------------------------------------------------------------------------
 278
 279 ; Build and maintain a full hash-based transaction index which makes all
 280 ; transactions available via the getrawtransaction RPC.
 281 ; txindex=1
 282
 283 ; Build and maintain a full address-based transaction index which makes the
 284 ; searchrawtransactions RPC available.
 285 ; addrindex=1
 286
 287
 288 ; ------------------------------------------------------------------------------
 289 ; Signature Verification Cache
 290 ; ------------------------------------------------------------------------------
 291
 292 ; Limit the signature cache to a max of 50000 entries.
 293 ; sigcachemaxsize=50000
 294
 295
 296 ; ------------------------------------------------------------------------------
 297 ; Coin Generation (Mining) Settings - The following options control the
 298 ; generation of block templates used by external mining applications through RPC
 299 ; calls as well as the built-in CPU miner (if enabled).
 300 ; ------------------------------------------------------------------------------
 301
 302 ; Enable built-in CPU mining.
 303 ;
 304 ; NOTE: This is typically only useful for testing purposes such as testnet or
 305 ; simnet since the difficutly on mainnet is far too high for CPU mining to be
 306 ; worth your while.
 307 ; generate=false
 308
 309 ; Add addresses to pay mined blocks to for CPU mining and potentially in the
 310 ; block templates generated for the getblocktemplate RPC.  One address per line.
 311 ; miningaddr=1yourbitcoinaddress
 312 ; miningaddr=1yourbitcoinaddress2
 313 ; miningaddr=1yourbitcoinaddress3
 314
 315 ; Specify the minimum block size in bytes to create.  By default, only
 316 ; transactions which have enough fees or a high enough priority will be included
 317 ; in generated block templates.  Specifying a minimum block size will instead
 318 ; attempt to fill generated block templates up with transactions until it is at
 319 ; least the specified number of bytes.
 320 ; blockminsize=0
 321
 322 ; Specify the maximum block size in bytes to create.  This value will be limited
 323 ; to the consensus limit if it is larger than that value.
 324 ; blockmaxsize=750000
 325
 326 ; Specify the size in bytes of the high-priority/low-fee area when creating a
 327 ; block.  Transactions which consist of large amounts, old inputs, and small
 328 ; sizes have the highest priority.  One consequence of this is that as low-fee
 329 ; or free transactions age, they raise in priority thereby making them more
 330 ; likely to be included in this section of a new block.  This value is limited
 331 ; by the blackmaxsize option and will be limited as needed.
 332 ; blockprioritysize=50000
 333
 334
 335 ; ------------------------------------------------------------------------------
 336 ; Debug
 337 ; ------------------------------------------------------------------------------
 338
 339 ; Debug logging level.
 340 ; Valid levels are {trace, debug, info, warn, error, critical}
 341 ; You may also specify <subsystem>=<level>,<subsystem2>=<level>,... to set
 342 ; log level for individual subsystems.  Use btcd --debuglevel=show to list
 343 ; available subsystems.
 344 ; debuglevel=info
 345
 346 ; The port used to listen for HTTP profile requests.  The profile server will
 347 ; be disabled if this option is not specified.  The profile information can be
 348 ; accessed at http://localhost:<profileport>/debug/pprof once running.
 349 ; profile=6061