Monero C++ Library
Public Member Functions | Static Public Member Functions | Friends | List of all members
monero::monero_wallet Class Reference

#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 &note)
 
void set_tx_notes (const vector< string > &tx_ids, const vector< string > &notes)
 
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
 

Detailed Description

Monero wallet interface.

Constructor & Destructor Documentation

◆ ~monero_wallet()

monero::monero_wallet::~monero_wallet ( )

Deconstruct the wallet.

Member Function Documentation

◆ add_listener()

void monero::monero_wallet::add_listener ( monero_wallet_listener &  listener)

Register a listener receive wallet notifications.

Parameters
listeneris the listener to receive wallet notifications

◆ check_reserve_proof()

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.

Parameters
addressis the public wallet address
messageis a message included with the signature to further authenticate the proof (optional)
signatureis the reserve proof signature to check
Returns
the result of checking the signature proof

◆ check_spend_proof()

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.

Parameters
tx_idspecifies the transaction to prove
messageis a message included with the signature to further authenticate the proof (optional)
signatureis the transaction signature to confirm
Returns
true if the signature is good, false otherwise

◆ check_tx_key()

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.

Parameters
tx_idspecifies the transaction to check
txKeyis the transaction's secret key
addressis the destination public address of the transaction
Returns
the result of the check

◆ check_tx_proof()

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.

Parameters
tx_idspecifies the transaction to prove
addressis the destination public address of the transaction
messageis a message included with the signature to further authenticate the proof (optional)
signatureis the transaction signature to confirm
Returns
the result of the check

◆ close()

void monero::monero_wallet::close ( bool  save = false)

Optionally save then close the wallet.

Parameters
savespecifies if the wallet should be saved before being closed (default false)

◆ create_account()

monero_account monero::monero_wallet::create_account ( const string &  label = "")

Create a new account with a label for the first subaddress.

Parameters
labelspecifies the label for the account's first subaddress (optional)
Returns
the created account

◆ create_payment_uri()

string monero::monero_wallet::create_payment_uri ( const monero_send_request &  request) const

Get all address book entries.

Returns
the address book entriesGet address book entries.
Parameters
entryIndicesare indices of the entries to get
Returns
the address book entriesAdd an address book entry.
Parameters
addressis the entry address
descriptionis the entry description (optional)
Returns
the index of the added entryAdd an address book entry.
Parameters
addressis the entry address
descriptionis the entry description (optional)
payment_idis the entry paymet id (optional)
Returns
the index of the added entryDelete an address book entry.
Parameters
entryIdxis the index of the entry to deleteTag accounts.
tagis the tag to apply to the specified accounts
accountIndicesare the indices of the accounts to tagUntag acconts.
accountIndicesare the indices of the accounts to untagReturn all account tags.
Returns
the wallet's account tagsSets a human-readable description for a tag.
Parameters
tagis the tag to set a description for
labelis the label to set for the tagCreates a payment URI from a send configuration.
requestspecifies configuration for a potential tx
Returns
is the payment uri

◆ create_subaddress()

monero_subaddress monero::monero_wallet::create_subaddress ( uint32_t  account_idx,
const string &  label = "" 
)

Create a subaddress within an account.

Parameters
account_idxspecifies the index of the account to create the subaddress within
labelspecifies the the label for the subaddress (defaults to empty string)
Returns
the created subaddress

◆ create_tx() [1/3]

monero_tx_set monero::monero_wallet::create_tx ( monero_send_request &  request)

Get new key images from the last imported outputs.

Returns
the key images from the last imported outputsCreate a transaction to transfer funds from this wallet according to the given request. The transaction may be relayed later.
Parameters
requestconfigures the transaction to create
Returns
a tx set for the requested transaction if possible

◆ create_tx() [2/3]

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.

Parameters
accountIndexis the index of the account to withdraw funds from
addressis the destination address to send funds to
amountis the amount being sent
Returns
a tx set for the requested transaction if possible

◆ create_tx() [3/3]

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.

Parameters
accountIndexis the index of the account to withdraw funds from
addressis the destination address to send funds to
amountis the amount being sent
priorityis the send priority (default normal)
Returns
a tx set for the requested transaction if possible

◆ create_txs()

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.

Parameters
requestconfigures the transactions to create
Returns
a tx set for the requested transactions if possible

◆ create_wallet_from_keys()

monero_wallet * monero::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

