market_history_plugin.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/plugin.hpp>
#include <graphene/chain/database.hpp>
#include <graphene/chain/operation_history_object.hpp>

#include <fc/thread/future.hpp>
#include <fc/uint128.hpp>

#include <boost/multi_index/composite_key.hpp>

namespace graphene { namespace market_history {
using namespace chain;

//
// Plugins should #define their SPACE_ID's so plugins with
// conflicting SPACE_ID assignments can be compiled into the
// same binary (by simply re-assigning some of the conflicting #defined
// SPACE_ID's in a build script).
//
// Assignment of SPACE_ID's cannot be done at run-time because
// various template automagic depends on them being known at compile
// time.
//
#ifndef MARKET_HISTORY_SPACE_ID
#define MARKET_HISTORY_SPACE_ID 5
#endif

enum market_history_object_type
{
   order_history_object_type = 0,
   bucket_object_type = 1,
   market_ticker_object_type = 2,
   market_ticker_meta_object_type = 3,
   // LP = liquidity pool
   lp_history_object_type = 4,
   lp_ticker_meta_object_type = 5,
   lp_ticker_object_type = 6
};

struct bucket_key
{
   bucket_key( asset_id_type a, asset_id_type b, uint32_t s, fc::time_point_sec o )
   :base(a),quote(b),seconds(s),open(o){}
   bucket_key(){}

   asset_id_type      base;
   asset_id_type      quote;
   uint32_t           seconds = 0;
   fc::time_point_sec open;

   friend bool operator < ( const bucket_key& a, const bucket_key& b )
   {
      return std::tie( a.base, a.quote, a.seconds, a.open ) < std::tie( b.base, b.quote, b.seconds, b.open );
   }
   friend bool operator == ( const bucket_key& a, const bucket_key& b )
   {
      return std::tie( a.base, a.quote, b.seconds, a.open ) == std::tie( b.base, b.quote, b.seconds, b.open );
   }
};

struct bucket_object : public abstract_object<bucket_object, MARKET_HISTORY_SPACE_ID, bucket_object_type>
{
   price high()const { return asset( high_base, key.base ) / asset( high_quote, key.quote ); }
   price low()const { return asset( low_base, key.base ) / asset( low_quote, key.quote ); }

   bucket_key          key;
   share_type          high_base;
   share_type          high_quote;
   share_type          low_base;
   share_type          low_quote;
   share_type          open_base;
   share_type          open_quote;
   share_type          close_base;
   share_type          close_quote;
   share_type          base_volume;
   share_type          quote_volume;
};

struct history_key {
  asset_id_type        base;
  asset_id_type        quote;
  int64_t              sequence = 0;

