transaction.hpp

//
// MIT License
//
// Copyright (c) 2017-2018 Thibault Martinez and Simon Ninon
//
// 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 <utility>

#include <iota/models/address.hpp>
#include <iota/models/tag.hpp>
#include <iota/types/trytes.hpp>

namespace IOTA {

namespace Models {

class Transaction {
public:
  Transaction() = default;

  ~Transaction() = default;

  explicit Transaction(const Types::Trytes& trytes);

  Transaction(const Types::Trytes& signatureFragments, int64_t currentIndex, int64_t lastIndex,
              const Types::Trytes& nonce, const Types::Trytes& hash, int64_t timestamp,
              const Types::Trytes& trunkTransaction, const Types::Trytes& branchTransaction,
              const Models::Address& address, int64_t value, const Types::Trytes& bundle,
              const Models::Tag& tag, int64_t attachmentTimestamp,
              int64_t attachmentTimestampLowerBound, int64_t attachmentTimestampUpperBound);

  Transaction(const Models::Address& address, int64_t value, const Models::Tag& tag,
              int64_t timestamp, int64_t attachmentTimestamp = 0,
              int64_t attachmentTimestampLowerBound = 0, int64_t attachmentTimestampUpperBound = 0);

public:
  bool isTailTransaction() const;

  const Types::Trytes& getHash() const;

  void setHash(const Types::Trytes& hash);

  const Types::Trytes& getSignatureFragments() const;

  void setSignatureFragments(const Types::Trytes& signatureFragments);

  const Models::Address& getAddress() const;

  void setAddress(const Models::Address& address);

  int64_t getValue() const;
  void setValue(int64_t value);

  const Models::Tag& getTag() const;

  void setTag(const Models::Tag& tag);

  const Models::Tag& getObsoleteTag() const;

  void setObsoleteTag(const Models::Tag& tag);

  int64_t getTimestamp() const;

  void setTimestamp(int64_t timestamp);

  int64_t getAttachmentTimestamp() const;

  void setAttachmentTimestamp(int64_t timestamp);

  int64_t getAttachmentTimestampLowerBound() const;

  void setAttachmentTimestampLowerBound(int64_t timestamp);

  int64_t getAttachmentTimestampUpperBound() const;

  void setAttachmentTimestampUpperBound(int64_t timestamp);

  int64_t getCurrentIndex() const;

  void setCurrentIndex(int64_t currentIndex);

  int64_t getLastIndex() const;

  void setLastIndex(int64_t lastIndex);

  const Types::Trytes& getBundle() const;

  void setBundle(const Types::Trytes& bundle);

  const Types::Trytes& getTrunkTransaction() const;

  void setTrunkTransaction(const Types::Trytes& trunkTransaction);

  const Types::Trytes& getBranchTransaction() const;

  void setBranchTransaction(const Types::Trytes& branchTransaction);

  const Types::Trytes& getNonce() const;

  void setNonce(const Types::Trytes& nonce);

  bool getPersistence() const;

  void setPersistence(bool persistence);

  bool operator==(const Transaction& rhs) const;

  bool operator!=(const Transaction& rhs) const;

  Types::Trytes toTrytes() const;

  void initFromTrytes(const Types::Trytes& trytes);

private:
  static const std::pair<int, int> SignatureFragmentsOffset;
  static const std::pair<int, int> AddressOffset;
  static const std::pair<int, int> ValueOffset;
  static const std::pair<int, int> TagOffset;
  static const std::pair<int, int> TimestampOffset;
  static const std::pair<int, int> CurrentIndexOffset;
  static const std::pair<int, int> LastIndexOffset;
  static const std::pair<int, int> BundleOffset;
  static const std::pair<int, int> TrunkOffset;
  static const std::pair<int, int> BranchOffset;
  static const std::pair<int, int> NonceOffset;
  static const std::pair<int, int> ObsoleteTagOffset;
  static const std::pair<int, int> AttachmentTimestampOffset;
  static const std::pair<int, int> AttachmentTimestampLowerBoundOffset;
  static const std::pair<int, int> AttachmentTimestampUpperBoundOffset;
  static const std::pair<int, int> ValidityChunkOffset;

private:
  Types::Trytes hash_;
  Types::Trytes signatureFragments_;
  Models::Address address_;
  int64_t value_ = 0;
  Models::Tag tag_;
  Models::Tag obsoleteTag_;
  int64_t timestamp_ = 0;
  int64_t attachmentTimestamp_ = 0;
  int64_t attachmentTimestampLowerBound_ = 0;
  int64_t attachmentTimestampUpperBound_ = 0;
  int64_t currentIndex_ = 0;
  int64_t lastIndex_ = 0;
  Types::Trytes bundle_;
  Types::Trytes trunkTransaction_;
  Types::Trytes branchTransaction_;
  Types::Trytes nonce_;
  bool persistence_ = false;
};

std::ostream& operator<<(std::ostream& os, const Transaction& transaction);

}  // namespace Models

}  // namespace IOTA