1  #!/usr/bin/env python3
  2  # Copyright (c) 2020-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 error messages for 'getaddressinfo' and 'validateaddress' RPC commands."""
  6  
  7  from test_framework.test_framework import BitcoinTestFramework
  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(BitcoinTestFramework):
 43      def set_test_params(self):
 44          self.setup_clean_chain = True
 45          self.num_nodes = 1
 46          self.uses_wallet = None
 47  
 48      def check_valid(self, addr):
 49          info = self.nodes[0].validateaddress(addr)
 50          assert info['isvalid']
 51          assert 'error' not in info
 52          assert 'error_locations' not in info
 53  
 54      def check_invalid(self, addr, error_str, error_locations=None):
 55          res = self.nodes[0].validateaddress(addr)
 56          assert not res['isvalid']
 57          assert_equal(res['error'], error_str)
 58          if error_locations:
 59              assert_equal(res['error_locations'], error_locations)
 60          else:
 61              assert_equal(res['error_locations'], [])
 62  
 63      def test_validateaddress(self):
 64          # Invalid Bech32
 65          self.check_invalid(BECH32_INVALID_SIZE, "Invalid Bech32 address program size (41 bytes)")
 66          self.check_invalid(BECH32_INVALID_PREFIX, 'Invalid or unsupported Segwit (Bech32) or Base58 encoding.')
 67          self.check_invalid(BECH32_INVALID_BECH32, 'Version 1+ witness address must use Bech32m checksum')
 68          self.check_invalid(BECH32_INVALID_BECH32M, 'Version 0 witness address must use Bech32 checksum')
 69          self.check_invalid(BECH32_INVALID_VERSION, 'Invalid Bech32 address witness version')
 70          self.check_invalid(BECH32_INVALID_V0_SIZE, "Invalid Bech32 v0 address program size (21 bytes), per BIP141")
 71          self.check_invalid(BECH32_TOO_LONG, 'Bech32 string too long', list(range(90, 108)))
 72          self.check_invalid(BECH32_ONE_ERROR, 'Invalid Bech32 checksum', [9])
 73          self.check_invalid(BECH32_TWO_ERRORS, 'Invalid Bech32 checksum', [22, 43])
 74          self.check_invalid(BECH32_ONE_ERROR_CAPITALS, 'Invalid Bech32 checksum', [38])
 75          self.check_invalid(BECH32_NO_SEPARATOR, 'Missing separator')
 76          self.check_invalid(BECH32_INVALID_CHAR, 'Invalid Base 32 character', [8])
 77          self.check_invalid(BECH32_MULTISIG_TWO_ERRORS, 'Invalid Bech32 checksum', [19, 30])
 78          self.check_invalid(BECH32_WRONG_VERSION, 'Invalid Bech32 checksum', [5])
 79  
 80          # Valid Bech32
 81          self.check_valid(BECH32_VALID)
 82          self.check_valid(BECH32_VALID_UNKNOWN_WITNESS)
 83          self.check_valid(BECH32_VALID_CAPITALS)
 84          self.check_valid(BECH32_VALID_MULTISIG)
 85  
 86          # Invalid Base58
 87          self.check_invalid(BASE58_INVALID_PREFIX, 'Invalid or unsupported Base58-encoded address.')
 88          self.check_invalid(BASE58_INVALID_CHECKSUM, 'Invalid checksum or length of Base58 address (P2PKH or P2SH)')
 89          self.check_invalid(BASE58_INVALID_LENGTH, 'Invalid checksum or length of Base58 address (P2PKH or P2SH)')
 90  
 91          # Valid Base58
 92          self.check_valid(BASE58_VALID)
 93  
 94          # Invalid address format
 95          self.check_invalid(INVALID_ADDRESS, 'Invalid or unsupported Segwit (Bech32) or Base58 encoding.')
 96          self.check_invalid(INVALID_ADDRESS_2, 'Invalid or unsupported Segwit (Bech32) or Base58 encoding.')
 97  
 98          node = self.nodes[0]
 99  
100  
101          if not self.options.usecli:
102              # Missing arg returns the help text
103              assert_raises_rpc_error(-1, "Return information about the given bitcoin address.", node.validateaddress)
104              # Explicit None is not allowed for required parameters
105              assert_raises_rpc_error(-3, "JSON value of type null is not of expected type string", node.validateaddress, None)
106  
107      def test_getaddressinfo(self):
108          node = self.nodes[0]
109  
110          assert_raises_rpc_error(-5, "Invalid Bech32 address program size (41 bytes)", node.getaddressinfo, BECH32_INVALID_SIZE)
111          assert_raises_rpc_error(-5, "Invalid or unsupported Segwit (Bech32) or Base58 encoding.", node.getaddressinfo, BECH32_INVALID_PREFIX)
112          assert_raises_rpc_error(-5, "Invalid or unsupported Base58-encoded address.", node.getaddressinfo, BASE58_INVALID_PREFIX)
113          assert_raises_rpc_error(-5, "Invalid or unsupported Segwit (Bech32) or Base58 encoding.", node.getaddressinfo, INVALID_ADDRESS)
114          assert "isscript" not in node.getaddressinfo(BECH32_VALID_UNKNOWN_WITNESS)
115  
116      def run_test(self):
117          self.test_validateaddress()
118  
119          if self.is_wallet_compiled():
120              self.init_wallet(node=0)
121              self.test_getaddressinfo()
122  
123  
124  if __name__ == '__main__':
125      InvalidAddressErrorMessageTest(__file__).main()