Golos
Разработчикам Статистика Баунти Документация Партнеры Github
Public Member Functions | Public Attributes | List of all members
golos::wallet::wallet_api Class Reference

#include <wallet.hpp>

Public Member Functions

 wallet_api (const wallet_data &initial_data, fc::api< login_api > rapi)
 
virtual ~wallet_api ()
 
bool copy_wallet_file (string destination_filename)
 
string help () const
 
variant info ()
 
variant_object about () const
 
optional< signed_block_with_infoget_block (uint32_t num)
 
vector< applied_operationget_ops_in_block (uint32_t block_num, bool only_virtual=true)
 
feed_history_api_obj get_feed_history () const
 
vector< account_name_type > get_active_witnesses () const
 
vector< account_name_type > get_miner_queue () const
 
vector< withdraw_routeget_withdraw_routes (string account, withdraw_route_type type=all) const
 
string get_account_count () const
 
string get_steem_per_mvests () const
 
vector< account_api_objlist_my_accounts () const
 
set< string > list_accounts (const string &lowerbound, uint32_t limit)
 
vector< asset< 0, 17, 0 > > list_account_balances (const account_name_type &account_name)
 
vector< asset_objectlist_assets (const string &lowerbound, uint32_t limit) const
 
dynamic_global_property_object get_dynamic_global_properties () const
 
account_api_obj get_account (string account_name) const
 
asset_object get_asset (string asset_symbol) const
 
proposal_object get_proposal (string account_name, integral_id_type id) const
 
asset_bitasset_data_object get_bitasset_data (string asset_symbol) const
 
string get_wallet_filename () const
 
string get_private_key (public_key_type pubkey) const
 
pair< public_key_type, string > get_private_key_from_password (string account, string role, string password) const
 
annotated_signed_transaction get_transaction (transaction_id_type trx_id) const
 
bool is_new () const
 
bool is_locked () const
 
void lock ()
 
void unlock (string password)
 
void set_password (string password)
 
map< public_key_type, string > list_keys ()
 
string get_help (const string &method) const
 
bool load_wallet_file (string wallet_filename="")
 
void save_wallet_file (string wallet_filename="")
 
void set_wallet_filename (string wallet_filename)
 
brain_key_info suggest_brain_key () const
 
string serialize_transaction (signed_transaction tx) const
 
bool import_key (string wif_key)
 
string normalize_brain_key (string s) const
 
annotated_signed_transaction create_account (string creator, string new_account_name, string json_meta, bool broadcast)
 
annotated_signed_transaction create_account_with_keys (string creator, string newname, string json_meta, public_key_type owner, public_key_type active, public_key_type posting, public_key_type memo, bool broadcast) const
 
annotated_signed_transaction create_account_delegated (string creator, asset< 0, 17, 0 > steem_fee, asset< 0, 17, 0 > delegated_vests, string new_account_name, string json_meta, bool broadcast)
 
annotated_signed_transaction create_account_with_keys_delegated (string creator, asset< 0, 17, 0 > steem_fee, asset< 0, 17, 0 > delegated_vests, string newname, string json_meta, public_key_type owner, public_key_type active, public_key_type posting, public_key_type memo, bool broadcast) const
 
annotated_signed_transaction update_account (string accountname, string json_meta, public_key_type owner, public_key_type active, public_key_type posting, public_key_type memo, bool broadcast) const
 
annotated_signed_transaction update_account_auth_key (string account_name, authority_type type, public_key_type key, weight_type weight, bool broadcast)
 
annotated_signed_transaction update_account_auth_account (string account_name, authority_type type, string auth_account, weight_type weight, bool broadcast)
 
annotated_signed_transaction update_account_auth_threshold (string account_name, authority_type type, uint32_t threshold, bool broadcast)
 
annotated_signed_transaction update_account_meta (string account_name, string json_meta, bool broadcast)
 
annotated_signed_transaction update_account_memo_key (string account_name, public_key_type key, bool broadcast)
 
annotated_signed_transaction delegate_vesting_shares (string delegator, string delegatee, asset< 0, 17, 0 > vesting_shares, bool broadcast)
 
transaction_id_type get_transaction_id (const signed_transaction &trx) const
 
set< account_name_type > list_witnesses (const string &lowerbound, uint32_t limit)
 
optional< witness_api_objget_witness (string owner_account)
 
vector< convert_request_objectget_conversion_requests (string owner)
 
annotated_signed_transaction update_witness (string witness_name, string url, public_key_type block_signing_key, const chain_properties< 0, 17, 0 > &props, bool broadcast=false)
 
annotated_signed_transaction set_voting_proxy (string account_to_modify, string proxy, bool broadcast=false)
 
annotated_signed_transaction vote_for_witness (string account_to_vote_with, string witness_to_vote_for, bool approve=true, bool broadcast=false)
 
annotated_signed_transaction transfer (string from, string to, asset< 0, 17, 0 > amount, string memo, bool broadcast=false)
 
annotated_signed_transaction escrow_transfer (string from, string to, string agent, uint32_t escrow_id, asset< 0, 17, 0 > sbd_amount, asset< 0, 17, 0 > steem_amount, asset< 0, 17, 0 > fee, time_point_sec ratification_deadline, time_point_sec escrow_expiration, string json_meta, bool broadcast=false)
 
annotated_signed_transaction escrow_approve (string from, string to, string agent, string who, uint32_t escrow_id, bool approve, bool broadcast=false)
 
annotated_signed_transaction escrow_dispute (string from, string to, string agent, string who, uint32_t escrow_id, bool broadcast=false)
 
annotated_signed_transaction escrow_release (string from, string to, string agent, string who, string receiver, uint32_t escrow_id, asset< 0, 17, 0 > sbd_amount, asset< 0, 17, 0 > steem_amount, bool broadcast=false)
 
annotated_signed_transaction transfer_to_vesting (string from, string to, asset< 0, 17, 0 > amount, bool broadcast=false)
 
annotated_signed_transaction transfer_to_savings (string from, string to, asset< 0, 17, 0 > amount, string memo, bool broadcast=false)
 
annotated_signed_transaction transfer_from_savings (string from, uint32_t request_id, string to, asset< 0, 17, 0 > amount, string memo, bool broadcast=false)
 
annotated_signed_transaction cancel_transfer_from_savings (string from, uint32_t request_id, bool broadcast=false)
 
annotated_signed_transaction withdraw_vesting (string from, asset< 0, 17, 0 > vesting_shares, bool broadcast=false)
 
annotated_signed_transaction set_withdraw_vesting_route (string from, string to, uint16_t percent, bool auto_vest, bool broadcast=false)
 
annotated_signed_transaction convert_sbd (string from, asset< 0, 17, 0 > amount, bool broadcast=false)
 
annotated_signed_transaction publish_feed (string witness, price< 0, 17, 0 > exchange_rate, bool broadcast)
 
annotated_signed_transaction sign_transaction (signed_transaction tx, bool broadcast=false)
 
operation get_prototype_operation (string operation_type)
 
void network_add_nodes (const vector< string > &nodes)
 
vector< variant > network_get_connected_peers ()
 
market_history::order_book get_order_book (const string &base, const string &quote, unsigned limit=50)
 
vector< extended_limit_orderget_limit_orders_by_owner (string account_name)
 
vector< call_order_objectget_call_orders_by_owner (string account_name)
 
vector< force_settlement_objectget_settle_orders_by_owner (string account_name)
 
vector< collateral_bid_objectget_collateral_bids (string asset, uint32_t limit=100, uint32_t start=0) const
 
signed_transaction bid_collateral (string bidder_name, string debt_amount, string debt_symbol, string additional_collateral, bool broadcast=false)
 
annotated_signed_transaction create_order (string owner, uint32_t order_id, asset< 0, 17, 0 > amount_to_sell, asset< 0, 17, 0 > min_to_receive, bool fill_or_kill, uint32_t expiration, bool broadcast)
 
annotated_signed_transaction cancel_order (string owner, protocol::integral_id_type order_id, bool broadcast)
 
signed_transaction sell_asset (string seller_account, asset< 0, 17, 0 > amount_to_sell, asset< 0, 17, 0 > amount_to_receive, uint32_t timeout_sec, protocol::integral_id_type order_id, bool fill_or_kill, bool broadcast)
 
signed_transaction sell (string seller_account, string base, string quote, double rate, double amount, protocol::integral_id_type order_id, bool broadcast)
 
signed_transaction buy (string buyer_account, string base, string quote, double rate, double amount, protocol::integral_id_type order_id, bool broadcast)
 
signed_transaction borrow_asset (string borrower_name, asset< 0, 17, 0 > amount_to_borrow, asset< 0, 17, 0 > amount_of_collateral, bool broadcast)
 
signed_transaction create_asset (string issuer, string symbol, uint8_t precision, asset_options< 0, 17, 0 > common, fc::optional< bitasset_options > bitasset_opts, bool broadcast=false)
 
