Taker.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_APP_BOOK_TAKER_H_INCLUDED
#define RIPPLE_APP_BOOK_TAKER_H_INCLUDED
 
#include <xrpld/app/tx/detail/Offer.h>
#include <xrpld/ledger/View.h>
 
#include <xrpl/beast/utility/Journal.h>
#include <xrpl/protocol/Quality.h>
#include <xrpl/protocol/Rate.h>
#include <xrpl/protocol/TER.h>
#include <xrpl/protocol/TxFlags.h>
 
namespace ripple {
 
enum class CrossType { XrpToIou, IouToXrp, IouToIou };
 
class BasicTaker
{
private:
    AccountID account_;
    Quality quality_;
    Quality threshold_;
 
    bool sell_;
 
    // The original in and out quantities.
    Amounts const original_;
 
    // The amounts still left over for us to try and take.
    Amounts remaining_;
 
    // The issuers for the input and output
    Issue const& issue_in_;
    Issue const& issue_out_;
 
    // The rates that will be paid when the input and output currencies are
    // transfered and the currency issuer isn't involved:
    Rate const m_rate_in;
    Rate const m_rate_out;
 
    // The type of crossing that we are performing
    CrossType cross_type_;
 
protected:
    beast::Journal const journal_;
 
    struct Flow
    {
        explicit Flow() = default;
 
        Amounts order;
        Amounts issuers;
 
        bool
        sanity_check() const
        {
            using beast::zero;
 
            if (isXRP(order.in) && isXRP(order.out))
                return false;
 
            return order.in >= zero && order.out >= zero &&
                issuers.in >= zero && issuers.out >= zero;
        }
    };
 
private:
    void
    log_flow(char const* description, Flow const& flow);
 
    Flow
    flow_xrp_to_iou(
        Amounts const& offer,
        Quality quality,
        STAmount const& owner_funds,
        STAmount const& taker_funds,
        Rate const& rate_out);
 
    Flow
    flow_iou_to_xrp(
        Amounts const& offer,
        Quality quality,
        STAmount const& owner_funds,
        STAmount const& taker_funds,
        Rate const& rate_in);
 
    Flow
    flow_iou_to_iou(
        Amounts const& offer,
        Quality quality,
        STAmount const& owner_funds,
        STAmount const& taker_funds,
        Rate const& rate_in,
        Rate const& rate_out);
 
    // Calculates the transfer rate that we should use when calculating
    // flows for a particular issue between two accounts.
    static Rate
    effective_rate(
        Rate const& rate,
        Issue const& issue,
        AccountID const& from,
        AccountID const& to);
 
    // The transfer rate for the input currency between the given accounts
    Rate
    in_rate(AccountID const& from, AccountID const& to) const
    {
        return effective_rate(m_rate_in, original_.in.issue(), from, to);
    }
 
    // The transfer rate for the output currency between the given accounts
    Rate
    out_rate(AccountID const& from, AccountID const& to) const
    {
        return effective_rate(m_rate_out, original_.out.issue(), from, to);
    }
 
public:
    BasicTaker() = delete;
    BasicTaker(BasicTaker const&) = delete;
 
    BasicTaker(
        CrossType cross_type,
        AccountID const& account,
        Amounts const& amount,
        Quality const& quality,
        std::uint32_t flags,
        Rate const& rate_in,
        Rate const& rate_out,
        beast::Journal journal = beast::Journal{beast::Journal::getNullSink()});
 
    virtual ~BasicTaker() = default;
 
    Amounts
    remaining_offer() const;
 
    Amounts const&
    original_offer() const;
 
    AccountID const&
    account() const noexcept
    {
        return account_;
    }
 
    bool
    reject(Quality const& quality) const noexcept
    {
        return quality < threshold_;
    }
 
    CrossType
    cross_type() const
    {
        return cross_type_;
    }
 
    Issue const&
    issue_in() const
    {
        return issue_in_;
    }
 
    Issue const&
    issue_out() const
    {
        return issue_out_;
    }
 
    bool
    unfunded() const;
 
    bool
    done() const;
 
    BasicTaker::Flow
    do_cross(Amounts offer, Quality quality, AccountID const& owner);
 
    std::pair<BasicTaker::Flow, BasicTaker::Flow>
    do_cross(
        Amounts offer1,
        Quality quality1,
        AccountID const& owner1,
        Amounts offer2,
        Quality quality2,
        AccountID const& owner2);
 
    virtual STAmount
    get_funds(AccountID const& account, STAmount const& funds) const = 0;
};
 
//------------------------------------------------------------------------------
 
class Taker : public BasicTaker
{
public:
    Taker() = delete;
    Taker(Taker const&) = delete;
 
    Taker(
        CrossType cross_type,
        ApplyView& view,
        AccountID const& account,
        Amounts const& offer,
        std::uint32_t flags,
        beast::Journal journal);
    ~Taker() = default;
 
    void
    consume_offer(Offer& offer, Amounts const& order);
 
    STAmount
    get_funds(AccountID const& account, STAmount const& funds) const override;
 
    STAmount const&
    get_xrp_flow() const
    {
        return xrp_flow_;
    }
 
    std::uint32_t
    get_direct_crossings() const
    {
        return direct_crossings_;
    }
 
    std::uint32_t
    get_bridge_crossings() const
    {
        return bridge_crossings_;
    }
 
    TER
    cross(Offer& offer);
 
    TER
    cross(Offer& leg1, Offer& leg2);
private:
    static Rate
    calculateRate(
        ApplyView const& view,
        AccountID const& issuer,
        AccountID const& account);
 
    TER
    fill(BasicTaker::Flow const& flow, Offer& offer);
 
    TER
    fill(
        BasicTaker::Flow const& flow1,
        Offer& leg1,
        BasicTaker::Flow const& flow2,
        Offer& leg2);
 
    TER
    transferXRP(
        AccountID const& from,
        AccountID const& to,
        STAmount const& amount);
 
    TER
    redeemIOU(
        AccountID const& account,
        STAmount const& amount,
        Issue const& issue);
 
    TER
    issueIOU(
        AccountID const& account,
        STAmount const& amount,
        Issue const& issue);
 
private:
    // The underlying ledger entry we are dealing with
    ApplyView& view_;
 
    // The amount of XRP that flowed if we were autobridging
    STAmount xrp_flow_;
 
    // The number direct crossings that we performed
    std::uint32_t direct_crossings_;
 
    // The number autobridged crossings that we performed
    std::uint32_t bridge_crossings_;
};
 
}  // namespace ripple
 
#endif