storage_extension.hpp

Go to the documentation of this file.

#ifndef KAGOME_HOST_API_STORAGE_EXTENSION_HPP
#define KAGOME_HOST_API_STORAGE_EXTENSION_HPP

#include <cstdint>

#include "log/logger.hpp"
#include "runtime/types.hpp"
#include "storage/trie/serialization/polkadot_codec.hpp"

namespace kagome::runtime {
  class MemoryProvider;
  class TrieStorageProvider;
}  // namespace kagome::runtime

namespace kagome::host_api {
  class StorageExtension {
   public:
    StorageExtension(
        std::shared_ptr<runtime::TrieStorageProvider> storage_provider,
        std::shared_ptr<const runtime::MemoryProvider> memory_provider);

    void reset();

    // -------------------------Trie operations--------------------------

    runtime::WasmSpan ext_storage_read_version_1(runtime::WasmSpan key,
                                                 runtime::WasmSpan value_out,
                                                 runtime::WasmOffset offset);

    // ------------------------ VERSION 1 ------------------------

    void ext_storage_set_version_1(runtime::WasmSpan key,
                                   runtime::WasmSpan value);

    runtime::WasmSpan ext_storage_get_version_1(runtime::WasmSpan key);

    void ext_storage_clear_version_1(runtime::WasmSpan key_data);

    runtime::WasmSize ext_storage_exists_version_1(
        runtime::WasmSpan key_data) const;

    void ext_storage_clear_prefix_version_1(runtime::WasmSpan prefix);

    runtime::WasmSpan ext_storage_clear_prefix_version_2(
        runtime::WasmSpan prefix, runtime::WasmSpan limit);

    runtime::WasmSpan ext_storage_root_version_1();

    runtime::WasmSpan ext_storage_root_version_2(
        runtime::WasmI32 state_version);

    runtime::WasmSpan ext_storage_changes_root_version_1(
        runtime::WasmSpan parent_hash);

    runtime::WasmSpan ext_storage_next_key_version_1(
        runtime::WasmSpan key) const;

    void ext_storage_append_version_1(runtime::WasmSpan key,
                                      runtime::WasmSpan value) const;

    void ext_storage_start_transaction_version_1();

    void ext_storage_commit_transaction_version_1();

    void ext_storage_rollback_transaction_version_1();

    runtime::WasmPointer ext_trie_blake2_256_root_version_1(
        runtime::WasmSpan values_data);

    runtime::WasmPointer ext_trie_blake2_256_ordered_root_version_1(
        runtime::WasmSpan values_data);

    runtime::WasmPointer ext_trie_blake2_256_ordered_root_version_2(
        runtime::WasmSpan values_data, runtime::WasmI32 state_version);

   private:
    outcome::result<std::optional<common::BufferConstRef>> get(
        const common::BufferView &key) const;

    common::Buffer loadKey(runtime::WasmSpan key) const;
    outcome::result<std::optional<common::Buffer>> getStorageNextKey(
        const common::Buffer &key) const;

    runtime::WasmSpan clearPrefix(common::BufferView prefix,
                                  std::optional<uint32_t> limit);

    void removeEmptyChildStorages();

    std::shared_ptr<runtime::TrieStorageProvider> storage_provider_;
    std::shared_ptr<const runtime::MemoryProvider> memory_provider_;
    storage::trie::PolkadotCodec codec_;
    log::Logger logger_;

    constexpr static auto kDefaultLoggerTag = "WASM Runtime [StorageExtension]";
  };

}  // namespace kagome::host_api

#endif  // KAGOME_HOST_API_STORAGE_EXTENSION_HPP