Inside Bitcoin

251                    'secret-torpassword',
252                    'Command-line arg: rpcbind=****',
253                    'Command-line arg: rpcallowip=****',
254                ]):
255            self.start_node(0, extra_args=[
256                '-addnode=some.node',
257                '-rpcauth=alice:f7efda5c189b999524f151318c0c86$d5b51b3beffbc0',
258                '-rpcbind=127.1.1.1',
259                '-rpcbind=127.0.0.1',
260                "-rpcallowip=127.0.0.1",
261                '-rpcpassword=',
262                '-rpcuser=secret-rpcuser',
263                '-torpassword=secret-torpassword',
264                UNREACHABLE_PROXY_ARG,
265            ])
266        self.stop_node(0)
267
268    def test_empty_addnode(self):
269        self.log.info("Test empty addnode configuration values are ignored")
270        node = self.nodes[0]
271        util.append_config(node.datadir_path, ["addnode="])
272
273        with node.assert_debug_log(expected_msgs=["Ignoring empty -addnode value"]):
274            # Values consisting of whitespace only are trimmed away by the
275            # config file parser, so they can only be passed on the command
276            # line. Non-empty values are unaffected.
277            self.start_node(0, extra_args=["-addnode= ", "-addnode=some.node"])
278        util.assert_equal([added["addednode"] for added in node.getaddednodeinfo()], ["some.node"])
279        self.stop_node(0)
280
281        node.replace_in_config([("addnode=\n", "")])
282
283    def test_networkactive(self):
284        self.log.info('Test -networkactive option')
285        with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: true\n']):
286            self.start_node(0)
287
288        self.stop_node(0)
289        with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: true\n']):
290            self.start_node(0, extra_args=['-networkactive'])
291
292        self.stop_node(0)
293        with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: true\n']):
294            self.start_node(0, extra_args=['-networkactive=1'])
295
296        self.stop_node(0)
297        with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: false\n']):
298            self.start_node(0, extra_args=['-networkactive=0'])
299
300        self.stop_node(0)
301        with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: false\n']):
302            self.start_node(0, extra_args=['-nonetworkactive'])
303
304        self.stop_node(0)
305        with self.nodes[0].assert_debug_log(expected_msgs=['SetNetworkActive: false\n']):
306            self.start_node(0, extra_args=['-nonetworkactive=1'])
307        self.stop_node(0)
308
309    def test_seed_peers(self):
310        self.log.info('Test seed peers')
311        default_data_dir = self.nodes[0].datadir_path
312        peer_dat = default_data_dir / 'peers.dat'
313
314        # No peers.dat exists and -dnsseed=1
315        # We expect the node will use DNS Seeds, but Regtest mode does not have
316        # any valid DNS seeds. So after 60 seconds, the node should fallback to
317        # fixed seeds
318        assert not peer_dat.exists()
319        start = int(time.time())
320        with self.nodes[0].assert_debug_log(
321                expected_msgs=[
322                    "Loaded 0 addresses from peers.dat",
323                    "0 addresses found from DNS seeds",
324                    "opencon thread start",  # Ensure ThreadOpenConnections::start time is properly set
325                ],
326                timeout=10,
327        ):
328            self.start_node(0, extra_args=['-dnsseed=1', '-fixedseeds=1', f'-mocktime={start}', UNREACHABLE_PROXY_ARG])
329
330        # Only regtest has no fixed seeds. To avoid connections to random
331        # nodes, regtest is the only network where it is safe to enable
332        # -fixedseeds in tests
333        util.assert_equal(self.nodes[0].getblockchaininfo()['chain'],'regtest')
334
335        with self.nodes[0].assert_debug_log(expected_msgs=[
336                "Adding fixed seeds as 60 seconds have passed and addrman is empty",
337        ], timeout=2):
338            self.nodes[0].setmocktime(start + 65)
339        self.stop_node(0)
340
341        # No peers.dat exists and -dnsseed=0
342        # We expect the node will fallback immediately to fixed seeds
343        # An empty -addnode value is ignored, so it must not delay the fallback
344        # either.
345        assert not peer_dat.exists()
346        with self.nodes[0].assert_debug_log(expected_msgs=[
347                "Loaded 0 addresses from peers.dat",
348                "DNS seeding disabled",
349                "Adding fixed seeds as -dnsseed=0 (or IPv4/IPv6 connections are disabled via -onlynet) and neither -addnode nor -seednode are provided\n",
350        ], timeout=2):
351            self.start_node(0, extra_args=['-dnsseed=0', '-fixedseeds=1', '-addnode='])
352        self.stop_node(0)
353        self.nodes[0].assert_start_raises_init_error(['-dnsseed=1', '-onlynet=i2p', '-i2psam=127.0.0.1:7656'], "Error: Incompatible options: -dnsseed=1 was explicitly specified, but -onlynet forbids connections to IPv4/IPv6")
354
355        # No peers.dat exists and dns seeds are disabled.
356        # We expect the node will not add fixed seeds when explicitly disabled.
357        assert not peer_dat.exists()
358        with self.nodes[0].assert_debug_log(expected_msgs=[
359                "Loaded 0 addresses from peers.dat",
360                "DNS seeding disabled",
361                "Fixed seeds are disabled",
362        ], timeout=2):
363            self.start_node(0, extra_args=['-dnsseed=0', '-fixedseeds=0'])
364        self.stop_node(0)
365
366        # No peers.dat exists and -dnsseed=0, but a -addnode is provided
367        # We expect the node will allow 60 seconds prior to using fixed seeds
368        assert not peer_dat.exists()
369        start = int(time.time())
370        with self.nodes[0].assert_debug_log(
371                expected_msgs=[
372                    "Loaded 0 addresses from peers.dat",
373                    "DNS seeding disabled",
374                    "opencon thread start",  # Ensure ThreadOpenConnections::start time is properly set
375                ],
376                timeout=10,
377        ):
378            self.start_node(0, extra_args=['-dnsseed=0', '-fixedseeds=1', '-addnode=fakenodeaddr', f'-mocktime={start}', UNREACHABLE_PROXY_ARG])
379        with self.nodes[0].assert_debug_log(expected_msgs=[
380                "Adding fixed seeds as 60 seconds have passed and addrman is empty",
381        ], timeout=2):
382            self.nodes[0].setmocktime(start + 65)
383        self.stop_node(0)
384
385    def test_connect_with_seednode(self):
386        self.log.info('Test -connect with -seednode')
387        seednode_ignored = ['-seednode is ignored when -connect is used\n']
388        dnsseed_ignored = ['-dnsseed is ignored when -connect is used and -proxy is specified\n']
389        addcon_thread_started = ['addcon thread start\n']
390        dnsseed_disabled = "parameter interaction: -connect or -maxconnections=0 set -> setting -dnsseed=0"
391        listen_disabled = "parameter interaction: -connect or -maxconnections=0 set -> setting -listen=0"
392
393        # When -connect is supplied, expanding addrman via getaddr calls to ADDR_FETCH(-seednode)
394        # nodes is irrelevant and -seednode is ignored.
395        with self.nodes[0].assert_debug_log(expected_msgs=seednode_ignored):
396            self.start_node(0, extra_args=['-connect=fakeaddress1', '-seednode=fakeaddress2', UNREACHABLE_PROXY_ARG])
397
398        # With -proxy, an ADDR_FETCH connection is made to a peer that the dns seed resolves to.
399        # ADDR_FETCH connections are not used when -connect is used.
400        with self.nodes[0].assert_debug_log(expected_msgs=dnsseed_ignored):
401            self.restart_node(0, extra_args=['-connect=fakeaddress1', '-dnsseed=1', UNREACHABLE_PROXY_ARG])
402
403        # If the user did not disable -dnsseed, but it was soft-disabled because they provided -connect,
404        # they shouldn't see a warning about -dnsseed being ignored.
405        with self.nodes[0].assert_debug_log(expected_msgs=addcon_thread_started,
406                unexpected_msgs=dnsseed_ignored, timeout=2):
407            self.restart_node(0, extra_args=['-connect=fakeaddress1', UNREACHABLE_PROXY_ARG])
408
409        # We have to supply expected_msgs as it's a required argument
410        # The expected_msg must be something we are confident will be logged after the unexpected_msg
411        # These cases test for -connect being supplied but only to disable it
412        for connect_arg in ['-connect=0', '-noconnect']:
413            with self.nodes[0].assert_debug_log(expected_msgs=addcon_thread_started,
414                    unexpected_msgs=seednode_ignored, timeout=2):
415                self.restart_node(0, extra_args=[connect_arg, '-seednode=fakeaddress2'])
416
417            # Make sure -noconnect soft-disables -listen and -dnsseed.
418            # Need to temporarily remove these settings from the config file in
419            # order for the two log messages to appear
420            self.nodes[0].replace_in_config([("bind=", "#bind="), ("dnsseed=", "#dnsseed=")])
421            with self.nodes[0].assert_debug_log(expected_msgs=[dnsseed_disabled, listen_disabled]):
422                self.restart_node(0, extra_args=[connect_arg])
423            self.nodes[0].replace_in_config([("#bind=", "bind="), ("#dnsseed=", "dnsseed=")])
424
425            # Make sure -proxy and -noconnect warn about -dnsseed setting being
426            # ignored, just like -proxy and -connect do.
427            with self.nodes[0].assert_debug_log(expected_msgs=dnsseed_ignored):
428                self.restart_node(0, extra_args=[connect_arg, '-dnsseed', '-proxy=localhost:1080'])
429        self.stop_node(0)
430
431    def test_privatebroadcast(self):
432        self.log.info("Test that an invalid usage of -privatebroadcast throws an init error")
433        self.stop_node(0)
434        # -privatebroadcast init error: Tor/I2P not reachable at startup
435        self.nodes[0].assert_start_raises_init_error(
436            extra_args=["-privatebroadcast"],
437            expected_msg=(
438                "Error: Private broadcast of own transactions requested (-privatebroadcast), "
439                "but none of Tor or I2P networks is reachable"))
440        # -privatebroadcast init error: incompatible with -connect
441        self.nodes[0].assert_start_raises_init_error(
442            extra_args=["-privatebroadcast", "-connect=127.0.0.1:8333", "-onion=127.0.0.1:9050"],
443            expected_msg=(
444                "Error: Private broadcast of own transactions requested (-privatebroadcast), but -connect is also configured. "
445                "They are incompatible because the private broadcast needs to open new connections to randomly "
446                "chosen Tor or I2P peers. Consider using -maxconnections=0 -addnode=... instead"))
447        # Warning case: private broadcast allowed, but -proxyrandomize=0 triggers a privacy warning
448        self.start_node(0, extra_args=["-privatebroadcast", "-onion=127.0.0.1:9050", "-proxyrandomize=0"])
449        self.stop_node(0, expected_stderr=(
450            "Warning: Private broadcast of own transactions requested (-privatebroadcast) and "
451            "-proxyrandomize is disabled. Tor circuits for private broadcast connections may "
452            "be correlated to other connections over Tor. To reduce this risk, set -proxyrandomize=1."))
453
454    def test_ignored_conf(self):
455        self.log.info('Test error is triggered when the datadir in use contains a bitcoin.conf file that would be ignored '
456                      'because a conflicting -conf file argument is passed.')
457        node = self.nodes[0]
458        with tempfile.NamedTemporaryFile(dir=self.options.tmpdir, mode="wt", delete=False) as temp_conf:
459            temp_conf.write(f"datadir={node.datadir_path}\n")
460        node.assert_start_raises_init_error([f"-conf={temp_conf.name}"], re.escape(
461            f'Error: Data directory "{node.datadir_path}" contains a "bitcoin.conf" file which is ignored, because a '
462            f'different configuration file "{temp_conf.name}" from command line argument "-conf={temp_conf.name}" '
463            f'is being used instead.') + r"[\s\S]*", match=ErrorMatch.FULL_REGEX)
464
465        # Test that passing a redundant -conf command line argument pointing to
466        # the same bitcoin.conf that would be loaded anyway does not trigger an
467        # error.
468        self.start_node(0, [f'-conf={node.datadir_path}/bitcoin.conf'])
469        self.stop_node(0)
470
471    def test_ignored_default_conf(self):
472        # Disable this test for windows currently because trying to override
473        # the default datadir through the environment does not seem to work.
474        if platform.system() == "Windows":
475            return
476
477        self.log.info('Test error is triggered when bitcoin.conf in the default data directory sets another datadir '
478                      'and it contains a different bitcoin.conf file that would be ignored')
479
480        # Create a temporary directory that will be treated as the default data
481        # directory by bitcoind.
482        env, default_datadir = util.get_temp_default_datadir(Path(self.options.tmpdir, "home"))
483        default_datadir.mkdir(parents=True)
484
485        # Write a bitcoin.conf file in the default data directory containing a
486        # datadir= line pointing at the node datadir. This will trigger a
487        # startup error because the node datadir contains a different
488        # bitcoin.conf that would be ignored.
489        node = self.nodes[0]
490        (default_datadir / "bitcoin.conf").write_text(f"datadir={node.datadir_path}\n")
491
492        # Drop the node -datadir= argument during this test, because if it is
493        # specified it would take precedence over the datadir setting in the
494        # config file.
495        node_args = node.args
496        node.args = [arg for arg in node.args if not arg.startswith("-datadir=")]
497        node.assert_start_raises_init_error([], re.escape(
498            f'Error: Data directory "{node.datadir_path}" contains a "bitcoin.conf" file which is ignored, because a '
499            f'different configuration file "{default_datadir}/bitcoin.conf" from data directory "{default_datadir}" '
500            f'is being used instead.') + r"[\s\S]*", env=env, match=ErrorMatch.FULL_REGEX)