rpc_invalid_address_message.py raw
1 #!/usr/bin/env python3
2 # Copyright (c) 2020-present The Limenka 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 error messages for 'getaddressinfo' and 'validateaddress' RPC commands."""
6
7 from test_framework.test_framework import LimenkaTestFramework
8
9 from test_framework.util import (
10 assert_equal,
11 assert_raises_rpc_error,
12 )
13
14 BECH32_VALID = 'bcrt1qtmp74ayg7p24uslctssvjm06q5phz4yrxucgnv'
15 BECH32_VALID_UNKNOWN_WITNESS = 'bcrt1p424qxxyd0r'
16 BECH32_VALID_CAPITALS = 'BCRT1QPLMTZKC2XHARPPZDLNPAQL78RSHJ68U33RAH7R'
17 BECH32_VALID_MULTISIG = 'bcrt1qdg3myrgvzw7ml9q0ejxhlkyxm7vl9r56yzkfgvzclrf4hkpx9yfqhpsuks'
18
19 BECH32_INVALID_BECH32 = 'bcrt1p0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqdmchcc'
20 BECH32_INVALID_BECH32M = 'bcrt1qw508d6qejxtdg4y5r3zarvary0c5xw7k35mrzd'
21 BECH32_INVALID_VERSION = 'bcrt130xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7vqynjegk'
22 BECH32_INVALID_SIZE = 'bcrt1s0xlxvlhemja6c4dqv22uapctqupfhlxm9h8z3k2e72q4k9hcz7v8n0nx0muaewav25430mtr'
23 BECH32_INVALID_V0_SIZE = 'bcrt1qw508d6qejxtdg4y5r3zarvary0c5xw7kqqq5k3my'
24 BECH32_INVALID_PREFIX = 'bc1pw508d6qejxtdg4y5r3zarvary0c5xw7kw508d6qejxtdg4y5r3zarvary0c5xw7k7grplx'
25 BECH32_TOO_LONG = 'bcrt1q049edschfnwystcqnsvyfpj23mpsg3jcedq9xv049edschfnwystcqnsvyfpj23mpsg3jcedq9xv049edschfnwystcqnsvyfpj23m'
26 BECH32_ONE_ERROR = 'bcrt1q049edschfnwystcqnsvyfpj23mpsg3jcedq9xv'
27 BECH32_ONE_ERROR_CAPITALS = 'BCRT1QPLMTZKC2XHARPPZDLNPAQL78RSHJ68U32RAH7R'
28 BECH32_TWO_ERRORS = 'bcrt1qax9suht3qv95sw33xavx8crpxduefdrsvgsklu' # should be bcrt1qax9suht3qv95sw33wavx8crpxduefdrsvgsklx
29 BECH32_NO_SEPARATOR = 'bcrtq049ldschfnwystcqnsvyfpj23mpsg3jcedq9xv'
30 BECH32_INVALID_CHAR = 'bcrt1q04oldschfnwystcqnsvyfpj23mpsg3jcedq9xv'
31 BECH32_MULTISIG_TWO_ERRORS = 'bcrt1qdg3myrgvzw7ml8q0ejxhlkyxn7vl9r56yzkfgvzclrf4hkpx9yfqhpsuks'
32 BECH32_WRONG_VERSION = 'bcrt1ptmp74ayg7p24uslctssvjm06q5phz4yrxucgnv'
33
34 BASE58_VALID = 'mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJRfn'
35 BASE58_INVALID_PREFIX = '17VZNX1SN5NtKa8UQFxwQbFeFc3iqRYhem'
36 BASE58_INVALID_CHECKSUM = 'mipcBbFg9gMiCh81Kj8tqqdgoZub1ZJJfn'
37 BASE58_INVALID_LENGTH = '2VKf7XKMrp4bVNVmuRbyCewkP8FhGLP2E54LHDPakr9Sq5mtU2'
38
39 INVALID_ADDRESS = 'asfah14i8fajz0123f'
40 INVALID_ADDRESS_2 = '1q049ldschfnwystcqnsvyfpj23mpsg3jcedq9xv'
41
42 class InvalidAddressErrorMessageTest(LimenkaTestFramework):
43 def add_options(self, parser):
44 self.add_wallet_options(parser)
45
46 def set_test_params(self):
47 self.setup_clean_chain = True
48 self.num_nodes = 1
49
50 def check_valid(self, addr):
51 info = self.nodes[0].validateaddress(addr)
52 assert info['isvalid']
53 assert 'error' not in info
54 assert 'error_index' not in info
55 assert 'error_locations' not in info
56
57 def check_invalid(self, addr, error_str, error_locations=None):
58 res = self.nodes[0].validateaddress(addr)
59 if addr[:2] == 'bc':
60 assert_equal(res, self.nodes[0].validateaddress(address=addr, address_type='bech32'))
61 assert not res['isvalid']
62 assert_equal(res['error'], error_str)
63 if error_locations:
64 assert_equal(res['error_index'], error_locations[0])
65 assert_equal(res['error_locations'], error_locations)
66 else:
67 assert 'error_index' not in res
68 assert_equal(res['error_locations'], [])
69
70 def test_validateaddress(self):
71 # Invalid deprecated address_type field
72 assert_raises_rpc_error(-8, "Unknown address type 'nonsense'", self.nodes[0].validateaddress, address=BECH32_INVALID_SIZE, address_type='nonsense')
73 for inv_addrtype in (7, True, {}, [], ['bech32']):
74 assert_raises_rpc_error(-3, "is not of expected type string", self.nodes[0].validateaddress, address=BECH32_INVALID_SIZE, address_type=inv_addrtype)
75
76 # Invalid Bech32
77 self.check_invalid(BECH32_INVALID_SIZE, "Invalid Bech32 address program size (41 bytes)")
78 self.check_invalid(BECH32_INVALID_PREFIX, 'Invalid or unsupported Segwit (Bech32) or Base58 encoding.')
79 self.check_invalid(BECH32_INVALID_BECH32, 'Version 1+ witness address must use Bech32m checksum')
80 self.check_invalid(BECH32_INVALID_BECH32M, 'Version 0 witness address must use Bech32 checksum')
81 self.check_invalid(BECH32_INVALID_VERSION, 'Invalid Bech32 address witness version')
82 self.check_invalid(BECH32_INVALID_V0_SIZE, "Invalid Bech32 v0 address program size (21 bytes), per BIP141")
83 self.check_invalid(BECH32_TOO_LONG, 'Bech32 string too long', list(range(90, 108)))
84 self.check_invalid(BECH32_ONE_ERROR, 'Invalid Bech32 checksum', [9])
85 self.check_invalid(BECH32_TWO_ERRORS, 'Invalid Bech32 checksum', [22, 43])
86 self.check_invalid(BECH32_ONE_ERROR_CAPITALS, 'Invalid Bech32 checksum', [38])
87 self.check_invalid(BECH32_NO_SEPARATOR, 'Missing separator')
88 self.check_invalid(BECH32_INVALID_CHAR, 'Invalid Base 32 character', [8])
89 self.check_invalid(BECH32_MULTISIG_TWO_ERRORS, 'Invalid Bech32 checksum', [19, 30])
90 self.check_invalid(BECH32_WRONG_VERSION, 'Invalid Bech32 checksum', [5])
91
92 # Valid Bech32
93 self.check_valid(BECH32_VALID)
94 self.check_valid(BECH32_VALID_UNKNOWN_WITNESS)
95 self.check_valid(BECH32_VALID_CAPITALS)
96 self.check_valid(BECH32_VALID_MULTISIG)
97
98 # Invalid Base58
99 self.check_invalid(BASE58_INVALID_PREFIX, 'Invalid or unsupported Base58-encoded address.')
100 self.check_invalid(BASE58_INVALID_CHECKSUM, 'Invalid checksum or length of Base58 address (P2PKH or P2SH)')
101 self.check_invalid(BASE58_INVALID_LENGTH, 'Invalid checksum or length of Base58 address (P2PKH or P2SH)')
102
103 # Valid Base58
104 self.check_valid(BASE58_VALID)
105
106 # Invalid address format
107 self.check_invalid(INVALID_ADDRESS, 'Invalid or unsupported Segwit (Bech32) or Base58 encoding.')
108 self.check_invalid(INVALID_ADDRESS_2, 'Invalid or unsupported Segwit (Bech32) or Base58 encoding.')
109
110 node = self.nodes[0]
111
112 # Missing arg returns the help text
113 assert_raises_rpc_error(-1, "Return information about the given limenka address.", node.validateaddress)
114 # Explicit None is not allowed for required parameters
115 assert_raises_rpc_error(-3, "JSON value of type null is not of expected type string", node.validateaddress, None)
116
117 def test_getaddressinfo(self):
118 node = self.nodes[0]
119
120 assert_raises_rpc_error(-5, "Invalid Bech32 address program size (41 bytes)", node.getaddressinfo, BECH32_INVALID_SIZE)
121 assert_raises_rpc_error(-5, "Invalid or unsupported Segwit (Bech32) or Base58 encoding.", node.getaddressinfo, BECH32_INVALID_PREFIX)
122 assert_raises_rpc_error(-5, "Invalid or unsupported Base58-encoded address.", node.getaddressinfo, BASE58_INVALID_PREFIX)
123 assert_raises_rpc_error(-5, "Invalid or unsupported Segwit (Bech32) or Base58 encoding.", node.getaddressinfo, INVALID_ADDRESS)
124 assert "isscript" not in node.getaddressinfo(BECH32_VALID_UNKNOWN_WITNESS)
125
126 def run_test(self):
127 self.test_validateaddress()
128
129 if self.is_wallet_compiled():
130 self.init_wallet(node=0)
131 self.test_getaddressinfo()
132
133
134 if __name__ == '__main__':
135 InvalidAddressErrorMessageTest(__file__).main()
136