DECENT
Functions
Account

Functions

uint64_t get_account_count () const
 Returns the number of accounts registered on the blockchain. More...
 
map< string, account_id_type > 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. More...
 
vector< account_object > search_accounts (const string &term, const string &order, const string &id, uint32_t limit)
 Get registered accounts that match search term. More...
 
vector< asset > list_account_balances (const string &id)
 List the balances of an account. Each account can have multiple balances, one for each type of asset owned by that account. More...
 
vector< class transaction_detail_object > search_account_history (const string &account_name, const string &order, const string &id, int limit) const
 Returns the operations on the named account. This returns a list of transaction detail objects, which describe past the past activity on the account. More...
 
vector< operation_detail > get_account_history (const string &name, int limit) const
 Returns the most recent operations on the named account. This returns a list of operation history objects, which describe activity on the account. More...
 
vector< operation_detail > get_relative_account_history (const string &name, uint32_t stop, int limit, uint32_t start) const
 Get operations relevant to the specified account referenced by an event numbering specific to the account. The current number of operations for the account can be found in the account statistics (or use 0 for start). More...
 
vector< balance_operation_detail > search_account_balance_history (const string &account_name, const flat_set< string > &assets_list, const string &partner_account, uint32_t from_block, uint32_t to_block, uint32_t start_offset, int limit) const
 Returns the most recent balance operations on the named account. This returns a list of operation history objects, which describe activity on the account. More...
 
fc::optional< balance_operation_detail > get_account_balance_for_transaction (const string &account_name, operation_history_id_type operation_history_id)
 Returns the most recent balance operations on the named account. More...
 
account_object get_account (const string &account_name_or_id) const
 Returns information about the given account. More...
 
fc::ecc::private_key derive_private_key (const std::string &prefix_string, int sequence_number) const
 Derive private key from given prefix and sequence. More...
 
brain_key_info 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). More...
 
brain_key_info get_brain_key_info (const string &brain_key) const
 Calculates the private key and public key corresponding to any brain key. More...
 
pair< brain_key_info, el_gamal_key_pair > generate_brain_key_el_gamal_key () const
 Suggests a safe brain key to use for creating your account. This funcion also generates el_gamal_key_pair corresponding to the brain key. More...
 
signed_transaction register_account (const string &name, public_key_type owner, public_key_type active, const string &registrar_account, bool broadcast=false)
 Registers a third party's account on the blockckain. This function is used to register an account for which you do not own the private keys. When acting as a registrar, an end user will generate their own private keys and send you the public keys. The registrar will use this function to register the account on behalf of the end user. More...
 
signed_transaction create_account_with_brain_key (const string &brain_key, const string &account_name, const string &registrar_account, bool broadcast=false)
 Creates a new account and registers it on the blockchain. More...
 
signed_transaction transfer (const string &from, const string &to, const string &amount, const string &asset_symbol, const string &memo, bool broadcast=false)
 Transfer an amount from one account to another account or to content. In the case of transferring to a content, amount is transferred to author and co-authors of the content, if they are specified. More...
 
pair< transaction_id_type, signed_transaction > transfer2 (const string &from, const string &to, const string &amount, const string &asset_symbol, const string &memo)
 This method works just like transfer, except it always broadcasts and returns the transaction ID along with the signed transaction. More...
 
el_gamal_key_pair generate_el_gamal_keys () const
 Generates private El Gamal key and corresponding public key. More...
 
el_gamal_key_pair_str get_el_gammal_key (const string &consumer) const
 Gets unique El Gamal key pair for consumer. More...
 
uint64_t graphene::wallet::wallet_api::get_account_count () const
 Returns the number of accounts registered on the blockchain. More...
 
map< string, account_id_typegraphene::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. More...
 
vector< account_objectgraphene::wallet::wallet_api::search_accounts (const string &term, const string &order, const string &id, uint32_t limit)
 Get registered accounts that match search term. More...
 
vector< assetgraphene::wallet::wallet_api::list_account_balances (const string &id)
 List the balances of an account. Each account can have multiple balances, one for each type of asset owned by that account. More...
 