Create a wallet from an address, view key, and spend key.

Parameters
pathis the path to create the wallet
passwordis the password encrypt the wallet
network_typeis the wallet's network type
addressis the address of the wallet to construct
view_keyis the view key of the wallet to construct
spend_keyis the spend key of the wallet to construct
daemon_connectionis connection information to a daemon (default = an unconnected wallet)
restore_heightis the block height to restore (i.e. scan the chain) from (default = 0)
languageis the wallet and mnemonic's language (default = "English")

◆ create_wallet_from_mnemonic()

monero_wallet * monero::monero_wallet::create_wallet_from_mnemonic ( const string &  path,
const string &  password,
const monero_network_type  network_type,
const string &  mnemonic 
)
static

Create a wallet from an existing mnemonic phrase.

Parameters
pathis the path to create the wallet
passwordis the password encrypt the wallet
network_typeis the wallet's network type
mnemonicis the mnemonic of the wallet to construct
daemon_connectionis connection information to a daemon (default = an unconnected wallet)
restore_heightis the block height to restore (i.e. scan the chain) from (default = 0)

◆ create_wallet_random()

monero_wallet * monero::monero_wallet::create_wallet_random ( const string &  path,
const string &  password 
)
static

Create a new wallet with a randomly generated seed.

Parameters
pathis the path to create the wallet
passwordis the password encrypt the wallet
network_typeis the wallet's network type (default = monero_network_type.MAINNET)
daemon_connectionis connection information to a daemon (default = an unconnected wallet)
languageis the wallet and mnemonic's language (default = "English")

◆ decode_integrated_address()

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.

Parameters
integrated_addressis an integrated address to decode
Returns
the decoded integrated address including standard address and payment id

◆ exchange_multisig_keys()

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.

Parameters
multisig_hexesare multisig hex from each participant
passwordis the wallet's password // TODO monero core: redundant? wallet is created with password
Returns
the result which has the multisig's address xor this wallet's multisig hex to share with participants iff not done

◆ finalize_multisig()

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

Parameters
multisig_hexesare multisig hex from each participant
passwordis the wallet's password // TODO monero core: redundant? wallet is created with password
Returns
the multisig wallet's address

◆ get_account() [1/2]

monero_account monero::monero_wallet::get_account ( uint32_t  account_idx) const

Get an account without subaddress information.

Parameters
account_idxspecifies the account to get
Returns
the retrieved account

◆ get_account() [2/2]

monero_account monero::monero_wallet::get_account ( const uint32_t  account_idx,
bool  include_subaddresses 
) const

Get an account.

Parameters
account_idxspecifies the account to get
include_subaddressesspecifies if subaddresses should be included
Returns
the retrieved account

◆ get_accounts() [1/4]

vector< monero_account > monero::monero_wallet::get_accounts ( ) const

Get all accounts.

Returns
List<monero_account> are all accounts within the wallet

◆ get_accounts() [2/4]

vector< monero_account > monero::monero_wallet::get_accounts ( bool  include_subaddresses) const

Get all accounts.

Parameters
include_subaddressesspecifies if subaddresses should be included
Returns
List<monero_account> are all accounts

◆ get_accounts() [3/4]

vector< monero_account > monero::monero_wallet::get_accounts ( const string &  tag) const

Get accounts with a given tag.

Parameters
tagis the tag for filtering accounts, all accounts if null
Returns
List<monero_account> are all accounts for the wallet with the given tag

◆ get_accounts() [4/4]

vector< monero_account > monero::monero_wallet::get_accounts ( bool  include_subaddresses,
const string &  tag 
) const

Get accounts with a given tag.

Parameters
include_subaddressesspecifies if subaddresses should be included
tagis the tag for filtering accounts, all accounts if null
Returns
List<monero_account> are all accounts for the wallet with the given tag

◆ get_address()

string monero::monero_wallet::get_address ( const uint32_t  account_idx,
const uint32_t  subaddress_idx 
) const

Get the address of a specific subaddress.

Parameters
account_idxspecifies the account index of the address's subaddress
subaddress_idxspecifies the subaddress index within the account
Returns
the receive address of the specified subaddress

◆ get_address_index()

monero_subaddress monero::monero_wallet::get_address_index ( const string &  address) const

Get the account and subaddress index of the given address.

Parameters
addressis the address to get the account and subaddress index from
Returns
the account and subaddress indices
Exceptions
exceptionif address is not a wallet address

