mirror of
https://github.com/monero-project/monero.git
synced 2024-11-18 00:37:43 +00:00
wallet2: Update function parameter documentation
This completes and fixes various parameters docs
This commit is contained in:
Leon Klingele
parent
a69c713f8e
commit
80d2f8007c
2 changed files with 41 additions and 31 deletions
|
|
@ -2699,6 +2699,7 @@ bool wallet2::verify_password(const epee::wipeable_string& password) const
|
|||
* \param keys_file_name Keys file to verify password for
|
||||
* \param password Password to verify
|
||||
* \param no_spend_key If set = only verify view keys, otherwise also spend keys
|
||||
* \param hwdev The hardware device to use
|
||||
* \return true if password is correct
|
||||
*
|
||||
* for verification only
|
||||
|
|
@ -2749,9 +2750,10 @@ bool wallet2::verify_password(const std::string& keys_file_name, const epee::wip
|
|||
|
||||
/*!
|
||||
* \brief Generates a wallet or restores one.
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param multisig_data The multisig restore info and keys
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param multisig_data The multisig restore info and keys
|
||||
* \param create_address_file Whether to create an address file
|
||||
*/
|
||||
void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
|
||||
const std::string& multisig_data, bool create_address_file)
|
||||
|
|
@ -2844,12 +2846,13 @@ void wallet2::generate(const std::string& wallet_, const epee::wipeable_string&
|
|||
|
||||
/*!
|
||||
* \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
|
||||
* \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
|
||||
* \param create_address_file Whether to create an address file
|
||||
* \return The secret key of the generated wallet
|
||||
*/
|
||||
crypto::secret_key wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
|
||||
const crypto::secret_key& recovery_param, bool recover, bool two_random, bool create_address_file)
|
||||
|
|
@ -2945,9 +2948,11 @@ crypto::secret_key wallet2::generate(const std::string& wallet_, const epee::wip
|
|||
|
||||
/*!
|
||||
* \brief Creates a watch only wallet from a public address and a view secret key.
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param viewkey view secret key
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param account_public_address The account's public address
|
||||
* \param viewkey view secret key
|
||||
* \param create_address_file Whether to create an address file
|
||||
*/
|
||||
void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
|
||||
const cryptonote::account_public_address &account_public_address,
|
||||
|
|
@ -2994,10 +2999,12 @@ void wallet2::generate(const std::string& wallet_, const epee::wipeable_string&
|
|||
|
||||
/*!
|
||||
* \brief Creates a wallet from a public address and a spend/view secret key pair.
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param spendkey spend secret key
|
||||
* \param viewkey view secret key
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param account_public_address The account's public address
|
||||
* \param spendkey spend secret key
|
||||
* \param viewkey view secret key
|
||||
* \param create_address_file Whether to create an address file
|
||||
*/
|
||||
void wallet2::generate(const std::string& wallet_, const epee::wipeable_string& password,
|
||||
const cryptonote::account_public_address &account_public_address,
|
||||
|
|
@ -3444,8 +3451,9 @@ void wallet2::rewrite(const std::string& wallet_name, const epee::wipeable_strin
|
|||
}
|
||||
/*!
|
||||
* \brief Writes to a file named based on the normal wallet (doesn't generate key, assumes it's already there)
|
||||
* \param wallet_name Base name of wallet file
|
||||
* \param password Password for wallet file
|
||||
* \param wallet_name Base name of wallet file
|
||||
* \param password Password for wallet file
|
||||
* \param new_keys_filename [OUT] Name of new keys file
|
||||
*/
|
||||
void wallet2::write_watch_only_wallet(const std::string& wallet_name, const epee::wipeable_string& password, std::string &new_keys_filename)
|
||||
{
|
||||
|
|
|
|||
|
|
@ -472,21 +472,23 @@ namespace tools
|
|||
bool two_random = false, bool create_address_file = false);
|
||||
/*!
|
||||
* \brief Creates a wallet from a public address and a spend/view secret key pair.
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param viewkey view secret key
|
||||
* \param spendkey spend secret key
|
||||
* \param create_address_file Whether to create an address file
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param account_public_address The account's public address
|
||||
* \param spendkey spend secret key
|
||||
* \param viewkey view secret key
|
||||
* \param create_address_file Whether to create an address file
|
||||
*/
|
||||
void generate(const std::string& wallet, const epee::wipeable_string& password,
|
||||
const cryptonote::account_public_address &account_public_address,
|
||||
const crypto::secret_key& spendkey, const crypto::secret_key& viewkey, bool create_address_file = false);
|
||||
/*!
|
||||
* \brief Creates a watch only wallet from a public address and a view secret key.
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param viewkey view secret key
|
||||
* \param create_address_file Whether to create an address file
|
||||
* \param wallet_ Name of wallet file
|
||||
* \param password Password of wallet file
|
||||
* \param account_public_address The account's public address
|
||||
* \param viewkey view secret key
|
||||
* \param create_address_file Whether to create an address file
|
||||
*/
|
||||
void generate(const std::string& wallet, const epee::wipeable_string& password,
|
||||
const cryptonote::account_public_address &account_public_address,
|
||||
|
|
@ -556,9 +558,9 @@ namespace tools
|
|||
void load(const std::string& wallet, const epee::wipeable_string& password);
|
||||
void store();
|
||||
/*!
|
||||
* \brief store_to - stores wallet to another file(s), deleting old ones
|
||||
* \param path - path to the wallet file (keys and address filenames will be generated based on this filename)
|
||||
* \param password - password to protect new wallet (TODO: probably better save the password in the wallet object?)
|
||||
* \brief store_to Stores wallet to another file(s), deleting old ones
|
||||
* \param path Path to the wallet file (keys and address filenames will be generated based on this filename)
|
||||
* \param password Password to protect new wallet (TODO: probably better save the password in the wallet object?)
|
||||
*/
|
||||
void store_to(const std::string &path, const epee::wipeable_string &password);
|
||||
|
||||
|
|
@ -942,7 +944,7 @@ namespace tools
|
|||
/*!
|
||||
* \brief Set the label of the given tag.
|
||||
* \param tag Tag's name (which must be non-empty).
|
||||
* \param label Tag's description.
|
||||
* \param description Tag's description.
|
||||
*/
|
||||
void set_account_tag_description(const std::string& tag, const std::string& description);
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue