chain_api.hpp

Go to the documentation of this file.

#ifndef KAGOME_API_CHAIN_API_HPP
#define KAGOME_API_CHAIN_API_HPP

#include <boost/variant.hpp>

#include "common/buffer.hpp"
#include "outcome/outcome.hpp"
#include "primitives/block_data.hpp"
#include "primitives/block_header.hpp"
#include "primitives/common.hpp"

namespace kagome::api {
  class ApiService;

  class ChainApi {
   public:
    virtual ~ChainApi() = default;
    using BlockNumber = primitives::BlockNumber;
    using BlockHash = kagome::primitives::BlockHash;
    using ValueType = boost::variant<BlockNumber, std::string>;

    virtual void setApiService(
        const std::shared_ptr<api::ApiService> &api_service) = 0;

    virtual outcome::result<BlockHash> getBlockHash() const = 0;

    virtual outcome::result<BlockHash> getBlockHash(
        BlockNumber block_number) const = 0;

    virtual outcome::result<BlockHash> getBlockHash(
        std::string_view hex_number) const = 0;

    virtual outcome::result<std::vector<BlockHash>> getBlockHash(
        gsl::span<const ValueType> values) const = 0;

    virtual outcome::result<primitives::BlockHeader> getHeader(
        std::string_view hash) = 0;

    virtual outcome::result<primitives::BlockHeader> getHeader() = 0;

    virtual outcome::result<primitives::BlockData> getBlock(
        std::string_view hash) = 0;

    virtual outcome::result<primitives::BlockData> getBlock() = 0;

    virtual outcome::result<primitives::BlockHash> getFinalizedHead() const = 0;

    virtual outcome::result<uint32_t> subscribeFinalizedHeads() = 0;

    virtual outcome::result<void> unsubscribeFinalizedHeads(
        uint32_t subscription_id) = 0;

    virtual outcome::result<uint32_t> subscribeNewHeads() = 0;

    virtual outcome::result<void> unsubscribeNewHeads(
        uint32_t subscription_id) = 0;
  };

}  // namespace kagome::api

#endif  // KAGOME_API_CHAIN_API_HPP