◆ get_attribute()

string monero::monero_wallet::get_attribute ( const string &  key) const

Get an attribute.

Parameters
keyis the attribute to get the value of
Returns
the attribute's value

◆ get_balance() [1/3]

uint64_t monero::monero_wallet::get_balance ( ) const

Indicates if importing multisig data is needed for returning a correct balance.

Returns
true if importing multisig data is needed for returning a correct balance, false otherwiseGet the wallet's balance.
the wallet's balance

◆ get_balance() [2/3]

uint64_t monero::monero_wallet::get_balance ( uint32_t  account_idx) const

Get an account's balance.

Parameters
account_idxis the index of the account to get the balance of
Returns
the account's balance

◆ get_balance() [3/3]

uint64_t monero::monero_wallet::get_balance ( uint32_t  account_idx,
uint32_t  subaddress_idx 
) const

Get a subaddress's balance.

Parameters
account_idxis the index of the subaddress's account to get the balance of
subaddress_idxis the index of the subaddress to get the balance of
Returns
the subaddress's balance

◆ get_daemon_connection()

shared_ptr< monero_rpc_connection > monero::monero_wallet::get_daemon_connection ( ) const

Get the wallet's daemon connection.

Returns
the wallet's daemon connection

◆ get_daemon_height()

uint64_t monero::monero_wallet::get_daemon_height ( ) const

Get the height that the wallet's daemon is synced to.

Returns
the height that the wallet's daemon is synced to

◆ get_daemon_max_peer_height()

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.

Returns
the maximum height of the peers the wallet's daemon is connected to

◆ get_height()

uint64_t monero::monero_wallet::get_height ( ) const

Get the height of the last block processed by the wallet (its index + 1).

Returns
the height of the last block processed by the wallet

◆ get_integrated_address()

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.

Parameters
standard_addressis the integrated addresse's standard address (defaults to wallet's primary address)
payment_idis the integrated addresse's payment id (defaults to randomly generating new payment id)
Returns
the integrated address

◆ get_key_images()

vector< shared_ptr< monero_key_image > > monero::monero_wallet::get_key_images ( ) const

Get all signed key images.

Returns
the wallet's signed key images

◆ get_language()

string monero::monero_wallet::get_language ( ) const

Get the language of the wallet's mnemonic phrase.

Returns
the language of the wallet's mnemonic phrase

◆ get_languages()

vector< string > monero::monero_wallet::get_languages ( ) const

Get a list of available languages for the wallet's mnemonic phrase.

Returns
the available languages for the wallet's mnemonic phrase

◆ get_listeners()

set< monero_wallet_listener * > monero::monero_wallet::get_listeners ( )

Get the listeners registered with the wallet.

◆ get_mnemonic()

string monero::monero_wallet::get_mnemonic ( ) const

Get the wallet's mnemonic phrase derived from the seed.

Parameters
mnemonicis assigned the wallet's mnemonic phrase

◆ get_multisig_hex()

string monero::monero_wallet::get_multisig_hex ( )

Export this wallet's multisig info as hex for other participants.

Returns
this wallet's multisig info as hex for other participants

◆ get_multisig_info()

monero_multisig_info monero::monero_wallet::get_multisig_info ( )

Get multisig info about this wallet.

Returns
multisig info about this wallet

◆ get_network_type()

monero_network_type monero::monero_wallet::get_network_type ( ) const

Get the wallet's network type (mainnet, testnet, or stagenet).

Returns
the wallet's network type

◆ get_outputs()

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.

Returns
List<monero_output_wallet> are all wallet outputsGet 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.

Parameters
requestspecifies request options (optional)
Returns
List<monero_output_wallet> are wallet outputs per the request

◆ get_outputs_hex()

string monero::monero_wallet::get_outputs_hex ( ) const

Export all outputs in hex format.

Returns
all outputs in hex format, empty string if no outputs

◆ get_path()

string monero::monero_wallet::get_path ( ) const

Get the path of this wallet's file on disk.

Returns
the path of this wallet's file on disk

◆ get_primary_address()

string monero::monero_wallet::get_primary_address ( ) const

Get the wallet's primary address.

Returns
the wallet's primary address

◆ get_private_spend_key()

string monero::monero_wallet::get_private_spend_key ( ) const

Get the wallet's private spend key.

