db_notify.cpp

Go to the documentation of this file.

#include <fc/container/flat.hpp>

#include <graphene/protocol/authority.hpp>
#include <graphene/protocol/operations.hpp>
#include <graphene/protocol/transaction.hpp>

#include <graphene/chain/withdraw_permission_object.hpp>
#include <graphene/chain/database.hpp>
#include <graphene/chain/worker_object.hpp>
#include <graphene/chain/confidential_object.hpp>
#include <graphene/chain/htlc_object.hpp>
#include <graphene/chain/market_object.hpp>
#include <graphene/chain/committee_member_object.hpp>
#include <graphene/chain/witness_object.hpp>
#include <graphene/chain/proposal_object.hpp>
#include <graphene/chain/operation_history_object.hpp>
#include <graphene/chain/vesting_balance_object.hpp>
#include <graphene/chain/transaction_history_object.hpp>
#include <graphene/chain/custom_authority_object.hpp>
#include <graphene/chain/ticket_object.hpp>
#include <graphene/chain/liquidity_pool_object.hpp>
#include <graphene/chain/samet_fund_object.hpp>
#include <graphene/chain/credit_offer_object.hpp>
#include <graphene/chain/impacted.hpp>
#include <graphene/chain/hardfork.hpp>

using namespace fc;
namespace graphene { namespace chain { namespace detail {

// TODO:  Review all of these, especially no-ops
struct get_impacted_account_visitor
{
   flat_set<account_id_type>& _impacted;
   bool _ignore_custom_op_reqd_auths;

   get_impacted_account_visitor( flat_set<account_id_type>& impact, bool ignore_custom_op_required_auths )
      : _impacted( impact ), _ignore_custom_op_reqd_auths( ignore_custom_op_required_auths )
   {}

   using result_type = void;

