withdraw_permission_object.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/protocol/asset.hpp>
#include <graphene/db/generic_index.hpp>

#include <boost/multi_index/composite_key.hpp>

namespace graphene { namespace chain {
   using namespace graphene::protocol;

  class withdraw_permission_object : public graphene::db::abstract_object<withdraw_permission_object,
                                               protocol_ids, withdraw_permission_object_type>
  {
     public:
        account_id_type    withdraw_from_account;
        account_id_type    authorized_account;
        asset              withdrawal_limit;
        uint32_t           withdrawal_period_sec = 0;
        time_point_sec     period_start_time;
        time_point_sec     expiration;

        share_type         claimed_this_period;

        /***
         * Determine how much is still available to be claimed during the period that contains a time of interest.
         * This object and function is mainly intended to be used with the "current" time as a parameter.
         * The current time can be obtained from the time of the current head of the blockchain.
         */
        asset              available_this_period( fc::time_point_sec current_time )const
        {
           if( current_time >= period_start_time + withdrawal_period_sec )
              return withdrawal_limit;
           return asset( ( withdrawal_limit.amount > claimed_this_period ) ?
                            ( withdrawal_limit.amount - claimed_this_period ) : 0,
                         withdrawal_limit.asset_id );
        }
   };

   struct by_from;
   struct by_authorized;
   struct by_expiration;

   using withdraw_permission_obj_mlt_idx = multi_index_container<
      withdraw_permission_object,
      indexed_by<
         ordered_unique< tag<by_id>, member< object, object_id_type, &object::id > >,
         ordered_unique< tag<by_from>,
            composite_key< withdraw_permission_object,
               member< withdraw_permission_object, account_id_type,
                       &withdraw_permission_object::withdraw_from_account >,
               member< object, object_id_type, &object::id >
            >
         >,
         ordered_unique< tag<by_authorized>,
            composite_key< withdraw_permission_object,
               member< withdraw_permission_object, account_id_type, &withdraw_permission_object::authorized_account >,
               member< object, object_id_type, &object::id >
            >
         >,
         ordered_unique< tag<by_expiration>,
            composite_key< withdraw_permission_object,
               member< withdraw_permission_object, time_point_sec, &withdraw_permission_object::expiration >,
               member< object, object_id_type, &object::id >
            >
         >
      >
   >;

   using withdraw_permission_index = generic_index<withdraw_permission_object, withdraw_permission_obj_mlt_idx>;


} } // graphene::chain

MAP_OBJECT_ID_TO_TYPE(graphene::chain::withdraw_permission_object)

FC_REFLECT_TYPENAME( graphene::chain::withdraw_permission_object )

GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::chain::withdraw_permission_object )