#include <monero_wallet.h>

Inheritance diagram for monero::monero_wallet:

Public Member Functions
virtual	~monero_wallet ()

virtual bool	is_view_only () const

virtual void	set_daemon_connection (const std::string &uri, const std::string &username="", const std::string &password="")

virtual void	set_daemon_connection (const boost::optional< monero_rpc_connection > &connection)

virtual void	set_daemon_proxy (const std::string &uri="")

virtual boost::optional< monero_rpc_connection >	get_daemon_connection () const

virtual bool	is_connected_to_daemon () const

virtual bool	is_daemon_synced () const

virtual bool	is_daemon_trusted () const

virtual bool	is_synced () const

virtual monero_version	get_version () const

virtual std::string	get_path () const

virtual monero_network_type	get_network_type () const

virtual std::string	get_seed () const

virtual std::string	get_seed_language () const

virtual std::string	get_public_view_key () const

virtual std::string	get_private_view_key () const

virtual std::string	get_public_spend_key () const

virtual std::string	get_private_spend_key () const

virtual std::string	get_primary_address () const

virtual std::string	get_address (const uint32_t account_idx, const uint32_t subaddress_idx) const

virtual monero_subaddress	get_address_index (const std::string &address) const

virtual monero_integrated_address	get_integrated_address (const std::string &standard_address="", const std::string &payment_id="") const

virtual monero_integrated_address	decode_integrated_address (const std::string &integrated_address) const

virtual uint64_t	get_height () const

virtual uint64_t	get_restore_height () const

virtual void	set_restore_height (uint64_t restore_height)

virtual uint64_t	get_daemon_height () const

virtual uint64_t	get_daemon_max_peer_height () const

virtual uint64_t	get_height_by_date (uint16_t year, uint8_t month, uint8_t day) const

virtual void	add_listener (monero_wallet_listener &listener)

virtual void	remove_listener (monero_wallet_listener &listener)

virtual std::set< monero_wallet_listener * >	get_listeners ()

virtual monero_sync_result	sync ()

virtual monero_sync_result	sync (monero_wallet_listener &listener)

virtual monero_sync_result	sync (uint64_t start_height)

virtual monero_sync_result	sync (uint64_t start_height, monero_wallet_listener &listener)

virtual void	start_syncing (uint64_t sync_period_in_ms=10000)

virtual void	stop_syncing ()

virtual void	scan_txs (const std::vector< std::string > &tx_hashes)

virtual void	rescan_spent ()

virtual void	rescan_blockchain ()

virtual uint64_t	get_balance () const

virtual uint64_t	get_balance (uint32_t account_idx) const

virtual uint64_t	get_balance (uint32_t account_idx, uint32_t subaddress_idx) const

virtual uint64_t	get_unlocked_balance () const

virtual uint64_t	get_unlocked_balance (uint32_t account_idx) const

virtual uint64_t	get_unlocked_balance (uint32_t account_idx, uint32_t subaddress_idx) const

virtual std::vector< monero_account >	get_accounts () const

virtual std::vector< monero_account >	get_accounts (bool include_subaddresses) const

virtual std::vector< monero_account >	get_accounts (const std::string &tag) const

virtual std::vector< monero_account >	get_accounts (bool include_subaddresses, const std::string &tag) const

virtual monero_account	get_account (uint32_t account_idx) const

virtual monero_account	get_account (const uint32_t account_idx, bool include_subaddresses) const

virtual monero_account	create_account (const std::string &label="")

virtual std::vector< monero_subaddress >	get_subaddresses (const uint32_t account_idx) const

virtual std::vector< monero_subaddress >	get_subaddresses (const uint32_t account_idx, const std::vector< uint32_t > &subaddress_indices) const

virtual monero_subaddress	get_subaddress (const uint32_t account_idx, const uint32_t subaddress_idx) const

virtual monero_subaddress	create_subaddress (uint32_t account_idx, const std::string &label="")

virtual void	set_subaddress_label (uint32_t account_idx, uint32_t subaddress_idx, const std::string &label="")

virtual std::vector< std::shared_ptr< monero_tx_wallet > >	get_txs () const

virtual std::vector< std::shared_ptr< monero_tx_wallet > >	get_txs (const monero_tx_query &query) const

virtual std::vector< std::shared_ptr< monero_transfer > >	get_transfers (const monero_transfer_query &query) const

virtual std::vector< std::shared_ptr< monero_output_wallet > >	get_outputs (const monero_output_query &query) const

virtual std::string	export_outputs (bool all=false) const

virtual int	import_outputs (const std::string &outputs_hex)

virtual std::vector< std::shared_ptr< monero_key_image > >	export_key_images (bool all=false) const

virtual std::shared_ptr< monero_key_image_import_result >	import_key_images (const std::vector< std::shared_ptr< monero_key_image > > &key_images)

virtual void	freeze_output (const std::string &key_image)

virtual void	thaw_output (const std::string &key_image)

virtual bool	is_output_frozen (const std::string &key_image)

virtual std::shared_ptr< monero_tx_wallet >	create_tx (const monero_tx_config &config)

virtual std::vector< std::shared_ptr< monero_tx_wallet > >	create_txs (const monero_tx_config &config)

virtual std::vector< std::shared_ptr< monero_tx_wallet > >	sweep_unlocked (const monero_tx_config &config)

virtual std::shared_ptr< monero_tx_wallet >	sweep_output (const monero_tx_config &config)

virtual std::vector< std::shared_ptr< monero_tx_wallet > >	sweep_dust (bool relay=false)

virtual std::string	relay_tx (const std::string &tx_metadata)

virtual std::string	relay_tx (const monero_tx_wallet &tx)

