state_api.hpp

Go to the documentation of this file.

#ifndef KAGOME_API_SERVICE_STATE_API
#define KAGOME_API_SERVICE_STATE_API

#include <optional>
#include <vector>

#include "api/service/api_service.hpp"
#include "common/buffer.hpp"
#include "outcome/outcome.hpp"
#include "primitives/block_id.hpp"
#include "primitives/common.hpp"
#include "primitives/version.hpp"

namespace kagome::api {

  class StateApi {
   public:
    virtual ~StateApi() = default;

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

    virtual outcome::result<common::Buffer> call(
        std::string_view method,
        common::Buffer data,
        const std::optional<primitives::BlockHash> &opt_at) const = 0;

    virtual outcome::result<std::vector<common::Buffer>> getKeysPaged(
        const std::optional<common::BufferView> &prefix,
        uint32_t keys_amount,
        const std::optional<common::BufferView> &prev_key,
        const std::optional<primitives::BlockHash> &block_hash_opt) const = 0;

    virtual outcome::result<std::optional<common::Buffer>> getStorage(
        const common::BufferView &key) const = 0;
    virtual outcome::result<std::optional<common::Buffer>> getStorageAt(
        const common::BufferView &key,
        const primitives::BlockHash &at) const = 0;

    struct StorageChangeSet {
      primitives::BlockHash block;
      struct Change {
        common::Buffer key;
        std::optional<common::Buffer> data;
      };
      std::vector<Change> changes;
    };

    virtual outcome::result<std::vector<StorageChangeSet>> queryStorage(
        gsl::span<const common::Buffer> keys,
        const primitives::BlockHash &from,
        std::optional<primitives::BlockHash> to) const = 0;

    virtual outcome::result<std::vector<StorageChangeSet>> queryStorageAt(
        gsl::span<const common::Buffer> keys,
        std::optional<primitives::BlockHash> at) const = 0;

    virtual outcome::result<uint32_t> subscribeStorage(
        const std::vector<common::Buffer> &keys) = 0;
    virtual outcome::result<bool> unsubscribeStorage(
        const std::vector<uint32_t> &subscription_id) = 0;

    virtual outcome::result<primitives::Version> getRuntimeVersion(
        const std::optional<primitives::BlockHash> &at) const = 0;

    virtual outcome::result<uint32_t> subscribeRuntimeVersion() = 0;
    virtual outcome::result<void> unsubscribeRuntimeVersion(
        uint32_t subscription_id) = 0;
    virtual outcome::result<std::string> getMetadata() = 0;

    virtual outcome::result<std::string> getMetadata(
        std::string_view hex_block_hash) = 0;
  };

}  // namespace kagome::api

#endif  // KAGOME_API_SERVICE_STATE_API