DECENT
Functions
General

Functions

variant_object about () const
 Returns info such as client version, git version of graphene/fc, version of boost, openssl. More...
 
optional< signed_block_with_info > get_block (uint32_t num)
 Retrieve a full, signed block with info. More...
 
global_property_object get_global_properties () const
 Returns the blockchain's slowly-changing properties. 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...
 
dynamic_global_property_object get_dynamic_global_properties () const
 Returns the blockchain's rapidly-changing properties. The returned object contains information that changes every block interval such as the head block number, the next miner, etc. More...
 
variant get_object (object_id_type id) const
 Returns the blockchain object corresponding to the given id. This generic function can be used to retrieve any object from the blockchain that is assigned an ID. Certain types of objects have specialized convenience functions to return their objects – e.g., assets have get_asset(), accounts have get_account(), but this function will work for any object. More...
 
fc::time_point_sec head_block_time () const
 Query the last local block. More...
 
variant info ()
 Get information about current state of the blockchain, such as head block number, chain_id, list of active miners,... More...
 
string 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() More...
 
string get_help (const string &method) const
 Returns detailed help on a single API command. More...
 
std::string sign_buffer (const std::string &str_buffer, const std::string &str_brainkey) const
 Sign a buffer. More...
 
bool verify_signature (const std::string &str_buffer, const std::string &str_publickey, const std::string &str_signature) const
 Verify if the signature is valid. More...
 
void network_add_nodes (const vector< string > &nodes)
 
vector< variant > network_get_connected_peers ()
 
transaction_id_type get_transaction_id (const signed_transaction &trx) const
 This method is used to convert a JSON transaction to its transaction ID. More...
 
optional< signed_transaction > get_transaction_by_id (const transaction_id_type &id) const
 This method will return the transaction for the given ID (transaction hash) or it will return null if it is not known. Just because it is not known does not mean it wasn't included in the blockchain. More...
 
variant_object graphene::wallet::wallet_api::about () const
 Returns info such as client version, git version of graphene/fc, version of boost, openssl. More...
 
optional< signed_block_with_infographene::wallet::wallet_api::get_block (uint32_t num)
 Retrieve a full, signed block with info. More...
 
global_property_object graphene::wallet::wallet_api::get_global_properties () const
 Returns the blockchain's slowly-changing properties. 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...
 
dynamic_global_property_object graphene::wallet::wallet_api::get_dynamic_global_properties () const
 Returns the blockchain's rapidly-changing properties. The returned object contains information that changes every block interval such as the head block number, the next miner, etc. More...
 
variant graphene::wallet::wallet_api::get_object (object_id_type id) const
 Returns the blockchain object corresponding to the given id. This generic function can be used to retrieve any object from the blockchain that is assigned an ID. Certain types of objects have specialized convenience functions to return their objects – e.g., assets have get_asset(), accounts have get_account(), but this function will work for any object. More...
 
fc::time_point_sec graphene::wallet::wallet_api::head_block_time () const
 Query the last local block. More...
 
variant graphene::wallet::wallet_api::info ()
 Get information about current state of the blockchain, such as head block number, chain_id, list of active miners,... More...
 
string graphene::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() More...
 
string graphene::wallet::wallet_api::get_help (const string &method) const
 Returns detailed help on a single API command. More...
 
std::string graphene::wallet::wallet_api::sign_buffer (const std::string &str_buffer, const std::string &str_brainkey) const
 Sign a buffer. More...
 
bool graphene::wallet::wallet_api::verify_signature (const std::string &str_buffer, const std::string &str_publickey, const std::string &str_signature) const
 Verify if the signature is valid. More...
 
void graphene::wallet::wallet_api::network_add_nodes (const vector< string > &nodes)
 
vector< variant > graphene::wallet::wallet_api::network_get_connected_peers ()
 
transaction_id_type graphene::wallet::wallet_api::get_transaction_id (const signed_transaction &trx) const
 This method is used to convert a JSON transaction to its transaction ID. More...
 
optional< signed_transactiongraphene::wallet::wallet_api::get_transaction_by_id (const transaction_id_type &id) const
 This method will return the transaction for the given ID (transaction hash) or it will return null if it is not known. Just because it is not known does not mean it wasn't included in the blockchain. More...
 

Detailed Description

Function Documentation

◆ about() [1/2]

variant_object 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

◆ about() [2/2]

variant_object 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 4 of file wallet.cpp.

◆ get_block() [1/2]

optional<signed_block_with_info> get_block ( uint32_t  num)

Retrieve a full, signed block with info.

Parameters
numID/height of the block
Returns
the referenced block with info, or null if no matching block was found

◆ get_block() [2/2]

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

Retrieve a full, signed block with info.

Parameters
numID/height of the block
Returns
the referenced block with info, or null if no matching block was found

Definition at line 9 of file wallet.cpp.

◆ get_dynamic_global_properties() [1/2]

dynamic_global_property_object get_dynamic_global_properties ( ) const

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

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

◆ get_dynamic_global_properties() [2/2]

dynamic_global_property_object wallet_api::get_dynamic_global_properties ( ) const

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

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

Definition at line 42 of file wallet.cpp.

◆ get_global_properties() [1/2]

global_property_object get_global_properties ( ) const

Returns the blockchain's slowly-changing properties. 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.

See also
get_dynamic_global_properties() for frequently changing properties
Returns
the global properties

