blockchain_history_api.hpp

Go to the documentation of this file.

#pragma once
 
#include <map>
#include <fc/api.hpp>
#include <scorum/blockchain_history/schema/applied_operation.hpp>
#include <scorum/blockchain_history/api_objects.hpp>
#include <scorum/protocol/transaction.hpp>
 
#ifndef API_BLOCKCHAIN_HISTORY
#define API_BLOCKCHAIN_HISTORY "blockchain_history_api"
#endif
 
namespace scorum {
namespace app {
struct api_context;
}
} // namespace scorum
 
namespace scorum {
namespace blockchain_history {
 
using namespace scorum::protocol;
 
namespace detail {
class blockchain_history_api_impl;
}
 
class blockchain_history_api
{
public:
    blockchain_history_api(const scorum::app::api_context& ctx);
    ~blockchain_history_api();
 
    void on_api_startup();
 
 
    std::map<uint32_t, applied_operation>
    get_ops_history(uint32_t from_op, uint32_t limit, applied_operation_type type_of_operation) const;
 
    std::map<uint32_t, applied_operation> get_ops_history_by_time(const fc::time_point_sec& from,
                                                                  const fc::time_point_sec& to,
                                                                  uint32_t from_op,
                                                                  uint32_t limit) const;
 
    std::map<uint32_t, applied_operation> get_ops_in_block(uint32_t block_num,
                                                           applied_operation_type type_of_operation) const;
 
    annotated_signed_transaction get_transaction(transaction_id_type trx_id) const;
 
    optional<block_header> get_block_header(uint32_t block_num) const;
 
    std::map<uint32_t, block_header> get_block_headers_history(uint32_t block_num, uint32_t limit) const;
 
    optional<signed_block_api_obj> get_block(uint32_t block_num) const;
 
    std::map<uint32_t, signed_block_api_obj> get_blocks_history(uint32_t block_num, uint32_t limit) const;
 
    std::vector<block_api_object> get_blocks(uint32_t from, uint32_t limit) const;
 
private:
    std::unique_ptr<detail::blockchain_history_api_impl> _impl;
};
 
} // namespace blockchain_history
} // namespace scorum
 
FC_API(scorum::blockchain_history::blockchain_history_api,
       (get_ops_history)(get_ops_history_by_time)(get_ops_in_block)
       // Blocks and transactions
       (get_transaction)(get_block_header)(get_block_headers_history)(get_block)(get_blocks_history)(get_blocks))