framework.wallet.Wallet Class Reference

Inheritance diagram for framework.wallet.Wallet:

Collaboration diagram for framework.wallet.Wallet:

Classes
class	BackgroundSyncOptions

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

Public Attributes
	host
	port
	rpc

Static Public Attributes
	getbalance
	sweep_unmixable
	getaddress
	getheight
	background_sync_options

Constructor & Destructor Documentation

__init__()

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

Member Function Documentation

add_address_book()

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

auto_refresh()

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

change_wallet_password()

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

check_reserve_proof()

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

check_spend_proof()

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

check_tx_key()

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

check_tx_proof()

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

close_wallet()

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

create_account()

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

create_address()

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

create_wallet()

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

delete_address_book()

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

describe_transfer()

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

edit_address_book()

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

estimate_tx_size_and_weight()

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

exchange_multisig_keys()

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

export_key_images()

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

export_multisig_info()

def framework.wallet.Wallet.export_multisig_info

(

self

)

export_outputs()

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

finalize_multisig()

def framework.wallet.Wallet.finalize_multisig

(

self

)

freeze()

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

frozen()

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

generate_from_keys()

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

get_account_tags()

def framework.wallet.Wallet.get_account_tags

(

self

)

get_accounts()

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

get_address()

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

get_address_book()

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

get_address_index()

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

get_attribute()

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

get_balance()

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

get_bulk_payments()

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

get_default_fee_priority()

def framework.wallet.Wallet.get_default_fee_priority

(

self

)

get_height()

def framework.wallet.Wallet.get_height

(

self

)

get_languages()

def framework.wallet.Wallet.get_languages

(

self

)

get_payments()

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

get_reserve_proof()

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

get_spend_proof()

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

get_transfer_by_txid()

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

get_transfers()

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

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

get_tx_notes()

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

get_tx_proof()

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

get_version()

def framework.wallet.Wallet.get_version

(

self

)

import_key_images()

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

import_multisig_info()

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

import_outputs()

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

incoming_transfers()

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

is_multisig()

def framework.wallet.Wallet.is_multisig

(

self

)

label_account()

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

label_address()

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

make_integrated_address()

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

make_multisig()

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

make_uri()

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

open_wallet()

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

parse_uri()

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

prepare_multisig()

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

query_key()

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

refresh()

def framework.wallet.Wallet.refresh

(

self

)

relay_tx()

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

rescan_blockchain()

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

rescan_spent()

def framework.wallet.Wallet.rescan_spent

(

self

)

restore_deterministic_wallet()

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

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

set_account_tag_description()

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

set_attribute()

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

set_daemon()

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

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

set_log_level()

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

set_subaddress_lookahead()

def framework.wallet.Wallet.set_subaddress_lookahead	(		self,
			major_idx
	)

set_tx_notes()

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

setup_background_sync()

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

sign()

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

sign_multisig()

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

sign_transfer()

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

split_integrated_address()

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

start_background_sync()

def framework.wallet.Wallet.start_background_sync

(

self

)

start_mining()

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

stop_background_sync()

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

stop_mining()

def framework.wallet.Wallet.stop_mining

(

self

)

stop_wallet()

def framework.wallet.Wallet.stop_wallet

(

self

)

store()

def framework.wallet.Wallet.store

(

self

)

submit_multisig()

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

submit_transfer()

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

sweep_all()

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

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

sweep_single()

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

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

thaw()

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

transfer()

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

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

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

validate_address()

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

verify()

def 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

static

getbalance

framework.wallet.Wallet.getbalance

static

getheight

framework.wallet.Wallet.getheight

static

host

framework.wallet.Wallet.host

port

framework.wallet.Wallet.port

rpc

framework.wallet.Wallet.rpc

sweep_unmixable

framework.wallet.Wallet.sweep_unmixable

static

---

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

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