vector< class transaction_detail_objectgraphene::wallet::wallet_api::search_account_history (const string &account_name, const string &order, const string &id, int limit) const
 Returns the operations on the named account. This returns a list of transaction detail objects, which describe past the past activity on the account. More...
 
vector< operation_detailgraphene::wallet::wallet_api::get_account_history (const string &name, int limit) const
 Returns the most recent operations on the named account. This returns a list of operation history objects, which describe activity on the account. More...
 
vector< operation_detailgraphene::wallet::wallet_api::get_relative_account_history (const string &name, uint32_t stop, int limit, uint32_t start) const
 Get operations relevant to the specified account referenced by an event numbering specific to the account. The current number of operations for the account can be found in the account statistics (or use 0 for start). More...
 
vector< balance_operation_detailgraphene::wallet::wallet_api::search_account_balance_history (const string &account_name, const flat_set< string > &assets_list, const string &partner_account, uint32_t from_block, uint32_t to_block, uint32_t start_offset, int limit) const
 Returns the most recent balance operations on the named account. This returns a list of operation history objects, which describe activity on the account. More...
 
fc::optional< balance_operation_detailgraphene::wallet::wallet_api::get_account_balance_for_transaction (const string &account_name, operation_history_id_type operation_history_id)
 Returns the most recent balance operations on the named account. More...
 
account_object graphene::wallet::wallet_api::get_account (const string &account_name_or_id) const
 Returns information about the given account. More...
 
fc::ecc::private_key graphene::wallet::wallet_api::derive_private_key (const std::string &prefix_string, int sequence_number) const
 Derive private key from given prefix and sequence. More...
 
brain_key_info graphene::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). More...
 
brain_key_info graphene::wallet::wallet_api::get_brain_key_info (const string &brain_key) const
 Calculates the private key and public key corresponding to any brain key. More...
 
pair< brain_key_info, el_gamal_key_pairgraphene::wallet::wallet_api::generate_brain_key_el_gamal_key () const
 Suggests a safe brain key to use for creating your account. This funcion also generates el_gamal_key_pair corresponding to the brain key. More...
 
signed_transaction graphene::wallet::wallet_api::register_account (const string &name, public_key_type owner, public_key_type active, const string &registrar_account, bool broadcast=false)
 Registers a third party's account on the blockckain. This function is used to register an account for which you do not own the private keys. When acting as a registrar, an end user will generate their own private keys and send you the public keys. The registrar will use this function to register the account on behalf of the end user. More...
 
signed_transaction graphene::wallet::wallet_api::create_account_with_brain_key (const string &brain_key, const string &account_name, const string &registrar_account, bool broadcast=false)
 Creates a new account and registers it on the blockchain. More...
 
signed_transaction graphene::wallet::wallet_api::transfer (const string &from, const string &to, const string &amount, const string &asset_symbol, const string &memo, bool broadcast=false)
 Transfer an amount from one account to another account or to content. In the case of transferring to a content, amount is transferred to author and co-authors of the content, if they are specified. More...
 
pair< transaction_id_type, signed_transactiongraphene::wallet::wallet_api::transfer2 (const string &from, const string &to, const string &amount, const string &asset_symbol, const string &memo)
 This method works just like transfer, except it always broadcasts and returns the transaction ID along with the signed transaction. More...
 
el_gamal_key_pair graphene::wallet::wallet_api::generate_el_gamal_keys () const
 Generates private El Gamal key and corresponding public key. More...
 
el_gamal_key_pair_str graphene::wallet::wallet_api::get_el_gammal_key (const string &consumer) const
 Gets unique El Gamal key pair for consumer. More...
 

Detailed Description

Function Documentation

◆ create_account_with_brain_key() [1/2]

signed_transaction create_account_with_brain_key ( const string &  brain_key,
const string &  account_name,
const string &  registrar_account,
bool  broadcast = false 
)

Creates a new account and registers it on the blockchain.

See also
suggest_brain_key()
register_account()
Parameters
brain_keythe brain key used for generating the account's private keys
account_namethe name of the account, must be unique on the blockchain and contains at least 5 characters
registrar_accountthe account which will pay the fee to register the user
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction registering the account

◆ create_account_with_brain_key() [2/2]

signed_transaction wallet_api::create_account_with_brain_key ( const string &  brain_key,
const string &  account_name,
const string &  registrar_account,
bool  broadcast = false 
)

