MPTokenIssuanceHistory.hpp

#pragma once
 
#include "data/BackendInterface.hpp"
#include "data/Types.hpp"
#include "rpc/Errors.hpp"
#include "rpc/JS.hpp"
#include "rpc/common/MetaProcessors.hpp"
#include "rpc/common/Modifiers.hpp"
#include "rpc/common/Specs.hpp"
#include "rpc/common/Types.hpp"
#include "rpc/common/Validators.hpp"
#include "util/TxUtils.hpp"
#include "util/log/Logger.hpp"
 
#include <boost/json/array.hpp>
#include <boost/json/conversion.hpp>
#include <boost/json/object.hpp>
#include <boost/json/value.hpp>
#include <xrpl/basics/base_uint.h>
#include <xrpl/protocol/ErrorCodes.h>
#include <xrpl/protocol/jss.h>
 
#include <atomic>
#include <cstdint>
#include <expected>
#include <memory>
#include <optional>
#include <string>
#include <utility>
 
namespace rpc {

class MPTokenIssuanceHistoryHandler {
    util::Logger log_{"RPC"};
    std::shared_ptr<BackendInterface> sharedPtrBackend_;

    std::shared_ptr<std::atomic_bool> migrated_ = std::make_shared<std::atomic_bool>(false);
 
public:
    static constexpr auto kLimitMin = 1;
    static constexpr auto kLimitMax = 100;
    static constexpr auto kLimitDefault = 50;

    static constexpr char const* kMigratorName = "MPTokenIssuanceHistoryMigrator";

    struct Marker {
        uint32_t ledger;
        uint32_t seq;
    };

    struct Output {
        std::string mptIssuanceID;
        uint32_t ledgerIndexMin{0};
        uint32_t ledgerIndexMax{0};
        std::optional<uint32_t> limit;
        std::optional<Marker> marker;
        boost::json::array transactions;
        bool validated = true;
    };

    struct Input {
        std::string mptIssuanceID;
        std::optional<std::string> account;
        std::optional<std::string> transactionTypeInLowercase;
        std::optional<std::string> ledgerHash;
        std::optional<uint32_t> ledgerIndex;
        std::optional<int32_t> ledgerIndexMin;
        std::optional<int32_t> ledgerIndexMax;
        bool binary = false;
        bool forward = false;
        std::optional<uint32_t> limit;
        std::optional<Marker> marker;
    };
 
    using Result = HandlerReturnType<Output>;

    explicit MPTokenIssuanceHistoryHandler(std::shared_ptr<BackendInterface> sharedPtrBackend)
        : sharedPtrBackend_(std::move(sharedPtrBackend))
    {
    }

    static RpcSpecConstRef
    spec([[maybe_unused]] uint32_t apiVersion)
    {
        auto const& typesKeysInLowercase = util::getTxTypesInLowercase();
        static auto const kRpcSpec = RpcSpec{
            {JS(mpt_issuance_id),
             validation::Required{},
             validation::CustomValidators::uint192HexStringValidator},
            {JS(account), validation::CustomValidators::accountValidator},
            {
                "tx_type",
                validation::Type<std::string>{},
                modifiers::ToLower{},
                validation::OneOf<std::string>(
                    typesKeysInLowercase.cbegin(), typesKeysInLowercase.cend()
                ),
            },
            {JS(ledger_hash), validation::CustomValidators::uint256HexStringValidator},
            {JS(ledger_index), validation::CustomValidators::ledgerIndexValidator},
            {JS(ledger_index_min), validation::Type<int32_t>{}},
            {JS(ledger_index_max), validation::Type<int32_t>{}},
            {JS(binary), validation::Type<bool>{}},
            {JS(forward), validation::Type<bool>{}},
            {JS(limit),
             validation::Type<uint32_t>{},
             validation::Min(1u),
             modifiers::Clamp<int32_t>{kLimitMin, kLimitMax}},
            {JS(marker),
             meta::WithCustomError{
                 validation::Type<boost::json::object>{},
                 Status{RippledError::RpcInvalidParams, "invalidMarker"}
             },
             meta::Section{
                 {JS(ledger), validation::Required{}, validation::Type<uint32_t>{}},
                 {JS(seq), validation::Required{}, validation::Type<uint32_t>{}},
             }},
        };
 
        return kRpcSpec;
    }

    [[nodiscard]] Result
    process(Input const& input, Context const& ctx) const;
 
private:
    struct SequenceRange {
        uint32_t min;
        uint32_t max;
    };

    [[nodiscard]] MaybeError
    verifyHistoryAvailable(Context const& ctx) const;

    [[nodiscard]] std::expected<SequenceRange, Status>
    resolveSequenceRange(Input const& input, Context const& ctx) const;

    [[nodiscard]] data::TransactionsAndCursor
    fetchTransactions(
        Input const& input,
        Context const& ctx,
        xrpl::uint192 const& mptIssuanceID,
        SequenceRange range
    ) const;

    void
    processTransactionsPage(
        Input const& input,
        Context const& ctx,
        SequenceRange range,
        data::TransactionsAndCursor const& page,
        Output& response
    ) const;

    [[nodiscard]] std::optional<boost::json::object>
    transactionToJsonIfTypeMatches(
        data::TransactionAndMetadata const& txnPlusMeta,
        Input const& input,
        Context const& ctx
    ) const;

    [[nodiscard]] boost::json::object
    expandedTransactionToJson(
        boost::json::object txn,
        boost::json::object meta,
        data::TransactionAndMetadata const& txnPlusMeta,
        Context const& ctx
    ) const;

    friend void
    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Output const& output);

    friend Input
    tag_invoke(boost::json::value_to_tag<Input>, boost::json::value const& jv);

    friend void
    tag_invoke(boost::json::value_from_tag, boost::json::value& jv, Marker const& marker);
};
 
}  // namespace rpc