ApplyContext.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 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_TX_APPLYCONTEXT_H_INCLUDED
#define RIPPLE_TX_APPLYCONTEXT_H_INCLUDED
 
#include <xrpld/app/main/Application.h>
#include <xrpld/core/Config.h>
 
#include <xrpl/beast/utility/Journal.h>
#include <xrpl/ledger/ApplyViewImpl.h>
#include <xrpl/protocol/STTx.h>
#include <xrpl/protocol/XRPAmount.h>
 
#include <optional>
 
namespace ripple {
 
class ApplyContext
{
public:
    explicit ApplyContext(
        Application& app,
        OpenView& base,
        std::optional<uint256 const> const& parentBatchId,
        STTx const& tx,
        TER preclaimResult,
        XRPAmount baseFee,
        ApplyFlags flags,
        beast::Journal journal = beast::Journal{beast::Journal::getNullSink()});
 
    explicit ApplyContext(
        Application& app,
        OpenView& base,
        STTx const& tx,
        TER preclaimResult,
        XRPAmount baseFee,
        ApplyFlags flags,
        beast::Journal journal = beast::Journal{beast::Journal::getNullSink()})
        : ApplyContext(
              app,
              base,
              std::nullopt,
              tx,
              preclaimResult,
              baseFee,
              flags,
              journal)
    {
        XRPL_ASSERT(
            (flags & tapBATCH) == 0, "Batch apply flag should not be set");
    }
 
    Application& app;
    STTx const& tx;
    TER const preclaimResult;
    XRPAmount const baseFee;
    beast::Journal const journal;
 
    ApplyView&
    view()
    {
        return *view_;
    }
 
    ApplyView const&
    view() const
    {
        return *view_;
    }
 
    // VFALCO Unfortunately this is necessary
    RawView&
    rawView()
    {
        return *view_;
    }
 
    ApplyFlags const&
    flags() const
    {
        return flags_;
    }
 
    void
    deliver(STAmount const& amount)
    {
        view_->deliver(amount);
    }
 
    void
    discard();
 
    std::optional<TxMeta> apply(TER);
 
    std::size_t
    size();
 
    void
    visit(std::function<void(
              uint256 const& key,
              bool isDelete,
              std::shared_ptr<SLE const> const& before,
              std::shared_ptr<SLE const> const& after)> const& func);
 
    void
    destroyXRP(XRPAmount const& fee)
    {
        view_->rawDestroyXRP(fee);
    }
 
    TER
    checkInvariants(TER const result, XRPAmount const fee);
 
private:
    TER
    failInvariantCheck(TER const result);
 
    template <std::size_t... Is>
    TER
    checkInvariantsHelper(
        TER const result,
        XRPAmount const fee,
        std::index_sequence<Is...>);
 
    OpenView& base_;
    ApplyFlags flags_;
    std::optional<ApplyViewImpl> view_;
 
    // The ID of the batch transaction we are executing under, if seated.
    std::optional<uint256 const> parentBatchId_;
};
 
}  // namespace ripple
 
#endif