framework.wallet.Wallet Class Reference

Inheritance diagram for framework.wallet.Wallet:

Collaboration diagram for framework.wallet.Wallet:

Classes
class	BackgroundSyncOptions

Public Member Functions
	__init__ (self, protocol='http', host='127.0.0.1', port=0, idx=0)
	transfer (self, destinations, account_index=0, subaddr_indices=[], priority=0, ring_size=0, unlock_time=0, payment_id='', get_tx_key=True, do_not_relay=False, get_tx_hex=False, get_tx_metadata=False, subtract_fee_from_outputs=[])
	transfer_split (self, destinations, account_index=0, subaddr_indices=[], priority=0, ring_size=0, unlock_time=0, payment_id='', get_tx_key=True, do_not_relay=False, get_tx_hex=False, get_tx_metadata=False)
	get_transfer_by_txid (self, txid, account_index=0)
	get_payments (self, payment_id)
	get_bulk_payments (self, payment_ids=[], min_block_height=0)
	describe_transfer (self, unsigned_txset='', multisig_txset='')
	create_wallet (self, filename='', password='', language='English')
	get_balance (self, account_index=0, address_indices=[], all_accounts=False, strict=False)
	sweep_dust (self, get_tx_keys=True, do_not_relay=False, get_tx_hex=False, get_tx_metadata=False)
	sweep_all (self, address='', account_index=0, subaddr_indices=[], priority=0, ring_size=0, outputs=1, unlock_time=0, payment_id='', get_tx_keys=False, below_amount=0, do_not_relay=False, get_tx_hex=False, get_tx_metadata=False)
	sweep_single (self, address='', priority=0, ring_size=0, outputs=1, unlock_time=0, payment_id='', get_tx_keys=False, key_image="", do_not_relay=False, get_tx_hex=False, get_tx_metadata=False)
	get_address (self, account_index=0, subaddresses=[])
	create_account (self, label="")
	create_address (self, account_index=0, label="", count=1)
	label_address (self, subaddress_index, label)
	label_account (self, account_index, label)
	get_address_index (self, address)
	query_key (self, key_type)
	restore_deterministic_wallet (self, seed='', seed_offset='', filename='', restore_height=0, password='', language='', autosave_current=True, enable_multisig_experimental=False)
	generate_from_keys (self, restore_height=0, filename="", password="", address="", spendkey="", viewkey="", autosave_current=True)
	set_subaddress_lookahead (self, int major_idx, int minor_idx, password="")
	open_wallet (self, filename, password='', autosave_current=True)
	close_wallet (self, autosave_current=True)
	change_wallet_password (self, old_password, new_password)
	store (self)
	stop_wallet (self)
	refresh (self)
	incoming_transfers (self, transfer_type='all', account_index=0, subaddr_indices=[])
	get_transfers (self, in_=True, out=True, pending=True, failed=True, pool=True, min_height=None, max_height=None, account_index=0, subaddr_indices=[], all_accounts=False)
	make_integrated_address (self, standard_address='', payment_id='')
	split_integrated_address (self, integrated_address)
	auto_refresh (self, enable, period=0)
	set_daemon (self, address, trusted=False, ssl_support="autodetect", ssl_private_key_path="", ssl_certificate_path="", ssl_allowed_certificates=[], ssl_allowed_fingerprints=[], ssl_allow_any_cert=False)
	is_multisig (self)
	prepare_multisig (self, enable_multisig_experimental=False)
	make_multisig (self, multisig_info, threshold, password='')
	finalize_multisig (self)
	exchange_multisig_keys (self, multisig_info, password='', force_update_use_with_caution=False)
	export_multisig_info (self)
	import_multisig_info (self, info=[])
	sign_multisig (self, tx_data_hex)
	submit_multisig (self, tx_data_hex)
	sign_transfer (self, unsigned_txset, export_raw=False, get_tx_keys=False)
	submit_transfer (self, tx_data_hex)
	get_tx_key (self, txid)
	check_tx_key (self, txid='', tx_key='', address='')
	get_tx_proof (self, txid='', address='', message='')
	check_tx_proof (self, txid='', address='', message='', signature='')
	get_spend_proof (self, txid='', message='')
	check_spend_proof (self, txid='', message='', signature='')
	get_reserve_proof (self, all_=True, account_index=0, amount=0, message='')
	check_reserve_proof (self, address='', message='', signature='')
	sign (self, data, account_index=0, address_index=0, signature_type="")
	verify (self, data, address, signature)
	get_height (self)
	relay_tx (self, hex_)
	get_languages (self)
	export_outputs (self, all=False, start=0, count=0xffffffff)
	import_outputs (self, outputs_data_hex)
	export_key_images (self, all_=False)
	import_key_images (self, signed_key_images, offset=0)
	set_log_level (self, level)
	set_log_categories (self, categories)
	validate_address (self, address, any_net_type=False, allow_openalias=False)
	get_accounts (self, tag, strict_balances=False)
	get_account_tags (self)
	tag_accounts (self, tag, accounts=[])
	untag_accounts (self, accounts=[])
	set_account_tag_description (self, tag, description)
	rescan_blockchain (self, hard=False)
	rescan_spent (self)
	set_tx_notes (self, txids=[], notes=[])
	get_tx_notes (self, txids=[])
	set_attribute (self, key, value)
	get_attribute (self, key)
	make_uri (self, address='', payment_id='', amount=0, tx_description='', recipient_name='')
	parse_uri (self, uri)
	add_address_book (self, address='', payment_id='', description='')
	edit_address_book (self, index, address=None, payment_id=None, description=None)
	get_address_book (self, entries=[])
	delete_address_book (self, index)
	start_mining (self, threads_count, do_background_mining=False, ignore_battery=False)
	stop_mining (self)
	estimate_tx_size_and_weight (self, n_inputs, n_outputs, ring_size=0, rct=True)
	get_default_fee_priority (self)
	get_version (self)
	scan_tx (self, txids)
	freeze (self, key_image)
	thaw (self, key_image)
	frozen (self, key_image)
	setup_background_sync (self, background_sync_type=background_sync_options.off, wallet_password='', background_cache_password='')
	start_background_sync (self)
	stop_background_sync (self, wallet_password='', seed='', seed_offset='')

