api.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2015 Cryptonomex, Inc., and contributors.
 *
 * The MIT License
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
#pragma once

#include <graphene/app/database_api.hpp>

#include <graphene/protocol/types.hpp>

#include <graphene/market_history/market_history_plugin.hpp>
#include <graphene/grouped_orders/grouped_orders_plugin.hpp>
#include <graphene/custom_operations/custom_operations_plugin.hpp>

#include <graphene/elasticsearch/elasticsearch_plugin.hpp>

#include <graphene/debug_witness/debug_api.hpp>

#include <graphene/net/node.hpp>

#include <fc/api.hpp>
#include <fc/optional.hpp>
#include <fc/crypto/elliptic.hpp>
#include <fc/network/ip.hpp>

#include <boost/container/flat_set.hpp>

#include <functional>
#include <map>
#include <string>
#include <vector>

namespace graphene { namespace app {
   using namespace graphene::chain;
   using namespace graphene::market_history;
   using namespace graphene::grouped_orders;
   using namespace graphene::custom_operations;

   using std::string;
   using std::vector;
   using std::map;

   class application;

   class history_api
   {
      public:
         explicit history_api(application& app);

         struct history_operation_detail
         {
            uint32_t total_count = 0;
            vector<operation_history_object> operation_history_objs;
         };

         vector<operation_history_object> get_account_history(
            const std::string& account_name_or_id,
            operation_history_id_type stop = operation_history_id_type(),
            uint32_t limit = application_options::get_default().api_limit_get_account_history,
            operation_history_id_type start = operation_history_id_type()
         )const;

         vector<operation_history_object> get_account_history_by_time(
            const std::string& account_name_or_id,
            const optional<uint32_t>& limit = optional<uint32_t>(),
            const optional<fc::time_point_sec>& start = optional<fc::time_point_sec>()
         )const;

         history_operation_detail get_account_history_by_operations(
            const std::string& account_name_or_id,
            const flat_set<uint16_t>& operation_types,
            uint32_t start,
            uint32_t limit
         )const;

         vector<operation_history_object> get_account_history_operations(
            const std::string& account_name_or_id,
            int64_t operation_type,
            operation_history_id_type start = operation_history_id_type(),
            operation_history_id_type stop = operation_history_id_type(),
            uint32_t limit = application_options::get_default().api_limit_get_account_history_operations
         )const;

         vector<operation_history_object> get_relative_account_history(
               const std::string& account_name_or_id,
               uint64_t stop = 0,
               uint32_t limit = application_options::get_default().api_limit_get_relative_account_history,
               uint64_t start = 0) const;

         vector<operation_history_object> get_block_operation_history(
               uint32_t block_num,
               const optional<uint16_t>& trx_in_block = {} ) const;

         vector<operation_history_object> get_block_operations_by_time(
               const optional<fc::time_point_sec>& start = optional<fc::time_point_sec>() ) const;

         vector<order_history_object> get_fill_order_history(
               const std::string& a,
               const std::string& b,
               uint32_t limit )const;

         vector<bucket_object> get_market_history( const std::string& a, const std::string& b,
                                                   uint32_t bucket_seconds,
                                                   const fc::time_point_sec& start,
                                                   const fc::time_point_sec& end )const;

         flat_set<uint32_t> get_market_history_buckets()const;

         vector<liquidity_pool_history_object> get_liquidity_pool_history(
               liquidity_pool_id_type pool_id,
               const optional<fc::time_point_sec>& start = optional<fc::time_point_sec>(),
               const optional<fc::time_point_sec>& stop = optional<fc::time_point_sec>(),
               const optional<uint32_t>& limit = optional<uint32_t>(),
               const optional<int64_t>& operation_type = optional<int64_t>() )const;

         vector<liquidity_pool_history_object> get_liquidity_pool_history_by_sequence(
               liquidity_pool_id_type pool_id,
               const optional<uint64_t>& start = optional<uint64_t>(),
               const optional<fc::time_point_sec>& stop = optional<fc::time_point_sec>(),
               const optional<uint32_t>& limit = optional<uint32_t>(),
               const optional<int64_t>& operation_type = optional<int64_t>() )const;

      private:
           application& _app;
   };

   class block_api
   {
   public:
      explicit block_api(const graphene::chain::database& db);

      vector<optional<signed_block>> get_blocks(uint32_t block_num_from, uint32_t block_num_to)const;

   private:
      const graphene::chain::database& _db;
   };


   class network_broadcast_api : public std::enable_shared_from_this<network_broadcast_api>
   {
      public:
         explicit network_broadcast_api(application& a);

         struct transaction_confirmation
         {
            transaction_id_type   id;
            uint32_t              block_num;
            uint32_t              trx_num;
            processed_transaction trx;
         };

         using confirmation_callback = std::function<void(variant/*transaction_confirmation*/)>;