  friend bool operator < ( const history_key& a, const history_key& b ) {
    return std::tie( a.base, a.quote, a.sequence ) < std::tie( b.base, b.quote, b.sequence );
  }
  friend bool operator == ( const history_key& a, const history_key& b ) {
    return std::tie( a.base, a.quote, a.sequence ) == std::tie( b.base, b.quote, b.sequence );
  }
};
struct order_history_object : public abstract_object<order_history_object,
                                        MARKET_HISTORY_SPACE_ID, order_history_object_type>
{
   history_key          key;
   fc::time_point_sec   time;
   fill_order_operation op;
};
struct order_history_object_key_base_extractor
{
   using result_type = asset_id_type;
   result_type operator()(const order_history_object& o)const { return o.key.base; }
};
struct order_history_object_key_quote_extractor
{
   using result_type = asset_id_type;
   result_type operator()(const order_history_object& o)const { return o.key.quote; }
};
struct order_history_object_key_sequence_extractor
{
   using result_type = int64_t;
   result_type operator()(const order_history_object& o)const { return o.key.sequence; }
};

struct market_ticker_object : public abstract_object<market_ticker_object,
                                        MARKET_HISTORY_SPACE_ID, market_ticker_object_type>
{
   asset_id_type       base;
   asset_id_type       quote;
   share_type          last_day_base;
   share_type          last_day_quote;
   share_type          latest_base;
   share_type          latest_quote;
   fc::uint128_t       base_volume;
   fc::uint128_t       quote_volume;
};

struct market_ticker_meta_object : public abstract_object<market_ticker_meta_object,
                                             MARKET_HISTORY_SPACE_ID, market_ticker_meta_object_type>
{
   object_id_type      rolling_min_order_his_id;
   bool                skip_min_order_his_id = false;
};

struct by_key;
using bucket_object_multi_index_type = multi_index_container<
   bucket_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_unique< tag<by_key>, member< bucket_object, bucket_key, &bucket_object::key > >
   >
>;

struct by_market_time;
using order_history_multi_index_type = multi_index_container<
   order_history_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_unique< tag<by_key>, member< order_history_object, history_key, &order_history_object::key > >,
      ordered_unique<
         tag<by_market_time>,
         composite_key<
            order_history_object,
            order_history_object_key_base_extractor,
            order_history_object_key_quote_extractor,
            member<order_history_object, time_point_sec, &order_history_object::time>,
            order_history_object_key_sequence_extractor
         >,
         composite_key_compare<
            std::less< asset_id_type >,
            std::less< asset_id_type >,
            std::greater< time_point_sec >,
            std::less< int64_t >
         >
      >
   >
>;

struct by_market;
struct by_volume;
using market_ticker_obj_mlti_idx_type = multi_index_container<
   market_ticker_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_non_unique< tag<by_volume>,
                          member< market_ticker_object, fc::uint128_t, &market_ticker_object::base_volume > >,
      ordered_unique<
         tag<by_market>,
         composite_key<
            market_ticker_object,
            member<market_ticker_object, asset_id_type, &market_ticker_object::base>,
            member<market_ticker_object, asset_id_type, &market_ticker_object::quote>
         >
      >
   >
>;

using bucket_index = generic_index<bucket_object, bucket_object_multi_index_type>;
using history_index = generic_index<order_history_object, order_history_multi_index_type>;
using market_ticker_index = generic_index<market_ticker_object, market_ticker_obj_mlti_idx_type>;


struct liquidity_pool_history_object : public abstract_object<liquidity_pool_history_object,
                                                 MARKET_HISTORY_SPACE_ID, lp_history_object_type>
{
   liquidity_pool_id_type   pool;
   uint64_t                 sequence = 0;
   fc::time_point_sec       time;
   int64_t                  op_type;
   operation_history_object op;
};

struct by_pool_seq;
struct by_pool_time;
struct by_pool_op_type_seq;
struct by_pool_op_type_time;

using lp_history_multi_index_type = multi_index_container<
   liquidity_pool_history_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_unique< tag<by_pool_seq>,
         composite_key< liquidity_pool_history_object,
            member<liquidity_pool_history_object, liquidity_pool_id_type, &liquidity_pool_history_object::pool>,
            member<liquidity_pool_history_object, uint64_t, &liquidity_pool_history_object::sequence>
         >,
         composite_key_compare<
            std::less< liquidity_pool_id_type >,
            std::greater< uint64_t >
         >
      >,
      ordered_unique< tag<by_pool_time>,
         composite_key< liquidity_pool_history_object,
            member<liquidity_pool_history_object, liquidity_pool_id_type, &liquidity_pool_history_object::pool>,
            member<liquidity_pool_history_object, time_point_sec, &liquidity_pool_history_object::time>,
            member<liquidity_pool_history_object, uint64_t, &liquidity_pool_history_object::sequence>
         >,
         composite_key_compare<
            std::less< liquidity_pool_id_type >,
            std::greater< time_point_sec >,
            std::greater< uint64_t >
         >
      >,
      ordered_unique< tag<by_pool_op_type_seq>,
         composite_key< liquidity_pool_history_object,
            member<liquidity_pool_history_object, liquidity_pool_id_type, &liquidity_pool_history_object::pool>,
            member<liquidity_pool_history_object, int64_t, &liquidity_pool_history_object::op_type>,
            member<liquidity_pool_history_object, uint64_t, &liquidity_pool_history_object::sequence>
         >,
         composite_key_compare<
            std::less< liquidity_pool_id_type >,
            std::less< int64_t >,
            std::greater< uint64_t >
         >
      >,
      ordered_unique< tag<by_pool_op_type_time>,
         composite_key< liquidity_pool_history_object,
            member<liquidity_pool_history_object, liquidity_pool_id_type, &liquidity_pool_history_object::pool>,
            member<liquidity_pool_history_object, int64_t, &liquidity_pool_history_object::op_type>,
            member<liquidity_pool_history_object, time_point_sec, &liquidity_pool_history_object::time>,
            member<liquidity_pool_history_object, uint64_t, &liquidity_pool_history_object::sequence>
         >,
         composite_key_compare<
            std::less< liquidity_pool_id_type >,
            std::less< int64_t >,
            std::greater< time_point_sec >,
            std::greater< uint64_t >
         >
      >
   >
>;

using liquidity_pool_history_index = generic_index< liquidity_pool_history_object, lp_history_multi_index_type >;


struct lp_ticker_meta_object : public abstract_object<lp_ticker_meta_object,
                                         MARKET_HISTORY_SPACE_ID, lp_ticker_meta_object_type>
{
   object_id_type      rolling_min_lp_his_id;
   bool                skip_min_lp_his_id = false;
};

using liquidity_pool_ticker_id_type = object_id<MARKET_HISTORY_SPACE_ID, lp_ticker_object_type>;

struct liquidity_pool_ticker_object : public abstract_object<liquidity_pool_ticker_object,
                                                MARKET_HISTORY_SPACE_ID, lp_ticker_object_type>
{
   uint32_t            _24h_deposit_count = 0;
   fc::uint128_t       _24h_deposit_amount_a = 0;
   fc::uint128_t       _24h_deposit_amount_b = 0;
   fc::uint128_t       _24h_deposit_share_amount = 0;
   uint32_t            _24h_withdrawal_count = 0;
   fc::uint128_t       _24h_withdrawal_amount_a = 0;
   fc::uint128_t       _24h_withdrawal_amount_b = 0;
   fc::uint128_t       _24h_withdrawal_share_amount = 0;
   fc::uint128_t       _24h_withdrawal_fee_a = 0;
   fc::uint128_t       _24h_withdrawal_fee_b = 0;
   uint32_t            _24h_exchange_a2b_count = 0;
   fc::uint128_t       _24h_exchange_a2b_amount_a = 0;
   fc::uint128_t       _24h_exchange_a2b_amount_b = 0;
   uint32_t            _24h_exchange_b2a_count = 0;
   fc::uint128_t       _24h_exchange_b2a_amount_a = 0;
   fc::uint128_t       _24h_exchange_b2a_amount_b = 0;
   fc::uint128_t       _24h_exchange_fee_a = 0;
   fc::uint128_t       _24h_exchange_fee_b = 0;
   share_type          _24h_balance_delta_a;
   share_type          _24h_balance_delta_b;
   uint64_t            total_deposit_count = 0;
   fc::uint128_t       total_deposit_amount_a = 0;
   fc::uint128_t       total_deposit_amount_b = 0;
   fc::uint128_t       total_deposit_share_amount = 0;
   uint64_t            total_withdrawal_count = 0;
   fc::uint128_t       total_withdrawal_amount_a = 0;
   fc::uint128_t       total_withdrawal_amount_b = 0;
   fc::uint128_t       total_withdrawal_share_amount = 0;
   fc::uint128_t       total_withdrawal_fee_a = 0;
   fc::uint128_t       total_withdrawal_fee_b = 0;
   uint64_t            total_exchange_a2b_count = 0;
   fc::uint128_t       total_exchange_a2b_amount_a = 0;
   fc::uint128_t       total_exchange_a2b_amount_b = 0;
   uint64_t            total_exchange_b2a_count = 0;
   fc::uint128_t       total_exchange_b2a_amount_a = 0;
   fc::uint128_t       total_exchange_b2a_amount_b = 0;
   fc::uint128_t       total_exchange_fee_a = 0;
   fc::uint128_t       total_exchange_fee_b = 0;
};

using lp_ticker_multi_index_type = multi_index_container<
   liquidity_pool_ticker_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >
   >
>;

using liquidity_pool_ticker_index = generic_index< liquidity_pool_ticker_object, lp_ticker_multi_index_type >;


namespace detail
{
    class market_history_plugin_impl;
}

class market_history_plugin : public graphene::app::plugin
{
   public:
      explicit market_history_plugin(graphene::app::application& app);
      ~market_history_plugin() override;