Public Attributes
	host = host
	port = port
	rpc = JSONRPC('{protocol}://{host}:{port}'.format(protocol=protocol, host=host, port=port if port else 18090+idx))

Static Public Attributes
	getbalance = get_balance
	sweep_unmixable = sweep_dust
	getaddress = get_address
	getheight = get_height
	background_sync_options

Constructor & Destructor Documentation

__init__()

framework.wallet.Wallet.__init__	(		self,
			protocol = 'http',
			host = '127.0.0.1',
			port = 0,
			idx = 0 )

Member Function Documentation

add_address_book()

framework.wallet.Wallet.add_address_book	(		self,
			address = '',
			payment_id = '',
			description = '' )

auto_refresh()

framework.wallet.Wallet.auto_refresh	(		self,
			enable,
			period = 0 )

change_wallet_password()

framework.wallet.Wallet.change_wallet_password	(		self,
			old_password,
			new_password )

check_reserve_proof()

framework.wallet.Wallet.check_reserve_proof	(		self,
			address = '',
			message = '',
			signature = '' )

check_spend_proof()

framework.wallet.Wallet.check_spend_proof	(		self,
			txid = '',
			message = '',
			signature = '' )

check_tx_key()

framework.wallet.Wallet.check_tx_key	(		self,
			txid = '',
			tx_key = '',
			address = '' )

check_tx_proof()

framework.wallet.Wallet.check_tx_proof	(		self,
			txid = '',
			address = '',
			message = '',
			signature = '' )

close_wallet()

framework.wallet.Wallet.close_wallet	(		self,
			autosave_current = True )

create_account()

framework.wallet.Wallet.create_account	(		self,
			label = "" )

create_address()

