#include <monero_wallet.h>

Inheritance diagram for monero::monero_wallet:

Public Member Functions
virtual	~monero_wallet ()

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

virtual void	set_daemon_connection (const monero_rpc_connection &connection)

virtual shared_ptr< monero_rpc_connection >	get_daemon_connection () const

virtual bool	is_connected () 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 string	get_path () const

virtual monero_network_type	get_network_type () const

virtual string	get_mnemonic () const

virtual string	get_mnemonic_language () const

virtual string	get_public_view_key () const

virtual string	get_private_view_key () const

virtual string	get_public_spend_key () const

virtual string	get_private_spend_key () const

virtual string	get_primary_address () const

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

virtual monero_subaddress	get_address_index (const string &address) const

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

virtual monero_integrated_address	decode_integrated_address (const 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 void	add_listener (monero_wallet_listener &listener)

virtual void	remove_listener (monero_wallet_listener &listener)

virtual set< monero_wallet_listener * >	get_listeners ()

virtual monero_sync_result	sync ()

virtual monero_sync_result	sync (monero_sync_listener &listener)

virtual monero_sync_result	sync (uint64_t start_height)

virtual monero_sync_result	sync (uint64_t start_height, monero_sync_listener &listener)

virtual void	start_syncing ()

virtual void	stop_syncing ()

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 vector< monero_account >	get_accounts () const

virtual vector< monero_account >	get_accounts (bool include_subaddresses) const

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

virtual vector< monero_account >	get_accounts (bool include_subaddresses, const 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 string &label="")

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

virtual vector< monero_subaddress >	get_subaddresses (const uint32_t account_idx, const 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 string &label="")

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

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

virtual vector< shared_ptr< monero_tx_wallet > >	get_txs (const monero_tx_query &query, vector< string > &missing_tx_hashes) const

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

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

virtual string	get_outputs_hex () const

virtual int	import_outputs_hex (const string &outputs_hex)

virtual vector< shared_ptr< monero_key_image > >	get_key_images () const

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

virtual monero_tx_set	create_tx (monero_send_request &request)

virtual monero_tx_set	create_tx (uint32_t account_index, string address, uint64_t amount)

virtual monero_tx_set	create_tx (int account_index, string address, uint64_t amount, monero_send_priority priority)

virtual monero_tx_set	create_txs (monero_send_request &request)

virtual string	relay_tx (const string &tx_metadata)

virtual string	relay_tx (const monero_tx_wallet &tx)

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

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

virtual monero_tx_set	send (const monero_send_request &request)

virtual monero_tx_set	send (uint32_t account_index, string address, uint64_t amount)

virtual monero_tx_set	send (uint32_t account_index, string address, uint64_t amount, monero_send_priority priority)

virtual monero_tx_set	send_split (const monero_send_request &request)

virtual vector< monero_tx_set >	sweep_unlocked (const monero_send_request &request)

virtual monero_tx_set	sweep_output (const monero_send_request &request)

virtual monero_tx_set	sweep_dust (bool do_not_relay=false)

virtual monero_tx_set	parse_tx_set (const monero_tx_set &tx_set)

virtual string	sign (const string &msg) const

virtual bool	verify (const string &msg, const string &address, const string &signature) const

virtual string	get_tx_key (const string &tx_hash) const

virtual shared_ptr< monero_check_tx >	check_tx_key (const string &tx_hash, const string &txKey, const string &address) const

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

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

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

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

virtual string	get_reserve_proof_wallet (const string &message) const

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

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

virtual string	get_tx_note (const string &tx_hash) const

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

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

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

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

virtual uint64_t	add_address_book_entry (const string &address, const string &description, const string &payment_id="")

virtual void	edit_address_book_entry (uint64_t index, bool set_address, const string &address, bool set_description, const string &description, bool set_payment_id=false, const string &payment_id="")

virtual void	delete_address_book_entry (uint64_t index)

virtual string	create_payment_uri (const monero_send_request &request) const

virtual shared_ptr< monero_send_request >	parse_payment_uri (const string &uri) const

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

virtual void	set_attribute (const string &key, const 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 monero_multisig_info	get_multisig_info ()

virtual string	prepare_multisig ()

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

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

virtual string	get_multisig_hex ()

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

virtual monero_multisig_sign_result	sign_multisig_tx_hex (const string &multisig_tx_hex)

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

virtual void	save ()

virtual void	move_to (string path, string password)

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 string &	address,
		const string &	description,
		const string &	payment_id = `""`
	)

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_core.

◆ 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_core.

◆ check_reserve_proof()

virtual shared_ptr<monero_check_reserve> monero::monero_wallet::check_reserve_proof	(	const string &	address,
		const string &	message,
		const 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_core.

◆ check_spend_proof()

virtual bool monero::monero_wallet::check_spend_proof	(	const string &	tx_hash,
		const string &	message,
		const 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_core.

◆ check_tx_key()

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

inlinevirtual

Check a transaction in the blockchain with its secret key.

Parameters

tx_hash	specifies the transaction to check
txKey	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_core.

◆ check_tx_proof()

virtual shared_ptr<monero_check_tx> monero::monero_wallet::check_tx_proof	(	const string &	tx_hash,
		const string &	address,
		const string &	message,
		const 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_core.

◆ 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_core, and monero::monero_wallet_keys.

◆ create_account()

virtual monero_account monero::monero_wallet::create_account ( const 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_core.

◆ create_payment_uri()

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

inlinevirtual

Tag accounts.

Parameters

tag	is the tag to apply to the specified accounts
accountIndices	are the indices of the accounts to tagUntag acconts.
accountIndices	are the indices of the accounts to untagReturn all account tags.

Returns: the wallet's account tagsSets a human-readable description for a tag.

Parameters

tag	is the tag to set a description for
label	is the label to set for the tagCreates a payment URI from a send configuration.
request	specifies configuration for a potential tx

Returns: is the payment uri

Reimplemented in monero::monero_wallet_core.

◆ create_subaddress()

virtual monero_subaddress monero::monero_wallet::create_subaddress	(	uint32_t	account_idx,
		const 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 string)

Returns: the created subaddress

Reimplemented in monero::monero_wallet_core.

◆ create_tx() [1/3]

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

inlinevirtual

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

request configures the transaction to create

Returns: a tx set for the requested transaction if possible

Reimplemented in monero::monero_wallet_core.

◆ create_tx() [2/3]

virtual monero_tx_set monero::monero_wallet::create_tx	(	uint32_t	account_index,
		string	address,
		uint64_t	amount
	)

inlinevirtual

Create a transaction to transfers funds from this wallet to a destination address. The transaction may be relayed later.

Parameters

accountIndex	is the index of the account to withdraw funds from
address	is the destination address to send funds to
amount	is the amount being sent

Returns: a tx set for the requested transaction if possible

Reimplemented in monero::monero_wallet_core.

◆ create_tx() [3/3]

virtual monero_tx_set monero::monero_wallet::create_tx	(	int	account_index,
		string	address,
		uint64_t	amount,
		monero_send_priority	priority
	)

inlinevirtual

Create a transaction to transfers funds from this wallet to a destination address. The transaction may be relayed later.

Parameters

accountIndex	is the index of the account to withdraw funds from
address	is the destination address to send funds to
amount	is the amount being sent
priority	is the send priority (default normal)

Returns: a tx set for the requested transaction if possible

Reimplemented in monero::monero_wallet_core.

◆ create_txs()

virtual monero_tx_set monero::monero_wallet::create_txs ( monero_send_request & request )

inlinevirtual

Create one or more transactions to transfer funds from this wallet according to the given request. The transactions may later be relayed.

Parameters

request configures the transactions to create

Returns: a tx set for the requested transactions if possible

Reimplemented in monero::monero_wallet_core.

◆ decode_integrated_address()

virtual monero_integrated_address monero::monero_wallet::decode_integrated_address ( const 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_core, 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_core.

◆ edit_address_book_entry()

virtual void monero::monero_wallet::edit_address_book_entry	(	uint64_t	index,
		bool	set_address,
		const string &	address,
		bool	set_description,
		const string &	description,
		bool	set_payment_id = `false`,
		const string &	payment_id = `""`
	)

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
set_payment_id	specifies if the payment id should be updated
payment_id	is the updated payment id

Reimplemented in monero::monero_wallet_core.

◆ exchange_multisig_keys()

virtual monero_multisig_init_result monero::monero_wallet::exchange_multisig_keys	(	const vector< string > &	mutisig_hexes,
		const 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 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

Reimplemented in monero::monero_wallet_core.

◆ get_account() [1/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_account() [2/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_core, and monero::monero_wallet_keys.

◆ get_accounts() [1/4]

virtual 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 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 vector<monero_account> monero::monero_wallet::get_accounts ( const 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_accounts() [4/4]

virtual vector<monero_account> monero::monero_wallet::get_accounts	(	bool	include_subaddresses,
		const 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_core.

◆ get_address()

virtual 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_core, and monero::monero_wallet_keys.

◆ get_address_book_entries()

virtual vector<monero_address_book_entry> monero::monero_wallet::get_address_book_entries ( const 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_core.

◆ get_address_index()

virtual monero_subaddress monero::monero_wallet::get_address_index ( const 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_core.

◆ get_attribute()

virtual bool monero::monero_wallet::get_attribute	(	const string &	key,
		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_core.

◆ get_balance() [1/3]

virtual uint64_t monero::monero_wallet::get_balance ( ) 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 otherwiseGet the wallet's balance.; the wallet's balance

Reimplemented in monero::monero_wallet_core.

◆ 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_core.

◆ 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_core.

◆ get_daemon_connection()

virtual shared_ptr<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_core.

◆ 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_core.

◆ 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_core.

◆ 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_core.

◆ get_integrated_address()

virtual monero_integrated_address monero::monero_wallet::get_integrated_address	(	const string &	standard_address = `""`,
		const 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_core, and monero::monero_wallet_keys.

◆ get_key_images()

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

inlinevirtual

Get all signed key images.

Returns: the wallet's signed key images

Reimplemented in monero::monero_wallet_core.

◆ get_listeners()

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

inlinevirtual

Get the listeners registered with the wallet.

Reimplemented in monero::monero_wallet_core.

◆ get_mnemonic()

virtual string monero::monero_wallet::get_mnemonic ( ) const

inlinevirtual

Get the wallet's mnemonic phrase.

Parameters

mnemonic is assigned the wallet's mnemonic phrase

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

◆ get_mnemonic_language()

virtual string monero::monero_wallet::get_mnemonic_language ( ) const

inlinevirtual

Get the language of the wallet's mnemonic phrase.

Returns: the language of the wallet's mnemonic phrase

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

◆ get_multisig_hex()

virtual string monero::monero_wallet::get_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_core.

◆ get_multisig_info()

virtual monero_multisig_info monero::monero_wallet::get_multisig_info ( )

inlinevirtual

Get multisig info about this wallet.

Returns: multisig info about this wallet

Reimplemented in monero::monero_wallet_core.

◆ 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_core, and monero::monero_wallet_keys.

◆ get_outputs()

virtual vector<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.

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

Reimplemented in monero::monero_wallet_core.

◆ get_outputs_hex()

virtual string monero::monero_wallet::get_outputs_hex ( ) const

inlinevirtual

Export all outputs in hex format.

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

Reimplemented in monero::monero_wallet_core.

◆ get_path()

virtual 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_core.

◆ get_primary_address()

virtual 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 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_core, and monero::monero_wallet_keys.

◆ get_private_view_key()

virtual 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_core, and monero::monero_wallet_keys.

◆ get_public_spend_key()

virtual 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_core, and monero::monero_wallet_keys.

◆ get_public_view_key()

virtual 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_core, and monero::monero_wallet_keys.

◆ get_reserve_proof_account()

virtual string monero::monero_wallet::get_reserve_proof_account	(	uint32_t	account_idx,
		uint64_t	amount,
		const 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_core.

◆ get_reserve_proof_wallet()

virtual string monero::monero_wallet::get_reserve_proof_wallet ( const 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_core.

◆ 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_core.

◆ get_spend_proof()

virtual string monero::monero_wallet::get_spend_proof	(	const string &	tx_hash,
		const 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

Returns: the transaction signatureGenerate 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_core.

◆ 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 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 vector<monero_subaddress> monero::monero_wallet::get_subaddresses	(	const uint32_t	account_idx,
		const 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_core, and monero::monero_wallet_keys.

◆ get_transfers()

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

inlinevirtual

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_idx is 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_idx	is the index of the account to get transfers from
subaddress_idx	is 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 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

Reimplemented in monero::monero_wallet_core.

◆ get_tx_key()

virtual string monero::monero_wallet::get_tx_key ( const 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_core.

◆ get_tx_note()

virtual string monero::monero_wallet::get_tx_note ( const 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_core.

◆ get_tx_notes()

virtual vector<string> monero::monero_wallet::get_tx_notes ( const vector< 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_core.

◆ get_tx_proof()

virtual string monero::monero_wallet::get_tx_proof	(	const string &	tx_hash,
		const string &	address,
		const 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

Returns: the transaction signatureGet 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_core.

◆ get_txs() [1/3]

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

inlinevirtual

Get a wallet transaction by hash.

Parameters

tx_hash is a hash 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

Reimplemented in monero::monero_wallet_core.

◆ get_txs() [2/3]

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

inlinevirtual

Get wallet transactions by hash.

Parameters

tx_hashes are hashes 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 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

Reimplemented in monero::monero_wallet_core.

◆ get_txs() [3/3]

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

inlinevirtual

Same as get_txs(request) but collects missing tx hashes instead of throwing an error. This method is separated because WebAssembly does not support exception handling.

Parameters

request	filters query results (optional)
missing_tx_hashes	are populated with requested tx hashes that are not part of the wallet

Returns: wallet transactions per the request

◆ 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_core.

◆ 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_core.

◆ 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_core.

◆ 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_core, and monero::monero_wallet_keys.

◆ import_key_images()

virtual shared_ptr<monero_key_image_import_result> monero::monero_wallet::import_key_images ( const vector< 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_core.

◆ import_multisig_hex()

virtual int monero::monero_wallet::import_multisig_hex ( const vector< 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_core.

◆ import_outputs_hex()

virtual int monero::monero_wallet::import_outputs_hex ( const 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_core.

◆ is_connected()

virtual bool monero::monero_wallet::is_connected ( ) 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_core.

◆ 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_core.

◆ 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_core.

◆ 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_core.

◆ 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_core.

◆ make_multisig()

virtual monero_multisig_init_result monero::monero_wallet::make_multisig	(	const vector< string > &	multisig_hexes,
		int	threshold,
		const 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: the result which has the multisig's address xor this wallet's multisig hex to share with participants iff not N/N

Reimplemented in monero::monero_wallet_core.

◆ move_to()

virtual void monero::monero_wallet::move_to	(	string	path,
		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_core.

◆ parse_payment_uri()

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

inlinevirtual

Parses a payment URI to a send request.

Parameters

uri	is the payment uri to parse

Returns: the send request parsed from the uri

Reimplemented in monero::monero_wallet_core.

◆ parse_tx_set()

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

inlinevirtual

Parses 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 parsed tx set containing structured transactions

Reimplemented in monero::monero_wallet_core.

◆ prepare_multisig()

virtual 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_core.

◆ relay_tx() [1/2]

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

inlinevirtual

Relay a transaction previously created without relaying.

Parameters

txMetadata is transaction metadata previously created without relaying

Returns: string is the hash of the relayed tx

Reimplemented in monero::monero_wallet_core.

◆ relay_tx() [2/2]

virtual 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

Reimplemented in monero::monero_wallet_core.

◆ relay_txs() [1/2]

virtual vector<string> monero::monero_wallet::relay_txs ( const vector< 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_core.

◆ relay_txs() [2/2]

virtual vector<string> monero::monero_wallet::relay_txs ( const vector< 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

Reimplemented in monero::monero_wallet_core.

◆ 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_core.

◆ 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_core.

◆ 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_core.

◆ save()

virtual void monero::monero_wallet::save ( )

inlinevirtual

Save the wallet at its current path.

Reimplemented in monero::monero_wallet_core.

◆ send() [1/3]

virtual monero_tx_set monero::monero_wallet::send ( const monero_send_request & request )

inlinevirtual

Create and relay a transaction to transfer funds from this wallet according to the given request.

Parameters

request configures the transaction

Returns: a tx set with the requested transaction if possible

Reimplemented in monero::monero_wallet_core.

◆ send() [2/3]

virtual monero_tx_set monero::monero_wallet::send	(	uint32_t	account_index,
		string	address,
		uint64_t	amount
	)

inlinevirtual

Create and relay a transaction to transfers funds from this wallet to a destination address.

Parameters

account_index	is the index of the account to withdraw funds from
address	is the destination address to send funds to
amount	is the amount being sent

Returns: a tx set with the requested transaction if possible

Reimplemented in monero::monero_wallet_core.

◆ send() [3/3]

virtual monero_tx_set monero::monero_wallet::send	(	uint32_t	account_index,
		string	address,
		uint64_t	amount,
		monero_send_priority	priority
	)

inlinevirtual

Create and relay a transaction to transfers funds from this wallet to a destination address.

Parameters

account_index	is the index of the account to withdraw funds from
address	is the destination address to send funds to
amount	is the amount being sent
priority	is the send priority (default normal)

Returns: a tx set with the requested transaction if possible

Reimplemented in monero::monero_wallet_core.

◆ send_split()

virtual monero_tx_set monero::monero_wallet::send_split ( const monero_send_request & request )

inlinevirtual

Create one or more transactions which transfer funds from this wallet to one or more destinations depending on the given configuration.

Parameters

request configures the transaction

Returns: a tx set with the requested transactions if possible

Reimplemented in monero::monero_wallet_core.

◆ set_attribute()

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

inlinevirtual

Set an arbitrary attribute.

Parameters

key	is the attribute key
val	is the attribute value

Reimplemented in monero::monero_wallet_core.

◆ set_daemon_connection() [1/2]

virtual void monero::monero_wallet::set_daemon_connection	(	const string &	uri,
		const string &	username = `""`,
		const 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_core.

◆ set_daemon_connection() [2/2]

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

inlinevirtual

Set the wallet's daemon connection.

Parameters

connection is the connection to set

Reimplemented in monero::monero_wallet_core.

◆ 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_core.

◆ set_tx_note()

virtual void monero::monero_wallet::set_tx_note	(	const string &	tx_hash,
		const 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_core.

◆ set_tx_notes()

virtual void monero::monero_wallet::set_tx_notes	(	const vector< string > &	tx_hashes,
		const vector< 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_core.

◆ sign()

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

inlinevirtual

Sign a message.

Parameters

msg	is the message to sign

Returns: the signature

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

◆ sign_multisig_tx_hex()

virtual monero_multisig_sign_result monero::monero_wallet::sign_multisig_tx_hex ( const 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_core.

◆ 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_core.

◆ start_syncing()

virtual void monero::monero_wallet::start_syncing ( )

inlinevirtual

Start an asynchronous thread to continuously synchronize the wallet with the daemon.

Reimplemented in monero::monero_wallet_core.

◆ stop_mining()

virtual void monero::monero_wallet::stop_mining ( )

inlinevirtual

Stop mining.

Reimplemented in monero::monero_wallet_core.

◆ 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_core.

◆ submit_multisig_tx_hex()

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

inlinevirtual

Submit signed multisig transactions as represented by a hex string.

Parameters

signed_multisig_tx_hex is the signed multisig hex returned from signMultisigTxs()

Returns: the resulting transaction hashes

Reimplemented in monero::monero_wallet_core.

◆ sweep_dust()

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

inlinevirtual

Sweep an output with a given key image.

Parameters

address	is the destination address to send to
key_image	is 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

address	is the destination address to send to
key_image	is the key image hex of the output to sweep
priority	is the transaction priority (optional)

Returns: the resulting transaction from sweeping an outputSweep a subaddress's unlocked funds to an address.

Parameters

account_idx	is the index of the account
subaddress_idx	is the index of the subaddress
address	is the address to sweep the subaddress's funds to

Returns: the resulting transactionsSweep an acount's unlocked funds to an address.

Parameters

account_idx	is the index of the account
address	is the address to sweep the account's funds to

Returns: the resulting transactionsSweep the wallet's unlocked funds to an address.

Parameters

address is the address to sweep the wallet's funds to

Returns: the resulting transactionsSweep all unlocked funds according to the given request.

Parameters

request is 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_relay specifies if the resulting transaction should not be relayed (defaults to false i.e. relayed)

Returns: a tx set with the requested transactions if possible

Reimplemented in monero::monero_wallet_core.

◆ sweep_output()

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

inlinevirtual

Sweep an output with a given key image.

Parameters

request configures the sweep transaction

Returns: a tx set with the requested transaction if possible

Reimplemented in monero::monero_wallet_core.

◆ sweep_unlocked()

virtual vector<monero_tx_set> monero::monero_wallet::sweep_unlocked ( const monero_send_request & request )

inlinevirtual

Create and relay one or more transactions which transfer funds from this wallet to one or more destination.

Parameters

account_index	is the index of the account to draw funds from
address	is the destination address to send funds to
sendAmount	is the amount being sent

Returns: the resulting transactionsCreate and relay one or more transactions which transfer funds from this wallet to one or more destination.

Parameters

account_index	is the index of the account to draw funds from
address	is the destination address to send funds to
sendAmount	is the amount being sent
priority	is the send priority (default normal)

Returns: the resulting transactionsSweep unlocked funds according to the given request.

Parameters

request is the sweep configuration

Returns: the tx sets with the requested transactions

Reimplemented in monero::monero_wallet_core.

◆ 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_core.

◆ sync() [2/4]

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

inlinevirtual

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

Parameters

listener is invoked as sync progress is made

Returns: the sync result

Reimplemented in monero::monero_wallet_core.

◆ 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_core.

◆ sync() [4/4]

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

inlinevirtual

Synchronizes the wallet with the blockchain.

Parameters

start_height	is the start height to sync from (ignored if less than last processed block)
listener	is invoked as sync progress is made

Returns: the sync result

Reimplemented in monero::monero_wallet_core.

◆ verify()

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

inlinevirtual

Verify a signature on a message.

Parameters

msg	is the signed message
address	is the signing address
signature	is the signature

Returns: true if the signature is good, false otherwise

Reimplemented in monero::monero_wallet_core, 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_core.

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

◆ check_reserve_proof()

◆ check_spend_proof()

◆ check_tx_key()

◆ check_tx_proof()

◆ close()

◆ create_account()

◆ create_payment_uri()

◆ create_subaddress()

◆ create_tx() [1/3]

◆ create_tx() [2/3]

◆ create_tx() [3/3]

◆ create_txs()

◆ decode_integrated_address()

◆ delete_address_book_entry()

◆ edit_address_book_entry()

◆ exchange_multisig_keys()

◆ 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_integrated_address()

◆ get_key_images()

◆ get_listeners()

◆ get_mnemonic()

◆ get_mnemonic_language()

◆ get_multisig_hex()

◆ get_multisig_info()

◆ get_network_type()

◆ get_outputs()

◆ get_outputs_hex()

◆ get_path()

◆ 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_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/3]

◆ get_txs() [2/3]

◆ get_txs() [3/3]

◆ 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_hex()

◆ is_connected()

◆ is_daemon_synced()