core.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 <iota/api/responses/fwd.hpp>
#include <iota/api/service.hpp>
#include <iota/models/address.hpp>
#include <iota/models/tag.hpp>

namespace IOTA {

namespace API {

class Core {
public:
  explicit Core(const std::string& host, const uint16_t& port, bool localPow = true,
                int timeout = 60);
  virtual ~Core() = default;

public:
  Responses::GetNodeInfo getNodeInfo() const;

  Responses::GetNeighbors getNeighbors() const;

  Responses::AddNeighbors addNeighbors(const std::vector<std::string>& uris) const;

  Responses::RemoveNeighbors removeNeighbors(const std::vector<std::string>& uris) const;

  Responses::GetTips getTips() const;

  Responses::FindTransactions findTransactions(const std::vector<Models::Address>& addresses,
                                               const std::vector<Models::Tag>&     tags,
                                               const std::vector<Types::Trytes>&   approvees,
                                               const std::vector<Types::Trytes>&   bundles) const;

  Responses::GetTrytes getTrytes(const std::vector<Types::Trytes>& hashes) const;

  Responses::GetInclusionStates getInclusionStates(const std::vector<Types::Trytes>& transactions,
                                                   const std::vector<Types::Trytes>& tips) const;

  Responses::GetBalances getBalances(const std::vector<Models::Address>& addresses,
                                     const int&                          threshold = 100,
                                     const std::vector<Types::Trytes>&   tips      = {}) const;

  Responses::GetTransactionsToApprove getTransactionsToApprove(
      const int& depth, const Types::Trytes& reference = "") const;

  Responses::AttachToTangle attachToTangle(const Types::Trytes&              trunkTransaction,
                                           const Types::Trytes&              branchTransaction,
                                           const int&                        minWeightMagnitude,
                                           const std::vector<Types::Trytes>& trytes) const;

  Responses::Base interruptAttachingToTangle() const;

  Responses::Base broadcastTransactions(const std::vector<Types::Trytes>& trytes) const;

  Responses::Base storeTransactions(const std::vector<Types::Trytes>& trytes) const;

  Responses::WereAddressesSpentFrom wereAddressesSpentFrom(
      const std::vector<Models::Address>& addresses) const;

  /*
   * Used to ensure tail resolves to a consistent ledger which is necessary to validate before
   * attempting promotion. Checks transaction hashes for promotability.
   *
   * This is called with a pending transaction (or more of them) and it will tell you if it is still
   * possible for this transaction (or all the transactions simultaneously if you give more than
   * one) to be confirmed, or not (because it conflicts with another already confirmed transaction).
   *
   * https://iota.readme.io/reference#checkconsistency
   *
   * @param tails Tails to check consistency.
   *
   * @return The response.
   */
  Responses::CheckConsistency checkConsistency(const std::vector<Types::Trytes>& tails) const;

private:
  Service service_;
  bool localPow_;
};

}  // namespace API

}  // namespace IOTA