monero_wallet_full.h

 
#pragma once
 
#include <boost/optional.hpp>
#include <boost/thread/mutex.hpp>
#include <boost/thread/recursive_mutex.hpp>
#include <boost/thread/thread.hpp>
#include <boost/thread/condition_variable.hpp>
#include <atomic>
#include <functional>
 
#include "monero_wallet.h"
#include "wallet/wallet2.h"

namespace monero {
 
  // -------------------------------- LISTENERS -------------------------------
 
  // forward declaration of internal wallet2 listener
  struct wallet2_listener;
 
  // --------------------------- STATIC WALLET UTILS --------------------------

  class monero_wallet_full : public monero_wallet {
 
  public:

    static bool wallet_exists(const std::string& path);

    static monero_wallet_full* open_wallet(const std::string& path, const std::string& password, const monero_network_type network_type, bool regtest = false);

    static monero_wallet_full* open_wallet_data(const std::string& password, const monero_network_type, const std::string& keys_data, const std::string& cache_data, const std::shared_ptr<monero_rpc_connection>& daemon_connection = std::make_shared<monero_rpc_connection>(), std::unique_ptr<epee::net_utils::http::http_client_factory> http_client_factory = nullptr, bool regtest = false);

    static monero_wallet_full* create_wallet(const monero_wallet_config& config, std::unique_ptr<epee::net_utils::http::http_client_factory> http_client_factory = nullptr);

    static std::vector<std::string> get_seed_languages();
 
    // ----------------------------- WALLET METHODS -----------------------------

    ~monero_wallet_full();

