Feature/message storage (#75)

Signed-off-by: Alexey-N-Chernyshov <[email protected]>

Author: Alexey-N-Chernyshov

core/CMakeLists.txt

@@ -3,6 +3,7 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+add_subdirectory(blockchain)
 add_subdirectory(clock)
 add_subdirectory(codec)
 add_subdirectory(common)

core/blockchain/CMakeLists.txt

@@ -0,0 +1,6 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_subdirectory(message_pool)

core/blockchain/message_pool/CMakeLists.txt

@@ -0,0 +1,12 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_library(message_pool
+    impl/gas_price_scored_message_storage.cpp
+    impl/message_pool_error.cpp)
+target_link_libraries(message_pool
+    outcome
+    message
+    )

core/blockchain/message_pool/impl/gas_price_scored_message_storage.cpp

@@ -0,0 +1,32 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "blockchain/message_pool/impl/gas_price_scored_message_storage.hpp"
+
+#include "blockchain/message_pool/message_pool_error.hpp"
+
+using fc::blockchain::message_pool::GasPriceScoredMessageStorage;
+using fc::blockchain::message_pool::MessagePoolError;
+using fc::vm::message::SignedMessage;
+
+fc::outcome::result<void> GasPriceScoredMessageStorage::put(
+    const SignedMessage &message) {
+  auto res = messages_.insert(message);
+  if (!res.second) return MessagePoolError::MESSAGE_ALREADY_IN_POOL;
+  return fc::outcome::success();
+}
+
+void GasPriceScoredMessageStorage::remove(const SignedMessage &message) {
+  messages_.erase(message);
+}
+
+std::vector<SignedMessage> GasPriceScoredMessageStorage::getTopScored(
+    size_t n) const {
+  std::set<SignedMessage, decltype(compareGasFunctor)> score(
+      messages_.begin(), messages_.end(), compareGasFunctor);
+  return std::vector<SignedMessage>(
+      score.begin(),
+      (n < score.size()) ? std::next(score.begin(), n) : score.end());
+}

core/blockchain/message_pool/impl/gas_price_scored_message_storage.hpp

@@ -0,0 +1,59 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_BLOCKCHAIN_MESSAGE_POOL_GAS_PRICE_SCORED_MESSAGE_STORAGE_HPP
+#define CPP_FILECOIN_BLOCKCHAIN_MESSAGE_POOL_GAS_PRICE_SCORED_MESSAGE_STORAGE_HPP
+
+#include "blockchain/message_pool/message_storage.hpp"
+
+namespace fc::blockchain::message_pool {
+
+  using primitives::address::Address;
+  using vm::message::SignedMessage;
+
+  /**
+   * Compare messages by sender address and nonce
+   */
+  auto compareMessagesFunctor = [](const SignedMessage &lhs,
+                                   const SignedMessage &rhs) {
+    return (lhs.message.from < rhs.message.from)
+           || ((lhs.message.from == rhs.message.from)
+               && (lhs.message.nonce < rhs.message.nonce));
+  };
+
+  /**
+   * Comparator based on gas price for scoring
+   */
+  auto compareGasFunctor = [](const SignedMessage &lhs,
+                              const SignedMessage &rhs) {
+    return (lhs.message.gasPrice > rhs.message.gasPrice)
+           || ((lhs.message.gasPrice == rhs.message.gasPrice)
+               && (compareMessagesFunctor(lhs, rhs)));
+  };
+
+  /**
+   * Caches pending messages and order by gas price.
+   */
+  class GasPriceScoredMessageStorage : public MessageStorage {
+   public:
+    ~GasPriceScoredMessageStorage() override = default;
+
+    /** \copydoc MessageStorage::put() */
+    outcome::result<void> put(const SignedMessage &message) override;
+
+    /** \copydoc MessageStorage::remove() */
+    void remove(const SignedMessage &message) override;
+
+    /** \copydoc MessageStorage::getTopScored() */
+    std::vector<SignedMessage> getTopScored(size_t n) const override;
+
+   private:
+    std::set<SignedMessage, decltype(compareMessagesFunctor)> messages_{
+        compareMessagesFunctor};
+  };
+
+}  // namespace fc::blockchain::message_pool
+
+#endif  // CPP_FILECOIN_BLOCKCHAIN_MESSAGE_POOL_GAS_PRICE_SCORED_MESSAGE_STORAGE_HPP

core/blockchain/message_pool/impl/message_pool_error.cpp

@@ -0,0 +1,17 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "blockchain/message_pool/message_pool_error.hpp"
+
+OUTCOME_CPP_DEFINE_CATEGORY(fc::blockchain::message_pool, MessagePoolError, e) {
+  using fc::blockchain::message_pool::MessagePoolError;
+
+  switch (e) {
+    case MessagePoolError::MESSAGE_ALREADY_IN_POOL:
+      return "MessagePoolError: message is already in pool";
+  }
+
+  return "unknown error";
+}

core/blockchain/message_pool/message_pool_error.hpp

@@ -0,0 +1,24 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef FILECOIN_CORE_BLOCKCHAIN_MESSAGE_POOL_ERROR
+#define FILECOIN_CORE_BLOCKCHAIN_MESSAGE_POOL_ERROR
+
+#include "common/outcome.hpp"
+
+namespace fc::blockchain::message_pool {
+
+  /**
+   * @brief Type of errors returned by MessagePool
+   */
+  enum class MessagePoolError {
+    MESSAGE_ALREADY_IN_POOL = 1,
+  };
+
+}  // namespace fc::blockchain::message_pool
+
+OUTCOME_HPP_DECLARE_ERROR(fc::blockchain::message_pool, MessagePoolError);
+
+#endif  // FILECOIN_CORE_BLOCKCHAIN_MESSAGE_POOL_ERROR

core/blockchain/message_pool/message_storage.hpp

@@ -0,0 +1,49 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_BLOCKCHAIN_MESSAGE_POOL_MESSAGE_STORAGE_HPP
+#define CPP_FILECOIN_BLOCKCHAIN_MESSAGE_POOL_MESSAGE_STORAGE_HPP
+
+#include "common/outcome.hpp"
+#include "primitives/address/address.hpp"
+#include "vm/message/message.hpp"
+
+namespace fc::blockchain::message_pool {
+
+  using primitives::address::Address;
+  using vm::message::SignedMessage;
+
+  /**
+   * Caches pending messages.
+   */
+  class MessageStorage {
+   public:
+    virtual ~MessageStorage() = default;
+
+    /**
+     * Add message
+     * @param message - message to add
+     * @return error code in case of error, or nothing otherwise
+     */
+    virtual outcome::result<void> put(const SignedMessage &message) = 0;
+
+    /**
+     * Remove message
+     * @param message - message to remove
+     * @return error code in case of error, or nothing otherwise
+     */
+    virtual void remove(const SignedMessage &message) = 0;
+
+    /**
+     * Get N top scored messages
+     * @param n - how many messages return
+     * @return no more than N top scored messages present in cache
+     */
+    virtual std::vector<SignedMessage> getTopScored(size_t n) const = 0;
+  };
+
+}  // namespace fc::blockchain::message_pool
+
+#endif  // CPP_FILECOIN_BLOCKCHAIN_MESSAGE_POOL_MESSAGE_STORAGE_HPP

test/core/CMakeLists.txt

@@ -3,12 +3,13 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+add_subdirectory(blockchain)
 add_subdirectory(clock)
+add_subdirectory(codec)
 add_subdirectory(common)
 add_subdirectory(crypto)
 add_subdirectory(fslock)
 add_subdirectory(power)
 add_subdirectory(primitives)
 add_subdirectory(storage)
-add_subdirectory(codec)
 add_subdirectory(vm)

test/core/blockchain/CMakeLists.txt

@@ -0,0 +1,6 @@
+#
+# Copyright Soramitsu Co., Ltd. All Rights Reserved.
+# SPDX-License-Identifier: Apache-2.0
+#
+
+add_subdirectory(message_pool)