DECENT
Functions

Functions

fc::variants graphene::app::database_api::get_objects (const vector< object_id_type > &ids) const
 Get the objects corresponding to the provided IDs. More...
 
std::string graphene::app::database_api::info () const
 Get the name of the API. More...
 
chain_property_object graphene::app::database_api::get_chain_properties () const
 Retrieve the chain_property_object associated with the chain. More...
 
global_property_object graphene::app::database_api::get_global_properties () const
 Retrieve the current global_property_object. This object contains all of the properties of the blockchain that are fixed or that change only once per maintenance interval such as the current list of miners, block interval, etc. More...
 
fc::variant_object graphene::app::database_api::get_config () const
 Retrieve compile-time constants. More...
 
chain_id_type graphene::app::database_api::get_chain_id () const
 Get the chain ID. More...
 
dynamic_global_property_object graphene::app::database_api::get_dynamic_global_properties () const
 Retrieve the current dynamic_global_property_object. The returned object contains information that changes every block interval such as the head block number, the next miner, etc. More...
 
vector< operation_info > graphene::app::database_api::list_operations () const
 Listing all operations available. More...
 
miner_reward_input graphene::app::database_api::get_time_to_maint_by_block_time (fc::time_point_sec block_time) const
 Get remaining time to next maintenance interval from given time. More...
 
share_type graphene::app::database_api::get_miner_pay_from_fees_by_block_time (fc::time_point_sec block_time) const
 Get miner pay from accumulated fees from given time. More...
 

Detailed Description

Function Documentation

chain_id_type graphene::app::database_api::get_chain_id ( ) const

Get the chain ID.

Returns
the chain ID identifying blockchain network

Definition at line 498 of file database_api.cpp.

chain_property_object graphene::app::database_api::get_chain_properties ( ) const

Retrieve the chain_property_object associated with the chain.

Returns
chain id and immutable chain parameters

Definition at line 468 of file database_api.cpp.

fc::variant_object graphene::app::database_api::get_config ( ) const

Retrieve compile-time constants.

Returns
configured constants

Definition at line 488 of file database_api.cpp.

dynamic_global_property_object graphene::app::database_api::get_dynamic_global_properties ( ) const

Retrieve the current dynamic_global_property_object. The returned object contains information that changes every block interval such as the head block number, the next miner, etc.

Returns
the dynamic properties

Definition at line 508 of file database_api.cpp.

global_property_object graphene::app::database_api::get_global_properties ( ) const

Retrieve the current global_property_object. This object contains all of the properties of the blockchain that are fixed or that change only once per maintenance interval such as the current list of miners, block interval, etc.

Returns
the global properties

Definition at line 478 of file database_api.cpp.

share_type graphene::app::database_api::get_miner_pay_from_fees_by_block_time ( fc::time_point_sec  block_time) const

Get miner pay from accumulated fees from given time.

Parameters
block_timereference time
Returns
miner pay from accumulated fees

Definition at line 2622 of file database_api.cpp.

fc::variants graphene::app::database_api::get_objects ( const vector< object_id_type > &  ids) const

Get the objects corresponding to the provided IDs.

Note
If any of the provided IDs does not map to an object, a null variant is returned in its position.
Parameters
idsIDs of the objects to retrieve
Returns
the objects retrieved, in the order they are mentioned in ids

Definition at line 272 of file database_api.cpp.

miner_reward_input graphene::app::database_api::get_time_to_maint_by_block_time ( fc::time_point_sec  block_time) const

Get remaining time to next maintenance interval from given time.

Parameters
block_timereference time
Returns
remaining time to next maintenance interval along with some additional data

Definition at line 2617 of file database_api.cpp.

std::string graphene::app::database_api::info ( ) const

Get the name of the API.

Returns
the name of the API

Definition at line 463 of file database_api.cpp.

vector< operation_info > graphene::app::database_api::list_operations ( ) const

Listing all operations available.

Note
This function lists all operations available, including the fees. These fees are taken primarily from global properties and secondarily from default values.
Returns
a vector of operation_info struct instances containing operation ids, names and fee parameters

Definition at line 1575 of file database_api.cpp.