asset_object.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2017 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/chain/types.hpp>
#include <graphene/db/generic_index.hpp>
#include <graphene/protocol/asset_ops.hpp>

#include <boost/multi_index/composite_key.hpp>

namespace graphene { namespace chain {
   class asset_bitasset_data_object;

   class asset_dynamic_data_object : public abstract_object<asset_dynamic_data_object,
                                               implementation_ids, impl_asset_dynamic_data_object_type>
   {
      public:
         share_type current_supply;
         share_type confidential_supply; 
         share_type accumulated_fees; 
         share_type accumulated_collateral_fees; 
         share_type fee_pool;         
   };

   class asset_object : public graphene::db::abstract_object<asset_object, protocol_ids, asset_object_type>
   {
      public:
         static bool is_valid_symbol( const string& symbol );

         bool is_market_issued()const { return bitasset_data_id.valid(); }
         bool is_liquidity_pool_share_asset()const { return for_liquidity_pool.valid(); }
         bool can_force_settle()const { return (0 == (options.flags & disable_force_settle)); }
         bool can_global_settle()const { return (0 != (options.issuer_permissions & global_settle)); }
         bool charges_market_fees()const { return (0 != (options.flags & charge_market_fee)); }
         bool is_transfer_restricted()const { return (0 != (options.flags & transfer_restricted)); }
         bool can_override()const { return (0 != (options.flags & override_authority)); }
         bool allow_confidential()const
         { return (0 == (options.flags & asset_issuer_permission_flags::disable_confidential)); }
         bool can_update_max_supply()const { return (0 == (options.flags & lock_max_supply)); }
         bool can_create_new_supply()const { return (0 == (options.flags & disable_new_supply)); }
         bool can_owner_update_mcr()const { return (0 == (options.issuer_permissions & disable_mcr_update)); }
         bool can_owner_update_icr()const { return (0 == (options.issuer_permissions & disable_icr_update)); }
         bool can_owner_update_mssr()const { return (0 == (options.issuer_permissions & disable_mssr_update)); }
         bool can_owner_update_bsrm()const { return (0 == (options.issuer_permissions & disable_bsrm_update)); }
         bool can_bid_collateral()const { return (0 == (options.flags & disable_collateral_bidding)); }

         asset amount(share_type a)const { return asset(a, asset_id_type(id)); }
         asset amount_from_string(string amount_string)const;
         string amount_to_string(share_type amount)const;
         string amount_to_string(const asset& amount)const
         { FC_ASSERT(amount.asset_id == get_id()); return amount_to_string(amount.amount); }
         string amount_to_pretty_string(share_type amount)const
         { return amount_to_string(amount) + " " + symbol; }
         string amount_to_pretty_string(const asset &amount)const
         { FC_ASSERT(amount.asset_id == get_id()); return amount_to_pretty_string(amount.amount); }

         string symbol;
         uint8_t precision = 0;
         account_id_type issuer;

         asset_options options;

         asset_dynamic_data_id_type  dynamic_asset_data_id;
         optional<asset_bitasset_data_id_type> bitasset_data_id;

         optional<account_id_type> buyback_account;

         optional<liquidity_pool_id_type> for_liquidity_pool;

         uint32_t       creation_block_num = 0;
         time_point_sec creation_time;

         void validate()const
         {
            // UIAs may not be prediction markets, have force settlement, or global settlements
            if( !is_market_issued() )
            {
               FC_ASSERT(0 == (options.flags & disable_force_settle) && 0 == (options.flags & global_settle));
               FC_ASSERT(0 == (options.issuer_permissions & disable_force_settle)
                         && 0 == (options.issuer_permissions & global_settle));
            }
         }

         template<class DB>
         const asset_bitasset_data_object& bitasset_data(const DB& db)const
         {
            FC_ASSERT( bitasset_data_id.valid(),
                       "Asset ${a} (${id}) is not a market issued asset.",
                       ("a",this->symbol)("id",this->id) );
            return db.get( *bitasset_data_id );
         }

         template<class DB>
         const asset_dynamic_data_object& dynamic_data(const DB& db)const
         { return db.get(dynamic_asset_data_id); }

         template<class DB>
         share_type reserved( const DB& db )const
         { return options.max_supply - dynamic_data(db).current_supply; }

         template<class DB>
         bool can_accumulate_fee(const DB& db, const asset& fee) const {
            return (( fee.asset_id == get_id() ) ||
                    ( is_market_issued() && fee.asset_id == bitasset_data(db).options.short_backing_asset ));
         }

