TrustLine.h

#pragma once
 
#include <xrpl/basics/CountedObject.h>
#include <xrpl/basics/base_uint.h>
#include <xrpl/json/json_value.h>
#include <xrpl/ledger/ReadView.h>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/LedgerFormats.h>
#include <xrpl/protocol/Rate.h>
#include <xrpl/protocol/STAmount.h>
#include <xrpl/protocol/STLedgerEntry.h>
 
#include <cstdint>
#include <optional>
#include <vector>
 
namespace xrpl {

enum class LineDirection : bool { Incoming = false, Outgoing = true };

class TrustLineBase
{
public:
    TrustLineBase&
    operator=(TrustLineBase const&) = delete;
 
protected:
    // This class should not be instantiated directly. Use one of the derived
    // classes.
    TrustLineBase(SLE::const_ref sle, AccountID const& viewAccount);
 
    ~TrustLineBase() = default;
    TrustLineBase(TrustLineBase const&) = default;
    TrustLineBase(TrustLineBase&&) = default;
 
public:
    [[nodiscard]] uint256 const&
    key() const
    {
        return key_;
    }
 
    // VFALCO Take off the "get" from each function name
 
    [[nodiscard]] AccountID const&
    getAccountID() const
    {
        return viewLowest_ ? lowLimit_.getIssuer() : highLimit_.getIssuer();
    }
 
    [[nodiscard]] AccountID const&
    getAccountIDPeer() const
    {
        return !viewLowest_ ? lowLimit_.getIssuer() : highLimit_.getIssuer();
    }
 
    // True, Provided auth to peer.
    [[nodiscard]] bool
    getAuth() const
    {
        return (flags_ & (viewLowest_ ? lsfLowAuth : lsfHighAuth)) != 0u;
    }
 
    [[nodiscard]] bool
    getAuthPeer() const
    {
        return (flags_ & (!viewLowest_ ? lsfLowAuth : lsfHighAuth)) != 0u;
    }
 
    [[nodiscard]] bool
    getNoRipple() const
    {
        return (flags_ & (viewLowest_ ? lsfLowNoRipple : lsfHighNoRipple)) != 0u;
    }
 
    [[nodiscard]] bool
    getNoRipplePeer() const
    {
        return (flags_ & (!viewLowest_ ? lsfLowNoRipple : lsfHighNoRipple)) != 0u;
    }
 
    [[nodiscard]] LineDirection
    getDirection() const
    {
        return getNoRipple() ? LineDirection::Incoming : LineDirection::Outgoing;
    }
 
    [[nodiscard]] LineDirection
    getDirectionPeer() const
    {
        return getNoRipplePeer() ? LineDirection::Incoming : LineDirection::Outgoing;
    }

    [[nodiscard]] bool
    getFreeze() const
    {
        return (flags_ & (viewLowest_ ? lsfLowFreeze : lsfHighFreeze)) != 0u;
    }

    [[nodiscard]] bool
    getDeepFreeze() const
    {
        return (flags_ & (viewLowest_ ? lsfLowDeepFreeze : lsfHighDeepFreeze)) != 0u;
    }

    [[nodiscard]] bool
    getFreezePeer() const
    {
        return (flags_ & (!viewLowest_ ? lsfLowFreeze : lsfHighFreeze)) != 0u;
    }

    [[nodiscard]] bool
    getDeepFreezePeer() const
    {
        return (flags_ & (!viewLowest_ ? lsfLowDeepFreeze : lsfHighDeepFreeze)) != 0u;
    }
 
    [[nodiscard]] STAmount const&
    getBalance() const
    {
        return balance_;
    }
 
    [[nodiscard]] STAmount const&
    getLimit() const
    {
        return viewLowest_ ? lowLimit_ : highLimit_;
    }
 
    [[nodiscard]] STAmount const&
    getLimitPeer() const
    {
        return !viewLowest_ ? lowLimit_ : highLimit_;
    }
 
    json::Value
    getJson(int);
 
protected:
    uint256 key_;
 
    STAmount const lowLimit_;
    STAmount const highLimit_;
 
    STAmount balance_;
 
    std::uint32_t flags_;
 
    bool viewLowest_;
};
 
// This wrapper is used for the path finder
class PathFindTrustLine final : public TrustLineBase, public CountedObject<PathFindTrustLine>
{
    using TrustLineBase::TrustLineBase;
 
public:
    PathFindTrustLine() = delete;
 
    static std::optional<PathFindTrustLine>
    makeItem(AccountID const& accountID, SLE::const_ref sle);
 
    static std::vector<PathFindTrustLine>
    getItems(AccountID const& accountID, ReadView const& view, LineDirection direction);
};
 
// This wrapper is used for the `AccountLines` command and includes the quality
// in and quality out values.
class RPCTrustLine final : public TrustLineBase, public CountedObject<RPCTrustLine>
{
    using TrustLineBase::TrustLineBase;
 
public:
    RPCTrustLine() = delete;
 
    RPCTrustLine(SLE::const_ref sle, AccountID const& viewAccount);
 
    [[nodiscard]] Rate const&
    getQualityIn() const
    {
        return viewLowest_ ? lowQualityIn_ : highQualityIn_;
    }
 
    [[nodiscard]] Rate const&
    getQualityOut() const
    {
        return viewLowest_ ? lowQualityOut_ : highQualityOut_;
    }
 
    static std::optional<RPCTrustLine>
    makeItem(AccountID const& accountID, SLE::const_ref sle);
 
    static std::vector<RPCTrustLine>
    getItems(AccountID const& accountID, ReadView const& view);
 
private:
    Rate lowQualityIn_;
    Rate lowQualityOut_;
    Rate highQualityIn_;
    Rate highQualityOut_;
};
 
}  // namespace xrpl