framework.wallet.Wallet.create_address	(		self,
			account_index = 0,
			label = "",
			count = 1 )

create_wallet()

framework.wallet.Wallet.create_wallet	(		self,
			filename = '',
			password = '',
			language = 'English' )

delete_address_book()

framework.wallet.Wallet.delete_address_book	(		self,
			index )

describe_transfer()

framework.wallet.Wallet.describe_transfer	(		self,
			unsigned_txset = '',
			multisig_txset = '' )

edit_address_book()

framework.wallet.Wallet.edit_address_book	(		self,
			index,
			address = None,
			payment_id = None,
			description = None )

estimate_tx_size_and_weight()

framework.wallet.Wallet.estimate_tx_size_and_weight	(		self,
			n_inputs,
			n_outputs,
			ring_size = 0,
			rct = True )

exchange_multisig_keys()

framework.wallet.Wallet.exchange_multisig_keys	(		self,
			multisig_info,
			password = '',
			force_update_use_with_caution = False )

export_key_images()

framework.wallet.Wallet.export_key_images	(		self,
			all_ = False )

export_multisig_info()

framework.wallet.Wallet.export_multisig_info

(

self

)

export_outputs()

framework.wallet.Wallet.export_outputs	(		self,
			all = False,
			start = 0,
			count = 0xffffffff )

finalize_multisig()

framework.wallet.Wallet.finalize_multisig

(

self

)

freeze()

framework.wallet.Wallet.freeze	(		self,
			key_image )

frozen()

framework.wallet.Wallet.frozen	(		self,
			key_image )

generate_from_keys()

framework.wallet.Wallet.generate_from_keys	(		self,
			restore_height = 0,
			filename = "",
			password = "",
			address = "",
			spendkey = "",
			viewkey = "",
			autosave_current = True )

get_account_tags()

framework.wallet.Wallet.get_account_tags

(

self

)

get_accounts()

framework.wallet.Wallet.get_accounts	(		self,
			tag,
			strict_balances = False )

get_address()

framework.wallet.Wallet.get_address	(		self,
			account_index = 0,
			subaddresses = [] )

get_address_book()

framework.wallet.Wallet.get_address_book	(		self,
			entries = [] )

get_address_index()

framework.wallet.Wallet.get_address_index	(		self,
			address )

get_attribute()

framework.wallet.Wallet.get_attribute	(		self,
			key )

get_balance()

framework.wallet.Wallet.get_balance	(		self,
			account_index = 0,
			address_indices = [],
			all_accounts = False,
			strict = False )

get_bulk_payments()

framework.wallet.Wallet.get_bulk_payments	(		self,
			payment_ids = [],
			min_block_height = 0 )

get_default_fee_priority()

framework.wallet.Wallet.get_default_fee_priority

(

self

)

get_height()

framework.wallet.Wallet.get_height

(

self

)

get_languages()

framework.wallet.Wallet.get_languages

(

self

)

get_payments()

framework.wallet.Wallet.get_payments	(		self,
			payment_id )

get_reserve_proof()

framework.wallet.Wallet.get_reserve_proof	(		self,
			all_ = True,
			account_index = 0,
			amount = 0,
			message = '' )

get_spend_proof()

framework.wallet.Wallet.get_spend_proof	(		self,
			txid = '',
			message = '' )

get_transfer_by_txid()

framework.wallet.Wallet.get_transfer_by_txid	(		self,
			txid,
			account_index = 0 )

get_transfers()

framework.wallet.Wallet.get_transfers	(		self,
			in_ = True,
			out = True,
			pending = True,
			failed = True,
			pool = True,
			min_height = None,
			max_height = None,
			account_index = 0,
			subaddr_indices = [],
			all_accounts = False )

get_tx_key()

framework.wallet.Wallet.get_tx_key	(		self,
			txid )

get_tx_notes()

framework.wallet.Wallet.get_tx_notes	(		self,
			txids = [] )

get_tx_proof()

