LCOV - code coverage report
Current view: top level - src - base58.cpp (source / functions) Hit Total Coverage
Test: test_dash_coverage.info Lines: 92 93 98.9 %
Date: 2026-06-25 07:23:51 Functions: 6 6 100.0 %

          Line data    Source code
       1             : // Copyright (c) 2014-2021 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 <base58.h>
       6             : 
       7             : #include <hash.h>
       8             : #include <uint256.h>
       9             : #include <util/strencodings.h>
      10             : #include <util/string.h>
      11             : 
      12             : #include <assert.h>
      13             : #include <stdint.h>
      14             : 
      15             : #include <limits>
      16             : 
      17             : /** All alphanumeric characters except for "0", "I", "O", and "l" */
      18             : static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
      19             : static const int8_t mapBase58[256] = {
      20             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      21             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      22             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      23             :     -1, 0, 1, 2, 3, 4, 5, 6,  7, 8,-1,-1,-1,-1,-1,-1,
      24             :     -1, 9,10,11,12,13,14,15, 16,-1,17,18,19,20,21,-1,
      25             :     22,23,24,25,26,27,28,29, 30,31,32,-1,-1,-1,-1,-1,
      26             :     -1,33,34,35,36,37,38,39, 40,41,42,43,-1,44,45,46,
      27             :     47,48,49,50,51,52,53,54, 55,56,57,-1,-1,-1,-1,-1,
      28             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      29             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      30             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      31             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      32             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      33             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      34             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      35             :     -1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
      36             : };
      37             : 
      38        9090 : [[nodiscard]] static bool DecodeBase58(const char* psz, std::vector<unsigned char>& vch, int max_ret_len)
      39             : {
      40             :     // Skip leading spaces.
      41        9104 :     while (*psz && IsSpace(*psz))
      42          14 :         psz++;
      43             :     // Skip and count leading '1's.
      44        9090 :     int zeroes = 0;
      45        9090 :     int length = 0;
      46       65984 :     while (*psz == '1') {
      47       57092 :         zeroes++;
      48       57092 :         if (zeroes > max_ret_len) return false;
      49       56894 :         psz++;
      50             :     }
      51             :     // Allocate enough space in big-endian base256 representation.
      52        8892 :     int size = strlen(psz) * 733 /1000 + 1; // log(58) / log(256), rounded up.
      53        8892 :     std::vector<unsigned char> b256(size);
      54             :     // Process the characters.
      55             :     static_assert(std::size(mapBase58) == 256, "mapBase58.size() should be 256"); // guarantee not out of range
      56      477213 :     while (*psz && !IsSpace(*psz)) {
      57             :         // Decode base58 character
      58      469372 :         int carry = mapBase58[(uint8_t)*psz];
      59      469372 :         if (carry == -1)  // Invalid b58 character
      60          49 :             return false;
      61      469323 :         int i = 0;
      62    38183823 :         for (std::vector<unsigned char>::reverse_iterator it = b256.rbegin(); (carry != 0 || i < length) && (it != b256.rend()); ++it, ++i) {
      63    18857250 :             carry += 58 * (*it);
      64    18857250 :             *it = carry % 256;
      65    18857250 :             carry /= 256;
      66    18857250 :         }
      67      469323 :         assert(carry == 0);
      68      469323 :         length = i;
      69      469323 :         if (length + zeroes > max_ret_len) return false;
      70      468321 :         psz++;
      71             :     }
      72             :     // Skip trailing spaces.
      73        7855 :     while (IsSpace(*psz))
      74          14 :         psz++;
      75        7841 :     if (*psz != 0)
      76           1 :         return false;
      77             :     // Skip leading zeroes in b256.
      78        7840 :     std::vector<unsigned char>::iterator it = b256.begin() + (size - length);
      79             :     // Copy result into output vector.
      80        7840 :     vch.reserve(zeroes + (b256.end() - it));
      81        7840 :     vch.assign(zeroes, 0x00);
      82      298182 :     while (it != b256.end())
      83      290342 :         vch.push_back(*(it++));
      84        7840 :     return true;
      85        9090 : }
      86             : 
      87       44780 : std::string EncodeBase58(Span<const unsigned char> input)
      88             : {
      89             :     // Skip & count leading zeroes.
      90       44780 :     int zeroes = 0;
      91       44780 :     int length = 0;
      92       77840 :     while (input.size() > 0 && input[0] == 0) {
      93       33060 :         input = input.subspan(1);
      94       33060 :         zeroes++;
      95             :     }
      96             :     // Allocate enough space in big-endian base58 representation.
      97       44780 :     int size = input.size() * 138 / 100 + 1; // log(256) / log(58), rounded up.
      98       44780 :     std::vector<unsigned char> b58(size);
      99             :     // Process the bytes.
     100     1900468 :     while (input.size() > 0) {
     101     1855688 :         int carry = input[0];
     102     1855688 :         int i = 0;
     103             :         // Apply "b58 = b58 * 256 + ch".
     104   159056010 :         for (std::vector<unsigned char>::reverse_iterator it = b58.rbegin(); (carry != 0 || i < length) && (it != b58.rend()); it++, i++) {
     105    78600161 :             carry += 256 * (*it);
     106    78600161 :             *it = carry % 58;
     107    78600161 :             carry /= 58;
     108    78600161 :         }
     109             : 
     110     1855688 :         assert(carry == 0);
     111     1855688 :         length = i;
     112     1855688 :         input = input.subspan(1);
     113             :     }
     114             :     // Skip leading zeroes in base58 result.
     115       44780 :     std::vector<unsigned char>::iterator it = b58.begin() + (size - length);
     116       44780 :     while (it != b58.end() && *it == 0)
     117           0 :         it++;
     118             :     // Translate the result into a string.
     119       44780 :     std::string str;
     120       44780 :     str.reserve(zeroes + (b58.end() - it));
     121       44780 :     str.assign(zeroes, '1');
     122     2563345 :     while (it != b58.end())
     123     2518565 :         str += pszBase58[*(it++)];
     124       44780 :     return str;
     125       44780 : }
     126             : 
     127          23 : bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret_len)
     128             : {
     129          23 :     if (!ContainsNoNUL(str)) {
     130           3 :         return false;
     131             :     }
     132          20 :     return DecodeBase58(str.c_str(), vchRet, max_ret_len);
     133          23 : }
     134             : 
     135       44766 : std::string EncodeBase58Check(Span<const unsigned char> input)
     136             : {
     137             :     // add 4-byte hash check to the end
     138       44766 :     std::vector<unsigned char> vch(input.begin(), input.end());
     139       44766 :     uint256 hash = Hash(vch);
     140       44766 :     vch.insert(vch.end(), (unsigned char*)&hash, (unsigned char*)&hash + 4);
     141       44766 :     return EncodeBase58(vch);
     142       44766 : }
     143             : 
     144        9070 : [[nodiscard]] static bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet, int max_ret_len)
     145             : {
     146        9070 :     if (!DecodeBase58(psz, vchRet, max_ret_len > std::numeric_limits<int>::max() - 4 ? std::numeric_limits<int>::max() : max_ret_len + 4) ||
     147        7824 :         (vchRet.size() < 4)) {
     148        1259 :         vchRet.clear();
     149        1259 :         return false;
     150             :     }
     151             :     // re-calculate the checksum, ensure it matches the included 4-byte checksum
     152        7811 :     uint256 hash = Hash(Span{vchRet}.first(vchRet.size() - 4));
     153        7811 :     if (memcmp(&hash, &vchRet[vchRet.size() - 4], 4) != 0) {
     154          22 :         vchRet.clear();
     155          22 :         return false;
     156             :     }
     157        7789 :     vchRet.resize(vchRet.size() - 4);
     158        7789 :     return true;
     159        9070 : }
     160             : 
     161        9071 : bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret)
     162             : {
     163        9071 :     if (!ContainsNoNUL(str)) {
     164           1 :         return false;
     165             :     }
     166        9070 :     return DecodeBase58Check(str.c_str(), vchRet, max_ret);
     167        9071 : }
     168             : 

Generated by: LCOV version 1.16