virtual std::vector< std::string >	relay_txs (const std::vector< std::shared_ptr< monero_tx_wallet > > &txs)

virtual std::vector< std::string >	relay_txs (const std::vector< std::string > &tx_metadatas)

virtual monero_tx_set	describe_tx_set (const monero_tx_set &tx_set)

virtual monero_tx_set	sign_txs (const std::string &unsigned_tx_hex)

virtual std::vector< std::string >	submit_txs (const std::string &signed_tx_hex)

virtual std::string	sign_message (const std::string &msg, monero_message_signature_type signature_type, uint32_t account_idx=0, uint32_t subaddress_idx=0) const

virtual monero_message_signature_result	verify_message (const std::string &msg, const std::string &address, const std::string &signature) const

virtual std::string	get_tx_key (const std::string &tx_hash) const

virtual std::shared_ptr< monero_check_tx >	check_tx_key (const std::string &tx_hash, const std::string &tx_key, const std::string &address) const

virtual std::string	get_tx_proof (const std::string &tx_hash, const std::string &address, const std::string &message) const

virtual std::shared_ptr< monero_check_tx >	check_tx_proof (const std::string &tx_hash, const std::string &address, const std::string &message, const std::string &signature) const

virtual std::string	get_spend_proof (const std::string &tx_hash, const std::string &message) const

virtual bool	check_spend_proof (const std::string &tx_hash, const std::string &message, const std::string &signature) const

virtual std::string	get_reserve_proof_wallet (const std::string &message) const

virtual std::string	get_reserve_proof_account (uint32_t account_idx, uint64_t amount, const std::string &message) const

virtual std::shared_ptr< monero_check_reserve >	check_reserve_proof (const std::string &address, const std::string &message, const std::string &signature) const

virtual std::string	get_tx_note (const std::string &tx_hash) const

virtual std::vector< std::string >	get_tx_notes (const std::vector< std::string > &tx_hashes) const

virtual void	set_tx_note (const std::string &tx_hash, const std::string &note)

virtual void	set_tx_notes (const std::vector< std::string > &tx_hashes, const std::vector< std::string > &notes)

virtual std::vector< monero_address_book_entry >	get_address_book_entries (const std::vector< uint64_t > &indices) const

virtual uint64_t	add_address_book_entry (const std::string &address, const std::string &description)

virtual void	edit_address_book_entry (uint64_t index, bool set_address, const std::string &address, bool set_description, const std::string &description)

virtual void	delete_address_book_entry (uint64_t index)

virtual std::string	get_payment_uri (const monero_tx_config &config) const

virtual std::shared_ptr< monero_tx_config >	parse_payment_uri (const std::string &uri) const

virtual bool	get_attribute (const std::string &key, std::string &value) const

virtual void	set_attribute (const std::string &key, const std::string &val)

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

virtual void	stop_mining ()

virtual uint64_t	wait_for_next_block ()

virtual bool	is_multisig_import_needed () const

virtual bool	is_multisig () const

virtual monero_multisig_info	get_multisig_info () const

virtual std::string	prepare_multisig ()

virtual std::string	make_multisig (const std::vector< std::string > &multisig_hexes, int threshold, const std::string &password)

virtual monero_multisig_init_result	exchange_multisig_keys (const std::vector< std::string > &mutisig_hexes, const std::string &password)

virtual std::string	export_multisig_hex ()

virtual int	import_multisig_hex (const std::vector< std::string > &multisig_hexes)

virtual monero_multisig_sign_result	sign_multisig_tx_hex (const std::string &multisig_tx_hex)

virtual std::vector< std::string >	submit_multisig_tx_hex (const std::string &signed_multisig_tx_hex)

virtual void	change_password (const std::string &old_password, const std::string &new_password)

virtual void	move_to (const std::string &path, const std::string &password)

virtual void	save ()

virtual void	close (bool save=false)

Detailed Description

Base wallet with default implementations.

Constructor & Destructor Documentation

◆ ~monero_wallet()

virtual monero::monero_wallet::~monero_wallet ( )

inlinevirtual

Virtual destructor.

Member Function Documentation

◆ add_address_book_entry()

virtual uint64_t monero::monero_wallet::add_address_book_entry	(	const std::string &	address,
		const std::string &	description )

inlinevirtual

Add an address book entry.

Parameters

address	is the entry address
description	is the entry description (optional)

Returns: the index of the added entry

Reimplemented in monero::monero_wallet_full.

◆ add_listener()

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

inlinevirtual

Register a listener receive wallet notifications.

Parameters

listener is the listener to receive wallet notifications

Reimplemented in monero::monero_wallet_full.

◆ change_password()

virtual void monero::monero_wallet::change_password	(	const std::string &	old_password,
		const std::string &	new_password )

inlinevirtual

Change the wallet password.

Parameters

old_password	is the wallet's old password
new_password	is the wallet's new password

Reimplemented in monero::monero_wallet_full.

◆ check_reserve_proof()

virtual std::shared_ptr< monero_check_reserve > monero::monero_wallet::check_reserve_proof	(	const std::string &	address,
		const std::string &	message,
		const std::string &	signature ) const

inlinevirtual

Proves a wallet has a disposable reserve using a signature.

Parameters

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

Returns: the result of checking the signature proof

Reimplemented in monero::monero_wallet_full.

◆ check_spend_proof()

virtual bool monero::monero_wallet::check_spend_proof	(	const std::string &	tx_hash,
		const std::string &	message,
		const std::string &	signature ) const

inlinevirtual

Prove a spend using a signature. Unlike proving a transaction, it does not require the destination public address.

Parameters

tx_hash	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

Returns: true if the signature is good, false otherwise

Reimplemented in monero::monero_wallet_full.

◆ check_tx_key()

