text: // Copyright (c) 2017-2018, The Monero Project
  //
  // All rights reserved.
  //
  // Redistribution and use in source and binary forms, with or without modification, are
  // permitted provided that the following conditions are met:
  //
  // 1. Redistributions of source code must retain the above copyright notice, this list of
  //    conditions and the following disclaimer.
  //
  // 2. Redistributions in binary form must reproduce the above copyright notice, this list
  //    of conditions and the following disclaimer in the documentation and/or other
  //    materials provided with the distribution.
  //
  // 3. Neither the name of the copyright holder nor the names of its contributors may be
  //    used to endorse or promote products derived from this software without specific
  //    prior written permission.
  //
  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
  // EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
  // THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  // PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  // STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF
  // THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  //
  
  #ifndef BITTUBE_EXCEPTIONS_H
  #define BITTUBE_EXCEPTIONS_H
  
  #include <exception>
  #include <string>
  #include <boost/optional.hpp>
  
  namespace hw {
  namespace trezor {
  namespace exc {
  
    class SecurityException : public std::exception {
    protected:
      boost::optional<std::string> reason;
  
    public:
      SecurityException(): reason("General Security exception"){}
      explicit SecurityException(std::string what): reason(what){}
  
      virtual const char* what() const throw() {
        return reason.get().c_str();
      }
    };
  
    class Poly1305TagInvalid: public SecurityException {
    public:
      using SecurityException::SecurityException;
      Poly1305TagInvalid(): SecurityException("Poly1305 authentication tag invalid"){}
    };
  
    class TrezorException : public std::exception {
    protected:
      boost::optional<std::string> reason;
  
    public:
      TrezorException(): reason("General Trezor exception"){}
      explicit TrezorException(std::string what): reason(what){}
  
      virtual const char* what() const throw() {
        return reason.get().c_str();
      }
    };
  
    class CommunicationException: public TrezorException {
    public:
      using TrezorException::TrezorException;
      CommunicationException(): TrezorException("Trezor communication error"){}
    };
  
    class EncodingException: public CommunicationException {
    public:
      using CommunicationException::CommunicationException;
      EncodingException(): CommunicationException("Trezor message encoding error"){}
    };
  
    class NotConnectedException : public CommunicationException {
    public:
      using CommunicationException::CommunicationException;
      NotConnectedException(): CommunicationException("Trezor not connected"){}
    };
  
    class DeviceNotResponsiveException : public CommunicationException {
    public:
      using CommunicationException::CommunicationException;
      DeviceNotResponsiveException(): CommunicationException("Trezor does not respond to ping"){}
    };
  
    class DeviceAcquireException : public CommunicationException {
    public:
      using CommunicationException::CommunicationException;
      DeviceAcquireException(): CommunicationException("Trezor could not be acquired"){}
    };
  
    class SessionException: public CommunicationException {
    public:
      using CommunicationException::CommunicationException;
      SessionException(): CommunicationException("Trezor session expired"){}
    };
  
    class TimeoutException: public CommunicationException {
    public:
      using CommunicationException::CommunicationException;
      TimeoutException(): CommunicationException("Trezor communication timeout"){}
    };
  
    class ProtocolException: public CommunicationException {
    public:
      using CommunicationException::CommunicationException;
      ProtocolException(): CommunicationException("Trezor protocol error"){}
    };
  
    // Communication protocol namespace
    // Separated to distinguish between client and Trezor side exceptions.
  namespace proto {
  
    class SecurityException : public ProtocolException {
    public:
      using ProtocolException::ProtocolException;
      SecurityException(): ProtocolException("Security assertion violated in the protocol"){}
    };
  
    class FailureException : public ProtocolException {
    private:
      boost::optional<uint32_t> code;
      boost::optional<std::string> message;
    public:
      using ProtocolException::ProtocolException;
      FailureException(): ProtocolException("Trezor returned failure"){}
      FailureException(boost::optional<uint32_t> code,
                       boost::optional<std::string> message)
          : code(code), message(message) {
        reason = "Trezor returned failure: code="
                 + (code ? std::to_string(code.get()) : "")
                 + ", message=" + (message ? message.get() : "");
      };
    };
  
    class UnexpectedMessageException : public FailureException {
    public:
      using FailureException::FailureException;
      UnexpectedMessageException(): FailureException("Trezor claims unexpected message received"){}
    };
  
    class CancelledException : public FailureException {
    public:
      using FailureException::FailureException;
      CancelledException(): FailureException("Trezor returned: cancelled operation"){}
    };
  
    class PinExpectedException : public FailureException {
    public:
      using FailureException::FailureException;
      PinExpectedException(): FailureException("Trezor claims PIN is expected"){}
    };
  
    class InvalidPinException : public FailureException {
    public:
      using FailureException::FailureException;
      InvalidPinException(): FailureException("Trezor claims PIN is invalid"){}
    };
  
    class NotEnoughFundsException : public FailureException {
    public:
      using FailureException::FailureException;
      NotEnoughFundsException(): FailureException("Trezor claims not enough funds"){}
    };
  
    class NotInitializedException : public FailureException {
    public:
      using FailureException::FailureException;
      NotInitializedException(): FailureException("Trezor claims not initialized"){}
    };
  
    class FirmwareErrorException : public FailureException {
    public:
      using FailureException::FailureException;
      FirmwareErrorException(): FailureException("Trezor returned firmware error"){}
    };
  
  }
  }
  }
  }
  #endif //BITTUBE_EXCEPTIONS_H
  