lwsf-wow/src/wallet_manager.cpp

// Copyright (c) 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.

#include "lws_frontend.h"

#include <chrono>
#include <filesystem>
#include <memory>
#include <string>
#include <string_view>
#include <system_error>
#include "backend.h"
#include "common/dns_utils.h"  // monero/src
#include "cryptonote_basic/cryptonote_format_utils.h" // monero/src
#include "lwsf_config.h"
#include "lws_frontend.h"
#include "net/http_client.h"   // monero/contrib/epee/include
#include "net/parse.h"         // monero/src
#include "net/socks_connect.h" // monero/src
#include "QrCode.hpp"          // monero/src/external
#include "rpc.h"
#include "wallet.h"
#include "wallet/api/wallet2_api.h" // monero/src

namespace lwsf
{
  namespace internal
  {
    //! \TODO Mark final when completely implemented
    class wallet_manager : public Monero::WalletManager
    {
      rpc::http_client client_;
      std::string error_;
      rpc::daemon_status cached_;
      std::chrono::steady_clock::time_point cached_last_;

      rpc::daemon_status get_daemon_status()
      {
        if (std::chrono::steady_clock::now() - cached_last_ > config::daemon_status_cache)
        {
          const auto resp = rpc::invoke<rpc::daemon_status>(client_, rpc::empty{});
          if (!resp)
          {
            error_ = resp.error().message();
            cached_ = rpc::daemon_status{};
          }
          else
          {
            error_.clear();
            cached_ = std::move(*resp);
          }
        }
        return cached_;
      }

    public:

      wallet_manager()
        : client_(), error_(), cached_{}, cached_last_(std::chrono::seconds{0})
      {}

      virtual ~wallet_manager() /* override */
      {}

    /*!
     * \brief  Creates new wallet
     * \param  path           Name of wallet file
     * \param  password       Password of wallet file
     * \param  language       Language to be used to generate electrum seed mnemonic
     * \param  nettype        Network type
     * \param  kdf_rounds     Number of rounds for key derivation function
     * \return                Wallet instance (Wallet::status() needs to be called to check if created successfully)
     */
      Monero::Wallet* createWallet(const std::string &path, const std::string &password, const std::string &language, Monero::NetworkType nettype, uint64_t kdf_rounds) override
      {
        return new wallet{wallet::create{}, nettype, path, password, kdf_rounds};
      }

    /*!
     * \brief  Opens existing wallet
     * \param  path           Name of wallet file
     * \param  password       Password of wallet file
     * \param  nettype        Network type
     * \param  kdf_rounds     Number of rounds for key derivation function
     * \param  listener       Wallet listener to set to the wallet after creation
     * \return                Wallet instance (Wallet::status() needs to be called to check if opened successfully)
     */

      Monero::Wallet* openWallet(const std::string &path, const std::string &password, Monero::NetworkType nettype, uint64_t kdf_rounds, Monero::WalletListener* listener) override
      {
        auto out = std::make_unique<wallet>(
          wallet::open{}, nettype, path, password, kdf_rounds
        );
        if (listener)
          out->setListener(listener);
        return out.release();
      }

    /*!
     * \brief  recovers existing wallet using mnemonic (electrum seed)
     * \param  path           Name of wallet file to be created
     * \param  password       Password of wallet file
     * \param  mnemonic       mnemonic (25 words electrum seed)
     * \param  nettype        Network type
     * \param  restoreHeight  restore from start height
     * \param  kdf_rounds     Number of rounds for key derivation function
     * \param  seed_offset    Seed offset passphrase (optional)
     * \return                Wallet instance (Wallet::status() needs to be called to check if recovered successfully)
     */
      Monero::Wallet* recoveryWallet(const std::string &path, const std::string &password, const std::string &mnemonic,
                                             Monero::NetworkType nettype = Monero::MAINNET, uint64_t restoreHeight = 0, uint64_t kdf_rounds = 1,
                                             const std::string &seed_offset = {}) override final
      {
        auto out = std::make_unique<wallet>(
          wallet::from_mnemonic{}, nettype, path, password, kdf_rounds, mnemonic, seed_offset
        );
        out->setRefreshFromBlockHeight(restoreHeight);
        return out.release();
      }

    /*!
     * \deprecated this method creates a wallet WITHOUT a passphrase, use the alternate recoverWallet() method
     * \brief  recovers existing wallet using mnemonic (electrum seed)
     * \param  path           Name of wallet file to be created
     * \param  mnemonic       mnemonic (25 words electrum seed)
     * \param  nettype        Network type
     * \param  restoreHeight  restore from start height
     * \return                Wallet instance (Wallet::status() needs to be called to check if recovered successfully)
     */
      Monero::Wallet* recoveryWallet(const std::string &path, const std::string &mnemonic, Monero::NetworkType nettype, uint64_t restoreHeight = 0) override
      {
        return recoveryWallet(path, "", mnemonic, nettype, restoreHeight);
      }

