trie_storage_provider.hpp

Go to the documentation of this file.

#ifndef KAGOME_CORE_RUNTIME_TRIE_STORAGE_PROVIDER
#define KAGOME_CORE_RUNTIME_TRIE_STORAGE_PROVIDER

#include <optional>
#include <unordered_map>

#include "common/blob.hpp"
#include "outcome/outcome.hpp"
#include "storage/trie/trie_batches.hpp"
#include "storage/trie/types.hpp"

namespace kagome::runtime {

  class TrieStorageProvider {
   public:
    using Batch = storage::trie::TrieBatch;
    using PersistentBatch = storage::trie::PersistentTrieBatch;

    virtual ~TrieStorageProvider() = default;

    virtual outcome::result<void> setToEphemeralAt(
        const common::Hash256 &state_root) = 0;

    virtual outcome::result<void> setToPersistentAt(
        const common::Hash256 &state_root) = 0;

    virtual std::shared_ptr<Batch> getCurrentBatch() const = 0;

    virtual std::optional<std::shared_ptr<PersistentBatch>>
    tryGetPersistentBatch() const = 0;

    virtual bool isCurrentlyPersistent() const = 0;

    virtual outcome::result<std::shared_ptr<PersistentBatch>> getChildBatchAt(
        const common::Buffer &root_path) = 0;

    virtual void clearChildBatches() noexcept = 0;

    virtual outcome::result<storage::trie::RootHash> forceCommit() = 0;

    // ------ Transaction methods ------

    virtual outcome::result<void> startTransaction() = 0;

    virtual outcome::result<void> rollbackTransaction() = 0;

    virtual outcome::result<void> commitTransaction() = 0;
  };

}  // namespace kagome::runtime

#endif  // KAGOME_CORE_RUNTIME_TRIE_STORAGE_PROVIDER