         void broadcast_transaction(const precomputable_transaction& trx);

         void broadcast_transaction_with_callback( confirmation_callback cb, const precomputable_transaction& trx);

         fc::variant broadcast_transaction_synchronous(const precomputable_transaction& trx);

         void broadcast_block( const signed_block& block );

         void on_applied_block( const signed_block& b );
      private:
         boost::signals2::scoped_connection             _applied_block_connection;
         map<transaction_id_type,confirmation_callback> _callbacks;
         application&                                   _app;
   };

   class network_node_api
   {
      public:
         explicit network_node_api(application& a);

         fc::variant_object get_info() const;

         void add_node(const fc::ip::endpoint& ep);

         std::vector<net::peer_status> get_connected_peers() const;

         fc::variant_object get_advanced_node_parameters() const;

         void set_advanced_node_parameters(const fc::variant_object& params);

         std::vector<net::potential_peer_record> get_potential_peers() const;

      private:
         application& _app;
   };

   class crypto_api
   {
      public:

         struct verify_range_result
         {
            bool        success;
            uint64_t    min_val;
            uint64_t    max_val;
         };

         struct verify_range_proof_rewind_result
         {
            bool                          success;
            uint64_t                      min_val;
            uint64_t                      max_val;
            uint64_t                      value_out;
            fc::ecc::blind_factor_type    blind_out;
            string                        message_out;
         };

         fc::ecc::commitment_type blind( const fc::ecc::blind_factor_type& blind, uint64_t value ) const;

         fc::ecc::blind_factor_type blind_sum( const std::vector<blind_factor_type>& blinds_in,
                                               uint32_t non_neg ) const;

         bool verify_sum(
            const std::vector<commitment_type>& commits_in,
            const std::vector<commitment_type>& neg_commits_in,
            int64_t excess
         ) const;

         verify_range_result verify_range( const fc::ecc::commitment_type& commit,
                                           const std::vector<char>& proof ) const;

         std::vector<char> range_proof_sign( uint64_t min_value,
                                             const commitment_type& commit,
                                             const blind_factor_type& commit_blind,
                                             const blind_factor_type& nonce,
                                             int8_t base10_exp,
                                             uint8_t min_bits,
                                             uint64_t actual_value ) const;

         verify_range_proof_rewind_result verify_range_proof_rewind( const blind_factor_type& nonce,
                                                                     const fc::ecc::commitment_type& commit,
                                                                     const std::vector<char>& proof ) const;

         fc::ecc::range_proof_info range_get_info( const std::vector<char>& proof ) const;
   };

   class asset_api
   {
      public:
         explicit asset_api(graphene::app::application& app);

         struct account_asset_balance
         {
            string          name;
            account_id_type account_id;
            share_type      amount;
         };
         struct asset_holders
         {
            asset_id_type   asset_id;
            int64_t         count;
         };

         vector<account_asset_balance> get_asset_holders( const std::string& asset_symbol_or_id,
                                                          uint32_t start, uint32_t limit  )const;

         int64_t get_asset_holders_count( const std::string& asset_symbol_or_id )const;

         vector<asset_holders> get_all_asset_holders() const;

      private:
         graphene::app::application& _app;
         graphene::chain::database& _db;
   };

   class orders_api
   {
      public:
         explicit orders_api(application& app);

         struct limit_order_group
         {
            explicit limit_order_group( const std::pair<limit_order_group_key,limit_order_group_data>& p )
               :  min_price( p.first.min_price ),
                  max_price( p.second.max_price ),
                  total_for_sale( p.second.total_for_sale )
                  {}
            limit_order_group() = default;

            price         min_price; 
            price         max_price; 
            share_type    total_for_sale; 
         };

         flat_set<uint16_t> get_tracked_groups()const;

         vector< limit_order_group > get_grouped_limit_orders( const std::string& base_asset,
                                                               const std::string& quote_asset,
                                                               uint16_t group,
                                                               const optional<price>& start,
                                                               uint32_t limit )const;

      private:
         application& _app;
   };

   class custom_operations_api
   {
   public:
      explicit custom_operations_api(application& app);

      vector<account_storage_object> get_storage_info(
            const optional<std::string>& account_name_or_id = optional<std::string>(),
            const optional<std::string>& catalog = optional<std::string>(),
            const optional<std::string>& key = optional<std::string>(),
            const optional<uint32_t>& limit = optional<uint32_t>(),
            const optional<account_storage_id_type>& start_id = optional<account_storage_id_type>() )const;

   private:
      application& _app;
   };

   struct dummy_api
   {
      bool dummy() const { return false; }
   };
} } // graphene::app