Returns
the wallet's private spend key

◆ get_private_view_key()

string monero::monero_wallet::get_private_view_key ( ) const

Get the wallet's private view key.

Returns
the wallet's private view key

◆ get_public_spend_key()

string monero::monero_wallet::get_public_spend_key ( ) const

Get the wallet's public spend key.

Returns
the wallet's public spend key

◆ get_public_view_key()

string monero::monero_wallet::get_public_view_key ( ) const

Get the wallet's public view key.

Returns
the wallet's public view key

◆ get_reserve_proof_account()

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.

Parameters
account_idxspecifies the account to prove ownership of the amount
amountis the minimum amount to prove as available in the account
messageis a message to include with the signature to further authenticate the proof (optional)
Returns
the reserve proof signature

◆ get_reserve_proof_wallet()

string monero::monero_wallet::get_reserve_proof_wallet ( const string &  message) const

Generate a signature to prove the entire balance of the wallet.

Parameters
messageis a message included with the signature to further authenticate the proof (optional)
Returns
the reserve proof signature

◆ get_restore_height()

uint64_t monero::monero_wallet::get_restore_height ( ) const

Get the height of the first block that the wallet scans.

Returns
the height of the first block that the wallet scans

◆ get_seed()

string monero::monero_wallet::get_seed ( ) const

Get the wallet's seed.

Returns
the wallet's seed

◆ get_spend_proof()

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.

Parameters
tx_idspecifies the transaction to prove
Returns
the transaction signatureGenerate a signature to prove a spend. Unlike proving a transaction, it does not require the destination public address.
Parameters
tx_idspecifies the transaction to prove
messageis a message to include with the signature to further authenticate the proof (optional)
Returns
the transaction signature

◆ get_subaddresses() [1/2]

vector< monero_subaddress > monero::monero_wallet::get_subaddresses ( const uint32_t  account_idx) const

Get all subaddresses in an account.

Parameters
account_idxspecifies the account to get subaddresses within
Returns
List<monero_subaddress> are the retrieved subaddresses

◆ get_subaddresses() [2/2]

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.

Parameters
account_idxspecifies the account to get subaddresses within
subaddress_indicesare specific subaddresses to get (optional)
Returns
the retrieved subaddresses

◆ get_transfers()

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.

Returns
all wallet transfersGet incoming and outgoing transfers to and from an account. 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.
Parameters
account_idxis the index of the account to get transfers from
Returns
transfers to/from the accountGet incoming and outgoing transfers to and from a subaddress. 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.
Parameters
account_idxis the index of the account to get transfers from
subaddress_idxis the index of the subaddress to get transfers from
Returns
transfers to/from the subaddressGet 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.

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.

Parameters
requestfilters query results (optional)
Returns
wallet transfers per the request

◆ get_tx_key()

string monero::monero_wallet::get_tx_key ( const string &  tx_id) const

Get a transaction's secret key from its id.

Parameters
tx_idis the transaction's id
Returns
is the transaction's secret key

◆ get_tx_note()

string monero::monero_wallet::get_tx_note ( const string &  tx_id) const

Get a transaction note.

Parameters
tx_idspecifies the transaction to get the note of
Returns
the tx note

◆ get_tx_notes()

vector< string > monero::monero_wallet::get_tx_notes ( const vector< string > &  tx_ids) const

Get notes for multiple transactions.

Parameters
tx_idsidentify the transactions to get notes for @preturns notes for the transactions

◆ get_tx_proof()

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.

Parameters
tx_idspecifies the transaction to prove
addressis the destination public address of the transaction
Returns
the transaction signatureGet a transaction signature to prove it.
Parameters
tx_idspecifies the transaction to prove
addressis the destination public address of the transaction
messageis a message to include with the signature to further authenticate the proof (optional)
Returns
the transaction signature

◆ get_txs() [1/2]

vector< shared_ptr< monero_tx_wallet > > monero::monero_wallet::get_txs ( ) const

Get a wallet transaction by id.

Parameters
tx_idis an id of a transaction to get
Returns
monero_tx_wallet is the identified transactionsGet all wallet transactions. Wallet transactions contain one or more transfers that are either incoming or outgoing to the wallet.
all wallet transactions

◆ get_txs() [2/2]

vector< shared_ptr< monero_tx_wallet > > monero::monero_wallet::get_txs ( const monero_tx_query &  request) const