◆ get_global_properties() [2/2]

global_property_object wallet_api::get_global_properties ( ) const

Returns the blockchain's slowly-changing properties. 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.

See also
get_dynamic_global_properties() for frequently changing properties
Returns
the global properties

Definition at line 37 of file wallet.cpp.

◆ get_help() [1/2]

string 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

◆ get_help() [2/2]

string 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 76 of file wallet.cpp.

◆ get_object() [1/2]

variant get_object ( object_id_type  id) const

Returns the blockchain object corresponding to the given id. This generic function can be used to retrieve any object from the blockchain that is assigned an ID. Certain types of objects have specialized convenience functions to return their objects – e.g., assets have get_asset(), accounts have get_account(), but this function will work for any object.

Parameters
idthe id of the object to return
Returns
the requested object

◆ get_object() [2/2]

variant wallet_api::get_object ( object_id_type  id) const

Returns the blockchain object corresponding to the given id. This generic function can be used to retrieve any object from the blockchain that is assigned an ID. Certain types of objects have specialized convenience functions to return their objects – e.g., assets have get_asset(), accounts have get_account(), but this function will work for any object.

Parameters
idthe id of the object to return
Returns
the requested object

Definition at line 47 of file wallet.cpp.

◆ get_transaction_by_id() [1/2]

optional<signed_transaction> get_transaction_by_id ( const transaction_id_type &  id) const

This method will return the transaction for the given ID (transaction hash) or it will return null if it is not known. Just because it is not known does not mean it wasn't included in the blockchain.

Note
By default these objects are not tracked, the transaction_history_plugin must be loaded for these objects to be maintained.
Parameters
idID (transaction hash) of the transaction to retrieve
Returns
The transaction

◆ get_transaction_by_id() [2/2]

optional< signed_transaction > wallet_api::get_transaction_by_id ( const transaction_id_type id) const

This method will return the transaction for the given ID (transaction hash) or it will return null if it is not known. Just because it is not known does not mean it wasn't included in the blockchain.

Note
By default these objects are not tracked, the transaction_history_plugin must be loaded for these objects to be maintained.
Parameters
idID (transaction hash) of the transaction to retrieve
Returns
The transaction

Definition at line 191 of file wallet.cpp.

◆ get_transaction_id() [1/2]

transaction_id_type get_transaction_id ( const signed_transaction &  trx) const

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

Parameters
trxSigned transaction
Returns
The transaction ID

◆ get_transaction_id() [2/2]

transaction_id_type wallet_api::get_transaction_id ( const signed_transaction trx) const

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

Parameters
trxSigned transaction
Returns
The transaction ID

Definition at line 186 of file wallet.cpp.

◆ head_block_time() [1/2]

fc::time_point_sec head_block_time ( ) const

Query the last local block.

Returns
the block time

◆ head_block_time() [2/2]

fc::time_point_sec wallet_api::head_block_time ( ) const

Query the last local block.

Returns
the block time

Definition at line 132 of file wallet.cpp.

◆ help() [1/2]

string 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

◆ help() [2/2]

string 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 58 of file wallet.cpp.

◆ info() [1/2]

variant info ( )

Get information about current state of the blockchain, such as head block number, chain_id, list of active miners,...

Returns
information about current state of the blockchain

◆ info() [2/2]

variant wallet_api::info ( )

Get information about current state of the blockchain, such as head block number, chain_id, list of active miners,...

Returns
information about current state of the blockchain

Definition at line 52 of file wallet.cpp.

◆ network_add_nodes() [1/2]

void network_add_nodes ( const vector< string > &  nodes)
Parameters
nodes

◆ network_add_nodes() [2/2]

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

Definition at line 138 of file wallet.cpp.

◆ network_get_connected_peers() [1/2]

vector< variant > network_get_connected_peers ( )

◆ network_get_connected_peers() [2/2]

vector< variant > wallet_api::network_get_connected_peers ( )

Definition at line 143 of file wallet.cpp.

◆ sign_buffer() [1/2]

std::string sign_buffer ( const std::string &  str_buffer,
const std::string &  str_brainkey 
) const

Sign a buffer.

Parameters
str_bufferthe buffer to be signed
str_brainkeyderives the private key used for signature
Returns
the signed buffer

◆ sign_buffer() [2/2]

std::string wallet_api::sign_buffer ( const std::string &  str_buffer,
const std::string &  str_brainkey 
) const

Sign a buffer.

Parameters
str_bufferthe buffer to be signed
str_brainkeyderives the private key used for signature
Returns
the signed buffer

Definition at line 149 of file wallet.cpp.

◆ verify_signature() [1/2]

bool verify_signature ( const std::string &  str_buffer,
const std::string &  str_publickey,
const std::string &  str_signature 
) const

Verify if the signature is valid.

Parameters
str_bufferthe original buffer
str_publickeythe public key used for verification
str_signaturethe signed buffer
Returns
true if valid, otherwise false

◆ verify_signature() [2/2]

bool wallet_api::verify_signature ( const std::string &  str_buffer,
const std::string &  str_publickey,
const std::string &  str_signature 
) const

Verify if the signature is valid.

Parameters
str_bufferthe original buffer
str_publickeythe public key used for verification
str_signaturethe signed buffer
Returns
true if valid, otherwise false

Definition at line 167 of file wallet.cpp.