         /***
          * @brief receive a fee asset to accrue in dynamic_data object
          *
          * Asset owners define various fees (market fees, force-settle fees, etc.) to be
          * collected for the asset owners. These fees are typically denominated in the asset
          * itself, but for bitassets some of the fees are denominated in the collateral
          * asset. This will place the fee in the right container.
          */
         template<class DB>
         void accumulate_fee(DB& db, const asset& fee) const
         {
            if (fee.amount == 0) return;
            FC_ASSERT( fee.amount >= 0, "Fee amount must be non-negative." );
            const auto& dyn_data = dynamic_asset_data_id(db);
            if (fee.asset_id == get_id()) { // fee same as asset
               db.modify( dyn_data, [&fee]( asset_dynamic_data_object& obj ){
                  obj.accumulated_fees += fee.amount;
               });
            } else { // fee different asset; perhaps collateral-denominated fee
               FC_ASSERT( is_market_issued(),
                          "Asset ${a} (${id}) cannot accept fee of asset (${fid}).",
                          ("a",this->symbol)("id",this->id)("fid",fee.asset_id) );
               const auto & bad = bitasset_data(db);
               FC_ASSERT( fee.asset_id == bad.options.short_backing_asset,
                          "Asset ${a} (${id}) cannot accept fee of asset (${fid}).",
                          ("a",this->symbol)("id",this->id)("fid",fee.asset_id) );
               db.modify( dyn_data, [&fee]( asset_dynamic_data_object& obj ){
                  obj.accumulated_collateral_fees += fee.amount;
               });
            }
         }

   };

   struct price_feed_with_icr : public price_feed
   {
      uint16_t initial_collateral_ratio = GRAPHENE_DEFAULT_MAINTENANCE_COLLATERAL_RATIO;

      price_feed_with_icr()
      : price_feed(), initial_collateral_ratio( maintenance_collateral_ratio )
      {}

      price_feed_with_icr( const price_feed& pf, const optional<uint16_t>& icr = {} )
      : price_feed( pf ), initial_collateral_ratio( icr.valid() ? *icr : pf.maintenance_collateral_ratio )
      {}

      price get_initial_collateralization()const;
   };

   class asset_bitasset_data_object : public abstract_object<asset_bitasset_data_object,
                                                implementation_ids, impl_asset_bitasset_data_object_type>
   {
      public:
         asset_id_type asset_id;

         bitasset_options options;

         flat_map<account_id_type, pair<time_point_sec,price_feed_with_icr>> feeds;
         price_feed_with_icr median_feed;
         price_feed_with_icr current_feed;
         time_point_sec current_feed_publication_time;

         bool is_current_feed_price_capped()const
         { return ( median_feed.settlement_price != current_feed.settlement_price ); }

         price current_maintenance_collateralization;
         price current_initial_collateralization;

         bool is_prediction_market = false;

         share_type force_settled_volume;
         share_type max_force_settlement_volume(share_type current_supply)const;

         bool has_settlement()const { return !settlement_price.is_null(); }

         price settlement_price;
         share_type settlement_fund;

         share_type individual_settlement_debt;
         share_type individual_settlement_fund;

         bool has_individual_settlement()const { return ( individual_settlement_debt != 0 ); }

         price get_individual_settlement_price() const
         {
            return asset( individual_settlement_debt, asset_id )
                   / asset( individual_settlement_fund, options.short_backing_asset );
         }

         bitasset_options::black_swan_response_type get_black_swan_response_method() const
         {
            return options.get_black_swan_response_method();
         }

         price get_margin_call_order_price() const
         {
            return current_feed.margin_call_order_price( options.extensions.value.margin_call_fee_ratio );
         }

         ratio_type get_margin_call_order_ratio() const
         {
            return current_feed.margin_call_order_ratio( options.extensions.value.margin_call_fee_ratio );
         }

         ratio_type get_margin_call_pays_ratio() const
         {
            return current_feed.margin_call_pays_ratio( options.extensions.value.margin_call_fee_ratio );
         }

         bool asset_cer_updated = false;

         bool feed_cer_updated = false;

         bool need_to_update_cer() const
         {
            return ( ( feed_cer_updated || asset_cer_updated ) && !current_feed.core_exchange_rate.is_null() );
         }

         time_point_sec feed_expiration_time()const
         {
            uint32_t current_feed_seconds = current_feed_publication_time.sec_since_epoch();
            if( (std::numeric_limits<uint32_t>::max() - current_feed_seconds) <= options.feed_lifetime_sec )
               return time_point_sec::maximum();
            else
               return current_feed_publication_time + options.feed_lifetime_sec;
         }
         bool feed_is_expired_before_hf_615(time_point_sec current_time)const
         { return feed_expiration_time() >= current_time; }
         bool feed_is_expired(time_point_sec current_time)const
         { return feed_expiration_time() <= current_time; }

         /******
          * @brief calculate the median feed
          *
          * This calculates the median feed from @ref feeds, feed_lifetime_sec
          * in @ref options, and the given parameters.
          * It may update the @ref median_feed, @ref current_feed_publication_time,
          * @ref current_initial_collateralization and
          * @ref current_maintenance_collateralization member variables.
          *
          * @param current_time the current time to use in the calculations
          * @param next_maintenance_time the next chain maintenance time
          *
          * @note Called by @ref database::update_bitasset_current_feed() which updates @ref current_feed afterwards.
          */
         void update_median_feeds(time_point_sec current_time, time_point_sec next_maintenance_time);
      private:
         void refresh_cache();
   };

