Interface for wallet operations. More...

#include <wallet2_api.h>

Inheritance diagram for Monero::Wallet:

Public Types
enum	Device { Device_Software = 0 , Device_Ledger = 1 , Device_Trezor = 2 }
enum	Status { Status_Ok , Status_Error , Status_Critical }
enum	ConnectionStatus { ConnectionStatus_Disconnected , ConnectionStatus_Connected , ConnectionStatus_WrongVersion }
enum	BackgroundSyncType { BackgroundSync_Off = 0 , BackgroundSync_ReusePassword = 1 , BackgroundSync_CustomPassword = 2 }

Public Member Functions
virtual	~Wallet ()=0
virtual std::string	seed (const std::string &seed_offset="") const =0
virtual std::string	getSeedLanguage () const =0
virtual void	setSeedLanguage (const std::string &arg)=0
virtual int	status () const =0
	returns wallet status (Status_Ok \| Status_Error)
virtual std::string	errorString () const =0
	in case error status, returns error string
virtual void	statusWithErrorString (int &status, std::string &errorString) const =0
	returns both error and error string atomically. suggested to use in instead of status() and errorString()
virtual bool	setPassword (const std::string &password)=0
virtual const std::string &	getPassword () const =0
virtual bool	setDevicePin (const std::string &pin)
virtual bool	setDevicePassphrase (const std::string &passphrase)
virtual std::string	address (uint32_t accountIndex=0, uint32_t addressIndex=0) const =0
std::string	mainAddress () const
virtual std::string	path () const =0
virtual NetworkType	nettype () const =0
bool	mainnet () const
bool	testnet () const
bool	stagenet () const
virtual void	hardForkInfo (uint8_t &version, uint64_t &earliest_height) const =0
	returns current hard fork info
virtual bool	useForkRules (uint8_t version, int64_t early_blocks) const =0
	check if hard fork rules should be used
virtual std::string	integratedAddress (const std::string &payment_id) const =0
	integratedAddress - returns integrated address for current wallet address and given payment_id. if passed "payment_id" param is an empty string or not-valid payment id string (16 characters hexadecimal string) - random payment_id will be generated
virtual std::string	secretViewKey () const =0
	secretViewKey - returns secret view key
virtual std::string	publicViewKey () const =0
	publicViewKey - returns public view key
virtual std::string	secretSpendKey () const =0
	secretSpendKey - returns secret spend key
virtual std::string	publicSpendKey () const =0
	publicSpendKey - returns public spend key
virtual std::string	publicMultisigSignerKey () const =0
	publicMultisigSignerKey - returns public signer key
