liquidity_pool_object.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2020 Abit More, 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/chain/types.hpp>
#include <graphene/db/generic_index.hpp>

#include <graphene/protocol/asset.hpp>
#include <graphene/protocol/liquidity_pool.hpp>

#include <boost/multi_index/composite_key.hpp>

namespace graphene { namespace chain {

using namespace graphene::db;

class liquidity_pool_object : public abstract_object<liquidity_pool_object, protocol_ids, liquidity_pool_object_type>
{
   public:
      asset_id_type   asset_a;                     
      asset_id_type   asset_b;                     
      share_type      balance_a;                   
      share_type      balance_b;                   
      asset_id_type   share_asset;                 
      uint16_t        taker_fee_percent = 0;       
      uint16_t        withdrawal_fee_percent = 0;  
      fc::uint128_t   virtual_value = 0;           

      void update_virtual_value()
      {
         virtual_value = fc::uint128_t( balance_a.value ) * balance_b.value;
      }
};

struct by_share_asset;
struct by_asset_a;
struct by_asset_b;
struct by_asset_ab;

typedef multi_index_container<
   liquidity_pool_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_unique< tag<by_share_asset>,
                      member< liquidity_pool_object, asset_id_type, &liquidity_pool_object::share_asset > >,
      ordered_unique< tag<by_asset_a>,
         composite_key< liquidity_pool_object,
            member< liquidity_pool_object, asset_id_type, &liquidity_pool_object::asset_a >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_asset_b>,
         composite_key< liquidity_pool_object,
            member< liquidity_pool_object, asset_id_type, &liquidity_pool_object::asset_b >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_asset_ab>,
         composite_key< liquidity_pool_object,
            member< liquidity_pool_object, asset_id_type, &liquidity_pool_object::asset_a >,
            member< liquidity_pool_object, asset_id_type, &liquidity_pool_object::asset_b >,
            member< object, object_id_type, &object::id>
         >
      >
   >
> liquidity_pool_multi_index_type;

typedef generic_index<liquidity_pool_object, liquidity_pool_multi_index_type> liquidity_pool_index;

} } // graphene::chain

MAP_OBJECT_ID_TO_TYPE( graphene::chain::liquidity_pool_object )

// Note: this is left here but not moved to a cpp file due to the extended_liquidity_pool_object struct in API.
FC_REFLECT_DERIVED( graphene::chain::liquidity_pool_object, (graphene::db::object),
                    (asset_a)
                    (asset_b)
                    (balance_a)
                    (balance_b)
                    (share_asset)
                    (taker_fee_percent)
                    (withdrawal_fee_percent)
                    (virtual_value)
                  )

GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::liquidity_pool_object )