signed_transaction issue_asset (string to_account, asset< 0, 17, 0 > amount, string memo, bool broadcast=false)
 
signed_transaction update_asset (string symbol, optional< string > new_issuer, asset_options< 0, 17, 0 > new_options, bool broadcast=false)
 
signed_transaction update_bitasset (string symbol, bitasset_options new_options, bool broadcast=false)
 
signed_transaction update_asset_feed_producers (string symbol, flat_set< string > new_feed_producers, bool broadcast=false)
 
signed_transaction publish_asset_feed (string publishing_account, string symbol, price_feed< 0, 17, 0 > feed, bool broadcast=false)
 
signed_transaction fund_asset_fee_pool (string from, string symbol, string amount, bool broadcast=false)
 
signed_transaction reserve_asset (string from, string amount, string symbol, bool broadcast=false)
 
signed_transaction global_settle_asset (string symbol, price< 0, 17, 0 > settle_price, bool broadcast=false)
 
signed_transaction settle_asset (string account_to_settle, string amount_to_settle, string symbol, bool broadcast=false)
 
signed_transaction whitelist_account (string authorizing_account, string account_to_list, account_whitelist_operation< 0, 17, 0 >::account_listing new_listing_status, bool broadcast=false)
 
annotated_signed_transaction post_comment (string author, string permlink, string parent_author, string parent_permlink, string title, string body, string json, bool broadcast)
 
annotated_signed_transaction extend_payout_by_cost (string payer, string author, string permlink, asset< 0, 17, 0 > extension_cost, bool broadcast)
 
annotated_signed_transaction extend_payout_by_time (string payer, string author, string permlink, fc::time_point_sec extension_time, bool broadcast)
 
annotated_signed_transaction send_private_message (string from, string to, string subject, string body, bool broadcast)
 
vector< extended_message_objectget_inbox (string account, fc::time_point newest, uint32_t limit)
 
vector< extended_message_objectget_outbox (string account, fc::time_point newest, uint32_t limit)
 
message_body try_decrypt_message (const message_api_obj &mo)
 
annotated_signed_transaction vote (string voter, string author, string permlink, int16_t weight, bool broadcast)
 
void set_transaction_expiration (uint32_t seconds)
 
annotated_signed_transaction challenge (string challenger, string challenged, bool broadcast)
 
annotated_signed_transaction request_account_recovery (string recovery_account, string account_to_recover, authority new_authority, bool broadcast)
 
annotated_signed_transaction recover_account (string account_to_recover, authority recent_authority, authority new_authority, bool broadcast)
 
annotated_signed_transaction change_recovery_account (string owner, string new_recovery_account, bool broadcast)
 
vector< owner_authority_history_api_objget_owner_history (string account) const
 
annotated_signed_transaction prove (string challenged, bool broadcast)
 
map< uint32_t, applied_operationget_account_history (string account, uint32_t from, uint32_t limit)
 
annotated_signed_transaction follow (string follower, string following, set< string > what, bool broadcast)
 
annotated_signed_transaction reblog (string account, string author, string permlink, bool broadcast)
 
std::map< string, std::function< string(fc::variant, const fc::variants &)> > get_result_formatters () const
 
void encrypt_keys ()
 
string get_encrypted_memo (string from, string to, string memo)
 
string decrypt_memo (string memo)
 
annotated_signed_transaction decline_voting_rights (string account, bool decline, bool broadcast)
 
signed_transaction approve_proposal (const string &owner, integral_id_type proposal_id, const approval_delta &delta, bool broadcast)
 
transaction_handle_type begin_builder_transaction ()
 
void add_operation_to_builder_transaction (transaction_handle_type transaction_handle, const operation &op)
 
void replace_operation_in_builder_transaction (transaction_handle_type handle, unsigned operation_index, const operation &new_op)
 
transaction preview_builder_transaction (transaction_handle_type handle)
 
signed_transaction sign_builder_transaction (transaction_handle_type transaction_handle, bool broadcast=true)
 
signed_transaction propose_builder_transaction (transaction_handle_type handle, time_point_sec expiration=time_point::now()+fc::minutes(1), uint32_t review_period_seconds=0, bool broadcast=true)
 
signed_transaction propose_builder_transaction2 (transaction_handle_type handle, string account_name_or_id, time_point_sec expiration=time_point::now()+fc::minutes(1), uint32_t review_period_seconds=0, bool broadcast=true)
 
void remove_builder_transaction (transaction_handle_type handle)
 

Public Attributes

fc::signal< void(bool)> lock_changed
 
std::shared_ptr< detail::wallet_api_implmy
 

Detailed Description

This wallet assumes it is connected to the database server with a high-bandwidth, low-latency connection and performs minimal caching. This API could be provided locally to be used by a web interface.

Definition at line 104 of file wallet.hpp.

Constructor & Destructor Documentation

◆ wallet_api()

golos::wallet::wallet_api::wallet_api ( const wallet_data initial_data,
fc::api< login_api rapi 
)

Definition at line 1191 of file wallet.cpp.

◆ ~wallet_api()

golos::wallet::wallet_api::~wallet_api ( )
virtual

Definition at line 1195 of file wallet.cpp.

Member Function Documentation

◆ about()

variant_object golos::wallet::wallet_api::about ( ) const

Returns info such as client version, git version of graphene/fc, version of boost, openssl.

Returns
compile time info and client and dependencies versions

Definition at line 1418 of file wallet.cpp.

◆ add_operation_to_builder_transaction()

void golos::wallet::wallet_api::add_operation_to_builder_transaction ( transaction_handle_type  transaction_handle,
const operation &  op 
)

Definition at line 1337 of file wallet.cpp.

◆ approve_proposal()

signed_transaction golos::wallet::wallet_api::approve_proposal ( const string &  owner,
integral_id_type  proposal_id,
const approval_delta delta,
bool  broadcast 
)

Approve or disapprove a proposal.

Parameters
ownerThe account paying the fee for the op.
proposal_idThe proposal to modify.
deltaMembers contain approvals to create or remove. In JSON you can leave empty members undefi ned.
broadcasttrue if you wish to broadcast the transaction
Returns
the signed version of the transaction

Definition at line 3052 of file wallet.cpp.

◆ begin_builder_transaction()

transaction_handle_type golos::wallet::wallet_api::begin_builder_transaction ( )

Definition at line 1333 of file wallet.cpp.

◆ bid_collateral()

signed_transaction golos::wallet::wallet_api::bid_collateral ( string  bidder_name,
string  debt_amount,
string  debt_symbol,
string  additional_collateral,
bool  broadcast = false 
)

Creates or updates a bid on an MPA after global settlement.

In order to revive a market-pegged asset after global settlement (aka black swan), investors can bid collateral in order to take over part of the debt and the settlement fund, see BSIP-0018. Updating an existing bid to cover 0 debt will delete the bid.

Parameters
bidder_namethe name or id of the account making the bid
debt_amountthe amount of debt of the named asset to bid for
debt_symbolthe name or id of the MPA to bid for
additional_collateralthe amount of additional collateral to bid for taking over debt_amount. The asset type of this amount is determined automatically from debt_symbol.
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction creating/updating the bid

Definition at line 1291 of file wallet.cpp.

◆ borrow_asset()

signed_transaction golos::wallet::wallet_api::borrow_asset ( string  borrower_name,
asset< 0, 17, 0 >  amount_to_borrow,
asset< 0, 17, 0 >  amount_of_collateral,
bool  broadcast 
)

Borrow an asset or update the debt/collateral ratio for the loan.

This is the first step in shorting an asset. Call sell_asset() to complete the short.

Parameters
borrower_namethe name or id of the account associated with the transaction.
amount_to_borrowthe amount of the asset being borrowed. Make this value negative to pay back debt.
amount_of_collateralthe amount of the backing asset to add to your collateral position. Make this negative to claim back some of your collateral. The backing asset is defined in the bitasset_options for the asset being borrowed.
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction borrowing the asset

Definition at line 2520 of file wallet.cpp.

◆ buy()

signed_transaction golos::wallet::wallet_api::buy ( string  buyer_account,
string  base,
string  quote,
double  rate,
double  amount,
protocol::integral_id_type  order_id,
bool  broadcast 
)

Place a limit order attempting to buy one asset with another.

This API call abstracts away some of the details of the sell_asset call to be more user friendly. All orders placed with buy never timeout and will not be killed if they cannot be filled immediately. If you wish for one of these parameters to be different, then sell_asset should be used instead.

Parameters
buyer_accountThe account buying the asset for another asset.
baseThe name or id of the asset to buy.
quoteThe name or id of the assest being offered as payment.
rateThe rate in base:quote at which you want to buy.
amountthe amount of base you want to buy.
broadcasttrue to broadcast the transaction on the network.
Returns
The signed transaction selling the funds.

Definition at line 2515 of file wallet.cpp.

◆ cancel_order()

