monero-project/monero
monero-project/monero
1
0
Fork 0
mirror of https://github.com/monero-project/monero.git synced 2024-11-17 16:27:39 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Doxygen comments in

Browse source
This commit is contained in:
Oran Juice 2014-10-18 23:11:05 +05:30
parent 0bd88ff256
commit 1f833dcf77
No known key found for this signature in database
GPG key ID: 71C5AF46CCB28124
2 changed files with 37 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
src/wallet/wallet2.cpp
View file

@ -104,6 +104,7 @@ bool wallet2::get_seed(std::string& electrum_words)
} }
/*! /*!
* \brief Sets the seed language * \brief Sets the seed language
* \param language Seed language to set to
*/ */
void wallet2::set_seed_language(const std::string &language) void wallet2::set_seed_language(const std::string &language)
{ {
@ -444,7 +445,13 @@ bool wallet2::clear()
m_local_bc_height = 1; m_local_bc_height = 1;
return true; return true;
} }
//----------------------------------------------------------------------------------------------------
/*!
* Stores wallet information to wallet file.
* @param keys_file_name Name of wallet file
* @param password Password of wallet file
* @return Whether it was successful.
*/
bool wallet2::store_keys(const std::string& keys_file_name, const std::string& password) bool wallet2::store_keys(const std::string& keys_file_name, const std::string& password)
{ {
std::string account_data; std::string account_data;
@ -493,7 +500,12 @@ namespace
return r && expected_pub == pub; return r && expected_pub == pub;
} }
} }
//----------------------------------------------------------------------------------------------------
/*!
* Load wallet information from wallet file.
* @param keys_file_name Name of wallet file
* @param password Password of wallet file
*/
void wallet2::load_keys(const std::string& keys_file_name, const std::string& password) void wallet2::load_keys(const std::string& keys_file_name, const std::string& password)
{ {
wallet2::keys_file_data keys_file_data; wallet2::keys_file_data keys_file_data;
@ -530,7 +542,16 @@ void wallet2::load_keys(const std::string& keys_file_name, const std::string& pa
r = r && verify_keys(keys.m_spend_secret_key, keys.m_account_address.m_spend_public_key); r = r && verify_keys(keys.m_spend_secret_key, keys.m_account_address.m_spend_public_key);
THROW_WALLET_EXCEPTION_IF(!r, error::invalid_password); THROW_WALLET_EXCEPTION_IF(!r, error::invalid_password);
} }
//----------------------------------------------------------------------------------------------------
/*!
* Generates a wallet or restores one.
* @param wallet_ Name of wallet file
* @param password Password of wallet file
* @param recovery_param If it is a restore, the recovery key
* @param recover Whether it is a restore
* @param two_random Whether it is a non-deterministic wallet
* @return The secret key of the generated wallet
*/
crypto::secret_key wallet2::generate(const std::string& wallet_, const std::string& password, const crypto::secret_key& recovery_param, bool recover, bool two_random) crypto::secret_key wallet2::generate(const std::string& wallet_, const std::string& password, const crypto::secret_key& recovery_param, bool recover, bool two_random)
{ {
clear(); clear();

15
src/wallet/wallet2.h
View file

@ -207,7 +207,18 @@ namespace tools
static std::string address_from_txt_record(const std::string& s); static std::string address_from_txt_record(const std::string& s);
private: private:
/*!
* Stores wallet information to wallet file.
* @param keys_file_name Name of wallet file
* @param password Password of wallet file
* @return Whether it was successful.
*/
bool store_keys(const std::string& keys_file_name, const std::string& password); bool store_keys(const std::string& keys_file_name, const std::string& password);
/*!
* Load wallet information from wallet file.
* @param keys_file_name Name of wallet file
* @param password Password of wallet file
*/
void load_keys(const std::string& keys_file_name, const std::string& password); void load_keys(const std::string& keys_file_name, const std::string& password);
void process_new_transaction(const cryptonote::transaction& tx, uint64_t height); void process_new_transaction(const cryptonote::transaction& tx, uint64_t height);
void process_new_blockchain_entry(const cryptonote::block& b, cryptonote::block_complete_entry& bche, crypto::hash& bl_id, uint64_t height); void process_new_blockchain_entry(const cryptonote::block& b, cryptonote::block_complete_entry& bche, crypto::hash& bl_id, uint64_t height);
@ -243,8 +254,8 @@ namespace tools
i_wallet2_callback* m_callback; i_wallet2_callback* m_callback;
bool m_testnet; bool m_testnet;
std::string seed_language; std::string seed_language; /*!< Language of the mnemonics (seed). */
bool is_old_file_format; bool is_old_file_format; /*!< Whether the wallet file is of an old file format */
}; };
} }
BOOST_CLASS_VERSION(tools::wallet2, 7) BOOST_CLASS_VERSION(tools::wallet2, 7)