monero_c_daemon.h

Go to the documentation of this file.

 
#ifndef MONERO_C_DAEMON_H
#define MONERO_C_DAEMON_H
 
#include "utils/monero_c_utils.h"
#include "common/monero_c_rpc_connection.h"
 
#include <stddef.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
// ------------------------------ DAEMON RPC ----------------------------------
// each function wraps the monero_daemon method of the same name (monero-cpp's
// monero_daemon interface). Results are JSON in monero-cpp's serializable_struct
// format unless the parameter says otherwise. A JSON argument can't nest deeper than
// 64 levels. On error, string and array outputs are set to NULL (counts to 0) and scalar
// outputs are left unchanged. The thread safety rules are documented on monero_daemon and
// monero_daemon_listener
 
typedef struct monero_daemon monero_daemon;
 
typedef struct monero_daemon_listener monero_daemon_listener;
 
typedef void (*monero_daemon_on_block_header_fn)(void* user_data, const char* header_json);
 
typedef struct monero_daemon_listener_callbacks {
  void* user_data;  
  monero_daemon_on_block_header_fn on_block_header;  
} monero_daemon_listener_callbacks;
 
typedef enum monero_key_image_spent_status {
  MONERO_KEY_IMAGE_NOT_SPENT = 0,
  MONERO_KEY_IMAGE_CONFIRMED = 1,
  MONERO_KEY_IMAGE_TX_POOL = 2
} monero_key_image_spent_status;
 
// ------------------------------ CONNECTION ----------------------------------
 
MONERO_EXPORT monero_result monero_daemon_connect(const char* uri, const char* username, const char* password, const char* proxy_uri, uint32_t timeout_ms, monero_daemon** out_daemon);
 
MONERO_EXPORT monero_result monero_daemon_connect_with(monero_rpc_connection* connection, monero_daemon** out_daemon);
 
MONERO_EXPORT void monero_daemon_free(monero_daemon* daemon);
 