      std::string plugin_name()const override;
      void plugin_set_program_options(
         boost::program_options::options_description& cli,
         boost::program_options::options_description& cfg) override;
      void plugin_initialize(
         const boost::program_options::variables_map& options) override;
      void plugin_startup() override;

      uint32_t                    max_history()const;
      const flat_set<uint32_t>&   tracked_buckets()const;
      uint32_t                    max_order_his_records_per_market()const;
      uint32_t                    max_order_his_seconds_per_market()const;

   private:
      std::unique_ptr<detail::market_history_plugin_impl> my;
};

} } //graphene::market_history

// Other objects aren't mapped here because they are not used
MAP_OBJECT_ID_TO_TYPE( graphene::market_history::liquidity_pool_ticker_object )

FC_REFLECT( graphene::market_history::history_key, (base)(quote)(sequence) )
FC_REFLECT_DERIVED( graphene::market_history::order_history_object, (graphene::db::object), (key)(time)(op) )
FC_REFLECT( graphene::market_history::bucket_key, (base)(quote)(seconds)(open) )
FC_REFLECT_DERIVED( graphene::market_history::bucket_object, (graphene::db::object),
                    (key)
                    (high_base)(high_quote)
                    (low_base)(low_quote)
                    (open_base)(open_quote)
                    (close_base)(close_quote)
                    (base_volume)(quote_volume) )
