credit_offer.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/protocol/base.hpp>
#include <graphene/protocol/asset.hpp>
 
namespace graphene { namespace protocol {
 
   struct credit_offer_create_operation : public base_operation
   {
      struct fee_params_t {
         uint64_t fee             = 1 * GRAPHENE_BLOCKCHAIN_PRECISION;
         uint32_t price_per_kbyte = 1 * GRAPHENE_BLOCKCHAIN_PRECISION;
      };
 
      asset           fee;                   
      account_id_type owner_account;         
      asset_id_type   asset_type;            
      share_type      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;
 
      extensions_type extensions;  
 
      account_id_type fee_payer()const { return owner_account; }
      void            validate()const override;
      share_type      calculate_fee(const fee_params_t& k)const;
   };
 
   struct credit_offer_delete_operation : public base_operation
   {
      struct fee_params_t { uint64_t fee = 0; };
 
      asset                fee;                
      account_id_type      owner_account;      
      credit_offer_id_type offer_id;           
 
      extensions_type extensions;  
 
      account_id_type fee_payer()const { return owner_account; }
      void            validate()const override;
   };
 
   struct credit_offer_update_operation : public base_operation
   {
      struct fee_params_t {
         uint64_t fee             = 1 * GRAPHENE_BLOCKCHAIN_PRECISION;
         uint32_t price_per_kbyte = 1 * GRAPHENE_BLOCKCHAIN_PRECISION;
      };
 
      asset                    fee;                   
      account_id_type          owner_account;         
      credit_offer_id_type     offer_id;              
      optional<asset>          delta_amount;          
      optional<uint32_t>       fee_rate;              
      optional<uint32_t>       max_duration_seconds;  
      optional<share_type>     min_deal_amount;       
      optional<bool>           enabled;               
      optional<time_point_sec> auto_disable_time;     
 
      optional<flat_map<asset_id_type, price>>          acceptable_collateral;
 
      optional<flat_map<account_id_type, share_type>>   acceptable_borrowers;
 
      extensions_type extensions;  
 
      account_id_type fee_payer()const { return owner_account; }
      void            validate()const override;
      share_type      calculate_fee(const fee_params_t& k)const;
   };
 
   enum class credit_deal_auto_repayment_type
   {
      no_auto_repayment = 0,
      only_full_repayment = 1,
      allow_partial_repayment = 2,
      CDAR_TYPE_COUNT = 3
   };
 
   struct credit_offer_accept_operation : public base_operation
   {
      struct ext
      {
         fc::optional<uint8_t> auto_repay;
      };
 
      struct fee_params_t { uint64_t fee = 1 * GRAPHENE_BLOCKCHAIN_PRECISION; };
 
      asset                    fee;                
      account_id_type          borrower;           
      credit_offer_id_type     offer_id;           
      asset                    borrow_amount;      
      asset                    collateral;         
      uint32_t                 max_fee_rate = 0;   
      uint32_t                 min_duration_seconds = 0; 
 
      extension<ext> extensions; 
 
      account_id_type fee_payer()const { return borrower; }
      void            validate()const override;
   };
 
   struct credit_deal_repay_operation : public base_operation
   {
      struct fee_params_t { uint64_t fee = 1 * GRAPHENE_BLOCKCHAIN_PRECISION; };
 
      asset                    fee;                
      account_id_type          account;            
      credit_deal_id_type      deal_id;            
      asset                    repay_amount;       
      asset                    credit_fee;         
 
      extensions_type extensions;  
 
      account_id_type fee_payer()const { return account; }
      void            validate()const override;
   };
 
   struct credit_deal_expired_operation : public base_operation
   {
      struct fee_params_t {};
 
      credit_deal_expired_operation() = default;
 
      credit_deal_expired_operation( const credit_deal_id_type& did, const credit_offer_id_type& oid,
            const account_id_type& o, const account_id_type& b, const asset& u, const asset& c, const uint32_t fr)
      : deal_id(did), offer_id(oid), offer_owner(o), borrower(b), unpaid_amount(u), collateral(c), fee_rate(fr)
      { /* Nothing to do */ }
 
