version.hpp

Go to the documentation of this file.

#ifndef KAGOME_CORE_PRIMITIVES_VERSION_HPP
#define KAGOME_CORE_PRIMITIVES_VERSION_HPP

#include <array>
#include <optional>
#include <string>
#include <vector>

#include "common/blob.hpp"

namespace kagome::primitives {
  using ApiId = common::Blob<8u>;

  using Api = std::pair<ApiId, uint32_t>;

  using ApisVec = std::vector<Api>;

  struct Version {
    std::string spec_name;

    std::string impl_name;

    uint32_t authoring_version = 0u;

    uint32_t spec_version = 0u;

    uint32_t impl_version = 0u;

    ApisVec apis;

    uint32_t transaction_version = 1u;

    uint8_t state_version = 0u;

    bool operator==(const Version &rhs) const {
      return spec_name == rhs.spec_name and impl_name == rhs.impl_name
             and authoring_version == rhs.authoring_version
             and impl_version == rhs.impl_version and apis == rhs.apis
             and spec_version == rhs.spec_version
             and transaction_version == rhs.transaction_version
             and state_version == rhs.state_version;
    }

    bool operator!=(const Version &rhs) const {
      return !operator==(rhs);
    }
  };

  namespace detail {
    std::optional<uint32_t> coreVersionFromApis(const ApisVec &apis);
  }  // namespace detail

  template <class Stream,
            typename = std::enable_if_t<Stream::is_encoder_stream>>
  Stream &operator<<(Stream &s, const Version &v) {
    return s << v.spec_name << v.impl_name << v.authoring_version
             << v.spec_version << v.impl_version << v.apis
             << v.transaction_version << v.state_version;
  }

  template <class Stream,
            typename = std::enable_if_t<Stream::is_decoder_stream>>
  Stream &operator>>(Stream &s, Version &v) {
    s >> v.spec_name >> v.impl_name >> v.authoring_version >> v.spec_version
        >> v.impl_version >> v.apis;

    auto core_version = detail::coreVersionFromApis(v.apis);
    // old Kusama runtimes do not contain transaction_version and state_version
    // https://github.com/paritytech/substrate/blob/1b3ddae9dec6e7653b5d6ef0179df1af831f46f0/primitives/version/src/lib.rs#L238
    if (core_version.has_value() and core_version.value() >= 3
        and s.hasMore(sizeof(v.transaction_version))) {
      s >> v.transaction_version;
    } else {
      v.transaction_version = 1;
    }
    if (core_version.has_value() and core_version.value() >= 4
        and s.hasMore(sizeof(v.state_version))) {
      s >> v.state_version;
    } else {
      v.state_version = 0;
    }
    return s;
  }
}  // namespace kagome::primitives

#endif  // KAGOME_CORE_PRIMITIVES_VERSION_HPP