2015-12-13 14:51:43 +01:00
|
|
|
// Copyright (c) 2014-2015 The Bitcoin Core developers
|
2014-10-31 01:43:19 +01:00
|
|
|
// Distributed under the MIT software license, see the accompanying
|
2014-04-12 23:34:00 +02:00
|
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
|
2020-03-19 23:46:56 +01:00
|
|
|
#include <base58.h>
|
2014-05-09 23:42:20 +02:00
|
|
|
|
2020-03-19 23:46:56 +01:00
|
|
|
#include <hash.h>
|
|
|
|
#include <uint256.h>
|
2021-06-27 08:33:13 +02:00
|
|
|
#include <util/strencodings.h>
|
|
|
|
#include <util/string.h>
|
2014-05-09 23:42:20 +02:00
|
|
|
|
2020-12-25 05:33:37 +01:00
|
|
|
#include <assert.h>
|
|
|
|
#include <stdint.h>
|
|
|
|
|
2019-12-12 10:55:37 +01:00
|
|
|
#include <limits>
|
|
|
|
|
2014-10-31 01:43:19 +01:00
|
|
|
/** All alphanumeric characters except for "0", "I", "O", and "l" */
|
2014-04-12 23:34:00 +02:00
|
|
|
static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
|
Merge #12704: base58: use map instead of strchr() when decode
bcab47b use base58 map instead of strchr() (Kevin Pan)
Pull request description:
Use array map instead of find string position.
Test code snippet:
```cpp
#include <assert.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string>
int main(int argc, const char * argv[]) {
static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
static const int8_t mapBase58[] = {
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
-1, 0, 1, 2, 3, 4, 5, 6, 7, 8,-1,-1,-1,-1,-1,-1,
-1, 9,10,11,12,13,14,15, 16,-1,17,18,19,20,21,-1,
22,23,24,25,26,27,28,29, 30,31,32,-1,-1,-1,-1,-1,
-1,33,34,35,36,37,38,39, 40,41,42,43,-1,44,45,46,
47,48,49,50,51,52,53,54, 55,56,57,-1,-1,-1,-1,-1,
};
const std::string b58Str(pszBase58);
for (size_t i = 0; i < b58Str.length(); i++) {
const char *ch = strchr(pszBase58, b58Str[i]);
printf("%d - %d\n", ch - pszBase58, mapBase58[(uint8_t)b58Str[i]]);
assert(ch - pszBase58 == mapBase58[(uint8_t)b58Str[i]]);
}
assert(mapBase58['1'] == 0);
assert(mapBase58['z'] == 57);
/** All alphanumeric characters except for "0", "I", "O", and "l" */
assert(mapBase58['0'] == -1);
assert(mapBase58['I'] == -1);
assert(mapBase58['O'] == -1);
assert(mapBase58['l'] == -1);
return 0;
}
```
Tree-SHA512: c28376dc8c92cc4a770c3282db4a568ae5f5a08e27f714183eb3d8755421dc7aa11d7b45afa55e70eba46565f378062aac53dc8f150eeeab12ce7b5db5af89c5
2018-03-22 09:59:29 +01:00
|
|
|
static const int8_t mapBase58[256] = {
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1, 0, 1, 2, 3, 4, 5, 6, 7, 8,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1, 9,10,11,12,13,14,15, 16,-1,17,18,19,20,21,-1,
|
|
|
|
22,23,24,25,26,27,28,29, 30,31,32,-1,-1,-1,-1,-1,
|
|
|
|
-1,33,34,35,36,37,38,39, 40,41,42,43,-1,44,45,46,
|
|
|
|
47,48,49,50,51,52,53,54, 55,56,57,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
|
|
|
|
};
|
2014-04-12 23:34:00 +02:00
|
|
|
|
2019-12-12 10:55:37 +01:00
|
|
|
bool DecodeBase58(const char* psz, std::vector<unsigned char>& vch, int max_ret_len)
|
2014-09-19 19:21:46 +02:00
|
|
|
{
|
2014-04-12 23:34:00 +02:00
|
|
|
// Skip leading spaces.
|
2018-10-28 11:48:46 +01:00
|
|
|
while (*psz && IsSpace(*psz))
|
2014-04-12 23:34:00 +02:00
|
|
|
psz++;
|
|
|
|
// Skip and count leading '1's.
|
|
|
|
int zeroes = 0;
|
2017-05-09 19:06:51 +02:00
|
|
|
int length = 0;
|
2014-04-12 23:34:00 +02:00
|
|
|
while (*psz == '1') {
|
|
|
|
zeroes++;
|
2019-12-12 10:55:37 +01:00
|
|
|
if (zeroes > max_ret_len) return false;
|
2014-04-12 23:34:00 +02:00
|
|
|
psz++;
|
|
|
|
}
|
|
|
|
// Allocate enough space in big-endian base256 representation.
|
2017-05-09 19:06:51 +02:00
|
|
|
int size = strlen(psz) * 733 /1000 + 1; // log(58) / log(256), rounded up.
|
|
|
|
std::vector<unsigned char> b256(size);
|
2014-04-12 23:34:00 +02:00
|
|
|
// Process the characters.
|
2022-10-30 17:42:34 +01:00
|
|
|
static_assert(std::size(mapBase58) == 256, "mapBase58.size() should be 256"); // guarantee not out of range
|
2018-10-28 11:48:46 +01:00
|
|
|
while (*psz && !IsSpace(*psz)) {
|
2014-04-12 23:34:00 +02:00
|
|
|
// Decode base58 character
|
Merge #12704: base58: use map instead of strchr() when decode
bcab47b use base58 map instead of strchr() (Kevin Pan)
Pull request description:
Use array map instead of find string position.
Test code snippet:
```cpp
#include <assert.h>
#include <stdint.h>
#include <stdio.h>
#include <stdlib.h>
#include <string>
int main(int argc, const char * argv[]) {
static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
static const int8_t mapBase58[] = {
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
-1,-1,-1,-1,-1,-1,-1,-1, -1,-1,-1,-1,-1,-1,-1,-1,
-1, 0, 1, 2, 3, 4, 5, 6, 7, 8,-1,-1,-1,-1,-1,-1,
-1, 9,10,11,12,13,14,15, 16,-1,17,18,19,20,21,-1,
22,23,24,25,26,27,28,29, 30,31,32,-1,-1,-1,-1,-1,
-1,33,34,35,36,37,38,39, 40,41,42,43,-1,44,45,46,
47,48,49,50,51,52,53,54, 55,56,57,-1,-1,-1,-1,-1,
};
const std::string b58Str(pszBase58);
for (size_t i = 0; i < b58Str.length(); i++) {
const char *ch = strchr(pszBase58, b58Str[i]);
printf("%d - %d\n", ch - pszBase58, mapBase58[(uint8_t)b58Str[i]]);
assert(ch - pszBase58 == mapBase58[(uint8_t)b58Str[i]]);
}
assert(mapBase58['1'] == 0);
assert(mapBase58['z'] == 57);
/** All alphanumeric characters except for "0", "I", "O", and "l" */
assert(mapBase58['0'] == -1);
assert(mapBase58['I'] == -1);
assert(mapBase58['O'] == -1);
assert(mapBase58['l'] == -1);
return 0;
}
```
Tree-SHA512: c28376dc8c92cc4a770c3282db4a568ae5f5a08e27f714183eb3d8755421dc7aa11d7b45afa55e70eba46565f378062aac53dc8f150eeeab12ce7b5db5af89c5
2018-03-22 09:59:29 +01:00
|
|
|
int carry = mapBase58[(uint8_t)*psz];
|
|
|
|
if (carry == -1) // Invalid b58 character
|
2014-04-12 23:34:00 +02:00
|
|
|
return false;
|
2017-05-09 19:06:51 +02:00
|
|
|
int i = 0;
|
|
|
|
for (std::vector<unsigned char>::reverse_iterator it = b256.rbegin(); (carry != 0 || i < length) && (it != b256.rend()); ++it, ++i) {
|
2014-04-12 23:34:00 +02:00
|
|
|
carry += 58 * (*it);
|
|
|
|
*it = carry % 256;
|
|
|
|
carry /= 256;
|
|
|
|
}
|
|
|
|
assert(carry == 0);
|
2017-05-09 19:06:51 +02:00
|
|
|
length = i;
|
2019-12-12 10:55:37 +01:00
|
|
|
if (length + zeroes > max_ret_len) return false;
|
2014-04-12 23:34:00 +02:00
|
|
|
psz++;
|
|
|
|
}
|
|
|
|
// Skip trailing spaces.
|
2018-10-28 11:48:46 +01:00
|
|
|
while (IsSpace(*psz))
|
2014-04-12 23:34:00 +02:00
|
|
|
psz++;
|
|
|
|
if (*psz != 0)
|
|
|
|
return false;
|
|
|
|
// Skip leading zeroes in b256.
|
2017-05-09 19:06:51 +02:00
|
|
|
std::vector<unsigned char>::iterator it = b256.begin() + (size - length);
|
2014-04-12 23:34:00 +02:00
|
|
|
// Copy result into output vector.
|
|
|
|
vch.reserve(zeroes + (b256.end() - it));
|
|
|
|
vch.assign(zeroes, 0x00);
|
|
|
|
while (it != b256.end())
|
2014-09-19 19:21:46 +02:00
|
|
|
vch.push_back(*(it++));
|
2014-04-12 23:34:00 +02:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2020-08-19 13:39:33 +02:00
|
|
|
std::string EncodeBase58(Span<const unsigned char> input)
|
2014-09-19 19:21:46 +02:00
|
|
|
{
|
2014-04-12 23:34:00 +02:00
|
|
|
// Skip & count leading zeroes.
|
|
|
|
int zeroes = 0;
|
2017-05-09 19:06:51 +02:00
|
|
|
int length = 0;
|
2020-08-19 13:39:33 +02:00
|
|
|
while (input.size() > 0 && input[0] == 0) {
|
|
|
|
input = input.subspan(1);
|
2014-04-12 23:34:00 +02:00
|
|
|
zeroes++;
|
|
|
|
}
|
|
|
|
// Allocate enough space in big-endian base58 representation.
|
2020-08-19 13:39:33 +02:00
|
|
|
int size = input.size() * 138 / 100 + 1; // log(256) / log(58), rounded up.
|
2017-05-09 19:06:51 +02:00
|
|
|
std::vector<unsigned char> b58(size);
|
2014-04-12 23:34:00 +02:00
|
|
|
// Process the bytes.
|
2020-08-19 13:39:33 +02:00
|
|
|
while (input.size() > 0) {
|
|
|
|
int carry = input[0];
|
2017-05-09 19:06:51 +02:00
|
|
|
int i = 0;
|
2014-04-12 23:34:00 +02:00
|
|
|
// Apply "b58 = b58 * 256 + ch".
|
2017-05-09 19:06:51 +02:00
|
|
|
for (std::vector<unsigned char>::reverse_iterator it = b58.rbegin(); (carry != 0 || i < length) && (it != b58.rend()); it++, i++) {
|
2014-04-12 23:34:00 +02:00
|
|
|
carry += 256 * (*it);
|
|
|
|
*it = carry % 58;
|
|
|
|
carry /= 58;
|
|
|
|
}
|
2017-05-09 19:06:51 +02:00
|
|
|
|
2014-04-12 23:34:00 +02:00
|
|
|
assert(carry == 0);
|
2017-05-09 19:06:51 +02:00
|
|
|
length = i;
|
2020-08-19 13:39:33 +02:00
|
|
|
input = input.subspan(1);
|
2014-04-12 23:34:00 +02:00
|
|
|
}
|
|
|
|
// Skip leading zeroes in base58 result.
|
2017-05-09 19:06:51 +02:00
|
|
|
std::vector<unsigned char>::iterator it = b58.begin() + (size - length);
|
2014-04-12 23:34:00 +02:00
|
|
|
while (it != b58.end() && *it == 0)
|
|
|
|
it++;
|
|
|
|
// Translate the result into a string.
|
|
|
|
std::string str;
|
|
|
|
str.reserve(zeroes + (b58.end() - it));
|
|
|
|
str.assign(zeroes, '1');
|
|
|
|
while (it != b58.end())
|
|
|
|
str += pszBase58[*(it++)];
|
|
|
|
return str;
|
|
|
|
}
|
2014-05-09 23:42:20 +02:00
|
|
|
|
2019-12-12 10:55:37 +01:00
|
|
|
bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret_len)
|
2014-09-19 19:21:46 +02:00
|
|
|
{
|
2019-12-11 12:00:52 +01:00
|
|
|
if (!ValidAsCString(str)) {
|
|
|
|
return false;
|
|
|
|
}
|
2019-12-12 10:55:37 +01:00
|
|
|
return DecodeBase58(str.c_str(), vchRet, max_ret_len);
|
2014-05-09 23:42:20 +02:00
|
|
|
}
|
|
|
|
|
2020-08-19 13:39:33 +02:00
|
|
|
std::string EncodeBase58Check(Span<const unsigned char> input)
|
2014-09-19 19:21:46 +02:00
|
|
|
{
|
2014-05-09 23:42:20 +02:00
|
|
|
// add 4-byte hash check to the end
|
2020-08-19 13:39:33 +02:00
|
|
|
std::vector<unsigned char> vch(input.begin(), input.end());
|
2023-09-08 15:34:57 +02:00
|
|
|
uint256 hash = Hash(vch);
|
2014-05-09 23:42:20 +02:00
|
|
|
vch.insert(vch.end(), (unsigned char*)&hash, (unsigned char*)&hash + 4);
|
|
|
|
return EncodeBase58(vch);
|
|
|
|
}
|
|
|
|
|
2019-12-12 10:55:37 +01:00
|
|
|
bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet, int max_ret_len)
|
2014-09-19 19:21:46 +02:00
|
|
|
{
|
2019-12-12 10:55:37 +01:00
|
|
|
if (!DecodeBase58(psz, vchRet, max_ret_len > std::numeric_limits<int>::max() - 4 ? std::numeric_limits<int>::max() : max_ret_len + 4) ||
|
2014-09-19 19:21:46 +02:00
|
|
|
(vchRet.size() < 4)) {
|
2014-05-09 23:42:20 +02:00
|
|
|
vchRet.clear();
|
|
|
|
return false;
|
|
|
|
}
|
2017-03-22 08:37:58 +01:00
|
|
|
// re-calculate the checksum, ensure it matches the included 4-byte checksum
|
2021-11-01 21:32:53 +01:00
|
|
|
uint256 hash = Hash(Span{vchRet}.first(vchRet.size() - 4));
|
2017-10-09 16:40:36 +02:00
|
|
|
if (memcmp(&hash, &vchRet[vchRet.size() - 4], 4) != 0) {
|
2014-05-09 23:42:20 +02:00
|
|
|
vchRet.clear();
|
|
|
|
return false;
|
|
|
|
}
|
2014-09-19 19:21:46 +02:00
|
|
|
vchRet.resize(vchRet.size() - 4);
|
2014-05-09 23:42:20 +02:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
2019-12-12 10:55:37 +01:00
|
|
|
bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret)
|
2014-09-19 19:21:46 +02:00
|
|
|
{
|
2019-12-11 12:00:52 +01:00
|
|
|
if (!ValidAsCString(str)) {
|
|
|
|
return false;
|
|
|
|
}
|
2019-12-12 10:55:37 +01:00
|
|
|
return DecodeBase58Check(str.c_str(), vchRet, max_ret);
|
2014-05-09 23:42:20 +02:00
|
|
|
}
|
|
|
|
|