   struct bitasset_backing_asst_extractor
   {
      using result_type = asset_id_type;
      result_type operator() (const asset_bitasset_data_object& obj) const
      {
         return obj.options.short_backing_asset;
      }
   };

   struct by_short_backing_asset;
   struct by_feed_expiration;
   struct by_cer_update;

   using bitasset_data_multi_index_type = multi_index_container<
      asset_bitasset_data_object,
      indexed_by<
         ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
         ordered_non_unique< tag<by_short_backing_asset>, bitasset_backing_asst_extractor >,
         ordered_unique< tag<by_feed_expiration>,
            composite_key< asset_bitasset_data_object,
               const_mem_fun< asset_bitasset_data_object, time_point_sec,
                              &asset_bitasset_data_object::feed_expiration_time >,
               member< asset_bitasset_data_object, asset_id_type, &asset_bitasset_data_object::asset_id >
            >
         >,
         ordered_non_unique< tag<by_cer_update>,
                             const_mem_fun< asset_bitasset_data_object, bool,
                                            &asset_bitasset_data_object::need_to_update_cer >
         >
      >
   >;
   using asset_bitasset_data_index = generic_index< asset_bitasset_data_object, bitasset_data_multi_index_type >;

   struct by_symbol;
   struct by_type;
   struct by_issuer;
   using asset_object_multi_index_type = multi_index_container<
      asset_object,
      indexed_by<
         ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
         ordered_unique< tag<by_symbol>, member<asset_object, string, &asset_object::symbol> >,
         ordered_unique< tag<by_type>,
            composite_key< asset_object,
                const_mem_fun<asset_object, bool, &asset_object::is_market_issued>,
                member< object, object_id_type, &object::id >
            >
         >,
         ordered_unique< tag<by_issuer>,
            composite_key< asset_object,
                member< asset_object, account_id_type, &asset_object::issuer >,
                member< object, object_id_type, &object::id >
            >
         >
      >
   >;
   using asset_index = generic_index< asset_object, asset_object_multi_index_type >;

} } // graphene::chain

MAP_OBJECT_ID_TO_TYPE(graphene::chain::asset_object)
MAP_OBJECT_ID_TO_TYPE(graphene::chain::asset_dynamic_data_object)
MAP_OBJECT_ID_TO_TYPE(graphene::chain::asset_bitasset_data_object)

FC_REFLECT_DERIVED( graphene::chain::price_feed_with_icr, (graphene::protocol::price_feed),
                    (initial_collateral_ratio) )

// Note: this is left here but not moved to a cpp file due to the extended_asset_object struct in API.
FC_REFLECT_DERIVED( graphene::chain::asset_object, (graphene::db::object),
                    (symbol)
                    (precision)
                    (issuer)
                    (options)
                    (dynamic_asset_data_id)
                    (bitasset_data_id)
                    (buyback_account)
                    (for_liquidity_pool)
                    (creation_block_num)
                    (creation_time)
                  )

FC_REFLECT_TYPENAME( graphene::chain::asset_bitasset_data_object )
FC_REFLECT_TYPENAME( graphene::chain::asset_dynamic_data_object )

GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::price_feed_with_icr )

GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::asset_object )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::asset_bitasset_data_object )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::asset_dynamic_data_object )