ETLState.hpp

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2023, the clio developers.
 
    Permission to use, copy, modify, and 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.
*/
//==============================================================================
 
#pragma once
 
#include "data/BackendInterface.hpp"
#include "rpc/JS.hpp"
 
#include <boost/json.hpp>
#include <boost/json/conversion.hpp>
#include <boost/json/object.hpp>
#include <boost/json/value.hpp>
#include <boost/json/value_to.hpp>
#include <xrpl/protocol/jss.h>
 
#include <cstdint>
#include <optional>
 
namespace etl {

struct ETLState {
    /*
     * NOTE: Rippled NetworkID: Mainnet = 0; Testnet = 1; Devnet = 2
     * However, if rippled is running on neither of these (ie. standalone mode) rippled will default
     * to 0, but is not included in the stateOpt response. Must manually add it here.
     */
    uint32_t networkID{0};

    template <typename Forward>
    static std::optional<ETLState>
    fetchETLStateFromSource(Forward& source) noexcept
    {
        auto const serverInfoRippled =
            data::synchronous([&source](auto yield) -> std::optional<boost::json::object> {
                if (auto result = source.forwardToRippled(
                        {{"command", "server_info"}}, std::nullopt, {}, yield
                    )) {
                    return std::move(result).value();
                }
                return std::nullopt;
            });
 
        if (serverInfoRippled && not serverInfoRippled->contains(JS(error))) {
            return boost::json::value_to<ETLState>(boost::json::value(*serverInfoRippled));
        }
 
        return std::nullopt;
    }
};

ETLState
tag_invoke(boost::json::value_to_tag<ETLState>, boost::json::value const& jv);
 
}  // namespace etl