// Copyright (c) 2016-2024, The Monero Project // // All rights reserved. // // Redistribution and use in source and binary forms, with or without modification, are // permitted provided that the following conditions are met: // // 1. Redistributions of source code must retain the above copyright notice, this list of // conditions and the following disclaimer. // // 2. Redistributions in binary form must reproduce the above copyright notice, this list // of conditions and the following disclaimer in the documentation and/or other // materials provided with the distribution. // // 3. Neither the name of the copyright holder nor the names of its contributors may be // used to endorse or promote products derived from this software without specific // prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. #pragma once #include #include #include #include "byte_stream.h" #include "message.h" #include "cryptonote_protocol/cryptonote_protocol_defs.h" #include "rpc/message_data_structs.h" #include "rpc/daemon_rpc_version.h" #include "cryptonote_basic/cryptonote_basic.h" #define BEGIN_RPC_MESSAGE_CLASS(classname) \ class classname \ { \ public: #define BEGIN_RPC_MESSAGE_REQUEST \ class Request final : public Message \ { \ public: \ Request() { } \ ~Request() { } \ void doToJson(rapidjson::Writer& dest) const override final; \ void fromJson(const rapidjson::Value& val) override final; #define BEGIN_RPC_MESSAGE_RESPONSE \ class Response final : public Message \ { \ public: \ Response() { } \ ~Response() { } \ void doToJson(rapidjson::Writer& dest) const override final; \ void fromJson(const rapidjson::Value& val) override final; #define END_RPC_MESSAGE_REQUEST }; #define END_RPC_MESSAGE_RESPONSE }; #define END_RPC_MESSAGE_CLASS }; // NOTE: when using a type with multiple template parameters, // replace any comma in the template specifier with the macro // above, or the preprocessor will eat the comma in a bad way. #define RPC_MESSAGE_MEMBER(type, name) type name = {} namespace cryptonote { namespace rpc { BEGIN_RPC_MESSAGE_CLASS(GetHeight); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(uint64_t, height); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlocksFast); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::list, block_ids); RPC_MESSAGE_MEMBER(uint64_t, start_height); RPC_MESSAGE_MEMBER(bool, prune); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, blocks); RPC_MESSAGE_MEMBER(uint64_t, start_height); RPC_MESSAGE_MEMBER(uint64_t, current_height); RPC_MESSAGE_MEMBER(crypto::hash, top_block_hash); RPC_MESSAGE_MEMBER(std::vector, output_indices); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetHashesFast); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::list, known_hashes); RPC_MESSAGE_MEMBER(uint64_t, start_height); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, hashes); RPC_MESSAGE_MEMBER(uint64_t, start_height); RPC_MESSAGE_MEMBER(uint64_t, current_height); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetTransactions); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::vector, tx_hashes); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; using txes_map = std::unordered_map; RPC_MESSAGE_MEMBER(txes_map, txs); RPC_MESSAGE_MEMBER(std::vector, missed_hashes); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(KeyImagesSpent); enum STATUS { UNSPENT = 0, SPENT_IN_BLOCKCHAIN = 1, SPENT_IN_POOL = 2, }; BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::vector, key_images); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, spent_status); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetTxGlobalOutputIndices); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(crypto::hash, tx_hash); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, output_indices); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetRandomOutputsForAmounts); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::vector, amounts); RPC_MESSAGE_MEMBER(uint64_t, count); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, amounts_with_outputs); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(SendRawTx); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(cryptonote::transaction, tx); RPC_MESSAGE_MEMBER(bool, relay); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(bool, relayed); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(SendRawTxHex); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::string, tx_as_hex); RPC_MESSAGE_MEMBER(bool, relay); END_RPC_MESSAGE_REQUEST; using Response = SendRawTx::Response; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(StartMining); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::string, miner_address); RPC_MESSAGE_MEMBER(uint64_t, threads_count); RPC_MESSAGE_MEMBER(bool, do_background_mining); RPC_MESSAGE_MEMBER(bool, ignore_battery); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetInfo); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(DaemonInfo, info); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(StopMining); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(MiningStatus); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(bool, active); RPC_MESSAGE_MEMBER(uint64_t, speed); RPC_MESSAGE_MEMBER(uint64_t, threads_count); RPC_MESSAGE_MEMBER(std::string, address); RPC_MESSAGE_MEMBER(bool, is_background_mining_enabled); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(SaveBC); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlockHash); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(uint64_t, height); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(crypto::hash, hash); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlockTemplate); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(SubmitBlock); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetLastBlockHeader); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(cryptonote::rpc::BlockHeaderResponse, header); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlockHeaderByHash); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(crypto::hash, hash); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(cryptonote::rpc::BlockHeaderResponse, header); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlockHeaderByHeight); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(uint64_t, height); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(cryptonote::rpc::BlockHeaderResponse, header); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlockHeadersByHeight); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::vector, heights); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, headers); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlock); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetPeerList); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, white_list); RPC_MESSAGE_MEMBER(std::vector, gray_list); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(SetLogHashRate); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(SetLogLevel); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(int8_t, level); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetTransactionPool); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, transactions); RPC_MESSAGE_MEMBER(key_images_with_tx_hashes, key_images); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetConnections); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBlockHeadersRange); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(StopDaemon); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(StartSaveGraph); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(StopSaveGraph); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(HardForkInfo); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(uint8_t, version); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(hard_fork_info, info); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetBans); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(SetBans); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(FlushTransactionPool); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetOutputHistogram); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::vector, amounts); RPC_MESSAGE_MEMBER(uint64_t, min_count); RPC_MESSAGE_MEMBER(uint64_t, max_count); RPC_MESSAGE_MEMBER(bool, unlocked); RPC_MESSAGE_MEMBER(uint64_t, recent_cutoff); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, histogram); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetOutputKeys); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::vector, outputs); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, keys); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetRPCVersion); BEGIN_RPC_MESSAGE_REQUEST; END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(uint32_t, version); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetFeeEstimate); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(uint64_t, num_grace_blocks); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(uint64_t, estimated_base_fee); RPC_MESSAGE_MEMBER(uint64_t, fee_mask); RPC_MESSAGE_MEMBER(uint32_t, size_scale); RPC_MESSAGE_MEMBER(uint8_t, hard_fork_version); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; BEGIN_RPC_MESSAGE_CLASS(GetOutputDistribution); BEGIN_RPC_MESSAGE_REQUEST; RPC_MESSAGE_MEMBER(std::vector, amounts); RPC_MESSAGE_MEMBER(uint64_t, from_height); RPC_MESSAGE_MEMBER(uint64_t, to_height); RPC_MESSAGE_MEMBER(bool, cumulative); END_RPC_MESSAGE_REQUEST; BEGIN_RPC_MESSAGE_RESPONSE; RPC_MESSAGE_MEMBER(std::vector, distributions); END_RPC_MESSAGE_RESPONSE; END_RPC_MESSAGE_CLASS; } // namespace rpc } // namespace cryptonote