123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436 |
- // ECOin - Copyright (c) - 2014/2022 - GPLv3 - epsylon@riseup.net (https://03c8.net)
- #ifndef ECOIN_BASE58_H
- #define ECOIN_BASE58_H
- #include <string>
- #include <vector>
- #include "bignum.h"
- #include "key.h"
- #include "script.h"
- static const char* pszBase58 = "123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz";
- // Encode a byte sequence as a base58-encoded string
- inline std::string EncodeBase58(const unsigned char* pbegin, const unsigned char* pend)
- {
- CAutoBN_CTX pctx;
- CBigNum bn58 = 58;
- CBigNum bn0 = 0;
- // Convert big endian data to little endian
- // Extra zero at the end make sure bignum will interpret as a positive number
- std::vector<unsigned char> vchTmp(pend-pbegin+1, 0);
- reverse_copy(pbegin, pend, vchTmp.begin());
- // Convert little endian data to bignum
- CBigNum bn;
- bn.setvch(vchTmp);
- // Convert bignum to std::string
- std::string str;
- // Expected size increase from base58 conversion is approximately 137%
- // use 138% to be safe
- str.reserve((pend - pbegin) * 138 / 100 + 1);
- CBigNum dv;
- CBigNum rem;
- while (bn > bn0)
- {
- if (!BN_div(&dv, &rem, &bn, &bn58, pctx))
- throw bignum_error("EncodeBase58 : BN_div failed");
- bn = dv;
- unsigned int c = rem.getulong();
- str += pszBase58[c];
- }
- // Leading zeroes encoded as base58 zeros
- for (const unsigned char* p = pbegin; p < pend && *p == 0; p++)
- str += pszBase58[0];
- // Convert little endian std::string to big endian
- reverse(str.begin(), str.end());
- return str;
- }
- // Encode a byte vector as a base58-encoded string
- inline std::string EncodeBase58(const std::vector<unsigned char>& vch)
- {
- return EncodeBase58(&vch[0], &vch[0] + vch.size());
- }
- // Decode a base58-encoded string psz into byte vector vchRet
- // returns true if decoding is successful
- inline bool DecodeBase58(const char* psz, std::vector<unsigned char>& vchRet)
- {
- CAutoBN_CTX pctx;
- vchRet.clear();
- CBigNum bn58 = 58;
- CBigNum bn = 0;
- CBigNum bnChar;
- while (isspace(*psz))
- psz++;
- // Convert big endian string to bignum
- for (const char* p = psz; *p; p++)
- {
- const char* p1 = strchr(pszBase58, *p);
- if (p1 == NULL)
- {
- while (isspace(*p))
- p++;
- if (*p != '\0')
- return false;
- break;
- }
- bnChar.setulong(p1 - pszBase58);
- if (!BN_mul(&bn, &bn, &bn58, pctx))
- throw bignum_error("DecodeBase58 : BN_mul failed");
- bn += bnChar;
- }
- // Get bignum as little endian data
- std::vector<unsigned char> vchTmp = bn.getvch();
- // Trim off sign byte if present
- if (vchTmp.size() >= 2 && vchTmp.end()[-1] == 0 && vchTmp.end()[-2] >= 0x80)
- vchTmp.erase(vchTmp.end()-1);
- // Restore leading zeros
- int nLeadingZeros = 0;
- for (const char* p = psz; *p == pszBase58[0]; p++)
- nLeadingZeros++;
- vchRet.assign(nLeadingZeros + vchTmp.size(), 0);
- // Convert little endian data to big endian
- reverse_copy(vchTmp.begin(), vchTmp.end(), vchRet.end() - vchTmp.size());
- return true;
- }
- // Decode a base58-encoded string str into byte vector vchRet
- // returns true if decoding is successful
- inline bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet)
- {
- return DecodeBase58(str.c_str(), vchRet);
- }
- // Encode a byte vector to a base58-encoded string, including checksum
- inline std::string EncodeBase58Check(const std::vector<unsigned char>& vchIn)
- {
- // add 4-byte hash check to the end
- std::vector<unsigned char> vch(vchIn);
- uint256 hash = Hash(vch.begin(), vch.end());
- vch.insert(vch.end(), (unsigned char*)&hash, (unsigned char*)&hash + 4);
- return EncodeBase58(vch);
- }
- // Decode a base58-encoded string psz that includes a checksum, into byte vector vchRet
- // returns true if decoding is successful
- inline bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet)
- {
- if (!DecodeBase58(psz, vchRet))
- return false;
- if (vchRet.size() < 4)
- {
- vchRet.clear();
- return false;
- }
- uint256 hash = Hash(vchRet.begin(), vchRet.end()-4);
- if (memcmp(&hash, &vchRet.end()[-4], 4) != 0)
- {
- vchRet.clear();
- return false;
- }
- vchRet.resize(vchRet.size()-4);
- return true;
- }
- // Decode a base58-encoded string str that includes a checksum, into byte vector vchRet
- // returns true if decoding is successful
- inline bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet)
- {
- return DecodeBase58Check(str.c_str(), vchRet);
- }
- /** Base class for all base58-encoded data */
- class CBase58Data
- {
- protected:
- // the version byte
- unsigned char nVersion;
- // the actually encoded data
- std::vector<unsigned char> vchData;
- CBase58Data()
- {
- nVersion = 0;
- vchData.clear();
- }
- ~CBase58Data()
- {
- // zero the memory, as it may contain sensitive data
- if (!vchData.empty())
- memset(&vchData[0], 0, vchData.size());
- }
- void SetData(int nVersionIn, const void* pdata, size_t nSize)
- {
- nVersion = nVersionIn;
- vchData.resize(nSize);
- if (!vchData.empty())
- memcpy(&vchData[0], pdata, nSize);
- }
- void SetData(int nVersionIn, const unsigned char *pbegin, const unsigned char *pend)
- {
- SetData(nVersionIn, (void*)pbegin, pend - pbegin);
- }
- public:
- bool SetString(const char* psz)
- {
- std::vector<unsigned char> vchTemp;
- DecodeBase58Check(psz, vchTemp);
- if (vchTemp.empty())
- {
- vchData.clear();
- nVersion = 0;
- return false;
- }
- nVersion = vchTemp[0];
- vchData.resize(vchTemp.size() - 1);
- if (!vchData.empty())
- memcpy(&vchData[0], &vchTemp[1], vchData.size());
- memset(&vchTemp[0], 0, vchTemp.size());
- return true;
- }
- bool SetString(const std::string& str)
- {
- return SetString(str.c_str());
- }
- std::string ToString() const
- {
- std::vector<unsigned char> vch(1, nVersion);
- vch.insert(vch.end(), vchData.begin(), vchData.end());
- return EncodeBase58Check(vch);
- }
- int CompareTo(const CBase58Data& b58) const
- {
- if (nVersion < b58.nVersion) return -1;
- if (nVersion > b58.nVersion) return 1;
- if (vchData < b58.vchData) return -1;
- if (vchData > b58.vchData) return 1;
- return 0;
- }
- bool operator==(const CBase58Data& b58) const { return CompareTo(b58) == 0; }
- bool operator<=(const CBase58Data& b58) const { return CompareTo(b58) <= 0; }
- bool operator>=(const CBase58Data& b58) const { return CompareTo(b58) >= 0; }
- bool operator< (const CBase58Data& b58) const { return CompareTo(b58) < 0; }
- bool operator> (const CBase58Data& b58) const { return CompareTo(b58) > 0; }
- };
- class CEcoinAddress;
- class CEcoinAddressVisitor : public boost::static_visitor<bool>
- {
- private:
- CEcoinAddress *addr;
- public:
- CEcoinAddressVisitor(CEcoinAddress *addrIn) : addr(addrIn) { }
- bool operator()(const CKeyID &id) const;
- bool operator()(const CScriptID &id) const;
- bool operator()(const CNoDestination &no) const;
- };
- class CEcoinAddress : public CBase58Data
- {
- public:
- enum
- {
- PUBKEY_ADDRESS = 33,
- SCRIPT_ADDRESS = 20,
- PUBKEY_ADDRESS_TEST = 92,
- SCRIPT_ADDRESS_TEST = 196,
- };
- bool Set(const CKeyID &id) {
- SetData(fTestNet ? PUBKEY_ADDRESS_TEST : PUBKEY_ADDRESS, &id, 20);
- return true;
- }
- bool Set(const CScriptID &id) {
- SetData(fTestNet ? SCRIPT_ADDRESS_TEST : SCRIPT_ADDRESS, &id, 20);
- return true;
- }
- bool Set(const CTxDestination &dest)
- {
- return boost::apply_visitor(CEcoinAddressVisitor(this), dest);
- }
- bool IsValid() const
- {
- unsigned int nExpectedSize = 20;
- bool fExpectTestNet = false;
- switch(nVersion)
- {
- case PUBKEY_ADDRESS:
- nExpectedSize = 20; // Hash of public key
- fExpectTestNet = false;
- break;
- case SCRIPT_ADDRESS:
- nExpectedSize = 20; // Hash of CScript
- fExpectTestNet = false;
- break;
- case PUBKEY_ADDRESS_TEST:
- nExpectedSize = 20;
- fExpectTestNet = true;
- break;
- case SCRIPT_ADDRESS_TEST:
- nExpectedSize = 20;
- fExpectTestNet = true;
- break;
- default:
- return false;
- }
- return fExpectTestNet == fTestNet && vchData.size() == nExpectedSize;
- }
- CEcoinAddress()
- {
- }
- CEcoinAddress(const CTxDestination &dest)
- {
- Set(dest);
- }
- CEcoinAddress(const std::string& strAddress)
- {
- SetString(strAddress);
- }
- CEcoinAddress(const char* pszAddress)
- {
- SetString(pszAddress);
- }
- CTxDestination Get() const {
- if (!IsValid())
- return CNoDestination();
- switch (nVersion) {
- case PUBKEY_ADDRESS:
- case PUBKEY_ADDRESS_TEST: {
- uint160 id;
- memcpy(&id, &vchData[0], 20);
- return CKeyID(id);
- }
- case SCRIPT_ADDRESS:
- case SCRIPT_ADDRESS_TEST: {
- uint160 id;
- memcpy(&id, &vchData[0], 20);
- return CScriptID(id);
- }
- }
- return CNoDestination();
- }
- bool GetKeyID(CKeyID &keyID) const {
- if (!IsValid())
- return false;
- switch (nVersion) {
- case PUBKEY_ADDRESS:
- case PUBKEY_ADDRESS_TEST: {
- uint160 id;
- memcpy(&id, &vchData[0], 20);
- keyID = CKeyID(id);
- return true;
- }
- default: return false;
- }
- }
- bool IsScript() const {
- if (!IsValid())
- return false;
- switch (nVersion) {
- case SCRIPT_ADDRESS:
- case SCRIPT_ADDRESS_TEST: {
- return true;
- }
- default: return false;
- }
- }
- };
- bool inline CEcoinAddressVisitor::operator()(const CKeyID &id) const { return addr->Set(id); }
- bool inline CEcoinAddressVisitor::operator()(const CScriptID &id) const { return addr->Set(id); }
- bool inline CEcoinAddressVisitor::operator()(const CNoDestination &id) const { return false; }
- /** A base58-encoded secret key */
- class CEcoinSecret : public CBase58Data
- {
- public:
- void SetSecret(const CSecret& vchSecret, bool fCompressed)
- {
- assert(vchSecret.size() == 32);
- SetData(128 + (fTestNet ? CEcoinAddress::PUBKEY_ADDRESS_TEST : CEcoinAddress::PUBKEY_ADDRESS), &vchSecret[0], vchSecret.size());
- if (fCompressed)
- vchData.push_back(1);
- }
- CSecret GetSecret(bool &fCompressedOut)
- {
- CSecret vchSecret;
- vchSecret.resize(32);
- memcpy(&vchSecret[0], &vchData[0], 32);
- fCompressedOut = vchData.size() == 33;
- return vchSecret;
- }
- bool IsValid() const
- {
- bool fExpectTestNet = false;
- switch(nVersion)
- {
- case (128 + CEcoinAddress::PUBKEY_ADDRESS):
- break;
- case (128 + CEcoinAddress::PUBKEY_ADDRESS_TEST):
- fExpectTestNet = true;
- break;
- default:
- return false;
- }
- return fExpectTestNet == fTestNet && (vchData.size() == 32 || (vchData.size() == 33 && vchData[32] == 1));
- }
- bool SetString(const char* pszSecret)
- {
- return CBase58Data::SetString(pszSecret) && IsValid();
- }
- bool SetString(const std::string& strSecret)
- {
- return SetString(strSecret.c_str());
- }
- CEcoinSecret(const CSecret& vchSecret, bool fCompressed)
- {
- SetSecret(vchSecret, fCompressed);
- }
- CEcoinSecret()
- {
- }
- };
- #endif
|