Creates a new account and registers it on the blockchain.

See also
suggest_brain_key()
register_account()
Parameters
brain_keythe brain key used for generating the account's private keys
account_namethe name of the account, must be unique on the blockchain and contains at least 5 characters
registrar_accountthe account which will pay the fee to register the user
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction registering the account

Definition at line 223 of file wallet.cpp.

◆ derive_private_key() [1/2]

fc::ecc::private_key derive_private_key ( const std::string &  prefix_string,
int  sequence_number 
) const

Derive private key from given prefix and sequence.

Parameters
prefix_string
sequence_number
Returns
derived private key

◆ derive_private_key() [2/2]

fc::ecc::private_key wallet_api::derive_private_key ( const std::string &  prefix_string,
int  sequence_number 
) const

Derive private key from given prefix and sequence.

Parameters
prefix_string
sequence_number
Returns
derived private key

Definition at line 3 of file wallet.cpp.

◆ generate_brain_key_el_gamal_key() [1/2]

pair<brain_key_info, el_gamal_key_pair> generate_brain_key_el_gamal_key ( ) const

Suggests a safe brain key to use for creating your account. This funcion also generates el_gamal_key_pair corresponding to the brain key.

Note
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 and corresponding El Gamal key pair

◆ generate_brain_key_el_gamal_key() [2/2]

pair< brain_key_info, el_gamal_key_pair > wallet_api::generate_brain_key_el_gamal_key ( ) const

Suggests a safe brain key to use for creating your account. This funcion also generates el_gamal_key_pair corresponding to the brain key.

Note
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 and corresponding El Gamal key pair

Definition at line 256 of file wallet.cpp.

◆ generate_el_gamal_keys() [1/2]

el_gamal_key_pair generate_el_gamal_keys ( ) const

Generates private El Gamal key and corresponding public key.

Returns
pair of El Gamal keys

◆ generate_el_gamal_keys() [2/2]

el_gamal_key_pair wallet_api::generate_el_gamal_keys ( ) const

Generates private El Gamal key and corresponding public key.

Returns
pair of El Gamal keys

Definition at line 233 of file wallet.cpp.

◆ get_account() [1/2]

account_object get_account ( const string &  account_name_or_id) const

Returns information about the given account.

Parameters
account_name_or_idthe name or id of the account to provide information about
Returns
the public account data stored in the blockchain

◆ get_account() [2/2]

account_object wallet_api::get_account ( const string &  account_name_or_id) const

Returns information about the given account.

Parameters
account_name_or_idthe name or id of the account to provide information about
Returns
the public account data stored in the blockchain

Definition at line 178 of file wallet.cpp.

◆ get_account_balance_for_transaction() [1/2]

fc::optional<balance_operation_detail> get_account_balance_for_transaction ( const string &  account_name,
operation_history_id_type  operation_history_id 
)

Returns the most recent balance operations on the named account.

Parameters
account_namethe name or id of the account
operation_history_idthe operation_history_id to search for
Returns
returns balance_operation_detail or empty when not found

◆ get_account_balance_for_transaction() [2/2]

fc::optional< balance_operation_detail > wallet_api::get_account_balance_for_transaction ( const string &  account_name,
operation_history_id_type  operation_history_id 
)

Returns the most recent balance operations on the named account.

Parameters
account_namethe name or id of the account
operation_history_idthe operation_history_id to search for
Returns
returns balance_operation_detail or empty when not found

Definition at line 98 of file wallet.cpp.

◆ get_account_count() [1/2]

uint64_t get_account_count ( ) const

Returns the number of accounts registered on the blockchain.

Returns
the number of registered accounts

◆ get_account_count() [2/2]

uint64_t wallet_api::get_account_count ( ) const

Returns the number of accounts registered on the blockchain.

Returns
the number of registered accounts

Definition at line 8 of file wallet.cpp.

◆ get_account_history() [1/2]

vector<operation_detail> get_account_history ( const string &  name,
int  limit 
) const

Returns the most recent operations on the named account. This returns a list of operation history objects, which describe activity on the account.