Get wallet transactions by id.

Parameters
tx_idsare ids of transactions to get
Returns
the identified transactionsGet wallet transactions. Wallet transactions contain one or more transfers that are either incoming or outgoing to the wallet.

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.

Parameters
requestfilters query results (optional)
Returns
wallet transactions per the request

◆ get_unlocked_balance() [1/3]

uint64_t monero::monero_wallet::get_unlocked_balance ( ) const

Get the wallet's unlocked balance.

Returns
the wallet's unlocked balance

◆ get_unlocked_balance() [2/3]

uint64_t monero::monero_wallet::get_unlocked_balance ( uint32_t  account_idx) const

Get an account's unlocked balance.

Parameters
account_idxis the index of the account to get the unlocked balance of
Returns
the account's unlocked balance

◆ get_unlocked_balance() [3/3]

uint64_t monero::monero_wallet::get_unlocked_balance ( uint32_t  account_idx,
uint32_t  subaddress_idx 
) const

Get a subaddress's unlocked balance.

Parameters
account_idxis the index of the subaddress's account to get the unlocked balance of
subaddress_idxis the index of the subaddress to get the unlocked balance of
Returns
the subaddress's balance

◆ getSubaddress()

monero_subaddress monero::monero_wallet::getSubaddress ( const uint32_t  account_idx,
const uint32_t  subaddress_idx 
) const

Get a subaddress.

Parameters
account_idxspecifies the index of the subaddress's account
subaddress_idxspecifies index of the subaddress within the account
Returns
the retrieved subaddress

◆ import_key_images()

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.

Parameters
key_imagesare key images to import and verify (requires hex and signature)
Returns
results of the import

◆ import_multisig_hex()

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

Parameters
multisig_hexesare multisig hex from each participant
Returns
the number of outputs signed with the given multisig hex

◆ import_outputs_hex()

int monero::monero_wallet::import_outputs_hex ( const string &  outputs_hex)

Import outputs in hex format.

Parameters
outputs_hexare outputs in hex format
Returns
the number of outputs imported

◆ is_connected()

bool monero::monero_wallet::is_connected ( ) const

Indicates if the wallet is connected a daemon.

Returns
true if the wallet is connected to a daemon, false otherwise

◆ is_daemon_synced()

bool monero::monero_wallet::is_daemon_synced ( ) const

Indicates if the wallet's daemon is synced with the network.

Returns
true if the daemon is synced with the network, false otherwise

◆ is_daemon_trusted()

bool monero::monero_wallet::is_daemon_trusted ( ) const

Indicates if the daemon is trusted or untrusted.

Returns
true if the daemon is trusted, false otherwise

◆ is_multisig_import_needed()

bool monero::monero_wallet::is_multisig_import_needed ( ) const

Indicates if importing multisig data is needed for returning a correct balance.

Returns
true if importing multisig data is needed for returning a correct balance, false otherwise

◆ is_synced()

bool monero::monero_wallet::is_synced ( ) const

Indicates if the wallet is synced with the daemon.

Returns
true if the wallet is synced with the daemon, false otherwise

◆ make_multisig()

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.

Parameters
multisig_hexesare multisig hex from each participant
thresholdis the number of signatures needed to sign transfers @password is the wallet password
Returns
the result which has the multisig's address xor this wallet's multisig hex to share with participants iff not N/N

◆ move_to()

void monero::monero_wallet::move_to ( string  path,
string  password 
)

Move the wallet from its current path to the given path.

Parameters
pathis the new wallet's path
passwordis the new wallet's password

◆ open_wallet()

monero_wallet * monero::monero_wallet::open_wallet ( const string &  path,
const string &  password,
const monero_network_type  network_type 
)
static

Open an existing wallet.

Parameters
pathis the path to the wallet file to open
passwordis the password of the wallet file to open
network_typeis the wallet's network type

◆ parse_payment_uri()

shared_ptr< monero_send_request > monero::monero_wallet::parse_payment_uri ( const string &  uri) const

Parses a payment URI to a send request.

Parameters
uriis the payment uri to parse
Returns
the send request parsed from the uri

◆ prepare_multisig()

string monero::monero_wallet::prepare_multisig ( )

Get multisig info as hex to share with participants to begin creating a multisig wallet.

Returns
this wallet's multisig hex to share with participants

◆ relay_tx() [1/2]

