NFTOffersCommon.hpp

#pragma once
 
#include "data/BackendInterface.hpp"
#include "rpc/JS.hpp"
#include "rpc/common/Modifiers.hpp"
#include "rpc/common/Specs.hpp"
#include "rpc/common/Types.hpp"
#include "rpc/common/Validators.hpp"
 
#include <boost/asio/spawn.hpp>
#include <boost/json/conversion.hpp>
#include <boost/json/value.hpp>
#include <xrpl/basics/base_uint.h>
#include <xrpl/protocol/Keylet.h>
#include <xrpl/protocol/STLedgerEntry.h>
#include <xrpl/protocol/jss.h>
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <vector>
 
namespace rpc {

class NFTOffersHandlerBase {
    std::shared_ptr<BackendInterface> sharedPtrBackend_;
 
public:
    static constexpr auto kLIMIT_MIN = 50;
    static constexpr auto kLIMIT_MAX = 500;
    static constexpr auto kLIMIT_DEFAULT = 250;

    struct Output {
        std::string nftID;
        std::vector<ripple::SLE> offers;
 
        // validated should be sent via framework
        bool validated = true;
        std::optional<uint32_t> limit;
        std::optional<std::string> marker;
    };

    struct Input {
        std::string nftID;
        std::optional<std::string> ledgerHash;
        std::optional<uint32_t> ledgerIndex;
        uint32_t limit = kLIMIT_DEFAULT;
        std::optional<std::string> marker;
    };
 
    using Result = HandlerReturnType<Output>;

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

    static RpcSpecConstRef
    spec([[maybe_unused]] uint32_t apiVersion)
    {
        static auto const kRPC_SPEC = RpcSpec{
            {JS(nft_id),
             validation::Required{},
             validation::CustomValidators::uint256HexStringValidator},
            {JS(ledger_hash), validation::CustomValidators::uint256HexStringValidator},
            {JS(ledger_index), validation::CustomValidators::ledgerIndexValidator},
            {JS(limit),
             validation::Type<uint32_t>{},
             validation::Min(1u),
             modifiers::Clamp<int32_t>{kLIMIT_MIN, kLIMIT_MAX}},
            {JS(marker), validation::CustomValidators::uint256HexStringValidator},
        };
 
        return kRPC_SPEC;
    }
 
protected:
    Result
    iterateOfferDirectory(
        Input input,
        ripple::uint256 const& tokenID,
        ripple::Keylet const& directory,
        boost::asio::yield_context yield
    ) const;
 
private:
    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);
};
 
}  // namespace rpc