GatewayBalances.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/Errors.hpp"
#include "rpc/JS.hpp"
#include "rpc/common/Specs.hpp"
#include "rpc/common/Types.hpp"
#include "rpc/common/Validators.hpp"
#include "util/AccountUtils.hpp"
 
#include <boost/json/array.hpp>
#include <boost/json/conversion.hpp>
#include <boost/json/value.hpp>
#include <xrpl/protocol/AccountID.h>
#include <xrpl/protocol/ErrorCodes.h>
#include <xrpl/protocol/PublicKey.h>
#include <xrpl/protocol/STAmount.h>
#include <xrpl/protocol/UintTypes.h>
#include <xrpl/protocol/jss.h>
#include <xrpl/protocol/tokens.h>
 
#include <cstdint>
#include <map>
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <string_view>
#include <vector>
 
namespace rpc {

class GatewayBalancesHandler {
    std::shared_ptr<BackendInterface> sharedPtrBackend_;
 
public:
    struct Output {
        std::string ledgerHash;
        uint32_t ledgerIndex;
        std::string accountID;
        bool overflow = false;
        std::map<ripple::Currency, ripple::STAmount> sums;
        std::map<ripple::AccountID, std::vector<ripple::STAmount>> hotBalances;
        std::map<ripple::AccountID, std::vector<ripple::STAmount>> assets;
        std::map<ripple::AccountID, std::vector<ripple::STAmount>> frozenBalances;
        std::map<ripple::Currency, ripple::STAmount> locked;
        // validated should be sent via framework
        bool validated = true;
    };

    struct Input {
        std::string account;
        std::set<ripple::AccountID> hotWallets;
        std::optional<std::string> ledgerHash;
        std::optional<uint32_t> ledgerIndex;
    };
 
    using Result = HandlerReturnType<Output>;

    GatewayBalancesHandler(std::shared_ptr<BackendInterface> const& sharedPtrBackend)
        : sharedPtrBackend_(sharedPtrBackend)
    {
    }

    static RpcSpecConstRef
    spec([[maybe_unused]] uint32_t apiVersion)
    {
        auto const getHotWalletValidator = [](RippledError errCode) {
            return validation::CustomValidator{
                [errCode](boost::json::value const& value, std::string_view key) -> MaybeError {
                    if (!value.is_string() && !value.is_array())
                        return Error{Status{errCode, std::string(key) + "NotStringOrArray"}};
 
                    // wallet needs to be an valid accountID or public key
                    auto const wallets =
                        value.is_array() ? value.as_array() : boost::json::array{value};
                    auto const getAccountID =
                        [](auto const& j) -> std::optional<ripple::AccountID> {
                        if (j.is_string()) {
                            auto const pk = util::parseBase58Wrapper<ripple::PublicKey>(
                                ripple::TokenType::AccountPublic,
                                boost::json::value_to<std::string>(j)
                            );
 
                            if (pk)
                                return ripple::calcAccountID(*pk);
 
                            return util::parseBase58Wrapper<ripple::AccountID>(
                                boost::json::value_to<std::string>(j)
                            );
                        }
 
                        return {};
                    };
 
                    for (auto const& wallet : wallets) {
                        if (!getAccountID(wallet))
                            return Error{Status{errCode, std::string(key) + "Malformed"}};
                    }
 
                    return MaybeError{};
                }
            };
        };
 
        static auto const kSPEC_COMMON = RpcSpec{
            {JS(account), validation::Required{}, validation::CustomValidators::accountValidator},
            {JS(ledger_hash), validation::CustomValidators::uint256HexStringValidator},
            {JS(ledger_index), validation::CustomValidators::ledgerIndexValidator}
        };
 
        static auto const kSPEC_V1 = RpcSpec{
            kSPEC_COMMON, {{JS(hotwallet), getHotWalletValidator(ripple::rpcINVALID_HOTWALLET)}}
        };
        static auto const kSPEC_V2 = RpcSpec{
            kSPEC_COMMON, {{JS(hotwallet), getHotWalletValidator(ripple::rpcINVALID_PARAMS)}}
        };
 
        return apiVersion == 1 ? kSPEC_V1 : kSPEC_V2;
    }

    Result
    process(Input const& input, Context const& ctx) 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