refactor ChainEpoch (#76)

Alexey-N-Chernyshov · web-flow · commit c6feeaebcb10 · 2020-01-29T13:23:12.000+03:00
Signed-off-by: Alexey-N-Chernyshov &lt;alexey.n.chernyshov@gmail.com&gt;
diff --git a/core/clock/chain_epoch_clock.hpp b/core/clock/chain_epoch_clock.hpp
@@ -7,13 +7,12 @@
 #define CPP_FILECOIN_CORE_CLOCK_CHAIN_EPOCH_CLOCK_HPP
 
 #include "clock/time.hpp"
-
-#include "libp2p/multi/uvarint.hpp"
+#include "primitives/chain_epoch.hpp"
 
 namespace fc::clock {
   enum class EpochAtTimeError { BEFORE_GENESIS = 1 };
 
-  using ChainEpoch = libp2p::multi::UVarint;
+  using primitives::ChainEpoch;
 
   /**
    * Converts UTC time to epoch number
diff --git a/core/crypto/bls/impl/bls_provider_impl.cpp b/core/crypto/bls/impl/bls_provider_impl.cpp
@@ -7,7 +7,7 @@
 
 #include <gsl/gsl_util>
 
-namespace fc::crypto::bls::impl {
+namespace fc::crypto::bls {
   outcome::result<KeyPair> BlsProviderImpl::generateKeyPair() const {
     KeyPair key_pair{};
     PrivateKeyGenerateResponse *private_key_response = private_key_generate();
diff --git a/core/crypto/bls/impl/bls_provider_impl.hpp b/core/crypto/bls/impl/bls_provider_impl.hpp
@@ -8,7 +8,7 @@
 
 #include "crypto/bls/bls_provider.hpp"
 
-namespace fc::crypto::bls::impl {
+namespace fc::crypto::bls {
   class BlsProviderImpl : public BlsProvider {
    public:
     outcome::result<KeyPair> generateKeyPair() const override;
@@ -32,6 +32,6 @@ namespace fc::crypto::bls::impl {
     static outcome::result<Digest> generateHash(
         gsl::span<const uint8_t> message);
   };
-}  // namespace fc::crypto::bls::impl
+}  // namespace fc::crypto::bls
 
 #endif
diff --git a/core/crypto/randomness/CMakeLists.txt b/core/crypto/randomness/CMakeLists.txt
@@ -2,7 +2,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 add_library(randomness_provider
-    impl/randomness_provider.cpp
+    impl/randomness_provider_imp.cpp
     )
 target_link_libraries(randomness_provider
     Boost::boost
diff --git a/core/crypto/randomness/impl/randomness_provider_imp.cpp b/core/crypto/randomness/impl/randomness_provider_imp.cpp
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "crypto/randomness/impl/randomness_provider.hpp"
+#include "crypto/randomness/impl/randomness_provider_imp.hpp"
 
 #include <libp2p/crypto/sha/sha256.hpp>
 #include "common/le_encoder.hpp"
@@ -12,23 +12,23 @@ namespace fc::crypto::randomness {
 
   Randomness RandomnessProviderImpl::deriveRandomness(DomainSeparationTag tag,
                                                       Serialization s) {
-    return deriveRandomness(tag, std::move(s), static_cast<size_t>(-1));
+    return deriveRandomness(tag, std::move(s), ChainEpoch(-1));
   }
 
   Randomness RandomnessProviderImpl::deriveRandomness(DomainSeparationTag tag,
                                                       Serialization s,
-                                                      ChainEpoch index) {
+                                                      const ChainEpoch &index) {
     return deriveRandomnessInternal(tag, std::move(s), index);
   }
 
   Randomness RandomnessProviderImpl::deriveRandomnessInternal(
-      DomainSeparationTag tag, Serialization s, ChainEpoch index) {
+      DomainSeparationTag tag, Serialization s, const ChainEpoch &index) {
     common::Buffer value{};
     const size_t bytes_required =
         sizeof(DomainSeparationTag) + sizeof(ChainEpoch) + s.size();
     value.reserve(bytes_required);
     common::encodeInteger(static_cast<size_t>(tag), value);
-    common::encodeInteger(static_cast<size_t>(index), value);
+    common::encodeInteger(static_cast<size_t>(index.toUInt64()), value);
     value.put(s);
     auto hash = libp2p::crypto::sha256(value);
 
diff --git a/core/crypto/randomness/impl/randomness_provider_imp.hpp b/core/crypto/randomness/impl/randomness_provider_imp.hpp
@@ -19,7 +19,7 @@ namespace fc::crypto::randomness {
 
     Randomness deriveRandomness(DomainSeparationTag tag,
                                 Serialization s,
-                                ChainEpoch index) override;
+                                const ChainEpoch &index) override;
 
     int randomInt(const Randomness &randomness,
                   size_t nonce,
@@ -28,7 +28,7 @@ namespace fc::crypto::randomness {
    private:
     Randomness deriveRandomnessInternal(DomainSeparationTag tag,
                                         Serialization s,
-                                        ChainEpoch index);
+                                        const ChainEpoch &index);
   };
 
 }  // namespace fc::crypto::randomness
diff --git a/core/crypto/randomness/randomness_provider.hpp b/core/crypto/randomness/randomness_provider.hpp
@@ -7,8 +7,12 @@
 #define CPP_FILECOIN_CORE_CRYPTO_RANDOMNESS_RANDOMNESS_PROVIDER_HPP
 
 #include "crypto/randomness/randomness_types.hpp"
+#include "primitives/chain_epoch.hpp"
 
 namespace fc::crypto::randomness {
+
+  using primitives::ChainEpoch;
+
   /**
    * @class RandomnessProvider provides 2 methods for drawing randomness value
    */
@@ -34,7 +38,7 @@ namespace fc::crypto::randomness {
      */
     virtual Randomness deriveRandomness(DomainSeparationTag tag,
                                         Serialization s,
-                                        ChainEpoch index) = 0;
+                                        const ChainEpoch &index) = 0;
 
     /**
      * @brief get random int value
diff --git a/core/crypto/randomness/randomness_types.hpp b/core/crypto/randomness/randomness_types.hpp
@@ -10,6 +10,7 @@
 #include "common/buffer.hpp"
 
 namespace fc::crypto::randomness {
+
   /// @brief randomness value type
   using Randomness = common::Hash256;
 
@@ -23,8 +24,6 @@ namespace fc::crypto::randomness {
     PoStDST = 3
   };
 
-  /// @brief epoch index type represents a round of a blockchain protocol
-  using ChainEpoch = size_t;
 }  // namespace fc::crypto::randomness
 
 #endif  // CPP_FILECOIN_CORE_CRYPTO_RANDOMNESS_RANDOMNESS_HPP
diff --git a/core/primitives/chain_epoch.hpp b/core/primitives/chain_epoch.hpp
@@ -0,0 +1,21 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_PRIMITIVES_CHAIN_EPOCH_HPP
+#define CPP_FILECOIN_PRIMITIVES_CHAIN_EPOCH_HPP
+
+#include "libp2p/multi/uvarint.hpp"
+
+namespace fc::primitives {
+
+  /**
+   * @brief epoch index type represents a round of a blockchain protocol, which
+   * acts as a proxy for time within the VM
+   */
+  using ChainEpoch = libp2p::multi::UVarint;
+
+}  // namespace fc::primitives
+
+#endif  // CPP_FILECOIN_PRIMITIVES_CHAIN_EPOCH_HPP
diff --git a/core/storage/repository/impl/filesystem_repository.cpp b/core/storage/repository/impl/filesystem_repository.cpp
@@ -15,7 +15,7 @@
 #include "storage/keystore/impl/filesystem/filesystem_keystore.hpp"
 #include "storage/repository/repository_error.hpp"
 
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::primitives::address::AddressVerifierImpl;
 using fc::storage::ipfs::LeveldbDatastore;
 using fc::storage::keystore::FileSystemKeyStore;
diff --git a/core/storage/repository/impl/in_memory_repository.cpp b/core/storage/repository/impl/in_memory_repository.cpp
@@ -11,7 +11,7 @@
 #include "storage/ipfs/impl/in_memory_datastore.hpp"
 #include "storage/keystore/impl/in_memory/in_memory_keystore.hpp"
 
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::primitives::address::AddressVerifierImpl;
 using fc::storage::ipfs::InMemoryDatastore;
 using fc::storage::keystore::InMemoryKeyStore;
diff --git a/core/vm/runtime/impl/runtime_impl.cpp b/core/vm/runtime/impl/runtime_impl.cpp
@@ -50,7 +50,7 @@ RuntimeImpl::RuntimeImpl(
       indices_{std::move(indices)},
       invoker_{std::move(invoker)},
       message_{std::move(message)},
-      chain_epoch_{chain_epoch},
+      chain_epoch_{std::move(chain_epoch)},
       immediate_caller_{std::move(immediate_caller)},
       block_miner_{std::move(block_miner)},
       gas_available_{std::move(gas_available)},
diff --git a/core/vm/runtime/runtime.hpp b/core/vm/runtime/runtime.hpp
@@ -11,6 +11,7 @@
 #include "common/outcome.hpp"
 #include "crypto/randomness/randomness_types.hpp"
 #include "primitives/address/address.hpp"
+#include "primitives/chain_epoch.hpp"
 #include "storage/ipfs/datastore.hpp"
 #include "vm/actor/actor.hpp"
 #include "vm/exit_code/exit_code.hpp"
@@ -25,12 +26,12 @@ namespace fc::vm::runtime {
   using actor::MethodNumber;
   using actor::MethodParams;
   using common::Buffer;
+  using crypto::randomness::DomainSeparationTag;
   using crypto::randomness::Randomness;
   using exit_code::ExitCode;
-  using fc::crypto::randomness::ChainEpoch;
-  using fc::crypto::randomness::DomainSeparationTag;
   using indices::Indices;
   using message::UnsignedMessage;
+  using primitives::ChainEpoch;
   using primitives::address::Address;
   using storage::ipfs::IpfsDatastore;
   using Serialization = Buffer;
diff --git a/test/core/crypto/bls_provider_test.cpp b/test/core/crypto/bls_provider_test.cpp
@@ -11,7 +11,7 @@
 #include <gtest/gtest.h>
 #include "testutil/outcome.hpp"
 
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::crypto::bls::KeyPair;
 using fc::crypto::bls::PrivateKey;
 using fc::crypto::bls::PublicKey;
diff --git a/test/core/crypto/randomness/randomness_provider_test.cpp b/test/core/crypto/randomness/randomness_provider_test.cpp
@@ -3,7 +3,7 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-#include "crypto/randomness/impl/randomness_provider.hpp"
+#include "crypto/randomness/impl/randomness_provider_imp.hpp"
 
 #include <gtest/gtest.h>
 
@@ -66,7 +66,7 @@ TEST_P(RandomnessProviderTest, DeriveRandomnessSuccess) {
 TEST_P(RandomnessProviderTest, TwoParamsMethodSuccess) {
   auto &&[tag, s, index, result] = GetParam();
   auto &&res1 = randomness_provider->deriveRandomness(tag, s);
-  auto &&res2 = randomness_provider->deriveRandomness(tag, s, -1);
+  auto &&res2 = randomness_provider->deriveRandomness(tag, s, ChainEpoch(-1));
   ASSERT_EQ(res1, res2);
 }
 
@@ -103,7 +103,7 @@ struct RandomnessProviderValuesTest : public RandomnessProviderBaseTest,
   Randomness generateRandomnessValue() {
     auto tag = static_cast<DomainSeparationTag>(getRandomByte() % 3 + 1);
     Serialization s{random_generator->randomBytes(buffer_size)};
-    ChainEpoch index = getRandomByte() % 100;
+    ChainEpoch index(getRandomByte() % 100);
 
     return randomness_provider->deriveRandomness(tag, s, index);
   }
diff --git a/test/core/crypto/vrf/vrf_provider_test.cpp b/test/core/crypto/vrf/vrf_provider_test.cpp
@@ -14,7 +14,7 @@
 using fc::common::Blob;
 using fc::common::Buffer;
 using fc::crypto::bls::BlsProvider;
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::crypto::randomness::DomainSeparationTag;
 using fc::crypto::vrf::VRFHash;
 using fc::crypto::vrf::VRFParams;
diff --git a/test/core/primitives/address/address_verifier_test.cpp b/test/core/primitives/address/address_verifier_test.cpp
@@ -17,7 +17,7 @@
 
 using fc::crypto::blake2b::blake2b_160;
 using fc::crypto::bls::BlsProvider;
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::primitives::address::Address;
 using fc::primitives::address::AddressBuilder;
 using fc::primitives::address::AddressBuilderImpl;
diff --git a/test/core/storage/keystore/filesystem_keystore_test.cpp b/test/core/storage/keystore/filesystem_keystore_test.cpp
@@ -16,7 +16,7 @@
 #include "testutil/storage/base_fs_test.hpp"
 
 using fc::crypto::bls::BlsProvider;
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::primitives::address::Address;
 using fc::primitives::address::AddressBuilderImpl;
 using fc::primitives::address::AddressVerifier;
diff --git a/test/core/storage/keystore/in_memory_keystore_test.cpp b/test/core/storage/keystore/in_memory_keystore_test.cpp
@@ -16,7 +16,7 @@
 #include "testutil/outcome.hpp"
 
 using fc::crypto::bls::BlsProvider;
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::primitives::address::Address;
 using fc::primitives::address::AddressBuilderImpl;
 using fc::primitives::address::AddressVerifier;
diff --git a/test/core/storage/repository/filesystem_repository_test.cpp b/test/core/storage/repository/filesystem_repository_test.cpp
@@ -15,7 +15,7 @@
 
 using fc::CID;
 using fc::common::Buffer;
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using fc::primitives::address::AddressBuilderImpl;
 using fc::storage::repository::FileSystemRepository;
 using fc::storage::repository::Repository;
diff --git a/test/core/vm/message/message_test.cpp b/test/core/vm/message/message_test.cpp
@@ -19,7 +19,7 @@
 #include "vm/message/message_util.hpp"
 
 using fc::crypto::bls::BlsProvider;
-using fc::crypto::bls::impl::BlsProviderImpl;
+using fc::crypto::bls::BlsProviderImpl;
 using BlsPrivateKey = fc::crypto::bls::PrivateKey;
 using BlsPublicKey = fc::crypto::bls::PublicKey;
 using fc::crypto::secp256k1::Secp256k1Provider;
diff --git a/test/testutil/mocks/crypto/randomness/randomness_provider_mock.hpp b/test/testutil/mocks/crypto/randomness/randomness_provider_mock.hpp
@@ -18,7 +18,7 @@ namespace fc::crypto::randomness {
     MOCK_METHOD3(deriveRandomness,
                  Randomness(DomainSeparationTag tag,
                             Serialization s,
-                            ChainEpoch index));
+                            const ChainEpoch &index));
     MOCK_METHOD3(randomInt,
                  int(const Randomness &randomness, size_t nonce, size_t limit));
   };

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`	`# SPDX-License-Identifier: Apache-2.0`
`3`	`3`
`4`	`4`	`add_library(randomness_provider`
`5`		`- impl/randomness_provider.cpp`
	`5`	`+ impl/randomness_provider_imp.cpp`
`6`	`6`	`)`
`7`	`7`	`target_link_libraries(randomness_provider`
`8`	`8`	`Boost::boost`