extern template class fc::api<graphene::app::block_api>;
extern template class fc::api<graphene::app::network_broadcast_api>;
extern template class fc::api<graphene::app::network_node_api>;
extern template class fc::api<graphene::app::history_api>;
extern template class fc::api<graphene::app::crypto_api>;
extern template class fc::api<graphene::app::asset_api>;
extern template class fc::api<graphene::app::orders_api>;
extern template class fc::api<graphene::debug_witness::debug_api>;
extern template class fc::api<graphene::app::custom_operations_api>;
extern template class fc::api<graphene::app::dummy_api>;

namespace graphene { namespace app {
   class login_api
   {
      public:
         explicit login_api(application& a);

         variant login(const optional<string>& user, const optional<string>& password);

         bool logout();

         string get_info() const;

         application_options get_config() const;

         flat_set<string> get_available_api_sets() const;

         fc::api<block_api> block();
         fc::api<network_broadcast_api> network_broadcast();
         fc::api<database_api> database();
         fc::api<history_api> history();
         fc::api<network_node_api> network_node();
         fc::api<crypto_api> crypto();
         fc::api<asset_api> asset();
         fc::api<orders_api> orders();
         fc::api<graphene::debug_witness::debug_api> debug();
         fc::api<custom_operations_api> custom_operations();

         fc::api<dummy_api> dummy();

         bool is_database_api_allowed() const;

      private:
         application& _app;

         flat_set< string > _allowed_apis;

         optional< fc::api<block_api> >                          _block_api;
         optional< fc::api<database_api> >                       _database_api;
         optional< fc::api<network_broadcast_api> >              _network_broadcast_api;
         optional< fc::api<network_node_api> >                   _network_node_api;
         optional< fc::api<history_api> >                        _history_api;
         optional< fc::api<crypto_api> >                         _crypto_api;
         optional< fc::api<asset_api> >                          _asset_api;
         optional< fc::api<orders_api> >                         _orders_api;
         optional< fc::api<graphene::debug_witness::debug_api> > _debug_api;
         optional< fc::api<custom_operations_api> >              _custom_operations_api;
         optional< fc::api<dummy_api> >                          _dummy_api;
   };

}}  // graphene::app

extern template class fc::api<graphene::app::login_api>;

FC_REFLECT( graphene::app::network_broadcast_api::transaction_confirmation,
        (id)(block_num)(trx_num)(trx) )

FC_REFLECT( graphene::app::crypto_api::verify_range_result,
        (success)(min_val)(max_val) )
FC_REFLECT( graphene::app::crypto_api::verify_range_proof_rewind_result,
        (success)(min_val)(max_val)(value_out)(blind_out)(message_out) )

FC_REFLECT( graphene::app::history_api::history_operation_detail,
            (total_count)(operation_history_objs) )

FC_REFLECT( graphene::app::orders_api::limit_order_group,
            (min_price)(max_price)(total_for_sale) )

FC_REFLECT( graphene::app::asset_api::account_asset_balance, (name)(account_id)(amount) )
FC_REFLECT( graphene::app::asset_api::asset_holders, (asset_id)(count) )

FC_API(graphene::app::history_api,
       (get_account_history)
       (get_account_history_by_time)
       (get_account_history_by_operations)
       (get_account_history_operations)
       (get_relative_account_history)
       (get_block_operation_history)
       (get_block_operations_by_time)
       (get_fill_order_history)
       (get_market_history)
       (get_market_history_buckets)
       (get_liquidity_pool_history)
       (get_liquidity_pool_history_by_sequence)
     )
FC_API(graphene::app::block_api,
       (get_blocks)
     )
FC_API(graphene::app::network_broadcast_api,
       (broadcast_transaction)
       (broadcast_transaction_with_callback)
       (broadcast_transaction_synchronous)
       (broadcast_block)
     )
FC_API(graphene::app::network_node_api,
       (get_info)
       (add_node)
       (get_connected_peers)
       (get_potential_peers)
       (get_advanced_node_parameters)
       (set_advanced_node_parameters)
     )
FC_API(graphene::app::crypto_api,
       (blind)
       (blind_sum)
       (verify_sum)
       (verify_range)
       (range_proof_sign)
       (verify_range_proof_rewind)
       (range_get_info)
     )
FC_API(graphene::app::asset_api,
       (get_asset_holders)
       (get_asset_holders_count)
       (get_all_asset_holders)
     )
FC_API(graphene::app::orders_api,
       (get_tracked_groups)
       (get_grouped_limit_orders)
     )
FC_API(graphene::app::custom_operations_api,
       (get_storage_info)
     )
FC_API(graphene::app::dummy_api,
       (dummy)
     )
FC_API(graphene::app::login_api,
       (login)
       (logout)
       (get_info)
       (get_config)
       (get_available_api_sets)
       (block)
       (network_broadcast)
       (database)
       (history)
       (network_node)
       (crypto)
       (asset)
       (orders)
       (debug)
       (custom_operations)
     )