annotated_signed_transaction golos::wallet::wallet_api::cancel_order ( string  owner,
protocol::integral_id_type  order_id,
bool  broadcast 
)

Cancel an order created with create_order

Parameters
ownerThe name of the account owning the order to cancel_order
order_idThe unique identifier assigned to the order by its creator
broadcasttrue if you wish to broadcast the transaction

Definition at line 2469 of file wallet.cpp.

◆ cancel_transfer_from_savings()

annotated_signed_transaction golos::wallet::wallet_api::cancel_transfer_from_savings ( string  from,
uint32_t  request_id,
bool  broadcast = false 
)
Parameters
request_idthe id used in transfer_from_savings
fromthe account that initiated the transfer
broadcasttrue if you wish to broadcast the transaction
request_idthe id used in transfer_from_savings
fromthe account that initiated the transfer

Definition at line 2234 of file wallet.cpp.

◆ challenge()

annotated_signed_transaction golos::wallet::wallet_api::challenge ( string  challenger,
string  challenged,
bool  broadcast 
)

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

Parameters
challengerThe account issuing the challenge
challengedThe account being challenged
broadcasttrue if you wish to broadcast the transaction

Definition at line 2852 of file wallet.cpp.

◆ change_recovery_account()

annotated_signed_transaction golos::wallet::wallet_api::change_recovery_account ( string  owner,
string  new_recovery_account,
bool  broadcast 
)

Change your recovery account after a 30 day delay.

Parameters
ownerThe name of your account
new_recovery_accountThe name of the recovery account you wish to have
broadcasttrue if you wish to broadcast the transaction

Definition at line 1681 of file wallet.cpp.

◆ convert_sbd()

annotated_signed_transaction golos::wallet::wallet_api::convert_sbd ( string  from,
asset< 0, 17, 0 >  amount,
bool  broadcast = false 
)

This method will convert SBD to GOLOS at the current_median_history price one week from the time it is executed. This method depends upon there being a valid price feed.

Parameters
fromThe account requesting conversion of its SBD i.e. "1.000 SBD"
amountThe amount of SBD to convert
broadcasttrue if you wish to broadcast the transaction

Definition at line 2292 of file wallet.cpp.

◆ copy_wallet_file()

bool golos::wallet::wallet_api::copy_wallet_file ( string  destination_filename)

Definition at line 1198 of file wallet.cpp.

◆ create_account()

annotated_signed_transaction golos::wallet::wallet_api::create_account ( string  creator,
string  new_account_name,
string  json_meta,
bool  broadcast 
)

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
creatorThe account creating the new account
new_account_nameThe name of the new account
json_metaJSON Metadata associated with the new account
broadcasttrue 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 1970 of file wallet.cpp.

◆ create_account_delegated()

annotated_signed_transaction golos::wallet::wallet_api::create_account_delegated ( string  creator,
asset< 0, 17, 0 >  steem_fee,
asset< 0, 17, 0 >  delegated_vests,
string  new_account_name,
string  json_meta,
bool  broadcast 
)

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 GOLOS and delegated GP

Parameters
creatorThe account creating the new account
steem_feeThe amount of the fee to be paid with GOLOS
delegated_vestsThe amount of the fee to be paid with delegation
new_account_nameThe name of the new account
json_metaJSON Metadata associated with the new account
broadcasttrue if you wish to broadcast the transaction

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

Definition at line 1991 of file wallet.cpp.

◆ create_account_with_keys()