virtual std::shared_ptr< monero_check_tx > monero::monero_wallet::check_tx_key	(	const std::string &	tx_hash,
		const std::string &	tx_key,
		const std::string &	address ) const

inlinevirtual

Check a transaction in the blockchain with its secret key.

Parameters

tx_hash	specifies the transaction to check
tx_key	is the transaction's secret key
address	is the destination public address of the transaction

Returns: the result of the check

Reimplemented in monero::monero_wallet_full.

◆ check_tx_proof()

virtual std::shared_ptr< monero_check_tx > monero::monero_wallet::check_tx_proof	(	const std::string &	tx_hash,
		const std::string &	address,
		const std::string &	message,
		const std::string &	signature ) const

inlinevirtual

Prove a transaction by checking its signature.

Parameters

tx_hash	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

Returns: the result of the check

Reimplemented in monero::monero_wallet_full.

◆ close()

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

inlinevirtual

Optionally save then close the wallet.

Parameters

save	specifies if the wallet should be saved before being closed (default false)

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ create_account()

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

inlinevirtual

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

Parameters

label specifies the label for the account's first subaddress (optional)

Returns: the created account

Reimplemented in monero::monero_wallet_full.

◆ create_subaddress()

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

inlinevirtual

Create a subaddress within an account.

Parameters

account_idx	specifies the index of the account to create the subaddress within
label	specifies the the label for the subaddress (defaults to empty std::string)

Returns: the created subaddress

Reimplemented in monero::monero_wallet_full.

◆ create_tx()

virtual std::shared_ptr< monero_tx_wallet > monero::monero_wallet::create_tx ( const monero_tx_config & config )

inlinevirtual

Create a transaction to transfer funds from this wallet.

Parameters

config configures the transaction to create

Returns: the created transaction (free memory using monero_utils::free)

◆ create_txs()

virtual std::vector< std::shared_ptr< monero_tx_wallet > > monero::monero_wallet::create_txs ( const monero_tx_config & config )

inlinevirtual

Create one or more transactions to transfer funds from this wallet.

Parameters

config configures the transactions to create

