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

Browse source
This commit is contained in:
Oran Juice 2014-10-19 01:08:21 +05:30
parent 031ca23ce9
commit 70971be96b
No known key found for this signature in database
GPG key ID: 71C5AF46CCB28124
2 changed files with 40 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
src/wallet/wallet2.cpp
View file

@ -447,10 +447,10 @@ bool wallet2::clear()
}
/*!
* 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.
* \brief 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)
{
@ -502,9 +502,9 @@ namespace
}
/*!
* Load wallet information from wallet file.
* @param keys_file_name Name of wallet file
* @param password Password of wallet file
* \brief 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)
{
@ -544,13 +544,13 @@ void wallet2::load_keys(const std::string& keys_file_name, const std::string& pa
}
/*!
* 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
* \brief 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)
@ -580,6 +580,11 @@ crypto::secret_key wallet2::generate(const std::string& wallet_, const std::stri
return retval;
}
/*!
* \brief Rewrites to the wallet file for wallet upgrade (doesn't generate key, assumes it's already there)
* \param wallet_name Name of wallet file (should exist)
* \param password Password for wallet file
*/
void wallet2::rewrite(const std::string& wallet_name, const std::string& password)
{
prepare_file_names(wallet_name);

28
src/wallet/wallet2.h
View file

@ -133,9 +133,23 @@ namespace tools
END_SERIALIZE()
};
/*!
* \brief 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 generate(const std::string& wallet, const std::string& password,
const crypto::secret_key& recovery_param = crypto::secret_key(), bool recover = false,
bool two_random = false);
/*!
* \brief Rewrites to the wallet file for wallet upgrade (doesn't generate key, assumes it's already there)
* \param wallet_name Name of wallet file (should exist)
* \param password Password for wallet file
*/
void rewrite(const std::string& wallet_name, const std::string& password);
void load(const std::string& wallet, const std::string& password);
void store();
@ -211,16 +225,16 @@ namespace tools
static std::string address_from_txt_record(const std::string& s);
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.
* \brief 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);
/*!
* Load wallet information from wallet file.
* @param keys_file_name Name of wallet file
* @param password Password of wallet file
* \brief 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 process_new_transaction(const cryptonote::transaction& tx, uint64_t height);