Note
this API doesn't give a way to retrieve more than the most recent 100 transactions
Parameters
namethe name or id of the account
limitthe number of entries to return (starting from the most recent)
Returns
a list of operation history objects

◆ get_account_history() [2/2]

vector< operation_detail > wallet_api::get_account_history ( const string &  name,
int  limit 
) const

Returns the most recent operations on the named account. This returns a list of operation history objects, which describe activity on the account.

Note
this API doesn't give a way to retrieve more than the most recent 100 transactions
Parameters
namethe name or id of the account
limitthe number of entries to return (starting from the most recent)
Returns
a list of operation history objects

Definition at line 30 of file wallet.cpp.

◆ get_brain_key_info() [1/2]

brain_key_info get_brain_key_info ( const string &  brain_key) const

Calculates the private key and public key corresponding to any brain key.

Parameters
brain_keythe brain key to be used for calculation
Returns
the corresponding brain_key_info

◆ get_brain_key_info() [2/2]

brain_key_info wallet_api::get_brain_key_info ( const string &  brain_key) const

Calculates the private key and public key corresponding to any brain key.

Parameters
brain_keythe brain key to be used for calculation
Returns
the corresponding brain_key_info

Definition at line 269 of file wallet.cpp.

◆ get_el_gammal_key() [1/2]

el_gamal_key_pair_str get_el_gammal_key ( const string &  consumer) const

Gets unique El Gamal key pair for consumer.

Returns
pair of El Gamal keys

◆ get_el_gammal_key() [2/2]

el_gamal_key_pair_str wallet_api::get_el_gammal_key ( const string &  consumer) const

Gets unique El Gamal key pair for consumer.

Returns
pair of El Gamal keys

Definition at line 241 of file wallet.cpp.

◆ get_relative_account_history() [1/2]

vector<operation_detail> get_relative_account_history ( const string &  name,
uint32_t  stop,
int  limit,
uint32_t  start 
) const

Get operations relevant to the specified account referenced by an event numbering specific to the account. The current number of operations for the account can be found in the account statistics (or use 0 for start).

Parameters
nameThe account whose history should be queried
stopSequence number of earliest operation. 0 is default and will query 'limit' number of operations.
limitMaximum number of operations to retrieve (must not exceed 100)
startSequence number of the most recent operation to retrieve. 0 is default, which will start querying from the most recent operation.
Returns
A list of operations performed by account, ordered from most recent to oldest.

◆ get_relative_account_history() [2/2]

vector< operation_detail > wallet_api::get_relative_account_history ( const string &  name,
uint32_t  stop,
int  limit,
uint32_t  start 
) const

Get operations relevant to the specified account referenced by an event numbering specific to the account. The current number of operations for the account can be found in the account statistics (or use 0 for start).

Parameters
nameThe account whose history should be queried
stopSequence number of earliest operation. 0 is default and will query 'limit' number of operations.
limitMaximum number of operations to retrieve (must not exceed 100)
startSequence number of the most recent operation to retrieve. 0 is default, which will start querying from the most recent operation.
Returns
A list of operations performed by account, ordered from most recent to oldest.

Definition at line 120 of file wallet.cpp.

◆ list_account_balances() [1/2]

vector<asset> list_account_balances ( const string &  id)

List the balances of an account. Each account can have multiple balances, one for each type of asset owned by that account.

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

◆ list_account_balances() [2/2]

vector< asset > wallet_api::list_account_balances ( const string &  id)

List the balances of an account. Each account can have multiple balances, one for each type of asset owned by that account.

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

Definition at line 23 of file wallet.cpp.

◆ list_accounts() [1/2]

map<string,account_id_type> 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

◆ list_accounts() [2/2]

map< string, account_id_type > 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 13 of file wallet.cpp.

◆ register_account() [1/2]

signed_transaction register_account ( const string &  name,
public_key_type  owner,
public_key_type  active,
const string &  registrar_account,
bool  broadcast = false 
)

Registers a third party's account on the blockckain. This function is used to register an account for which you do not own the private keys. When acting as a registrar, an end user will generate their own private keys and send you the public keys. The registrar will use this function to register the account on behalf of the end user.