      asset                    fee;                
      credit_deal_id_type      deal_id;            
      credit_offer_id_type     offer_id;           
      account_id_type          offer_owner;        
      account_id_type          borrower;           
      asset                    unpaid_amount;      
      asset                    collateral;         
      uint32_t                 fee_rate = 0;       
 
      account_id_type fee_payer()const { return borrower; }
      void            validate()const override { FC_ASSERT( !"virtual operation" ); }
 
      share_type      calculate_fee(const fee_params_t&)const { return 0; }
   };
 
   struct credit_deal_update_operation : public base_operation
   {
      struct fee_params_t { uint64_t fee = 1 * GRAPHENE_BLOCKCHAIN_PRECISION; };
 
      asset                    fee;                
      account_id_type          account;            
      credit_deal_id_type      deal_id;            
      uint8_t                  auto_repay;         
 
      extensions_type extensions;  
 
      account_id_type fee_payer()const { return account; }
      void            validate()const override;
   };
 
} } // graphene::protocol
 
FC_REFLECT( graphene::protocol::credit_offer_create_operation::fee_params_t, (fee)(price_per_kbyte) )
FC_REFLECT( graphene::protocol::credit_offer_delete_operation::fee_params_t, (fee) )
FC_REFLECT( graphene::protocol::credit_offer_update_operation::fee_params_t, (fee)(price_per_kbyte) )
FC_REFLECT( graphene::protocol::credit_offer_accept_operation::fee_params_t, (fee) )
FC_REFLECT( graphene::protocol::credit_deal_repay_operation::fee_params_t, (fee) )
FC_REFLECT( graphene::protocol::credit_deal_expired_operation::fee_params_t, ) // VIRTUAL
FC_REFLECT( graphene::protocol::credit_deal_update_operation::fee_params_t, (fee) )
 
FC_REFLECT( graphene::protocol::credit_offer_create_operation,
            (fee)
            (owner_account)
            (asset_type)
            (balance)
            (fee_rate)
            (max_duration_seconds)
            (min_deal_amount)
            (enabled)
            (auto_disable_time)
            (acceptable_collateral)
            (acceptable_borrowers)
            (extensions)
          )
 
FC_REFLECT( graphene::protocol::credit_offer_delete_operation,
            (fee)
            (owner_account)
            (offer_id)
            (extensions)
          )
 
FC_REFLECT( graphene::protocol::credit_offer_update_operation,
            (fee)
            (owner_account)
            (offer_id)
            (delta_amount)
            (fee_rate)
            (max_duration_seconds)
            (min_deal_amount)
            (enabled)
            (auto_disable_time)
            (acceptable_collateral)
            (acceptable_borrowers)
            (extensions)
          )
 
FC_REFLECT( graphene::protocol::credit_offer_accept_operation::ext,
            (auto_repay)
          )
 
FC_REFLECT( graphene::protocol::credit_offer_accept_operation,
            (fee)
            (borrower)
            (offer_id)
            (borrow_amount)
            (collateral)
            (max_fee_rate)
            (min_duration_seconds)
            (extensions)
          )
 
FC_REFLECT( graphene::protocol::credit_deal_repay_operation,
            (fee)
            (account)
            (deal_id)
            (repay_amount)
            (credit_fee)
            (extensions)
          )
 
FC_REFLECT( graphene::protocol::credit_deal_expired_operation,
            (fee)
            (deal_id)
            (offer_id)
            (offer_owner)
            (borrower)
            (unpaid_amount)
            (collateral)
            (fee_rate)
          )
 
FC_REFLECT( graphene::protocol::credit_deal_update_operation,
            (fee)
            (account)
            (deal_id)
            (auto_repay)
            (extensions)
          )
 
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_accept_operation::ext )
 
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_create_operation::fee_params_t )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_delete_operation::fee_params_t )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_update_operation::fee_params_t )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_accept_operation::fee_params_t )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_deal_repay_operation::fee_params_t )
// Note: credit_deal_expired_operation is virtual so no external serialization for its fee_params_t
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_deal_update_operation::fee_params_t )
 
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_create_operation )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_delete_operation )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_update_operation )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_offer_accept_operation )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_deal_repay_operation )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_deal_expired_operation )
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::credit_deal_update_operation )