src/base58.h

   1 // Copyright (c) 2009-2010 Satoshi Nakamoto
   2 // Copyright (c) 2009-2012 The Bitcoin Developers
   3 // Distributed under the MIT/X11 software license, see the accompanying
   4 // file COPYING or http://www.opensource.org/licenses/mit-license.php.
   5
   6
   7 //
   8 // Why base-58 instead of standard base-64 encoding?
   9 // - Don't want 0OIl characters that look the same in some fonts and
  10 //      could be used to create visually identical looking account numbers.
  11 // - A string with non-alphanumeric characters is not as easily accepted as an account number.
  12 // - E-mail usually won't line-break if there's no punctuation to break at.
  13 // - Double-clicking selects the whole number as one word if it's all alphanumeric.
  14 //
  15 #ifndef BITCOIN_BASE58_H
  16 #define BITCOIN_BASE58_H
  17
  18 #include <string>
  19 #include <vector>
  20 #include <openssl/crypto.h> // for OPENSSL_cleanse()
  21 #include "bignum.h"
  22 #include "key.h"
  23 #include "script.h"
  24
  25 // Encode a byte sequence as a base58-encoded string
  26 std::string EncodeBase58(const unsigned char* pbegin, const unsigned char* pend);
  27
  28 // Encode a byte vector as a base58-encoded string
  29 std::string EncodeBase58(const std::vector<unsigned char>& vch);
  30
  31 // Decode a base58-encoded string psz into byte vector vchRet
  32 // returns true if decoding is successful
  33 bool DecodeBase58(const char* psz, std::vector<unsigned char>& vchRet);
  34
  35 // Decode a base58-encoded string str into byte vector vchRet
  36 // returns true if decoding is successful
  37 bool DecodeBase58(const std::string& str, std::vector<unsigned char>& vchRet);
  38
  39 // Encode a byte vector to a base58-encoded string, including checksum
  40 std::string EncodeBase58Check(const std::vector<unsigned char>& vchIn);
  41
  42 // Decode a base58-encoded string psz that includes a checksum, into byte vector vchRet
  43 // returns true if decoding is successful
  44 bool DecodeBase58Check(const char* psz, std::vector<unsigned char>& vchRet);
  45
  46 // Decode a base58-encoded string str that includes a checksum, into byte vector vchRet
  47 // returns true if decoding is successful
  48 bool DecodeBase58Check(const std::string& str, std::vector<unsigned char>& vchRet);
  49
  50 /** Base class for all base58-encoded data */
  51 class CBase58Data
  52 {
  53 protected:
  54     // the version byte
  55     unsigned char nVersion;
  56
  57     // the actually encoded data
  58     std::vector<unsigned char> vchData;
  59
  60     CBase58Data();
  61     ~CBase58Data();
  62
  63     void SetData(int nVersionIn, const void* pdata, size_t nSize);
  64     void SetData(int nVersionIn, const unsigned char *pbegin, const unsigned char *pend);
  65
  66 public:
  67     bool SetString(const char* psz);
  68     bool SetString(const std::string& str);
  69     std::string ToString() const;
  70
  71     int CompareTo(const CBase58Data& b58) const;
  72     bool operator==(const CBase58Data& b58) const { return CompareTo(b58) == 0; }
  73     bool operator<=(const CBase58Data& b58) const { return CompareTo(b58) <= 0; }
  74     bool operator>=(const CBase58Data& b58) const { return CompareTo(b58) >= 0; }
  75     bool operator< (const CBase58Data& b58) const { return CompareTo(b58) <  0; }
  76     bool operator> (const CBase58Data& b58) const { return CompareTo(b58) >  0; }
  77 };
  78
  79 /** base58-encoded Bitcoin addresses.
  80  * Public-key-hash-addresses have version 0 (or 111 testnet).
  81  * The data vector contains RIPEMD160(SHA256(pubkey)), where pubkey is the serialized public key.
  82  * Script-hash-addresses have version 5 (or 196 testnet).
  83  * The data vector contains RIPEMD160(SHA256(cscript)), where cscript is the serialized redemption script.
  84  */
  85 class CBitcoinAddress;
  86 class CBitcoinAddressVisitor : public boost::static_visitor<bool>
  87 {
  88 private:
  89     CBitcoinAddress *addr;
  90 public:
  91     CBitcoinAddressVisitor(CBitcoinAddress *addrIn) : addr(addrIn) { }
  92     bool operator()(const CKeyID &id) const;
  93     bool operator()(const CScriptID &id) const;
  94     bool operator()(const CNoDestination &no) const;
  95 };
  96
  97 class CBitcoinAddress : public CBase58Data
  98 {
  99 public:
 100     enum
 101     {
 102         PUBKEY_ADDRESS = 8,
 103         SCRIPT_ADDRESS = 20,
 104         PUBKEY_ADDRESS_TEST = 111,
 105         SCRIPT_ADDRESS_TEST = 196
 106     };
 107
 108     bool Set(const CKeyID &id);
 109     bool Set(const CScriptID &id);
 110     bool Set(const CTxDestination &dest);
 111     bool IsValid() const;
 112
 113     CBitcoinAddress()
 114     {
 115     }
 116
 117     CBitcoinAddress(const CTxDestination &dest)
 118     {
 119         Set(dest);
 120     }
 121
 122     CBitcoinAddress(const std::string& strAddress)
 123     {
 124         SetString(strAddress);
 125     }
 126
 127     CBitcoinAddress(const char* pszAddress)
 128     {
 129         SetString(pszAddress);
 130     }
 131
 132     CTxDestination Get() const;
 133     bool GetKeyID(CKeyID &keyID) const;
 134     bool IsScript() const;
 135 };
 136
 137 bool inline CBitcoinAddressVisitor::operator()(const CKeyID &id) const         { return addr->Set(id); }
 138 bool inline CBitcoinAddressVisitor::operator()(const CScriptID &id) const      { return addr->Set(id); }
 139 bool inline CBitcoinAddressVisitor::operator()(const CNoDestination &id) const { return false; }
 140
 141 /** A base58-encoded secret key */
 142 class CBitcoinSecret : public CBase58Data
 143 {
 144 public:
 145     void SetSecret(const CSecret& vchSecret, bool fCompressed);
 146     CSecret GetSecret(bool &fCompressedOut);
 147
 148     bool IsValid() const;
 149
 150     bool SetString(const char* pszSecret);
 151     bool SetString(const std::string& strSecret);
 152
 153     CBitcoinSecret(const CSecret& vchSecret, bool fCompressed);
 154     CBitcoinSecret()
 155     {
 156     }
 157 };
 158
 159 #endif