MONERO_EXPORT monero_result monero_daemon_get_rpc_connection(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_set_poll_period(monero_daemon* daemon, uint64_t period_ms);
 
// -------------------------------- LISTENERS ---------------------------------
 
MONERO_EXPORT monero_result monero_daemon_listener_create(const monero_daemon_listener_callbacks* callbacks, monero_daemon_listener** out_listener);
 
MONERO_EXPORT void monero_daemon_listener_free(monero_daemon_listener* listener);
 
MONERO_EXPORT monero_result monero_daemon_add_listener(monero_daemon* daemon, monero_daemon_listener* listener);
 
MONERO_EXPORT monero_result monero_daemon_remove_listener(monero_daemon* daemon, monero_daemon_listener* listener);
 
MONERO_EXPORT monero_result monero_daemon_get_listeners(monero_daemon* daemon, monero_daemon_listener*** out_listeners, size_t* out_count);
 
MONERO_EXPORT monero_result monero_daemon_remove_listeners(monero_daemon* daemon);
 
// ---------------------------------- GENERAL ---------------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_version(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_is_trusted(monero_daemon* daemon, bool* out_trusted);
 
MONERO_EXPORT monero_result monero_daemon_get_height(monero_daemon* daemon, uint64_t* out_height);
 
MONERO_EXPORT monero_result monero_daemon_get_block_hash(monero_daemon* daemon, uint64_t height, char** out_hash);
 
MONERO_EXPORT monero_result monero_daemon_get_info(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_sync_info(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_network_stats(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_hard_fork_info(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_alt_chains(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_alt_block_hashes(monero_daemon* daemon, char** out_json);
 
// ---------------------------------- MINING ----------------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_block_template(monero_daemon* daemon, const char* wallet_address, const int32_t* reserve_size, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_miner_data(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_calculate_pow(monero_daemon* daemon, uint32_t major_version, uint64_t height, const char* block_blob, const char* seed_hash, char** out_pow_hash);
 
MONERO_EXPORT monero_result monero_daemon_add_auxiliary_pow(monero_daemon* daemon, const char* block_template_blob, const char* aux_pow_json, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_mining_status(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_start_mining(monero_daemon* daemon, const char* address, const uint64_t* num_threads, const bool* is_background, const bool* ignore_battery);
 
MONERO_EXPORT monero_result monero_daemon_stop_mining(monero_daemon* daemon);
 
MONERO_EXPORT monero_result monero_daemon_generate_blocks(monero_daemon* daemon, const char* wallet_address, uint64_t num_blocks, const char* prev_block_hash, const uint32_t* starting_nonce, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_submit_block(monero_daemon* daemon, const char* block_blob);
 
MONERO_EXPORT monero_result monero_daemon_submit_blocks(monero_daemon* daemon, const char* const* block_blobs, size_t num_block_blobs);
 
// ----------------------------------- BLOCKS ---------------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_last_block_header(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_block_header_by_hash(monero_daemon* daemon, const char* block_hash, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_block_header_by_height(monero_daemon* daemon, uint64_t height, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_block_headers_by_range(monero_daemon* daemon, uint64_t start_height, uint64_t end_height, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_block_by_hash(monero_daemon* daemon, const char* block_hash, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_blocks_by_hash(monero_daemon* daemon, const char* const* block_hashes, size_t num_block_hashes, uint64_t start_height, bool prune, uint64_t max_block_count, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_block_by_height(monero_daemon* daemon, uint64_t height, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_blocks_by_height(monero_daemon* daemon, const uint64_t* heights, size_t num_heights, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_blocks_by_range(monero_daemon* daemon, const uint64_t* start_height, const uint64_t* end_height, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_blocks_by_range_chunked(monero_daemon* daemon, const uint64_t* start_height, const uint64_t* end_height, const uint64_t* max_chunk_size, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_block_hashes(monero_daemon* daemon, const char* const* block_hashes, size_t num_block_hashes, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_wait_for_next_block_header(monero_daemon* daemon, char** out_json);
 
// ---------------------------- TRANSACTIONS ----------------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_tx(monero_daemon* daemon, const char* tx_hash, bool prune, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_txs(monero_daemon* daemon, const char* const* tx_hashes, size_t num_tx_hashes, bool prune, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_tx_hex(monero_daemon* daemon, const char* tx_hash, bool prune, char** out_tx_hex);
 
MONERO_EXPORT monero_result monero_daemon_get_tx_hexes(monero_daemon* daemon, const char* const* tx_hashes, size_t num_tx_hashes, bool prune, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_miner_tx_sum(monero_daemon* daemon, uint64_t height, uint64_t num_blocks, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_fee_estimate(monero_daemon* daemon, uint64_t grace_blocks, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_submit_tx_hex(monero_daemon* daemon, const char* tx_hex, bool do_not_relay, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_relay_tx_by_hash(monero_daemon* daemon, const char* tx_hash);
 
MONERO_EXPORT monero_result monero_daemon_relay_txs_by_hash(monero_daemon* daemon, const char* const* tx_hashes, size_t num_tx_hashes);
 
// ------------------------------- TX POOL ------------------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_tx_pool(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_tx_pool_hashes(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_tx_pool_backlog(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_tx_pool_stats(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_flush_tx_pool(monero_daemon* daemon);
 
MONERO_EXPORT monero_result monero_daemon_flush_tx_pool_hashes(monero_daemon* daemon, const char* const* tx_hashes, size_t num_tx_hashes);
 
MONERO_EXPORT monero_result monero_daemon_flush_tx_pool_hash(monero_daemon* daemon, const char* tx_hash);
 
// --------------------------- KEY IMAGES AND OUTPUTS -------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_key_image_spent_status(monero_daemon* daemon, const char* key_image, monero_key_image_spent_status* out_status);
 
MONERO_EXPORT monero_result monero_daemon_get_key_image_spent_statuses(monero_daemon* daemon, const char* const* key_images, size_t num_key_images, monero_key_image_spent_status** out_statuses, size_t* out_count);
 
MONERO_EXPORT monero_result monero_daemon_get_output_indices(monero_daemon* daemon, const char* tx_hash, uint64_t** out_indices, size_t* out_count);
 
MONERO_EXPORT monero_result monero_daemon_get_outputs(monero_daemon* daemon, const char* outputs_json, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_output_histogram(monero_daemon* daemon, const uint64_t* amounts, size_t num_amounts, const int32_t* min_count, const int32_t* max_count, const bool* is_unlocked, const int32_t* recent_cutoff, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_output_distribution(monero_daemon* daemon, const uint64_t* amounts, size_t num_amounts, const bool* is_cumulative, const uint64_t* start_height, const uint64_t* end_height, char** out_json);
 
// ------------------------------- BANDWIDTH ----------------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_download_limit(monero_daemon* daemon, int32_t* out_limit);
 
MONERO_EXPORT monero_result monero_daemon_set_download_limit(monero_daemon* daemon, int32_t limit, int32_t* out_limit);
 
MONERO_EXPORT monero_result monero_daemon_reset_download_limit(monero_daemon* daemon, int32_t* out_limit);
 
MONERO_EXPORT monero_result monero_daemon_get_upload_limit(monero_daemon* daemon, int32_t* out_limit);
 
MONERO_EXPORT monero_result monero_daemon_set_upload_limit(monero_daemon* daemon, int32_t limit, int32_t* out_limit);
 
MONERO_EXPORT monero_result monero_daemon_reset_upload_limit(monero_daemon* daemon, int32_t* out_limit);
 
// ---------------------------------- PEERS -----------------------------------
 
MONERO_EXPORT monero_result monero_daemon_get_peers(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_known_peers(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_get_public_peers(monero_daemon* daemon, bool include_offline, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_set_outgoing_peer_limit(monero_daemon* daemon, int32_t limit);
 
MONERO_EXPORT monero_result monero_daemon_set_incoming_peer_limit(monero_daemon* daemon, int32_t limit);
 
MONERO_EXPORT monero_result monero_daemon_get_peer_bans(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_set_peer_bans(monero_daemon* daemon, const char* bans_json);
 
MONERO_EXPORT monero_result monero_daemon_set_peer_ban(monero_daemon* daemon, const char* ban_json);
 
MONERO_EXPORT monero_result monero_daemon_get_peer_ban(monero_daemon* daemon, const char* address, char** out_json);
 
// ---------------------------------- ADMIN -----------------------------------
 
MONERO_EXPORT monero_result monero_daemon_prune_blockchain(monero_daemon* daemon, bool check, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_save_blockchain(monero_daemon* daemon);
 
MONERO_EXPORT monero_result monero_daemon_pop_blocks(monero_daemon* daemon, uint64_t num_blocks, uint64_t* out_height);
 
MONERO_EXPORT monero_result monero_daemon_flush_cache(monero_daemon* daemon, bool bad_blocks);
 
MONERO_EXPORT monero_result monero_daemon_set_bootstrap_daemon(monero_daemon* daemon, const char* address, const char* username, const char* password, const char* proxy);
 
MONERO_EXPORT monero_result monero_daemon_remove_bootstrap_daemon(monero_daemon* daemon);
 
MONERO_EXPORT monero_result monero_daemon_set_log_hash_rate(monero_daemon* daemon, bool is_visible);
 
MONERO_EXPORT monero_result monero_daemon_set_log_level(monero_daemon* daemon, int32_t level);
 
MONERO_EXPORT monero_result monero_daemon_set_log_categories(monero_daemon* daemon, const char* categories, char** out_categories);
 
MONERO_EXPORT monero_result monero_daemon_check_for_update(monero_daemon* daemon, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_download_update(monero_daemon* daemon, const char* path, char** out_json);
 
MONERO_EXPORT monero_result monero_daemon_stop(monero_daemon* daemon);
 
#ifdef __cplusplus
}
#endif
 
#endif // MONERO_C_DAEMON_H