string monero::monero_wallet::relay_tx ( const string &  tx_metadata)

Relay a transaction previously created without relaying.

Parameters
txMetadatais transaction metadata previously created without relaying
Returns
string is the id of the relayed tx

◆ relay_tx() [2/2]

string monero::monero_wallet::relay_tx ( const monero_tx_wallet &  tx)

Relay a previously created transaction.

Parameters
txis the transaction to relay
Returns
the id of the relayed tx

◆ relay_txs() [1/2]

vector< string > monero::monero_wallet::relay_txs ( const vector< string > &  tx_metadatas)

Relay transactions previously created without relaying.

Parameters
tx_metadatasare transaction metadata previously created without relaying
Returns
the ids of the relayed txs

◆ relay_txs() [2/2]

vector< string > monero::monero_wallet::relay_txs ( const vector< shared_ptr< monero_tx_wallet >> &  txs)

Relay previously created transactions.

Parameters
txsare the transactions to relay
Returns
the ids of the relayed txs

◆ remove_listener()

void monero::monero_wallet::remove_listener ( monero_wallet_listener &  listener)

Unregister a listener to receive wallet notifications.

Parameters
listeneris the listener to unregister

◆ rescan_blockchain()

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.

◆ rescan_spent()

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.

◆ save()

void monero::monero_wallet::save ( )

Save the wallet at its current path.

◆ send() [1/3]

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.

Parameters
requestconfigures the transaction
Returns
a tx set with the requested transaction if possible

◆ send() [2/3]

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.

Parameters
account_indexis the index of the account to withdraw funds from
addressis the destination address to send funds to
amountis the amount being sent
Returns
a tx set with the requested transaction if possible

◆ send() [3/3]

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.

Parameters
account_indexis the index of the account to withdraw funds from
addressis the destination address to send funds to
amountis the amount being sent
priorityis the send priority (default normal)
Returns
a tx set with the requested transaction if possible

◆ send_split()

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.

Parameters
requestconfigures the transaction
Returns
a tx set with the requested transactions if possible

◆ set_attribute()

void monero::monero_wallet::set_attribute ( const string &  key,
const string &  val 
)

Set an arbitrary attribute.

Parameters
keyis the attribute key
valis the attribute value

◆ set_daemon_connection() [1/2]

void monero::monero_wallet::set_daemon_connection ( const string &  uri,
const string &  username = "",
const string &  password = "" 
)

Set the wallet's daemon connection.

Parameters
uriis the daemon's URI
usernameis the username to authenticate with the daemon (optional)
passwordis the password to authenticate with the daemon (optional)

◆ set_daemon_connection() [2/2]

void monero::monero_wallet::set_daemon_connection ( const monero_rpc_connection &  connection)

Set the wallet's daemon connection.

Parameters
connectionis the connection to set

◆ set_restore_height()

void monero::monero_wallet::set_restore_height ( uint64_t  restore_height)

Set the height of the first block that the wallet scans.

Parameters
restore_heightis the height of the first block that the wallet scans

◆ set_tx_note()

void monero::monero_wallet::set_tx_note ( const string &  tx_id,
const string &  note 
)

Set a note for a specific transaction.

Parameters
tx_idspecifies the transaction
notespecifies the note

◆ set_tx_notes()

void monero::monero_wallet::set_tx_notes ( const vector< string > &  tx_ids,
const vector< string > &  notes 
)

Set notes for multiple transactions.

Parameters
tx_idsspecify the transactions to set notes for
notesare the notes to set for the transactions

◆ sign()

string monero::monero_wallet::sign ( const string &  msg) const

Sign a message.

Parameters
msgis the message to sign
Returns
the signature

◆ sign_multisig_tx_hex()

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.

Parameters
multisig_tx_hexis the hex shared among the multisig transactions when they were created
Returns
the result of signing the multisig transactions

◆ start_mining()

void monero::monero_wallet::start_mining ( boost::optional< uint64_t >  num_threads,
boost::optional< bool >  background_mining,
boost::optional< bool >  ignore_battery 
)

Start mining.

Parameters
num_threadsis the number of threads created for mining (optional)
background_miningspecifies if mining should occur in the background (optional)
ignore_batteryspecifies if the battery should be ignored for mining (optional)

◆ start_syncing()

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.

◆ stop_mining()

void monero::monero_wallet::stop_mining ( )

Stop mining.

◆ stop_syncing()

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.

