thehub/libs/utils/base58.h

/*
 * This file is part of the Flowee project
 * Copyright (C) 2009-2010 Satoshi Nakamoto
 * Copyright (C) 2009-2015 The Bitcoin Core developers
 * Copyright (C) 2019-2022 Tom Zander <tom@flowee.org>
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */

/**
 * 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 FLOWEE_BASE58_H
#define FLOWEE_BASE58_H

#include <string>
#include <vector>
#include <cstdint>

class uint160;
class PrivateKey;

namespace Base58
{

/**
 * Encode a byte sequence as a base58-encoded string.
 * pbegin and pend cannot be nullptr, unless both are.
 */
std::string encode(const unsigned char* pbegin, int64_t size);

/**
 * Encode a byte vector as a base58-encoded string
 */
std::string encode(const std::vector<unsigned char>& vch);

/**
 * Decode a base58-encoded string (psz) into a byte vector (vchRet).
 * return true if decoding is successful.
 * psz cannot be nullptr.
 */
bool decode(const char* psz, std::vector<unsigned char>& vchRet);

/**
 * Decode a base58-encoded string (str) into a byte vector (vchRet).
 * return true if decoding is successful.
 */
bool decode(const std::string& str, std::vector<unsigned char>& vchRet);

/**
 * Encode a byte vector into a base58-encoded string, including checksum
 */
std::string encodeCheck(const std::vector<unsigned char>& vchIn);

/**
 * Decode a base58-encoded string (psz) that includes a checksum into a byte
 * vector (vchRet), return true if decoding is successful
 */
bool decodeCheck(const char* psz, std::vector<unsigned char>& vchRet);

/**
 * Decode a base58-encoded string (str) that includes a checksum into a byte
 * vector (vchRet), return true if decoding is successful
 */
bool decodeCheck(const std::string& str, std::vector<unsigned char>& vchRet);
}

/**
 * Base class for all base58-encoded data
 */
class CBase58Data
{
public:
    CBase58Data();
    bool SetString(const char* psz, unsigned int nVersionBytes = 1);
    bool SetString(const std::string& str);
    std::string ToString() const;
    int CompareTo(const CBase58Data& b58) const;

    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; }

    bool isMainnetPkh() const;
    bool isMainnetSh() const;
    bool isMainnetPrivKey() const;

    /**
     * Returns true if this is testnet public-key-hash encoded data.
     * Notice that this is all of the following networks:
     *      testnet3, testnet4, scalenet and regtest.
     */
    bool isTestnetPkh() const;
    /**
     * Returns true if this is testnet p2sh encoded data.
     * Notice that this is all of the following networks:
     *      testnet3, testnet4, scalenet and regtest.
     */
    bool isTestnetSh() const;
    /**
     * Returns true if this is a testnet private key.
     * Notice that this is all of the following networks:
     *      testnet3, testnet4, scalenet and regtest.
     */
    bool isTestnetPrivKey() const;

    inline const std::vector<uint8_t> &data() const {
        return vchData;
    }

    /// \deprecated use setData() instead
    void SetData(const std::vector<unsigned char> &vchVersionIn, const void* pdata, size_t nSize);

    enum KeyType {
        PubkeyType,
        ScriptType
    };
    enum Chain {
        Mainnet,
        Testnet ///< Various testnets and scalenet are eligable here.
    };
    /// Set an address to be encoded.
    void setData(const uint160 &key, KeyType type, Chain chain);
    /// Set a private key to be encoded.
    void setData(const PrivateKey &key, Chain chain);

protected:
    //! the version byte(s)
    std::vector<unsigned char> vchVersion;

    //! the actually encoded data
    std::vector<unsigned char> vchData;

    void SetData(const std::vector<unsigned char> &vchVersionIn, const char *pbegin, const char *pend);
};

#endif