credit_offer_object.hpp

Go to the documentation of this file.

/*
 * Copyright (c) 2021 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 <boost/multi_index/composite_key.hpp>

namespace graphene { namespace chain {

class credit_offer_object : public abstract_object<credit_offer_object>
{
   public:
      static constexpr uint8_t space_id = protocol_ids;
      static constexpr uint8_t type_id  = credit_offer_object_type;

      account_id_type owner_account;            
      asset_id_type   asset_type;               
      share_type      total_balance;            
      share_type      current_balance;          
      uint32_t        fee_rate = 0;             
      uint32_t        max_duration_seconds = 0; 
      share_type      min_deal_amount;          
      bool            enabled = false;          
      time_point_sec  auto_disable_time;        

      flat_map<asset_id_type, price>          acceptable_collateral;

      flat_map<account_id_type, share_type>   acceptable_borrowers;
};

struct by_auto_disable_time; // for protocol
struct by_owner;             // for API
struct by_asset_type;        // for API

using credit_offer_multi_index_type = multi_index_container<
   credit_offer_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_unique< tag<by_auto_disable_time>,
         composite_key< credit_offer_object,
            member< credit_offer_object, bool, &credit_offer_object::enabled >,
            member< credit_offer_object, time_point_sec, &credit_offer_object::auto_disable_time >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_owner>,
         composite_key< credit_offer_object,
            member< credit_offer_object, account_id_type, &credit_offer_object::owner_account >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_asset_type>,
         composite_key< credit_offer_object,
            member< credit_offer_object, asset_id_type, &credit_offer_object::asset_type >,
            member< object, object_id_type, &object::id>
         >
      >
   >
>;

using credit_offer_index = generic_index<credit_offer_object, credit_offer_multi_index_type>;


class credit_deal_object : public abstract_object<credit_deal_object>
{
   public:
      static constexpr uint8_t space_id = protocol_ids;
      static constexpr uint8_t type_id  = credit_deal_object_type;

      account_id_type      borrower;           
      credit_offer_id_type offer_id;           
      account_id_type      offer_owner;        
      asset_id_type        debt_asset;         
      share_type           debt_amount;        
      asset_id_type        collateral_asset;   
      share_type           collateral_amount;  
      uint32_t             fee_rate = 0;       
      time_point_sec       latest_repay_time;  
};

struct by_latest_repay_time; // for protocol
struct by_offer_id;          // for API
struct by_offer_owner;       // for API
struct by_borrower;          // for API
struct by_debt_asset;        // for API
struct by_collateral_asset;  // for API

using credit_deal_multi_index_type = multi_index_container<
   credit_deal_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_unique< tag<by_latest_repay_time>,
         composite_key< credit_deal_object,
            member< credit_deal_object, time_point_sec, &credit_deal_object::latest_repay_time >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_offer_id>,
         composite_key< credit_deal_object,
            member< credit_deal_object, credit_offer_id_type, &credit_deal_object::offer_id >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_offer_owner>,
         composite_key< credit_deal_object,
            member< credit_deal_object, account_id_type, &credit_deal_object::offer_owner >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_borrower>,
         composite_key< credit_deal_object,
            member< credit_deal_object, account_id_type, &credit_deal_object::borrower >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_debt_asset>,
         composite_key< credit_deal_object,
            member< credit_deal_object, asset_id_type, &credit_deal_object::debt_asset >,
            member< object, object_id_type, &object::id>
         >
      >,
      ordered_unique< tag<by_collateral_asset>,
         composite_key< credit_deal_object,
            member< credit_deal_object, asset_id_type, &credit_deal_object::collateral_asset >,
            member< object, object_id_type, &object::id>
         >
      >
   >
>;

using credit_deal_index = generic_index<credit_deal_object, credit_deal_multi_index_type>;


class credit_deal_summary_object : public abstract_object<credit_deal_summary_object>
{
   public:
      static constexpr uint8_t space_id = implementation_ids;
      static constexpr uint8_t type_id  = impl_credit_deal_summary_object_type;

      account_id_type      borrower;           
      credit_offer_id_type offer_id;           
      account_id_type      offer_owner;        
      asset_id_type        debt_asset;         
      share_type           total_debt_amount;  
};

struct by_offer_borrower;    // for protocol

using credit_deal_summary_index_type = multi_index_container<
   credit_deal_summary_object,
   indexed_by<
      ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
      ordered_unique< tag<by_offer_borrower>,
         composite_key< credit_deal_summary_object,
            member< credit_deal_summary_object, credit_offer_id_type, &credit_deal_summary_object::offer_id >,
            member< credit_deal_summary_object, account_id_type, &credit_deal_summary_object::borrower >
         >
      >
   >
>;

using credit_deal_summary_index = generic_index<credit_deal_summary_object, credit_deal_summary_index_type>;

} } // graphene::chain

MAP_OBJECT_ID_TO_TYPE( graphene::chain::credit_offer_object )
MAP_OBJECT_ID_TO_TYPE( graphene::chain::credit_deal_object )
MAP_OBJECT_ID_TO_TYPE( graphene::chain::credit_deal_summary_object )

FC_REFLECT_TYPENAME( graphene::chain::credit_offer_object )
FC_REFLECT_TYPENAME( graphene::chain::credit_deal_object )
FC_REFLECT_TYPENAME( graphene::chain::credit_deal_summary_object )

GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::credit_offer_object )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::credit_deal_object )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::credit_deal_summary_object )