use enum instead of bool for flushing the vm

Author: akaladarshi

src/rpc/methods/eth.rs

@@ -54,7 +54,7 @@ use crate::shim::gas::GasOutputs;
 use crate::shim::message::Message;
 use crate::shim::trace::{CallReturn, ExecutionEvent};
 use crate::shim::{clock::ChainEpoch, state_tree::StateTree};
-use crate::state_manager::StateLookupPolicy;
+use crate::state_manager::{StateLookupPolicy, VMFlush};
 use crate::utils::cache::SizeTrackingLruCache;
 use crate::utils::db::BlockstoreExt as _;
 use crate::utils::encoding::from_slice_with_fallback;
@@ -2159,7 +2159,7 @@ where
 {
     let (invoc_res, _) = ctx
         .state_manager
-        .apply_on_state_with_gas(tipset, msg, StateLookupPolicy::Enabled, false)
+        .apply_on_state_with_gas(tipset, msg, StateLookupPolicy::Enabled, VMFlush::Skip)
         .await
         .map_err(|e| anyhow::anyhow!("failed to apply on state with gas: {e}"))?;
 
@@ -2256,7 +2256,7 @@ where
                 Some(ts),
                 VMTrace::NotTraced,
                 StateLookupPolicy::Enabled,
-                false,
+                VMFlush::Skip,
             )
             .await?;
         Ok(apply_ret.msg_receipt().exit_code().is_success())
@@ -4027,7 +4027,7 @@ impl RpcMethod<3> for EthTraceCall {
                 Some(ts.clone()),
                 msg.clone(),
                 StateLookupPolicy::Enabled,
-                true,
+                VMFlush::Flush,
             )
             .await
             .map_err(|e| anyhow::anyhow!("failed to apply message: {e}"))?;

src/rpc/methods/gas.rs

@@ -15,7 +15,7 @@ use crate::shim::{
     econ::{BLOCK_GAS_LIMIT, TokenAmount},
     message::Message,
 };
-use crate::state_manager::StateLookupPolicy;
+use crate::state_manager::{StateLookupPolicy, VMFlush};
 use anyhow::{Context, Result};
 use enumflags2::BitFlags;
 use fvm_ipld_blockstore::Blockstore;
@@ -263,7 +263,7 @@ impl GasEstimateGasLimit {
                 Some(ts.clone()),
                 trace_config,
                 StateLookupPolicy::Enabled,
-                false,
+                VMFlush::Skip,
             )
             .await?;
         Ok((invoc_res, apply_ret, prior_messages, ts))

src/state_manager/mod.rs

@@ -683,7 +683,7 @@ where
         tipset: Option<Tipset>,
         msg: Message,
         state_lookup: StateLookupPolicy,
-        flush: bool,
+        vm_flush: VMFlush,
     ) -> anyhow::Result<(ApiInvocResult, Option<Cid>)> {
         let ts = tipset.unwrap_or_else(|| self.heaviest_tipset());
 
@@ -713,7 +713,7 @@ where
                 Some(ts),
                 VMTrace::Traced,
                 state_lookup,
-                flush,
+                vm_flush,
             )
             .await?;
 
@@ -741,7 +741,7 @@ where
         tipset: Option<Tipset>,
         trace_config: VMTrace,
         state_lookup: StateLookupPolicy,
-        flush: bool,
+        vm_flush: VMFlush,
     ) -> Result<(InvocResult, ApplyRet, Duration, Option<Cid>), Error> {
         let ts = tipset.unwrap_or_else(|| self.heaviest_tipset());
         let (st, _) = self
@@ -787,7 +787,10 @@ where
 
             message.set_sequence(from_actor.sequence);
             let (ret, duration) = vm.apply_message(message)?;
-            let state_root = if flush { Some(vm.flush()?) } else { None };
+            let state_root = match vm_flush {
+                VMFlush::Flush => Some(vm.flush()?),
+                VMFlush::Skip => None,
+            };
             Ok((ret, duration, state_root))
         })?;
 
@@ -2109,3 +2112,11 @@ pub enum StateLookupPolicy {
     Enabled,
     Disabled,
 }
+
+/// Controls whether the VM should flush its state after execution
+#[derive(Debug, Copy, Clone, Default)]
+pub enum VMFlush {
+    Flush,
+    #[default]
+    Skip,
+}