    bool is_view_only() const override { return m_w2->watch_only(); }
    void set_daemon_connection(const std::string& uri, const std::string& username = "", const std::string& password = "", const std::string& proxy_uri = "", const boost::optional<bool>& is_trusted = boost::none) override;
    void set_daemon_connection(const std::shared_ptr<monero_rpc_connection>& connection, const boost::optional<bool>& is_trusted = boost::none) override;
    std::shared_ptr<monero_rpc_connection> get_daemon_connection() const override;
    bool is_connected_to_daemon() const override;
    bool is_daemon_synced() const override;
    bool is_daemon_trusted() const override;
    bool is_synced() const override;
    monero_version get_version() const override;
    std::string get_path() const override;
    monero_network_type get_network_type() const override;
    std::string get_seed() const override;
    std::string get_seed_language() const override;
    std::string get_public_view_key() const override;
    std::string get_private_view_key() const override;
    std::string get_public_spend_key() const override;
    std::string get_private_spend_key() const override;
    std::string get_address(const uint32_t account_idx, const uint32_t subaddress_idx) const override;
    monero_subaddress get_address_index(const std::string& address) const override;
    monero_integrated_address get_integrated_address(const std::string& standard_address = "", const std::string& payment_id = "") const override;
    monero_integrated_address decode_integrated_address(const std::string& integrated_address) const override;
    uint64_t get_height() const override;
    uint64_t get_restore_height() const override;
    void set_restore_height(uint64_t restore_height) override;
    uint64_t get_daemon_height() const override;
    uint64_t get_daemon_max_peer_height() const override;
    uint64_t get_height_by_date(uint16_t year, uint8_t month, uint8_t day) const override;
    void add_listener(monero_wallet_listener& listener) override;
    // waits for active callbacks and permits cleanup after close; callers must not hold locks needed by those callbacks
    void remove_listener(monero_wallet_listener& listener) override;
    std::set<monero_wallet_listener*> get_listeners() override;
    monero_sync_result sync() override;
    monero_sync_result sync(monero_wallet_listener& listener) override;
    monero_sync_result sync(uint64_t start_height) override;
    monero_sync_result sync(uint64_t start_height, monero_wallet_listener& listener) override;
    void start_syncing(uint64_t sync_period_in_ms) override;
    void stop_syncing() override;
    void scan_txs(const std::vector<std::string>& tx_hashes) override;
    void rescan_spent() override;
    void rescan_blockchain() override;
    uint64_t get_balance() const override;
    uint64_t get_balance(uint32_t account_idx) const override;
    uint64_t get_balance(uint32_t account_idx, uint32_t subaddress_idx) const override;
    uint64_t get_unlocked_balance() const override;
    uint64_t get_unlocked_balance(uint32_t account_idx) const override;
    uint64_t get_unlocked_balance(uint32_t account_idx, uint32_t subaddress_idx) const override;
    std::vector<monero_account> get_accounts(bool include_subaddresses, const std::string& tag) const override;
    monero_account get_account(const uint32_t account_idx, bool include_subaddresses) const override;
    monero_account create_account(const std::string& label = "") override;
    std::vector<monero_subaddress> get_subaddresses(const uint32_t account_idx, const std::vector<uint32_t>& subaddress_indices) const override;
    monero_subaddress create_subaddress(uint32_t account_idx, const std::string& label = "") override;
    void set_subaddress_label(uint32_t account_idx, uint32_t subaddress_idx, const std::string& label = "") override;
    std::vector<std::shared_ptr<monero_tx_wallet>> get_txs() const override;
    std::vector<std::shared_ptr<monero_tx_wallet>> get_txs(const monero_tx_query& query) const override;
    std::vector<std::shared_ptr<monero_transfer>> get_transfers(const monero_transfer_query& query) const override;
    std::vector<std::shared_ptr<monero_output_wallet>> get_outputs(const monero_output_query& query) const override;
    std::string export_outputs(bool all = false) const override;
    int import_outputs(const std::string& outputs_hex) override;
    std::shared_ptr<monero_key_image_export_result> export_key_images(bool all = false) const override;
    std::shared_ptr<monero_key_image_import_result> import_key_images(const std::vector<std::shared_ptr<monero_key_image>>& key_images, uint64_t offset = 0) override;
    void freeze_output(const std::string& key_image) override;
    void thaw_output(const std::string& key_image) override;
    bool is_output_frozen(const std::string& key_image) override;
    monero_tx_priority get_default_fee_priority() const override;
    std::vector<std::shared_ptr<monero_tx_wallet>> create_txs(const monero_tx_config& config) override;
    std::vector<std::shared_ptr<monero_tx_wallet>> sweep_unlocked(const monero_tx_config& config) override;
    std::shared_ptr<monero_tx_wallet> sweep_output(const monero_tx_config& config) override;
    std::vector<std::shared_ptr<monero_tx_wallet>> sweep_dust(bool relay = false) override;
    std::vector<std::string> relay_txs(const std::vector<std::string>& tx_metadatas) override;
    monero_tx_set describe_tx_set(const monero_tx_set& tx_set) override;
    monero_tx_set sign_txs(const std::string& unsigned_tx_hex) override;
    std::vector<std::string> submit_txs(const std::string& signed_tx_hex) override;
    std::string sign_message(const std::string& msg, monero_message_signature_type signature_type, uint32_t account_idx = 0, uint32_t subaddress_idx = 0) const override;
    monero_message_signature_result verify_message(const std::string& msg, const std::string& address, const std::string& signature) const override;
    std::string get_tx_key(const std::string& tx_hash) const override;
    std::shared_ptr<monero_check_tx> check_tx_key(const std::string& tx_hash, const std::string& txKey, const std::string& address) const override;
    std::string get_tx_proof(const std::string& tx_hash, const std::string& address, const std::string& message) const override;
    std::shared_ptr<monero_check_tx> check_tx_proof(const std::string& tx_hash, const std::string& address, const std::string& message, const std::string& signature) const override;
    std::string get_spend_proof(const std::string& tx_hash, const std::string& message) const override;
    bool check_spend_proof(const std::string& tx_hash, const std::string& message, const std::string& signature) const override;
    std::string get_reserve_proof_wallet(const std::string& message) const override;
    std::string get_reserve_proof_account(uint32_t account_idx, uint64_t amount, const std::string& message) const override;
    std::shared_ptr<monero_check_reserve> check_reserve_proof(const std::string& address, const std::string& message, const std::string& signature) const override;
    std::string get_tx_note(const std::string& tx_hash) const override;
    std::vector<std::string> get_tx_notes(const std::vector<std::string>& tx_hashes) const override;
    void set_tx_note(const std::string& tx_hash, const std::string& note) override;
    void set_tx_notes(const std::vector<std::string>& tx_hashes, const std::vector<std::string>& notes) override;
    std::vector<monero_address_book_entry> get_address_book_entries(const std::vector<uint64_t>& indices) const override;
    uint64_t add_address_book_entry(const std::string& address, const std::string& description) override;
    void edit_address_book_entry(uint64_t index, bool set_address, const std::string& address, bool set_description, const std::string& description) override;
    void delete_address_book_entry(uint64_t index) override;
    std::string get_payment_uri(const monero_tx_config& config) const override;
    std::shared_ptr<monero_tx_config> parse_payment_uri(const std::string& uri) const override;
    bool get_attribute(const std::string& key, std::string& value) const override;
    void set_attribute(const std::string& key, const std::string& val) override;
    void start_mining(boost::optional<uint64_t> num_threads, boost::optional<bool> background_mining, boost::optional<bool> ignore_battery) override;
    void stop_mining() override;
    uint64_t wait_for_next_block() override;
    bool is_multisig_import_needed() const override;
    monero_multisig_info get_multisig_info() const override;
    std::string prepare_multisig() override;
    std::string make_multisig(const std::vector<std::string>& multisig_hexes, int threshold, const std::string& password) override;
    monero_multisig_init_result exchange_multisig_keys(const std::vector<std::string>& multisig_hexes, const std::string& password) override;
    std::string export_multisig_hex() override;
    int import_multisig_hex(const std::vector<std::string>& multisig_hexes, const bool refresh_after_import = true) override;
    monero_multisig_sign_result sign_multisig_tx_hex(const std::string& multisig_tx_hex) override;
    std::vector<std::string> submit_multisig_tx_hex(const std::string& signed_multisig_tx_hex) override;
    void change_password(const std::string& old_password, const std::string& new_password) override;
    void move_to(const std::string& path, const std::string& password) override;
    void save() override;
    void close(bool save = false) override;
    bool is_closed() const override { return m_is_closed; }