Note
The owner key represents absolute control over the account. Generally, the only time the owner key is required is to update the active key.
The active key represents the hot key of the account. This key has control over nearly all operations the account may perform.
See also
suggest_brain_key()
Parameters
namethe name of the account, must be unique on the blockchain and contains at least 5 characters
ownerthe owner key for the new account
activethe active key for the new account
registrar_accountthe account which will pay the fee to register the user
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction registering the account

◆ register_account() [2/2]

signed_transaction wallet_api::register_account ( const string &  name,
public_key_type  owner,
public_key_type  active,
const string &  registrar_account,
bool  broadcast = false 
)

Registers a third party's account on the blockckain. This function is used to register an account for which you do not own the private keys. When acting as a registrar, an end user will generate their own private keys and send you the public keys. The registrar will use this function to register the account on behalf of the end user.

Note
The owner key represents absolute control over the account. Generally, the only time the owner key is required is to update the active key.
The active key represents the hot key of the account. This key has control over nearly all operations the account may perform.
See also
suggest_brain_key()
Parameters
namethe name of the account, must be unique on the blockchain and contains at least 5 characters
ownerthe owner key for the new account
activethe active key for the new account
registrar_accountthe account which will pay the fee to register the user
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction registering the account

Definition at line 214 of file wallet.cpp.

◆ search_account_balance_history() [1/2]

vector<balance_operation_detail> search_account_balance_history ( const string &  account_name,
const flat_set< string > &  assets_list,
const string &  partner_account,
uint32_t  from_block,
uint32_t  to_block,
uint32_t  start_offset,
int  limit 
) const

Returns the most recent balance operations on the named account. This returns a list of operation history objects, which describe activity on the account.

Parameters
account_namethe name or id of the account
assets_listlist of asset names to filter or empty for all assets
partner_accountpartner account_id to filter transfers to speccific account or empty
from_blockfiltering parameter, starting block number (can be determined by from time) or zero when not used
to_blockfiltering parameter, ending block number or zero when not used
orderordering parameter, not working yet
start_offsetstarting offset from zero
limitthe number of entries to return (starting from the most recent)
Returns
a list of balance operation history objects

◆ search_account_balance_history() [2/2]

vector< balance_operation_detail > wallet_api::search_account_balance_history ( const string &  account_name,
const flat_set< string > &  assets_list,
const string &  partner_account,
uint32_t  from_block,
uint32_t  to_block,
uint32_t  start_offset,
int  limit 
) const

Returns the most recent balance operations on the named account. This returns a list of operation history objects, which describe activity on the account.

Parameters
account_namethe name or id of the account
assets_listlist of asset names to filter or empty for all assets
partner_accountpartner account_id to filter transfers to speccific account or empty
from_blockfiltering parameter, starting block number (can be determined by from time) or zero when not used
to_blockfiltering parameter, ending block number or zero when not used
orderordering parameter, not working yet
start_offsetstarting offset from zero
limitthe number of entries to return (starting from the most recent)
Returns
a list of balance operation history objects

Definition at line 59 of file wallet.cpp.

◆ search_account_history() [1/2]

vector<class transaction_detail_object> search_account_history ( const string &  account_name,
const string &  order,
const string &  id,
int  limit 
) const

Returns the operations on the named account. This returns a list of transaction detail objects, which describe past the past activity on the account.

Parameters
account_namethe name or id of the account
ordersort data by field
idobject_id to start searching from
limitthe number of entries to return (starting from the most recent) (max 100)
Returns
a list of transaction detail objects

◆ search_account_history() [2/2]

vector< transaction_detail_object > wallet_api::search_account_history ( const string &  account_name,
const string &  order,
const string &  id,
int  limit 
) const

Returns the operations on the named account. This returns a list of transaction detail objects, which describe past the past activity on the account.

Parameters
account_namethe name or id of the account
ordersort data by field
idobject_id to start searching from
limitthe number of entries to return (starting from the most recent) (max 100)
Returns
a list of transaction detail objects

Definition at line 138 of file wallet.cpp.

◆ search_accounts() [1/2]

vector<account_object> search_accounts ( const string &  term,
const string &  order,
const string &  id,
uint32_t  limit 
)

Get registered accounts that match search term.

