[FIL-78] CronActor (#57)

* Cron Actor implementation

Signed-off-by: artyom-yurin <[email protected]>

Author: ortyomka

core/vm/actor/CMakeLists.txt

@@ -6,6 +6,8 @@
 add_library(actor
     actor.cpp
     init_actor.cpp
+    cron_actor.cpp
+    cron_actor_error.cpp
     )
 target_link_libraries(actor
     address

core/vm/actor/actor.hpp

@@ -55,6 +55,8 @@ namespace fc::vm::actor {
       kInitCodeCid, kPaymentChannelCodeCid;
 
   inline static const auto kInitAddress = Address::makeFromId(0);
+  inline static const auto kStoragePowerAddress = Address::makeFromId(2);
+  inline static const auto kCronAddress = Address::makeFromId(4);
 }  // namespace fc::vm::actor
 
 #endif  // CPP_FILECOIN_CORE_VM_ACTOR_ACTOR_HPP

core/vm/actor/cron_actor.cpp

@@ -0,0 +1,24 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "vm/actor/cron_actor.hpp"
+#include "vm/actor/cron_actor_error.hpp"
+
+std::vector<fc::vm::actor::CronTableEntry> fc::vm::actor::CronActor::entries = {
+    {kStoragePowerAddress, SpaMethods::CHECK_PROOF_SUBMISSIONS}};
+
+fc::outcome::result<void> fc::vm::actor::CronActor::EpochTick(
+    fc::vm::actor::Actor &actor,
+    fc::vm::VMContext &vmctx,
+    const std::vector<uint8_t> &params) {
+  if (!(vmctx.message().from == kCronAddress)) {
+    return CronActorError::WRONG_CALL;
+  }
+
+  for (const auto &entry : entries) {
+    OUTCOME_TRY(vmctx.send(entry.to_addr, entry.method_num, BigInt(0), {}));
+  }
+  return outcome::success();
+}

core/vm/actor/cron_actor.hpp

@@ -0,0 +1,41 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_CORE_VM_ACTOR_CRON_ACTOR_HPP
+#define CPP_FILECOIN_CORE_VM_ACTOR_CRON_ACTOR_HPP
+
+#include "vm/actor/actor.hpp"
+#include "vm/actor/storage_power_actor.hpp"
+#include "vm/vm_context.hpp"
+
+namespace fc::vm::actor {
+
+  struct CronTableEntry {
+    Address to_addr;
+    uint64_t method_num;
+  };
+
+  struct CronActor {
+    /**
+     * Entries is a set of actors (and corresponding methods) to call during
+     * EpochTick
+     */
+    static std::vector<CronTableEntry> entries;
+
+    /**
+     * @brief EpochTick executes built-in periodic actions, run at every Epoch.
+     * @param actor from Lotus(doesn't use)
+     * @param vmctx is virtual machine context
+     * @param params from Lotus(doesn't use)
+     * @return success or error
+     */
+    static outcome::result<void> EpochTick(Actor &actor,
+                                           vm::VMContext &vmctx,
+                                           const std::vector<uint8_t> &params);
+  };
+
+}  // namespace fc::vm::actor
+
+#endif  // CPP_FILECOIN_CORE_VM_ACTOR_CRON_ACTOR_HPP

core/vm/actor/cron_actor_error.cpp

@@ -0,0 +1,18 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include "vm/actor/cron_actor_error.hpp"
+
+OUTCOME_CPP_DEFINE_CATEGORY(fc::vm::actor, CronActorError, e) {
+  using fc::vm::actor::CronActorError;
+
+  switch (e) {
+    case (CronActorError::WRONG_CALL):
+      return "CronActor: EpochTick is only callable as a part of tipset state "
+             "computation";
+    case (CronActorError::UNKNOWN):
+      return "CronActor: unknown error";
+  }
+}

core/vm/actor/cron_actor_error.hpp

@@ -0,0 +1,26 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_CORE_VM_ACTOR_CRON_ACTOR_ERROR_HPP
+#define CPP_FILECOIN_CORE_VM_ACTOR_CRON_ACTOR_ERROR_HPP
+
+#include "common/outcome.hpp"
+
+namespace fc::vm::actor {
+
+  /**
+   * @brief CronActor returns these types of errors
+   */
+  enum class CronActorError {
+    WRONG_CALL = 1,
+
+    UNKNOWN = 1000
+  };
+
+}  // namespace fc::vm::actor
+
+OUTCOME_HPP_DECLARE_ERROR(fc::vm::actor, CronActorError);
+
+#endif  // CPP_FILECOIN_CORE_VM_ACTOR_CRON_ACTOR_ERROR_HPP

core/vm/actor/storage_power_actor.hpp

@@ -0,0 +1,25 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_CORE_VM_ACTOR_STORAGE_POWER_ACTOR_HPP
+#define CPP_FILECOIN_CORE_VM_ACTOR_STORAGE_POWER_ACTOR_HPP
+
+namespace fc::vm::actor {
+
+  enum SpaMethods {
+    CONSTRUCTOR = 1,
+    CREATE_STORAGE_MINER,
+    ARBITRATE_CONSENSUS_FAULT,
+    UPDATE_STORAGE,
+    GET_TOTAL_STORAGE,
+    POWER_LOOKUP,
+    IS_VALID_MINER,
+    PLEDGE_COLLATERAL_FOR_SIZE,
+    CHECK_PROOF_SUBMISSIONS
+  };
+
+}  // namespace fc::vm::actor
+
+#endif  // CPP_FILECOIN_CORE_VM_ACTOR_STORAGE_POWER_ACTOR_HPP

core/vm/vm_context.hpp

@@ -0,0 +1,31 @@
+/**
+ * Copyright Soramitsu Co., Ltd. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#ifndef CPP_FILECOIN_CORE_VM_CONTEXT_HPP
+#define CPP_FILECOIN_CORE_VM_CONTEXT_HPP
+
+namespace fc::vm {
+
+  /**
+   * TODO(artyom-yurin): it is temp structure, will be removed after "runtime"
+   * would be implemented
+   */
+  struct Message {
+    primitives::address::Address from;
+  };
+
+  class VMContext {
+   public:
+    virtual ~VMContext() = default;
+
+    virtual outcome::result<void> send(primitives::address::Address to,
+                                       uint64_t method,
+                                       actor::BigInt value,
+                                       std::vector<uint8_t> params) = 0;
+    virtual Message message() = 0;
+  };
+}  // namespace fc::vm
+
+#endif  // CPP_FILECOIN_CORE_VM_CONTEXT_HPP

test/core/vm/CMakeLists.txt

@@ -3,6 +3,10 @@
 # SPDX-License-Identifier: Apache-2.0
 #
 
+include_directories(${CMAKE_CURRENT_SOURCE_DIR}
+        ${PROJECT_SOURCE_DIR}/core
+        )
+
 add_subdirectory(actor)
 add_subdirectory(exit_code)
 add_subdirectory(state)

test/core/vm/actor/CMakeLists.txt

@@ -19,3 +19,11 @@ target_link_libraries(init_actor_test
     hexutil
     ipfs_datastore_in_memory
     )
+
+addtest(cron_actor_test
+        cron_actor_test.cpp
+        )
+target_link_libraries(cron_actor_test
+        actor
+        hexutil
+        )