Returns: the created transactions (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ decode_integrated_address()

virtual monero_integrated_address monero::monero_wallet::decode_integrated_address ( const std::string & integrated_address ) const

inlinevirtual

Decode an integrated address to get its standard address and payment id.

Parameters

integrated_address is an integrated address to decode

Returns: the decoded integrated address including standard address and payment id

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ delete_address_book_entry()

virtual void monero::monero_wallet::delete_address_book_entry ( uint64_t index )

inlinevirtual

Delete an address book entry.

Parameters

index is the index of the entry to delete

Reimplemented in monero::monero_wallet_full.

◆ describe_tx_set()

virtual monero_tx_set monero::monero_wallet::describe_tx_set ( const monero_tx_set & tx_set )

inlinevirtual

Describes a tx set containing unsigned or multisig tx hex to a new tx set containing structured transactions.

Parameters

tx_set is a tx set containing unsigned or multisig tx hex

Returns: the tx set containing structured transactions

Reimplemented in monero::monero_wallet_full.

◆ edit_address_book_entry()

virtual void monero::monero_wallet::edit_address_book_entry	(	uint64_t	index,
		bool	set_address,
		const std::string &	address,
		bool	set_description,
		const std::string &	description )

inlinevirtual

Edit an address book entry.

Parameters

index	is the index of the address book entry to edit
set_address	specifies if the address should be updated
address	is the updated address
set_description	specifies if the description should be updated
description	is the updated description

Reimplemented in monero::monero_wallet_full.

◆ exchange_multisig_keys()

virtual monero_multisig_init_result monero::monero_wallet::exchange_multisig_keys	(	const std::vector< std::string > &	mutisig_hexes,
		const std::string &	password )

inlinevirtual

Exchange multisig hex with participants in a M/N multisig wallet.

This process must be repeated with participants exactly N-M times.

Parameters

multisig_hexes	are multisig hex from each participant
password	is the wallet's password // TODO monero-project: 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

Reimplemented in monero::monero_wallet_full.

◆ export_key_images()

virtual std::vector< std::shared_ptr< monero_key_image > > monero::monero_wallet::export_key_images ( bool all = false ) const

inlinevirtual

Export signed key images.

Parameters

all	- export all key images if true, else export key images since the last export

Returns: the wallet's signed key images

Reimplemented in monero::monero_wallet_full.

◆ export_multisig_hex()

virtual std::string monero::monero_wallet::export_multisig_hex ( )

inlinevirtual

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

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

Reimplemented in monero::monero_wallet_full.

◆ export_outputs()

virtual std::string monero::monero_wallet::export_outputs ( bool all = false ) const

inlinevirtual

Export outputs in hex format.

Parameters

all	- export all outputs if true, else export outputs since the last export

Returns: outputs in hex format, empty std::string if no outputs

Reimplemented in monero::monero_wallet_full.

◆ freeze_output()

virtual void monero::monero_wallet::freeze_output ( const std::string & key_image )

inlinevirtual

Freeze an output.

Parameters

key_image key image of the output to freeze

Reimplemented in monero::monero_wallet_full.

◆ get_account() [1/2]

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

inlinevirtual

Get an account.

Parameters

account_idx	specifies the account to get
include_subaddresses	specifies if subaddresses should be included

Returns: the retrieved account

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_account() [2/2]

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

inlinevirtual

Get an account without subaddress information.

Parameters

account_idx specifies the account to get

Returns: the retrieved account

◆ get_accounts() [1/4]

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

inlinevirtual

Get all accounts.

Returns: List<monero_account> are all accounts within the wallet

◆ get_accounts() [2/4]

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

inlinevirtual

Get all accounts.

Parameters

include_subaddresses specifies if subaddresses should be included

Returns: List<monero_account> are all accounts

◆ get_accounts() [3/4]

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

inlinevirtual

Get accounts with a given tag.

Parameters

include_subaddresses	specifies if subaddresses should be included
tag	is the tag for filtering accounts, all accounts if null

Returns: List<monero_account> are all accounts for the wallet with the given tag

Reimplemented in monero::monero_wallet_full.

◆ get_accounts() [4/4]

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

inlinevirtual

Get accounts with a given tag.

Parameters

tag	is 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()

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

inlinevirtual

Get the address of a specific subaddress.

Parameters

account_idx	specifies the account index of the address's subaddress
subaddress_idx	specifies the subaddress index within the account

Returns: the receive address of the specified subaddress

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_address_book_entries()

virtual std::vector< monero_address_book_entry > monero::monero_wallet::get_address_book_entries ( const std::vector< uint64_t > & indices ) const

inlinevirtual

Get all address book entries.

Parameters

indices are indices of the entries to get

Returns: the address book entries

Reimplemented in monero::monero_wallet_full.

◆ get_address_index()

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

inlinevirtual

Get the account and subaddress index of the given address.

Parameters

address is the address to get the account and subaddress index from

Returns: the account and subaddress indices

Exceptions

exception if address is not a wallet address

Reimplemented in monero::monero_wallet_full.

◆ get_attribute()

virtual bool monero::monero_wallet::get_attribute	(	const std::string &	key,
		std::string &	value ) const

inlinevirtual

Get an attribute.

Parameters

key	is the attribute to get the value of
value	is set to the key's value if set

Returns: true if the key's value has been set, false otherwise

Reimplemented in monero::monero_wallet_full.

◆ get_balance() [1/3]

virtual uint64_t monero::monero_wallet::get_balance ( ) const

inlinevirtual

Get the wallet's balance.

Returns: the wallet's balance

Reimplemented in monero::monero_wallet_full.

◆ get_balance() [2/3]

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

inlinevirtual

Get an account's balance.

Parameters

account_idx is the index of the account to get the balance of

Returns: the account's balance

Reimplemented in monero::monero_wallet_full.

◆ get_balance() [3/3]

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

inlinevirtual

Get a subaddress's balance.

Parameters

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

Returns: the subaddress's balance

Reimplemented in monero::monero_wallet_full.

◆ get_daemon_connection()

virtual boost::optional< monero_rpc_connection > monero::monero_wallet::get_daemon_connection ( ) const

inlinevirtual

Get the wallet's daemon connection.

Returns: the wallet's daemon connection

Reimplemented in monero::monero_wallet_full.

◆ get_daemon_height()

virtual uint64_t monero::monero_wallet::get_daemon_height ( ) const

inlinevirtual

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

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

Reimplemented in monero::monero_wallet_full.

◆ get_daemon_max_peer_height()

virtual uint64_t monero::monero_wallet::get_daemon_max_peer_height ( ) const

inlinevirtual

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

Reimplemented in monero::monero_wallet_full.

◆ get_height()

virtual uint64_t monero::monero_wallet::get_height ( ) const

inlinevirtual

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

Reimplemented in monero::monero_wallet_full.

◆ get_height_by_date()

virtual uint64_t monero::monero_wallet::get_height_by_date	(	uint16_t	year,
		uint8_t	month,
		uint8_t	day ) const

inlinevirtual

Get the blockchain's height by date as a conservative estimate for scanning.

Parameters

year	- year of the height to get
month	- month of the height to get as a number between 1 and 12
day	- day of the height to get as a number between 1 and 31

Returns: the blockchain's approximate height at the given date

Reimplemented in monero::monero_wallet_full.

◆ get_integrated_address()

virtual monero_integrated_address monero::monero_wallet::get_integrated_address	(	const std::string &	standard_address = "",
		const std::string &	payment_id = "" ) const

inlinevirtual

Get an integrated address from a standard address and a payment id.

Parameters

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)

Returns: the integrated address

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_listeners()

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

inlinevirtual

Get the listeners registered with the wallet.

Reimplemented in monero::monero_wallet_full.

◆ get_multisig_info()

virtual monero_multisig_info monero::monero_wallet::get_multisig_info ( ) const

inlinevirtual

Get multisig info about this wallet.

Returns: multisig info about this wallet

Reimplemented in monero::monero_wallet_full.

◆ get_network_type()

virtual monero_network_type monero::monero_wallet::get_network_type ( ) const

inlinevirtual

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

Returns: the wallet's network type

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_outputs()

virtual std::vector< std::shared_ptr< monero_output_wallet > > monero::monero_wallet::get_outputs ( const monero_output_query & query ) const

inlinevirtual

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 query in order to be returned. All filtering is optional and no filtering is applied when not defined.

Parameters

query specifies query options (optional)

