base.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/ext.hpp>
#include <graphene/protocol/types.hpp>
 
#include <fc/thread/future.hpp>
 
namespace graphene { namespace protocol {
   struct asset;
   struct authority;
 
   struct void_result{};
 
   struct generic_operation_result
   {
      flat_set<object_id_type> new_objects;
      flat_set<object_id_type> updated_objects;
      flat_set<object_id_type> removed_objects;
   };
 
   struct generic_exchange_operation_result
   {
      vector<asset> paid;
      vector<asset> received;
      vector<asset> fees;
   };
 
   struct extendable_operation_result_dtl
   {
      optional<flat_set<account_id_type>> impacted_accounts;
      optional<flat_set<object_id_type>>  new_objects;
      optional<flat_set<object_id_type>>  updated_objects;
      optional<flat_set<object_id_type>>  removed_objects;
      optional<vector<asset>>             paid;
      optional<vector<asset>>             received;
      optional<vector<asset>>             fees;
   };
 
   using extendable_operation_result = extension<extendable_operation_result_dtl>;
 
   using operation_result = fc::static_variant <
         /* 0 */ void_result,
         /* 1 */ object_id_type,
         /* 2 */ asset,
         /* 3 */ generic_operation_result,
         /* 4 */ generic_exchange_operation_result,
         /* 5 */ extendable_operation_result
         >;
 
   struct base_operation
   {
      virtual ~base_operation() = default;
      template<typename T>
      share_type calculate_fee(const T& params)const
      {
         return params.fee;
      }
      virtual void get_required_authorities( vector<authority>& )const{ /* do nothing by default */ }
      virtual void get_required_active_authorities( flat_set<account_id_type>& )const{ /* do nothing by default */ }
      virtual void get_required_owner_authorities( flat_set<account_id_type>& )const{ /* do nothing by default */ }
      virtual void validate()const{ /* do nothing by default */ }
      fc::optional< fc::future<void> > validate_parallel( uint32_t skip )const;
 
      static uint64_t calculate_data_fee( uint64_t bytes, uint64_t price_per_kbyte );
   };
 
   using future_extensions = static_variant<void_t>;
 
   using extensions_type = future_extensions::flat_set_type;
 
 
} } // graphene::protocol
 
FC_REFLECT_TYPENAME( graphene::protocol::extendable_operation_result )
FC_REFLECT_TYPENAME( graphene::protocol::operation_result )
FC_REFLECT_TYPENAME( graphene::protocol::future_extensions )
FC_REFLECT_TYPENAME( graphene::protocol::extensions_type )
FC_REFLECT( graphene::protocol::void_result, )
FC_REFLECT( graphene::protocol::generic_operation_result, (new_objects)(updated_objects)(removed_objects) )
FC_REFLECT( graphene::protocol::generic_exchange_operation_result, (paid)(received)(fees) )
FC_REFLECT( graphene::protocol::extendable_operation_result_dtl,
            (impacted_accounts)(new_objects)(updated_objects)(removed_objects)(paid)(received)(fees) )
 
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::generic_operation_result ) // impl in operations.cpp
// impl in operations.cpp
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::generic_exchange_operation_result )
// impl in operations.cpp
GRAPHENE_DECLARE_EXTERNAL_SERIALIZATION( graphene::protocol::extendable_operation_result_dtl )