AccountID.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2014 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_PROTOCOL_ACCOUNTID_H_INCLUDED
#define RIPPLE_PROTOCOL_ACCOUNTID_H_INCLUDED
 
#include <ripple/protocol/tokens.h>
// VFALCO Uncomment when the header issues are resolved
//#include <ripple/protocol/PublicKey.h>
#include <ripple/basics/UnorderedContainers.h>
#include <ripple/basics/base_uint.h>
#include <ripple/json/json_value.h>
#include <boost/optional.hpp>
#include <cstddef>
#include <mutex>
#include <string>
 
namespace ripple {
 
namespace detail {
 
class AccountIDTag
{
public:
    explicit AccountIDTag() = default;
};
 
}  // namespace detail
 
using AccountID = base_uint<160, detail::AccountIDTag>;
 
std::string
toBase58(AccountID const& v);
 
template <>
boost::optional<AccountID>
parseBase58(std::string const& s);
 
// Parses AccountID using Bitcoin's alphabet
// This is to catch user error. Likely not needed
// DEPRECATED
boost::optional<AccountID>
deprecatedParseBitcoinAccountID(std::string const& s);
 
// Compatibility with legacy code
bool
deprecatedParseBase58(AccountID& account, Json::Value const& jv);
 
template <>
boost::optional<AccountID>
parseHex(std::string const& s);
 
template <>
boost::optional<AccountID>
parseHexOrBase58(std::string const& s);
 
// VFALCO In PublicKey.h for now
// AccountID
// calcAccountID (PublicKey const& pk);
 
AccountID const&
xrpAccount();
 
AccountID const&
noAccount();
 
// DEPRECATED
bool
to_issuer(AccountID&, std::string const&);
 
// DEPRECATED Should be checking the currency or native flag
inline bool
isXRP(AccountID const& c)
{
    return c == beast::zero;
}
 
// DEPRECATED
inline std::string
to_string(AccountID const& account)
{
    return toBase58(account);
}
 
// DEPRECATED
inline std::ostream&
operator<<(std::ostream& os, AccountID const& x)
{
    os << to_string(x);
    return os;
}
 
//------------------------------------------------------------------------------
 
class AccountIDCache
{
private:
    std::mutex mutable mutex_;
    std::size_t capacity_;
    hash_map<AccountID, std::string> mutable m0_;
    hash_map<AccountID, std::string> mutable m1_;
 
public:
    AccountIDCache(AccountIDCache const&) = delete;
    AccountIDCache&
    operator=(AccountIDCache const&) = delete;
 
    explicit AccountIDCache(std::size_t capacity);
 
    std::string
    toBase58(AccountID const&) const;
};
 
}  // namespace ripple
 
//------------------------------------------------------------------------------
 
namespace std {
 
// DEPRECATED
// VFALCO Use beast::uhash or a hardened container
template <>
struct hash<ripple::AccountID> : ripple::AccountID::hasher
{
    explicit hash() = default;
};
 
}  // namespace std
 
#endif