   void operator()( const transfer_operation& op )
   {
      _impacted.insert( op.to );
      _impacted.insert( op.fee_payer() ); // from
   }
   void operator()( const asset_claim_fees_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
   }
   void operator()( const asset_claim_pool_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
   }
   void operator()( const limit_order_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // seller
   }
   void operator()( const limit_order_cancel_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // fee_paying_account
   }
   void operator()( const call_order_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // funding_account
   }
   void operator()( const bid_collateral_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // bidder
   }
   void operator()( const fill_order_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account_id
   }
   void operator()( const execute_bid_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // bidder
   }
   void operator()( const account_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // registrar
      _impacted.insert( op.referrer );
      add_authority_accounts( _impacted, op.owner );
      add_authority_accounts( _impacted, op.active );
   }
   void operator()( const account_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
      if( op.owner )
         add_authority_accounts( _impacted, *(op.owner) );
      if( op.active )
         add_authority_accounts( _impacted, *(op.active) );
   }
   void operator()( const account_whitelist_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // authorizing_account
      _impacted.insert( op.account_to_list );
   }
   void operator()( const account_upgrade_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account_to_upgrade
   }
   void operator()( const account_transfer_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account_id
   }
   void operator()( const asset_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
   }
   void operator()( const asset_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
      if( op.new_issuer )
         _impacted.insert( *(op.new_issuer) );
   }
   void operator()( const asset_update_issuer_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
      _impacted.insert( op.new_issuer );
   }
   void operator()( const asset_update_bitasset_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
   }
   void operator()( const asset_update_feed_producers_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
   }
   void operator()( const asset_issue_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
      _impacted.insert( op.issue_to_account );
   }
   void operator()( const asset_reserve_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // payer
   }
   void operator()( const asset_fund_fee_pool_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // from_account
   }
   void operator()( const asset_settle_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const asset_global_settle_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // issuer
   }
   void operator()( const asset_publish_feed_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // publisher
   }
   void operator()( const witness_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // witness_account
   }
   void operator()( const witness_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // witness_account
   }
   void operator()( const proposal_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // fee_paying_account
      vector<authority> other;
      for( const auto& proposed_op : op.proposed_ops )
         operation_get_required_authorities( proposed_op.op, _impacted, _impacted, other,
                                             _ignore_custom_op_reqd_auths );
      for( const auto& o : other )
         add_authority_accounts( _impacted, o );
   }
   void operator()( const proposal_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // fee_paying_account
   }
   void operator()( const proposal_delete_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // fee_paying_account
   }
   void operator()( const withdraw_permission_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // withdraw_from_account
      _impacted.insert( op.authorized_account );
   }
   void operator()( const withdraw_permission_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // withdraw_from_account
      _impacted.insert( op.authorized_account );
   }
   void operator()( const withdraw_permission_claim_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // withdraw_to_account
      _impacted.insert( op.withdraw_from_account );
   }
   void operator()( const withdraw_permission_delete_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // withdraw_from_account
      _impacted.insert( op.authorized_account );
   }
   void operator()( const committee_member_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // committee_member_account
   }
   void operator()( const committee_member_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // committee_member_account
   }
   void operator()( const committee_member_update_global_parameters_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account_id_type()
   }
   void operator()( const vesting_balance_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // creator
      _impacted.insert( op.owner );
   }
   void operator()( const vesting_balance_withdraw_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner
   }
   void operator()( const worker_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner
   }
   void operator()( const custom_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // payer
      if( !_ignore_custom_op_reqd_auths )
         _impacted.insert( op.required_auths.begin(), op.required_auths.end() );
   }
   void operator()( const assert_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // fee_paying_account
   }
   void operator()( const balance_claim_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // deposit_to_account
   }
   void operator()( const override_transfer_operation& op )
   {
      _impacted.insert( op.to );
      _impacted.insert( op.from );
      _impacted.insert( op.fee_payer() ); // issuer
   }
   void operator()( const transfer_to_blind_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // from
      for( const auto& out : op.outputs )
         add_authority_accounts( _impacted, out.owner );
   }
   void operator()( const blind_transfer_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // GRAPHENE_TEMP_ACCOUNT
      for( const auto& in : op.inputs )
         add_authority_accounts( _impacted, in.owner );
      for( const auto& out : op.outputs )
         add_authority_accounts( _impacted, out.owner );
   }
   void operator()( const transfer_from_blind_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // GRAPHENE_TEMP_ACCOUNT
      _impacted.insert( op.to );
      for( const auto& in : op.inputs )
         add_authority_accounts( _impacted, in.owner );
   }
   void operator()( const asset_settle_cancel_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const fba_distribute_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account_id
   }
   void operator()( const htlc_create_operation& op )
   {
      _impacted.insert( op.fee_payer() );
      _impacted.insert( op.to );
   }
   void operator()( const htlc_redeem_operation& op )
   {
      _impacted.insert( op.fee_payer() );
   }
   void operator()( const htlc_redeemed_operation& op )
   {
      _impacted.insert( op.from );
      if ( op.to != op.redeemer )
         _impacted.insert( op.to );
   }
   void operator()( const htlc_extend_operation& op )
   {
      _impacted.insert( op.fee_payer() );
   }
   void operator()( const htlc_refund_operation& op )
   {
      _impacted.insert( op.fee_payer() );
   }
   void operator()( const custom_authority_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
      add_authority_accounts( _impacted, op.auth );
   }
   void operator()( const custom_authority_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
      if ( op.new_auth )
         add_authority_accounts(_impacted, *op.new_auth);
   }
   void operator()( const custom_authority_delete_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const ticket_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const ticket_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const liquidity_pool_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const liquidity_pool_delete_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const liquidity_pool_deposit_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const liquidity_pool_withdraw_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const liquidity_pool_exchange_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const samet_fund_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner_account
   }
   void operator()( const samet_fund_delete_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner_account
   }
   void operator()( const samet_fund_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner_account
   }
   void operator()( const samet_fund_borrow_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // borrower
   }
   void operator()( const samet_fund_repay_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const credit_offer_create_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner_account
   }
   void operator()( const credit_offer_delete_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner_account
   }
   void operator()( const credit_offer_update_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // owner_account
   }
   void operator()( const credit_offer_accept_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // borrower
   }
   void operator()( const credit_deal_repay_operation& op )
   {
      _impacted.insert( op.fee_payer() ); // account
   }
   void operator()( const credit_deal_expired_operation& op )
   {
      _impacted.insert( op.offer_owner );
      _impacted.insert( op.borrower );
   }
};

} // namespace detail

// Declared in impacted.hpp
void operation_get_impacted_accounts( const operation& op, flat_set<account_id_type>& result,
      bool ignore_custom_op_required_auths )
{
  detail::get_impacted_account_visitor vtor( result, ignore_custom_op_required_auths );
  op.visit( vtor );
}

// Declared in impacted.hpp, although only used in this file
void transaction_get_impacted_accs( const transaction& tx, flat_set<account_id_type>& result,
      bool ignore_custom_op_required_auths )
{
  for( const auto& op : tx.operations )
    operation_get_impacted_accounts( op, result, ignore_custom_op_required_auths );
}

static void get_relevant_accounts( const object* obj, flat_set<account_id_type>& accounts,
                            bool ignore_custom_op_required_auths ) {
   FC_ASSERT( obj != nullptr, "Internal error: get_relevant_accounts called with nullptr" ); // This should not happen
   if( obj->id.space() == protocol_ids )
   {
      switch( (object_type)obj->id.type() )
      {
        case null_object_type:
        case base_object_type:
           return;
        case account_object_type:
           accounts.insert( account_id_type(obj->id) );
           break;
        case asset_object_type:{
           const auto* aobj = dynamic_cast<const asset_object*>(obj);
           accounts.insert( aobj->issuer );
           break;
        } case force_settlement_object_type:{
           const auto* aobj = dynamic_cast<const force_settlement_object*>(obj);
           accounts.insert( aobj->owner );
           break;
        } case committee_member_object_type:{
           const auto* aobj = dynamic_cast<const committee_member_object*>(obj);
           accounts.insert( aobj->committee_member_account );
           break;
        } case witness_object_type:{
           const auto* aobj = dynamic_cast<const witness_object*>(obj);
           accounts.insert( aobj->witness_account );
           break;
        } case limit_order_object_type:{
           const auto* aobj = dynamic_cast<const limit_order_object*>(obj);
           accounts.insert( aobj->seller );
           break;
        } case call_order_object_type:{
           const auto* aobj = dynamic_cast<const call_order_object*>(obj);
           accounts.insert( aobj->borrower );
           break;
        } case custom_object_type:
          break;
        case proposal_object_type:{
           const auto* aobj = dynamic_cast<const proposal_object*>(obj);
           transaction_get_impacted_accs( aobj->proposed_transaction, accounts,
                                          ignore_custom_op_required_auths );
           break;
        } case operation_history_object_type:{
           const auto* aobj = dynamic_cast<const operation_history_object*>(obj);
           operation_get_impacted_accounts( aobj->op, accounts,
                                            ignore_custom_op_required_auths );
           break;
        } case withdraw_permission_object_type:{
           const auto* aobj = dynamic_cast<const withdraw_permission_object*>(obj);
           accounts.insert( aobj->withdraw_from_account );
           accounts.insert( aobj->authorized_account );
           break;
        } case vesting_balance_object_type:{
           const auto* aobj = dynamic_cast<const vesting_balance_object*>(obj);
           accounts.insert( aobj->owner );
           break;
        } case worker_object_type:{
           const auto* aobj = dynamic_cast<const worker_object*>(obj);
           accounts.insert( aobj->worker_account );
           break;
        } case balance_object_type:
           break;
        case htlc_object_type:{
              const auto* htlc_obj = dynamic_cast<const htlc_object*>(obj);
              accounts.insert( htlc_obj->transfer.from );
              accounts.insert( htlc_obj->transfer.to );
              break;
        } case custom_authority_object_type:{
           const auto* cust_auth_obj = dynamic_cast<const custom_authority_object*>( obj );
           accounts.insert( cust_auth_obj->account );
           add_authority_accounts( accounts, cust_auth_obj->auth );
           break;
        } case ticket_object_type:{
           const auto* aobj = dynamic_cast<const ticket_object*>( obj );
           accounts.insert( aobj->account );
           break;
        } case liquidity_pool_object_type:
           // no account info in the object although it does have an owner
           break;
        case samet_fund_object_type:{
           const auto* aobj = dynamic_cast<const samet_fund_object*>( obj );
           accounts.insert( aobj->owner_account );
           break;
        } case credit_offer_object_type:{
           const auto* aobj = dynamic_cast<const credit_offer_object*>( obj );
           accounts.insert( aobj->owner_account );
           break;
        } case credit_deal_object_type:{
           const auto* aobj = dynamic_cast<const credit_deal_object*>( obj );
           accounts.insert( aobj->offer_owner );
           accounts.insert( aobj->borrower );
           break;
        }
        // Do not have a default fallback so that there will be a compiler warning when a new type is added
      }
   }
   else if( obj->id.space() == implementation_ids )
   {
      switch( (impl_object_type)obj->id.type() )
      {
             case impl_global_property_object_type:
              break;
             case impl_dynamic_global_property_object_type:
              break;
             case impl_reserved0_object_type:
              break;
             case impl_asset_dynamic_data_object_type:
              break;
             case impl_asset_bitasset_data_object_type:
              break;
             case impl_account_balance_object_type:{
              const auto* aobj = dynamic_cast<const account_balance_object*>(obj);
              accounts.insert( aobj->owner );
              break;
           } case impl_account_statistics_object_type:{
              const auto* aobj = dynamic_cast<const account_statistics_object*>(obj);
              accounts.insert( aobj->owner );
              break;
           } case impl_transaction_history_object_type:{
              const auto* aobj = dynamic_cast<const transaction_history_object*>(obj);
              transaction_get_impacted_accs( aobj->trx, accounts,
                                             ignore_custom_op_required_auths );
              break;
           } case impl_blinded_balance_object_type:{
              const auto* aobj = dynamic_cast<const blinded_balance_object*>(obj);
              for( const auto& a : aobj->owner.account_auths )
                accounts.insert( a.first );
              break;
           } case impl_block_summary_object_type:
              break;
             case impl_account_history_object_type: {
              const auto* aobj = dynamic_cast<const account_history_object*>(obj);
              accounts.insert( aobj->account );
              break;
           } case impl_chain_property_object_type:
              break;
             case impl_witness_schedule_object_type:
              break;
             case impl_budget_record_object_type:
              break;
             case impl_special_authority_object_type:
              break;
             case impl_buyback_object_type:
              break;
             case impl_fba_accumulator_object_type:
              break;
             case impl_collateral_bid_object_type:{
              const auto* aobj = dynamic_cast<const collateral_bid_object*>(obj);
              accounts.insert( aobj->bidder );
              break;
           } case impl_credit_deal_summary_object_type:{
              const auto* aobj = dynamic_cast<const credit_deal_summary_object*>(obj);
              accounts.insert( aobj->offer_owner );
              accounts.insert( aobj->borrower );
              break;
           }
           // Do not have a default fallback so that there will be a compiler warning when a new type is added
      }
   }
} // end get_relevant_accounts( const object* obj, flat_set<account_id_type>& accounts )

void database::notify_applied_block( const signed_block& block )
{
   GRAPHENE_TRY_NOTIFY( applied_block, block )
}

void database::notify_on_pending_transaction( const signed_transaction& tx )
{
   GRAPHENE_TRY_NOTIFY( on_pending_transaction, tx )
}

void database::notify_changed_objects()
{ try {
   if( _undo_db.enabled() )
   {
      const auto& head_undo = _undo_db.head();
      auto chain_time = head_block_time();

      // New
      if( !new_objects.empty() )
      {
        vector<object_id_type> new_ids;
        new_ids.reserve(head_undo.new_ids.size());
        flat_set<account_id_type> new_accounts_impacted;
        for( const auto& item : head_undo.new_ids )
        {
          new_ids.push_back(item);
          auto* obj = find_object(item);
          if(obj != nullptr)
            get_relevant_accounts(obj, new_accounts_impacted,
                                  MUST_IGNORE_CUSTOM_OP_REQD_AUTHS(chain_time));
        }

        if( !new_ids.empty() )
           GRAPHENE_TRY_NOTIFY( new_objects, new_ids, new_accounts_impacted)
      }

      // Changed
      if( !changed_objects.empty() )
      {
        vector<object_id_type> changed_ids;
        changed_ids.reserve(head_undo.old_values.size());
        flat_set<account_id_type> changed_accounts_impacted;
        for( const auto& item : head_undo.old_values )
        {
          changed_ids.push_back(item.first);
          get_relevant_accounts(item.second.get(), changed_accounts_impacted,
                                MUST_IGNORE_CUSTOM_OP_REQD_AUTHS(chain_time));
        }

        if( !changed_ids.empty() )
           GRAPHENE_TRY_NOTIFY( changed_objects, changed_ids, changed_accounts_impacted)
      }

      // Removed
      if( !removed_objects.empty() )
      {
        vector<object_id_type> removed_ids;
        removed_ids.reserve( head_undo.removed.size() );
        vector<const object*> removed;
        removed.reserve( head_undo.removed.size() );
        flat_set<account_id_type> removed_accounts_impacted;
        for( const auto& item : head_undo.removed )
        {
          removed_ids.emplace_back( item.first );
          auto* obj = item.second.get();
          removed.emplace_back( obj );
          get_relevant_accounts(obj, removed_accounts_impacted,
                                MUST_IGNORE_CUSTOM_OP_REQD_AUTHS(chain_time));
        }

        if( !removed_ids.empty() )
           GRAPHENE_TRY_NOTIFY( removed_objects, removed_ids, removed, removed_accounts_impacted )
      }
   }
} catch( const graphene::chain::plugin_exception& e ) {
   elog( "Caught plugin exception: ${e}", ("e", e.to_detail_string() ) );
   throw;
} FC_CAPTURE_AND_LOG( (0) ) }

} } // namespace graphene::chain