monero/src/wallet/api/wallet.h

233 lines
12 KiB
C
Raw Normal View History

2018-01-07 07:05:16 +02:00
// Copyright (c) 2014-2018, 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.
//
// Parts of this file are originally copyright (c) 2012-2013 The Cryptonote developers
#ifndef WALLET_IMPL_H
#define WALLET_IMPL_H
#include "wallet/api/wallet2_api.h"
#include "wallet/wallet2.h"
#include <string>
#include <boost/thread/mutex.hpp>
#include <boost/thread/thread.hpp>
#include <boost/thread/condition_variable.hpp>
namespace Monero {
2016-04-20 13:17:27 +03:00
class TransactionHistoryImpl;
class PendingTransactionImpl;
2017-01-08 14:17:09 +02:00
class UnsignedTransactionImpl;
2016-12-12 01:42:46 +02:00
class AddressBookImpl;
2017-02-19 04:42:10 +02:00
class SubaddressImpl;
class SubaddressAccountImpl;
2016-05-05 22:24:00 +03:00
struct Wallet2CallbackImpl;
class WalletImpl : public Wallet
{
public:
WalletImpl(NetworkType nettype = MAINNET);
~WalletImpl();
bool create(const std::string &path, const std::string &password,
const std::string &language);
bool createWatchOnly(const std::string &path, const std::string &password,
const std::string &language) const;
bool open(const std::string &path, const std::string &password);
bool recover(const std::string &path,const std::string &password,
const std::string &seed);
bool recoverFromKeysWithPassword(const std::string &path,
const std::string &password,
const std::string &language,
const std::string &address_string,
const std::string &viewkey_string,
const std::string &spendkey_string = "");
// following two methods are deprecated since they create passwordless wallets
// use the two equivalent methods above
bool recover(const std::string &path, const std::string &seed);
// deprecated: use recoverFromKeysWithPassword() instead
2017-01-26 22:33:36 +02:00
bool recoverFromKeys(const std::string &path,
const std::string &language,
const std::string &address_string,
const std::string &viewkey_string,
const std::string &spendkey_string = "");
bool close(bool store = true);
std::string seed() const;
std::string getSeedLanguage() const;
void setSeedLanguage(const std::string &arg);
// void setListener(Listener *) {}
int status() const;
std::string errorString() const;
bool setPassword(const std::string &password);
std::string address(uint32_t accountIndex = 0, uint32_t addressIndex = 0) const;
std::string integratedAddress(const std::string &payment_id) const;
2017-05-02 17:48:38 +03:00
std::string secretViewKey() const;
std::string publicViewKey() const;
std::string secretSpendKey() const;
std::string publicSpendKey() const;
std::string path() const;
bool store(const std::string &path);
std::string filename() const;
std::string keysFilename() const;
bool init(const std::string &daemon_address, uint64_t upper_transaction_size_limit = 0, const std::string &daemon_username = "", const std::string &daemon_password = "", bool use_ssl = false, bool lightWallet = false);
bool connectToDaemon();
ConnectionStatus connected() const;
2016-04-26 13:46:20 +03:00
void setTrustedDaemon(bool arg);
bool trustedDaemon() const;
uint64_t balance(uint32_t accountIndex = 0) const;
uint64_t unlockedBalance(uint32_t accountIndex = 0) const;
uint64_t blockChainHeight() const;
uint64_t approximateBlockChainHeight() const;
uint64_t daemonBlockChainHeight() const;
uint64_t daemonBlockChainTargetHeight() const;
bool synchronized() const;
bool refresh();
2016-07-10 17:17:23 +03:00
void refreshAsync();
void setAutoRefreshInterval(int millis);
int autoRefreshInterval() const;
void setRefreshFromBlockHeight(uint64_t refresh_from_block_height);
uint64_t getRefreshFromBlockHeight() const { return m_wallet->get_refresh_from_block_height(); };
void setRecoveringFromSeed(bool recoveringFromSeed);
bool watchOnly() const;
2017-01-12 23:10:38 +02:00
bool rescanSpent();
NetworkType nettype() const {return static_cast<NetworkType>(m_wallet->nettype());}
void hardForkInfo(uint8_t &version, uint64_t &earliest_height) const;
bool useForkRules(uint8_t version, int64_t early_blocks) const;
2017-02-19 04:42:10 +02:00
void addSubaddressAccount(const std::string& label);
size_t numSubaddressAccounts() const;
size_t numSubaddresses(uint32_t accountIndex) const;
void addSubaddress(uint32_t accountIndex, const std::string& label);
std::string getSubaddressLabel(uint32_t accountIndex, uint32_t addressIndex) const;
void setSubaddressLabel(uint32_t accountIndex, uint32_t addressIndex, const std::string &label);
PendingTransaction * createTransaction(const std::string &dst_addr, const std::string &payment_id,
2016-11-09 14:19:22 +02:00
optional<uint64_t> amount, uint32_t mixin_count,
PendingTransaction::Priority priority = PendingTransaction::Priority_Low,
uint32_t subaddr_account = 0,
std::set<uint32_t> subaddr_indices = {});
virtual PendingTransaction * createSweepUnmixableTransaction();
2017-01-08 14:17:09 +02:00
bool submitTransaction(const std::string &fileName);
virtual UnsignedTransaction * loadUnsignedTx(const std::string &unsigned_filename);
bool exportKeyImages(const std::string &filename);
bool importKeyImages(const std::string &filename);
virtual void disposeTransaction(PendingTransaction * t);
2017-02-19 04:42:10 +02:00
virtual TransactionHistory * history();
virtual AddressBook * addressBook();
virtual Subaddress * subaddress();
virtual SubaddressAccount * subaddressAccount();
2016-05-05 22:24:00 +03:00
virtual void setListener(WalletListener * l);
virtual uint32_t defaultMixin() const;
virtual void setDefaultMixin(uint32_t arg);
2016-11-05 22:53:45 +02:00
virtual bool setUserNote(const std::string &txid, const std::string &note);
virtual std::string getUserNote(const std::string &txid) const;
2016-11-06 20:04:59 +02:00
virtual std::string getTxKey(const std::string &txid) const;
virtual bool checkTxKey(const std::string &txid, std::string tx_key, const std::string &address, uint64_t &received, bool &in_pool, uint64_t &confirmations);
virtual std::string getTxProof(const std::string &txid, const std::string &address, const std::string &message) const;
virtual bool checkTxProof(const std::string &txid, const std::string &address, const std::string &message, const std::string &signature, bool &good, uint64_t &received, bool &in_pool, uint64_t &confirmations);
2017-08-28 18:34:17 +03:00
virtual std::string getSpendProof(const std::string &txid, const std::string &message) const;
virtual bool checkSpendProof(const std::string &txid, const std::string &message, const std::string &signature, bool &good) const;
2017-12-28 15:50:10 +02:00
virtual std::string getReserveProof(bool all, uint32_t account_index, uint64_t amount, const std::string &message) const;
virtual bool checkReserveProof(const std::string &address, const std::string &message, const std::string &signature, bool &good, uint64_t &total, uint64_t &spent) const;
virtual std::string signMessage(const std::string &message);
virtual bool verifySignedMessage(const std::string &message, const std::string &address, const std::string &signature) const;
virtual void startRefresh();
virtual void pauseRefresh();
2017-01-09 00:53:24 +02:00
virtual bool parse_uri(const std::string &uri, std::string &address, std::string &payment_id, uint64_t &amount, std::string &tx_description, std::string &recipient_name, std::vector<std::string> &unknown_parameters, std::string &error);
2017-08-09 13:38:29 +03:00
virtual std::string getDefaultDataDir() const;
virtual bool lightWalletLogin(bool &isNewWallet) const;
virtual bool lightWalletImportWalletRequest(std::string &payment_id, uint64_t &fee, bool &new_request, bool &request_fulfilled, std::string &payment_address, std::string &status);
2018-03-04 15:32:35 +02:00
virtual bool blackballOutputs(const std::vector<std::string> &pubkeys, bool add);
virtual bool unblackballOutput(const std::string &pubkey);
2018-03-05 17:04:59 +02:00
virtual bool getRing(const std::string &key_image, std::vector<uint64_t> &ring) const;
virtual bool getRings(const std::string &txid, std::vector<std::pair<std::string, std::vector<uint64_t>>> &rings) const;
2018-03-05 17:04:59 +02:00
virtual bool setRing(const std::string &key_image, const std::vector<uint64_t> &ring, bool relative);
virtual void segregatePreForkOutputs(bool segregate);
virtual void segregationHeight(uint64_t height);
virtual void keyReuseMitigation2(bool mitigation);
private:
void clearStatus() const;
2016-07-10 17:17:23 +03:00
void refreshThreadFunc();
void doRefresh();
bool daemonSynced() const;
2016-07-10 17:17:23 +03:00
void stopRefresh();
bool isNewWallet() const;
bool doInit(const std::string &daemon_address, uint64_t upper_transaction_size_limit = 0, bool ssl = false);
private:
2016-04-20 13:17:27 +03:00
friend class PendingTransactionImpl;
2017-01-08 14:17:09 +02:00
friend class UnsignedTransactionImpl;
2016-04-20 13:17:27 +03:00
friend class TransactionHistoryImpl;
friend struct Wallet2CallbackImpl;
2016-12-12 01:42:46 +02:00
friend class AddressBookImpl;
2017-02-19 04:42:10 +02:00
friend class SubaddressImpl;
friend class SubaddressAccountImpl;
2016-04-20 13:17:27 +03:00
tools::wallet2 * m_wallet;
mutable std::atomic<int> m_status;
mutable std::string m_errorString;
std::string m_password;
TransactionHistoryImpl * m_history;
2016-04-26 13:46:20 +03:00
bool m_trustedDaemon;
2016-05-05 22:24:00 +03:00
Wallet2CallbackImpl * m_wallet2Callback;
2016-12-12 01:42:46 +02:00
AddressBookImpl * m_addressBook;
2017-02-19 04:42:10 +02:00
SubaddressImpl * m_subaddress;
SubaddressAccountImpl * m_subaddressAccount;
2016-07-10 17:17:23 +03:00
// multi-threaded refresh stuff
std::atomic<bool> m_refreshEnabled;
std::atomic<bool> m_refreshThreadDone;
std::atomic<int> m_refreshIntervalMillis;
// synchronizing refresh loop;
boost::mutex m_refreshMutex;
// synchronizing sync and async refresh
boost::mutex m_refreshMutex2;
boost::condition_variable m_refreshCV;
boost::thread m_refreshThread;
// flag indicating wallet is recovering from seed
// so it shouldn't be considered as new and pull blocks (slow-refresh)
// instead of pulling hashes (fast-refresh)
std::atomic<bool> m_recoveringFromSeed;
std::atomic<bool> m_synchronized;
std::atomic<bool> m_rebuildWalletCache;
// cache connection status to avoid unnecessary RPC calls
mutable std::atomic<bool> m_is_connected;
boost::optional<epee::net_utils::http::login> m_daemon_login{};
};
} // namespace
namespace Bitmonero = Monero;
#endif