DECENT
Functions

Functions

map< string, miner_id_type > list_miners (const string &lowerbound, uint32_t limit)
 Lists all miners registered in the blockchain. This returns a list of all account names that own miners, and the associated miner id, sorted by name. This lists miners whether they are currently voted in or not. Use the lowerbound and limit parameters to page through the list. To retrieve all miners, start by setting lowerbound to the empty string "", and then each iteration, pass the last miner name returned as the lowerbound for the next list_miners() call. More...
 
miner_object get_miner (const string &owner_account)
 Returns information about the given miner. More...
 
signed_transaction create_miner (const string &owner_account, const string &url, bool broadcast=false)
 Creates a miner object owned by the given account. More...
 
signed_transaction update_miner (const string &miner_name, const string &url, const string &block_signing_key, bool broadcast=false)
 Update a miner object owned by the given account. More...
 
vector< vesting_balance_object_with_info > get_vesting_balances (const string &account_name)
 Get information about a vesting balance object. More...
 
signed_transaction withdraw_vesting (const string &miner_name, const string &amount, const string &asset_symbol, bool broadcast=false)
 Withdraw a vesting balance. More...
 
signed_transaction vote_for_miner (const string &voting_account, const string &miner, bool approve, bool broadcast=false)
 Vote for a given miner. An account can publish a list of all miners they approve of. This command allows you to add or remove miners from this list. Each account's vote is weighted according to the number of shares of the core asset owned by that account at the time the votes are tallied. More...
 