◆ submit_multisig_tx_hex()

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.

Parameters
signed_multisig_tx_hexis the signed multisig hex returned from signMultisigTxs()
Returns
the resulting transaction ids

◆ sweep_dust()

monero_tx_set monero::monero_wallet::sweep_dust ( bool  do_not_relay = false)

Sweep an output with a given key image.

Parameters
addressis the destination address to send to
key_imageis the key image hex of the output to sweep
Returns
the resulting transaction from sweeping an outputSweep an output with a given key image.
Parameters
addressis the destination address to send to
key_imageis the key image hex of the output to sweep
priorityis the transaction priority (optional)
Returns
the resulting transaction from sweeping an outputSweep a subaddress's unlocked funds to an address.
Parameters
account_idxis the index of the account
subaddress_idxis the index of the subaddress
addressis the address to sweep the subaddress's funds to
Returns
the resulting transactionsSweep an acount's unlocked funds to an address.
Parameters
account_idxis the index of the account
addressis the address to sweep the account's funds to
Returns
the resulting transactionsSweep the wallet's unlocked funds to an address.
Parameters
addressis the address to sweep the wallet's funds to
Returns
the resulting transactionsSweep all unlocked funds according to the given request.
Parameters
requestis the sweep configuration
Returns
the resulting transactionsSweep all unmixable dust outputs back to the wallet to make them easier to spend and mix.

NOTE: Dust only exists pre RCT, so this method will return "no dust to sweep" on new wallets.

Returns
the resulting transactions from sweeping dustSweep all unmixable dust outputs back to the wallet to make them easier to spend and mix.
Parameters
do_not_relayspecifies if the resulting transaction should not be relayed (defaults to false i.e. relayed)
Returns
a tx set with the requested transactions if possible

◆ sweep_output()

monero_tx_set monero::monero_wallet::sweep_output ( const monero_send_request &  request)

Sweep an output with a given key image.

Parameters
requestconfigures the sweep transaction
Returns
a tx set with the requested transaction if possible

◆ sweep_unlocked()

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.

Parameters
account_indexis the index of the account to draw funds from
addressis the destination address to send funds to
sendAmountis the amount being sent
Returns
the resulting transactionsCreate and relay one or more transactions which transfer funds from this wallet to one or more destination.
Parameters
account_indexis the index of the account to draw funds from
addressis the destination address to send funds to
sendAmountis the amount being sent
priorityis the send priority (default normal)
Returns
the resulting transactionsSweep unlocked funds according to the given request.
Parameters
requestis the sweep configuration
Returns
the tx sets with the requested transactions

◆ sync() [1/4]

monero_sync_result monero::monero_wallet::sync ( )

Synchronize the wallet with the daemon as a one-time synchronous process.

Returns
the sync result

◆ sync() [2/4]

monero_sync_result monero::monero_wallet::sync ( monero_sync_listener &  listener)

Synchronize the wallet with the daemon as a one-time synchronous process.

Parameters
listeneris invoked as sync progress is made
Returns
the sync result

◆ sync() [3/4]

monero_sync_result monero::monero_wallet::sync ( uint64_t  start_height)

Synchronize the wallet with the daemon as a one-time synchronous process.

Parameters
start_heightis the start height to sync from (ignored if less than last processed block)
Returns
the sync result

◆ sync() [4/4]

monero_sync_result monero::monero_wallet::sync ( uint64_t  start_height,
monero_sync_listener &  listener 
)

Synchronizes the wallet with the blockchain.

Parameters
start_heightis the start height to sync from (ignored if less than last processed block)
listeneris invoked as sync progress is made
Returns
the sync result

◆ verify()

bool monero::monero_wallet::verify ( const string &  msg,
const string &  address,
const string &  signature 
) const

Verify a signature on a message.

Parameters
msgis the signed message
addressis the signing address
signatureis the signature
Returns
true if the signature is good, false otherwise

◆ wait_for_next_block()

uint64_t monero::monero_wallet::wait_for_next_block ( )

Wait for the next block to be added to the chain.

Returns
the height of the next block when it is added to the chain

◆ wallet_exists()

bool monero::monero_wallet::wallet_exists ( const string &  path)
static

Indicates if a wallet exists at the given path.

Parameters
pathis the path to check for a wallet
Returns
true if a wallet exists at the given path, false otherwise

The documentation for this class was generated from the following files: