Wallet Account/Market/Blog API. More...

Functions
std::string	scorum::wallet::wallet_api::get_encrypted_memo (const std::string &from, const std::string &to, const std::string &memo)

std::string	scorum::wallet::wallet_api::decrypt_memo (const std::string &memo)

variant	scorum::wallet::wallet_api::info ()

chain_capital_api_obj	scorum::wallet::wallet_api::get_chain_capital () const

std::vector< account_name_type >	scorum::wallet::wallet_api::get_active_witnesses () const

std::vector< account_api_obj >	scorum::wallet::wallet_api::list_my_accounts ()

std::set< std::string >	scorum::wallet::wallet_api::list_accounts (const std::string &lowerbound, uint32_t limit)

account_api_obj	scorum::wallet::wallet_api::get_account (const std::string &account_name) const

account_balance_info_api_obj	scorum::wallet::wallet_api::get_account_balance (const std::string &account_name) const

annotated_signed_transaction	scorum::wallet::wallet_api::create_account (const std::string &creator, const std::string &newname, const std::string &json_meta, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::create_account_with_keys (const std::string &creator, const std::string &newname, const std::string &json_meta, const public_key_type &owner, const public_key_type &active, const public_key_type &posting, const public_key_type &memo, bool broadcast) const

annotated_signed_transaction	scorum::wallet::wallet_api::create_account_delegated (const std::string &creator, const asset &scorum_fee, const asset &delegated_scorumpower, const std::string &new_account_name, const std::string &json_meta, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::create_account_with_keys_delegated (const std::string &creator, const asset &scorum_fee, const asset &delegated_scorumpower, const std::string &newname, const std::string &json_meta, const public_key_type &owner, const public_key_type &active, const public_key_type &posting, const public_key_type &memo, bool broadcast) const

annotated_signed_transaction	scorum::wallet::wallet_api::create_account_by_committee (const std::string &creator, const std::string &newname, const std::string &json_meta, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::create_account_by_committee_with_keys (const std::string &creator, const std::string &newname, const std::string &json_meta, const public_key_type &owner, const public_key_type &active, const public_key_type &posting, const public_key_type &memo, bool broadcast) const

annotated_signed_transaction	scorum::wallet::wallet_api::update_account (const std::string &accountname, const std::string &json_meta, const public_key_type &owner, const public_key_type &active, const public_key_type &posting, const public_key_type &memo, bool broadcast) const

annotated_signed_transaction	scorum::wallet::wallet_api::update_account_auth_key (const std::string &account_name, const authority_type &type, const public_key_type &key, authority_weight_type weight, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::update_account_auth_account (const std::string &account_name, authority_type type, const std::string &auth_account, authority_weight_type weight, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::update_account_auth_threshold (const std::string &account_name, authority_type type, uint32_t threshold, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::update_account_meta (const std::string &account_name, const std::string &json_meta, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::update_account_memo_key (const std::string &account_name, const public_key_type &key, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::delegate_scorumpower (const std::string &delegator, const std::string &delegatee, const asset &scorumpower, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::delegate_scorumpower_from_reg_pool (const std::string &reg_committee_member, const std::string &delegatee, const asset &scorumpower, bool broadcast)

std::set< account_name_type >	scorum::wallet::wallet_api::list_witnesses (const std::string &lowerbound, uint32_t limit)

optional< witness_api_obj >	scorum::wallet::wallet_api::get_witness (const std::string &owner_account)

annotated_signed_transaction	scorum::wallet::wallet_api::update_witness (const std::string &witness_name, const std::string &url, const public_key_type &block_signing_key, const chain_properties &props, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::set_voting_proxy (const std::string &account_to_modify, const std::string &proxy, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::vote_for_witness (const std::string &account_to_vote_with, const std::string &witness_to_vote_for, bool approve=true, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::transfer (const std::string &from, const std::string &to, const asset &amount, const std::string &memo, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::escrow_transfer (const std::string &from, const std::string &to, const std::string &agent, uint32_t escrow_id, const asset &scorum_amount, const asset &fee, time_point_sec ratification_deadline, time_point_sec escrow_expiration, const std::string &json_meta, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::escrow_approve (const std::string &from, const std::string &to, const std::string &agent, const std::string &who, uint32_t escrow_id, bool approve, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::escrow_dispute (const std::string &from, const std::string &to, const std::string &agent, const std::string &who, uint32_t escrow_id, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::escrow_release (const std::string &from, const std::string &to, const std::string &agent, const std::string &who, const std::string &receiver, uint32_t escrow_id, const asset &scorum_amount, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::transfer_to_scorumpower (const std::string &from, const std::string &to, const asset &amount, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::withdraw_scorumpower (const std::string &from, const asset &scorumpower, bool broadcast=false)

annotated_signed_transaction	scorum::wallet::wallet_api::set_withdraw_scorumpower_route (const std::string &from, const std::string &to, uint16_t percent, bool auto_vest, bool broadcast=false)

std::vector< withdraw_route >	scorum::wallet::wallet_api::get_withdraw_routes (const std::string &account, withdraw_route_type type=all) const

annotated_signed_transaction	scorum::wallet::wallet_api::get_transaction (transaction_id_type trx_id) const

annotated_signed_transaction	scorum::wallet::wallet_api::post_comment (const std::string &author, const std::string &permlink, const std::string &parent_author, const std::string &parent_permlink, const std::string &title, const std::string &body, const std::string &json, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::vote (const std::string &voter, const std::string &author, const std::string &permlink, int16_t weight, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::challenge (const std::string &challenger, const std::string &challenged, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::request_account_recovery (const std::string &recovery_account, const std::string &account_to_recover, const authority &new_authority, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::recover_account (const std::string &account_to_recover, const authority &recent_authority, const authority &new_authority, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::change_recovery_account (const std::string &owner, const std::string &new_recovery_account, bool broadcast)

annotated_signed_transaction	scorum::wallet::wallet_api::prove (const std::string &challenged, bool broadcast)

std::vector< owner_authority_history_api_obj >	scorum::wallet::wallet_api::get_owner_history (const std::string &account) const
	Get the owner history object. More...

std::map< uint32_t, applied_operation >	scorum::wallet::wallet_api::get_account_history (const std::string &account, uint64_t from, uint32_t limit)

std::map< uint32_t, applied_operation >	scorum::wallet::wallet_api::get_account_scr_to_scr_transfers (const std::string &account, uint64_t from, uint32_t limit)

std::map< uint32_t, applied_operation >	scorum::wallet::wallet_api::get_account_scr_to_sp_transfers (const std::string &account, uint64_t from, uint32_t limit)

std::map< uint32_t, applied_withdraw_operation >	scorum::wallet::wallet_api::get_account_sp_to_scr_transfers (const std::string &account, uint64_t from, uint32_t limit)

annotated_signed_transaction	scorum::wallet::wallet_api::decline_voting_rights (const std::string &account, bool decline, bool broadcast)

Detailed Description

Wallet Account/Market/Blog API.

Function Documentation

◆ challenge()

annotated_signed_transaction scorum::wallet::wallet_api::challenge	(	const std::string &	challenger,
		const std::string &	challenged,
		bool	broadcast
	)

Challenge a user's authority. The challenger pays a fee to the challenged which is depositted as Scorum Power. Until the challenged proves their active key, all posting rights are revoked.

Parameters

challenger	The account issuing the challenge
challenged	The account being challenged
broadcast	true if you wish to broadcast the transaction

Definition at line 2493 of file wallet.cpp.

◆ change_recovery_account()

annotated_signed_transaction scorum::wallet::wallet_api::change_recovery_account	(	const std::string &	owner,
		const std::string &	new_recovery_account,
		bool	broadcast
	)

Change your recovery account after a 30 day delay.

Parameters

owner	The name of your account
new_recovery_account	The name of the recovery account you wish to have
broadcast	true if you wish to broadcast the transaction

Definition at line 1549 of file wallet.cpp.

◆ create_account()

annotated_signed_transaction scorum::wallet::wallet_api::create_account	(	const std::string &	creator,
		const std::string &	newname,
		const std::string &	json_meta,
		bool	broadcast
	)

Create account

This method will genrate new owner, active, and memo keys for the new account which will be controlable by this wallet. There is a fee associated with account creation that is paid by the creator. The current account creation fee can be found with the 'info' wallet command.

Parameters

creator	The account creating the new account
newname	The name of the new account
json_meta	JSON Metadata associated with the new account
broadcast	true if you wish to broadcast the transaction

This method will genrate new owner, active, and memo keys for the new account which will be controlable by this wallet.

Definition at line 1898 of file wallet.cpp.

◆ create_account_by_committee()

annotated_signed_transaction scorum::wallet::wallet_api::create_account_by_committee	(	const std::string &	creator,
		const std::string &	newname,
		const std::string &	json_meta,
		bool	broadcast
	)

This method will generate new owner, active, and memo keys for the new account which will be controllable by this wallet. There is a fee associated with account creation that is paid by the creator. The current account creation fee can be found with the 'info' wallet command.

Parameters

creator	The account creating the new account
newname	The name of the new account
json_meta	JSON Metadata associated with the new account
broadcast	true if you wish to broadcast the transaction

This method will generate new owner, active, and memo keys for the new account which will be controllable by this wallet.

Definition at line 1488 of file wallet.cpp.

◆ create_account_by_committee_with_keys()

annotated_signed_transaction scorum::wallet::wallet_api::create_account_by_committee_with_keys	(	const std::string &	creator,
		const std::string &	newname,
		const std::string &	json_meta,
		const public_key_type &	owner,
		const public_key_type &	active,
		const public_key_type &	posting,
		const public_key_type &	memo,
		bool	broadcast
	)		const

This method is used by faucets to create new accounts for other users which must provide their desired keys. The resulting account accepts bonus from registration pool. Creator must belong registration committee.

Parameters

creator	The committee member creating the new account
newname	The name of the new account
json_meta	JSON Metadata associated with the new account
owner	public owner key of the new account
active	public active key of the new account
posting	public posting key of the new account
memo	public memo key of the new account
broadcast	true if you wish to broadcast the transaction

Definition at line 1454 of file wallet.cpp.

◆ create_account_delegated()

annotated_signed_transaction scorum::wallet::wallet_api::create_account_delegated	(	const std::string &	creator,
		const asset &	scorum_fee,
		const asset &	delegated_scorumpower,
		const std::string &	newname,
		const std::string &	json_meta,
		bool	broadcast
	)

Create account delegated

This method will genrate new owner, active, and memo keys for the new account which will be controlable by this wallet. There is a fee associated with account creation that is paid by the creator. The current account creation fee can be found with the 'info' wallet command.

These accounts are created with combination of SCR and delegated SP

Parameters

creator	The account creating the new account
scorum_fee	The amount of the fee to be paid with SCR
delegated_scorumpower	The amount of the fee to be paid with delegation
new_account_name	The name of the new account
json_meta	JSON Metadata associated with the new account
broadcast	true if you wish to broadcast the transaction

This method will genrate new owner, active, and memo keys for the new account which will be controlable by this wallet.

Definition at line 1924 of file wallet.cpp.

◆ create_account_with_keys()

annotated_signed_transaction scorum::wallet::wallet_api::create_account_with_keys	(	const std::string &	creator,
		const std::string &	newname,
		const std::string &	json_meta,
		const public_key_type &	owner,
		const public_key_type &	active,
		const public_key_type &	posting,
		const public_key_type &	memo,
		bool	broadcast
	)		const

Create account with keys

This method is used by faucets to create new accounts for other users which must provide their desired keys. The resulting account may not be controllable by this wallet. There is a fee associated with account creation that is paid by the creator. The current account creation fee can be found with the 'info' wallet command.

Parameters

creator	The account creating the new account
newname	The name of the new account
json_meta	JSON Metadata associated with the new account
owner	public owner key of the new account
active	public active key of the new account
posting	public posting key of the new account
memo	public memo key of the new account
broadcast	true if you wish to broadcast the transaction

This method is used by faucets to create new accounts for other users which must provide their desired keys. The resulting account may not be controllable by this wallet.

Definition at line 1383 of file wallet.cpp.

◆ create_account_with_keys_delegated()

annotated_signed_transaction scorum::wallet::wallet_api::create_account_with_keys_delegated	(	const std::string &	creator,
		const asset &	scorum_fee,
		const asset &	delegated_scorumpower,
		const std::string &	newname,
		const std::string &	json_meta,
		const public_key_type &	owner,
		const public_key_type &	active,
		const public_key_type &	posting,
		const public_key_type &	memo,
		bool	broadcast
	)		const

Create account with keys delegated

This method is used by faucets to create new accounts for other users which must provide their desired keys. The resulting account may not be controllable by this wallet. There is a fee associated with account creation that is paid by the creator. The current account creation fee can be found with the 'info' wallet command.

These accounts are created with combination of SCR and delegated SP

Parameters

creator	The account creating the new account
scorum_fee	The amount of the fee to be paid with SCR
delegated_scorumpower	The amount of the fee to be paid with delegation
newname	The name of the new account
json_meta	JSON Metadata associated with the new account
owner	public owner key of the new account
active	public active key of the new account
posting	public posting key of the new account
memo	public memo key of the new account
broadcast	true if you wish to broadcast the transaction

This method is used by faucets to create new accounts for other users which must provide their desired keys. The resulting account may not be controllable by this wallet.

Definition at line 1420 of file wallet.cpp.

◆ decline_voting_rights()

annotated_signed_transaction scorum::wallet::wallet_api::decline_voting_rights	(	const std::string &	account,
		bool	decline,
		bool	broadcast
	)

Decline voting rights

Parameters

account
decline
broadcast

Definition at line 2316 of file wallet.cpp.

◆ decrypt_memo()

std::string scorum::wallet::wallet_api::decrypt_memo ( const std::string & memo )

Returns the decrypted memo if possible given wallet's known private keys

Definition at line 2271 of file wallet.cpp.

◆ delegate_scorumpower()

annotated_signed_transaction scorum::wallet::wallet_api::delegate_scorumpower	(	const std::string &	delegator,
		const std::string &	delegatee,
		const asset &	scorumpower,
		bool	broadcast
	)

This method delegates SP from one account to another.

Parameters

delegator	The name of the account delegating SP
delegatee	The name of the account receiving SP
scorumpower	The amount of SP to delegate
broadcast	true if you wish to broadcast the transaction

Definition at line 1846 of file wallet.cpp.

◆ delegate_scorumpower_from_reg_pool()

annotated_signed_transaction scorum::wallet::wallet_api::delegate_scorumpower_from_reg_pool	(	const std::string &	reg_committee_member,
		const std::string &	delegatee,
		const asset &	scorumpower,
		bool	broadcast
	)

This method delegates SP from registration pool to account.

Parameters

reg_committee_member	Registration committee member
delegatee	The name of the account receiving SP
scorumpower	The amount of SP to delegate
broadcast	true if you wish to broadcast the transaction

Definition at line 1870 of file wallet.cpp.

◆ escrow_approve()

annotated_signed_transaction scorum::wallet::wallet_api::escrow_approve	(	const std::string &	from,
		const std::string &	to,
		const std::string &	agent,
		const std::string &	who,
		uint32_t	escrow_id,
		bool	approve,
		bool	broadcast = `false`
	)

Approve a proposed escrow transfer. Funds cannot be released until after approval. This is in lieu of requiring multi-sig on escrow_transfer

Parameters

from	The account that funded the escrow
to	The destination of the escrow
agent	The account acting as the agent in case of dispute
who	The account approving the escrow transfer (either 'to' or 'agent')
escrow_id	A unique id for the escrow transfer
approve	true to approve the escrow transfer, otherwise cancels it and refunds 'from'
broadcast	true if you wish to broadcast the transaction

Definition at line 2153 of file wallet.cpp.

◆ escrow_dispute()

annotated_signed_transaction scorum::wallet::wallet_api::escrow_dispute	(	const std::string &	from,
		const std::string &	to,
		const std::string &	agent,
		const std::string &	who,
		uint32_t	escrow_id,
		bool	broadcast = `false`
	)

Raise a dispute on the escrow transfer before it expires

Parameters

from	The account that funded the escrow
to	The destination of the escrow
agent	The account acting as the agent in case of dispute
who	The account raising the dispute (either 'from' or 'to')
escrow_id	A unique id for the escrow transfer
broadcast	true if you wish to broadcast the transaction

Definition at line 2176 of file wallet.cpp.

◆ escrow_release()

annotated_signed_transaction scorum::wallet::wallet_api::escrow_release	(	const std::string &	from,
		const std::string &	to,
		const std::string &	agent,
		const std::string &	who,
		const std::string &	receiver,
		uint32_t	escrow_id,
		const asset &	scorum_amount,
		bool	broadcast = `false`
	)

Release funds help in escrow

Parameters

from	The account that funded the escrow
to	The account the funds are originally going to
agent	The account acting as the agent in case of dispute
who	The account authorizing the release
receiver	The account that will receive funds being released
escrow_id	A unique id for the escrow transfer
scorum_amount	The amount of SCR that will be released
broadcast	true if you wish to broadcast the transaction

Definition at line 2198 of file wallet.cpp.

◆ escrow_transfer()

annotated_signed_transaction scorum::wallet::wallet_api::escrow_transfer	(	const std::string &	from,
		const std::string &	to,
		const std::string &	agent,
		uint32_t	escrow_id,
		const asset &	scorum_amount,
		const asset &	fee,
		time_point_sec	ratification_deadline,
		time_point_sec	escrow_expiration,
		const std::string &	json_meta,
		bool	broadcast = `false`
	)

Transfer funds from one account to another using escrow.

Parameters

from	The account the funds are coming from
to	The account the funds are going to
agent	The account acting as the agent in case of dispute
escrow_id	A unique id for the escrow transfer. (from, escrow_id) must be a unique pair
scorum_amount	The amount of SCR to transfer
fee	The fee paid to the agent
ratification_deadline	The deadline for 'to' and 'agent' to approve the escrow transfer
escrow_expiration	The expiration of the escrow transfer, after which either party can claim the funds
json_meta	JSON encoded meta data
broadcast	true if you wish to broadcast the transaction

Definition at line 2123 of file wallet.cpp.

◆ get_account()

account_api_obj scorum::wallet::wallet_api::get_account ( const std::string & account_name ) const

Returns information about the given account.

Parameters

account_name the name of the account to provide information about

Returns: the public account data stored in the blockchain

Definition at line 1159 of file wallet.cpp.

◆ get_account_balance()

account_balance_info_api_obj scorum::wallet::wallet_api::get_account_balance ( const std::string & account_name ) const

Returns balance information about the given account.

Parameters

account_name the name of the account to provide information about

Returns: the public account data stored in the blockchain

Definition at line 1164 of file wallet.cpp.

◆ get_account_history()

std::map< uint32_t, applied_operation > scorum::wallet::wallet_api::get_account_history	(	const std::string &	account,
		uint64_t	from,
		uint32_t	limit
	)

Account operations have sequence numbers from 0 to N where N is the most recent operation.

This method returns operations in the range [from-limit, from]

Parameters

account	account whose history will be returned
from	the absolute sequence number, -1 means most recent, limit is the number of operations before from.
limit	the maximum number of items that can be queried (0 to 100], must be less than from

Definition at line 2331 of file wallet.cpp.

◆ get_account_scr_to_scr_transfers()

std::map< uint32_t, applied_operation > scorum::wallet::wallet_api::get_account_scr_to_scr_transfers	(	const std::string &	account,
		uint64_t	from,
		uint32_t	limit
	)

Account operations have sequence numbers from 0 to N where N is the most recent operation.

This method returns operations in the range [from-limit, from]

Parameters

account	account whose history will be returned
from	the absolute sequence number, -1 means most recent, limit is the number of operations before from.
limit	the maximum number of items that can be queried (0 to 100], must be less than from

Definition at line 2354 of file wallet.cpp.

◆ get_account_scr_to_sp_transfers()

std::map< uint32_t, applied_operation > scorum::wallet::wallet_api::get_account_scr_to_sp_transfers	(	const std::string &	account,
		uint64_t	from,
		uint32_t	limit
	)

Account operations have sequence numbers from 0 to N where N is the most recent operation.

This method returns operations in the range [from-limit, from]

Parameters

account	account whose history will be returned
from	the absolute sequence number, -1 means most recent, limit is the number of operations before from.
limit	the maximum number of items that can be queried (0 to 100], must be less than from

Definition at line 2373 of file wallet.cpp.

◆ get_account_sp_to_scr_transfers()

std::map< uint32_t, applied_withdraw_operation > scorum::wallet::wallet_api::get_account_sp_to_scr_transfers	(	const std::string &	account,
		uint64_t	from,
		uint32_t	limit
	)

Account operations have sequence numbers from 0 to N where N is the most recent operation.

This method returns operations in the range [from-limit, from]

Parameters

account	account whose history will be returned
from	the absolute sequence number, -1 means most recent, limit is the number of operations before from.
limit	the maximum number of items that can be queried (0 to 100], must be less than from

Definition at line 2392 of file wallet.cpp.

◆ get_active_witnesses()

std::vector< account_name_type > scorum::wallet::wallet_api::get_active_witnesses ( ) const

Returns the list of witnesses producing blocks in the current round (21 Blocks)

Definition at line 1144 of file wallet.cpp.

◆ get_chain_capital()

chain_capital_api_obj scorum::wallet::wallet_api::get_chain_capital ( ) const

Gets all money circulating between funds and users.

Definition at line 3387 of file wallet.cpp.

◆ get_encrypted_memo()

std::string scorum::wallet::wallet_api::get_encrypted_memo	(	const std::string &	from,
		const std::string &	to,
		const std::string &	memo
	)

Returns the encrypted memo if memo starts with '#' otherwise returns memo

Definition at line 2068 of file wallet.cpp.

◆ get_owner_history()

std::vector< owner_authority_history_api_obj > scorum::wallet::wallet_api::get_owner_history ( const std::string & account ) const

Get the owner history object.

Parameters

account

Returns: std::vector<owner_authority_history_api_obj>

Definition at line 1564 of file wallet.cpp.

◆ get_transaction()

annotated_signed_transaction scorum::wallet::wallet_api::get_transaction ( transaction_id_type trx_id ) const

Returns transaction by ID.

Parameters

trx_id

Returns: annotated_signed_transaction

Definition at line 2528 of file wallet.cpp.

◆ get_withdraw_routes()

std::vector< withdraw_route > scorum::wallet::wallet_api::get_withdraw_routes	(	const std::string &	account,
		withdraw_route_type	type = `all`
	)		const

Returns vesting withdraw routes for an account.

Parameters

account	Account to query routes
type	Withdraw type type [incoming, outgoing, all]

Definition at line 2437 of file wallet.cpp.

◆ get_witness()

optional< witness_api_obj > scorum::wallet::wallet_api::get_witness ( const std::string & owner_account )

Returns information about the given witness.

Parameters

owner_account the name or id of the witness account owner, or the id of the witness

Returns: the information about the witness stored in the block chain

Definition at line 1208 of file wallet.cpp.

◆ info()

variant scorum::wallet::wallet_api::info ( )

Returns info about the current state of the blockchain

Definition at line 1193 of file wallet.cpp.

◆ list_accounts()

std::set< std::string > scorum::wallet::wallet_api::list_accounts	(	const std::string &	lowerbound,
		uint32_t	limit
	)

Lists all accounts registered in the blockchain.

This returns a list of all account names and their account ids, sorted by account name.

Use the lowerbound and limit parameters to page through the list. To retrieve all accounts, start by setting lowerbound to the empty string "", and then each iteration, pass the last account name returned as the lowerbound for the next list_accounts() call.

Parameters

lowerbound	the name of the first account to return. If the named account does not exist, the list will start at the account that comes after `lowerbound`
limit	the maximum number of accounts to return (max: 1000)

Returns: a list of accounts mapping account names to account ids

Definition at line 1139 of file wallet.cpp.

◆ list_my_accounts()

std::vector< account_api_obj > scorum::wallet::wallet_api::list_my_accounts ( )

Gets the account information for all accounts for which this wallet has a private key

Definition at line 1113 of file wallet.cpp.

◆ list_witnesses()

std::set< account_name_type > scorum::wallet::wallet_api::list_witnesses	(	const std::string &	lowerbound,
		uint32_t	limit
	)

Lists all witnesses registered in the blockchain.

This returns a list of all account names that own witnesses, and the associated witness id, sorted by name. This lists witnesses whether they are currently voted in or not.

Use the lowerbound and limit parameters to page through the list. To retrieve all witnesss, start by setting lowerbound to the empty string "", and then each iteration, pass the last witness name returned as the lowerbound for the next list_witnesss() call.

Parameters

lowerbound	the name of the first witness to return. If the named witness does not exist, the list will start at the witness that comes after `lowerbound`
limit	the maximum number of witnesss to return (max: 1000)

Returns: a list of witnesss mapping witness names to witness ids

Definition at line 1203 of file wallet.cpp.

◆ post_comment()

annotated_signed_transaction scorum::wallet::wallet_api::post_comment	(	const std::string &	author,
		const std::string &	permlink,
		const std::string &	parent_author,
		const std::string &	parent_permlink,
		const std::string &	title,
		const std::string &	body,
		const std::string &	json,
		bool	broadcast
	)

Post or update a comment.

Parameters

author	the name of the account authoring the comment
permlink	the accountwide unique permlink for the comment
parent_author	can be null if this is a top level comment
parent_permlink	becomes category if parent_author is ""
title	the title of the comment
body	the body of the comment
json	the json metadata of the comment
broadcast	true if you wish to broadcast the transaction

Definition at line 2442 of file wallet.cpp.

◆ prove()

annotated_signed_transaction scorum::wallet::wallet_api::prove	(	const std::string &	challenged,
		bool	broadcast
	)

Prove an account's active authority, fulfilling a challenge, restoring posting rights, and making the account immune to challenge for 24 hours.

Parameters

challenged	The account that was challenged and is proving its authority.
broadcast	true if you wish to broadcast the transaction

Definition at line 2513 of file wallet.cpp.

◆ recover_account()

annotated_signed_transaction scorum::wallet::wallet_api::recover_account	(	const std::string &	account_to_recover,
		const authority &	recent_authority,
		const authority &	new_authority,
		bool	broadcast
	)

Recover your account using a recovery request created by your recovery account.

The syntax for this commain contains a serialized authority object, so there is an example below on how to pass in the authority.

recover_account "your_account" {"weight_threshold": 1,"account_auths": [], "key_auths": [["old_public_key",1]]} {"weight_threshold": 1,"account_auths": [], "key_auths": [["new_public_key",1]]} true

Parameters

account_to_recover	The name of your account
recent_authority	A recent owner authority on your account
new_authority	The new authority that your recovery account used in the account recover request.
broadcast	true if you wish to broadcast the transaction

Definition at line 1529 of file wallet.cpp.

◆ request_account_recovery()

annotated_signed_transaction scorum::wallet::wallet_api::request_account_recovery	(	const std::string &	recovery_account,
		const std::string &	account_to_recover,
		const authority &	new_authority,
		bool	broadcast
	)

Create an account recovery request as a recover account. The syntax for this command contains a serialized authority object so there is an example below on how to pass in the authority.

request_account_recovery "your_account" "account_to_recover" {"weight_threshold": 1,"account_auths": [], "key_auths": [["new_public_key",1]]} true

Parameters

recovery_account	The name of your account
account_to_recover	The name of the account you are trying to recover
new_authority	The new owner authority for the recovered account. This should be given to you by the holder of the compromised or lost account.
broadcast	true if you wish to broadcast the transaction

Definition at line 1511 of file wallet.cpp.

◆ set_voting_proxy()

annotated_signed_transaction scorum::wallet::wallet_api::set_voting_proxy	(	const std::string &	account_to_modify,
		const std::string &	proxy,
		bool	broadcast = `false`
	)

Set the voting proxy for an account.

If a user does not wish to take an active part in voting, they can choose to allow another account to vote their stake.

Setting a vote proxy does not remove your previous votes from the blockchain, they remain there but are ignored. If you later null out your vote proxy, your previous votes will take effect again.

This setting can be changed at any time.

Parameters

account_to_modify	the name or id of the account to update
proxy	the name of account that should proxy to, or empty string to have no proxy
broadcast	true if you wish to broadcast the transaction

Definition at line 1213 of file wallet.cpp.

◆ set_withdraw_scorumpower_route()

annotated_signed_transaction scorum::wallet::wallet_api::set_withdraw_scorumpower_route	(	const std::string &	from,
		const std::string &	to,
		uint16_t	percent,
		bool	auto_vest,
		bool	broadcast = `false`
	)

Set up a vesting withdraw route.

When scorumpower are withdrawn, they will be routed to these accounts based on the specified weights.

Parameters

from	The account the SP are withdrawn from.
to	The account receiving either SP or SCR.
percent	The percent of the withdraw to go to the 'to' account. This is denoted in hundredths of a percent. i.e. 100 is 1% and 10000 is 100%. This value must be between 1 and 100000
auto_vest	Set to true if the 'to' account should receive the SP as SP, or false if it should receive them as SCR.
broadcast	true if you wish to broadcast the transaction.

Definition at line 2254 of file wallet.cpp.

◆ transfer()

annotated_signed_transaction scorum::wallet::wallet_api::transfer	(	const std::string &	from,
		const std::string &	to,
		const asset &	amount,
		const std::string &	memo,
		bool	broadcast = `false`
	)

Transfer funds from one account to another.

Parameters

from	The account the funds are coming from
to	The account the funds are going to
amount	The funds being transferred. i.e. "100.000000000 SCR"
memo	A memo for the transactionm, encrypted with the to account's public memo key
broadcast	true if you wish to broadcast the transaction

Definition at line 2100 of file wallet.cpp.

◆ transfer_to_scorumpower()

annotated_signed_transaction scorum::wallet::wallet_api::transfer_to_scorumpower	(	const std::string &	from,
		const std::string &	to,
		const asset &	amount,
		bool	broadcast = `false`
	)

Transfer SCR into a scorumpower fund represented by scorumpower (SP).

SP are required to vesting for a minimum of one coin year and can be withdrawn once a week over a two year withdraw period. SP are protected against dilution up until 90% of SCR is vesting.

Parameters

from	The account the SCR is coming from
to	The account getting the SP
amount	The amount of SCR to scorum power i.e. "100.000000000 SCR"
broadcast	true if you wish to broadcast the transaction

Definition at line 2224 of file wallet.cpp.

◆ update_account()

annotated_signed_transaction scorum::wallet::wallet_api::update_account	(	const std::string &	accountname,
		const std::string &	json_meta,
		const public_key_type &	owner,
		const public_key_type &	active,
		const public_key_type &	posting,
		const public_key_type &	memo,
		bool	broadcast
	)		const

This method updates the keys of an existing account.

Parameters

accountname	The name of the account
json_meta	New JSON Metadata to be associated with the account
owner	New public owner key for the account
active	New public active key for the account
posting	New public posting key for the account
memo	New public memo key for the account
broadcast	true if you wish to broadcast the transaction

Definition at line 1569 of file wallet.cpp.

◆ update_account_auth_account()

annotated_signed_transaction scorum::wallet::wallet_api::update_account_auth_account	(	const std::string &	account_name,
		authority_type	type,
		const std::string &	auth_account,
		authority_weight_type	weight,
		bool	broadcast
	)

This method updates the account of an authority for an existing account.

Warning: You can create impossible authorities using this method. The method will fail if you create an impossible owner authority, but will allow impossible active and posting authorities.

Parameters

account_name	The name of the account whose authority you wish to update
type	The authority type. e.g. owner, active, or posting
auth_account	The account to add the the authority
weight	The weight the account should have in the authority. A weight of 0 indicates the removal of the account.
broadcast	true if you wish to broadcast the transaction.

Definition at line 1669 of file wallet.cpp.

◆ update_account_auth_key()

annotated_signed_transaction scorum::wallet::wallet_api::update_account_auth_key	(	const std::string &	account_name,
		const authority_type &	type,
		const public_key_type &	key,
		authority_weight_type	weight,
		bool	broadcast
	)

This method updates the key of an authority for an existing account.

Warning: You can create impossible authorities using this method. The method will fail if you create an impossible owner authority, but will allow impossible active and posting authorities.

Parameters

account_name	The name of the account whose authority you wish to update
type	The authority type. e.g. owner, active, or posting
key	The public key to add to the authority
weight	The weight the key should have in the authority. A weight of 0 indicates the removal of the key.
broadcast	true if you wish to broadcast the transaction.

Definition at line 1598 of file wallet.cpp.

◆ update_account_auth_threshold()

annotated_signed_transaction scorum::wallet::wallet_api::update_account_auth_threshold	(	const std::string &	account_name,
		authority_type	type,
		uint32_t	threshold,
		bool	broadcast
	)

This method updates the weight threshold of an authority for an account.

Warning: You can create impossible authorities using this method as well as implicitly met authorities. The method will fail if you create an implicitly true authority and if you create an impossible owner authoroty, but will allow impossible active and posting authorities.

Parameters

account_name	The name of the account whose authority you wish to update
type	The authority type. e.g. owner, active, or posting
threshold	The weight threshold required for the authority to be met
broadcast	true if you wish to broadcast the transaction

Definition at line 1740 of file wallet.cpp.

◆ update_account_memo_key()

annotated_signed_transaction scorum::wallet::wallet_api::update_account_memo_key	(	const std::string &	account_name,
		const public_key_type &	key,
		bool	broadcast
	)

This method updates the memo key of an account

Parameters

account_name	The name of the account you wish to update
key	The new memo public key
broadcast	true if you wish to broadcast the transaction

Definition at line 1826 of file wallet.cpp.

◆ update_account_meta()

annotated_signed_transaction scorum::wallet::wallet_api::update_account_meta	(	const std::string &	account_name,
		const std::string &	json_meta,
		bool	broadcast
	)

This method updates the account JSON metadata

Parameters

account_name	The name of the account you wish to update
json_meta	The new JSON metadata for the account. This overrides existing metadata
broadcast	true if you wish to broadcast the transaction

Definition at line 1805 of file wallet.cpp.

◆ update_witness()

annotated_signed_transaction scorum::wallet::wallet_api::update_witness	(	const std::string &	witness_name,
		const std::string &	url,
		const public_key_type &	block_signing_key,
		const chain_properties &	props,
		bool	broadcast = `false`
	)

Update a witness object owned by the given account.

Parameters

witness_name	The name of the witness account.
url	A URL containing some information about the witness. The empty string makes it remain the same.
block_signing_key	The new block signing public key. The empty string disables block production.
props	The chain properties the witness is voting on.
broadcast	true if you wish to broadcast the transaction.

Definition at line 1949 of file wallet.cpp.

◆ vote()

annotated_signed_transaction scorum::wallet::wallet_api::vote	(	const std::string &	voter,
		const std::string &	author,
		const std::string &	permlink,
		int16_t	weight,
		bool	broadcast
	)

Vote on a comment to be paid SCR

Parameters

voter	The account voting
author	The author of the comment to be voted on
permlink	The permlink of the comment to be voted on. (author, permlink) is a unique pair
weight	The weight [-10000,10000] of the vote
broadcast	true if you wish to broadcast the transaction

Definition at line 2468 of file wallet.cpp.

◆ vote_for_witness()

annotated_signed_transaction scorum::wallet::wallet_api::vote_for_witness	(	const std::string &	account_to_vote_with,
		const std::string &	witness_to_vote_for,
		bool	approve = `true`,
		bool	broadcast = `false`
	)

Vote for a witness to become a block producer.

By default an account has not voted positively or negatively for a witness. The account can either vote for with positively votes or against with negative votes. The vote will remain until updated with another vote. Vote strength is determined by the accounts scorumpower.

Parameters

account_to_vote_with	The account voting for a witness
witness_to_vote_for	The witness that is being voted for
approve	true if the account is voting for the account to be able to be a block produce
broadcast	true if you wish to broadcast the transaction

Definition at line 1983 of file wallet.cpp.

◆ withdraw_scorumpower()

annotated_signed_transaction scorum::wallet::wallet_api::withdraw_scorumpower	(	const std::string &	from,
		const asset &	scorumpower,
		bool	broadcast = `false`
	)

Set up a vesting withdraw request.

The request is fulfilled once a week over the next 13 weeks.

Parameters

from	The account the SP are withdrawn from
scorumpower	The amount of SP to withdraw over the next 13 weeks. Each week (amount/13) shares are withdrawn and deposited back as SCR i.e. "10.000000000 SP"
broadcast	true if you wish to broadcast the transaction

Definition at line 2240 of file wallet.cpp.

Functions

Detailed Description

Function Documentation

◆ challenge()

◆ change_recovery_account()

◆ create_account()

◆ create_account_by_committee()

◆ create_account_by_committee_with_keys()

◆ create_account_delegated()

◆ create_account_with_keys()

◆ create_account_with_keys_delegated()

◆ decline_voting_rights()

◆ decrypt_memo()

◆ delegate_scorumpower()

◆ delegate_scorumpower_from_reg_pool()

◆ escrow_approve()

◆ escrow_dispute()

◆ escrow_release()

◆ escrow_transfer()

◆ get_account()

◆ get_account_balance()

◆ get_account_history()

◆ get_account_scr_to_scr_transfers()

◆ get_account_scr_to_sp_transfers()

◆ get_account_sp_to_scr_transfers()

◆ get_active_witnesses()

◆ get_chain_capital()

◆ get_encrypted_memo()

◆ get_owner_history()

◆ get_transaction()

◆ get_withdraw_routes()

◆ get_witness()

◆ info()

◆ list_accounts()

◆ list_my_accounts()

◆ list_witnesses()

◆ post_comment()

◆ prove()

◆ recover_account()

◆ request_account_recovery()

◆ set_voting_proxy()

◆ set_withdraw_scorumpower_route()

◆ transfer()

◆ transfer_to_scorumpower()

◆ update_account()

◆ update_account_auth_account()

◆ update_account_auth_key()

◆ update_account_auth_threshold()

◆ update_account_memo_key()

◆ update_account_meta()

◆ update_witness()

◆ vote()

◆ vote_for_witness()

◆ withdraw_scorumpower()