Parameters
termwill try to partially match account name or id
limitmaximum number of results to return ( must not exceed 1000 )
ordersort data by field
idobject_id to start searching from
Returns
map of account names to corresponding IDs

◆ search_accounts() [2/2]

vector< account_object > wallet_api::search_accounts ( const string &  term,
const string &  order,
const string &  id,
uint32_t  limit 
)

Get registered accounts that match search term.

Parameters
termwill try to partially match account name or id
limitmaximum number of results to return ( must not exceed 1000 )
ordersort data by field
idobject_id to start searching from
Returns
map of account names to corresponding IDs

Definition at line 18 of file wallet.cpp.

◆ suggest_brain_key() [1/2]

brain_key_info 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

◆ suggest_brain_key() [2/2]

brain_key_info 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 183 of file wallet.cpp.

◆ transfer() [1/2]

signed_transaction transfer ( const string &  from,
const string &  to,
const string &  amount,
const string &  asset_symbol,
const string &  memo,
bool  broadcast = false 
)

Transfer an amount from one account to another account or to content. In the case of transferring to a content, amount is transferred to author and co-authors of the content, if they are specified.

Parameters
fromthe name or id of the account sending the funds
tothe name or id of the account or id of the content receiving the funds
amountthe amount to send (in nominal units – to send half of a DCT, specify 0.5)
asset_symbolthe symbol or id of the asset to send
memoa memo to attach to the transaction. The memo will be encrypted in the transaction and readable for the receiver. There is no length limit other than the limit imposed by maximum transaction size.
Note
transaction fee is fixed and does not depend on the length of the memo
Parameters
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction transferring funds

◆ transfer() [2/2]

signed_transaction wallet_api::transfer ( const string &  from,
const string &  to,
const string &  amount,
const string &  asset_symbol,
const string &  memo,
bool  broadcast = false 
)

Transfer an amount from one account to another account or to content. In the case of transferring to a content, amount is transferred to author and co-authors of the content, if they are specified.

Parameters
fromthe name or id of the account sending the funds
tothe name or id of the account or id of the content receiving the funds
amountthe amount to send (in nominal units – to send half of a DCT, specify 0.5)
asset_symbolthe symbol or id of the asset to send
memoa memo to attach to the transaction. The memo will be encrypted in the transaction and readable for the receiver. There is no length limit other than the limit imposed by maximum transaction size.
Note
transaction fee is fixed and does not depend on the length of the memo
Parameters
broadcasttrue to broadcast the transaction on the network
Returns
the signed transaction transferring funds

Definition at line 281 of file wallet.cpp.

◆ transfer2() [1/2]

pair<transaction_id_type,signed_transaction> transfer2 ( const string &  from,
const string &  to,
const string &  amount,
const string &  asset_symbol,
const string &  memo 
)

This method works just like transfer, except it always broadcasts and returns the transaction ID along with the signed transaction.

Parameters
fromthe name or id of the account sending the funds
tothe name or id of the account or id of the content receiving the funds
amountthe amount to send (in nominal units – to send half of a DCT, specify 0.5)
asset_symbolthe symbol or id of the asset to send
memoa memo to attach to the transaction. The memo will be encrypted in the transaction and readable for the receiver. There is no length limit other than the limit imposed by maximum transaction size, but transaction increase with transaction size
Note
transaction fee is fixed and does not depend on the length of the memo
Returns
the transaction ID along with the signed transaction

◆ transfer2() [2/2]

pair< transaction_id_type, signed_transaction > wallet_api::transfer2 ( const string &  from,
const string &  to,
const string &  amount,
const string &  asset_symbol,
const string &  memo 
)

This method works just like transfer, except it always broadcasts and returns the transaction ID along with the signed transaction.

Parameters
fromthe name or id of the account sending the funds
tothe name or id of the account or id of the content receiving the funds
amountthe amount to send (in nominal units – to send half of a DCT, specify 0.5)
asset_symbolthe symbol or id of the asset to send
memoa memo to attach to the transaction. The memo will be encrypted in the transaction and readable for the receiver. There is no length limit other than the limit imposed by maximum transaction size, but transaction increase with transaction size
Note
transaction fee is fixed and does not depend on the length of the memo
Returns
the transaction ID along with the signed transaction

Definition at line 290 of file wallet.cpp.