    /*!
     * \brief  recovers existing wallet using keys. Creates a view only wallet if spend key is omitted
     * \param  path           Name of wallet file to be created
     * \param  password       Password of wallet file
     * \param  language       language
     * \param  nettype        Network type
     * \param  restoreHeight  restore from start height
     * \param  addressString  public address
     * \param  viewKeyString  view key
     * \param  spendKeyString spend key (optional)
     * \param  kdf_rounds     Number of rounds for key derivation function
     * \return                Wallet instance (Wallet::status() needs to be called to check if recovered successfully)
     */
      Monero::Wallet* createWalletFromKeys(const std::string &path,
                                                   const std::string &password,
                                                   const std::string &language,
                                                   Monero::NetworkType nettype,
                                                   uint64_t restoreHeight,
                                                   const std::string &addressString,
                                                   const std::string &viewKeyString,
                                                   const std::string &spendKeyString,
                                                   uint64_t kdf_rounds) override
      {
        auto out = std::make_unique<wallet>(
          wallet::from_keys{}, nettype, path, password, kdf_rounds, addressString, viewKeyString, spendKeyString
        );
        out->setRefreshFromBlockHeight(restoreHeight);
        return out.release();
      }

   /*!
    * \deprecated this method creates a wallet WITHOUT a passphrase, use createWalletFromKeys(..., password, ...) instead
    * \brief  recovers existing wallet using keys. Creates a view only wallet if spend key is omitted
    * \param  path           Name of wallet file to be created
    * \param  language       language
    * \param  nettype        Network type
    * \param  restoreHeight  restore from start height
    * \param  addressString  public address
    * \param  viewKeyString  view key
    * \param  spendKeyString spend key (optional)
    * \return                Wallet instance (Wallet::status() needs to be called to check if recovered successfully)
    */
      Monero::Wallet* createWalletFromKeys(const std::string &path, 
                                                   const std::string &language,
                                                   Monero::NetworkType nettype, 
                                                   uint64_t restoreHeight,
                                                   const std::string &addressString,
                                                   const std::string &viewKeyString,
                                                   const std::string &spendKeyString) override
      {
        return createWalletFromKeys(path, "", language, nettype, restoreHeight, addressString, viewKeyString, spendKeyString, 1);
      }

    /*!
     * \brief  creates wallet using hardware device.
     * \param  path                 Name of wallet file to be created
     * \param  password             Password of wallet file
     * \param  nettype              Network type
     * \param  deviceName           Device name
     * \param  restoreHeight        restore from start height (0 sets to current height)
     * \param  subaddressLookahead  Size of subaddress lookahead (empty sets to some default low value)
     * \param  kdf_rounds           Number of rounds for key derivation function
     * \param  listener             Wallet listener to set to the wallet after creation
     * \return                      Wallet instance (Wallet::status() needs to be called to check if recovered successfully)
     */
      Monero::Wallet* createWalletFromDevice(const std::string &path,
                                            const std::string &password,
                                            Monero::NetworkType nettype,
                                            const std::string &deviceName,
                                            uint64_t restoreHeight,
                                            const std::string &subaddressLookahead,
                                            uint64_t kdf_rounds,
                                            Monero::WalletListener * listener) override
      {
        //! \TODO Complete
      }

    /*!
     * \brief Closes wallet. In case operation succeeded, wallet object deleted. in case operation failed, wallet object not deleted
     * \param wallet        previously opened / created wallet instance
     * \return              None
     */
      bool closeWallet(Monero::Wallet* const wallet, const bool store) override
      {
        if (wallet && store && !wallet->store({}))
          return false;
        delete wallet;
        return true;
      }

    /*
     * ! checks if wallet with the given name already exists
     */

    /*!
     * @brief TODO: delme walletExists - check if the given filename is the wallet
     * @param path - filename
     * @return - true if wallet exists
     */
      bool walletExists(const std::string &path) override
      {
        return wallet::is_wallet_file(path); 
      }

    /*!
     * @brief verifyWalletPassword - check if the given filename is the wallet
     * @param keys_file_name - location of keys file
     * @param password - password to verify
     * @param no_spend_key - verify only view keys?
     * @param kdf_rounds - number of rounds for key derivation function
     * @return - true if password is correct
     *
     * @note
     * This function will fail when the wallet keys file is opened because the wallet program locks the keys file.
     * In this case, Wallet::unlockKeysFile() and Wallet::lockKeysFile() need to be called before and after the call to this function, respectively.
     */
      bool verifyWalletPassword(const std::string &keys_file_name, const std::string &password, bool, uint64_t) const override
      {
        return wallet::verify_password(keys_file_name, password);
      }

