base58_tests.cpp raw

   1  // Copyright (c) 2011-present The Bitcoin Core developers
   2  // Distributed under the MIT software license, see the accompanying
   3  // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   4  
   5  #include <test/data/base58_encode_decode.json.h>
   6  
   7  #include <base58.h>
   8  #include <test/util/json.h>
   9  #include <test/util/random.h>
  10  #include <test/util/setup_common.h>
  11  #include <util/strencodings.h>
  12  #include <util/vector.h>
  13  
  14  #include <univalue.h>
  15  
  16  #include <boost/test/unit_test.hpp>
  17  #include <string>
  18  
  19  using namespace std::literals;
  20  using namespace util::hex_literals;
  21  
  22  BOOST_FIXTURE_TEST_SUITE(base58_tests, BasicTestingSetup)
  23  
  24  // Goal: test low-level base58 encoding functionality
  25  BOOST_AUTO_TEST_CASE(base58_EncodeBase58)
  26  {
  27      UniValue tests = read_json(json_tests::base58_encode_decode);
  28      for (unsigned int idx = 0; idx < tests.size(); idx++) {
  29          const UniValue& test = tests[idx];
  30          std::string strTest = test.write();
  31          if (test.size() < 2) // Allow for extra stuff (useful for comments)
  32          {
  33              BOOST_ERROR("Bad test: " << strTest);
  34              continue;
  35          }
  36          std::vector<unsigned char> sourcedata = ParseHex(test[0].get_str());
  37          std::string base58string = test[1].get_str();
  38          BOOST_CHECK_MESSAGE(
  39                      EncodeBase58(sourcedata) == base58string,
  40                      strTest);
  41      }
  42  }
  43  
  44  // Goal: test low-level base58 decoding functionality
  45  BOOST_AUTO_TEST_CASE(base58_DecodeBase58)
  46  {
  47      UniValue tests = read_json(json_tests::base58_encode_decode);
  48      std::vector<unsigned char> result;
  49  
  50      for (unsigned int idx = 0; idx < tests.size(); idx++) {
  51          const UniValue& test = tests[idx];
  52          std::string strTest = test.write();
  53          if (test.size() < 2) // Allow for extra stuff (useful for comments)
  54          {
  55              BOOST_ERROR("Bad test: " << strTest);
  56              continue;
  57          }
  58          std::vector<unsigned char> expected = ParseHex(test[0].get_str());
  59          std::string base58string = test[1].get_str();
  60          BOOST_CHECK_MESSAGE(DecodeBase58(base58string, result, 256), strTest);
  61          BOOST_CHECK_MESSAGE(result.size() == expected.size() && std::equal(result.begin(), result.end(), expected.begin()), strTest);
  62      }
  63  
  64      BOOST_CHECK(!DecodeBase58("invalid"s, result, 100));
  65      BOOST_CHECK(!DecodeBase58("invalid\0"s, result, 100));
  66      BOOST_CHECK(!DecodeBase58("\0invalid"s, result, 100));
  67  
  68      BOOST_CHECK( DecodeBase58("good"s, result, 100));
  69      BOOST_CHECK(!DecodeBase58("bad0IOl"s, result, 100));
  70      BOOST_CHECK(!DecodeBase58("goodbad0IOl"s, result, 100));
  71      BOOST_CHECK(!DecodeBase58("good\0bad0IOl"s, result, 100));
  72  
  73      // check that DecodeBase58 skips whitespace, but still fails with unexpected non-whitespace at the end.
  74      BOOST_CHECK(!DecodeBase58(" \t\n\v\f\r skip \r\f\v\n\t a", result, 3));
  75      BOOST_CHECK( DecodeBase58(" \t\n\v\f\r skip \r\f\v\n\t ", result, 3));
  76      constexpr auto expected{"971a55"_hex_u8};
  77      BOOST_CHECK_EQUAL_COLLECTIONS(result.begin(), result.end(), expected.begin(), expected.end());
  78  
  79      BOOST_CHECK( DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oh"s, result, 100));
  80      BOOST_CHECK(!DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oi"s, result, 100));
  81      BOOST_CHECK(!DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oh0IOl"s, result, 100));
  82      BOOST_CHECK(!DecodeBase58Check("3vQB7B6MrGQZaxCuFg4oh\0" "0IOl"s, result, 100));
  83  }
  84  
  85  BOOST_AUTO_TEST_SUITE_END()
  86