Returns: wallet outputs per the query (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ get_path()

virtual std::string monero::monero_wallet::get_path ( ) const

inlinevirtual

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

Returns: the path of this wallet's file on disk

Reimplemented in monero::monero_wallet_full.

◆ get_payment_uri()

virtual std::string monero::monero_wallet::get_payment_uri ( const monero_tx_config & config ) const

inlinevirtual

Creates a payment URI from a tx configuration.

Parameters

config specifies configuration for a potential tx

Returns: is the payment uri

Reimplemented in monero::monero_wallet_full.

◆ get_primary_address()

virtual std::string monero::monero_wallet::get_primary_address ( ) const

inlinevirtual

Get the wallet's primary address.

Returns: the wallet's primary address

Reimplemented in monero::monero_wallet_keys.

◆ get_private_spend_key()

virtual std::string monero::monero_wallet::get_private_spend_key ( ) const

inlinevirtual

Get the wallet's private spend key.

Returns: the wallet's private spend key

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_private_view_key()

virtual std::string monero::monero_wallet::get_private_view_key ( ) const

inlinevirtual

Get the wallet's private view key.

Returns: the wallet's private view key

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_public_spend_key()

virtual std::string monero::monero_wallet::get_public_spend_key ( ) const

inlinevirtual

Get the wallet's public spend key.

Returns: the wallet's public spend key

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_public_view_key()

virtual std::string monero::monero_wallet::get_public_view_key ( ) const

inlinevirtual

Get the wallet's public view key.

Returns: the wallet's public view key

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_reserve_proof_account()

virtual std::string monero::monero_wallet::get_reserve_proof_account	(	uint32_t	account_idx,
		uint64_t	amount,
		const std::string &	message ) const

inlinevirtual

Generate a signature to prove an available amount in an account.

Parameters

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)

Returns: the reserve proof signature

Reimplemented in monero::monero_wallet_full.

◆ get_reserve_proof_wallet()

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

inlinevirtual

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

Parameters

message is a message included with the signature to further authenticate the proof (optional)

Returns: the reserve proof signature

Reimplemented in monero::monero_wallet_full.

◆ get_restore_height()

virtual uint64_t monero::monero_wallet::get_restore_height ( ) const

inlinevirtual

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

Returns: the height of the first block that the wallet scans

Reimplemented in monero::monero_wallet_full.

◆ get_seed()

virtual std::string monero::monero_wallet::get_seed ( ) const

inlinevirtual

Get the wallet's mnemonic phrase or seed.

Returns: the wallet's mnemonic phrase or seed.

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_seed_language()

virtual std::string monero::monero_wallet::get_seed_language ( ) const

inlinevirtual

Get the language of the wallet's mnemonic phrase or seed.

Returns: the language of the wallet's mnemonic phrase or seed.

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_spend_proof()

virtual std::string monero::monero_wallet::get_spend_proof	(	const std::string &	tx_hash,
		const std::string &	message ) const

inlinevirtual

Generate a signature to prove a spend. Unlike proving a transaction, it does not require the destination public address.

Parameters

tx_hash	specifies the transaction to prove
message	is a message to include with the signature to further authenticate the proof (optional)

Returns: the transaction signature

Reimplemented in monero::monero_wallet_full.

◆ get_subaddress()

virtual monero_subaddress monero::monero_wallet::get_subaddress	(	const uint32_t	account_idx,
		const uint32_t	subaddress_idx ) const

inlinevirtual

Get a subaddress.

Parameters

account_idx	specifies the index of the subaddress's account
subaddress_idx	specifies index of the subaddress within the account

Returns: the retrieved subaddress

◆ get_subaddresses() [1/2]

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

inlinevirtual

Get all subaddresses in an account.

Parameters

account_idx specifies the account to get subaddresses within

Returns: List<monero_subaddress> are the retrieved subaddresses

◆ get_subaddresses() [2/2]

virtual std::vector< monero_subaddress > monero::monero_wallet::get_subaddresses	(	const uint32_t	account_idx,
		const std::vector< uint32_t > &	subaddress_indices ) const

inlinevirtual

Get subaddresses in an account.

Parameters

account_idx	specifies the account to get subaddresses within
subaddress_indices	are specific subaddresses to get (optional)

Returns: the retrieved subaddresses

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ get_transfers()

virtual std::vector< std::shared_ptr< monero_transfer > > monero::monero_wallet::get_transfers ( const monero_transfer_query & query ) const

inlinevirtual

Get 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 query in order to be returned. All filtering is optional and no filtering is applied when not defined.

Parameters

query filters query results (optional)

Returns: wallet transfers per the query (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ get_tx_key()

virtual std::string monero::monero_wallet::get_tx_key ( const std::string & tx_hash ) const

inlinevirtual

Get a transaction's secret key from its hash.

Parameters

tx_hash is the transaction's hash

Returns: is the transaction's secret key

Reimplemented in monero::monero_wallet_full.

◆ get_tx_note()

virtual std::string monero::monero_wallet::get_tx_note ( const std::string & tx_hash ) const

inlinevirtual

Get a transaction note.

Parameters

tx_hash specifies the transaction to get the note of

Returns: the tx note

Reimplemented in monero::monero_wallet_full.

◆ get_tx_notes()

virtual std::vector< std::string > monero::monero_wallet::get_tx_notes ( const std::vector< std::string > & tx_hashes ) const

inlinevirtual

Get notes for multiple transactions.

Parameters

tx_hashes identify the transactions to get notes for @preturns notes for the transactions

Reimplemented in monero::monero_wallet_full.

◆ get_tx_proof()

virtual std::string monero::monero_wallet::get_tx_proof	(	const std::string &	tx_hash,
		const std::string &	address,
		const std::string &	message ) const

inlinevirtual

Get a transaction signature to prove it.

Parameters

tx_hash	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)

Returns: the transaction signature

Reimplemented in monero::monero_wallet_full.

◆ get_txs() [1/2]

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

inlinevirtual

Get all wallet transactions. Wallet transactions contain one or more transfers that are either incoming or outgoing to the wallet.

