tx_status_factory.hpp

Go to the documentation of this file.

#ifndef IROHA_TX_STATUS_FACTORY_HPP
#define IROHA_TX_STATUS_FACTORY_HPP

#include <memory>

#include "interfaces/transaction_responses/tx_response.hpp"

namespace shared_model {
  namespace interface {

    class TxStatusFactory {
     public:
      using FactoryReturnType = std::unique_ptr<TransactionResponse>;

      using TransactionHashType =
          const TransactionResponse::TransactionHashType &;

      using StatelessErrorOrFailedCommandNameType =
          const TransactionResponse::StatelessErrorOrFailedCommandNameType &;

      using FailedCommandIndexType =
          TransactionResponse::FailedCommandIndexType;

      using ErrorCodeType = TransactionResponse::ErrorCodeType;

      struct TransactionError {
        std::decay_t<StatelessErrorOrFailedCommandNameType> cmd_name_;
        FailedCommandIndexType cmd_index_;
        ErrorCodeType error_code_;

        TransactionError() : cmd_name_{}, cmd_index_{}, error_code_{} {}
        TransactionError(StatelessErrorOrFailedCommandNameType cmd_name,
                         FailedCommandIndexType cmd_index,
                         ErrorCodeType error_code)
            : cmd_name_{cmd_name},
              cmd_index_{cmd_index},
              error_code_{error_code} {}
      };

      // ------------------------| Stateless statuses |-------------------------

      virtual FactoryReturnType makeStatelessFail(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      virtual FactoryReturnType makeStatelessValid(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      // ------------------------| Stateful statuses |--------------------------

      virtual FactoryReturnType makeStatefulFail(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;
      virtual FactoryReturnType makeStatefulValid(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      // --------------------------| Final statuses |---------------------------

      virtual FactoryReturnType makeCommitted(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      virtual FactoryReturnType makeRejected(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      // --------------------------| Rest statuses |----------------------------

      virtual FactoryReturnType makeMstExpired(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      virtual FactoryReturnType makeMstPending(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      virtual FactoryReturnType makeNotReceived(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      virtual FactoryReturnType makeEnoughSignaturesCollected(
          TransactionHashType,
          TransactionError tx_error = TransactionError()) = 0;

      virtual ~TxStatusFactory() = default;
    };
  }  // namespace interface
}  // namespace shared_model

#endif  // IROHA_TX_STATUS_FACTORY_HPP