FC_REFLECT_DERIVED( graphene::market_history::market_ticker_object, (graphene::db::object),
                    (base)(quote)
                    (last_day_base)(last_day_quote)
                    (latest_base)(latest_quote)
                    (base_volume)(quote_volume) )
FC_REFLECT_DERIVED( graphene::market_history::market_ticker_meta_object, (graphene::db::object),
                    (rolling_min_order_his_id)(skip_min_order_his_id) )
FC_REFLECT_DERIVED( graphene::market_history::liquidity_pool_history_object, (graphene::db::object),
                    (pool)(sequence)(time)(op_type)(op) )
FC_REFLECT_DERIVED( graphene::market_history::lp_ticker_meta_object, (graphene::db::object),
                    (rolling_min_lp_his_id)(skip_min_lp_his_id) )
FC_REFLECT_DERIVED( graphene::market_history::liquidity_pool_ticker_object, (graphene::db::object),
                    (_24h_deposit_count)
                    (_24h_deposit_amount_a)
                    (_24h_deposit_amount_b)
                    (_24h_deposit_share_amount)
                    (_24h_withdrawal_count)
                    (_24h_withdrawal_amount_a)
                    (_24h_withdrawal_amount_b)
                    (_24h_withdrawal_share_amount)
                    (_24h_withdrawal_fee_a)
                    (_24h_withdrawal_fee_b)
                    (_24h_exchange_a2b_count)
                    (_24h_exchange_a2b_amount_a)
                    (_24h_exchange_a2b_amount_b)
                    (_24h_exchange_b2a_count)
                    (_24h_exchange_b2a_amount_a)
                    (_24h_exchange_b2a_amount_b)
                    (_24h_exchange_fee_a)
                    (_24h_exchange_fee_b)
                    (_24h_balance_delta_a)
                    (_24h_balance_delta_b)
                    (total_deposit_count)
                    (total_deposit_amount_a)
                    (total_deposit_amount_b)
                    (total_deposit_share_amount)
                    (total_withdrawal_count)
                    (total_withdrawal_amount_a)
                    (total_withdrawal_amount_b)
                    (total_withdrawal_share_amount)
                    (total_withdrawal_fee_a)
                    (total_withdrawal_fee_b)
                    (total_exchange_a2b_count)
                    (total_exchange_a2b_amount_a)
                    (total_exchange_a2b_amount_b)
                    (total_exchange_b2a_count)
                    (total_exchange_b2a_amount_a)
                    (total_exchange_b2a_amount_b)
                    (total_exchange_fee_a)
                    (total_exchange_fee_b)
                  )