trie_batches.hpp

Go to the documentation of this file.

#ifndef KAGOME_STORAGE_TRIE_IMPL_TRIE_BATCH
#define KAGOME_STORAGE_TRIE_IMPL_TRIE_BATCH

#include "storage/buffer_map_types.hpp"
#include "storage/trie/polkadot_trie/polkadot_trie_cursor.hpp"
#include "storage/trie/types.hpp"

namespace kagome::storage::trie {

  class TrieBatch
      : public face::ReadableMap<BufferView, Buffer>,
        public face::Writeable<BufferView, Buffer>,
        public face::Iterable<Buffer, common::BufferConstRef, BufferView> {
   public:
    ~TrieBatch() override = default;

    using Cursor =
        face::Iterable<Buffer, common::BufferConstRef, BufferView>::Cursor;
    std::unique_ptr<Cursor> cursor() final {
      return trieCursor();
    }

    virtual std::unique_ptr<PolkadotTrieCursor> trieCursor() = 0;

    virtual outcome::result<std::tuple<bool, uint32_t>> clearPrefix(
        const BufferView &prefix,
        std::optional<uint64_t> limit = std::nullopt) = 0;
  };

  class TopperTrieBatch;

  class PersistentTrieBatch
      : public TrieBatch,
        public std::enable_shared_from_this<PersistentTrieBatch> {
   public:
    virtual outcome::result<RootHash> commit() = 0;

    virtual std::unique_ptr<TopperTrieBatch> batchOnTop() = 0;
  };

  class EphemeralTrieBatch : public TrieBatch {
   public:
    virtual outcome::result<RootHash> hash() = 0;
  };

  class TopperTrieBatch : public TrieBatch {
   public:
    virtual outcome::result<void> writeBack() = 0;
  };

}  // namespace kagome::storage::trie

#endif  // KAGOME_STORAGE_TRIE_IMPL_TRIE_BATCH