configure EVM on each runtime borrow

Author: turbolent

fvm/environment/runtime.go

@@ -8,6 +8,10 @@ import (
 
 type RuntimeParams struct {
 	runtime.ReusableCadenceRuntimePool
+	ConfigureCadenceRuntime func(
+		reusableCadenceRuntime *runtime.ReusableCadenceRuntime,
+		env Environment,
+	)
 }
 
 func DefaultRuntimeParams() RuntimeParams {
@@ -37,7 +41,16 @@ func (runtime *Runtime) SetEnvironment(env Environment) {
 }
 
 func (runtime *Runtime) BorrowCadenceRuntime() *runtime.ReusableCadenceRuntime {
-	return runtime.ReusableCadenceRuntimePool.Borrow(runtime.env)
+	env := runtime.env
+
+	reusableCadenceRuntime := runtime.ReusableCadenceRuntimePool.Borrow(env)
+
+	configure := runtime.ConfigureCadenceRuntime
+	if configure != nil {
+		configure(reusableCadenceRuntime, env)
+	}
+
+	return reusableCadenceRuntime
 }
 
 func (runtime *Runtime) ReturnCadenceRuntime(

fvm/evm/evm.go

@@ -26,7 +26,7 @@ func SetupEnvironment(
 	chainID flow.ChainID,
 	fvmEnv environment.Environment,
 	runtimeEnv runtime.Environment,
-) error {
+) {
 	sc := systemcontracts.SystemContractsForChain(chainID)
 	randomBeaconAddress := sc.RandomBeaconHistory.Address
 	flowTokenAddress := sc.FlowToken.Address
@@ -66,6 +66,4 @@ func SetupEnvironment(
 		internalEVMFunctions,
 		evmContractAddress,
 	)
-
-	return nil
 }

fvm/script.go

@@ -6,11 +6,12 @@ import (
 
 	"github.com/hashicorp/go-multierror"
 	"github.com/onflow/cadence/common"
-	"github.com/onflow/cadence/runtime"
+	cadenceRuntime "github.com/onflow/cadence/runtime"
 
 	"github.com/onflow/flow-go/fvm/environment"
 	"github.com/onflow/flow-go/fvm/errors"
 	"github.com/onflow/flow-go/fvm/evm"
+	"github.com/onflow/flow-go/fvm/runtime"
 	"github.com/onflow/flow-go/fvm/storage"
 	"github.com/onflow/flow-go/fvm/storage/logical"
 	"github.com/onflow/flow-go/model/flow"
@@ -126,15 +127,55 @@ func newScriptExecutor(
 	// creating the executor
 	scriptInfo := environment.NewScriptInfoParams(proc.Script, proc.Arguments)
 	ctx.EnvironmentParams.SetScriptInfoParams(scriptInfo)
+
+	env := environment.NewScriptEnv(
+		proc.RequestContext,
+		ctx.TracerSpan,
+		ctx.EnvironmentParams,
+		txnState,
+	)
+
+	if ctx.EVMEnabled {
+		chainID := ctx.Chain.ChainID()
+
+		cadenceVMEnabled := ctx.CadenceVMEnabled
+
+		env.Runtime.ConfigureCadenceRuntime = func(
+			reusableCadenceRuntime *runtime.ReusableCadenceRuntime,
+			env environment.Environment,
+		) {
+			// Setup EVM environment in both script and transaction environments.
+			// We also need to set up the transaction environment,
+			// because it is used for nested contract invocations
+
+			var scriptRuntimeEnv, txRuntimeEnv cadenceRuntime.Environment
+			if cadenceVMEnabled {
+				scriptRuntimeEnv = reusableCadenceRuntime.VMScriptRuntimeEnv
+				txRuntimeEnv = reusableCadenceRuntime.VMTxRuntimeEnv
+			} else {
+				scriptRuntimeEnv = reusableCadenceRuntime.ScriptRuntimeEnv
+				txRuntimeEnv = reusableCadenceRuntime.TxRuntimeEnv
+			}
+
+			evm.SetupEnvironment(
+				chainID,
+				env,
+				scriptRuntimeEnv,
+			)
+
+			evm.SetupEnvironment(
+				chainID,
+				env,
+				txRuntimeEnv,
+			)
+		}
+	}
+
 	return &scriptExecutor{
 		ctx:      ctx,
 		proc:     proc,
 		txnState: txnState,
-		env: environment.NewScriptEnv(
-			proc.RequestContext,
-			ctx.TracerSpan,
-			ctx.EnvironmentParams,
-			txnState),
+		env:      env,
 	}
 }
 
@@ -200,36 +241,13 @@ func (executor *scriptExecutor) executeScript() error {
 	rt := executor.env.BorrowCadenceRuntime()
 	defer executor.env.ReturnCadenceRuntime(rt)
 
-	chainID := executor.ctx.Chain.ChainID()
-
-	cadenceVMEnabled := executor.ctx.CadenceVMEnabled
-
-	if executor.ctx.EVMEnabled {
-
-		var scriptRuntimeEnv runtime.Environment
-		if cadenceVMEnabled {
-			scriptRuntimeEnv = rt.VMScriptRuntimeEnv
-		} else {
-			scriptRuntimeEnv = rt.ScriptRuntimeEnv
-		}
-
-		err := evm.SetupEnvironment(
-			chainID,
-			executor.env,
-			scriptRuntimeEnv,
-		)
-		if err != nil {
-			return err
-		}
-	}
-
 	value, err := rt.ExecuteScript(
-		runtime.Script{
+		cadenceRuntime.Script{
 			Source:    executor.proc.Script,
 			Arguments: executor.proc.Arguments,
 		},
 		common.ScriptLocation(executor.proc.ID),
-		cadenceVMEnabled,
+		executor.ctx.CadenceVMEnabled,
 	)
 	populateErr := executor.output.PopulateEnvironmentValues(executor.env)
 	if err != nil {

fvm/transactionInvoker.go

@@ -5,15 +5,15 @@ import (
 	"strconv"
 
 	"github.com/onflow/cadence/common"
-	"github.com/onflow/cadence/runtime"
+	cadenceRuntime "github.com/onflow/cadence/runtime"
 	"github.com/rs/zerolog"
 	"go.opentelemetry.io/otel/attribute"
 	otelTrace "go.opentelemetry.io/otel/trace"
 
 	"github.com/onflow/flow-go/fvm/environment"
 	"github.com/onflow/flow-go/fvm/errors"
 	"github.com/onflow/flow-go/fvm/evm"
-	reusableRuntime "github.com/onflow/flow-go/fvm/runtime"
+	"github.com/onflow/flow-go/fvm/runtime"
 	"github.com/onflow/flow-go/fvm/storage"
 	"github.com/onflow/flow-go/fvm/storage/derived"
 	"github.com/onflow/flow-go/fvm/storage/snapshot"
@@ -70,8 +70,8 @@ type transactionExecutor struct {
 	// writes to any of those registers
 	executionStateRead *snapshot.ExecutionSnapshot
 
-	cadenceRuntime  *reusableRuntime.ReusableCadenceRuntime
-	txnBodyExecutor runtime.Executor
+	cadenceRuntime  *runtime.ReusableCadenceRuntime
+	txnBodyExecutor cadenceRuntime.Executor
 
 	output ProcedureOutput
 }
@@ -93,6 +93,30 @@ func newTransactionExecutor(
 		ctx.EnvironmentParams,
 		txnState)
 
+	if ctx.EVMEnabled {
+		chainID := ctx.Chain.ChainID()
+
+		cadenceVMEnabled := ctx.CadenceVMEnabled
+
+		env.Runtime.ConfigureCadenceRuntime = func(
+			reusableCadenceRuntime *runtime.ReusableCadenceRuntime,
+			env environment.Environment,
+		) {
+			var txRuntimeEnv cadenceRuntime.Environment
+			if cadenceVMEnabled {
+				txRuntimeEnv = reusableCadenceRuntime.VMTxRuntimeEnv
+			} else {
+				txRuntimeEnv = reusableCadenceRuntime.TxRuntimeEnv
+			}
+
+			evm.SetupEnvironment(
+				chainID,
+				env,
+				txRuntimeEnv,
+			)
+		}
+	}
+
 	return &transactionExecutor{
 		TransactionExecutorParams: ctx.TransactionExecutorParams,
 		TransactionVerifier: TransactionVerifier{
@@ -186,30 +210,8 @@ func (executor *transactionExecutor) preprocess() error {
 // infrequently modified and are expensive to compute.  For now this includes
 // reading meter parameter overrides and parsing programs.
 func (executor *transactionExecutor) preprocessTransactionBody() error {
-	chainID := executor.ctx.Chain.ChainID()
 
 	// setup EVM
-	cadenceVMEnabled := executor.ctx.CadenceVMEnabled
-
-	if executor.ctx.EVMEnabled {
-
-		var txRuntimeEnv runtime.Environment
-		if cadenceVMEnabled {
-			txRuntimeEnv = executor.cadenceRuntime.VMTxRuntimeEnv
-		} else {
-			txRuntimeEnv = executor.cadenceRuntime.TxRuntimeEnv
-		}
-
-		err := evm.SetupEnvironment(
-			chainID,
-			executor.env,
-			txRuntimeEnv,
-		)
-		if err != nil {
-			return err
-		}
-	}
-
 	// get meter parameters
 	executionParameters, executionStateRead, err := getExecutionParameters(
 		executor.env.Logger(),
@@ -238,12 +240,12 @@ func (executor *transactionExecutor) preprocessTransactionBody() error {
 	executor.nestedTxnId = txnId
 
 	executor.txnBodyExecutor = executor.cadenceRuntime.NewTransactionExecutor(
-		runtime.Script{
+		cadenceRuntime.Script{
 			Source:    executor.proc.Transaction.Script,
 			Arguments: executor.proc.Transaction.Arguments,
 		},
 		common.TransactionLocation(executor.proc.ID),
-		cadenceVMEnabled,
+		executor.ctx.CadenceVMEnabled,
 	)
 
 	// This initializes various cadence variables and parses the programs used
@@ -267,27 +269,6 @@ func (executor *transactionExecutor) execute() error {
 }
 
 func (executor *transactionExecutor) ExecuteTransactionBody() error {
-	chainID := executor.ctx.Chain.ChainID()
-
-	// setup EVM
-	if executor.ctx.EVMEnabled {
-
-		var txRuntimeEnv runtime.Environment
-		if executor.ctx.CadenceVMEnabled {
-			txRuntimeEnv = executor.cadenceRuntime.VMTxRuntimeEnv
-		} else {
-			txRuntimeEnv = executor.cadenceRuntime.TxRuntimeEnv
-		}
-
-		err := evm.SetupEnvironment(
-			chainID,
-			executor.env,
-			txRuntimeEnv,
-		)
-		if err != nil {
-			return err
-		}
-	}
 
 	var invalidator derived.TransactionInvalidator
 	if !executor.errs.CollectedError() {