Inside Bitcoin

251        assert_equal(cli_get_info["Proxies"], "127.0.0.1:9050 (ipv4, ipv6, onion, cjdns), 127.0.0.1:7656 (i2p)")
252
253        if self.is_wallet_compiled():
254            self.log.info("Test -getinfo and bitcoin-cli getwalletinfo return expected wallet info")
255            # Explicitly set the output type in order to have consistent tx vsize / fees
256            # for both legacy and descriptor wallets (disables the change address type detection algorithm)
257            self.restart_node(0, extra_args=["-addresstype=bech32", "-changetype=bech32"])
258            assert_equal(Decimal(cli_get_info['Balance']), BALANCE)
259            assert 'Balances' not in cli_get_info_string
260            wallet_info = self.nodes[0].getwalletinfo()
261            assert_equal(int(cli_get_info['Keypool size']), wallet_info['keypoolsize'])
262            assert_equal(int(cli_get_info['Unlocked until']), wallet_info['unlocked_until'])
263            assert_equal(Decimal(cli_get_info['Min tx relay fee rate (BTC/kvB)']), network_info['relayfee'])
264            assert_equal(self.nodes[0].cli.getwalletinfo(), wallet_info)
265
266            # Setup to test -getinfo, -generate, and -rpcwallet= with multiple wallets.
267            wallets = [self.default_wallet_name, 'Encrypted', 'secret']
268            amounts = [BALANCE + Decimal('9.999928'), Decimal(9), Decimal(31)]
269            self.nodes[0].createwallet(wallet_name=wallets[1])
270            self.nodes[0].createwallet(wallet_name=wallets[2])
271            w1 = self.nodes[0].get_wallet_rpc(wallets[0])
272            w2 = self.nodes[0].get_wallet_rpc(wallets[1])
273            w3 = self.nodes[0].get_wallet_rpc(wallets[2])
274            rpcwallet2 = f'-rpcwallet={wallets[1]}'
275            rpcwallet3 = f'-rpcwallet={wallets[2]}'
276            w1.walletpassphrase(password, self.rpc_timeout)
277            w2.encryptwallet(password)
278            w1.sendtoaddress(w2.getnewaddress(), amounts[1])
279            w1.sendtoaddress(w3.getnewaddress(), amounts[2])
280
281            # Mine a block to confirm; adds a block reward (50 BTC) to the default wallet.
282            self.generate(self.nodes[0], 1)
283
284            self.log.info("Test -getinfo with multiple wallets and -rpcwallet returns specified wallet balance")
285            for i in range(len(wallets)):
286                cli_get_info_string = self.nodes[0].cli('-getinfo', f'-rpcwallet={wallets[i]}').send_cli()
287                cli_get_info = cli_get_info_string_to_dict(cli_get_info_string)
288                assert 'Balances' not in cli_get_info_string
289                assert_equal(cli_get_info["Wallet"], wallets[i])
290                assert_equal(Decimal(cli_get_info['Balance']), amounts[i])
291
292            self.log.info("Test -getinfo with multiple wallets and -rpcwallet=non-existing-wallet returns no balances")
293            cli_get_info_string = self.nodes[0].cli('-getinfo', '-rpcwallet=does-not-exist').send_cli()
294            assert 'Balance' not in cli_get_info_string
295            assert 'Balances' not in cli_get_info_string
296
297            self.log.info("Test -getinfo with multiple wallets returns all loaded wallet names and balances")
298            assert_equal(set(self.nodes[0].listwallets()), set(wallets))
299            cli_get_info_string = self.nodes[0].cli('-getinfo').send_cli()
300            cli_get_info = cli_get_info_string_to_dict(cli_get_info_string)
301            assert 'Balance' not in cli_get_info
302            for k, v in zip(wallets, amounts):
303                assert_equal(Decimal(cli_get_info['Balances'][k]), v)
304
305            # Unload the default wallet and re-verify.
306            self.nodes[0].unloadwallet(wallets[0])
307            assert wallets[0] not in self.nodes[0].listwallets()
308            cli_get_info_string = self.nodes[0].cli('-getinfo').send_cli()
309            cli_get_info = cli_get_info_string_to_dict(cli_get_info_string)
310            assert 'Balance' not in cli_get_info
311            assert 'Balances' in cli_get_info_string
312            for k, v in zip(wallets[1:], amounts[1:]):
313                assert_equal(Decimal(cli_get_info['Balances'][k]), v)
314            assert wallets[0] not in cli_get_info
315
316            self.log.info("Test -getinfo after unloading all wallets except a non-default one returns its balance")
317            self.nodes[0].unloadwallet(wallets[2])
318            assert_equal(self.nodes[0].listwallets(), [wallets[1]])
319            cli_get_info_string = self.nodes[0].cli('-getinfo').send_cli()
320            cli_get_info = cli_get_info_string_to_dict(cli_get_info_string)
321            assert 'Balances' not in cli_get_info_string
322            assert_equal(cli_get_info['Wallet'], wallets[1])
323            assert_equal(Decimal(cli_get_info['Balance']), amounts[1])
324
325            self.log.info("Test -getinfo -norpcwallet returns the same as -getinfo")
326            # Previously there was a bug where -norpcwallet was treated like -rpcwallet=0
327            assert_equal(self.nodes[0].cli('-getinfo', "-norpcwallet").send_cli(), cli_get_info_string)
328
329            self.log.info("Test -getinfo with -rpcwallet=remaining-non-default-wallet returns only its balance")
330            cli_get_info_string = self.nodes[0].cli('-getinfo', rpcwallet2).send_cli()
331            cli_get_info = cli_get_info_string_to_dict(cli_get_info_string)
332            assert 'Balances' not in cli_get_info_string
333            assert_equal(cli_get_info['Wallet'], wallets[1])
334            assert_equal(Decimal(cli_get_info['Balance']), amounts[1])
335
336            self.log.info("Test -getinfo with -rpcwallet=unloaded wallet returns no balances")
337            cli_get_info_string = self.nodes[0].cli('-getinfo', rpcwallet3).send_cli()
338            cli_get_info_keys = cli_get_info_string_to_dict(cli_get_info_string)
339            assert 'Balance' not in cli_get_info_keys
340            assert 'Balances' not in cli_get_info_string
341
342            # Test bitcoin-cli -generate.
343            n1 = 3
344            n2 = 4
345            w2.walletpassphrase(password, self.rpc_timeout)
346            blocks = self.nodes[0].getblockcount()
347
348            self.log.info('Test -generate with no args')
349            generate = self.nodes[0].cli('-generate').send_cli()
350            assert_equal(set(generate.keys()), {'address', 'blocks'})
351            assert_equal(len(generate["blocks"]), 1)
352            assert_equal(self.nodes[0].getblockcount(), blocks + 1)
353
354            self.log.info('Test -generate with bad args')
355            assert_raises_process_error(1, JSON_PARSING_ERROR, self.nodes[0].cli('-generate', 'foo').echo)
356            assert_raises_process_error(1, BLOCKS_VALUE_OF_ZERO, self.nodes[0].cli('-generate', 0).echo)
357            assert_raises_process_error(1, TOO_MANY_ARGS, self.nodes[0].cli('-generate', 1, 2, 3).echo)
358
359            self.log.info('Test -generate with nblocks')
360            generate = self.nodes[0].cli('-generate', n1).send_cli()
361            assert_equal(set(generate.keys()), {'address', 'blocks'})
362            assert_equal(len(generate["blocks"]), n1)
363            assert_equal(self.nodes[0].getblockcount(), blocks + 1 + n1)
364
365            self.log.info('Test -generate with nblocks and maxtries')
366            generate = self.nodes[0].cli('-generate', n2, 1000000).send_cli()
367            assert_equal(set(generate.keys()), {'address', 'blocks'})
368            assert_equal(len(generate["blocks"]), n2)
369            assert_equal(self.nodes[0].getblockcount(), blocks + 1 + n1 + n2)
370
371            self.log.info('Test -generate -rpcwallet in single-wallet mode')
372            generate = self.nodes[0].cli(rpcwallet2, '-generate').send_cli()
373            assert_equal(set(generate.keys()), {'address', 'blocks'})
374            assert_equal(len(generate["blocks"]), 1)
375            assert_equal(self.nodes[0].getblockcount(), blocks + 2 + n1 + n2)
376
377            self.log.info('Test -generate -rpcwallet=unloaded wallet raises RPC error')
378            assert_raises_rpc_error(-18, WALLET_NOT_LOADED, self.nodes[0].cli(rpcwallet3, '-generate').echo)
379            assert_raises_rpc_error(-18, WALLET_NOT_LOADED, self.nodes[0].cli(rpcwallet3, '-generate', 'foo').echo)
380            assert_raises_rpc_error(-18, WALLET_NOT_LOADED, self.nodes[0].cli(rpcwallet3, '-generate', 0).echo)
381            assert_raises_rpc_error(-18, WALLET_NOT_LOADED, self.nodes[0].cli(rpcwallet3, '-generate', 1, 2, 3).echo)
382
383            # Test bitcoin-cli -generate with -rpcwallet in multiwallet mode.
384            self.nodes[0].loadwallet(wallets[2])
385            n3 = 4
386            n4 = 10
387            blocks = self.nodes[0].getblockcount()
388
389            self.log.info('Test -generate -rpcwallet=<filename> raise RPC error')
390            wallet2_path = f'-rpcwallet={self.nodes[0].wallets_path / wallets[2] / self.wallet_data_filename}'
391            assert_raises_rpc_error(-18, WALLET_NOT_LOADED, self.nodes[0].cli(wallet2_path, '-generate').echo)
392
393            self.log.info('Test -generate -rpcwallet with no args')
394            generate = self.nodes[0].cli(rpcwallet2, '-generate').send_cli()
395            assert_equal(set(generate.keys()), {'address', 'blocks'})
396            assert_equal(len(generate["blocks"]), 1)
397            assert_equal(self.nodes[0].getblockcount(), blocks + 1)
398
399            self.log.info('Test -generate -rpcwallet with bad args')
400            assert_raises_process_error(1, JSON_PARSING_ERROR, self.nodes[0].cli(rpcwallet2, '-generate', 'foo').echo)
401            assert_raises_process_error(1, BLOCKS_VALUE_OF_ZERO, self.nodes[0].cli(rpcwallet2, '-generate', 0).echo)
402            assert_raises_process_error(1, TOO_MANY_ARGS, self.nodes[0].cli(rpcwallet2, '-generate', 1, 2, 3).echo)
403
404            self.log.info('Test -generate -rpcwallet with nblocks')
405            generate = self.nodes[0].cli(rpcwallet2, '-generate', n3).send_cli()
406            assert_equal(set(generate.keys()), {'address', 'blocks'})
407            assert_equal(len(generate["blocks"]), n3)
408            assert_equal(self.nodes[0].getblockcount(), blocks + 1 + n3)
409
410            self.log.info('Test -generate -rpcwallet with nblocks and maxtries')
411            generate = self.nodes[0].cli(rpcwallet2, '-generate', n4, 1000000).send_cli()
412            assert_equal(set(generate.keys()), {'address', 'blocks'})
413            assert_equal(len(generate["blocks"]), n4)
414            assert_equal(self.nodes[0].getblockcount(), blocks + 1 + n3 + n4)
415
416            self.log.info('Test -generate without -rpcwallet in multiwallet mode raises RPC error')
417            assert_raises_rpc_error(-19, WALLET_NOT_SPECIFIED, self.nodes[0].cli('-generate').echo)
418            assert_raises_rpc_error(-19, WALLET_NOT_SPECIFIED, self.nodes[0].cli('-generate', 'foo').echo)
419            assert_raises_rpc_error(-19, WALLET_NOT_SPECIFIED, self.nodes[0].cli('-generate', 0).echo)
420            assert_raises_rpc_error(-19, WALLET_NOT_SPECIFIED, self.nodes[0].cli('-generate', 1, 2, 3).echo)
421        else:
422            self.log.info("*** Wallet not compiled; cli getwalletinfo and -getinfo wallet tests skipped")
423            self.generate(self.nodes[0], 25)  # maintain block parity with the wallet_compiled conditional branch
424
425        self.test_netinfo()
426
427        self.log.info("Test -rpcid option sets custom JSON-RPC request ID")
428        with self.nodes[0].assert_debug_log(expected_msgs=['id=myrpcid']):
429            self.nodes[0].cli('-rpcid=myrpcid').getblockcount()
430
431        self.log.info("Test default request logs default id=1")
432        with self.nodes[0].assert_debug_log(expected_msgs=["ThreadRPCServer method=getblockcount", "id=1"]):
433            self.nodes[0].cli.getblockcount()
434
435        self.log.info("Test that request ids with unsafe characters are sanitized in the log")
436        with self.nodes[0].assert_debug_log(expected_msgs=["ThreadRPCServer method=getblockcount", "id=abcdef"]):
437            self.nodes[0].cli('-rpcid=abc<\n>def').getblockcount()
438
439        self.log.info("Test -version with node stopped")
440        self.stop_node(0)
441        cli_response = self.nodes[0].cli('-version').send_cli()
442        assert f"{self.config['environment']['CLIENT_NAME']} RPC client version" in cli_response
443
444        self.log.info("Test -rpcwait option successfully waits for RPC connection")
445        self.nodes[0].start()  # start node without RPC connection
446        self.nodes[0].wait_for_cookie_credentials()  # ensure cookie file is available to avoid race condition
447        blocks = self.nodes[0].cli('-rpcwait').send_cli('getblockcount')
448        self.nodes[0].wait_for_rpc_connection()
449        assert_equal(blocks, BLOCKS + 25)
450
451        self.log.info("Test -rpcwait option waits at most -rpcwaittimeout seconds for startup")
452        self.stop_node(0)  # stop the node so we time out
453        start_time = time.time()
454        assert_raises_process_error(1, "Could not connect to the server", self.nodes[0].cli('-rpcwait', '-rpcwaittimeout=5').echo)
455        assert_greater_than_or_equal(time.time(), start_time + 5)
456
457        self.log.info("Test that only one of -addrinfo, -generate, -getinfo, -netinfo may be specified at a time")
458        assert_raises_process_error(1, "Only one of -getinfo, -netinfo may be specified", self.nodes[0].cli('-getinfo', '-netinfo').send_cli)
459
460        if not self.is_ipc_compiled():
461            # This tests behavior when ENABLE_IPC is off. When it is on,
462            # behavior is checked by the interface_ipc_cli.py test.
463            self.log.info("Test bitcoin-cli -ipcconnect triggers error if not built with IPC support")
464            # node.cli.options includes -rpcconnect which can't be combined with -ipcconnect, so pass just -datadir directly to keep bitcoin-cli on the test's bitcoin.conf
465            args = self.nodes[0].binaries.valgrind_cmd + [self.nodes[0].binaries.paths.bitcoincli, f"-datadir={self.nodes[0].datadir_path}", "-ipcconnect=unix", "-getinfo"]
466            result = subprocess.run(args, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, text=True)
467            assert_equal(result.stdout, "error: bitcoin-cli was not built with IPC support\n")
468            assert_equal(result.stderr, None)
469            assert_equal(result.returncode, 1)
470
471
472if __name__ == '__main__':
473    TestBitcoinCli(__file__).main()
474