Monero
wallet_manager.h
Go to the documentation of this file.
1 // Copyright (c) 2014-2022, The Monero Project
2 //
3 // All rights reserved.
4 //
5 // Redistribution and use in source and binary forms, with or without modification, are
6 // permitted provided that the following conditions are met:
7 //
8 // 1. Redistributions of source code must retain the above copyright notice, this list of
9 // conditions and the following disclaimer.
10 //
11 // 2. Redistributions in binary form must reproduce the above copyright notice, this list
12 // of conditions and the following disclaimer in the documentation and/or other
13 // materials provided with the distribution.
14 //
15 // 3. Neither the name of the copyright holder nor the names of its contributors may be
16 // used to endorse or promote products derived from this software without specific
17 // prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
20 // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
21 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
22 // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24 // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
26 // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
27 // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 //
29 // Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
30 
31 
32 #include "wallet/api/wallet2_api.h"
33 #include "net/http.h"
34 #include <string>
35 
36 namespace Monero {
37 
39 {
40 public:
41  Wallet * createWallet(const std::string &path, const std::string &password,
42  const std::string &language, NetworkType nettype, uint64_t kdf_rounds = 1) override;
43  Wallet * openWallet(const std::string &path, const std::string &password, NetworkType nettype, uint64_t kdf_rounds = 1, WalletListener * listener = nullptr) override;
44  virtual Wallet * recoveryWallet(const std::string &path,
45  const std::string &password,
46  const std::string &mnemonic,
47  NetworkType nettype,
48  uint64_t restoreHeight,
49  uint64_t kdf_rounds = 1,
50  const std::string &seed_offset = {}) override;
51  virtual Wallet * createWalletFromKeys(const std::string &path,
52  const std::string &password,
53  const std::string &language,
54  NetworkType nettype,
55  uint64_t restoreHeight,
56  const std::string &addressString,
57  const std::string &viewKeyString,
58  const std::string &spendKeyString = "",
59  uint64_t kdf_rounds = 1) override;
60  // next two methods are deprecated - use the above version which allow setting of a password
61  virtual Wallet * recoveryWallet(const std::string &path, const std::string &mnemonic, NetworkType nettype, uint64_t restoreHeight) override;
62  // deprecated: use createWalletFromKeys(..., password, ...) instead
63  virtual Wallet * createWalletFromKeys(const std::string &path,
64  const std::string &language,
65  NetworkType nettype,
66  uint64_t restoreHeight,
67  const std::string &addressString,
68  const std::string &viewKeyString,
69  const std::string &spendKeyString = "") override;
70  virtual Wallet * createWalletFromDevice(const std::string &path,
71  const std::string &password,
72  NetworkType nettype,
73  const std::string &deviceName,
74  uint64_t restoreHeight = 0,
75  const std::string &subaddressLookahead = "",
76  uint64_t kdf_rounds = 1,
77  WalletListener * listener = nullptr) override;
78  virtual bool closeWallet(Wallet *wallet, bool store = true) override;
79  bool walletExists(const std::string &path) override;
80  bool verifyWalletPassword(const std::string &keys_file_name, const std::string &password, bool no_spend_key, uint64_t kdf_rounds = 1) const override;
81  bool queryWalletDevice(Wallet::Device& device_type, const std::string &keys_file_name, const std::string &password, uint64_t kdf_rounds = 1) const override;
82  std::vector<std::string> findWallets(const std::string &path) override;
83  std::string errorString() const override;
84  void setDaemonAddress(const std::string &address) override;
85  bool connected(uint32_t *version = NULL) override;
86  uint64_t blockchainHeight() override;
88  uint64_t networkDifficulty() override;
89  double miningHashRate() override;
90  uint64_t blockTarget() override;
91  bool isMining() override;
92  bool startMining(const std::string &address, uint32_t threads = 1, bool background_mining = false, bool ignore_battery = true) override;
93  bool stopMining() override;
94  std::string resolveOpenAlias(const std::string &address, bool &dnssec_valid) const override;
95  bool setProxy(const std::string &address) override;
96 
97 private:
99  friend struct WalletManagerFactory;
102 };
103 
104 } // namespace
bool setProxy(const std::string &address) override
sets proxy address, empty string to disable
Definition: wallet_manager.cpp:383
Definition: http.h:39
Wallet * createWallet(const std::string &path, const std::string &password, const std::string &language, NetworkType nettype, uint64_t kdf_rounds=1) override
Creates new wallet.
Definition: wallet_manager.cpp:57
Device
Definition: wallet2_api.h:430
std::string errorString() const override
returns verbose error string regarding last error;
Definition: wallet_manager.cpp:229
::std::string string
Definition: gtest-port.h:1097
bool verifyWalletPassword(const std::string &keys_file_name, const std::string &password, bool no_spend_key, uint64_t kdf_rounds=1) const override
verifyWalletPassword - check if the given filename is the wallet
Definition: wallet_manager.cpp:184
bool connected(uint32_t *version=NULL) override
returns whether the daemon can be reached, and its version number
Definition: wallet_manager.cpp:239
uint64_t networkDifficulty() override
returns current network difficulty
Definition: wallet_manager.cpp:274
net::http::client m_http_client
Definition: wallet_manager.h:100
Interface for wallet operations.
Definition: wallet2_api.h:428
Definition: address_book.cpp:40
virtual Wallet * createWalletFromKeys(const std::string &path, const std::string &password, const std::string &language, NetworkType nettype, uint64_t restoreHeight, const std::string &addressString, const std::string &viewKeyString, const std::string &spendKeyString="", uint64_t kdf_rounds=1) override
recovers existing wallet using keys. Creates a view only wallet if spend key is omitted ...
Definition: wallet_manager.cpp:112
double miningHashRate() override
returns current mining hash rate (0 if not mining)
Definition: wallet_manager.cpp:284
uint64_t blockchainTargetHeight() override
returns current blockchain target height
Definition: wallet_manager.cpp:264
WalletManager - provides functions to manage wallets.
Definition: wallet2_api.h:1148
virtual bool closeWallet(Wallet *wallet, bool store=true) override
Closes wallet. In case operation succeeded, wallet object deleted. in case operation failed...
Definition: wallet_manager.cpp:159
unsigned int uint32_t
Definition: stdint.h:126
bool walletExists(const std::string &path) override
TODO: delme walletExists - check if the given filename is the wallet.
Definition: wallet_manager.cpp:173
bool stopMining() override
stops mining
Definition: wallet_manager.cpp:332
bool isMining() override
returns true iff mining
Definition: wallet_manager.cpp:307
std::string resolveOpenAlias(const std::string &address, bool &dnssec_valid) const override
resolves an OpenAlias address to a monero address
Definition: wallet_manager.cpp:342
unsigned __int64 uint64_t
Definition: stdint.h:136
WalletManagerImpl()
Definition: wallet_manager.cpp:52
Definition: wallet2_api.h:347
virtual Wallet * createWalletFromDevice(const std::string &path, const std::string &password, NetworkType nettype, const std::string &deviceName, uint64_t restoreHeight=0, const std::string &subaddressLookahead="", uint64_t kdf_rounds=1, WalletListener *listener=nullptr) override
creates wallet using hardware device.
Definition: wallet_manager.cpp:130
NetworkType
Definition: wallet2_api.h:46
Definition: wallet.py:1
version
Supported socks variants.
Definition: socks.h:57
void setDaemonAddress(const std::string &address) override
set the daemon address (hostname and port)
Definition: wallet_manager.cpp:234
Definition: wallet2_api.h:1400
std::string m_errorString
Definition: wallet_manager.h:101
bool queryWalletDevice(Wallet::Device &device_type, const std::string &keys_file_name, const std::string &password, uint64_t kdf_rounds=1) const override
determine the key storage for the specified wallet file
Definition: wallet_manager.cpp:189
Definition: wallet_manager.h:38
uint64_t blockTarget() override
returns current block target
Definition: wallet_manager.cpp:297
virtual Wallet * recoveryWallet(const std::string &path, const std::string &password, const std::string &mnemonic, NetworkType nettype, uint64_t restoreHeight, uint64_t kdf_rounds=1, const std::string &seed_offset={}) override
recovers existing wallet using mnemonic (electrum seed)
Definition: wallet_manager.cpp:96
uint32_t address
Definition: getifaddr.c:269
std::vector< std::string > findWallets(const std::string &path) override
findWallets - searches for the wallet files by given path name recursively
Definition: wallet_manager.cpp:197
Wallet * openWallet(const std::string &path, const std::string &password, NetworkType nettype, uint64_t kdf_rounds=1, WalletListener *listener=nullptr) override
Opens existing wallet.
Definition: wallet_manager.cpp:65
bool startMining(const std::string &address, uint32_t threads=1, bool background_mining=false, bool ignore_battery=true) override
starts mining with the set number of threads
Definition: wallet_manager.cpp:317
uint64_t blockchainHeight() override
returns current blockchain height
Definition: wallet_manager.cpp:254