Returns: all wallet transactions (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ get_txs() [2/2]

virtual std::vector< std::shared_ptr< monero_tx_wallet > > monero::monero_wallet::get_txs ( const monero_tx_query & query ) const

inlinevirtual

Get 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 query. Transactions must meet every criteria defined in the query in order to be returned. All filtering is optional and no filtering is applied when not defined.

Parameters

query filters query results (optional)

Returns: wallet transactions per the query (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ get_unlocked_balance() [1/3]

virtual uint64_t monero::monero_wallet::get_unlocked_balance ( ) const

inlinevirtual

Get the wallet's unlocked balance.

Returns: the wallet's unlocked balance

Reimplemented in monero::monero_wallet_full.

◆ get_unlocked_balance() [2/3]

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

inlinevirtual

Get an account's unlocked balance.

Parameters

account_idx is the index of the account to get the unlocked balance of

Returns: the account's unlocked balance

Reimplemented in monero::monero_wallet_full.

◆ get_unlocked_balance() [3/3]

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

inlinevirtual

Get a subaddress's unlocked balance.

Parameters

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

Returns: the subaddress's balance

Reimplemented in monero::monero_wallet_full.

◆ get_version()

virtual monero_version monero::monero_wallet::get_version ( ) const

inlinevirtual

Get the wallet's version.

Returns: the wallet's version

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ import_key_images()

virtual std::shared_ptr< monero_key_image_import_result > monero::monero_wallet::import_key_images ( const std::vector< std::shared_ptr< monero_key_image > > & key_images )

inlinevirtual

Import signed key images and verify their spent status.

Parameters

key_images are key images to import and verify (requires hex and signature)

Returns: results of the import

Reimplemented in monero::monero_wallet_full.

◆ import_multisig_hex()

virtual int monero::monero_wallet::import_multisig_hex ( const std::vector< std::string > & multisig_hexes )

inlinevirtual

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_hexes are multisig hex from each participant

Returns: the number of outputs signed with the given multisig hex

Reimplemented in monero::monero_wallet_full.

◆ import_outputs()

virtual int monero::monero_wallet::import_outputs ( const std::string & outputs_hex )

inlinevirtual

Import outputs in hex format.

Parameters

outputs_hex are outputs in hex format

Returns: the number of outputs imported

Reimplemented in monero::monero_wallet_full.

◆ is_connected_to_daemon()

virtual bool monero::monero_wallet::is_connected_to_daemon ( ) const

inlinevirtual

Indicates if the wallet is connected a daemon.

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

Reimplemented in monero::monero_wallet_full.

◆ is_daemon_synced()

virtual bool monero::monero_wallet::is_daemon_synced ( ) const

inlinevirtual

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

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

Reimplemented in monero::monero_wallet_full.

◆ is_daemon_trusted()

virtual bool monero::monero_wallet::is_daemon_trusted ( ) const

inlinevirtual

Indicates if the daemon is trusted or untrusted.

Returns: true if the daemon is trusted, false otherwise

Reimplemented in monero::monero_wallet_full.

◆ is_multisig()

virtual bool monero::monero_wallet::is_multisig ( ) const

inlinevirtual

Indicates if this wallet is a multisig wallet.

Returns: true if this is a multisig wallet, false otherwise

◆ is_multisig_import_needed()

virtual bool monero::monero_wallet::is_multisig_import_needed ( ) const

inlinevirtual

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

Reimplemented in monero::monero_wallet_full.

◆ is_output_frozen()

virtual bool monero::monero_wallet::is_output_frozen ( const std::string & key_image )

inlinevirtual

Check if an output is frozen.

Parameters

key_image key image of the output to check if frozen

Returns: true if the output is frozen, false otherwise

Reimplemented in monero::monero_wallet_full.

◆ is_synced()

virtual bool monero::monero_wallet::is_synced ( ) const

inlinevirtual

Indicates if the wallet is synced with the daemon.

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

Reimplemented in monero::monero_wallet_full.

◆ is_view_only()

virtual bool monero::monero_wallet::is_view_only ( ) const

inlinevirtual

Indicates if the wallet is view-only, meaning it does have the private spend key and can therefore only observe incoming outputs.

Returns: true if the wallet is view-only, false otherwise

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ make_multisig()

virtual std::string monero::monero_wallet::make_multisig	(	const std::vector< std::string > &	multisig_hexes,
		int	threshold,
		const std::string &	password )

inlinevirtual

Make this wallet multisig by importing multisig hex from participants.

Parameters

multisig_hexes	are multisig hex from each participant
threshold	is the number of signatures needed to sign transfers @password is the wallet password

Returns: this wallet's multisig hex to share with participants

Reimplemented in monero::monero_wallet_full.

◆ move_to()

virtual void monero::monero_wallet::move_to	(	const std::string &	path,
		const std::string &	password )

inlinevirtual

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

Parameters

path	is the new wallet's path
password	is the new wallet's password

Reimplemented in monero::monero_wallet_full.

◆ parse_payment_uri()

virtual std::shared_ptr< monero_tx_config > monero::monero_wallet::parse_payment_uri ( const std::string & uri ) const

inlinevirtual

Parses a payment URI to a tx configuration.

Parameters

uri	is the payment uri to parse

Returns: the tx configuration parsed from the uri

Reimplemented in monero::monero_wallet_full.

◆ prepare_multisig()

virtual std::string monero::monero_wallet::prepare_multisig ( )

inlinevirtual

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

Reimplemented in monero::monero_wallet_full.

◆ relay_tx() [1/2]

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

inlinevirtual

Relay a previously created transaction.

Parameters

tx	is the transaction to relay

Returns: the hash of the relayed tx

◆ relay_tx() [2/2]

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

inlinevirtual

Relay a transaction previously created without relaying.

Parameters

txMetadata is transaction metadata previously created without relaying

Returns: std::string is the hash of the relayed tx

◆ relay_txs() [1/2]

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

inlinevirtual

Relay previously created transactions.

Parameters

txs	are the transactions to relay

Returns: the hashes of the relayed txs

◆ relay_txs() [2/2]

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

inlinevirtual

Relay transactions previously created without relaying.

Parameters

tx_metadatas are transaction metadata previously created without relaying

Returns: the hashes of the relayed txs

Reimplemented in monero::monero_wallet_full.

◆ remove_listener()

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

inlinevirtual

Unregister a listener to receive wallet notifications.

Parameters

listener is the listener to unregister

Reimplemented in monero::monero_wallet_full.

◆ rescan_blockchain()

virtual void monero::monero_wallet::rescan_blockchain ( )

inlinevirtual

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.

Reimplemented in monero::monero_wallet_full.

◆ rescan_spent()

virtual void monero::monero_wallet::rescan_spent ( )

inlinevirtual

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.

Reimplemented in monero::monero_wallet_full.

◆ save()

virtual void monero::monero_wallet::save ( )

inlinevirtual

Save the wallet at its current path.

Reimplemented in monero::monero_wallet_full.

◆ scan_txs()

virtual void monero::monero_wallet::scan_txs ( const std::vector< std::string > & tx_hashes )

inlinevirtual

Scan transactions by their hash/id.

Parameters

txHashes - tx hashes to scan

Reimplemented in monero::monero_wallet_full.

◆ set_attribute()

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

inlinevirtual

Set an arbitrary attribute.

Parameters

key	is the attribute key
val	is the attribute value

Reimplemented in monero::monero_wallet_full.

◆ set_daemon_connection() [1/2]

virtual void monero::monero_wallet::set_daemon_connection ( const boost::optional< monero_rpc_connection > & connection )

inlinevirtual

Set the wallet's daemon connection.

Parameters

connection is the connection to set

Reimplemented in monero::monero_wallet_full.

◆ set_daemon_connection() [2/2]

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

inlinevirtual

Set the wallet's daemon connection.

Parameters

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)

Reimplemented in monero::monero_wallet_full.

◆ set_daemon_proxy()

virtual void monero::monero_wallet::set_daemon_proxy ( const std::string & uri = "" )

inlinevirtual

Set the Tor proxy to the daemon.

Reimplemented in monero::monero_wallet_full.

◆ set_restore_height()

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

inlinevirtual

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

Parameters

restore_height is the height of the first block that the wallet scans

Reimplemented in monero::monero_wallet_full.

◆ set_subaddress_label()

virtual void monero::monero_wallet::set_subaddress_label	(	uint32_t	account_idx,
		uint32_t	subaddress_idx,
		const std::string &	label = "" )

inlinevirtual

Set a subaddress label.

Parameters

account_idx	index of the account to set the label for
subaddress_idx	index of the subaddress to set the label for
label	the label to set

Reimplemented in monero::monero_wallet_full.

◆ set_tx_note()

virtual void monero::monero_wallet::set_tx_note	(	const std::string &	tx_hash,
		const std::string &	note )

inlinevirtual

Set a note for a specific transaction.

Parameters

tx_hash	specifies the transaction
note	specifies the note

Reimplemented in monero::monero_wallet_full.

◆ set_tx_notes()

virtual void monero::monero_wallet::set_tx_notes	(	const std::vector< std::string > &	tx_hashes,
		const std::vector< std::string > &	notes )

inlinevirtual

Set notes for multiple transactions.

Parameters

tx_hashes	specify the transactions to set notes for
notes	are the notes to set for the transactions

Reimplemented in monero::monero_wallet_full.

◆ sign_message()

virtual std::string monero::monero_wallet::sign_message	(	const std::string &	msg,
		monero_message_signature_type	signature_type,
		uint32_t	account_idx = 0,
		uint32_t	subaddress_idx = 0 ) const

inlinevirtual

Sign a message.

Parameters

msg	- the message to sign
signature_type	- sign with spend key or spend key
account_idx	- the account index of the message signature (default 0)
subaddress_idx	- the subaddress index of the message signature (default 0)

Returns: the message signature

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ sign_multisig_tx_hex()

virtual monero_multisig_sign_result monero::monero_wallet::sign_multisig_tx_hex ( const std::string & multisig_tx_hex )

inlinevirtual

Sign previously created multisig transactions as represented by hex.

Parameters

multisig_tx_hex is the hex shared among the multisig transactions when they were created

Returns: the result of signing the multisig transactions

Reimplemented in monero::monero_wallet_full.

◆ sign_txs()

virtual monero_tx_set monero::monero_wallet::sign_txs ( const std::string & unsigned_tx_hex )

inlinevirtual

Sign unsigned transactions from a view-only wallet.

Parameters

unsigned_tx_hex is unsigned transaction hex from when the transactions were created

Returns: the signed transaction set

Reimplemented in monero::monero_wallet_full.

◆ start_mining()

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

inlinevirtual

Start mining.

Parameters

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)