    void request_shutdown();

    std::string get_keys_file_buffer(const epee::wipeable_string& password, bool view_only) const;
    std::string get_cache_file_buffer() const;
 
  // --------------------------------- PROTECTED --------------------------------
 
  protected:
    std::unique_ptr<tools::wallet2> m_w2;            // internal wallet implementation
 
    void init_common();
 
  // ---------------------------------- PRIVATE ---------------------------------
 
  private:
    friend struct wallet2_listener;
    mutable boost::mutex m_daemon_connection_mutex; // serialize daemon changes and connection snapshots
    std::string m_daemon_proxy_uri;
    bool m_daemon_ssl_verify = true;
    void set_daemon_connection(const std::string& uri, const std::string& username, const std::string& password, const std::string& proxy_uri, const boost::optional<bool>& is_trusted, bool ssl_verify);
    std::unique_ptr<wallet2_listener> m_w2_listener; // internal wallet implementation listener
    std::set<monero_wallet_listener*> m_listeners;   // external wallet listeners
    boost::recursive_mutex m_listeners_mutex;       // serialize notifications with listener removal, including removal from a callback
    void notify_listeners(const std::function<void(monero_wallet_listener*)>& notify);
    std::atomic<bool> m_is_closed;
 
    static monero_wallet_full* create_wallet_from_seed(monero_wallet_config& config, std::unique_ptr<epee::net_utils::http::http_client_factory> http_client_factory);
    static monero_wallet_full* create_wallet_from_keys(monero_wallet_config& config, std::unique_ptr<epee::net_utils::http::http_client_factory> http_client_factory);
    static monero_wallet_full* create_wallet_random(monero_wallet_config& config, std::unique_ptr<epee::net_utils::http::http_client_factory> http_client_factory);
 
    std::vector<monero_subaddress> get_subaddresses_aux(uint32_t account_idx, const std::vector<uint32_t>& subaddress_indices, const std::vector<tools::wallet2::transfer_details>& transfers) const;
    std::vector<std::shared_ptr<monero_tx_wallet>> get_txs_aux(const monero_tx_query& query, int max_attempts = 5) const; // unlocked; callers may hold sync_op_lock
    std::vector<std::shared_ptr<monero_transfer>> get_transfers_aux(const monero_transfer_query& query) const;
    std::vector<std::shared_ptr<monero_output_wallet>> get_outputs_aux(const monero_output_query& query) const;
    std::vector<std::shared_ptr<monero_tx_wallet>> sweep_account(const monero_tx_config& config);  // sweeps unlocked funds within an account; private helper to sweep_unlocked()
 
    void assert_not_closed() const;
 
    // serializes a wallet operation with background sync: pauses the sync loop, interrupts background refresh unless interrupt_sync is false, and locks m_sync_mutex
    struct sync_op_lock {
      sync_op_lock(const monero_wallet_full& wallet, bool interrupt_sync = true);
      sync_op_lock(const sync_op_lock&) = delete;
      ~sync_op_lock();
      const monero_wallet_full& m_wallet;
    };
 
    // blockchain sync management
    mutable std::atomic<bool> m_is_synced;       // whether or not wallet is synced
    boost::condition_variable m_sync_cv;         // to make sync threads woke
    mutable boost::mutex m_sync_mutex;           // synchronize sync and other wallet operations
    mutable std::atomic<uint32_t> m_num_sync_pauses; // number of operations pausing background sync
    std::atomic<bool> m_background_syncing;      // whether or not a background sync pass is in progress
    std::atomic<bool> m_interrupt_sync;          // request to end an in-progress sync at the next chunk boundary
    std::atomic<bool> m_sync_in_progress;        // whether or not a sync pass is executing
    std::atomic<bool> m_rescan_on_sync;          // whether or not to rescan on sync
    std::atomic<bool> m_syncing_enabled;         // whether or not auto sync is enabled
    std::atomic<bool> m_sync_loop_running;       // whether or not the syncing thread is shut down
    std::atomic<int> m_syncing_interval;         // auto sync loop interval in milliseconds
    boost::thread m_syncing_thread;              // thread for auto sync loop
    boost::mutex m_syncing_mutex;                // synchronize auto sync loop
    void run_sync_loop();                        // run the sync loop in a thread
    monero_sync_result lock_and_sync(boost::optional<uint64_t> start_height = boost::none, bool background = false);  // internal function to synchronize request to sync and rescan
    monero_sync_result sync_aux(boost::optional<uint64_t> start_height, boost::unique_lock<boost::mutex>& lock);  // internal function to immediately block, sync, and report progress
  };
}