framework.wallet.Wallet.get_tx_proof	(		self,
			txid = '',
			address = '',
			message = '' )

get_version()

framework.wallet.Wallet.get_version

(

self

)

import_key_images()

framework.wallet.Wallet.import_key_images	(		self,
			signed_key_images,
			offset = 0 )

import_multisig_info()

framework.wallet.Wallet.import_multisig_info	(		self,
			info = [] )

import_outputs()

framework.wallet.Wallet.import_outputs	(		self,
			outputs_data_hex )

incoming_transfers()

framework.wallet.Wallet.incoming_transfers	(		self,
			transfer_type = 'all',
			account_index = 0,
			subaddr_indices = [] )

is_multisig()

framework.wallet.Wallet.is_multisig

(

self

)

label_account()

framework.wallet.Wallet.label_account	(		self,
			account_index,
			label )

label_address()

framework.wallet.Wallet.label_address	(		self,
			subaddress_index,
			label )

make_integrated_address()

framework.wallet.Wallet.make_integrated_address	(		self,
			standard_address = '',
			payment_id = '' )

make_multisig()

framework.wallet.Wallet.make_multisig	(		self,
			multisig_info,
			threshold,
			password = '' )

make_uri()

framework.wallet.Wallet.make_uri	(		self,
			address = '',
			payment_id = '',
			amount = 0,
			tx_description = '',
			recipient_name = '' )

open_wallet()

framework.wallet.Wallet.open_wallet	(		self,
			filename,
			password = '',
			autosave_current = True )

parse_uri()

framework.wallet.Wallet.parse_uri	(		self,
			uri )

prepare_multisig()

framework.wallet.Wallet.prepare_multisig	(		self,
			enable_multisig_experimental = False )

query_key()

framework.wallet.Wallet.query_key	(		self,
			key_type )

refresh()

framework.wallet.Wallet.refresh

(

self

)

relay_tx()

framework.wallet.Wallet.relay_tx	(		self,
			hex_ )

rescan_blockchain()

framework.wallet.Wallet.rescan_blockchain	(		self,
			hard = False )

rescan_spent()

framework.wallet.Wallet.rescan_spent

(

self

)

restore_deterministic_wallet()

framework.wallet.Wallet.restore_deterministic_wallet	(		self,
			seed = '',
			seed_offset = '',
			filename = '',
			restore_height = 0,
			password = '',
			language = '',
			autosave_current = True,
			enable_multisig_experimental = False )

scan_tx()

framework.wallet.Wallet.scan_tx	(		self,
			txids )

set_account_tag_description()

framework.wallet.Wallet.set_account_tag_description	(		self,
			tag,
			description )

set_attribute()

framework.wallet.Wallet.set_attribute	(		self,
			key,
			value )

set_daemon()

framework.wallet.Wallet.set_daemon	(		self,
			address,
			trusted = False,
			ssl_support = "autodetect",
			ssl_private_key_path = "",
			ssl_certificate_path = "",
			ssl_allowed_certificates = [],
			ssl_allowed_fingerprints = [],
			ssl_allow_any_cert = False )

set_log_categories()

framework.wallet.Wallet.set_log_categories	(		self,
			categories )

set_log_level()

framework.wallet.Wallet.set_log_level	(		self,
			level )

set_subaddress_lookahead()

framework.wallet.Wallet.set_subaddress_lookahead	(		self,
		int	major_idx,
		int	minor_idx,
			password = "" )

set_tx_notes()

framework.wallet.Wallet.set_tx_notes	(		self,
			txids = [],
			notes = [] )

setup_background_sync()

framework.wallet.Wallet.setup_background_sync	(		self,
			background_sync_type = background_sync_options.off,
			wallet_password = '',
			background_cache_password = '' )

sign()

framework.wallet.Wallet.sign	(		self,
			data,
			account_index = 0,
			address_index = 0,
			signature_type = "" )

sign_multisig()

framework.wallet.Wallet.sign_multisig	(		self,
			tx_data_hex )

sign_transfer()

