storage_util.hpp

Go to the documentation of this file.

#ifndef KAGOME_CORE_BLOCKCHAIN_IMPL_PERSISTENT_MAP_UTIL_HPP
#define KAGOME_CORE_BLOCKCHAIN_IMPL_PERSISTENT_MAP_UTIL_HPP

#include "common/buffer.hpp"
#include "primitives/block_header.hpp"
#include "primitives/block_id.hpp"
#include "storage/buffer_map_types.hpp"

namespace kagome::blockchain {

  namespace prefix {
    enum Prefix : uint8_t {
      // mapping of block id to a storage lookup key
      ID_TO_LOOKUP_KEY = 3,

      // block headers
      HEADER = 4,

      // body of the block (extrinsics)
      BLOCK_DATA = 5,

      // node of a trie db
      TRIE_NODE = 7
    };
  }

  enum class KeyValueRepositoryError { INVALID_KEY = 1 };

  outcome::result<void> putNumberToIndexKey(storage::BufferStorage &map,
                                            const primitives::BlockInfo &block);

  common::Buffer prependPrefix(common::BufferView key,
                               prefix::Prefix key_column);

  outcome::result<void> putWithPrefix(storage::BufferStorage &map,
                                      prefix::Prefix prefix,
                                      primitives::BlockNumber num,
                                      common::Hash256 block_hash,
                                      const common::Buffer &value);

  outcome::result<bool> hasWithPrefix(const storage::BufferStorage &storage,
                                      prefix::Prefix prefix,
                                      const primitives::BlockId &block_id);

  outcome::result<std::optional<common::Buffer>> getWithPrefix(
      const storage::BufferStorage &storage,
      prefix::Prefix prefix,
      const primitives::BlockId &block_id);

  common::Buffer numberToIndexKey(primitives::BlockNumber n);

  common::Buffer numberAndHashToLookupKey(primitives::BlockNumber number,
                                          const common::Hash256 &hash);

  outcome::result<primitives::BlockNumber> lookupKeyToNumber(
      const common::BufferView &key);

}  // namespace kagome::blockchain

OUTCOME_HPP_DECLARE_ERROR(kagome::blockchain, KeyValueRepositoryError);

#endif  // KAGOME_CORE_BLOCKCHAIN_IMPL_PERSISTENT_MAP_UTIL_HPP