DECENT
Functions
History API

Functions

string graphene::app::history_api::info ()
 
vector< operation_history_objectgraphene::app::history_api::get_account_history (account_id_type account, operation_history_id_type stop=operation_history_id_type(), unsigned limit=100, operation_history_id_type start=operation_history_id_type()) const
 Get operations relevant to the specificed account. More...
 
vector< operation_history_objectgraphene::app::history_api::get_relative_account_history (account_id_type account, uint32_t stop=0, unsigned limit=100, uint32_t start=0) 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_change_resultgraphene::app::history_api::search_account_balance_history (account_id_type account_id, const flat_set< asset_id_type > &assets_list, fc::optional< account_id_type > partner_account_id, 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_change_resultgraphene::app::history_api::get_account_balance_for_transaction (account_id_type account_id, operation_history_id_type operation_history_id)
 Returns balance operation on the named account and transaction_id. More...
 

Detailed Description

Function Documentation

◆ get_account_balance_for_transaction()

fc::optional< balance_change_result > graphene::app::history_api::get_account_balance_for_transaction ( account_id_type  account_id,
operation_history_id_type  operation_history_id 
)

Returns balance operation on the named account and transaction_id.

Parameters
account_idthe account whose history should be queried
operation_history_idthe operation_history_id whose history should be queried
Returns
balance operation history object or empty when not found

Definition at line 408 of file api.cpp.

◆ get_account_history()

vector< operation_history_object > graphene::app::history_api::get_account_history ( account_id_type  account,
operation_history_id_type  stop = operation_history_id_type(),
unsigned  limit = 100,
operation_history_id_type  start = operation_history_id_type() 
) const

Get operations relevant to the specificed account.

Parameters
accountthe account whose history should be queried
stopID of the earliest operation to retrieve
limitmaximum number of operations to retrieve (must not exceed 100)
startID of the most recent operation to retrieve
Returns
a list of operations performed by account, ordered from most recent to oldest

Definition at line 280 of file api.cpp.

◆ get_relative_account_history()

vector< operation_history_object > graphene::app::history_api::get_relative_account_history ( account_id_type  account,
uint32_t  stop = 0,
unsigned  limit = 100,
uint32_t  start = 0 
) 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
accountthe 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 307 of file api.cpp.

◆ info()

string graphene::app::history_api::info ( )
inline

Get the name of the API.

Returns
the name of the API

Definition at line 108 of file api.hpp.

◆ search_account_balance_history()

vector< balance_change_result > graphene::app::history_api::search_account_balance_history ( account_id_type  account_id,
const flat_set< asset_id_type > &  assets_list,
fc::optional< account_id_type partner_account_id,
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_idthe account whose history should be queried
assets_listlist of asset_ids to filter assets or empty for all assets
partner_account_idpartner 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 335 of file api.cpp.