Reimplemented in monero::monero_wallet_full.

◆ start_syncing()

virtual void monero::monero_wallet::start_syncing ( uint64_t sync_period_in_ms = 10000 )

inlinevirtual

Start background synchronizing with a maximum period between syncs.

Parameters

syncPeriodInMs - maximum period between syncs in milliseconds

Reimplemented in monero::monero_wallet_full.

◆ stop_mining()

virtual void monero::monero_wallet::stop_mining ( )

inlinevirtual

Stop mining.

Reimplemented in monero::monero_wallet_full.

◆ stop_syncing()

virtual void monero::monero_wallet::stop_syncing ( )

inlinevirtual

Stop the asynchronous thread to continuously synchronize the wallet with the daemon.

Reimplemented in monero::monero_wallet_full.

◆ submit_multisig_tx_hex()

virtual std::vector< std::string > monero::monero_wallet::submit_multisig_tx_hex ( const std::string & signed_multisig_tx_hex )

inlinevirtual

Submit signed multisig transactions as represented by a hex std::string.

Parameters

signed_multisig_tx_hex is the signed multisig hex returned from signMultisigTxs()

Returns: the resulting transaction hashes

Reimplemented in monero::monero_wallet_full.

◆ submit_txs()

virtual std::vector< std::string > monero::monero_wallet::submit_txs ( const std::string & signed_tx_hex )

