monero_daemon_rpc.h

#pragma once
 
#include "monero_daemon.h"

namespace monero {
 
  // forward declaration of internal daemon poller
  class monero_daemon_poller;

  class monero_daemon_rpc : public monero_daemon {
  public:

    ~monero_daemon_rpc() override;
    monero_daemon_rpc(const std::shared_ptr<monero_rpc_connection>& rpc);
    monero_daemon_rpc(const std::string& uri, const std::string& username = "", const std::string& password = "", const std::string& proxy_uri = "", const std::string& zmq_uri = "", const boost::optional<uint32_t>& timeout = boost::none);

    std::shared_ptr<monero_rpc_connection> get_rpc_connection() const;

    bool is_connected();

    void set_poll_period_in_ms(uint64_t period_ms);

    std::set<monero_daemon_listener*> get_listeners() override;
    void add_listener(monero_daemon_listener &listener) override;
    void remove_listener(monero_daemon_listener &listener) override;
    void remove_listeners() override;
    monero_version get_version() override;
    bool is_trusted() override;
    uint64_t get_height() override;
    std::string get_block_hash(uint64_t height) override;
    std::shared_ptr<monero_block_template> get_block_template(const std::string& wallet_address, const boost::optional<int>& reserve_size = boost::none) override;
    std::shared_ptr<monero_block_header> get_last_block_header() override;
    std::shared_ptr<monero_block_header> get_block_header_by_hash(const std::string& hash) override;
    std::shared_ptr<monero_block_header> get_block_header_by_height(uint64_t height) override;
    std::vector<std::shared_ptr<monero_block_header>> get_block_headers_by_range(uint64_t start_height, uint64_t end_height) override;
    std::shared_ptr<monero_block> get_block_by_hash(const std::string& hash) override;
    std::vector<std::shared_ptr<monero_block>> get_blocks_by_hash(const std::vector<std::string>& block_hashes, uint64_t start_height, bool prune) override;
    std::shared_ptr<monero_block> get_block_by_height(uint64_t height) override;
    std::vector<std::shared_ptr<monero_block>> get_blocks_by_height(const std::vector<uint64_t>& heights) override;
    std::vector<std::shared_ptr<monero_block>> get_blocks_by_range(boost::optional<uint64_t> start_height, boost::optional<uint64_t> end_height) override;
    std::vector<std::shared_ptr<monero_block>> get_blocks_by_range_chunked(boost::optional<uint64_t> start_height, boost::optional<uint64_t> end_height, boost::optional<uint64_t> max_chunk_size) override;
    std::vector<std::string> get_block_hashes(const std::vector<std::string>& block_hashes, uint64_t start_height) override;
    std::vector<std::shared_ptr<monero_tx>> get_txs(const std::vector<std::string>& tx_hashes, bool prune = false) override;
    std::vector<std::string> get_tx_hexes(const std::vector<std::string>& tx_hashes, bool prune = false) override;
    std::shared_ptr<monero_miner_tx_sum> get_miner_tx_sum(uint64_t height, uint64_t num_blocks) override;
    std::shared_ptr<monero_fee_estimate> get_fee_estimate(uint64_t grace_blocks = 0) override;
    std::shared_ptr<monero_submit_tx_result> submit_tx_hex(const std::string& tx_hex, bool do_not_relay = false) override;
    void relay_txs_by_hash(const std::vector<std::string>& tx_hashes) override;
    std::shared_ptr<monero_tx_pool_stats> get_tx_pool_stats() override;
    std::vector<std::shared_ptr<monero_tx>> get_tx_pool() override;
    std::vector<std::string> get_tx_pool_hashes() override;
    void flush_tx_pool(const std::vector<std::string> &hashes) override;
    void flush_tx_pool() override;
    void flush_tx_pool(const std::string &hash) override;
    std::vector<monero_key_image_spent_status> get_key_image_spent_statuses(const std::vector<std::string>& key_images) override;
    std::vector<std::shared_ptr<monero_output>> get_outputs(const std::vector<monero_output>& outputs) override;
    std::vector<std::shared_ptr<monero_output_histogram_entry>> get_output_histogram(const std::vector<uint64_t>& amounts, const boost::optional<int>& min_count, const boost::optional<int>& max_count, const boost::optional<bool>& is_unlocked, const boost::optional<int>& recent_cutoff) override;
    std::vector<std::shared_ptr<monero_output_distribution_entry>> get_output_distribution(const std::vector<uint64_t>& amounts, const boost::optional<bool>& is_cumulative = boost::none, const boost::optional<uint64_t>& start_height = boost::none, const boost::optional<uint64_t>& end_height = boost::none) override;
    std::shared_ptr<monero_daemon_info> get_info() override;
    std::shared_ptr<monero_daemon_sync_info> get_sync_info() override;
    std::shared_ptr<monero_hard_fork_info> get_hard_fork_info() override;
    std::vector<std::shared_ptr<monero_alt_chain>> get_alt_chains() override;
    std::vector<std::string> get_alt_block_hashes() override;
    int get_download_limit() override;
    int set_download_limit(int limit) override;
    int reset_download_limit() override;
    int get_upload_limit() override;
    int set_upload_limit(int limit) override;
    int reset_upload_limit() override;
    std::vector<std::shared_ptr<monero_peer>> get_peers() override;
    std::vector<std::shared_ptr<monero_peer>> get_known_peers() override;
    void set_outgoing_peer_limit(int limit) override;
    void set_incoming_peer_limit(int limit) override;
    std::vector<std::shared_ptr<monero_ban>> get_peer_bans() override;
    void set_peer_bans(const std::vector<std::shared_ptr<monero_ban>>& bans) override;
    void start_mining(const std::string &address, boost::optional<uint64_t> num_threads, boost::optional<bool> background_mining, boost::optional<bool> ignore_battery) override;
    void stop_mining() override;
    std::shared_ptr<monero_mining_status> get_mining_status() override;
    std::shared_ptr<monero_generate_blocks_result> generate_blocks(const std::string& wallet_address, uint64_t num_blocks, const boost::optional<std::string>& prev_block_hash = boost::none, const boost::optional<uint32_t>& starting_nonce = boost::none) override;
    void submit_blocks(const std::vector<std::string>& block_blobs) override;
    std::shared_ptr<monero_prune_result> prune_blockchain(bool check) override;
    std::shared_ptr<monero_daemon_update_check_result> check_for_update() override;
    std::shared_ptr<monero_daemon_update_download_result> download_update(const std::string& path = "") override;
    void stop() override;
    std::shared_ptr<monero_block_header> wait_for_next_block_header() override;
 
