Include EVM stdlib in staging update validator (#1697)

onflow · Aug 15, 2024 · 5d187a5 · 5d187a5
1 parent 819f8bc
commit 5d187a5
Show file tree

Hide file tree

Showing 5 changed files with 501 additions and 311 deletions.
diff --git a/internal/cadence/linter.go b/internal/cadence/linter.go
@@ -69,8 +69,8 @@ func newLinter(state *flowkit.State) *linter {
 
 	// Create checker configs for both standard and script
 	// Scripts have a different stdlib than contracts and transactions
-	l.checkerStandardConfig = l.newCheckerConfig(util.NewStandardLibrary())
-	l.checkerScriptConfig = l.newCheckerConfig(util.NewScriptStandardLibrary())
+	l.checkerStandardConfig = l.newCheckerConfig(util.NewCheckerEnvironment())
+	l.checkerScriptConfig = l.newCheckerConfig(util.NewScriptCheckerEnvironment())
 
 	return l
 }
@@ -154,10 +154,13 @@ func (l *linter) lintFile(
 }
 
 // Create a new checker config with the given standard library
-func (l *linter) newCheckerConfig(lib util.StandardLibrary) *sema.Config {
+func (l *linter) newCheckerConfig(env *util.CheckerEnvironment) *sema.Config {
 	return &sema.Config{
-		BaseValueActivationHandler: func(_ common.Location) *sema.VariableActivation {
-			return lib.BaseValueActivation
+		BaseValueActivationHandler: func(location common.Location) *sema.VariableActivation {
+			return env.GetBaseValueActivation(location)
+		},
+		BaseTypeActivationHandler: func(location common.Location) *sema.VariableActivation {
+			return env.GetBaseTypeActivation(location)
 		},
 		AccessCheckMode:            sema.AccessCheckModeStrict,
 		PositionInfoEnabled:        true, // Must be enabled for linters

diff --git a/internal/migrate/staging_validator.go b/internal/migrate/staging_validator.go
@@ -68,6 +68,9 @@ type stagingValidatorImpl struct {
 
 	// Cache for contract checkers which are reused during program checking & used for the update checker
 	checkingCache map[common.Location]*cachedCheckingResult
+
+	// Environment for the stdlib
+	env *util.CheckerEnvironment
 }
 
 type node map[common.Location]node
@@ -174,6 +177,14 @@ func newStagingValidator(flow flowkit.Services) *stagingValidatorImpl {
 }
 
 func (v *stagingValidatorImpl) Validate(stagedContracts []stagedContractUpdate) error {
+	// Setup the environment for the stdlib
+	chainId, ok := chainIdMap[v.flow.Network().Name]
+	if !ok {
+		return fmt.Errorf("unsupported network: %s", v.flow.Network().Name)
+	}
+	v.env = util.NewCheckerEnvironment()
+	v.env.SetupFVM(chainId)
+
 	v.stagedContracts = make(map[common.AddressLocation]stagedContractUpdate)
 	for _, stagedContract := range stagedContracts {
 		v.stagedContracts[stagedContract.DeployLocation] = stagedContract
@@ -408,9 +419,13 @@ func (v *stagingValidatorImpl) checkContract(
 		&sema.Config{
 			AccessCheckMode:    sema.AccessCheckModeStrict,
 			AttachmentsEnabled: true,
-			BaseValueActivationHandler: func(_ common.Location) *sema.VariableActivation {
+			BaseValueActivationHandler: func(location common.Location) *sema.VariableActivation {
+				// Only checking contracts, so no need to consider script standard library
+				return v.env.GetBaseValueActivation(location)
+			},
+			BaseTypeActivationHandler: func(location common.Location) *sema.VariableActivation {
 				// Only checking contracts, so no need to consider script standard library
-				return util.NewStandardLibrary().BaseValueActivation
+				return v.env.GetBaseTypeActivation(location)
 			},
 			LocationHandler:            v.resolveLocation,
 			ImportHandler:              v.resolveImport,

diff --git a/internal/migrate/staging_validator_test.go b/internal/migrate/staging_validator_test.go
@@ -762,4 +762,64 @@ func Test_StagingValidator(t *testing.T) {
 
 		require.Nil(t, err)
 	})
+
+	t.Run("import InternalEVM fails with wrong location", func(t *testing.T) {
+		// setup mocks
+		srv := setupValidatorMocks(t, []mockNetworkAccount{
+			{
+				address: flow.HexToAddress("01"),
+				contracts: map[string][]byte{"Foo": []byte(`
+				pub contract Foo {
+					init() {}
+				}`)},
+			},
+		})
+
+		validator := newStagingValidator(srv)
+		err := validator.Validate([]stagedContractUpdate{
+			{
+				DeployLocation: simpleAddressLocation("0x01.Foo"),
+				SourceLocation: common.StringLocation("./Foo.cdc"),
+				Code: []byte(`
+				access(all) contract Foo {
+					init() {
+						log(InternalEVM)
+					}
+				}`),
+			},
+		})
+
+		var validatorErr *stagingValidatorError
+		require.ErrorAs(t, err, &validatorErr)
+
+		var checkerErr *sema.CheckerError
+		require.ErrorAs(t, validatorErr.errors[simpleAddressLocation("0x01.Foo")], &checkerErr)
+		require.ErrorContains(t, checkerErr, "cannot find variable in this scope: `InternalEVM`")
+	})
+
+	t.Run("EVM import works", func(t *testing.T) {
+		location := simpleAddressLocation("0x01.Test")
+		sourceCodeLocation := common.StringLocation("./Test.cdc")
+		oldContract := `
+		pub contract Test {
+			pub fun test() {}
+		}`
+		newContract := `
+		import EVM from 0x8c5303eaa26202d6
+		access(all) contract Test {
+			access(all) fun test() {}
+		}`
+
+		// setup mocks
+		srv := setupValidatorMocks(t, []mockNetworkAccount{
+			{
+				address:   flow.HexToAddress("01"),
+				contracts: map[string][]byte{"Test": []byte(oldContract)},
+			},
+		})
+
+		validator := newStagingValidator(srv)
+		err := validator.Validate([]stagedContractUpdate{{location, sourceCodeLocation, []byte(newContract)}})
+		require.NoError(t, err)
+	})
 }