virtual void	stop ()=0
	stop - interrupts wallet refresh() loop once (doesn't stop background refresh thread)
virtual bool	store (const std::string &path)=0
	store - stores wallet to file.
virtual std::string	filename () const =0
	filename - returns wallet filename
virtual std::string	keysFilename () const =0
	keysFilename - returns keys filename. usually this formed as "wallet_filename".keys
virtual bool	init (const std::string &daemon_address, uint64_t upper_transaction_size_limit=0, const std::string &daemon_username="", const std::string &daemon_password="", bool use_ssl=false, bool lightWallet=false, const std::string &proxy_address="")=0
	init - initializes wallet with daemon connection params. if daemon_address is local address, "trusted daemon" will be set to true forcibly startRefresh() should be called when wallet is initialized.
virtual bool	createWatchOnly (const std::string &path, const std::string &password, const std::string &language) const =0
	createWatchOnly - Creates a watch only wallet
virtual void	setRefreshFromBlockHeight (uint64_t refresh_from_block_height)=0
	setRefreshFromBlockHeight - start refresh from block height on recover
virtual uint64_t	getRefreshFromBlockHeight () const =0
	getRestoreHeight - get wallet creation height
virtual void	setRecoveringFromSeed (bool recoveringFromSeed)=0
	setRecoveringFromSeed - set state recover form seed
virtual void	setRecoveringFromDevice (bool recoveringFromDevice)=0
	setRecoveringFromDevice - set state to recovering from device
virtual void	setSubaddressLookahead (uint32_t major, uint32_t minor)=0
	setSubaddressLookahead - set size of subaddress lookahead
virtual bool	connectToDaemon ()=0
	connectToDaemon - connects to the daemon. TODO: check if it can be removed
virtual ConnectionStatus	connected () const =0
	connected - checks if the wallet connected to the daemon
virtual void	setTrustedDaemon (bool arg)=0
virtual bool	trustedDaemon () const =0
virtual bool	setProxy (const std::string &address)=0
virtual uint64_t	balance (uint32_t accountIndex=0) const =0
uint64_t	balanceAll () const
virtual uint64_t	unlockedBalance (uint32_t accountIndex=0) const =0
uint64_t	unlockedBalanceAll () const
virtual bool	watchOnly () const =0
	watchOnly - checks if wallet is watch only
virtual bool	isDeterministic () const =0
	isDeterministic - checks if wallet keys are deterministic
virtual uint64_t	blockChainHeight () const =0
	blockChainHeight - returns current blockchain height
virtual uint64_t	approximateBlockChainHeight () const =0
	approximateBlockChainHeight - returns approximate blockchain height calculated from date/time
virtual uint64_t	estimateBlockChainHeight () const =0
	estimateBlockChainHeight - returns estimate blockchain height. More accurate than approximateBlockChainHeight, uses daemon height and falls back to calculation from date/time
virtual uint64_t	daemonBlockChainHeight () const =0
	daemonBlockChainHeight - returns daemon blockchain height
virtual uint64_t	daemonBlockChainTargetHeight () const =0
	daemonBlockChainTargetHeight - returns daemon blockchain target height
virtual bool	synchronized () const =0
	synchronized - checks if wallet was ever synchronized
virtual void	startRefresh ()=0
	StartRefresh - Start/resume refresh thread (refresh every 10 seconds).
virtual void	pauseRefresh ()=0
	pauseRefresh - pause refresh thread
virtual bool	refresh ()=0
	refresh - refreshes the wallet, updating transactions from daemon
virtual void	refreshAsync ()=0
	refreshAsync - refreshes wallet asynchronously.
virtual bool	rescanBlockchain ()=0
	rescanBlockchain - rescans the wallet, updating transactions from daemon
virtual void	rescanBlockchainAsync ()=0
	rescanBlockchainAsync - rescans wallet asynchronously, starting from genesys
virtual void	setAutoRefreshInterval (int millis)=0
	setAutoRefreshInterval - setup interval for automatic refresh.
virtual int	autoRefreshInterval () const =0
	autoRefreshInterval - returns automatic refresh interval in millis
virtual void	addSubaddressAccount (const std::string &label)=0
	addSubaddressAccount - appends a new subaddress account at the end of the last major index of existing subaddress accounts
virtual size_t	numSubaddressAccounts () const =0
	numSubaddressAccounts - returns the number of existing subaddress accounts
virtual size_t	numSubaddresses (uint32_t accountIndex) const =0
	numSubaddresses - returns the number of existing subaddresses associated with the specified subaddress account
virtual void	addSubaddress (uint32_t accountIndex, const std::string &label)=0
	addSubaddress - appends a new subaddress at the end of the last minor index of the specified subaddress account
virtual std::string	getSubaddressLabel (uint32_t accountIndex, uint32_t addressIndex) const =0
	getSubaddressLabel - gets the label of the specified subaddress
virtual void	setSubaddressLabel (uint32_t accountIndex, uint32_t addressIndex, const std::string &label)=0
	setSubaddressLabel - sets the label of the specified subaddress
virtual MultisigState	multisig () const =0
	multisig - returns current state of multisig wallet creation process
virtual std::string	getMultisigInfo () const =0
	getMultisigInfo
virtual std::string	makeMultisig (const std::vector< std::string > &info, uint32_t threshold)=0
	makeMultisig - switches wallet in multisig state. The one and only creation phase for N / N wallets
virtual std::string	exchangeMultisigKeys (const std::vector< std::string > &info, const bool force_update_use_with_caution)=0
	exchange_multisig_keys - provides additional key exchange round for arbitrary multisig schemes (like N-1/N, M/N)
virtual bool	exportMultisigImages (std::string &images)=0
	exportMultisigImages - exports transfers' key images
virtual size_t	importMultisigImages (const std::vector< std::string > &images)=0
	importMultisigImages - imports other participants' multisig images
virtual bool	hasMultisigPartialKeyImages () const =0
	hasMultisigPartialKeyImages - checks if wallet needs to import multisig key images from other participants
virtual PendingTransaction *	restoreMultisigTransaction (const std::string &signData)=0
	restoreMultisigTransaction creates PendingTransaction from signData
virtual PendingTransaction *	createTransactionMultDest (const std::vector< std::string > &dst_addr, const std::string &payment_id, optional< std::vector< uint64_t > > amount, uint32_t mixin_count, PendingTransaction::Priority=PendingTransaction::Priority_Low, uint32_t subaddr_account=0, std::set< uint32_t > subaddr_indices={})=0
	createTransactionMultDest creates transaction with multiple destinations. if dst_addr is an integrated address, payment_id is ignored
virtual PendingTransaction *	createTransaction (const std::string &dst_addr, const std::string &payment_id, optional< uint64_t > amount, uint32_t mixin_count, PendingTransaction::Priority=PendingTransaction::Priority_Low, uint32_t subaddr_account=0, std::set< uint32_t > subaddr_indices={})=0
	createTransaction creates transaction. if dst_addr is an integrated address, payment_id is ignored
virtual PendingTransaction *	createSweepUnmixableTransaction ()=0
	createSweepUnmixableTransaction creates transaction with unmixable outputs.
virtual UnsignedTransaction *	loadUnsignedTx (const std::string &unsigned_filename)=0
	loadUnsignedTx - creates transaction from unsigned tx file
virtual bool	submitTransaction (const std::string &fileName)=0
	submitTransaction - submits transaction in signed tx file
virtual void	disposeTransaction (PendingTransaction *t)=0
	disposeTransaction - destroys transaction object
virtual uint64_t	estimateTransactionFee (const std::vector< std::pair< std::string, uint64_t > > &destinations, PendingTransaction::Priority priority) const =0
	Estimates transaction fee.
virtual bool	exportKeyImages (const std::string &filename, bool all=false)=0
	exportKeyImages - exports key images to file
virtual bool	importKeyImages (const std::string &filename)=0
	importKeyImages - imports key images from file
virtual bool	exportOutputs (const std::string &filename, bool all=false)=0
	importOutputs - exports outputs to file
virtual bool	importOutputs (const std::string &filename)=0
	importOutputs - imports outputs from file
virtual bool	scanTransactions (const std::vector< std::string > &txids)=0
	scanTransactions - scan a list of transaction ids, this operation may reveal the txids to the remote node and affect your privacy
virtual bool	setupBackgroundSync (const BackgroundSyncType background_sync_type, const std::string &wallet_password, const optional< std::string > &background_cache_password)=0
	setupBackgroundSync - setup background sync mode with just a view key
virtual BackgroundSyncType	getBackgroundSyncType () const =0
	getBackgroundSyncType - get mode the wallet background syncs in
virtual bool	startBackgroundSync ()=0
	startBackgroundSync - sync the chain in the background with just view key
virtual bool	stopBackgroundSync (const std::string &wallet_password)=0
	stopBackgroundSync - bring back spend key and process background synced txs
virtual bool	isBackgroundSyncing () const =0
	isBackgroundSyncing - returns true if the wallet is background syncing
virtual bool	isBackgroundWallet () const =0
	isBackgroundWallet - returns true if the wallet is a background wallet
virtual TransactionHistory *	history ()=0
virtual AddressBook *	addressBook ()=0
virtual Subaddress *	subaddress ()=0
virtual SubaddressAccount *	subaddressAccount ()=0
virtual void	setListener (WalletListener *)=0
virtual uint32_t	defaultMixin () const =0
	defaultMixin - returns number of mixins used in transactions
virtual void	setDefaultMixin (uint32_t arg)=0
	setDefaultMixin - setum number of mixins to be used for new transactions
virtual bool	setCacheAttribute (const std::string &key, const std::string &val)=0
	setCacheAttribute - attach an arbitrary string to a wallet cache attribute
virtual std::string	getCacheAttribute (const std::string &key) const =0
	getCacheAttribute - return an arbitrary string attached to a wallet cache attribute
virtual bool	setUserNote (const std::string &txid, const std::string &note)=0
	setUserNote - attach an arbitrary string note to a txid
virtual std::string	getUserNote (const std::string &txid) const =0
	getUserNote - return an arbitrary string note attached to a txid
virtual std::string	getTxKey (const std::string &txid) const =0
virtual bool	checkTxKey (const std::string &txid, std::string tx_key, const std::string &address, uint64_t &received, bool &in_pool, uint64_t &confirmations)=0
virtual std::string	getTxProof (const std::string &txid, const std::string &address, const std::string &message) const =0
virtual bool	checkTxProof (const std::string &txid, const std::string &address, const std::string &message, const std::string &signature, bool &good, uint64_t &received, bool &in_pool, uint64_t &confirmations)=0
virtual std::string	getSpendProof (const std::string &txid, const std::string &message) const =0
virtual bool	checkSpendProof (const std::string &txid, const std::string &message, const std::string &signature, bool &good) const =0
virtual std::string	getReserveProof (bool all, uint32_t account_index, uint64_t amount, const std::string &message) const =0
	getReserveProof - Generates a proof that proves the reserve of unspent funds Parameters account_index and amount are ignored when all is true
virtual bool	checkReserveProof (const std::string &address, const std::string &message, const std::string &signature, bool &good, uint64_t &total, uint64_t &spent) const =0
virtual std::string	signMessage (const std::string &message, const std::string &address="")=0
virtual bool	verifySignedMessage (const std::string &message, const std::string &addres, const std::string &signature) const =0
	verifySignedMessage - verify a signature matches a given message
virtual std::string	signMultisigParticipant (const std::string &message) const =0
	signMultisigParticipant signs given message with the multisig public signer key
virtual bool	verifyMessageWithPublicKey (const std::string &message, const std::string &publicKey, const std::string &signature) const =0
	verifyMessageWithPublicKey verifies that message was signed with the given public key
virtual bool	parse_uri (const std::string &uri, std::string &address, std::string &payment_id, uint64_t &amount, std::string &tx_description, std::string &recipient_name, std::vector< std::string > &unknown_parameters, std::string &error)=0
virtual std::string	make_uri (const std::string &address, const std::string &payment_id, uint64_t amount, const std::string &tx_description, const std::string &recipient_name, std::string &error) const =0
virtual std::string	getDefaultDataDir () const =0
virtual bool	rescanSpent ()=0
virtual void	setOffline (bool offline)=0
virtual bool	isOffline () const =0
virtual bool	blackballOutputs (const std::vector< std::string > &outputs, bool add)=0
	blackballs a set of outputs
virtual bool	blackballOutput (const std::string &amount, const std::string &offset)=0
	blackballs an output
virtual bool	unblackballOutput (const std::string &amount, const std::string &offset)=0
	unblackballs an output
virtual bool	getRing (const std::string &key_image, std::vector< uint64_t > &ring) const =0
	gets the ring used for a key image, if any
virtual bool	getRings (const std::string &txid, std::vector< std::pair< std::string, std::vector< uint64_t > > > &rings) const =0
	gets the rings used for a txid, if any
virtual bool	setRing (const std::string &key_image, const std::vector< uint64_t > &ring, bool relative)=0
	sets the ring used for a key image
virtual void	segregatePreForkOutputs (bool segregate)=0
	sets whether pre-fork outs are to be segregated
virtual void	segregationHeight (uint64_t height)=0
	sets the height where segregation should occur
virtual void	keyReuseMitigation2 (bool mitigation)=0
	secondary key reuse mitigation
virtual bool	lightWalletLogin (bool &isNewWallet) const =0
	Light wallet authenticate and login.
virtual bool	lightWalletImportWalletRequest (std::string &payment_id, uint64_t &fee, bool &new_request, bool &request_fulfilled, std::string &payment_address, std::string &status)=0
	Initiates a light wallet import wallet request.
virtual bool	lockKeysFile ()=0
	locks/unlocks the keys file; returns true on success
virtual bool	unlockKeysFile ()=0
virtual bool	isKeysFileLocked ()=0
	returns true if the keys file is locked
virtual Device	getDeviceType () const =0
	Queries backing device for wallet keys.
virtual uint64_t	coldKeyImageSync (uint64_t &spent, uint64_t &unspent)=0
	cold-device protocol key image sync
virtual void	deviceShowAddress (uint32_t accountIndex, uint32_t addressIndex, const std::string &paymentId)=0
	shows address on device display
virtual bool	reconnectDevice ()=0
	attempt to reconnect to hardware device
virtual uint64_t	getBytesReceived ()=0
	get bytes received
virtual uint64_t	getBytesSent ()=0
	get bytes sent

Static Public Member Functions
static std::string	displayAmount (uint64_t amount)
static uint64_t	amountFromString (const std::string &amount)
static uint64_t	amountFromDouble (double amount)
static std::string	genPaymentId ()
static bool	paymentIdValid (const std::string &paiment_id)
static bool	addressValid (const std::string &str, NetworkType nettype)
static bool	addressValid (const std::string &str, bool testnet)
static bool	keyValid (const std::string &secret_key_string, const std::string &address_string, bool isViewKey, NetworkType nettype, std::string &error)
static bool	keyValid (const std::string &secret_key_string, const std::string &address_string, bool isViewKey, bool testnet, std::string &error)
static std::string	paymentIdFromAddress (const std::string &str, NetworkType nettype)
static std::string	paymentIdFromAddress (const std::string &str, bool testnet)
static uint64_t	maximumAllowedAmount ()
static void	init (const char argv0, const char default_log_base_name)
static void	init (const char argv0, const char default_log_base_name, const std::string &log_path, bool console)
static void	debug (const std::string &category, const std::string &str)
static void	info (const std::string &category, const std::string &str)
static void	warning (const std::string &category, const std::string &str)
static void	error (const std::string &category, const std::string &str)

Detailed Description

Interface for wallet operations.

Member Enumeration Documentation

◆ BackgroundSyncType

enum Monero::Wallet::BackgroundSyncType

Enumerator
BackgroundSync_Off
BackgroundSync_ReusePassword
BackgroundSync_CustomPassword

◆ ConnectionStatus

enum Monero::Wallet::ConnectionStatus

Enumerator
ConnectionStatus_Disconnected
ConnectionStatus_Connected
ConnectionStatus_WrongVersion

◆ Device

enum Monero::Wallet::Device

Enumerator
Device_Software
Device_Ledger
Device_Trezor

◆ Status

enum Monero::Wallet::Status

Enumerator
Status_Ok
Status_Error
Status_Critical

Constructor & Destructor Documentation

◆ ~Wallet()

Monero::Wallet::~Wallet ( )

pure virtual

Member Function Documentation

◆ address()

virtual std::string Monero::Wallet::address	(	uint32_t	accountIndex = 0,
		uint32_t	addressIndex = 0 ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ addressBook()

virtual AddressBook * Monero::Wallet::addressBook ( )

pure virtual

Implemented in Monero::WalletImpl.

◆ addressValid() [1/2]

bool Monero::Wallet::addressValid	(	const std::string &	str,
		bool	testnet )

inlinestatic

◆ addressValid() [2/2]

bool Monero::Wallet::addressValid	(	const std::string &	str,
		NetworkType	nettype )

static

◆ addSubaddress()

virtual void Monero::Wallet::addSubaddress	(	uint32_t	accountIndex,
		const std::string &	label )

pure virtual

addSubaddress - appends a new subaddress at the end of the last minor index of the specified subaddress account

Parameters

accountIndex	- the major index specifying the subaddress account
label	- the label for the new subaddress

Implemented in Monero::WalletImpl.

◆ addSubaddressAccount()

virtual void Monero::Wallet::addSubaddressAccount ( const std::string & label )

pure virtual

addSubaddressAccount - appends a new subaddress account at the end of the last major index of existing subaddress accounts

Parameters

label - the label for the new account (which is the as the label of the primary address (accountIndex,0))

Implemented in Monero::WalletImpl.

◆ amountFromDouble()

uint64_t Monero::Wallet::amountFromDouble ( double amount )

static

◆ amountFromString()

uint64_t Monero::Wallet::amountFromString ( const std::string & amount )

static

◆ approximateBlockChainHeight()

virtual uint64_t Monero::Wallet::approximateBlockChainHeight ( ) const

pure virtual

approximateBlockChainHeight - returns approximate blockchain height calculated from date/time

Returns

Implemented in Monero::WalletImpl.

◆ autoRefreshInterval()

virtual int Monero::Wallet::autoRefreshInterval ( ) const

pure virtual

autoRefreshInterval - returns automatic refresh interval in millis

Returns

Implemented in Monero::WalletImpl.

◆ balance()

virtual uint64_t Monero::Wallet::balance ( uint32_t accountIndex = 0 ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ balanceAll()

uint64_t Monero::Wallet::balanceAll ( ) const

inline

◆ blackballOutput()

virtual bool Monero::Wallet::blackballOutput	(	const std::string &	amount,
		const std::string &	offset )

pure virtual

blackballs an output

Implemented in Monero::WalletImpl.

◆ blackballOutputs()

virtual bool Monero::Wallet::blackballOutputs	(	const std::vector< std::string > &	outputs,
		bool	add )

pure virtual

blackballs a set of outputs

Implemented in Monero::WalletImpl.

◆ blockChainHeight()

virtual uint64_t Monero::Wallet::blockChainHeight ( ) const

pure virtual

blockChainHeight - returns current blockchain height

Returns

Implemented in Monero::WalletImpl.

◆ checkReserveProof()

virtual bool Monero::Wallet::checkReserveProof	(	const std::string &	address,
		const std::string &	message,
		const std::string &	signature,
		bool &	good,
		uint64_t &	total,
		uint64_t &	spent ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ checkSpendProof()

virtual bool Monero::Wallet::checkSpendProof	(	const std::string &	txid,
		const std::string &	message,
		const std::string &	signature,
		bool &	good ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ checkTxKey()

virtual bool Monero::Wallet::checkTxKey	(	const std::string &	txid,
		std::string	tx_key,
		const std::string &	address,
		uint64_t &	received,
		bool &	in_pool,
		uint64_t &	confirmations )

pure virtual

Implemented in Monero::WalletImpl.

◆ checkTxProof()

virtual bool Monero::Wallet::checkTxProof	(	const std::string &	txid,
		const std::string &	address,
		const std::string &	message,
		const std::string &	signature,
		bool &	good,
		uint64_t &	received,
		bool &	in_pool,
		uint64_t &	confirmations )

pure virtual

Implemented in Monero::WalletImpl.

◆ coldKeyImageSync()

virtual uint64_t Monero::Wallet::coldKeyImageSync	(	uint64_t &	spent,
		uint64_t &	unspent )

pure virtual

cold-device protocol key image sync

Implemented in Monero::WalletImpl.

◆ connected()

virtual ConnectionStatus Monero::Wallet::connected ( ) const

pure virtual

connected - checks if the wallet connected to the daemon

Returns: - true if connected

Implemented in Monero::WalletImpl.

◆ connectToDaemon()

virtual bool Monero::Wallet::connectToDaemon ( )

pure virtual

connectToDaemon - connects to the daemon. TODO: check if it can be removed

Returns

Implemented in Monero::WalletImpl.

◆ createSweepUnmixableTransaction()

virtual PendingTransaction * Monero::Wallet::createSweepUnmixableTransaction ( )

pure virtual

createSweepUnmixableTransaction creates transaction with unmixable outputs.

Returns: PendingTransaction object. caller is responsible to check PendingTransaction::status() after object returned

Implemented in Monero::WalletImpl.

◆ createTransaction()

virtual PendingTransaction * Monero::Wallet::createTransaction	(	const std::string &	dst_addr,
		const std::string &	payment_id,
		optional< uint64_t >	amount,
		uint32_t	mixin_count,
		PendingTransaction::Priority	= PendingTransaction::Priority_Low,
		uint32_t	subaddr_account = 0,
		std::set< uint32_t >	subaddr_indices = {} )

pure virtual

createTransaction creates transaction. if dst_addr is an integrated address, payment_id is ignored

Parameters

dst_addr	destination address as string
payment_id	optional payment_id, can be empty string
amount	amount
mixin_count	mixin count. if 0 passed, wallet will use default value
subaddr_account	subaddress account from which the input funds are taken
subaddr_indices	set of subaddress indices to use for transfer or sweeping. if set empty, all are chosen when sweeping, and one or more are automatically chosen when transferring. after execution, returns the set of actually used indices
priority

Returns: PendingTransaction object. caller is responsible to check PendingTransaction::status() after object returned

Implemented in Monero::WalletImpl.

◆ createTransactionMultDest()

virtual PendingTransaction * Monero::Wallet::createTransactionMultDest	(	const std::vector< std::string > &	dst_addr,
		const std::string &	payment_id,
		optional< std::vector< uint64_t > >	amount,
		uint32_t	mixin_count,
		PendingTransaction::Priority	= PendingTransaction::Priority_Low,
		uint32_t	subaddr_account = 0,
		std::set< uint32_t >	subaddr_indices = {} )

pure virtual

createTransactionMultDest creates transaction with multiple destinations. if dst_addr is an integrated address, payment_id is ignored

Parameters

dst_addr	vector of destination address as string
payment_id	optional payment_id, can be empty string
amount	vector of amounts
mixin_count	mixin count. if 0 passed, wallet will use default value
subaddr_account	subaddress account from which the input funds are taken
subaddr_indices	set of subaddress indices to use for transfer or sweeping. if set empty, all are chosen when sweeping, and one or more are automatically chosen when transferring. after execution, returns the set of actually used indices
priority

Returns: PendingTransaction object. caller is responsible to check PendingTransaction::status() after object returned

Implemented in Monero::WalletImpl.

◆ createWatchOnly()

virtual bool Monero::Wallet::createWatchOnly	(	const std::string &	path,
		const std::string &	password,
		const std::string &	language ) const

pure virtual

createWatchOnly - Creates a watch only wallet

Parameters

path	- where to store the wallet
password
language

Returns: - true if created successfully

Implemented in Monero::WalletImpl.

◆ daemonBlockChainHeight()

virtual uint64_t Monero::Wallet::daemonBlockChainHeight ( ) const

pure virtual

daemonBlockChainHeight - returns daemon blockchain height

Returns: 0 - in case error communicating with the daemon. status() will return Status_Error and errorString() will return verbose error description

Implemented in Monero::WalletImpl.

◆ daemonBlockChainTargetHeight()

virtual uint64_t Monero::Wallet::daemonBlockChainTargetHeight ( ) const

pure virtual

daemonBlockChainTargetHeight - returns daemon blockchain target height

Returns: 0 - in case error communicating with the daemon. status() will return Status_Error and errorString() will return verbose error description

Implemented in Monero::WalletImpl.

◆ debug()

void Monero::Wallet::debug	(	const std::string &	category,
		const std::string &	str )

static

◆ defaultMixin()

virtual uint32_t Monero::Wallet::defaultMixin ( ) const

pure virtual

defaultMixin - returns number of mixins used in transactions

Returns

Implemented in Monero::WalletImpl.

◆ deviceShowAddress()

virtual void Monero::Wallet::deviceShowAddress	(	uint32_t	accountIndex,
		uint32_t	addressIndex,
		const std::string &	paymentId )

pure virtual

shows address on device display

Implemented in Monero::WalletImpl.

◆ displayAmount()

string Monero::Wallet::displayAmount ( uint64_t amount )

static

◆ disposeTransaction()

virtual void Monero::Wallet::disposeTransaction ( PendingTransaction * t )

pure virtual

disposeTransaction - destroys transaction object

Parameters

t	- pointer to the "PendingTransaction" object. Pointer is not valid after function returned;

Implemented in Monero::WalletImpl.

◆ error()

void Monero::Wallet::error	(	const std::string &	category,
		const std::string &	str )

static

◆ errorString()

virtual std::string Monero::Wallet::errorString ( ) const

pure virtual

in case error status, returns error string

Implemented in Monero::WalletImpl.

◆ estimateBlockChainHeight()

virtual uint64_t Monero::Wallet::estimateBlockChainHeight ( ) const

pure virtual

estimateBlockChainHeight - returns estimate blockchain height. More accurate than approximateBlockChainHeight, uses daemon height and falls back to calculation from date/time

Returns

Implemented in Monero::WalletImpl.

◆ estimateTransactionFee()

virtual uint64_t Monero::Wallet::estimateTransactionFee	(	const std::vector< std::pair< std::string, uint64_t > > &	destinations,
		PendingTransaction::Priority	priority ) const

pure virtual

Estimates transaction fee.

Parameters

destinations Vector consisting of <address, amount> pairs.

Returns: Estimated fee.

Implemented in Monero::WalletImpl.

◆ exchangeMultisigKeys()

virtual std::string Monero::Wallet::exchangeMultisigKeys	(	const std::vector< std::string > &	info,
		const bool	force_update_use_with_caution )

pure virtual

exchange_multisig_keys - provides additional key exchange round for arbitrary multisig schemes (like N-1/N, M/N)

Parameters

info	- base58 encoded key derivations returned by makeMultisig or exchangeMultisigKeys function call
force_update_use_with_caution	- force multisig account to update even if not all signers contribute round messages

Returns: new info string if more rounds required or an empty string if wallet creation is done

Implemented in Monero::WalletImpl.

◆ exportKeyImages()

virtual bool Monero::Wallet::exportKeyImages	(	const std::string &	filename,
		bool	all = false )

pure virtual

exportKeyImages - exports key images to file

Parameters

filename
all	- export all key images or only those that have not yet been exported

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ exportMultisigImages()

virtual bool Monero::Wallet::exportMultisigImages ( std::string & images )

pure virtual

exportMultisigImages - exports transfers' key images

Parameters

images - output paramter for hex encoded array of images

Returns: true if success

Implemented in Monero::WalletImpl.

◆ exportOutputs()

virtual bool Monero::Wallet::exportOutputs	(	const std::string &	filename,
		bool	all = false )

pure virtual

importOutputs - exports outputs to file

Parameters

filename

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ filename()

virtual std::string Monero::Wallet::filename ( ) const

pure virtual

filename - returns wallet filename

Returns

Implemented in Monero::WalletImpl.

◆ genPaymentId()

std::string Monero::Wallet::genPaymentId ( )

static

◆ getBackgroundSyncType()

virtual BackgroundSyncType Monero::Wallet::getBackgroundSyncType ( ) const

pure virtual

getBackgroundSyncType - get mode the wallet background syncs in

Returns: - the type, or off if type is unknown

Implemented in Monero::WalletImpl.

◆ getBytesReceived()

virtual uint64_t Monero::Wallet::getBytesReceived ( )

pure virtual

get bytes received

Implemented in Monero::WalletImpl.

◆ getBytesSent()

virtual uint64_t Monero::Wallet::getBytesSent ( )

pure virtual

get bytes sent

Implemented in Monero::WalletImpl.

◆ getCacheAttribute()

virtual std::string Monero::Wallet::getCacheAttribute ( const std::string & key ) const

pure virtual

getCacheAttribute - return an arbitrary string attached to a wallet cache attribute

Parameters

key - the key

Returns: the attached string, or empty string if there is none

Implemented in Monero::WalletImpl.

◆ getDefaultDataDir()

virtual std::string Monero::Wallet::getDefaultDataDir ( ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ getDeviceType()

virtual Device Monero::Wallet::getDeviceType ( ) const

pure virtual

Queries backing device for wallet keys.

Returns: Device they are on

Implemented in Monero::WalletImpl.

◆ getMultisigInfo()

virtual std::string Monero::Wallet::getMultisigInfo ( ) const

pure virtual

getMultisigInfo

Returns: serialized and signed multisig info string

Implemented in Monero::WalletImpl.

◆ getPassword()

virtual const std::string & Monero::Wallet::getPassword ( ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ getRefreshFromBlockHeight()

virtual uint64_t Monero::Wallet::getRefreshFromBlockHeight ( ) const

pure virtual

getRestoreHeight - get wallet creation height

Implemented in Monero::WalletImpl.

◆ getReserveProof()

virtual std::string Monero::Wallet::getReserveProof	(	bool	all,
		uint32_t	account_index,
		uint64_t	amount,
		const std::string &	message ) const

pure virtual

getReserveProof - Generates a proof that proves the reserve of unspent funds Parameters account_index and amount are ignored when all is true

Implemented in Monero::WalletImpl.

◆ getRing()

virtual bool Monero::Wallet::getRing	(	const std::string &	key_image,
		std::vector< uint64_t > &	ring ) const

pure virtual

gets the ring used for a key image, if any

Implemented in Monero::WalletImpl.

◆ getRings()

virtual bool Monero::Wallet::getRings	(	const std::string &	txid,
		std::vector< std::pair< std::string, std::vector< uint64_t > > > &	rings ) const

pure virtual

gets the rings used for a txid, if any

Implemented in Monero::WalletImpl.

◆ getSeedLanguage()

virtual std::string Monero::Wallet::getSeedLanguage ( ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ getSpendProof()

virtual std::string Monero::Wallet::getSpendProof	(	const std::string &	txid,
		const std::string &	message ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ getSubaddressLabel()

virtual std::string Monero::Wallet::getSubaddressLabel	(	uint32_t	accountIndex,
		uint32_t	addressIndex ) const

pure virtual

getSubaddressLabel - gets the label of the specified subaddress

Parameters

accountIndex	- the major index specifying the subaddress account
addressIndex	- the minor index specifying the subaddress

Implemented in Monero::WalletImpl.

◆ getTxKey()

virtual std::string Monero::Wallet::getTxKey ( const std::string & txid ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ getTxProof()

virtual std::string Monero::Wallet::getTxProof	(	const std::string &	txid,
		const std::string &	address,
		const std::string &	message ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ getUserNote()

virtual std::string Monero::Wallet::getUserNote ( const std::string & txid ) const

pure virtual

getUserNote - return an arbitrary string note attached to a txid

Parameters

txid	- the transaction id to attach the note to

Returns: the attached note, or empty string if there is none

Implemented in Monero::WalletImpl.

◆ hardForkInfo()

virtual void Monero::Wallet::hardForkInfo	(	uint8_t &	version,
		uint64_t &	earliest_height ) const

pure virtual

returns current hard fork info

Implemented in Monero::WalletImpl.

◆ hasMultisigPartialKeyImages()

virtual bool Monero::Wallet::hasMultisigPartialKeyImages ( ) const

pure virtual

hasMultisigPartialKeyImages - checks if wallet needs to import multisig key images from other participants

Returns: true if there are partial key images

Implemented in Monero::WalletImpl.

◆ history()

virtual TransactionHistory * Monero::Wallet::history ( )

pure virtual

Implemented in Monero::WalletImpl.

◆ importKeyImages()

virtual bool Monero::Wallet::importKeyImages ( const std::string & filename )

pure virtual

importKeyImages - imports key images from file

Parameters

filename

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ importMultisigImages()

virtual size_t Monero::Wallet::importMultisigImages ( const std::vector< std::string > & images )

pure virtual

importMultisigImages - imports other participants' multisig images

Parameters

images - array of hex encoded arrays of images obtained with exportMultisigImages

Returns: number of imported images

Implemented in Monero::WalletImpl.

◆ importOutputs()

virtual bool Monero::Wallet::importOutputs ( const std::string & filename )

pure virtual

importOutputs - imports outputs from file

Parameters

filename

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ info()

void Monero::Wallet::info	(	const std::string &	category,
		const std::string &	str )

static

◆ init() [1/3]

void Monero::Wallet::init	(	const char *	argv0,
		const char *	default_log_base_name )

inlinestatic

◆ init() [2/3]

void Monero::Wallet::init	(	const char *	argv0,
		const char *	default_log_base_name,
		const std::string &	log_path,
		bool	console )

static

◆ init() [3/3]

virtual bool Monero::Wallet::init	(	const std::string &	daemon_address,
		uint64_t	upper_transaction_size_limit = 0,
		const std::string &	daemon_username = "",
		const std::string &	daemon_password = "",
		bool	use_ssl = false,
		bool	lightWallet = false,
		const std::string &	proxy_address = "" )

pure virtual

init - initializes wallet with daemon connection params. if daemon_address is local address, "trusted daemon" will be set to true forcibly startRefresh() should be called when wallet is initialized.

Parameters

daemon_address	- daemon address in "hostname:port" format
upper_transaction_size_limit
daemon_username
daemon_password
lightWallet	- start wallet in light mode, connect to a openmonero compatible server.
proxy_address	- set proxy address, empty string to disable

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ integratedAddress()

virtual std::string Monero::Wallet::integratedAddress ( const std::string & payment_id ) const

pure virtual

integratedAddress - returns integrated address for current wallet address and given payment_id. if passed "payment_id" param is an empty string or not-valid payment id string (16 characters hexadecimal string) - random payment_id will be generated

Parameters

payment_id - 16 characters hexadecimal string or empty string if new random payment id needs to be generated

Returns: - 106 characters string representing integrated address

Implemented in Monero::WalletImpl.

◆ isBackgroundSyncing()

virtual bool Monero::Wallet::isBackgroundSyncing ( ) const

pure virtual

isBackgroundSyncing - returns true if the wallet is background syncing

Implemented in Monero::WalletImpl.

◆ isBackgroundWallet()

virtual bool Monero::Wallet::isBackgroundWallet ( ) const

pure virtual

isBackgroundWallet - returns true if the wallet is a background wallet

Implemented in Monero::WalletImpl.

◆ isDeterministic()

virtual bool Monero::Wallet::isDeterministic ( ) const

pure virtual

isDeterministic - checks if wallet keys are deterministic

Returns: - true if deterministic

Implemented in Monero::WalletImpl.

◆ isKeysFileLocked()

virtual bool Monero::Wallet::isKeysFileLocked ( )

pure virtual

returns true if the keys file is locked

Implemented in Monero::WalletImpl.

◆ isOffline()

virtual bool Monero::Wallet::isOffline ( ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ keyReuseMitigation2()

virtual void Monero::Wallet::keyReuseMitigation2 ( bool mitigation )

pure virtual

secondary key reuse mitigation

Implemented in Monero::WalletImpl.

◆ keysFilename()

virtual std::string Monero::Wallet::keysFilename ( ) const

pure virtual

keysFilename - returns keys filename. usually this formed as "wallet_filename".keys

Returns

Implemented in Monero::WalletImpl.

◆ keyValid() [1/2]

bool Monero::Wallet::keyValid	(	const std::string &	secret_key_string,
		const std::string &	address_string,
		bool	isViewKey,
		bool	testnet,
		std::string &	error )

inlinestatic

◆ keyValid() [2/2]

bool Monero::Wallet::keyValid	(	const std::string &	secret_key_string,
		const std::string &	address_string,
		bool	isViewKey,
		NetworkType	nettype,
		std::string &	error )

static

◆ lightWalletImportWalletRequest()

virtual bool Monero::Wallet::lightWalletImportWalletRequest	(	std::string &	payment_id,
		uint64_t &	fee,
		bool &	new_request,
		bool &	request_fulfilled,
		std::string &	payment_address,
		std::string &	status )

pure virtual

Initiates a light wallet import wallet request.

Implemented in Monero::WalletImpl.

◆ lightWalletLogin()

virtual bool Monero::Wallet::lightWalletLogin ( bool & isNewWallet ) const

pure virtual

Light wallet authenticate and login.

Implemented in Monero::WalletImpl.

◆ loadUnsignedTx()

virtual UnsignedTransaction * Monero::Wallet::loadUnsignedTx ( const std::string & unsigned_filename )

pure virtual

loadUnsignedTx - creates transaction from unsigned tx file

Returns: - UnsignedTransaction object. caller is responsible to check UnsignedTransaction::status() after object returned

Implemented in Monero::WalletImpl.

◆ lockKeysFile()

virtual bool Monero::Wallet::lockKeysFile ( )

pure virtual

locks/unlocks the keys file; returns true on success

Implemented in Monero::WalletImpl.

◆ mainAddress()

std::string Monero::Wallet::mainAddress ( ) const

inline

◆ mainnet()

bool Monero::Wallet::mainnet ( ) const

inline

◆ make_uri()

virtual std::string Monero::Wallet::make_uri	(	const std::string &	address,
		const std::string &	payment_id,
		uint64_t	amount,
		const std::string &	tx_description,
		const std::string &	recipient_name,
		std::string &	error ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ makeMultisig()

virtual std::string Monero::Wallet::makeMultisig	(	const std::vector< std::string > &	info,
		uint32_t	threshold )

pure virtual

makeMultisig - switches wallet in multisig state. The one and only creation phase for N / N wallets

Parameters

info	- vector of multisig infos from other participants obtained with getMulitisInfo call
threshold	- number of required signers to make valid transaction. Must be <= number of participants

Returns: in case of N / N wallets returns empty string since no more key exchanges needed. For N - 1 / N wallets returns base58 encoded extra multisig info

Implemented in Monero::WalletImpl.

◆ maximumAllowedAmount()

uint64_t Monero::Wallet::maximumAllowedAmount ( )

static

◆ multisig()

virtual MultisigState Monero::Wallet::multisig ( ) const

pure virtual

multisig - returns current state of multisig wallet creation process

Returns: MultisigState struct

Implemented in Monero::WalletImpl.

◆ nettype()

virtual NetworkType Monero::Wallet::nettype ( ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ numSubaddressAccounts()

virtual size_t Monero::Wallet::numSubaddressAccounts ( ) const

pure virtual

numSubaddressAccounts - returns the number of existing subaddress accounts

Implemented in Monero::WalletImpl.

◆ numSubaddresses()

virtual size_t Monero::Wallet::numSubaddresses ( uint32_t accountIndex ) const

pure virtual

numSubaddresses - returns the number of existing subaddresses associated with the specified subaddress account

Parameters

accountIndex - the major index specifying the subaddress account

Implemented in Monero::WalletImpl.

◆ parse_uri()

virtual bool Monero::Wallet::parse_uri	(	const std::string &	uri,
		std::string &	address,
		std::string &	payment_id,
		uint64_t &	amount,
		std::string &	tx_description,
		std::string &	recipient_name,
		std::vector< std::string > &	unknown_parameters,
		std::string &	error )

pure virtual

Implemented in Monero::WalletImpl.

◆ path()

virtual std::string Monero::Wallet::path ( ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ pauseRefresh()

virtual void Monero::Wallet::pauseRefresh ( )

pure virtual

pauseRefresh - pause refresh thread

Implemented in Monero::WalletImpl.

◆ paymentIdFromAddress() [1/2]

std::string Monero::Wallet::paymentIdFromAddress	(	const std::string &	str,
		bool	testnet )

inlinestatic

◆ paymentIdFromAddress() [2/2]

std::string Monero::Wallet::paymentIdFromAddress	(	const std::string &	str,
		NetworkType	nettype )

static

◆ paymentIdValid()

bool Monero::Wallet::paymentIdValid ( const std::string & paiment_id )

static

◆ publicMultisigSignerKey()

virtual std::string Monero::Wallet::publicMultisigSignerKey ( ) const

pure virtual

publicMultisigSignerKey - returns public signer key

Returns: - public multisignature signer key or empty string if wallet is not multisig

Implemented in Monero::WalletImpl.

◆ publicSpendKey()

virtual std::string Monero::Wallet::publicSpendKey ( ) const

pure virtual

publicSpendKey - returns public spend key

Returns: - public spend key

Implemented in Monero::WalletImpl.

◆ publicViewKey()

virtual std::string Monero::Wallet::publicViewKey ( ) const

pure virtual

publicViewKey - returns public view key

Returns: - public view key

Implemented in Monero::WalletImpl.

◆ reconnectDevice()

virtual bool Monero::Wallet::reconnectDevice ( )

pure virtual

attempt to reconnect to hardware device

Implemented in Monero::WalletImpl.

◆ refresh()

virtual bool Monero::Wallet::refresh ( )

pure virtual

refresh - refreshes the wallet, updating transactions from daemon

Returns: - true if refreshed successfully;

Implemented in Monero::WalletImpl.

◆ refreshAsync()

virtual void Monero::Wallet::refreshAsync ( )

pure virtual

refreshAsync - refreshes wallet asynchronously.

Implemented in Monero::WalletImpl.

◆ rescanBlockchain()

virtual bool Monero::Wallet::rescanBlockchain ( )

pure virtual

rescanBlockchain - rescans the wallet, updating transactions from daemon

Returns: - true if refreshed successfully;

Implemented in Monero::WalletImpl.

◆ rescanBlockchainAsync()

virtual void Monero::Wallet::rescanBlockchainAsync ( )

pure virtual

rescanBlockchainAsync - rescans wallet asynchronously, starting from genesys

Implemented in Monero::WalletImpl.

◆ rescanSpent()

virtual bool Monero::Wallet::rescanSpent ( )

pure virtual

Implemented in Monero::WalletImpl.

◆ restoreMultisigTransaction()

virtual PendingTransaction * Monero::Wallet::restoreMultisigTransaction ( const std::string & signData )

pure virtual

restoreMultisigTransaction creates PendingTransaction from signData

Parameters

signData encrypted unsigned transaction. Obtained with PendingTransaction::multisigSignData

Returns: PendingTransaction

Implemented in Monero::WalletImpl.

◆ scanTransactions()

virtual bool Monero::Wallet::scanTransactions ( const std::vector< std::string > & txids )

pure virtual

scanTransactions - scan a list of transaction ids, this operation may reveal the txids to the remote node and affect your privacy

Parameters

txids - list of transaction ids

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ secretSpendKey()

virtual std::string Monero::Wallet::secretSpendKey ( ) const

pure virtual

secretSpendKey - returns secret spend key

Returns: - secret spend key

Implemented in Monero::WalletImpl.

◆ secretViewKey()

virtual std::string Monero::Wallet::secretViewKey ( ) const

pure virtual

secretViewKey - returns secret view key

Returns: - secret view key

Implemented in Monero::WalletImpl.

◆ seed()

virtual std::string Monero::Wallet::seed ( const std::string & seed_offset = "" ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ segregatePreForkOutputs()

virtual void Monero::Wallet::segregatePreForkOutputs ( bool segregate )

pure virtual

sets whether pre-fork outs are to be segregated

Implemented in Monero::WalletImpl.

◆ segregationHeight()

virtual void Monero::Wallet::segregationHeight ( uint64_t height )

pure virtual

sets the height where segregation should occur

Implemented in Monero::WalletImpl.

◆ setAutoRefreshInterval()

virtual void Monero::Wallet::setAutoRefreshInterval ( int millis )

pure virtual

setAutoRefreshInterval - setup interval for automatic refresh.

Parameters

seconds - interval in millis. if zero or less than zero - automatic refresh disabled;

Implemented in Monero::WalletImpl.

◆ setCacheAttribute()

virtual bool Monero::Wallet::setCacheAttribute	(	const std::string &	key,
		const std::string &	val )

pure virtual

setCacheAttribute - attach an arbitrary string to a wallet cache attribute

Parameters

key	- the key
val	- the value

Returns: true if successful, false otherwise

Implemented in Monero::WalletImpl.

◆ setDefaultMixin()

virtual void Monero::Wallet::setDefaultMixin ( uint32_t arg )

pure virtual

setDefaultMixin - setum number of mixins to be used for new transactions

Parameters

arg

Implemented in Monero::WalletImpl.

◆ setDevicePassphrase()

virtual bool Monero::Wallet::setDevicePassphrase ( const std::string & passphrase )

inlinevirtual

Reimplemented in Monero::WalletImpl.

◆ setDevicePin()

virtual bool Monero::Wallet::setDevicePin ( const std::string & pin )

inlinevirtual

Reimplemented in Monero::WalletImpl.

◆ setListener()

virtual void Monero::Wallet::setListener ( WalletListener * )

pure virtual

Implemented in Monero::WalletImpl.

◆ setOffline()

virtual void Monero::Wallet::setOffline ( bool offline )

pure virtual

Implemented in Monero::WalletImpl.

◆ setPassword()

virtual bool Monero::Wallet::setPassword ( const std::string & password )

pure virtual

Implemented in Monero::WalletImpl.

◆ setProxy()

virtual bool Monero::Wallet::setProxy ( const std::string & address )

pure virtual

Implemented in Monero::WalletImpl.

◆ setRecoveringFromDevice()

virtual void Monero::Wallet::setRecoveringFromDevice ( bool recoveringFromDevice )

pure virtual

setRecoveringFromDevice - set state to recovering from device

Parameters

recoveringFromDevice - true/false

Implemented in Monero::WalletImpl.

◆ setRecoveringFromSeed()

virtual void Monero::Wallet::setRecoveringFromSeed ( bool recoveringFromSeed )

pure virtual

setRecoveringFromSeed - set state recover form seed

Parameters

recoveringFromSeed - true/false

Implemented in Monero::WalletImpl.

◆ setRefreshFromBlockHeight()

virtual void Monero::Wallet::setRefreshFromBlockHeight ( uint64_t refresh_from_block_height )

pure virtual

setRefreshFromBlockHeight - start refresh from block height on recover

Parameters

refresh_from_block_height - blockchain start height

Implemented in Monero::WalletImpl.

◆ setRing()

virtual bool Monero::Wallet::setRing	(	const std::string &	key_image,
		const std::vector< uint64_t > &	ring,
		bool	relative )

pure virtual

sets the ring used for a key image

Implemented in Monero::WalletImpl.

◆ setSeedLanguage()

virtual void Monero::Wallet::setSeedLanguage ( const std::string & arg )

pure virtual

Implemented in Monero::WalletImpl.

◆ setSubaddressLabel()

virtual void Monero::Wallet::setSubaddressLabel	(	uint32_t	accountIndex,
		uint32_t	addressIndex,
		const std::string &	label )

pure virtual

setSubaddressLabel - sets the label of the specified subaddress

Parameters

accountIndex	- the major index specifying the subaddress account
addressIndex	- the minor index specifying the subaddress
label	- the new label for the specified subaddress

Implemented in Monero::WalletImpl.

◆ setSubaddressLookahead()

virtual void Monero::Wallet::setSubaddressLookahead	(	uint32_t	major,
		uint32_t	minor )

pure virtual

setSubaddressLookahead - set size of subaddress lookahead

Parameters

major	- size fot the major index
minor	- size fot the minor index

Implemented in Monero::WalletImpl.

◆ setTrustedDaemon()

virtual void Monero::Wallet::setTrustedDaemon ( bool arg )

pure virtual

Implemented in Monero::WalletImpl.

◆ setupBackgroundSync()

virtual bool Monero::Wallet::setupBackgroundSync	(	const BackgroundSyncType	background_sync_type,
		const std::string &	wallet_password,
		const optional< std::string > &	background_cache_password )

pure virtual

setupBackgroundSync - setup background sync mode with just a view key

Parameters

background_sync_type	- the mode the wallet background syncs in
wallet_password
background_cache_password	- custom password to encrypt background cache, only needed for custom password background sync type

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ setUserNote()

virtual bool Monero::Wallet::setUserNote	(	const std::string &	txid,
		const std::string &	note )

pure virtual

setUserNote - attach an arbitrary string note to a txid

Parameters

txid	- the transaction id to attach the note to
note	- the note

Returns: true if successful, false otherwise

Implemented in Monero::WalletImpl.

◆ signMessage()

virtual std::string Monero::Wallet::signMessage	(	const std::string &	message,
		const std::string &	address = "" )

pure virtual

Implemented in Monero::WalletImpl.

◆ signMultisigParticipant()

virtual std::string Monero::Wallet::signMultisigParticipant ( const std::string & message ) const

pure virtual

signMultisigParticipant signs given message with the multisig public signer key

Parameters

message message to sign

Returns: signature in case of success. Sets status to Error and return empty string in case of error

Implemented in Monero::WalletImpl.

◆ stagenet()

bool Monero::Wallet::stagenet ( ) const

inline

◆ startBackgroundSync()

virtual bool Monero::Wallet::startBackgroundSync ( )

pure virtual

startBackgroundSync - sync the chain in the background with just view key

Implemented in Monero::WalletImpl.

◆ startRefresh()

virtual void Monero::Wallet::startRefresh ( )

pure virtual

StartRefresh - Start/resume refresh thread (refresh every 10 seconds).

Implemented in Monero::WalletImpl.

◆ status()

virtual int Monero::Wallet::status ( ) const

pure virtual

returns wallet status (Status_Ok | Status_Error)

Implemented in Monero::WalletImpl.

◆ statusWithErrorString()

virtual void Monero::Wallet::statusWithErrorString	(	int &	status,
		std::string &	errorString ) const

pure virtual

returns both error and error string atomically. suggested to use in instead of status() and errorString()

Implemented in Monero::WalletImpl.

◆ stop()

virtual void Monero::Wallet::stop ( )

pure virtual

stop - interrupts wallet refresh() loop once (doesn't stop background refresh thread)

Implemented in Monero::WalletImpl.

◆ stopBackgroundSync()

virtual bool Monero::Wallet::stopBackgroundSync ( const std::string & wallet_password )

pure virtual

stopBackgroundSync - bring back spend key and process background synced txs

Parameters

wallet_password

Implemented in Monero::WalletImpl.

◆ store()

virtual bool Monero::Wallet::store ( const std::string & path )

pure virtual

store - stores wallet to file.

Parameters

path	- main filename to store wallet to. additionally stores address file and keys file. to store to the same file - just pass empty string;

Returns

Implemented in Monero::WalletImpl.

◆ subaddress()

virtual Subaddress * Monero::Wallet::subaddress ( )

pure virtual

Implemented in Monero::WalletImpl.

◆ subaddressAccount()

virtual SubaddressAccount * Monero::Wallet::subaddressAccount ( )

pure virtual

Implemented in Monero::WalletImpl.

◆ submitTransaction()

virtual bool Monero::Wallet::submitTransaction ( const std::string & fileName )

pure virtual

submitTransaction - submits transaction in signed tx file

Returns: - true on success

Implemented in Monero::WalletImpl.

◆ synchronized()

virtual bool Monero::Wallet::synchronized ( ) const

pure virtual

synchronized - checks if wallet was ever synchronized

Returns

Implemented in Monero::WalletImpl.

◆ testnet()

bool Monero::Wallet::testnet ( ) const

inline

◆ trustedDaemon()

virtual bool Monero::Wallet::trustedDaemon ( ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ unblackballOutput()

virtual bool Monero::Wallet::unblackballOutput	(	const std::string &	amount,
		const std::string &	offset )

pure virtual

unblackballs an output

Implemented in Monero::WalletImpl.

◆ unlockedBalance()

virtual uint64_t Monero::Wallet::unlockedBalance ( uint32_t accountIndex = 0 ) const

pure virtual

Implemented in Monero::WalletImpl.

◆ unlockedBalanceAll()

uint64_t Monero::Wallet::unlockedBalanceAll ( ) const

inline

◆ unlockKeysFile()

virtual bool Monero::Wallet::unlockKeysFile ( )

pure virtual

Implemented in Monero::WalletImpl.

◆ useForkRules()

virtual bool Monero::Wallet::useForkRules	(	uint8_t	version,
		int64_t	early_blocks ) const

pure virtual

check if hard fork rules should be used

Implemented in Monero::WalletImpl.

◆ verifyMessageWithPublicKey()

virtual bool Monero::Wallet::verifyMessageWithPublicKey	(	const std::string &	message,
		const std::string &	publicKey,
		const std::string &	signature ) const

pure virtual

verifyMessageWithPublicKey verifies that message was signed with the given public key

Parameters

message	message
publicKey	hex encoded public key
signature	signature of the message

Returns: true if the signature is correct. false and sets error state in case of error

Implemented in Monero::WalletImpl.

◆ verifySignedMessage()

virtual bool Monero::Wallet::verifySignedMessage	(	const std::string &	message,
		const std::string &	addres,
		const std::string &	signature ) const

pure virtual

verifySignedMessage - verify a signature matches a given message

Parameters

message	- the message (arbitrary byte data)
address	- the address the signature claims to be made with
signature	- the signature

Returns: true if the signature verified, false otherwise

Implemented in Monero::WalletImpl.

◆ warning()

void Monero::Wallet::warning	(	const std::string &	category,
		const std::string &	str )

static

◆ watchOnly()

virtual bool Monero::Wallet::watchOnly ( ) const

pure virtual

watchOnly - checks if wallet is watch only

Returns: - true if watch only

Implemented in Monero::WalletImpl.

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

src/wallet/api/wallet2_api.h
src/wallet/api/wallet.cpp

Public Types

Public Member Functions

Static Public Member Functions

Detailed Description

Member Enumeration Documentation

◆ BackgroundSyncType

◆ ConnectionStatus

◆ Device

◆ Status

Constructor & Destructor Documentation

◆ ~Wallet()

Member Function Documentation

◆ address()

◆ addressBook()

◆ addressValid() [1/2]

◆ addressValid() [2/2]

◆ addSubaddress()

◆ addSubaddressAccount()

◆ amountFromDouble()

◆ amountFromString()

◆ approximateBlockChainHeight()

◆ autoRefreshInterval()

◆ balance()

◆ balanceAll()

◆ blackballOutput()

◆ blackballOutputs()

◆ blockChainHeight()

◆ checkReserveProof()

◆ checkSpendProof()

◆ checkTxKey()

◆ checkTxProof()

◆ coldKeyImageSync()

◆ connected()

◆ connectToDaemon()

◆ createSweepUnmixableTransaction()

◆ createTransaction()

◆ createTransactionMultDest()

◆ createWatchOnly()

◆ daemonBlockChainHeight()

◆ daemonBlockChainTargetHeight()

◆ debug()

◆ defaultMixin()

◆ deviceShowAddress()

◆ displayAmount()

◆ disposeTransaction()

◆ error()

◆ errorString()

◆ estimateBlockChainHeight()

◆ estimateTransactionFee()

◆ exchangeMultisigKeys()

◆ exportKeyImages()

◆ exportMultisigImages()

◆ exportOutputs()

◆ filename()

◆ genPaymentId()

◆ getBackgroundSyncType()

◆ getBytesReceived()

◆ getBytesSent()

◆ getCacheAttribute()

◆ getDefaultDataDir()

◆ getDeviceType()

◆ getMultisigInfo()

◆ getPassword()

◆ getRefreshFromBlockHeight()

◆ getReserveProof()

◆ getRing()

◆ getRings()

◆ getSeedLanguage()

◆ getSpendProof()

◆ getSubaddressLabel()

◆ getTxKey()

◆ getTxProof()

◆ getUserNote()

◆ hardForkInfo()

◆ hasMultisigPartialKeyImages()

◆ history()

◆ importKeyImages()

◆ importMultisigImages()

◆ importOutputs()

◆ info()