add Runtime::commitState<T> (#107)

Signed-off-by: Alexey-N-Chernyshov <alexey.n.chernyshov@gmail.com>

Author: Alexey-N-Chernyshov

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

@@ -48,8 +48,7 @@ namespace fc::vm::actor::builtin::init {
                              kConstructorMethodNumber,
                              exec_params.params,
                              message.value));
-    OUTCOME_TRY(new_state, store->setCbor(init_actor));
-    OUTCOME_TRY(runtime.commit(ActorSubstateCID{new_state}));
+    OUTCOME_TRY(runtime.commitState(init_actor));
     return InvocationOutput{Buffer{primitives::address::encode(id_address)}};
   }
 

core/vm/actor/builtin/multisig/multisig_actor.cpp

@@ -158,10 +158,7 @@ fc::outcome::result<InvocationOutput> MultiSigActor::construct(
     state.initial_balance = runtime.getValueReceived();
   }
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 
@@ -189,11 +186,9 @@ fc::outcome::result<InvocationOutput> MultiSigActor::propose(
   // approve pending tx
   OUTCOME_TRY(state.approveTransaction(actor, runtime, tx_number));
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
   OUTCOME_TRY(encoded_result, codec::cbor::encode(tx_number));
+
+  OUTCOME_TRY(runtime.commitState(state));
   return InvocationOutput{Buffer{encoded_result}};
 }
 
@@ -211,10 +206,7 @@ fc::outcome::result<InvocationOutput> MultiSigActor::approve(
   OUTCOME_TRY(
       state.approveTransaction(actor, runtime, tx_params.transaction_number));
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 
@@ -239,10 +231,7 @@ fc::outcome::result<InvocationOutput> MultiSigActor::cancel(
     return VMExitCode::MULTISIG_ACTOR_FORBIDDEN;
   }
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 
@@ -264,10 +253,7 @@ fc::outcome::result<InvocationOutput> MultiSigActor::addSigner(
   state.signers.push_back(add_signer_params.signer);
   if (add_signer_params.increase_threshold) state.threshold++;
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 
@@ -296,10 +282,7 @@ fc::outcome::result<InvocationOutput> MultiSigActor::removeSigner(
   if (state.threshold < 1 || state.signers.size() < state.threshold)
     return VMExitCode::MULTISIG_ACTOR_ILLEGAL_ARGUMENT;
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 
@@ -324,10 +307,7 @@ fc::outcome::result<InvocationOutput> MultiSigActor::swapSigner(
     return VMExitCode::MULTISIG_ACTOR_NOT_FOUND;
   *old_signer = swap_signer_params.new_signer;
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 
@@ -349,10 +329,7 @@ fc::outcome::result<InvocationOutput> MultiSigActor::changeThreshold(
 
   state.threshold = change_threshold_params.new_threshold;
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 

core/vm/actor/builtin/payment_channel/payment_channel_actor.cpp

@@ -33,10 +33,7 @@ fc::outcome::result<InvocationOutput> PaymentChannelActor::construct(
   PaymentChannelActorState state{
       runtime.getImmediateCaller(), construct_params.to, 0, 0, 0, {}};
 
-  // commit state
-  OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(state));
-  OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
-
+  OUTCOME_TRY(runtime.commitState(state));
   return fc::outcome::success();
 }
 

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

@@ -107,8 +107,7 @@ namespace fc::vm::actor::builtin::reward {
     OUTCOME_TRY(empty_mmap_cid, empty_mmap.flush());
     State empty_state{.reward_total = 0, .reward_map = empty_mmap_cid};
 
-    OUTCOME_TRY(state_cid, runtime.getIpfsDatastore()->setCbor(empty_state));
-    OUTCOME_TRY(runtime.commit(ActorSubstateCID{state_cid}));
+    OUTCOME_TRY(runtime.commitState(empty_state));
     return outcome::success();
   }
 
@@ -143,11 +142,10 @@ namespace fc::vm::actor::builtin::reward {
                         .amount_withdrawn = 0};
       OUTCOME_TRY(state.addReward(
           runtime.getIpfsDatastore(), reward_params.miner, new_reward));
-      OUTCOME_TRY(new_state_cid, runtime.getIpfsDatastore()->setCbor(state));
-      OUTCOME_TRY(runtime.commit(ActorSubstateCID{new_state_cid}));
     }
     OUTCOME_TRY(runtime.send(
         kBurntFundsActorAddress, kSendMethodNumber, MethodParams{}, penalty));
+    OUTCOME_TRY(runtime.commitState(state));
     return outcome::success();
   }
 
@@ -163,11 +161,9 @@ namespace fc::vm::actor::builtin::reward {
     OUTCOME_TRY(state, store->getCbor<State>(state_cid));
     OUTCOME_TRY(withdrawn,
                 state.withdrawReward(store, owner, runtime.getCurrentEpoch()));
-    OUTCOME_TRY(new_state_cid, runtime.getIpfsDatastore()->setCbor(state));
-    OUTCOME_TRY(runtime.commit(ActorSubstateCID{new_state_cid}));
     OUTCOME_TRY(
         runtime.send(owner, kSendMethodNumber, MethodParams{}, withdrawn));
-
+    OUTCOME_TRY(runtime.commitState(state));
     return outcome::success();
   }
 

core/vm/runtime/runtime.hpp

@@ -138,8 +138,21 @@ namespace fc::vm::runtime {
     /// Get current actor state
     virtual ActorSubstateCID getCurrentActorState() = 0;
 
-    /// Update actor state
+    /// Update actor state CID
     virtual outcome::result<void> commit(const ActorSubstateCID &new_state) = 0;
+
+    /**
+     * Commit actor state
+     * @tparam T - POD state type
+     * @param state - actor state structure
+     * @return error in case of failure
+     */
+    template <typename T>
+    outcome::result<void> commitState(const T &state) {
+      OUTCOME_TRY(state_cid, getIpfsDatastore()->setCbor(state));
+      OUTCOME_TRY(commit(ActorSubstateCID{state_cid}));
+      return outcome::success();
+    }
   };
 
 }  // namespace fc::vm::runtime

test/core/vm/actor/builtin/init/init_actor_test.cpp

@@ -112,7 +112,8 @@ TEST(InitActorExecText, ExecSuccess) {
       .WillOnce(testing::Return(std::cref(message)));
 
   EXPECT_CALL(runtime, getIpfsDatastore())
-      .WillOnce(testing::Return(state_tree->getStore()));
+      .Times(2)
+      .WillRepeatedly(testing::Return(state_tree->getStore()));
 
   EXPECT_CALL(runtime,
               send(id_address,