signed_transaction set_voting_proxy (const string &account_to_modify, optional< string > voting_account, 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. More...
 
signed_transaction set_desired_miner_count (const string &account_to_modify, uint16_t desired_number_of_miners, bool broadcast=false)
 Set your vote for the number of miners in the system. Each account can voice their opinion on how many miners there should be in the active miner list. These are independent of each other. You must vote your approval of at least as many miners as you claim there should be (you can't say that there should be 20 miners but only vote for 10). There are maximum values for each set in the blockchain parameters (currently defaulting to 1001). This setting can be changed at any time. If your account has a voting proxy set, your preferences will be ignored. More...
 
vector< miner_voting_info > search_miner_voting (const string &account_id, const string &term, bool only_my_votes, const string &order, const string &id, uint32_t count) const
 Get miner voting info list by account that match search term. More...
 
map< string, miner_id_typegraphene::wallet::wallet_api::list_miners (const string &lowerbound, uint32_t limit)
 Lists all miners registered in the blockchain. This returns a list of all account names that own miners, and the associated miner id, sorted by name. This lists miners whether they are currently voted in or not. Use the lowerbound and limit parameters to page through the list. To retrieve all miners, start by setting lowerbound to the empty string "", and then each iteration, pass the last miner name returned as the lowerbound for the next list_miners() call. More...
 
miner_object graphene::wallet::wallet_api::get_miner (const string &owner_account)
 Returns information about the given miner. More...
 
signed_transaction graphene::wallet::wallet_api::create_miner (const string &owner_account, const string &url, bool broadcast=false)
 Creates a miner object owned by the given account. More...
 
signed_transaction graphene::wallet::wallet_api::update_miner (const string &miner_name, const string &url, const string &block_signing_key, bool broadcast=false)
 Update a miner object owned by the given account. More...
 
vector< vesting_balance_object_with_infographene::wallet::wallet_api::get_vesting_balances (const string &account_name)
 Get information about a vesting balance object. More...
 
signed_transaction graphene::wallet::wallet_api::withdraw_vesting (const string &miner_name, const string &amount, const string &asset_symbol, bool broadcast=false)
 Withdraw a vesting balance. More...
 
signed_transaction graphene::wallet::wallet_api::vote_for_miner (const string &voting_account, const string &miner, bool approve, bool broadcast=false)
 Vote for a given miner. An account can publish a list of all miners they approve of. This command allows you to add or remove miners from this list. Each account's vote is weighted according to the number of shares of the core asset owned by that account at the time the votes are tallied. More...
 
signed_transaction graphene::wallet::wallet_api::set_voting_proxy (const string &account_to_modify, optional< string > voting_account, 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. More...
 
signed_transaction graphene::wallet::wallet_api::set_desired_miner_count (const string &account_to_modify, uint16_t desired_number_of_miners, bool broadcast=false)
 Set your vote for the number of miners in the system. Each account can voice their opinion on how many miners there should be in the active miner list. These are independent of each other. You must vote your approval of at least as many miners as you claim there should be (you can't say that there should be 20 miners but only vote for 10). There are maximum values for each set in the blockchain parameters (currently defaulting to 1001). This setting can be changed at any time. If your account has a voting proxy set, your preferences will be ignored. More...
 
vector< miner_voting_infographene::wallet::wallet_api::search_miner_voting (const string &account_id, const string &term, bool only_my_votes, const string &order, const string &id, uint32_t count) const
 Get miner voting info list by account that match search term. More...
 

Detailed Description

Function Documentation

◆ create_miner() [1/2]

signed_transaction create_miner ( const string &  owner_account,
const string &  url,
bool  broadcast = false 
)

Creates a miner object owned by the given account.

Note
an account can have at most one miner object.
Parameters
owner_accountthe name or id of the account which is creating the miner
urla URL to include in the miner record in the blockchain. Clients may display this when showing a list of miners. May be blank.
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction registering a miner

◆ create_miner() [2/2]

signed_transaction wallet_api::create_miner ( const string &  owner_account,
const string &  url,
bool  broadcast = false 
)

Creates a miner object owned by the given account.

Note
an account can have at most one miner object.
Parameters
owner_accountthe name or id of the account which is creating the miner
urla URL to include in the miner record in the blockchain. Clients may display this when showing a list of miners. May be blank.
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction registering a miner

Definition at line 13 of file wallet.cpp.

◆ get_miner() [1/2]

miner_object get_miner ( const string &  owner_account)

Returns information about the given miner.

Parameters
owner_accountthe name or id of the miner account owner, or the id of the miner
Returns
the information about the miner stored in the block chain

◆ get_miner() [2/2]

miner_object wallet_api::get_miner ( const string &  owner_account)

Returns information about the given miner.

Parameters
owner_accountthe name or id of the miner account owner, or the id of the miner
Returns
the information about the miner stored in the block chain

Definition at line 8 of file wallet.cpp.

◆ get_vesting_balances() [1/2]

vector< vesting_balance_object_with_info > get_vesting_balances ( const string &  account_name)

Get information about a vesting balance object.

Parameters
account_namean account name, account ID, or vesting balance object ID.

◆ get_vesting_balances() [2/2]

vector< vesting_balance_object_with_info > wallet_api::get_vesting_balances ( const string &  account_name)

Get information about a vesting balance object.

Parameters
account_namean account name, account ID, or vesting balance object ID.

Definition at line 28 of file wallet.cpp.

◆ list_miners() [1/2]

map<string,miner_id_type> list_miners ( const string &  lowerbound,
uint32_t  limit 
)

Lists all miners registered in the blockchain. This returns a list of all account names that own miners, and the associated miner id, sorted by name. This lists miners whether they are currently voted in or not. Use the lowerbound and limit parameters to page through the list. To retrieve all miners, start by setting lowerbound to the empty string "", and then each iteration, pass the last miner name returned as the lowerbound for the next list_miners() call.

Parameters
lowerboundthe name of the first miner to return. If the named miner does not exist, the list will start at the miner that comes after lowerbound
limitthe maximum number of miners to return (max: 1000)
Returns
a list of miners mapping miner names to miner ids

◆ list_miners() [2/2]

map< string, miner_id_type > wallet_api::list_miners ( const string &  lowerbound,
uint32_t  limit 
)

Lists all miners registered in the blockchain. This returns a list of all account names that own miners, and the associated miner id, sorted by name. This lists miners whether they are currently voted in or not. Use the lowerbound and limit parameters to page through the list. To retrieve all miners, start by setting lowerbound to the empty string "", and then each iteration, pass the last miner name returned as the lowerbound for the next list_miners() call.

Parameters
lowerboundthe name of the first miner to return. If the named miner does not exist, the list will start at the miner that comes after lowerbound
limitthe maximum number of miners to return (max: 1000)
Returns
a list of miners mapping miner names to miner ids

Definition at line 3 of file wallet.cpp.

◆ search_miner_voting() [1/2]

vector<miner_voting_info> search_miner_voting ( const string &  account_id,
const string &  term,
bool  only_my_votes,
const string &  order,
const string &  id,
uint32_t  count 
) const

Get miner voting info list by account that match search term.

Parameters
account_idaccount name or empty when search without account
termsearch term - miner name
only_my_voteswhen true it selects only votes given by account
orderorder field. Available options are 'name,link,votes'
idthe id of the miner to start searching from, or empty when start from beginning
countmaximum number of miners info to fetch (must not exceed 1000)
Returns
the contents found

◆ search_miner_voting() [2/2]

vector< miner_voting_info > wallet_api::search_miner_voting ( const string &  account_id,
const string &  term,
bool  only_my_votes,
const string &  order,
const string &  id,
uint32_t  count 
) const

Get miner voting info list by account that match search term.

Parameters
account_idaccount name or empty when search without account
termsearch term - miner name
only_my_voteswhen true it selects only votes given by account
orderorder field. Available options are 'name,link,votes'
idthe id of the miner to start searching from, or empty when start from beginning
countmaximum number of miners info to fetch (must not exceed 1000)
Returns
the contents found

Definition at line 63 of file wallet.cpp.

◆ set_desired_miner_count() [1/2]

signed_transaction set_desired_miner_count ( const string &  account_to_modify,
uint16_t  desired_number_of_miners,
bool  broadcast = false 
)

Set your vote for the number of miners in the system. Each account can voice their opinion on how many miners there should be in the active miner list. These are independent of each other. You must vote your approval of at least as many miners as you claim there should be (you can't say that there should be 20 miners but only vote for 10). There are maximum values for each set in the blockchain parameters (currently defaulting to 1001). This setting can be changed at any time. If your account has a voting proxy set, your preferences will be ignored.

Parameters
account_to_modifythe name or id of the account to update
desired_number_of_miners
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction changing your vote proxy settings

◆ set_desired_miner_count() [2/2]

signed_transaction wallet_api::set_desired_miner_count ( const string &  account_to_modify,
uint16_t  desired_number_of_miners,
bool  broadcast = false 
)

Set your vote for the number of miners in the system. Each account can voice their opinion on how many miners there should be in the active miner list. These are independent of each other. You must vote your approval of at least as many miners as you claim there should be (you can't say that there should be 20 miners but only vote for 10). There are maximum values for each set in the blockchain parameters (currently defaulting to 1001). This setting can be changed at any time. If your account has a voting proxy set, your preferences will be ignored.

Parameters
account_to_modifythe name or id of the account to update
desired_number_of_miners
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction changing your vote proxy settings

Definition at line 56 of file wallet.cpp.

◆ set_voting_proxy() [1/2]

signed_transaction set_voting_proxy ( const string &  account_to_modify,
optional< string >  voting_account,
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
voting_accountthe name or id of an account authorized to vote account_to_modify's shares, or null to vote your own shares
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction changing your vote proxy settings

◆ set_voting_proxy() [2/2]

signed_transaction wallet_api::set_voting_proxy ( const string &  account_to_modify,
optional< string >  voting_account,
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
voting_accountthe name or id of an account authorized to vote account_to_modify's shares, or null to vote your own shares
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction changing your vote proxy settings

Definition at line 49 of file wallet.cpp.

◆ update_miner() [1/2]

signed_transaction update_miner ( const string &  miner_name,
const string &  url,
const string &  block_signing_key,
bool  broadcast = false 
)

Update a miner object owned by the given account.

Parameters
miner_nameThe name of the miner's owner account. Also accepts the ID of the owner account or the ID of the miner.
urlSame as for create_miner. The empty string makes it remain the same.
block_signing_keythe new block signing public key. The empty string makes it remain the same
broadcasttrue if you wish to broadcast the transaction.

◆ update_miner() [2/2]

signed_transaction wallet_api::update_miner ( const string &  miner_name,
const string &  url,
const string &  block_signing_key,
bool  broadcast = false 
)

Update a miner object owned by the given account.

Parameters
miner_nameThe name of the miner's owner account. Also accepts the ID of the owner account or the ID of the miner.
urlSame as for create_miner. The empty string makes it remain the same.
block_signing_keythe new block signing public key. The empty string makes it remain the same
broadcasttrue if you wish to broadcast the transaction.

Definition at line 20 of file wallet.cpp.

◆ vote_for_miner() [1/2]

signed_transaction vote_for_miner ( const string &  voting_account,
const string &  miner,
bool  approve,
bool  broadcast = false 
)

Vote for a given miner. An account can publish a list of all miners they approve of. This command allows you to add or remove miners from this list. Each account's vote is weighted according to the number of shares of the core asset owned by that account at the time the votes are tallied.

Note
You cannot vote against a miner, you can only vote for the miner or not vote for the miner.
See also
list_miners()
Parameters
voting_accountthe name or id of the account who is voting with their shares
minerthe name or id of the miner' owner account
approvetrue if you wish to vote in favor of that miner, false to remove your vote in favor of that miner
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction changing your vote for the given miner

◆ vote_for_miner() [2/2]

signed_transaction wallet_api::vote_for_miner ( const string &  voting_account,
const string &  miner,
bool  approve,
bool  broadcast = false 
)

Vote for a given miner. An account can publish a list of all miners they approve of. This command allows you to add or remove miners from this list. Each account's vote is weighted according to the number of shares of the core asset owned by that account at the time the votes are tallied.

Note
You cannot vote against a miner, you can only vote for the miner or not vote for the miner.
See also
list_miners()
Parameters
voting_accountthe name or id of the account who is voting with their shares
minerthe name or id of the miner' owner account
approvetrue if you wish to vote in favor of that miner, false to remove your vote in favor of that miner
broadcasttrue if you wish to broadcast the transaction
Returns
the signed transaction changing your vote for the given miner

Definition at line 41 of file wallet.cpp.

◆ withdraw_vesting() [1/2]

signed_transaction withdraw_vesting ( const string &  miner_name,
const string &  amount,
const string &  asset_symbol,
bool  broadcast = false 
)

Withdraw a vesting balance.

Parameters
miner_namethe account name of the miner, also accepts account ID or vesting balance ID type.
amountthe amount to withdraw.
asset_symbolthe symbol of the asset to withdraw
broadcasttrue if you wish to broadcast the transaction

◆ withdraw_vesting() [2/2]

signed_transaction wallet_api::withdraw_vesting ( const string &  miner_name,
const string &  amount,
const string &  asset_symbol,
bool  broadcast = false 
)

Withdraw a vesting balance.

Parameters
miner_namethe account name of the miner, also accepts account ID or vesting balance ID type.
amountthe amount to withdraw.
asset_symbolthe symbol of the asset to withdraw
broadcasttrue if you wish to broadcast the transaction

Definition at line 33 of file wallet.cpp.