    /*!
     * \brief determine the key storage for the specified wallet file
     * \param device_type     (OUT) wallet backend as enumerated in Wallet::Device
     * \param keys_file_name  Keys file to verify password for
     * \param password        Password to verify
     * \return                true if password correct, else false
     *
     * for verification only - determines key storage hardware
     *
     */
      bool queryWalletDevice(Monero::Wallet::Device& device_type, const std::string &keys_file_name, const std::string &password, uint64_t kdf_rounds) const override
      {
        //! \TODO Complete
      }

    /*!
     * \brief findWallets - searches for the wallet files by given path name recursively
     * \param path - starting point to search
     * \return - list of strings with found wallets (absolute paths);
     */
      std::vector<std::string> findWallets(const std::string &path) override
      {
        return wallet::find(path);
      }

      std::string errorString() const override { return error_; }

    //! set the daemon address (hostname and port)
      void setDaemonAddress(const std::string &address) override
      {
        epee::net_utils::http::url_content url{};
        if (!epee::net_utils::parse_url(address, url))
          throw std::runtime_error{"Invalid LWS URL: " + address};
        if (!url.m_uri_content.m_path.empty())
          throw std::runtime_error{"LWS URL contains path (unsupported)"};

        bool use_ssl = false;
        if (url.schema == "https")
          use_ssl = true;

        const epee::net_utils::ssl_options_t options{
          use_ssl ? epee::net_utils::ssl_support_t::e_ssl_support_disabled : epee::net_utils::ssl_support_t::e_ssl_support_enabled
        };

        client_.set_server(std::move(url.host), std::to_string(url.port), boost::none, std::move(options));
      }

    //! returns whether the daemon can be reached, and its version number
      bool connected(uint32_t *version = NULL) override
      {
        if (version)
          *version = 0;
        return client_.is_connected();
      }

      uint64_t blockchainHeight() override
      {
        return get_daemon_status().height;
      }

      uint64_t blockchainTargetHeight() override
      {
        return get_daemon_status().target_height;
      }

        //! \TODO Complete
      uint64_t networkDifficulty() override { return 0; }

        //! \TODO Complete
      double miningHashRate() override { return 0.f; }

        //! \TODO Complete
      uint64_t blockTarget() override { return 0; }

      bool isMining() override { return false; }
      bool startMining(const std::string&, uint32_t, bool, bool) override
      {
        return false;
      }
      bool stopMining() override { return true; }

      std::string resolveOpenAlias(const std::string &address, bool &dnssec_valid) const override
      {
        std::vector<std::string> addresses = tools::dns_utils::addresses_from_url(address, dnssec_valid);
        if (addresses.empty())
          return {};
        return {std::move(addresses.front())};
      }

      //! checks for an update and returns version, hash and url
      static std::tuple<bool, std::string, std::string, std::string, std::string> checkUpdates(
        const std::string &software,
        std::string subdir,
        const char *buildtag = nullptr,
        const char *current_version = nullptr);

      bool setProxy(const std::string &address) override
      {
        auto endpoint = net::get_tcp_endpoint(address);
        if (!endpoint)
        {
          error_ = endpoint.error().message();
          return false;
        }
        client_.set_connector(net::socks::connector{std::move(*endpoint)});
        return true;
      }
    };
  } // internal

  std::string displayAmount(std::uint64_t amount)
  {
    return cryptonote::print_money(amount);
  }

  std::optional<std::uint64_t> amountFromString(const std::string &amount)
  {
    std::uint64_t result = 0;
    if (cryptonote::parse_amount(result, amount))
      return result;
    return std::nullopt;
  }

  bool addressValid(const std::string &str, Monero::NetworkType nettype)
  {
    cryptonote::address_parse_info info;
    return get_account_address_from_str(info, static_cast<cryptonote::network_type>(nettype), str);
  }

  std::vector<std::vector<std::uint8_t>> qrcode(Monero::Wallet const* const wal, const std::uint32_t major, const std::uint32_t minor)
  {
    if (!wal)
      return {};

    const std::string uri = "monero:" + wal->address(major, minor);
    const qrcodegen::QrCode qr = qrcodegen::QrCode::encodeText(uri.c_str(), qrcodegen::QrCode::Ecc::LOW);
    const int size = qr.getSize();
    if (size < 0 || std::numeric_limits<std::size_t>::max() < size)
      return {};

    std::vector<std::vector<std::uint8_t>> out;
    out.resize(size);
    for (std::size_t y = 0; y < size; ++y)
    {
      auto& row = out.at(y);
      row.resize(size);

      for (std::size_t x = 0; x < size; ++x)
        row.at(x) = qr.getModule(x, y);
    }

    return out;
  }

  Monero::WalletManager* WalletManagerFactory::getWalletManager()
  {
    return new internal::wallet_manager{};
  }

  void WalletManagerFactory::setLogLevel(LogLevel level)
  {
        //! \TODO Complete
  }
   
  void WalletManagerFactory::setLogCategories(const std::string &categories)
  {
        //! \TODO Complete
  }
} // lwsf