annotated_signed_transaction golos::wallet::wallet_api::create_account_with_keys ( string  creator,
string  new_account_name,
string  json_meta,
public_key_type  owner,
public_key_type  active,
public_key_type  posting,
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 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
creatorThe account creating the new account
newnameThe name of the new account
json_metaJSON Metadata associated with the new account
ownerpublic owner key of the new account
activepublic active key of the new account
postingpublic posting key of the new account
memopublic memo key of the new account
broadcasttrue 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 1586 of file wallet.cpp.

◆ create_account_with_keys_delegated()

annotated_signed_transaction golos::wallet::wallet_api::create_account_with_keys_delegated ( string  creator,
asset< 0, 17, 0 >  steem_fee,
asset< 0, 17, 0 >  delegated_vests,
string  new_account_name,
string  json_meta,
public_key_type  owner,
public_key_type  active,
public_key_type  posting,
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 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 GOLOS and delegated GP

Parameters
creatorThe account creating the new account
steem_feeThe amount of the fee to be paid with GOLOS
delegated_vestsThe amount of the fee to be paid with delegation
newnameThe name of the new account
json_metaJSON Metadata associated with the new account
ownerpublic owner key of the new account
activepublic active key of the new account
postingpublic posting key of the new account
memopublic memo key of the new account
broadcasttrue 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 1617 of file wallet.cpp.

◆ create_asset()

signed_transaction golos::wallet::wallet_api::create_asset ( string  issuer,
string  symbol,
uint8_t  precision,
asset_options< 0, 17, 0 >  common,
fc::optional< bitasset_options >  bitasset_opts,
bool  broadcast = false 
)

Creates a new user-issued or market-issued asset.

Many options can be changed later using update_asset()

Right now this function is difficult to use because you must provide raw JSON data structures for the options objects, and those include prices and asset ids.

Parameters
issuerthe name or id of the account who will pay the fee and become the issuer of the new asset. This can be updated later
symbolthe ticker symbol of the new asset
precisionthe number of digits of precision to the right of the decimal point, must be less than or equal to 12
commonasset options required for all new assets. Note that core_exchange_rate technically needs to store the asset ID of this new asset. Since this ID is not known at the time this operation is created, create this price as though the new asset has instance ID 1, and the chain will overwrite it with the new asset's ID.
bitasset_optsoptions specific to BitAssets. This may be null unless the market_issued flag is set in common.flags
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction creating a new asset

Definition at line 2563 of file wallet.cpp.

◆ create_order()

annotated_signed_transaction golos::wallet::wallet_api::create_order ( string  owner,
uint32_t  order_id,
asset< 0, 17, 0 >  amount_to_sell,
asset< 0, 17, 0 >  min_to_receive,
bool  fill_or_kill,
uint32_t  expiration,
bool  broadcast 
)

Creates a limit order at the price amount_to_sell / min_to_receive and will deduct amount_to_sell from account

Parameters
ownerThe name of the account creating the order
order_idis a unique identifier assigned by the creator of the order, it can be reused after the order has been filled
amount_to_sellThe amount of either SBD or GOLOS you wish to sell
min_to_receiveThe amount of the other asset you will receive at a minimum
fill_or_killtrue if you want the order to be killed if it cannot immediately be filled
expirationthe time the order should expire if it has not been filled
broadcasttrue if you wish to broadcast the transaction

Definition at line 2448 of file wallet.cpp.

◆ decline_voting_rights()

annotated_signed_transaction golos::wallet::wallet_api::decline_voting_rights ( string  account,
bool  decline,
bool  broadcast 
)

Definition at line 2363 of file wallet.cpp.

◆ decrypt_memo()

string golos::wallet::wallet_api::decrypt_memo ( string  memo)

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

Definition at line 2324 of file wallet.cpp.

◆ delegate_vesting_shares()

annotated_signed_transaction golos::wallet::wallet_api::delegate_vesting_shares ( string  delegator,
string  delegatee,
asset< 0, 17, 0 >  vesting_shares,
bool  broadcast 
)

This method delegates VESTS from one account to another.

Parameters
delegatorThe name of the account delegating VESTS
delegateeThe name of the account receiving VESTS
vesting_sharesThe amount of VESTS to delegate
broadcasttrue if you wish to broadcast the transaction

Definition at line 1944 of file wallet.cpp.

◆ encrypt_keys()

void golos::wallet::wallet_api::encrypt_keys ( )

Definition at line 1513 of file wallet.cpp.

◆ escrow_approve()

annotated_signed_transaction golos::wallet::wallet_api::escrow_approve ( string  from,
string  to,
string  agent,
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
fromThe account that funded the escrow
toThe destination of the escrow
agentThe account acting as the agent in case of dispute
whoThe account approving the escrow transfer (either 'to' or 'agent)
escrow_idA unique id for the escrow transfer
approvetrue to approve the escrow transfer, otherwise cancels it and refunds 'from'
broadcasttrue if you wish to broadcast the transaction

Definition at line 2135 of file wallet.cpp.

◆ escrow_dispute()

annotated_signed_transaction golos::wallet::wallet_api::escrow_dispute ( string  from,
string  to,
string  agent,
string  who,
uint32_t  escrow_id,
bool  broadcast = false 
)

Raise a dispute on the escrow transfer before it expires

Parameters
fromThe account that funded the escrow
toThe destination of the escrow
agentThe account acting as the agent in case of dispute
whoThe account raising the dispute (either 'from' or 'to')
escrow_idA unique id for the escrow transfer
broadcasttrue if you wish to broadcast the transaction

Definition at line 2152 of file wallet.cpp.

◆ escrow_release()

annotated_signed_transaction golos::wallet::wallet_api::escrow_release ( string  from,
string  to,
string  agent,
string  who,
string  receiver,
uint32_t  escrow_id,
asset< 0, 17, 0 >  sbd_amount,
asset< 0, 17, 0 >  steem_amount,
bool  broadcast = false 
)

Release funds help in escrow

Parameters
fromThe account that funded the escrow
toThe account the funds are originally going to
agentThe account acting as the agent in case of dispute
whoThe account authorizing the release
receiverThe account that will receive funds being released
escrow_idA unique id for the escrow transfer
sbd_amountThe amount of SBD that will be released
steem_amountThe amount of GOLOS that will be released
broadcasttrue if you wish to broadcast the transaction

Definition at line 2169 of file wallet.cpp.

◆ escrow_transfer()

annotated_signed_transaction golos::wallet::wallet_api::escrow_transfer ( string  from,
string  to,
string  agent,
uint32_t  escrow_id,
asset< 0, 17, 0 >  sbd_amount,
asset< 0, 17, 0 >  steem_amount,
asset< 0, 17, 0 >  fee,
time_point_sec  ratification_deadline,
time_point_sec  escrow_expiration,
string  json_meta,
bool  broadcast = false 
)

Transfer funds from one account to another using escrow. GOLOS and SBD can be transferred.

Parameters
fromThe account the funds are coming from
toThe account the funds are going to
agentThe account acting as the agent in case of dispute
escrow_idA unique id for the escrow transfer. (from, escrow_id) must be a unique pair
sbd_amountThe amount of SBD to transfer
steem_amountThe amount of GOLOS to transfer
feeThe fee paid to the agent
ratification_deadlineThe deadline for 'to' and 'agent' to approve the escrow transfer
escrow_expirationThe expiration of the escrow transfer, after which either party can claim the funds
json_metaJSON encoded meta data
broadcasttrue if you wish to broadcast the transaction

Definition at line 2109 of file wallet.cpp.

◆ extend_payout_by_cost()

annotated_signed_transaction golos::wallet::wallet_api::extend_payout_by_cost ( string  payer,
string  author,
string  permlink,
asset< 0, 17, 0 >  extension_cost,
bool  broadcast 
)

Extend the comment payout window by passing the required SBD to spend

Parameters
payerthe name of the account paying for the transaction
authorthe name of the account authoring the comment
permlinkcomment permlink
extension_costSBD amount payer will spend on payout window extension
broadcasttrue if you wish to broadcast the transaction

Definition at line 2795 of file wallet.cpp.

◆ extend_payout_by_time()

annotated_signed_transaction golos::wallet::wallet_api::extend_payout_by_time ( string  payer,
string  author,
string  permlink,
fc::time_point_sec  extension_time,
bool  broadcast 
)

Extend the comment payout window by passing the required SBD to spend

Parameters
payerthe name of the account paying for the transaction
authorthe name of the account authoring the comment
permlinkcomment permlink
extension_timethe payout window final time point
broadcasttrue if you wish to broadcast the transaction

Definition at line 2812 of file wallet.cpp.

◆ follow()

annotated_signed_transaction golos::wallet::wallet_api::follow ( string  follower,
string  following,
set< string >  what,
bool  broadcast 
)

Marks one account as following another account. Requires the posting authority of the follower.

Parameters
followeraccount name to follow with
followingaccount name to follow for
what- a set of things to follow: posts, comments, votes, ignore
broadcasttrue if you wish to broadcast the transaction

Definition at line 2886 of file wallet.cpp.

◆ fund_asset_fee_pool()

signed_transaction golos::wallet::wallet_api::fund_asset_fee_pool ( string  from,
string  symbol,
string  amount,
bool  broadcast = false 
)

Pay into the fee pool for the given asset.

User-issued assets can optionally have a pool of the core asset which is automatically used to pay transaction fees for any transaction using that asset (using the asset's core exchange rate).

This command allows anyone to deposit the core asset into this fee pool.

Parameters
fromthe name or id of the account sending the core asset
symbolthe name or id of the asset whose fee pool you wish to fund
amountthe amount of the core asset to deposit
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction funding the fee pool

Definition at line 2676 of file wallet.cpp.

◆ get_account()

account_api_obj golos::wallet::wallet_api::get_account ( string  account_name) const

Returns information about the given account.

Parameters
account_namethe name of the account to provide information about
Returns
the public account data stored in the blockchain

Definition at line 1374 of file wallet.cpp.

◆ get_account_count()

string golos::wallet::wallet_api::get_account_count ( ) const

Returns the amount of accounts registered in blockchain

Definition at line 1210 of file wallet.cpp.

◆ get_account_history()

map< uint32_t, applied_operation > golos::wallet::wallet_api::get_account_history ( string  account,
uint32_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 1000], must be less than from

Definition at line 2376 of file wallet.cpp.

◆ get_active_witnesses()

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

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

Definition at line 1275 of file wallet.cpp.

◆ get_asset()

asset_object golos::wallet::wallet_api::get_asset ( string  asset_symbol) const

Returns information about the given asset.

Parameters
asset_symbolthe symbol of the asset in the request
Returns
the information about the asset stored in the block chain

Definition at line 1378 of file wallet.cpp.

◆ get_bitasset_data()

asset_bitasset_data_object golos::wallet::wallet_api::get_bitasset_data ( string  asset_symbol) const

Returns the BitAsset-specific data for a given asset. Market-issued assets's behavior are determined both by their "BitAsset Data" and their basic asset data, as returned by get_asset().

Parameters
asset_symbolthe symbol of the BitAsset in the request
Returns
the BitAsset-specific data for this asset

Definition at line 1385 of file wallet.cpp.

◆ get_block()

optional< signed_block_with_info > golos::wallet::wallet_api::get_block ( uint32_t  num)

Returns the information about a block

Parameters
numBlock num
Returns
Public block data on the blockchain

Definition at line 1202 of file wallet.cpp.

◆ get_call_orders_by_owner()

vector< call_order_object > golos::wallet::wallet_api::get_call_orders_by_owner ( string  account_name)

Definition at line 2426 of file wallet.cpp.

◆ get_collateral_bids()

vector< collateral_bid_object > golos::wallet::wallet_api::get_collateral_bids ( string  asset,
uint32_t  limit = 100,
uint32_t  start = 0 
) const

Returns the collateral_bid object for the given MPA

Parameters
assetthe name or id of the asset
limitthe number of entries to return
startthe sequence number where to start looping back throw the history
Returns
a list of collateral_bid_objects

Definition at line 1279 of file wallet.cpp.

◆ get_conversion_requests()

vector< convert_request_object > golos::wallet::wallet_api::get_conversion_requests ( string  owner)

Returns conversion requests by an account

Parameters
ownerAccount name of the account owning the requests
Returns
All pending conversion requests by account

Definition at line 2320 of file wallet.cpp.

◆ get_dynamic_global_properties()

dynamic_global_property_object golos::wallet::wallet_api::get_dynamic_global_properties ( ) const

Returns the block chain's rapidly-changing properties. The returned object contains information that changes every block interval such as the head block number, the next witness, etc.

See also
get_global_properties() for less-frequently changing properties
Returns
the dynamic global properties

Definition at line 1267 of file wallet.cpp.

◆ get_encrypted_memo()

string golos::wallet::wallet_api::get_encrypted_memo ( string  from,
string  to,
string  memo 
)

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

Definition at line 2059 of file wallet.cpp.

◆ get_feed_history()

feed_history_api_obj golos::wallet::wallet_api::get_feed_history ( ) const

Return the current price feed history

Returns
Price feed history data on the blockchain

Definition at line 1577 of file wallet.cpp.

◆ get_help()

string golos::wallet::wallet_api::get_help ( const string &  method) const

Returns detailed help on a single API command.

Parameters
methodthe name of the API command you want help with
Returns
a multi-line string suitable for displaying on a terminal

Definition at line 1477 of file wallet.cpp.

◆ get_inbox()

vector< extended_message_object > golos::wallet::wallet_api::get_inbox ( string  account,
fc::time_point  newest,
uint32_t  limit 
)

Retrieves the private message inbox for the account mentioned

Parameters
accountaccount to retrieve inbox for
newesttimestamp to start retrieve messages from
limitamount of messages to retrieve
Returns
message api objects vector

Definition at line 3030 of file wallet.cpp.

◆ get_limit_orders_by_owner()

vector< extended_limit_order > golos::wallet::wallet_api::get_limit_orders_by_owner ( string  account_name)

Definition at line 2415 of file wallet.cpp.

◆ get_miner_queue()

vector< account_name_type > golos::wallet::wallet_api::get_miner_queue ( ) const

Returns the queue of pow miners waiting to produce blocks.

Definition at line 1271 of file wallet.cpp.

◆ get_ops_in_block()

vector< applied_operation > golos::wallet::wallet_api::get_ops_in_block ( uint32_t  block_num,
bool  only_virtual = true 
)

Returns sequence of operations included/generated in a specified block

Parameters
block_numBlock height of specified block
only_virtualWhether to only return virtual operations

Definition at line 1206 of file wallet.cpp.

◆ get_order_book()

market_history::order_book golos::wallet::wallet_api::get_order_book ( const string &  base,
const string &  quote,
unsigned  limit = 50 
)

Gets the current order book for selected asset pair

Parameters
baseBase symbol string
quoteQuote symbol string
limitMaximum number of orders to return for bids and asks. Max is 1000.

Definition at line 2402 of file wallet.cpp.

◆ get_outbox()

vector< extended_message_object > golos::wallet::wallet_api::get_outbox ( string  account,
fc::time_point  newest,
uint32_t  limit 
)

Retrieves the private message outbox for the account mentioned

Parameters
accountaccount to retrieve outbox for
newesttimestamp to start retireve messages from
limitamount of messages to retrieve
Returns
message api objects vector

Definition at line 3041 of file wallet.cpp.

◆ get_owner_history()

vector< owner_authority_history_api_obj > golos::wallet::wallet_api::get_owner_history ( string  account) const

Definition at line 1696 of file wallet.cpp.

◆ get_private_key()

string golos::wallet::wallet_api::get_private_key ( public_key_type  pubkey) const

Get the WIF private key corresponding to a public key. The private key must already be in the wallet.

Definition at line 1555 of file wallet.cpp.

◆ get_private_key_from_password()

pair< public_key_type, string > golos::wallet::wallet_api::get_private_key_from_password ( string  account,
string  role,
string  password 
) const
Parameters
role- active | owner | posting | memo

Definition at line 1559 of file wallet.cpp.

◆ get_proposal()

proposal_object golos::wallet::wallet_api::get_proposal ( string  account_name,
integral_id_type  id 
) const

Returns information about the given proposed_transaction.

Parameters
account_namethe proposal author name
idthe proposal identification number unique for the account given
Returns
the information about the asset stored in the block chain

Definition at line 1389 of file wallet.cpp.

◆ get_prototype_operation()

operation golos::wallet::wallet_api::get_prototype_operation ( string  operation_type)

Returns an uninitialized object representing a given blockchain operation.

This returns a default-initialized object of the given type; it can be used during early development of the wallet when we don't yet have custom commands for creating all of the operations the blockchain supports.

Any operation the blockchain supports can be created using the transaction builder's add_operation_to_builder_transaction() , but to do that from the CLI you need to know what the JSON form of the operation looks like. This will give you a template you can fill in. It's better than nothing.

Parameters
operation_typethe type of operation to return, must be one of the operations defined in steemit/chain/operations.hpp (e.g., "global_parameters_update_operation")
Returns
a default-constructed operation of the given type

Definition at line 1452 of file wallet.cpp.

◆ get_result_formatters()

std::map< string, std::function< string(fc::variant, const fc::variants &)> > golos::wallet::wallet_api::get_result_formatters ( ) const

Definition at line 1501 of file wallet.cpp.

◆ get_settle_orders_by_owner()

vector< force_settlement_object > golos::wallet::wallet_api::get_settle_orders_by_owner ( string  account_name)

Definition at line 2437 of file wallet.cpp.

◆ get_steem_per_mvests()

string golos::wallet::wallet_api::get_steem_per_mvests ( ) const

Gets the steem price per mvests

Definition at line 1214 of file wallet.cpp.

◆ get_transaction()

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

Returns transaction by ID.

Definition at line 2882 of file wallet.cpp.

◆ get_transaction_id()

transaction_id_type golos::wallet::wallet_api::get_transaction_id ( const signed_transaction &  trx) const
inline

This method is used to convert a JSON transaction to its transaction ID.

Definition at line 582 of file wallet.hpp.

◆ get_wallet_filename()

string golos::wallet::wallet_api::get_wallet_filename ( ) const

Returns the current wallet filename.

This is the filename that will be used when automatically saving the wallet.

See also
set_wallet_filename()
Returns
the wallet filename

Definition at line 1329 of file wallet.cpp.

◆ get_withdraw_routes()

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

Returns vesting withdraw routes for an account.

Parameters
accountAccount to query routes
typeWithdraw type type [incoming, outgoing, all]

Definition at line 2398 of file wallet.cpp.

◆ get_witness()

optional< witness_api_obj > golos::wallet::wallet_api::get_witness ( string  owner_account)

Returns information about the given witness.

Parameters
owner_accountthe 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 1433 of file wallet.cpp.

◆ global_settle_asset()

signed_transaction golos::wallet::wallet_api::global_settle_asset ( string  symbol,
price< 0, 17, 0 >  settle_price,
bool  broadcast = false 
)

Forces a global settling of the given asset (black swan or prediction markets).

In order to use this operation, asset_to_settle must have the global_settle flag set

When this operation is executed all balances are converted into the backing asset at the settle_price and all open margin positions are called at the settle price. If this asset is used as backing for other bitassets, those bitassets will be force settled at their current feed price.

Note
this operation is used only by the asset issuer, settle_asset() may be used by any user owning the asset
Parameters
symbolthe name or id of the asset to force settlement on
settle_pricethe price at which to settle
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction settling the named asset

Definition at line 2718 of file wallet.cpp.

◆ help()

string golos::wallet::wallet_api::help ( ) const

Returns a list of all commands supported by the wallet API.

This lists each command, along with its arguments and return types. For more detailed help on a single command, use get_help()

Returns
a multi-line string suitable for displaying on a terminal

Definition at line 1464 of file wallet.cpp.

◆ import_key()

bool golos::wallet::wallet_api::import_key ( string  wif_key)

Imports a WIF Private Key into the wallet to be used to sign transactions by an account.

example: import_key 5KQwrPbwdL6PhXujxW37FSSQZ1JiwsST4cqQzDeyXtP79zkvFD3

Parameters
wif_keythe WIF Private Key to import

Definition at line 1393 of file wallet.cpp.

◆ info()

variant golos::wallet::wallet_api::info ( )

Returns info about the current state of the blockchain

Definition at line 1414 of file wallet.cpp.

◆ is_locked()

bool golos::wallet::wallet_api::is_locked ( ) const

Checks whether the wallet is locked (is unable to use its private keys).

This state can be changed by calling lock() or unlock().

Returns
true if the wallet is locked

Definition at line 1505 of file wallet.cpp.

◆ is_new()

bool golos::wallet::wallet_api::is_new ( ) const

Checks whether the wallet has just been created and has not yet had a password set.

Calling set_password will transition the wallet to the locked state.

Returns
true if the wallet is new

Definition at line 1509 of file wallet.cpp.

◆ issue_asset()

signed_transaction golos::wallet::wallet_api::issue_asset ( string  to_account,
asset< 0, 17, 0 >  amount,
string  memo,
bool  broadcast = false 
)

Issue new shares of an asset.

Parameters
to_accountthe name or id of the account to receive the new shares
amountthe amount to issue, in nominal units
memoa memo to include in the transaction, readable by the recipient
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction issuing the new shares

Definition at line 2543 of file wallet.cpp.

◆ list_account_balances()

vector< asset< 0, 17, 0 > > golos::wallet::wallet_api::list_account_balances ( const account_name_type &  account_name)

List the balances of an account. Each account can have multiple balances, one for each type of asset owned by that account. The returned list will only contain assets for which the account has a nonzero balance

Parameters
account_namethe name or id of the account whose balances you want
Returns
a list of the given account's balances

Definition at line 1259 of file wallet.cpp.

◆ list_accounts()

set< string > golos::wallet::wallet_api::list_accounts ( const 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
lowerboundthe 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
limitthe maximum number of accounts to return (max: 1000)
Returns
a list of accounts mapping account names to account ids

Definition at line 1255 of file wallet.cpp.

◆ list_assets()

vector< asset_object > golos::wallet::wallet_api::list_assets ( const string &  lowerbound,
uint32_t  limit 
) const

Lists all assets registered on the blockchain.

To list all assets, pass the empty string "" for the lowerbound to start at the beginning of the list, and iterate as necessary.

Parameters
lowerboundthe symbol of the first asset to include in the list.
limitthe maximum number of assets to return (max: 100)
Returns
the list of asset objects, ordered by symbol

Definition at line 1263 of file wallet.cpp.

◆ list_keys()

map< public_key_type, string > golos::wallet::wallet_api::list_keys ( )

Dumps all private keys owned by the wallet.

The keys are printed in WIF format. You can import these keys into another wallet using import_key()

Returns
a map containing the private keys, indexed by their public key

Definition at line 1550 of file wallet.cpp.

◆ list_my_accounts()

vector< account_api_obj > golos::wallet::wallet_api::list_my_accounts ( ) const

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

Definition at line 1220 of file wallet.cpp.

◆ list_witnesses()

set< account_name_type > golos::wallet::wallet_api::list_witnesses ( const 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
lowerboundthe 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
limitthe maximum number of witnesss to return (max: 1000)
Returns
a list of witnesss mapping witness names to witness ids

Definition at line 1429 of file wallet.cpp.

◆ load_wallet_file()

bool golos::wallet::wallet_api::load_wallet_file ( string  wallet_filename = "")

Loads a specified Graphene wallet.

The current wallet is closed before the new wallet is loaded.

Warning
This does not change the filename that will be used for future wallet writes, so this may cause you to overwrite your original wallet unless you also call set_wallet_filename()
Parameters
wallet_filenamethe filename of the wallet JSON file to load. If wallet_filename is empty, it reloads the existing wallet file
Returns
true if the specified wallet is loaded

Definition at line 1492 of file wallet.cpp.

◆ lock()

void golos::wallet::wallet_api::lock ( )

Locks the wallet immediately.

Definition at line 1517 of file wallet.cpp.

◆ network_add_nodes()

void golos::wallet::wallet_api::network_add_nodes ( const vector< string > &  nodes)

Definition at line 1456 of file wallet.cpp.

◆ network_get_connected_peers()

vector< variant > golos::wallet::wallet_api::network_get_connected_peers ( )

Definition at line 1460 of file wallet.cpp.

◆ normalize_brain_key()

string golos::wallet::wallet_api::normalize_brain_key ( string  s) const

Transforms a brain key to reduce the chance of errors when re-entering the key from memory.

This takes a user-supplied brain key and normalizes it into the form used for generating private keys. In particular, this upper-cases all ASCII characters and collapses multiple spaces into one.

Parameters
sthe brain key as supplied by the user
Returns
the brain key in its normalized form

Definition at line 1410 of file wallet.cpp.

◆ post_comment()

annotated_signed_transaction golos::wallet::wallet_api::post_comment ( string  author,
string  permlink,
string  parent_author,
string  parent_permlink,
string  title,
string  body,
string  json,
bool  broadcast 
)

Post or update a comment.

Parameters
authorthe name of the account authoring the comment
permlinkthe accountwide unique permlink for the comment
parent_authorcan be null if this is a top level comment
parent_permlinkbecomes category if parent_author is ""
titlethe title of the comment
bodythe body of the comment
jsonthe json metadata of the comment
broadcasttrue if you wish to broadcast the transaction

Definition at line 2775 of file wallet.cpp.

◆ preview_builder_transaction()

transaction golos::wallet::wallet_api::preview_builder_transaction ( transaction_handle_type  handle)

Definition at line 1347 of file wallet.cpp.

◆ propose_builder_transaction()

signed_transaction golos::wallet::wallet_api::propose_builder_transaction ( transaction_handle_type  handle,
time_point_sec  expiration = time_point::now() + fc::minutes(1),
uint32_t  review_period_seconds = 0,
bool  broadcast = true 
)

Definition at line 1356 of file wallet.cpp.

◆ propose_builder_transaction2()

signed_transaction golos::wallet::wallet_api::propose_builder_transaction2 ( transaction_handle_type  handle,
string  account_name_or_id,
time_point_sec  expiration = time_point::now() + fc::minutes(1),
uint32_t  review_period_seconds = 0,
bool  broadcast = true 
)

Definition at line 1362 of file wallet.cpp.

◆ prove()

annotated_signed_transaction golos::wallet::wallet_api::prove ( 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
challengedThe account that was challenged and is proving its authority.
broadcasttrue if you wish to broadcast the transaction

Definition at line 2867 of file wallet.cpp.

◆ publish_asset_feed()

signed_transaction golos::wallet::wallet_api::publish_asset_feed ( string  publishing_account,
string  symbol,
price_feed< 0, 17, 0 >  feed,
bool  broadcast = false 
)

Publishes a price feed for the named asset.

Price feed providers use this command to publish their price feeds for market-issued assets. A price feed is used to tune the market for a particular market-issued asset. For each value in the feed, the median across all committee_member feeds for that asset is calculated and the market for the asset is configured with the median of that value.

The feed object in this command contains three prices: a call price limit, a short price limit, and a settlement price. The call limit price is structured as (collateral asset) / (debt asset) and the short limit price is structured as (asset for sale) / (collateral asset). Note that the asset IDs are opposite to eachother, so if we're publishing a feed for USD, the call limit price will be CORE/USD and the short limit price will be USD/CORE. The settlement price may be flipped either direction, as long as it is a ratio between the market-issued asset and its collateral.

Parameters
publishing_accountthe account publishing the price feed
symbolthe name or id of the asset whose feed we're publishing
feedthe price_feed object containing the three prices making up the feed
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction updating the price feed for the given asset

Definition at line 2656 of file wallet.cpp.

◆ publish_feed()

annotated_signed_transaction golos::wallet::wallet_api::publish_feed ( string  witness,
price< 0, 17, 0 >  exchange_rate,
bool  broadcast 
)

A witness can public a price feed for the GOLOS:SBD market. The median price feed is used to process conversion requests from SBD to GOLOS.

Parameters
witnessThe witness publishing the price feed
exchange_rateThe desired exchange rate
broadcasttrue if you wish to broadcast the transaction

Definition at line 2306 of file wallet.cpp.

◆ reblog()

annotated_signed_transaction golos::wallet::wallet_api::reblog ( string  account,
string  author,
string  permlink,
bool  broadcast 
)

Reblog another account's post. Requires the posting authority of the account doing the reblog.

Parameters
accountaccount name of the user reblogging a post
authoraccount name of the author of the post
permlink- permanent link of the post to reblog
broadcasttrue if you wish to broadcast the transaction

Definition at line 2913 of file wallet.cpp.

◆ recover_account()

annotated_signed_transaction golos::wallet::wallet_api::recover_account ( string  account_to_recover,
authority  recent_authority,
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_recoverThe name of your account
recent_authorityA recent owner authority on your account
new_authorityThe new authority that your recovery account used in the account recover request.
broadcasttrue if you wish to broadcast the transaction

Definition at line 1665 of file wallet.cpp.

◆ remove_builder_transaction()

void golos::wallet::wallet_api::remove_builder_transaction ( transaction_handle_type  handle)

Definition at line 1370 of file wallet.cpp.

◆ replace_operation_in_builder_transaction()

void golos::wallet::wallet_api::replace_operation_in_builder_transaction ( transaction_handle_type  handle,
unsigned  operation_index,
const operation &  new_op 
)

Definition at line 1342 of file wallet.cpp.

◆ request_account_recovery()

annotated_signed_transaction golos::wallet::wallet_api::request_account_recovery ( string  recovery_account,
string  account_to_recover,
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_accountThe name of your account
account_to_recoverThe name of the account you are trying to recover
new_authorityThe new owner authority for the recovered account. This should be given to you by the holder of the compromised or lost account.
broadcasttrue if you wish to broadcast the transaction

Definition at line 1649 of file wallet.cpp.

◆ reserve_asset()

signed_transaction golos::wallet::wallet_api::reserve_asset ( string  from,
string  amount,
string  symbol,
bool  broadcast = false 
)

Burns the given user-issued asset.

This command burns the user-issued asset to reduce the amount in circulation.

Note
you cannot burn market-issued assets.
Parameters
fromthe account containing the asset you wish to burn
amountthe amount to burn, in nominal units
symbolthe name or id of the asset to burn
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction burning the asset

Definition at line 2698 of file wallet.cpp.

◆ save_wallet_file()

void golos::wallet::wallet_api::save_wallet_file ( string  wallet_filename = "")

Saves the current wallet to the given filename.

Warning
This does not change the wallet filename that will be used for future writes, so think of this function as 'Save a Copy As...' instead of 'Save As...'. Use set_wallet_filename() to make the filename persist.
Parameters
wallet_filenamethe filename of the new wallet JSON file to create or overwrite. If wallet_filename is empty, save to the current filename.

Definition at line 1496 of file wallet.cpp.

◆ sell()

signed_transaction golos::wallet::wallet_api::sell ( string  seller_account,
string  base,
string  quote,
double  rate,
double  amount,
protocol::integral_id_type  order_id,
bool  broadcast 
)

Place a limit order attempting to sell one asset for another.

This API call abstracts away some of the details of the sell_asset call to be more user friendly. All orders placed with sell never timeout and will not be killed if they cannot be filled immediately. If you wish for one of these parameters to be different, then sell_asset should be used instead.

Parameters
seller_accountthe account providing the asset being sold, and which will receive the processed of the sale.
baseThe name or id of the asset to sell.
quoteThe name or id of the asset to recieve.
rateThe rate in base:quote at which you want to sell.
amountThe amount of base you want to sell.
broadcasttrue to broadcast the transaction on the network.
Returns
The signed transaction selling the funds.

Definition at line 2508 of file wallet.cpp.

◆ sell_asset()

signed_transaction golos::wallet::wallet_api::sell_asset ( string  seller_account,
asset< 0, 17, 0 >  amount_to_sell,
asset< 0, 17, 0 >  amount_to_receive,
uint32_t  timeout_sec,
protocol::integral_id_type  order_id,
bool  fill_or_kill,
bool  broadcast 
)

Place a limit order attempting to sell one asset for another.

Buying and selling are the same operation on Graphene; if you want to buy GOLOS with USD, you should sell USD for GOLOS.

The blockchain will attempt to sell the symbol_to_sell for as much symbol_to_receive as possible, as long as the price is at least min_to_receive / amount_to_sell.

In addition to the transaction fees, market fees will apply as specified by the issuer of both the selling asset and the receiving asset as a percentage of the amount exchanged.

If either the selling asset or the receiving asset is whitelist restricted, the order will only be created if the seller is on the whitelist of the restricted asset type.

Market orders are matched in the order they are included in the block chain.

Todo:
Allow order expiration to be set here. Document default/max expiration time
Parameters
seller_accountthe account providing the asset being sold, and which will receive the proceeds of the sale.
amount_to_sellthe amount of the asset being sold to sell (in nominal units)
amount_to_receivethe minimum amount you are willing to receive in return for selling the entire amount_to_sell
timeout_secif the order does not fill immediately, this is the length of time the order will remain on the order books before it is cancelled and the un-spent funds are returned to the seller's account
fill_or_killif true, the order will only be included in the blockchain if it is filled immediately; if false, an open order will be left on the books to fill any amount that cannot be filled immediately.
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction selling the funds

Definition at line 2483 of file wallet.cpp.

◆ send_private_message()

annotated_signed_transaction golos::wallet::wallet_api::send_private_message ( string  from,
string  to,
string  subject,
string  body,
bool  broadcast 
)

Send the encrypted private email-like message to user

Parameters
frommessage author name
tomessage recipient name
subjectmessage subject
bodymessage content
broadcasttrue if you wish to broadcast the transaction

Definition at line 2933 of file wallet.cpp.

◆ serialize_transaction()

string golos::wallet::wallet_api::serialize_transaction ( signed_transaction  tx) const

Converts a signed_transaction in JSON form to its binary representation.

TODO: I don't see a broadcast_transaction() function, do we need one?

Parameters
txthe transaction to serialize
Returns
the binary form of the transaction. It will not be hex encoded, this returns a raw string that may have null characters embedded in it

Definition at line 1325 of file wallet.cpp.

◆ set_password()

void golos::wallet::wallet_api::set_password ( string  password)

Sets a new password on the wallet.

The wallet must be either 'new' or 'unlocked' to execute this command.

Definition at line 1543 of file wallet.cpp.

◆ set_transaction_expiration()

void golos::wallet::wallet_api::set_transaction_expiration ( uint32_t  seconds)

Sets the amount of time in the future until a transaction expires.

Definition at line 2848 of file wallet.cpp.

◆ set_voting_proxy()

annotated_signed_transaction golos::wallet::wallet_api::set_voting_proxy ( string  account_to_modify,
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_modifythe name or id of the account to update
proxythe name of account that should proxy to, or empty string to have no proxy
broadcasttrue if you wish to broadcast the transaction

Definition at line 1437 of file wallet.cpp.

◆ set_wallet_filename()

void golos::wallet::wallet_api::set_wallet_filename ( string  wallet_filename)

Sets the wallet filename used for future writes.

This does not trigger a save, it only changes the default filename that will be used the next time a save is triggered.

Parameters
wallet_filenamethe new filename to use for future saves

Definition at line 1442 of file wallet.cpp.

◆ set_withdraw_vesting_route()

annotated_signed_transaction golos::wallet::wallet_api::set_withdraw_vesting_route ( string  from,
string  to,
uint16_t  percent,
bool  auto_vest,
bool  broadcast = false 
)

Set up a vesting withdraw route. When vesting shares are withdrawn, they will be routed to these accounts based on the specified weights.

Parameters
fromThe account the VESTS are withdrawn from.
toThe account receiving either VESTS or GOLOS.
percentThe percent of the withdraw to go to the 'to' account. This is denoted in hundreths of a percent. i.e. 100 is 1% and 10000 is 100%. This value must be between 1 and 100000
auto_vestSet to true if the from account should receive the VESTS as VESTS, or false if it should receive them as GOLOS.
broadcasttrue if you wish to broadcast the transaction.

Definition at line 2276 of file wallet.cpp.

◆ settle_asset()

signed_transaction golos::wallet::wallet_api::settle_asset ( string  account_to_settle,
string  amount_to_settle,
string  symbol,
bool  broadcast = false 
)

Schedules a market-issued asset for automatic settlement.

Holders of market-issued assests may request a forced settlement for some amount of their asset. This means that the specified sum will be locked by the chain and held for the settlement period, after which time the chain will choose a margin posision holder and buy the settled asset using the margin's collateral. The price of this sale will be based on the feed price for the market-issued asset being settled. The exact settlement price will be the feed price at the time of settlement with an offset in favor of the margin position, where the offset is a blockchain parameter set in the global_property_object.

Parameters
account_to_settlethe name or id of the account owning the asset
amount_to_settlethe amount of the named asset to schedule for settlement
symbolthe name or id of the asset to settlement on
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction settling the named asset

Definition at line 2738 of file wallet.cpp.

◆ sign_builder_transaction()

signed_transaction golos::wallet::wallet_api::sign_builder_transaction ( transaction_handle_type  transaction_handle,
bool  broadcast = true 
)

Definition at line 1351 of file wallet.cpp.

◆ sign_transaction()

annotated_signed_transaction golos::wallet::wallet_api::sign_transaction ( signed_transaction  tx,
bool  broadcast = false 
)

Signs a transaction.

Given a fully-formed transaction that is only lacking signatures, this signs the transaction with the necessary keys and optionally broadcasts the transaction

Parameters
txthe unsigned transaction
broadcasttrue if you wish to broadcast the transaction
Returns
the signed version of the transaction

Definition at line 1446 of file wallet.cpp.

◆ suggest_brain_key()

brain_key_info golos::wallet::wallet_api::suggest_brain_key ( ) const

Suggests a safe brain key to use for creating your account. create_account_with_brain_key() requires you to specify a 'brain key', a long passphrase that provides enough entropy to generate cyrptographic keys. This function will suggest a suitably random string that should be easy to write down (and, with effort, memorize).

Returns
a suggested brain_key

Definition at line 1296 of file wallet.cpp.

◆ transfer()

annotated_signed_transaction golos::wallet::wallet_api::transfer ( string  from,
string  to,
asset< 0, 17, 0 >  amount,
string  memo,
bool  broadcast = false 
)

Transfer funds from one account to another. GOLOS and SBD can be transferred.

Parameters
fromThe account the funds are coming from
toThe account the funds are going to
amountThe funds being transferred. i.e. "100.000 GOLOS"
memoA memo for the transactionm, encrypted with the to account's public memo key
broadcasttrue if you wish to broadcast the transaction

Definition at line 2087 of file wallet.cpp.

◆ transfer_from_savings()

annotated_signed_transaction golos::wallet::wallet_api::transfer_from_savings ( string  from,
uint32_t  request_id,
string  to,
asset< 0, 17, 0 >  amount,
string  memo,
bool  broadcast = false 
)
Parameters
fromThe account the GOLOS is coming from
toThe account getting the VESTS
amountThe amount of GOLOS to vest i.e. "100.00 GOLOS"
request_id- an unique ID assigned by from account, the id is used to cancel the operation and can be reused after the transfer completes
memoa memo to include in the transaction, readable by the recipient
broadcasttrue if you wish to broadcast the transaction
request_id- an unique ID assigned by from account, the id is used to cancel the operation and can be reused after the transfer completes

Definition at line 2212 of file wallet.cpp.

◆ transfer_to_savings()

annotated_signed_transaction golos::wallet::wallet_api::transfer_to_savings ( string  from,
string  to,
asset< 0, 17, 0 >  amount,
string  memo,
bool  broadcast = false 
)

Transfers into savings happen immediately, transfers from savings take 72 hours

Definition at line 2193 of file wallet.cpp.

◆ transfer_to_vesting()

annotated_signed_transaction golos::wallet::wallet_api::transfer_to_vesting ( string  from,
string  to,
asset< 0, 17, 0 >  amount,
bool  broadcast = false 
)

Transfer GOLOS into a vesting fund represented by vesting shares (VESTS). VESTS are required to vesting for a minimum of one coin year and can be withdrawn once a week over a two year withdraw period. VESTS are protected against dilution up until 90% of GOLOS is vesting.

Parameters
fromThe account the GOLOS is coming from
toThe account getting the VESTS
amountThe amount of GOLOS to vest i.e. "100.00 GOLOS"
broadcasttrue if you wish to broadcast the transaction

Definition at line 2247 of file wallet.cpp.

◆ try_decrypt_message()

message_body golos::wallet::wallet_api::try_decrypt_message ( const message_api_obj mo)
Parameters
momessage api object to try to decrypt

Definition at line 2985 of file wallet.cpp.

◆ unlock()

void golos::wallet::wallet_api::unlock ( string  password)

Unlocks the wallet.

The wallet remain unlocked until the lock is called or the program exits.

Parameters
passwordthe password previously set with set_password()

Definition at line 1530 of file wallet.cpp.

◆ update_account()

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

This method updates the keys of an existing account.

Parameters
accountnameThe name of the account
json_metaNew JSON Metadata to be associated with the account
ownerNew public owner key for the account
activeNew public active key for the account
postingNew public posting key for the account
memoNew public memo key for the account
broadcasttrue if you wish to broadcast the transaction

Definition at line 1700 of file wallet.cpp.

◆ update_account_auth_account()

annotated_signed_transaction golos::wallet::wallet_api::update_account_auth_account ( string  account_name,
authority_type  type,
string  auth_account,
weight_type  weight,
bool  broadcast 
)

This method updates the account of an authority for an exisiting 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_nameThe name of the account whose authority you wish to update
typeThe authority type. e.g. owner, active, or posting
auth_accountThe account to add the the authority
weightThe weight the account should have in the authority. A weight of 0 indicates the removal of the account.
broadcasttrue if you wish to broadcast the transaction.

Definition at line 1785 of file wallet.cpp.

◆ update_account_auth_key()

annotated_signed_transaction golos::wallet::wallet_api::update_account_auth_key ( string  account_name,
authority_type  type,
public_key_type  key,
weight_type  weight,
bool  broadcast 
)

This method updates the key of an authority for an exisiting 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_nameThe name of the account whose authority you wish to update
typeThe authority type. e.g. owner, active, or posting
keyThe public key to add to the authority
weightThe weight the key should have in the authority. A weight of 0 indicates the removal of the key.
broadcasttrue if you wish to broadcast the transaction.

Definition at line 1723 of file wallet.cpp.

◆ update_account_auth_threshold()

annotated_signed_transaction golos::wallet::wallet_api::update_account_auth_threshold ( 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_nameThe name of the account whose authority you wish to update
typeThe authority type. e.g. owner, active, or posting
thresholdThe weight threshold required for the authority to be met
broadcasttrue if you wish to broadcast the transaction

Definition at line 1847 of file wallet.cpp.

◆ update_account_memo_key()

annotated_signed_transaction golos::wallet::wallet_api::update_account_memo_key ( string  account_name,
public_key_type  key,
bool  broadcast 
)

This method updates the memo key of an account

Parameters
account_nameThe name of the account you wish to update
keyThe new memo public key
broadcasttrue if you wish to broadcast the transaction

Definition at line 1924 of file wallet.cpp.

◆ update_account_meta()

annotated_signed_transaction golos::wallet::wallet_api::update_account_meta ( string  account_name,
string  json_meta,
bool  broadcast 
)

This method updates the account JSON metadata

Parameters
account_nameThe name of the account you wish to update
json_metaThe new JSON metadata for the account. This overrides existing metadata
broadcastture if you wish to broadcast the transaction

Definition at line 1904 of file wallet.cpp.

◆ update_asset()

signed_transaction golos::wallet::wallet_api::update_asset ( string  symbol,
optional< string >  new_issuer,
asset_options< 0, 17, 0 >  new_options,
bool  broadcast = false 
)

Update the core options on an asset. There are a number of options which all assets in the network use. These options are enumerated in the asset_object::asset_options<0, 17, 0> struct. This command is used to update these options for an existing asset.

Note
This operation cannot be used to update BitAsset-specific options. For these options, update_bitasset() instead.
Parameters
symbolthe name or id of the asset to update
new_issuerif changing the asset's issuer, the name or id of the new issuer. null if you wish to remain the issuer of the asset
new_optionsthe new asset_options<0, 17, 0> object, which will entirely replace the existing options.
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction updating the asset

Definition at line 2585 of file wallet.cpp.

◆ update_asset_feed_producers()

signed_transaction golos::wallet::wallet_api::update_asset_feed_producers ( string  symbol,
flat_set< string >  new_feed_producers,
bool  broadcast = false 
)

Update the set of feed-producing accounts for a BitAsset.

BitAssets have price feeds selected by taking the median values of recommendations from a set of feed producers. This command is used to specify which accounts may produce feeds for a given BitAsset.

Parameters
symbolthe name or id of the asset to update
new_feed_producersa list of account names or ids which are authorized to produce feeds for the asset. this list will completely replace the existing list
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction updating the bitasset's feed producers

Definition at line 2631 of file wallet.cpp.

◆ update_bitasset()

signed_transaction golos::wallet::wallet_api::update_bitasset ( string  symbol,
bitasset_options  new_options,
bool  broadcast = false 
)

Update the options specific to a BitAsset.

BitAssets have some options which are not relevant to other asset types. This operation is used to update those options an an existing BitAsset.

See also
update_asset()
Parameters
symbolthe name or id of the asset to update, which must be a market-issued asset
new_optionsthe new bitasset_options object, which will entirely replace the existing options.
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction updating the bitasset

Definition at line 2611 of file wallet.cpp.

◆ update_witness()

annotated_signed_transaction golos::wallet::wallet_api::update_witness ( string  witness_name,
string  url,
public_key_type  block_signing_key,
const chain_properties< 0, 17, 0 > &  props,
bool  broadcast = false 
)

Update a witness object owned by the given account.

Parameters
witness_nameThe name of the witness account.
urlA URL containing some information about the witness. The empty string makes it remain the same.
block_signing_keyThe new block signing public key. The empty string disables block production.
propsThe chain properties the witness is voting on.
broadcasttrue if you wish to broadcast the transaction.

Definition at line 2012 of file wallet.cpp.

◆ vote()

annotated_signed_transaction golos::wallet::wallet_api::vote ( string  voter,
string  author,
string  permlink,
int16_t  weight,
bool  broadcast 
)

Vote on a comment to be paid GOLOS

Parameters
voterThe account voting
authorThe author of the comment to be voted on
permlinkThe permlink of the comment to be voted on. (author, permlink) is a unique pair
weightThe weight [-100,100] of the vote
broadcasttrue if you wish to broadcast the transaction

Definition at line 2830 of file wallet.cpp.

◆ vote_for_witness()

annotated_signed_transaction golos::wallet::wallet_api::vote_for_witness ( string  account_to_vote_with,
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 vesting shares.

Parameters
account_to_vote_withThe account voting for a witness
witness_to_vote_forThe witness that is being voted for
approvetrue if the account is voting for the account to be able to be a block produce
broadcasttrue if you wish to broadcast the transaction

Definition at line 2042 of file wallet.cpp.

◆ whitelist_account()

signed_transaction golos::wallet::wallet_api::whitelist_account ( string  authorizing_account,
string  account_to_list,
account_whitelist_operation< 0, 17, 0 >::account_listing  new_listing_status,
bool  broadcast = false 
)

Whitelist and blacklist accounts, primarily for transacting in whitelisted assets.

Accounts can freely specify opinions about other accounts, in the form of either whitelisting or blackl isting them. This information is used in chain validation only to determine whether an account is authorized to tra nsact in an asset type which enforces a whitelist, but third parties can use this information for other uses as wel l, as long as it does not conflict with the use of whitelisted assets.

An asset which enforces a whitelist specifies a list of accounts to maintain its whitelist, and a list of accounts to maintain its blacklist. In order for a given account A to hold and transact in a whitel isted asset S, A must be whitelisted by at least one of S's whitelist_authorities and blacklisted by none of S's blacklist_authorities. If A receives a balance of S, and is later removed from the whitelist(s) which allowe d it to hold S, or added to any blacklist S specifies as authoritative, A's balance of S will be frozen until A's authorization is reinstated.

Parameters
authorizing_accountthe account who is doing the whitelisting
account_to_listthe account being whitelisted
new_listing_statusthe new whitelisting status
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction changing the whitelisting status

Definition at line 2757 of file wallet.cpp.

◆ withdraw_vesting()

annotated_signed_transaction golos::wallet::wallet_api::withdraw_vesting ( string  from,
asset< 0, 17, 0 >  vesting_shares,
bool  broadcast = false 
)

Set up a vesting withdraw request. The request is fulfilled once a week over the next two year (104 weeks).

Parameters
fromThe account the VESTS are withdrawn from
vesting_sharesThe amount of VESTS to withdraw over the next two years. Each week (amount/104) shares are withdrawn and deposited back as GOLOS. i.e. "10.000000 VESTS"
broadcasttrue if you wish to broadcast the transaction

Definition at line 2262 of file wallet.cpp.

Member Data Documentation

◆ lock_changed

fc::signal<void(bool)> golos::wallet::wallet_api::lock_changed

Definition at line 1387 of file wallet.hpp.

◆ my

std::shared_ptr<detail::wallet_api_impl> golos::wallet::wallet_api::my

Definition at line 1388 of file wallet.hpp.


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