Inside Bitcoin

1#!/usr/bin/env python3
2# Copyright (c) 2017-present The Bitcoin Core developers
3# Distributed under the MIT software license, see the accompanying
4# file COPYING or http://www.opensource.org/licenses/mit-license.php.
5"""Test bitcoin-cli"""
6
7from decimal import Decimal
8import re
9import subprocess
10
11from test_framework.blocktools import COINBASE_MATURITY
12from test_framework.netutil import test_ipv6_local
13from test_framework.test_framework import BitcoinTestFramework
14from test_framework.util import (
15    assert_equal,
16    assert_greater_than_or_equal,
17    assert_raises_process_error,
18    assert_raises_rpc_error,
19    get_auth_cookie,
20    rpc_port,
21)
22import time
23
24# The block reward of coinbaseoutput.nValue (50) BTC/block matures after
25# COINBASE_MATURITY (100) blocks. Therefore, after mining 101 blocks we expect
26# node 0 to have a balance of (BLOCKS - COINBASE_MATURITY) * 50 BTC/block.
27BLOCKS = COINBASE_MATURITY + 1
28BALANCE = (BLOCKS - 100) * 50
29
30JSON_PARSING_ERROR = 'error: Error parsing JSON: foo'
31BLOCKS_VALUE_OF_ZERO = 'error: the first argument (number of blocks to generate, default: 1) must be an integer value greater than zero'
32TOO_MANY_ARGS = 'error: too many arguments (maximum 2 for nblocks and maxtries)'
33WALLET_NOT_LOADED = 'Requested wallet does not exist or is not loaded'
34WALLET_NOT_SPECIFIED = (
35    "Multiple wallets are loaded. Please select which wallet to use by requesting the RPC "
36    "through the /wallet/<walletname> URI path. Or for the CLI, specify the \"-rpcwallet=<walletname>\" "
37    "option before the command (run \"bitcoin-cli -h\" for help or \"bitcoin-cli listwallets\" to see "
38    "which wallets are currently loaded)."
39)
40
41
42def cli_get_info_string_to_dict(cli_get_info_string):
43    """Helper method to convert human-readable -getinfo into a dictionary"""
44    cli_get_info = {}
45    lines = cli_get_info_string.splitlines()
46    line_idx = 0
47    ansi_escape = re.compile(r'(\x9B|\x1B\[)[0-?]*[ -\/]*[@-~]')
48    while line_idx < len(lines):
49        # Remove ansi colour code
50        line = ansi_escape.sub('', lines[line_idx])
51        if "Balances" in line:
52            # When "Balances" appears in a line, all of the following lines contain "balance: wallet" until an empty line
53            cli_get_info["Balances"] = {}
54            while line_idx < len(lines) and not (lines[line_idx + 1] == ''):
55                line_idx += 1
56                balance, wallet = lines[line_idx].strip().split(" ")
57                # Remove right justification padding
58                wallet = wallet.strip()
59                if wallet == '""':
60                    # Set default wallet("") to empty string
61                    wallet = ''
62                cli_get_info["Balances"][wallet] = balance.strip()
63        elif ": " in line:
64            key, value = line.split(": ")
65            if key == 'Wallet' and value == '""':
66                # Set default wallet("") to empty string
67                value = ''
68            if key == "Proxies" and value == "n/a":
69                # Set N/A to empty string to represent no proxy
70                value = ''
71            cli_get_info[key.strip()] = value.strip()
72        line_idx += 1
73    return cli_get_info
74
75
76class TestBitcoinCli(BitcoinTestFramework):
77    def set_test_params(self):
78        self.setup_clean_chain = True
79        self.num_nodes = 1
80        self.uses_wallet = None
81
82    def skip_test_if_missing_module(self):
83        self.skip_if_no_cli()
84
85    def test_netinfo(self):
86        """Test -netinfo output format."""
87        self.log.info("Test -netinfo header and separate local services line")
88        out = self.nodes[0].cli('-netinfo').send_cli().splitlines()
89        assert out[0].startswith(f"{self.config['environment']['CLIENT_NAME']} client ")
90        assert any(re.match(r"^Local services:.+network", line) for line in out)
91
92        self.log.info("Test -netinfo local services are moved to header if details are requested")
93        det = self.nodes[0].cli('-netinfo', '1').send_cli().splitlines()
94        self.log.debug(f"Test -netinfo 1 header output: {det[0]}")
95        assert re.match(rf"^{re.escape(self.config['environment']['CLIENT_NAME'])} client.+services nwl2?$", det[0])
96        assert not any(line.startswith("Local services:") for line in det)
97
98    def test_echojson_positional_equals(self):
99        """Test JSON parameter parsing containing '=' with -named echojson"""
100        self.log.info("Test JSON parameter parsing containing '=' is handled correctly with -named")
101
102        # This should be treated as a positional JSON argument, not as a named
103        result = self.nodes[0].cli("-named", "echojson", '["key=value"]').send_cli()
104        assert_equal(result, [["key=value"]])
105
106        result = self.nodes[0].cli("-named", "echojson", '["key=value", "another=test"]').send_cli()
107        assert_equal(result, [["key=value", "another=test"]])
108
109        result = self.nodes[0].cli("-named", "echojson", '["data=test"]', "42").send_cli()
110        expected = [["data=test"], 42]
111        assert_equal(result, expected)
112
113        # This should be treated as a named parameter, as arg0 and arg1 are valid parameter names
114        result = self.nodes[0].cli("-named", "echojson", 'arg0=["data=test"]', 'arg1=42').send_cli()
115        expected = [["data=test"], 42]
116        assert_equal(result, expected)
117
118    def run_test(self):
119        """Main test logic"""
120        self.test_echojson_positional_equals()
121
122        self.generate(self.nodes[0], BLOCKS)
123
124        self.log.info("Compare responses from getblockchaininfo RPC and `bitcoin-cli getblockchaininfo`")
125        cli_response = self.nodes[0].cli.getblockchaininfo()
126        rpc_response = self.nodes[0].getblockchaininfo()
127        assert_equal(cli_response, rpc_response)
128
129        self.log.info("Test named arguments")
130        assert_equal(self.nodes[0].cli.echo(0, 1, arg3=3, arg5=5), ['0', '1', None, '3', None, '5'])
131        assert_raises_rpc_error(-8, "Parameter arg1 specified twice both as positional and named argument", self.nodes[0].cli.echo, 0, 1, arg1=1)
132        assert_raises_rpc_error(-8, "Parameter arg1 specified twice both as positional and named argument", self.nodes[0].cli.echo, 0, None, 2, arg1=1)
133
134        self.log.info("Test that later cli named arguments values silently overwrite earlier ones")
135        assert_equal(self.nodes[0].cli("-named", "echo", "arg0=0", "arg1=1", "arg2=2", "arg1=3").send_cli(), ['0', '3', '2'])
136        assert_raises_rpc_error(-8, "Parameter args specified multiple times", self.nodes[0].cli("-named", "echo", "args=[0,1,2,3]", "4", "5", "6", ).send_cli)
137
138        user, password = get_auth_cookie(self.nodes[0].datadir_path, self.chain)
139
140        self.log.info("Test -stdinrpcpass option")
141        assert_equal(BLOCKS, self.nodes[0].cli(f'-rpcuser={user}', '-stdinrpcpass', input=password).getblockcount())
142        assert_raises_process_error(1, 'Incorrect rpcuser or rpcpassword were specified', self.nodes[0].cli(f'-rpcuser={user}', '-stdinrpcpass', input='foo').echo)
143
144        self.log.info("Test -stdin and -stdinrpcpass")
145        assert_equal(['foo', 'bar'], self.nodes[0].cli(f'-rpcuser={user}', '-stdin', '-stdinrpcpass', input=f'{password}\nfoo\nbar').echo())
146        assert_raises_process_error(1, 'Incorrect rpcuser or rpcpassword were specified', self.nodes[0].cli(f'-rpcuser={user}', '-stdin', '-stdinrpcpass', input='foo').echo)
147
148        self.log.info("Test -rpcclienttimeout=0 (no timeout)")
149        assert_equal(BLOCKS, self.nodes[0].cli('-rpcclienttimeout=0').getblockcount())
150
151        self.log.info("Test connecting to a non-existing server")
152        assert_raises_process_error(1, "Could not connect to the server", self.nodes[0].cli('-rpcport=1').echo)
153
154        self.log.info("Test handling of invalid ports in rpcconnect")
155        assert_raises_process_error(1, "Invalid port provided in -rpcconnect: 127.0.0.1:notaport", self.nodes[0].cli("-rpcconnect=127.0.0.1:notaport").echo)
156        assert_raises_process_error(1, "Invalid port provided in -rpcconnect: 127.0.0.1:-1", self.nodes[0].cli("-rpcconnect=127.0.0.1:-1").echo)
157        assert_raises_process_error(1, "Invalid port provided in -rpcconnect: 127.0.0.1:0", self.nodes[0].cli("-rpcconnect=127.0.0.1:0").echo)
158        assert_raises_process_error(1, "Invalid port provided in -rpcconnect: 127.0.0.1:65536", self.nodes[0].cli("-rpcconnect=127.0.0.1:65536").echo)
159
160        self.log.info("Checking for IPv6")
161        have_ipv6 = test_ipv6_local()
162        if not have_ipv6:
163            self.log.info("Skipping IPv6 tests")
164
165        if have_ipv6:
166            assert_raises_process_error(1, "Invalid port provided in -rpcconnect: [::1]:notaport", self.nodes[0].cli("-rpcconnect=[::1]:notaport").echo)
167            assert_raises_process_error(1, "Invalid port provided in -rpcconnect: [::1]:-1", self.nodes[0].cli("-rpcconnect=[::1]:-1").echo)
168            assert_raises_process_error(1, "Invalid port provided in -rpcconnect: [::1]:0", self.nodes[0].cli("-rpcconnect=[::1]:0").echo)
169            assert_raises_process_error(1, "Invalid port provided in -rpcconnect: [::1]:65536", self.nodes[0].cli("-rpcconnect=[::1]:65536").echo)
170
171        self.log.info("Test handling of invalid ports in rpcport")
172        assert_raises_process_error(1, "Invalid port provided in -rpcport: notaport", self.nodes[0].cli("-rpcport=notaport").echo)
173        assert_raises_process_error(1, "Invalid port provided in -rpcport: -1", self.nodes[0].cli("-rpcport=-1").echo)
174        assert_raises_process_error(1, "Invalid port provided in -rpcport: 0", self.nodes[0].cli("-rpcport=0").echo)
175        assert_raises_process_error(1, "Invalid port provided in -rpcport: 65536", self.nodes[0].cli("-rpcport=65536").echo)
176
177        self.log.info("Test port usage preferences")
178        node_rpc_port = rpc_port(self.nodes[0].index)
179        # Prevent bitcoin-cli from using existing rpcport in conf
180        conf_rpcport = "rpcport=" + str(node_rpc_port)
181        self.nodes[0].replace_in_config([(conf_rpcport, "#" + conf_rpcport)])
182        # prefer rpcport over rpcconnect
183        assert_raises_process_error(1, "Error while attempting to communicate with server 127.0.0.1:1 (Could not connect to the server)", self.nodes[0].cli(f"-rpcconnect=127.0.0.1:{node_rpc_port}", "-rpcport=1").echo)
184        if have_ipv6:
185            assert_raises_process_error(1, "Error while attempting to communicate with server ::1:1 (Could not connect to the server)", self.nodes[0].cli(f"-rpcconnect=[::1]:{node_rpc_port}", "-rpcport=1").echo)
186
187        assert_equal(BLOCKS, self.nodes[0].cli("-rpcconnect=127.0.0.1:18999", f'-rpcport={node_rpc_port}').getblockcount())
188        if have_ipv6:
189            assert_equal(BLOCKS, self.nodes[0].cli("-rpcconnect=[::1]:18999", f'-rpcport={node_rpc_port}').getblockcount())
190
191        # prefer rpcconnect port over default
192        assert_equal(BLOCKS, self.nodes[0].cli(f"-rpcconnect=127.0.0.1:{node_rpc_port}").getblockcount())
193        if have_ipv6:
194            assert_equal(BLOCKS, self.nodes[0].cli(f"-rpcconnect=[::1]:{node_rpc_port}").getblockcount())
195
196        # prefer rpcport over default
197        assert_equal(BLOCKS, self.nodes[0].cli(f'-rpcport={node_rpc_port}').getblockcount())
198        # Re-enable rpcport in conf if present
199        self.nodes[0].replace_in_config([("#" + conf_rpcport, conf_rpcport)])
200
201        self.log.info("Test connecting with non-existing RPC cookie file")
202        assert_raises_process_error(1, "Failed to read cookie file and no rpcpassword was specified.", self.nodes[0].cli('-rpccookiefile=does-not-exist', '-rpcpassword=').echo)
203
204        self.log.info("Test connecting with neither cookie file, nor password")
205        assert_raises_process_error(1, "Cookie file was disabled via -norpccookiefile and no rpcpassword was specified.", self.nodes[0].cli("-norpccookiefile").echo)
206        assert_raises_process_error(1, "Cookie file was disabled via -norpccookiefile and no rpcpassword was specified.", self.nodes[0].cli("-norpccookiefile", "-rpcpassword=").echo)
207
208        self.log.info("Test connecting with invalid cookie file")
209        assert_raises_process_error(1, "Cookie file credentials were invalid and no rpcpassword was specified.", self.nodes[0].cli(f"-rpccookiefile={self.nodes[0].datadir_path / 'bitcoin.conf'}").echo)
210
211        self.log.info("Test connecting without RPC cookie file and with password arg")
212        assert_equal(BLOCKS, self.nodes[0].cli('-norpccookiefile', f'-rpcuser={user}', f'-rpcpassword={password}').getblockcount())
213
214        self.log.info("Test -getinfo with arguments fails")
215        assert_raises_process_error(1, "-getinfo takes no arguments", self.nodes[0].cli('-getinfo').help)
216
217        self.log.info("Test -getinfo with -color=never does not return ANSI escape codes")
218        assert "\u001b[0m" not in self.nodes[0].cli('-getinfo', '-color=never').send_cli()
219
220        self.log.info("Test -getinfo with -color=always returns ANSI escape codes")
221        assert "\u001b[0m" in self.nodes[0].cli('-getinfo', '-color=always').send_cli()
222
223        self.log.info("Test -getinfo with invalid value for -color option")
224        assert_raises_process_error(1, "Invalid value for -color option. Valid values: always, auto, never.", self.nodes[0].cli('-getinfo', '-color=foo').send_cli)
225
226        self.log.info("Test -getinfo returns expected network and blockchain info")
227        if self.is_wallet_compiled():
228            self.import_deterministic_coinbase_privkeys()
229            self.nodes[0].encryptwallet(password)
230        cli_get_info_string = self.nodes[0].cli('-getinfo').send_cli()
231        cli_get_info = cli_get_info_string_to_dict(cli_get_info_string)
232
233        network_info = self.nodes[0].getnetworkinfo()
234        blockchain_info = self.nodes[0].getblockchaininfo()
235        assert_equal(int(cli_get_info['Version']), network_info['version'])
236        assert_equal(cli_get_info['Verification progress'], "%.4f%%" % (blockchain_info['verificationprogress'] * 100))
237        assert_equal(int(cli_get_info['Blocks']), blockchain_info['blocks'])
238        assert_equal(int(cli_get_info['Headers']), blockchain_info['headers'])
239        assert_equal(int(cli_get_info['Time offset (s)']), network_info['timeoffset'])
240        expected_network_info = f"in {network_info['connections_in']}, out {network_info['connections_out']}, total {network_info['connections']}"
241        assert_equal(cli_get_info["Network"], expected_network_info)
242        assert_equal(cli_get_info['Proxies'], network_info['networks'][0]['proxy'])
243        assert_equal(Decimal(cli_get_info['Difficulty']), blockchain_info['difficulty'])
244        assert_equal(cli_get_info['Chain'], blockchain_info['chain'])
245
246        self.log.info("Test -getinfo and bitcoin-cli return all proxies")
247        self.restart_node(0, extra_args=["-proxy=127.0.0.1:9050", "-i2psam=127.0.0.1:7656"])
248        network_info = self.nodes[0].getnetworkinfo()
249        cli_get_info_string = self.nodes[0].cli('-getinfo').send_cli()
250        cli_get_info = cli_get_info_string_to_dict(cli_get_info_string)