|
Monero C++ Library
|
#include <monero_wallet.h>
Public Member Functions | |
| ~monero_wallet () | |
| uint64_t | get_height () const |
| uint64_t | get_restore_height () const |
| void | set_restore_height (uint64_t restore_height) |
| uint64_t | get_daemon_height () const |
| uint64_t | get_daemon_max_peer_height () const |
| void | set_daemon_connection (const string &uri, const string &username="", const string &password="") |
| void | set_daemon_connection (const monero_rpc_connection &connection) |
| shared_ptr< monero_rpc_connection > | get_daemon_connection () const |
| bool | is_connected () const |
| bool | is_daemon_synced () const |
| bool | is_daemon_trusted () const |
| bool | is_synced () const |
| string | get_path () const |
| monero_network_type | get_network_type () const |
| string | get_seed () const |
| string | get_mnemonic () const |
| string | get_language () const |
| vector< string > | get_languages () const |
| string | get_public_view_key () const |
| string | get_private_view_key () const |
| string | get_public_spend_key () const |
| string | get_private_spend_key () const |
| string | get_primary_address () const |
| string | get_address (const uint32_t account_idx, const uint32_t subaddress_idx) const |
| monero_subaddress | get_address_index (const string &address) const |
| monero_integrated_address | get_integrated_address (const string &standard_address="", const string &payment_id="") const |
| monero_integrated_address | decode_integrated_address (const string &integrated_address) const |
| void | add_listener (monero_wallet_listener &listener) |
| void | remove_listener (monero_wallet_listener &listener) |
| set< monero_wallet_listener * > | get_listeners () |
| monero_sync_result | sync () |
| monero_sync_result | sync (monero_sync_listener &listener) |
| monero_sync_result | sync (uint64_t start_height) |
| monero_sync_result | sync (uint64_t start_height, monero_sync_listener &listener) |
| void | start_syncing () |
| void | stop_syncing () |
| void | rescan_spent () |
| void | rescan_blockchain () |
| uint64_t | get_balance () const |
| uint64_t | get_balance (uint32_t account_idx) const |
| uint64_t | get_balance (uint32_t account_idx, uint32_t subaddress_idx) const |
| uint64_t | get_unlocked_balance () const |
| uint64_t | get_unlocked_balance (uint32_t account_idx) const |
| uint64_t | get_unlocked_balance (uint32_t account_idx, uint32_t subaddress_idx) const |
| vector< monero_account > | get_accounts () const |
| vector< monero_account > | get_accounts (bool include_subaddresses) const |
| vector< monero_account > | get_accounts (const string &tag) const |
| vector< monero_account > | get_accounts (bool include_subaddresses, const string &tag) const |
| monero_account | get_account (uint32_t account_idx) const |
| monero_account | get_account (const uint32_t account_idx, bool include_subaddresses) const |
| monero_account | create_account (const string &label="") |
| vector< monero_subaddress > | get_subaddresses (const uint32_t account_idx) const |
| vector< monero_subaddress > | get_subaddresses (const uint32_t account_idx, const vector< uint32_t > &subaddress_indices) const |
| monero_subaddress | getSubaddress (const uint32_t account_idx, const uint32_t subaddress_idx) const |
| monero_subaddress | create_subaddress (uint32_t account_idx, const string &label="") |
| vector< shared_ptr< monero_tx_wallet > > | get_txs () const |
| vector< shared_ptr< monero_tx_wallet > > | get_txs (const monero_tx_query &request) const |
| vector< shared_ptr< monero_transfer > > | get_transfers (const monero_transfer_query &request) const |
| vector< shared_ptr< monero_output_wallet > > | get_outputs (const monero_output_query &request) const |
| string | get_outputs_hex () const |
| int | import_outputs_hex (const string &outputs_hex) |
| vector< shared_ptr< monero_key_image > > | get_key_images () const |
| shared_ptr< monero_key_image_import_result > | import_key_images (const vector< shared_ptr< monero_key_image >> &key_images) |
| monero_tx_set | create_tx (monero_send_request &request) |
| monero_tx_set | create_tx (uint32_t account_index, string address, uint64_t amount) |
| monero_tx_set | create_tx (int account_index, string address, uint64_t amount, monero_send_priority priority) |
| monero_tx_set | create_txs (monero_send_request &request) |
| string | relay_tx (const string &tx_metadata) |
| string | relay_tx (const monero_tx_wallet &tx) |
| vector< string > | relay_txs (const vector< string > &tx_metadatas) |
| vector< string > | relay_txs (const vector< shared_ptr< monero_tx_wallet >> &txs) |
| monero_tx_set | send (const monero_send_request &request) |
| monero_tx_set | send (uint32_t account_index, string address, uint64_t amount) |
| monero_tx_set | send (uint32_t account_index, string address, uint64_t amount, monero_send_priority priority) |
| monero_tx_set | send_split (const monero_send_request &request) |
| vector< monero_tx_set > | sweep_unlocked (const monero_send_request &request) |
| monero_tx_set | sweep_output (const monero_send_request &request) |
| monero_tx_set | sweep_dust (bool do_not_relay=false) |
| string | sign (const string &msg) const |
| bool | verify (const string &msg, const string &address, const string &signature) const |
| string | get_tx_key (const string &tx_id) const |
| shared_ptr< monero_check_tx > | check_tx_key (const string &tx_id, const string &txKey, const string &address) const |
| string | get_tx_proof (const string &tx_id, const string &address, const string &message) const |
| shared_ptr< monero_check_tx > | check_tx_proof (const string &tx_id, const string &address, const string &message, const string &signature) const |
| string | get_spend_proof (const string &tx_id, const string &message) const |
| bool | check_spend_proof (const string &tx_id, const string &message, const string &signature) const |
| string | get_reserve_proof_wallet (const string &message) const |
| string | get_reserve_proof_account (uint32_t account_idx, uint64_t amount, const string &message) const |
| shared_ptr< monero_check_reserve > | check_reserve_proof (const string &address, const string &message, const string &signature) const |
| string | get_tx_note (const string &tx_id) const |
| vector< string > | get_tx_notes (const vector< string > &tx_ids) const |
| void | set_tx_note (const string &tx_id, const string ¬e) |
| void | set_tx_notes (const vector< string > &tx_ids, const vector< string > ¬es) |
| string | create_payment_uri (const monero_send_request &request) const |
| shared_ptr< monero_send_request > | parse_payment_uri (const string &uri) const |
| string | get_attribute (const string &key) const |
| void | set_attribute (const string &key, const string &val) |
| void | start_mining (boost::optional< uint64_t > num_threads, boost::optional< bool > background_mining, boost::optional< bool > ignore_battery) |
| void | stop_mining () |
| uint64_t | wait_for_next_block () |
| bool | is_multisig_import_needed () const |
| monero_multisig_info | get_multisig_info () |
| string | prepare_multisig () |
| monero_multisig_init_result | make_multisig (const vector< string > &multisig_hexes, int threshold, const string &password) |
| string | finalize_multisig (const vector< string > &multisig_hexes, const string &password) |
| monero_multisig_init_result | exchange_multisig_keys (const vector< string > &mutisig_hexes, const string &password) |
| string | get_multisig_hex () |
| int | import_multisig_hex (const vector< string > &multisig_hexes) |
| monero_multisig_sign_result | sign_multisig_tx_hex (const string &multisig_tx_hex) |
| vector< string > | submit_multisig_tx_hex (const string &signed_multisig_tx_hex) |
| void | save () |
| void | move_to (string path, string password) |
| void | close (bool save=false) |
Static Public Member Functions | |
| static bool | wallet_exists (const string &path) |
| static monero_wallet * | open_wallet (const string &path, const string &password, const monero_network_type network_type) |
| static monero_wallet * | create_wallet_random (const string &path, const string &password) |
| static monero_wallet * | create_wallet_random (const string &path, const string &password, const monero_network_type network_type, const monero_rpc_connection &daemon_connection, const string &language) |
| static monero_wallet * | create_wallet_from_mnemonic (const string &path, const string &password, const monero_network_type network_type, const string &mnemonic) |
| static monero_wallet * | create_wallet_from_mnemonic (const string &path, const string &password, const monero_network_type network_type, const string &mnemonic, const monero_rpc_connection &daemon_connection, uint64_t restore_height) |
| static monero_wallet * | create_wallet_from_keys (const string &path, const string &password, const monero_network_type network_type, const string &address, const string &view_key, const string &spend_key) |
| static monero_wallet * | create_wallet_from_keys (const string &path, const string &password, const monero_network_type network_type, const string &address, const string &view_key, const string &spend_key, const monero_rpc_connection &daemon_connection, uint64_t restore_height) |
| static monero_wallet * | create_wallet_from_keys (const string &path, const string &password, const monero_network_type network_type, const string &address, const string &view_key, const string &spend_key, const monero_rpc_connection &daemon_connection, uint64_t restore_height, const string &language) |
Friends | |
| struct | wallet2_listener |
Monero wallet interface.
| monero::monero_wallet::~monero_wallet | ( | ) |
Deconstruct the wallet.
| void monero::monero_wallet::add_listener | ( | monero_wallet_listener & | listener | ) |
Register a listener receive wallet notifications.
| listener | is the listener to receive wallet notifications |
| shared_ptr< monero_check_reserve > monero::monero_wallet::check_reserve_proof | ( | const string & | address, |
| const string & | message, | ||
| const string & | signature | ||
| ) | const |
Proves a wallet has a disposable reserve using a signature.
| address | is the public wallet address |
| message | is a message included with the signature to further authenticate the proof (optional) |
| signature | is the reserve proof signature to check |
| bool monero::monero_wallet::check_spend_proof | ( | const string & | tx_id, |
| const string & | message, | ||
| const string & | signature | ||
| ) | const |
Prove a spend using a signature. Unlike proving a transaction, it does not require the destination public address.
| tx_id | specifies the transaction to prove |
| message | is a message included with the signature to further authenticate the proof (optional) |
| signature | is the transaction signature to confirm |
| shared_ptr< monero_check_tx > monero::monero_wallet::check_tx_key | ( | const string & | tx_id, |
| const string & | txKey, | ||
| const string & | address | ||
| ) | const |
Check a transaction in the blockchain with its secret key.
| tx_id | specifies the transaction to check |
| txKey | is the transaction's secret key |
| address | is the destination public address of the transaction |
| shared_ptr< monero_check_tx > monero::monero_wallet::check_tx_proof | ( | const string & | tx_id, |
| const string & | address, | ||
| const string & | message, | ||
| const string & | signature | ||
| ) | const |
Prove a transaction by checking its signature.
| tx_id | specifies the transaction to prove |
| address | is the destination public address of the transaction |
| message | is a message included with the signature to further authenticate the proof (optional) |
| signature | is the transaction signature to confirm |
| void monero::monero_wallet::close | ( | bool | save = false | ) |
Optionally save then close the wallet.
| save | specifies if the wallet should be saved before being closed (default false) |
| monero_account monero::monero_wallet::create_account | ( | const string & | label = "" | ) |
Create a new account with a label for the first subaddress.
| label | specifies the label for the account's first subaddress (optional) |
| string monero::monero_wallet::create_payment_uri | ( | const monero_send_request & | request | ) | const |
Get all address book entries.
| entryIndices | are indices of the entries to get |
| address | is the entry address |
| description | is the entry description (optional) |
| address | is the entry address |
| description | is the entry description (optional) |
| payment_id | is the entry paymet id (optional) |
| entryIdx | is the index of the entry to deleteTag accounts. |
| tag | is the tag to apply to the specified accounts |
| accountIndices | are the indices of the accounts to tagUntag acconts. |
| accountIndices | are the indices of the accounts to untagReturn all account tags. |
| tag | is the tag to set a description for |
| label | is the label to set for the tagCreates a payment URI from a send configuration. |
| request | specifies configuration for a potential tx |
| monero_subaddress monero::monero_wallet::create_subaddress | ( | uint32_t | account_idx, |
| const string & | label = "" |
||
| ) |
Create a subaddress within an account.
| account_idx | specifies the index of the account to create the subaddress within |
| label | specifies the the label for the subaddress (defaults to empty string) |
| monero_tx_set monero::monero_wallet::create_tx | ( | monero_send_request & | request | ) |
Get new key images from the last imported outputs.
| request | configures the transaction to create |
| monero_tx_set monero::monero_wallet::create_tx | ( | uint32_t | account_index, |
| string | address, | ||
| uint64_t | amount | ||
| ) |
Create a transaction to transfers funds from this wallet to a destination address. The transaction may be relayed later.
| accountIndex | is the index of the account to withdraw funds from |
| address | is the destination address to send funds to |
| amount | is the amount being sent |
| monero_tx_set monero::monero_wallet::create_tx | ( | int | account_index, |
| string | address, | ||
| uint64_t | amount, | ||
| monero_send_priority | priority | ||
| ) |
Create a transaction to transfers funds from this wallet to a destination address. The transaction may be relayed later.
| accountIndex | is the index of the account to withdraw funds from |
| address | is the destination address to send funds to |
| amount | is the amount being sent |
| priority | is the send priority (default normal) |
| monero_tx_set monero::monero_wallet::create_txs | ( | monero_send_request & | request | ) |
Create one or more transactions to transfer funds from this wallet according to the given request. The transactions may later be relayed.
| request | configures the transactions to create |
|
static |
Create a wallet from an address, view key, and spend key.
| path | is the path to create the wallet |
| password | is the password encrypt the wallet |
| network_type | is the wallet's network type |
| address | is the address of the wallet to construct |
| view_key | is the view key of the wallet to construct |
| spend_key | is the spend key of the wallet to construct |
| daemon_connection | is connection information to a daemon (default = an unconnected wallet) |
| restore_height | is the block height to restore (i.e. scan the chain) from (default = 0) |
| language | is the wallet and mnemonic's language (default = "English") |
|
static |
Create a wallet from an existing mnemonic phrase.
| path | is the path to create the wallet |
| password | is the password encrypt the wallet |
| network_type | is the wallet's network type |
| mnemonic | is the mnemonic of the wallet to construct |
| daemon_connection | is connection information to a daemon (default = an unconnected wallet) |
| restore_height | is the block height to restore (i.e. scan the chain) from (default = 0) |
|
static |
Create a new wallet with a randomly generated seed.
| path | is the path to create the wallet |
| password | is the password encrypt the wallet |
| network_type | is the wallet's network type (default = monero_network_type.MAINNET) |
| daemon_connection | is connection information to a daemon (default = an unconnected wallet) |
| language | is the wallet and mnemonic's language (default = "English") |
| monero_integrated_address monero::monero_wallet::decode_integrated_address | ( | const string & | integrated_address | ) | const |
Decode an integrated address to get its standard address and payment id.
| integrated_address | is an integrated address to decode |
| monero_multisig_init_result monero::monero_wallet::exchange_multisig_keys | ( | const vector< string > & | mutisig_hexes, |
| const string & | password | ||
| ) |
Exchange multisig hex with participants in a M/N multisig wallet.
This process must be repeated with participants exactly N-M times.
| multisig_hexes | are multisig hex from each participant |
| password | is the wallet's password // TODO monero core: redundant? wallet is created with password |
| string monero::monero_wallet::finalize_multisig | ( | const vector< string > & | multisig_hexes, |
| const string & | password | ||
| ) |
Finalize a N-1/N multisig wallet.
TODO monero core: this is a special case of exchangeMultisigKeys() for N-1/N multisig. use that as the last step instead and remove this? that would further generalize the process
| multisig_hexes | are multisig hex from each participant |
| password | is the wallet's password // TODO monero core: redundant? wallet is created with password |
| monero_account monero::monero_wallet::get_account | ( | uint32_t | account_idx | ) | const |
Get an account without subaddress information.
| account_idx | specifies the account to get |
| monero_account monero::monero_wallet::get_account | ( | const uint32_t | account_idx, |
| bool | include_subaddresses | ||
| ) | const |
Get an account.
| account_idx | specifies the account to get |
| include_subaddresses | specifies if subaddresses should be included |
| vector< monero_account > monero::monero_wallet::get_accounts | ( | ) | const |
Get all accounts.
| vector< monero_account > monero::monero_wallet::get_accounts | ( | bool | include_subaddresses | ) | const |
Get all accounts.
| include_subaddresses | specifies if subaddresses should be included |
| vector< monero_account > monero::monero_wallet::get_accounts | ( | const string & | tag | ) | const |
Get accounts with a given tag.
| tag | is the tag for filtering accounts, all accounts if null |
| vector< monero_account > monero::monero_wallet::get_accounts | ( | bool | include_subaddresses, |
| const string & | tag | ||
| ) | const |
Get accounts with a given tag.
| include_subaddresses | specifies if subaddresses should be included |
| tag | is the tag for filtering accounts, all accounts if null |
| string monero::monero_wallet::get_address | ( | const uint32_t | account_idx, |
| const uint32_t | subaddress_idx | ||
| ) | const |
Get the address of a specific subaddress.
| account_idx | specifies the account index of the address's subaddress |
| subaddress_idx | specifies the subaddress index within the account |
| monero_subaddress monero::monero_wallet::get_address_index | ( | const string & | address | ) | const |
Get the account and subaddress index of the given address.
| address | is the address to get the account and subaddress index from |
| exception | if address is not a wallet address |
| string monero::monero_wallet::get_attribute | ( | const string & | key | ) | const |
Get an attribute.
| key | is the attribute to get the value of |
| uint64_t monero::monero_wallet::get_balance | ( | ) | const |
Indicates if importing multisig data is needed for returning a correct balance.
| uint64_t monero::monero_wallet::get_balance | ( | uint32_t | account_idx | ) | const |
Get an account's balance.
| account_idx | is the index of the account to get the balance of |
| uint64_t monero::monero_wallet::get_balance | ( | uint32_t | account_idx, |
| uint32_t | subaddress_idx | ||
| ) | const |
Get a subaddress's balance.
| account_idx | is the index of the subaddress's account to get the balance of |
| subaddress_idx | is the index of the subaddress to get the balance of |
| shared_ptr< monero_rpc_connection > monero::monero_wallet::get_daemon_connection | ( | ) | const |
Get the wallet's daemon connection.
| uint64_t monero::monero_wallet::get_daemon_height | ( | ) | const |
Get the height that the wallet's daemon is synced to.
| uint64_t monero::monero_wallet::get_daemon_max_peer_height | ( | ) | const |
Get the maximum height of the peers the wallet's daemon is connected to.
| uint64_t monero::monero_wallet::get_height | ( | ) | const |
Get the height of the last block processed by the wallet (its index + 1).
| monero_integrated_address monero::monero_wallet::get_integrated_address | ( | const string & | standard_address = "", |
| const string & | payment_id = "" |
||
| ) | const |
Get an integrated address from a standard address and a payment id.
| standard_address | is the integrated addresse's standard address (defaults to wallet's primary address) |
| payment_id | is the integrated addresse's payment id (defaults to randomly generating new payment id) |
| vector< shared_ptr< monero_key_image > > monero::monero_wallet::get_key_images | ( | ) | const |
Get all signed key images.
| string monero::monero_wallet::get_language | ( | ) | const |
Get the language of the wallet's mnemonic phrase.
| vector< string > monero::monero_wallet::get_languages | ( | ) | const |
Get a list of available languages for the wallet's mnemonic phrase.
| set< monero_wallet_listener * > monero::monero_wallet::get_listeners | ( | ) |
Get the listeners registered with the wallet.
| string monero::monero_wallet::get_mnemonic | ( | ) | const |
Get the wallet's mnemonic phrase derived from the seed.
| mnemonic | is assigned the wallet's mnemonic phrase |
| string monero::monero_wallet::get_multisig_hex | ( | ) |
Export this wallet's multisig info as hex for other participants.
| monero_multisig_info monero::monero_wallet::get_multisig_info | ( | ) |
Get multisig info about this wallet.
| monero_network_type monero::monero_wallet::get_network_type | ( | ) | const |
Get the wallet's network type (mainnet, testnet, or stagenet).
| vector< shared_ptr< monero_output_wallet > > monero::monero_wallet::get_outputs | ( | const monero_output_query & | request | ) | const |
Get outputs created from previous transactions that belong to the wallet (i.e. that the wallet can spend one time). Outputs are part of transactions which are stored in blocks on the blockchain.
Results can be configured by passing a monero_output_query. Outputs must meet every criteria defined in the request in order to be returned. All filtering is optional and no filtering is applied when not defined.
| request | specifies request options (optional) |
| string monero::monero_wallet::get_outputs_hex | ( | ) | const |
Export all outputs in hex format.
| string monero::monero_wallet::get_path | ( | ) | const |
Get the path of this wallet's file on disk.
| string monero::monero_wallet::get_primary_address | ( | ) | const |
Get the wallet's primary address.
| string monero::monero_wallet::get_private_spend_key | ( | ) | const |
Get the wallet's private spend key.
| string monero::monero_wallet::get_private_view_key | ( | ) | const |
Get the wallet's private view key.
| string monero::monero_wallet::get_public_spend_key | ( | ) | const |
Get the wallet's public spend key.
| string monero::monero_wallet::get_public_view_key | ( | ) | const |
Get the wallet's public view key.
| string monero::monero_wallet::get_reserve_proof_account | ( | uint32_t | account_idx, |
| uint64_t | amount, | ||
| const string & | message | ||
| ) | const |
Generate a signature to prove an available amount in an account.
| account_idx | specifies the account to prove ownership of the amount |
| amount | is the minimum amount to prove as available in the account |
| message | is a message to include with the signature to further authenticate the proof (optional) |
| string monero::monero_wallet::get_reserve_proof_wallet | ( | const string & | message | ) | const |
Generate a signature to prove the entire balance of the wallet.
| message | is a message included with the signature to further authenticate the proof (optional) |
| uint64_t monero::monero_wallet::get_restore_height | ( | ) | const |
Get the height of the first block that the wallet scans.
| string monero::monero_wallet::get_seed | ( | ) | const |
Get the wallet's seed.
| string monero::monero_wallet::get_spend_proof | ( | const string & | tx_id, |
| const string & | message | ||
| ) | const |
Generate a signature to prove a spend. Unlike proving a transaction, it does not require the destination public address.
| tx_id | specifies the transaction to prove |
| tx_id | specifies the transaction to prove |
| message | is a message to include with the signature to further authenticate the proof (optional) |
| vector< monero_subaddress > monero::monero_wallet::get_subaddresses | ( | const uint32_t | account_idx | ) | const |
Get all subaddresses in an account.
| account_idx | specifies the account to get subaddresses within |
| vector< monero_subaddress > monero::monero_wallet::get_subaddresses | ( | const uint32_t | account_idx, |
| const vector< uint32_t > & | subaddress_indices | ||
| ) | const |
Get subaddresses in an account.
| account_idx | specifies the account to get subaddresses within |
| subaddress_indices | are specific subaddresses to get (optional) |
| vector< shared_ptr< monero_transfer > > monero::monero_wallet::get_transfers | ( | const monero_transfer_query & | request | ) | const |
Get all incoming and outgoing transfers to and from this wallet. An outgoing transfer represents a total amount sent from one or more subaddresses within an account to individual destination addresses, each with their own amount. An incoming transfer represents a total amount received into a subaddress within an account. Transfers belong to transactions which are stored on the blockchain.
| account_idx | is the index of the account to get transfers from |
| account_idx | is the index of the account to get transfers from |
| subaddress_idx | is the index of the subaddress to get transfers from |
Query results can be filtered by passing in a monero_transfer_query. Transfers must meet every criteria defined in the request in order to be returned. All filtering is optional and no filtering is applied when not defined.
| request | filters query results (optional) |
| string monero::monero_wallet::get_tx_key | ( | const string & | tx_id | ) | const |
Get a transaction's secret key from its id.
| tx_id | is the transaction's id |
| string monero::monero_wallet::get_tx_note | ( | const string & | tx_id | ) | const |
Get a transaction note.
| tx_id | specifies the transaction to get the note of |
| vector< string > monero::monero_wallet::get_tx_notes | ( | const vector< string > & | tx_ids | ) | const |
Get notes for multiple transactions.
| tx_ids | identify the transactions to get notes for @preturns notes for the transactions |
| string monero::monero_wallet::get_tx_proof | ( | const string & | tx_id, |
| const string & | address, | ||
| const string & | message | ||
| ) | const |
Get a transaction signature to prove it.
| tx_id | specifies the transaction to prove |
| address | is the destination public address of the transaction |
| tx_id | specifies the transaction to prove |
| address | is the destination public address of the transaction |
| message | is a message to include with the signature to further authenticate the proof (optional) |
| vector< shared_ptr< monero_tx_wallet > > monero::monero_wallet::get_txs | ( | ) | const |
Get a wallet transaction by id.
| tx_id | is an id of a transaction to get |
| vector< shared_ptr< monero_tx_wallet > > monero::monero_wallet::get_txs | ( | const monero_tx_query & | request | ) | const |
Get wallet transactions by id.
| tx_ids | are ids of transactions to get |
Query results can be filtered by passing in a transaction request. Transactions must meet every criteria defined in the request in order to be returned. All filtering is optional and no filtering is applied when not defined.
| request | filters query results (optional) |
| uint64_t monero::monero_wallet::get_unlocked_balance | ( | ) | const |
Get the wallet's unlocked balance.
| uint64_t monero::monero_wallet::get_unlocked_balance | ( | uint32_t | account_idx | ) | const |
Get an account's unlocked balance.
| account_idx | is the index of the account to get the unlocked balance of |
| uint64_t monero::monero_wallet::get_unlocked_balance | ( | uint32_t | account_idx, |
| uint32_t | subaddress_idx | ||
| ) | const |
Get a subaddress's unlocked balance.
| account_idx | is the index of the subaddress's account to get the unlocked balance of |
| subaddress_idx | is the index of the subaddress to get the unlocked balance of |
| monero_subaddress monero::monero_wallet::getSubaddress | ( | const uint32_t | account_idx, |
| const uint32_t | subaddress_idx | ||
| ) | const |
Get a subaddress.
| account_idx | specifies the index of the subaddress's account |
| subaddress_idx | specifies index of the subaddress within the account |
| shared_ptr< monero_key_image_import_result > monero::monero_wallet::import_key_images | ( | const vector< shared_ptr< monero_key_image >> & | key_images | ) |
Import signed key images and verify their spent status.
| key_images | are key images to import and verify (requires hex and signature) |
| int monero::monero_wallet::import_multisig_hex | ( | const vector< string > & | multisig_hexes | ) |
Import multisig info as hex from other participants.
Note: If the daemon is not trusted, this method will not automatically update the spent status after importing peer multisig hex. In that case, the
| multisig_hexes | are multisig hex from each participant |
| int monero::monero_wallet::import_outputs_hex | ( | const string & | outputs_hex | ) |
Import outputs in hex format.
| outputs_hex | are outputs in hex format |
| bool monero::monero_wallet::is_connected | ( | ) | const |
Indicates if the wallet is connected a daemon.
| bool monero::monero_wallet::is_daemon_synced | ( | ) | const |
Indicates if the wallet's daemon is synced with the network.
| bool monero::monero_wallet::is_daemon_trusted | ( | ) | const |
Indicates if the daemon is trusted or untrusted.
| bool monero::monero_wallet::is_multisig_import_needed | ( | ) | const |
Indicates if importing multisig data is needed for returning a correct balance.
| bool monero::monero_wallet::is_synced | ( | ) | const |
Indicates if the wallet is synced with the daemon.
| monero_multisig_init_result monero::monero_wallet::make_multisig | ( | const vector< string > & | multisig_hexes, |
| int | threshold, | ||
| const string & | password | ||
| ) |
Make this wallet multisig by importing multisig hex from participants.
| multisig_hexes | are multisig hex from each participant |
| threshold | is the number of signatures needed to sign transfers @password is the wallet password |
| void monero::monero_wallet::move_to | ( | string | path, |
| string | password | ||
| ) |
Move the wallet from its current path to the given path.
| path | is the new wallet's path |
| password | is the new wallet's password |
|
static |
Open an existing wallet.
| path | is the path to the wallet file to open |
| password | is the password of the wallet file to open |
| network_type | is the wallet's network type |
| shared_ptr< monero_send_request > monero::monero_wallet::parse_payment_uri | ( | const string & | uri | ) | const |
Parses a payment URI to a send request.
| uri | is the payment uri to parse |
| string monero::monero_wallet::prepare_multisig | ( | ) |
Get multisig info as hex to share with participants to begin creating a multisig wallet.
| string monero::monero_wallet::relay_tx | ( | const string & | tx_metadata | ) |
Relay a transaction previously created without relaying.
| txMetadata | is transaction metadata previously created without relaying |
| string monero::monero_wallet::relay_tx | ( | const monero_tx_wallet & | tx | ) |
Relay a previously created transaction.
| tx | is the transaction to relay |
| vector< string > monero::monero_wallet::relay_txs | ( | const vector< string > & | tx_metadatas | ) |
Relay transactions previously created without relaying.
| tx_metadatas | are transaction metadata previously created without relaying |
| vector< string > monero::monero_wallet::relay_txs | ( | const vector< shared_ptr< monero_tx_wallet >> & | txs | ) |
Relay previously created transactions.
| txs | are the transactions to relay |
| void monero::monero_wallet::remove_listener | ( | monero_wallet_listener & | listener | ) |
Unregister a listener to receive wallet notifications.
| listener | is the listener to unregister |
| void monero::monero_wallet::rescan_blockchain | ( | ) |
Rescan the blockchain from scratch, losing any information which cannot be recovered from the blockchain itself.
WARNING: This method discards local wallet data like destination addresses, tx secret keys, tx notes, etc.
| void monero::monero_wallet::rescan_spent | ( | ) |
Rescan the blockchain for spent outputs.
Note: this can only be called with a trusted daemon.
Example use case: peer multisig hex is import when connected to an untrusted daemon, so the wallet will not rescan spent outputs. Then the wallet connects to a trusted daemon. This method should be manually invoked to rescan outputs.
| void monero::monero_wallet::save | ( | ) |
Save the wallet at its current path.
| monero_tx_set monero::monero_wallet::send | ( | const monero_send_request & | request | ) |
Create and relay a transaction to transfer funds from this wallet according to the given request.
| request | configures the transaction |
| monero_tx_set monero::monero_wallet::send | ( | uint32_t | account_index, |
| string | address, | ||
| uint64_t | amount | ||
| ) |
Create and relay a transaction to transfers funds from this wallet to a destination address.
| account_index | is the index of the account to withdraw funds from |
| address | is the destination address to send funds to |
| amount | is the amount being sent |
| monero_tx_set monero::monero_wallet::send | ( | uint32_t | account_index, |
| string | address, | ||
| uint64_t | amount, | ||
| monero_send_priority | priority | ||
| ) |
Create and relay a transaction to transfers funds from this wallet to a destination address.
| account_index | is the index of the account to withdraw funds from |
| address | is the destination address to send funds to |
| amount | is the amount being sent |
| priority | is the send priority (default normal) |
| monero_tx_set monero::monero_wallet::send_split | ( | const monero_send_request & | request | ) |
Create one or more transactions which transfer funds from this wallet to one or more destinations depending on the given configuration.
| request | configures the transaction |
| void monero::monero_wallet::set_attribute | ( | const string & | key, |
| const string & | val | ||
| ) |
Set an arbitrary attribute.
| key | is the attribute key |
| val | is the attribute value |
| void monero::monero_wallet::set_daemon_connection | ( | const string & | uri, |
| const string & | username = "", |
||
| const string & | password = "" |
||
| ) |
Set the wallet's daemon connection.
| uri | is the daemon's URI |
| username | is the username to authenticate with the daemon (optional) |
| password | is the password to authenticate with the daemon (optional) |
| void monero::monero_wallet::set_daemon_connection | ( | const monero_rpc_connection & | connection | ) |
Set the wallet's daemon connection.
| connection | is the connection to set |
| void monero::monero_wallet::set_restore_height | ( | uint64_t | restore_height | ) |
Set the height of the first block that the wallet scans.
| restore_height | is the height of the first block that the wallet scans |
| void monero::monero_wallet::set_tx_note | ( | const string & | tx_id, |
| const string & | note | ||
| ) |
Set a note for a specific transaction.
| tx_id | specifies the transaction |
| note | specifies the note |
| void monero::monero_wallet::set_tx_notes | ( | const vector< string > & | tx_ids, |
| const vector< string > & | notes | ||
| ) |
Set notes for multiple transactions.
| tx_ids | specify the transactions to set notes for |
| notes | are the notes to set for the transactions |
| string monero::monero_wallet::sign | ( | const string & | msg | ) | const |
Sign a message.
| msg | is the message to sign |
| monero_multisig_sign_result monero::monero_wallet::sign_multisig_tx_hex | ( | const string & | multisig_tx_hex | ) |
Sign previously created multisig transactions as represented by hex.
| multisig_tx_hex | is the hex shared among the multisig transactions when they were created |
| void monero::monero_wallet::start_mining | ( | boost::optional< uint64_t > | num_threads, |
| boost::optional< bool > | background_mining, | ||
| boost::optional< bool > | ignore_battery | ||
| ) |
Start mining.
| num_threads | is the number of threads created for mining (optional) |
| background_mining | specifies if mining should occur in the background (optional) |
| ignore_battery | specifies if the battery should be ignored for mining (optional) |
| void monero::monero_wallet::start_syncing | ( | ) |
Start an asynchronous thread to continuously synchronize the wallet with the daemon.
Start automatic syncing as its own thread.
| void monero::monero_wallet::stop_mining | ( | ) |
Stop mining.
| void monero::monero_wallet::stop_syncing | ( | ) |
Stop the asynchronous thread to continuously synchronize the wallet with the daemon.
Stop automatic syncing as its own thread.
| vector< string > monero::monero_wallet::submit_multisig_tx_hex | ( | const string & | signed_multisig_tx_hex | ) |
Submit signed multisig transactions as represented by a hex string.
| signed_multisig_tx_hex | is the signed multisig hex returned from signMultisigTxs() |
| monero_tx_set monero::monero_wallet::sweep_dust | ( | bool | do_not_relay = false | ) |
Sweep an output with a given key image.
| address | is the destination address to send to |
| key_image | is the key image hex of the output to sweep |
| address | is the destination address to send to |
| key_image | is the key image hex of the output to sweep |
| priority | is the transaction priority (optional) |
| account_idx | is the index of the account |
| subaddress_idx | is the index of the subaddress |
| address | is the address to sweep the subaddress's funds to |
| account_idx | is the index of the account |
| address | is the address to sweep the account's funds to |
| address | is the address to sweep the wallet's funds to |
| request | is the sweep configuration |
NOTE: Dust only exists pre RCT, so this method will return "no dust to sweep" on new wallets.
| do_not_relay | specifies if the resulting transaction should not be relayed (defaults to false i.e. relayed) |
| monero_tx_set monero::monero_wallet::sweep_output | ( | const monero_send_request & | request | ) |
Sweep an output with a given key image.
| request | configures the sweep transaction |
| vector< monero_tx_set > monero::monero_wallet::sweep_unlocked | ( | const monero_send_request & | request | ) |
Create and relay one or more transactions which transfer funds from this wallet to one or more destination.
| account_index | is the index of the account to draw funds from |
| address | is the destination address to send funds to |
| sendAmount | is the amount being sent |
| account_index | is the index of the account to draw funds from |
| address | is the destination address to send funds to |
| sendAmount | is the amount being sent |
| priority | is the send priority (default normal) |
| request | is the sweep configuration |
| monero_sync_result monero::monero_wallet::sync | ( | ) |
Synchronize the wallet with the daemon as a one-time synchronous process.
| monero_sync_result monero::monero_wallet::sync | ( | monero_sync_listener & | listener | ) |
Synchronize the wallet with the daemon as a one-time synchronous process.
| listener | is invoked as sync progress is made |
| monero_sync_result monero::monero_wallet::sync | ( | uint64_t | start_height | ) |
Synchronize the wallet with the daemon as a one-time synchronous process.
| start_height | is the start height to sync from (ignored if less than last processed block) |
| monero_sync_result monero::monero_wallet::sync | ( | uint64_t | start_height, |
| monero_sync_listener & | listener | ||
| ) |
Synchronizes the wallet with the blockchain.
| start_height | is the start height to sync from (ignored if less than last processed block) |
| listener | is invoked as sync progress is made |
| bool monero::monero_wallet::verify | ( | const string & | msg, |
| const string & | address, | ||
| const string & | signature | ||
| ) | const |
Verify a signature on a message.
| msg | is the signed message |
| address | is the signing address |
| signature | is the signature |
| uint64_t monero::monero_wallet::wait_for_next_block | ( | ) |
Wait for the next block to be added to the chain.
|
static |
Indicates if a wallet exists at the given path.
| path | is the path to check for a wallet |
1.8.15