mst_storage.hpp

Go to the documentation of this file.

#ifndef IROHA_MST_STORAGE_HPP
#define IROHA_MST_STORAGE_HPP

#include <mutex>

#include "interfaces/common_objects/string_view_types.hpp"
#include "logger/logger_fwd.hpp"
#include "multi_sig_transactions/mst_types.hpp"
#include "multi_sig_transactions/state/mst_state.hpp"

namespace iroha {

  class MstStorage {
   public:
    // ------------------------------| user API |-------------------------------

    StateUpdateResult apply(
        shared_model::interface::types::PublicKeyHexStringView target_peer_key,
        const MstState &new_state);

    StateUpdateResult updateOwnState(const DataType &tx);

    MstState extractExpiredTransactions(const TimeType &current_time);

    MstState getDiffState(
        shared_model::interface::types::PublicKeyHexStringView target_peer_key,
        const TimeType &current_time);

    MstState whatsNew(ConstRefState new_state) const;

    bool batchInStorage(const DataType &batch) const;

    void processFinalizedTransaction(
        shared_model::interface::types::HashType const &hash);

    virtual ~MstStorage() = default;

   protected:
    // ------------------------------| class API |------------------------------

    explicit MstStorage(logger::LoggerPtr log);

   private:
    virtual auto applyImpl(
        shared_model::interface::types::PublicKeyHexStringView target_peer_key,
        const MstState &new_state)
        -> decltype(apply(target_peer_key, new_state)) = 0;

    virtual auto updateOwnStateImpl(const DataType &tx)
        -> decltype(updateOwnState(tx)) = 0;

    virtual auto extractExpiredTransactionsImpl(const TimeType &current_time)
        -> decltype(extractExpiredTransactions(current_time)) = 0;

    virtual auto getDiffStateImpl(
        shared_model::interface::types::PublicKeyHexStringView target_peer_key,
        const TimeType &current_time)
        -> decltype(getDiffState(target_peer_key, current_time)) = 0;

    virtual auto whatsNewImpl(ConstRefState new_state) const
        -> decltype(whatsNew(new_state)) = 0;

    virtual bool batchInStorageImpl(const DataType &batch) const = 0;

    virtual void processFinalizedTransactionImpl(
        shared_model::interface::types::HashType const &hash) = 0;

    // -------------------------------| fields |--------------------------------

    mutable std::mutex mutex_;

   protected:
    logger::LoggerPtr log_;
  };
}  // namespace iroha
#endif  // IROHA_MST_STORAGE_HPP