  // --------------------------------- PRIVATE --------------------------------
 
  private:
    friend class monero_daemon_poller;
    mutable boost::recursive_mutex m_listeners_mutex;
    std::set<monero_daemon_listener*> m_listeners;
    std::shared_ptr<monero_rpc_connection> m_rpc;
    boost::mutex m_poller_mutex;
    std::unique_ptr<monero_daemon_poller> m_poller;
 
    // header_cache is scoped to a single get_blocks_by_range_chunked() call (see below) rather than
    // stored as a member: it only helps avoid re-fetching a header already seen earlier in that one
    // chunking pass, and keeping it as instance state would let it grow unbounded over the connection's
    // lifetime and serve stale headers across reorgs on later calls
    std::vector<std::shared_ptr<monero_block>> get_max_blocks(boost::optional<uint64_t> start_height, boost::optional<uint64_t> max_height, boost::optional<uint64_t> chunk_size, std::unordered_map<uint64_t, std::shared_ptr<monero_block_header>>& header_cache);
    std::shared_ptr<monero_block_header> get_block_header_by_height_cached(uint64_t height, uint64_t max_height, std::unordered_map<uint64_t, std::shared_ptr<monero_block_header>>& header_cache);
    std::shared_ptr<monero_bandwidth_limits> get_bandwidth_limits();
    std::shared_ptr<monero_bandwidth_limits> set_bandwidth_limits(int up, int down);
    void refresh_listening();
    void wait_for_listener_callbacks_idle();
  };
 
}