Skip to content

Latest commit

 

History

History
876 lines (585 loc) · 25.2 KB

wallet.rst

File metadata and controls

876 lines (585 loc) · 25.2 KB

Wallet

account_create

Creates a new account, insert next deterministic key in wallet :py:func:`raiblocks.rpc.RPCClient.account_create(wallet, work=True) <raiblocks.rpc.RPCClient.account_create>`

account_list

Lists all the accounts inside wallet :py:func:`raiblocks.rpc.RPCClient.account_list(wallet) <raiblocks.rpc.RPCClient.account_list>`

account_move

Moves accounts from source to wallet :py:func:`raiblocks.rpc.RPCClient.account_move(source, wallet, accounts) <raiblocks.rpc.RPCClient.account_move>`

account_remove

Remove account from wallet :py:func:`raiblocks.rpc.RPCClient.account_remove(wallet, account) <raiblocks.rpc.RPCClient.account_remove>`

account_representative_set

Sets the representative for account in wallet :py:func:`raiblocks.rpc.RPCClient.account_representative_set(wallet, account, representative, work=None) <raiblocks.rpc.RPCClient.account_representative_set>`

accounts_create

Creates new accounts, insert next deterministic keys in wallet up to count :py:func:`raiblocks.rpc.RPCClient.accounts_create(wallet, count, work=True) <raiblocks.rpc.RPCClient.accounts_create>`

password_change

Changes the password for wallet to password :py:func:`raiblocks.rpc.RPCClient.password_change(wallet, password) <raiblocks.rpc.RPCClient.password_change>`

password_enter

Enters the password in to wallet :py:func:`raiblocks.rpc.RPCClient.password_enter(wallet, password) <raiblocks.rpc.RPCClient.password_enter>`

password_valid

Checks whether the password entered for wallet is valid :py:func:`raiblocks.rpc.RPCClient.password_valid(wallet) <raiblocks.rpc.RPCClient.password_valid>`

payment_begin

Begin a new payment session. Searches wallet for an account that's marked as available and has a 0 balance. If one is found, the account number is returned and is marked as unavailable. If no account is found, a new account is created, placed in the wallet, and returned. :py:func:`raiblocks.rpc.RPCClient.payment_begin(wallet) <raiblocks.rpc.RPCClient.payment_begin>`

payment_end

End a payment session. Marks the account as available for use in a payment session. :py:func:`raiblocks.rpc.RPCClient.payment_end(account, wallet) <raiblocks.rpc.RPCClient.payment_end>`

payment_init

Marks all accounts in wallet as available for being used as a payment session. :py:func:`raiblocks.rpc.RPCClient.payment_init(wallet) <raiblocks.rpc.RPCClient.payment_init>`

receive

Receive pending block for account in wallet :py:func:`raiblocks.rpc.RPCClient.receive(wallet, account, block, work=None) <raiblocks.rpc.RPCClient.receive>`

search_pending

Tells the node to look for pending blocks for any account in wallet :py:func:`raiblocks.rpc.RPCClient.search_pending(wallet) <raiblocks.rpc.RPCClient.search_pending>`

send

Send amount from source in wallet to destination :py:func:`raiblocks.rpc.RPCClient.send(wallet, source, destination, amount, work=None) <raiblocks.rpc.RPCClient.send>`

wallet_add

Add an adhoc private key key to wallet :py:func:`raiblocks.rpc.RPCClient.wallet_add(wallet, key, work=True) <raiblocks.rpc.RPCClient.wallet_add>`

wallet_balance_total

Returns the sum of all accounts balances in wallet :py:func:`raiblocks.rpc.RPCClient.wallet_balance_total(wallet) <raiblocks.rpc.RPCClient.wallet_balance_total>`

wallet_balances

Returns how many rai is owned and how many have not yet been received by all accounts in wallet :py:func:`raiblocks.rpc.RPCClient.wallet_balances(wallet) <raiblocks.rpc.RPCClient.wallet_balances>`

wallet_change_seed

Changes seed for wallet to seed :py:func:`raiblocks.rpc.RPCClient.wallet_change_seed(wallet, seed) <raiblocks.rpc.RPCClient.wallet_change_seed>`

wallet_contains

Check whether wallet contains account :py:func:`raiblocks.rpc.RPCClient.wallet_contains(wallet, account) <raiblocks.rpc.RPCClient.wallet_contains>`

wallet_create

Creates a new random wallet id :py:func:`raiblocks.rpc.RPCClient.wallet_create() <raiblocks.rpc.RPCClient.wallet_create>`

wallet_destroy

Destroys wallet and all contained accounts :py:func:`raiblocks.rpc.RPCClient.wallet_destroy(wallet) <raiblocks.rpc.RPCClient.wallet_destroy>`

wallet_export

Return a json representation of wallet :py:func:`raiblocks.rpc.RPCClient.wallet_export(wallet) <raiblocks.rpc.RPCClient.wallet_export>`

wallet_frontiers

Returns a list of pairs of account and block hash representing the head block starting for accounts from wallet :py:func:`raiblocks.rpc.RPCClient.wallet_frontiers(wallet) <raiblocks.rpc.RPCClient.wallet_frontiers>`

wallet_key_valid

Returns if a wallet key is valid :py:func:`raiblocks.rpc.RPCClient.wallet_key_valid(wallet) <raiblocks.rpc.RPCClient.wallet_key_valid>`

wallet_lock

Locks a wallet :py:func:`raiblocks.rpc.RPCClient.wallet_lock(wallet) <raiblocks.rpc.RPCClient.wallet_lock>`

wallet_locked

Checks whether wallet is locked :py:func:`raiblocks.rpc.RPCClient.wallet_locked(wallet) <raiblocks.rpc.RPCClient.wallet_locked>`

wallet_pending

Returns a list of block hashes which have not yet been received by accounts in this wallet :py:func:`raiblocks.rpc.RPCClient.wallet_pending(wallet, count=None, threshold=None, source=False) <raiblocks.rpc.RPCClient.wallet_pending>`

wallet_representative

Returns the default representative for wallet :py:func:`raiblocks.rpc.RPCClient.wallet_representative(wallet) <raiblocks.rpc.RPCClient.wallet_representative>`

wallet_representative_set

Sets the default representative for wallet :py:func:`raiblocks.rpc.RPCClient.wallet_representative_set(wallet, representative) <raiblocks.rpc.RPCClient.wallet_representative_set>`

wallet_republish

Rebroadcast blocks for accounts from wallet starting at frontier down to count to the network :py:func:`raiblocks.rpc.RPCClient.wallet_republish(wallet, count) <raiblocks.rpc.RPCClient.wallet_republish>`

wallet_unlock

Unlocks wallet using password :py:func:`raiblocks.rpc.RPCClient.wallet_unlock(wallet, password) <raiblocks.rpc.RPCClient.wallet_unlock>`