Feature/storage power actor 2 (#112)

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

Author: Alexey-N-Chernyshov

core/adt/balance_table_hamt.hpp

@@ -76,11 +76,11 @@ namespace fc::adt {
                                                      const TokenAmount &floor);
 
     /**
-     * Removes from table
+     * Removes from table and returnes previous balance
      * @param key addrss
-     * @return error in case of failure
+     * @return previous balance or error in case of failure
      */
-    outcome::result<void> remove(const Address &key);
+    outcome::result<TokenAmount> remove(const Address &key);
 
     /**
      * HAMT CID of root

core/adt/impl/balance_table_hamt.cpp

@@ -51,9 +51,10 @@ fc::outcome::result<TokenAmount> BalanceTableHamt::subtractWithMinimum(
   return sub;
 }
 
-fc::outcome::result<void> BalanceTableHamt::remove(const Address &key) {
+fc::outcome::result<TokenAmount> BalanceTableHamt::remove(const Address &key) {
+  OUTCOME_TRY(old_balance, hamt_.getCbor<TokenAmount>(encodeToByteString(key)));
   OUTCOME_TRY(hamt_.remove(encodeToByteString(key)));
   OUTCOME_TRY(new_root, hamt_.flush());
   root = new_root;
-  return fc::outcome::success();
+  return std::move(old_balance);
 }

core/power/impl/power_table_impl.cpp

@@ -56,7 +56,7 @@ namespace fc::power {
   PowerTableImpl::getMiners() const {
     std::vector<primitives::address::Address> result;
     result.reserve(power_table_.size());
-    for (auto &elem : power_table_) {
+    for (const auto &elem : power_table_) {
       OUTCOME_TRY(miner_addr,
                   primitives::address::decodeFromString(elem.first));
       result.push_back(miner_addr);

core/primitives/types.hpp

@@ -31,6 +31,8 @@ namespace fc::primitives {
     DealWeight deal_weight;
   };
 
+  using StoragePower = primitives::BigInt;
+
   CBOR_TUPLE(SectorStorageWeightDesc, sector_size, duration, deal_weight)
 }  // namespace fc::primitives
 

core/vm/actor/actor.hpp

@@ -110,6 +110,12 @@ namespace fc::vm::actor {
   /** Check if actor code can represent external signing parties */
   bool isSignableActor(const CodeId &code);
 
+  /** Reserved method number for send operation */
+  constexpr MethodNumber kSendMethodNumber{0};
+
+  /** Reserved method number for constructor */
+  constexpr MethodNumber kConstructorMethodNumber{1};
+
   extern const CID kEmptyObjectCid;
 
   extern const CodeId kAccountCodeCid, kCronCodeCid, kStoragePowerCodeCid,

core/vm/actor/actor_method.hpp

@@ -17,6 +17,8 @@
       const Actor &actor, Runtime &runtime, const MethodParams &params)
 
 namespace fc::vm::actor {
+
+  using common::Buffer;
   using runtime::InvocationOutput;
   using runtime::Runtime;
 
@@ -33,12 +35,6 @@ namespace fc::vm::actor {
   /// Actor methods exported by number
   using ActorExports = std::map<MethodNumber, ActorMethod>;
 
-  /// Reserved method number for send operation
-  constexpr MethodNumber kSendMethodNumber{0};
-
-  /// Reserved method number for constructor
-  constexpr MethodNumber kConstructorMethodNumber{1};
-
   /// Decode actor params, raises appropriate error
   template <typename T>
   outcome::result<T> decodeActorParams(MethodParams params_bytes) {
@@ -50,6 +46,20 @@ namespace fc::vm::actor {
   }
 
   using runtime::encodeActorParams;
+
+  template <typename T>
+  outcome::result<T> decodeActorReturn(const InvocationOutput &result) {
+    OUTCOME_TRY(decoded,
+                codec::cbor::decode<T>(result.return_value.toVector()));
+    return std::move(decoded);
+  }
+
+  template <typename T>
+  outcome::result<InvocationOutput> encodeActorReturn(const T &result) {
+    OUTCOME_TRY(encoded, codec::cbor::encode(result));
+    return InvocationOutput{Buffer{encoded}};
+  }
+
 }  // namespace fc::vm::actor
 
 #endif  // CPP_FILECOIN_CORE_VM_ACTOR_ACTOR_METHOD_HPP

core/vm/actor/builtin/init/init_actor.cpp

@@ -45,8 +45,10 @@ namespace fc::vm::actor::builtin::init {
                              kConstructorMethodNumber,
                              exec_params.params,
                              message.value));
+    ExecReturn exec_return{id_address, actor_address};
+    OUTCOME_TRY(output, encodeActorReturn(exec_return));
     OUTCOME_TRY(runtime.commitState(init_actor));
-    return InvocationOutput{Buffer{primitives::address::encode(id_address)}};
+    return std::move(output);
   }
 
   const ActorExports exports{{kExecMethodNumber, ActorMethod(exec)}};

core/vm/actor/builtin/init/init_actor.hpp

@@ -33,11 +33,20 @@ namespace fc::vm::actor::builtin::init {
     MethodParams params;
   };
 
+  struct ExecReturn {
+    Address id_address;      // The canonical ID-based address for the actor
+    Address robust_address;  // A more expensive but re-org-safe address for the
+                             // newly created actor
+  };
+
   ACTOR_METHOD(exec);
 
   extern const ActorExports exports;
 
   CBOR_TUPLE(ExecParams, code, params)
+
+  CBOR_TUPLE(ExecReturn, id_address, robust_address)
+
 }  // namespace fc::vm::actor::builtin::init
 
 #endif  // CPP_FILECOIN_CORE_VM_ACTOR_INIT_ACTOR_HPP

core/vm/actor/builtin/miner/miner_actor.hpp

@@ -13,6 +13,7 @@
 #include "vm/actor/builtin/miner/types.hpp"
 
 namespace fc::vm::actor::builtin::miner {
+
   constexpr MethodNumber kGetControlAddressesMethodNumber{2};
   constexpr MethodNumber kChangeWorkerAddressMethodNumber{3};
   constexpr MethodNumber kChangePeerIdMethodNumber{4};
@@ -52,6 +53,7 @@ namespace fc::vm::actor::builtin::miner {
   ACTOR_METHOD(onDeferredCronEvent);
 
   extern const ActorExports exports;
+
 }  // namespace fc::vm::actor::builtin::miner
 
 #endif  // CPP_FILECOIN_CORE_VM_ACTOR_BUILTIN_MINER_MINER_ACTOR_HPP

core/vm/actor/builtin/reward/reward_actor.hpp

@@ -60,7 +60,15 @@ namespace fc::vm::actor::builtin::reward {
 
   // Actor related stuff
 
+  /**
+   * The network works purely in the indivisible token amounts. This constant
+   * converts to a fixed decimal with more human-friendly scale.
+   */
   static const BigInt kTokenPrecision{1e18};
+
+  /**
+   * Target reward released to each block winner
+   */
   static const BigInt kBlockRewardTarget{1e20};
 
   static constexpr auto kRewardVestingFunction{VestingFunction::NONE};