inlinevirtual

Submit signed transactions from a view-only wallet.

Parameters

signed_tx_hex is signed transaction hex from sign_txs()

Returns: the resulting transaction hashes

Reimplemented in monero::monero_wallet_full.

◆ sweep_dust()

virtual std::vector< std::shared_ptr< monero_tx_wallet > > monero::monero_wallet::sweep_dust ( bool relay = false )

inlinevirtual

Sweep all unmixable dust outputs back to the wallet to make them easier to spend and mix.

Parameters

relay specifies if the resulting transaction should be relayed (default false)

Returns: the created transactions (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ sweep_output()

virtual std::shared_ptr< monero_tx_wallet > monero::monero_wallet::sweep_output ( const monero_tx_config & config )

inlinevirtual

Sweep an output with a given key image.

Parameters

config configures the sweep transaction

Returns: the created transaction (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ sweep_unlocked()

virtual std::vector< std::shared_ptr< monero_tx_wallet > > monero::monero_wallet::sweep_unlocked ( const monero_tx_config & config )

inlinevirtual

Sweep unlocked funds according to the given config.

Parameters

config is the sweep configuration

Returns: the created transactions (free memory using monero_utils::free)

Reimplemented in monero::monero_wallet_full.

◆ sync() [1/4]

virtual monero_sync_result monero::monero_wallet::sync ( )

inlinevirtual

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

Returns: the sync result

Reimplemented in monero::monero_wallet_full.

◆ sync() [2/4]

virtual monero_sync_result monero::monero_wallet::sync ( monero_wallet_listener & listener )

inlinevirtual

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

Parameters

listener - listener to receive notifications during synchronization

Returns: the sync result

Reimplemented in monero::monero_wallet_full.

◆ sync() [3/4]

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

inlinevirtual

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

Parameters

start_height is the start height to sync from (ignored if less than last processed block)

Returns: the sync result

Reimplemented in monero::monero_wallet_full.

◆ sync() [4/4]

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

inlinevirtual

Synchronizes the wallet with the blockchain.

Parameters

start_height	- start height to sync from (ignored if less than last processed block)
listener	- listener to receive notifications during synchronization

Returns: the sync result

Reimplemented in monero::monero_wallet_full.

◆ thaw_output()

virtual void monero::monero_wallet::thaw_output ( const std::string & key_image )

inlinevirtual

Thaw a frozen output.

Parameters

key_image key image of the output to thaw

Reimplemented in monero::monero_wallet_full.

◆ verify_message()

virtual monero_message_signature_result monero::monero_wallet::verify_message	(	const std::string &	msg,
		const std::string &	address,
		const std::string &	signature ) const

inlinevirtual

Verify a message signature.

Parameters

msg	- the signed message
address	- signing address
signature	- signature

Returns: the message signature result

Reimplemented in monero::monero_wallet_full, and monero::monero_wallet_keys.

◆ wait_for_next_block()

virtual uint64_t monero::monero_wallet::wait_for_next_block ( )

inlinevirtual

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

Reimplemented in monero::monero_wallet_full.

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

wallet/monero_wallet.h

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~monero_wallet()

Member Function Documentation

◆ add_address_book_entry()

◆ add_listener()

◆ change_password()

◆ check_reserve_proof()

◆ check_spend_proof()

◆ check_tx_key()

◆ check_tx_proof()

◆ close()

◆ create_account()

◆ create_subaddress()

◆ create_tx()

◆ create_txs()

◆ decode_integrated_address()

◆ delete_address_book_entry()

◆ describe_tx_set()

◆ edit_address_book_entry()

◆ exchange_multisig_keys()

◆ export_key_images()

◆ export_multisig_hex()

◆ export_outputs()

◆ freeze_output()

◆ get_account() [1/2]

◆ get_account() [2/2]

◆ get_accounts() [1/4]

◆ get_accounts() [2/4]

◆ get_accounts() [3/4]

◆ get_accounts() [4/4]

◆ get_address()

◆ get_address_book_entries()

◆ get_address_index()

◆ get_attribute()

◆ get_balance() [1/3]

◆ get_balance() [2/3]

◆ get_balance() [3/3]

◆ get_daemon_connection()

◆ get_daemon_height()

◆ get_daemon_max_peer_height()

◆ get_height()

◆ get_height_by_date()

◆ get_integrated_address()

◆ get_listeners()

◆ get_multisig_info()

◆ get_network_type()

◆ get_outputs()

◆ get_path()

◆ get_payment_uri()

◆ get_primary_address()

◆ get_private_spend_key()

◆ get_private_view_key()

◆ get_public_spend_key()

◆ get_public_view_key()

◆ get_reserve_proof_account()

◆ get_reserve_proof_wallet()

◆ get_restore_height()

◆ get_seed()

◆ get_seed_language()

◆ get_spend_proof()

◆ get_subaddress()

◆ get_subaddresses() [1/2]

◆ get_subaddresses() [2/2]

◆ get_transfers()

◆ get_tx_key()

◆ get_tx_note()

◆ get_tx_notes()

◆ get_tx_proof()

◆ get_txs() [1/2]

◆ get_txs() [2/2]

◆ get_unlocked_balance() [1/3]

◆ get_unlocked_balance() [2/3]

◆ get_unlocked_balance() [3/3]

◆ get_version()

◆ import_key_images()

◆ import_multisig_hex()

◆ import_outputs()

◆ is_connected_to_daemon()