framework.wallet.Wallet.sign_transfer	(		self,
			unsigned_txset,
			export_raw = False,
			get_tx_keys = False )

split_integrated_address()

framework.wallet.Wallet.split_integrated_address	(		self,
			integrated_address )

start_background_sync()

framework.wallet.Wallet.start_background_sync

(

self

)

start_mining()

framework.wallet.Wallet.start_mining	(		self,
			threads_count,
			do_background_mining = False,
			ignore_battery = False )

stop_background_sync()

framework.wallet.Wallet.stop_background_sync	(		self,
			wallet_password = '',
			seed = '',
			seed_offset = '' )

stop_mining()

framework.wallet.Wallet.stop_mining

(

self

)

stop_wallet()

framework.wallet.Wallet.stop_wallet

(

self

)

store()

framework.wallet.Wallet.store

(

self

)

submit_multisig()

framework.wallet.Wallet.submit_multisig	(		self,
			tx_data_hex )

submit_transfer()

framework.wallet.Wallet.submit_transfer	(		self,
			tx_data_hex )

sweep_all()

framework.wallet.Wallet.sweep_all	(		self,
			address = '',
			account_index = 0,
			subaddr_indices = [],
			priority = 0,
			ring_size = 0,
			outputs = 1,
			unlock_time = 0,
			payment_id = '',
			get_tx_keys = False,
			below_amount = 0,
			do_not_relay = False,
			get_tx_hex = False,
			get_tx_metadata = False )

sweep_dust()

framework.wallet.Wallet.sweep_dust	(		self,
			get_tx_keys = True,
			do_not_relay = False,
			get_tx_hex = False,
			get_tx_metadata = False )

sweep_single()

framework.wallet.Wallet.sweep_single	(		self,
			address = '',
			priority = 0,
			ring_size = 0,
			outputs = 1,
			unlock_time = 0,
			payment_id = '',
			get_tx_keys = False,
			key_image = "",
			do_not_relay = False,
			get_tx_hex = False,
			get_tx_metadata = False )

tag_accounts()

framework.wallet.Wallet.tag_accounts	(		self,
			tag,
			accounts = [] )

thaw()

framework.wallet.Wallet.thaw	(		self,
			key_image )

transfer()

framework.wallet.Wallet.transfer	(		self,
			destinations,
			account_index = 0,
			subaddr_indices = [],
			priority = 0,
			ring_size = 0,
			unlock_time = 0,
			payment_id = '',
			get_tx_key = True,
			do_not_relay = False,
			get_tx_hex = False,
			get_tx_metadata = False,
			subtract_fee_from_outputs = [] )

transfer_split()

framework.wallet.Wallet.transfer_split	(		self,
			destinations,
			account_index = 0,
			subaddr_indices = [],
			priority = 0,
			ring_size = 0,
			unlock_time = 0,
			payment_id = '',
			get_tx_key = True,
			do_not_relay = False,
			get_tx_hex = False,
			get_tx_metadata = False )

untag_accounts()

framework.wallet.Wallet.untag_accounts	(		self,
			accounts = [] )

validate_address()

framework.wallet.Wallet.validate_address	(		self,
			address,
			any_net_type = False,
			allow_openalias = False )

verify()

framework.wallet.Wallet.verify	(		self,
			data,
			address,
			signature )

Member Data Documentation

background_sync_options

framework.wallet.Wallet.background_sync_options

static

getaddress

framework.wallet.Wallet.getaddress = get_address

static

getbalance

framework.wallet.Wallet.getbalance = get_balance

static

getheight

framework.wallet.Wallet.getheight = get_height

static

host

framework.wallet.Wallet.host = host

port

framework.wallet.Wallet.port = port

rpc

framework.wallet.Wallet.rpc = JSONRPC('{protocol}://{host}:{port}'.format(protocol=protocol, host=host, port=port if port else 18090+idx))

sweep_unmixable

framework.wallet.Wallet.sweep_unmixable = sweep_dust

static

---

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

• utils/python-rpc/framework/wallet.py