mirror of
https://github.com/dashpay/dash.git
synced 2024-12-26 04:22:55 +01:00
d751b27c78
356988e200b1debaa80d210d502d2d085c72dc64 util: make EncodeBase58Check consume Spans (Sebastian Falbesoner)
f0fce0675d56b2226a993253731690ca864066c8 util: make EncodeBase58 consume Spans (Sebastian Falbesoner)
Pull request description:
This PR improves the interfaces for the functions `EncodeBase58{Check}` by using Spans, in a similar fashion to e.g. PRs #19660, #19687. Note that on the master branch there are currently two versions of `EncodeBase58`: one that takes two pointers (marking begin and end) and another one that takes a `std::vector<unsigned char>` const-ref. The PR branch only leaves one generic Span-interface, both simplifying the interface and allowing more generic containers to be passed. The same is done for `EncodeBase58Check`, where only one interface existed but it's more generic now (e.g. a std::array can be directly passed, as done in the benchmarks).
ACKs for top commit:
laanwj:
Code review ACK 356988e200b1debaa80d210d502d2d085c72dc64
Tree-SHA512: 47cfccdd7f3a2d4694bb8785e6e5fd756daee04ce1652ee59a7822e7e833b4a441ae9362b9bd67ea020d2b5b7d927629c9addb6abaa9881d8564fd3b1257f512
59 lines
2.0 KiB
C++
59 lines
2.0 KiB
C++
// Copyright (c) 2009-2010 Satoshi Nakamoto
|
|
// Copyright (c) 2009-2015 The Bitcoin Core developers
|
|
// Distributed under the MIT software license, see the accompanying
|
|
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
|
|
|
/**
|
|
* Why base-58 instead of standard base-64 encoding?
|
|
* - Don't want 0OIl characters that look the same in some fonts and
|
|
* could be used to create visually identical looking data.
|
|
* - A string with non-alphanumeric characters is not as easily accepted as input.
|
|
* - E-mail usually won't line-break if there's no punctuation to break at.
|
|
* - Double-clicking selects the whole string as one word if it's all alphanumeric.
|
|
*/
|
|
#ifndef BITCOIN_BASE58_H
|
|
#define BITCOIN_BASE58_H
|
|
|
|
#include <attributes.h>
|
|
#include <span.h>
|
|
|
|
#include <string>
|
|
#include <vector>
|
|
|
|
/**
|
|
* Encode a byte span as a base58-encoded string
|
|
*/
|
|
std::string EncodeBase58(Span<const unsigned char> input);
|
|
|
|
/**
|
|
* Decode a base58-encoded string (psz) into a byte vector (vchRet).
|
|
* return true if decoding is successful.
|
|
* psz cannot be nullptr.
|
|
*/
|
|
[[nodiscard]] bool DecodeBase58(const char* psz, std::vector<unsigned char>& vchRet, int max_ret_len);
|
|
|
|
/**
|
|
* Decode a base58-encoded string (str) into a byte vector (vchRet).
|
|
* return true if decoding is successful.
|
|
*/
|
|
[[nodiscard]] bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret_len);
|
|
|
|
/**
|
|
* Encode a byte span into a base58-encoded string, including checksum
|
|
*/
|
|
std::string EncodeBase58Check(Span<const unsigned char> input);
|
|
|
|
/**
|
|
* Decode a base58-encoded string (psz) that includes a checksum into a byte
|
|
* vector (vchRet), return true if decoding is successful
|
|
*/
|
|
[[nodiscard]] bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet, int max_ret_len);
|
|
|
|
/**
|
|
* Decode a base58-encoded string (str) that includes a checksum into a byte
|
|
* vector (vchRet), return true if decoding is successful
|
|
*/
|
|
[[nodiscard]] bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet, int max_ret_len);
|
|
|
|
#endif // BITCOIN_BASE58_H
|