Merge master into Stable Cadence

runtime/context.go

@@ -29,24 +29,24 @@ type Context struct {
 	CoverageReport *CoverageReport
 }
 
-// codesAndPrograms collects the source code and AST for each location.
+// CodesAndPrograms collects the source code and AST for each location.
 // It is purely used for debugging: Both the codes and the programs
 // are provided in runtime errors.
-type codesAndPrograms struct {
+type CodesAndPrograms struct {
 	codes    map[Location][]byte
 	programs map[Location]*ast.Program
 }
 
-func (c codesAndPrograms) setCode(location Location, code []byte) {
+func (c CodesAndPrograms) setCode(location Location, code []byte) {
 	c.codes[location] = code
 }
 
-func (c codesAndPrograms) setProgram(location Location, program *ast.Program) {
+func (c CodesAndPrograms) setProgram(location Location, program *ast.Program) {
 	c.programs[location] = program
 }
 
-func newCodesAndPrograms() codesAndPrograms {
-	return codesAndPrograms{
+func NewCodesAndPrograms() CodesAndPrograms {
+	return CodesAndPrograms{
 		codes:    map[Location][]byte{},
 		programs: map[Location]*ast.Program{},
 	}

runtime/contract_function_executor.go

@@ -34,7 +34,7 @@ type interpreterContractFunctionExecutor struct {
 	result           cadence.Value
 	executeErr       error
 	preprocessErr    error
-	codesAndPrograms codesAndPrograms
+	codesAndPrograms CodesAndPrograms
 	runtime          *interpreterRuntime
 	storage          *Storage
 	contractLocation common.AddressLocation
@@ -90,7 +90,7 @@ func (executor *interpreterContractFunctionExecutor) preprocess() (err error) {
 	context := executor.context
 	location := context.Location
 
-	codesAndPrograms := newCodesAndPrograms()
+	codesAndPrograms := NewCodesAndPrograms()
 	executor.codesAndPrograms = codesAndPrograms
 
 	interpreterRuntime := executor.runtime

runtime/environment.go

@@ -41,7 +41,7 @@ type Environment interface {
 	Declare(valueDeclaration stdlib.StandardLibraryValue)
 	Configure(
 		runtimeInterface Interface,
-		codesAndPrograms codesAndPrograms,
+		codesAndPrograms CodesAndPrograms,
 		storage *Storage,
 		coverageReport *CoverageReport,
 	)
@@ -72,7 +72,7 @@ type interpreterEnvironmentReconfigured struct {
 	runtimeInterface Interface
 	storage          *Storage
 	coverageReport   *CoverageReport
-	codesAndPrograms codesAndPrograms
+	codesAndPrograms CodesAndPrograms
 }
 
 type interpreterEnvironment struct {
@@ -180,7 +180,7 @@ func NewScriptInterpreterEnvironment(config Config) Environment {
 
 func (e *interpreterEnvironment) Configure(
 	runtimeInterface Interface,
-	codesAndPrograms codesAndPrograms,
+	codesAndPrograms CodesAndPrograms,
 	storage *Storage,
 	coverageReport *CoverageReport,
 ) {

runtime/errors.go

@@ -37,7 +37,7 @@ type Error struct {
 	Programs map[Location]*ast.Program
 }
 
-func newError(err error, location Location, codesAndPrograms codesAndPrograms) Error {
+func newError(err error, location Location, codesAndPrograms CodesAndPrograms) Error {
 	return Error{
 		Err:      err,
 		Location: location,

runtime/runtime.go

@@ -221,7 +221,7 @@ func (r *interpreterRuntime) Config() Config {
 	return r.defaultConfig
 }
 
-func (r *interpreterRuntime) Recover(onError func(Error), location Location, codesAndPrograms codesAndPrograms) {
+func (r *interpreterRuntime) Recover(onError func(Error), location Location, codesAndPrograms CodesAndPrograms) {
 	recovered := recover()
 	if recovered == nil {
 		return
@@ -231,7 +231,7 @@ func (r *interpreterRuntime) Recover(onError func(Error), location Location, cod
 	onError(err)
 }
 
-func getWrappedError(recovered any, location Location, codesAndPrograms codesAndPrograms) Error {
+func getWrappedError(recovered any, location Location, codesAndPrograms CodesAndPrograms) Error {
 	switch recovered := recovered.(type) {
 
 	// If the error is already a `runtime.Error`, then avoid redundant wrapping.
@@ -510,7 +510,7 @@ func (r *interpreterRuntime) ParseAndCheckProgram(
 ) {
 	location := context.Location
 
-	codesAndPrograms := newCodesAndPrograms()
+	codesAndPrograms := NewCodesAndPrograms()
 
 	defer r.Recover(
 		func(internalErr Error) {
@@ -549,7 +549,7 @@ func (r *interpreterRuntime) Storage(context Context) (*Storage, *interpreter.In
 
 	location := context.Location
 
-	codesAndPrograms := newCodesAndPrograms()
+	codesAndPrograms := NewCodesAndPrograms()
 
 	storage := NewStorage(context.Interface, context.Interface)
 
@@ -587,7 +587,7 @@ func (r *interpreterRuntime) ReadStored(
 ) {
 	location := context.Location
 
-	var codesAndPrograms codesAndPrograms
+	var codesAndPrograms CodesAndPrograms
 
 	defer r.Recover(
 		func(internalErr Error) {

runtime/script_executor.go

@@ -29,7 +29,7 @@ import (
 type interpreterScriptExecutorPreparation struct {
 	environment            Environment
 	preprocessErr          error
-	codesAndPrograms       codesAndPrograms
+	codesAndPrograms       CodesAndPrograms
 	functionEntryPointType *sema.FunctionType
 	program                *interpreter.Program
 	storage                *Storage
@@ -92,7 +92,7 @@ func (executor *interpreterScriptExecutor) preprocess() (err error) {
 	location := context.Location
 	script := executor.script
 
-	codesAndPrograms := newCodesAndPrograms()
+	codesAndPrograms := NewCodesAndPrograms()
 	executor.codesAndPrograms = codesAndPrograms
 
 	interpreterRuntime := executor.runtime

runtime/stdlib/contracts/test.cdc

@@ -152,6 +152,29 @@ contract Test {
         fun moveTime(by delta: Fix64) {
             self.backend.moveTime(by: delta)
         }
+
+        /// Creates a snapshot of the blockchain, at the
+        /// current ledger state, with the given name.
+        ///
+        access(all)
+        fun createSnapshot(name: String) {
+            let err = self.backend.createSnapshot(name: name)
+            if err != nil {
+                panic(err!.message)
+            }
+        }
+
+        /// Loads a snapshot of the blockchain, with the
+        /// given name, and updates the current ledger
+        /// state.
+        ///
+        access(all)
+        fun loadSnapshot(name: String) {
+            let err = self.backend.loadSnapshot(name: name)
+            if err != nil {
+                panic(err!.message)
+            }
+        }
     }
 
     access(all)
@@ -394,6 +417,19 @@ contract Test {
         ///
         access(all)
         fun moveTime(by delta: Fix64)
+
+        /// Creates a snapshot of the blockchain, at the
+        /// current ledger state, with the given name.
+        ///
+        access(all)
+        fun createSnapshot(name: String): Error?
+
+        /// Loads a snapshot of the blockchain, with the
+        /// given name, and updates the current ledger
+        /// state.
+        ///
+        access(all)
+        fun loadSnapshot(name: String): Error?
     }
 
     /// Returns a new matcher that negates the test of the given matcher.

runtime/stdlib/test-framework.go

@@ -79,6 +79,10 @@ type Blockchain interface {
 	Reset(uint64)
 
 	MoveTime(int64)
+
+	CreateSnapshot(string) error
+
+	LoadSnapshot(string) error
 }
 
 type ScriptResult struct {

runtime/stdlib/test_emulatorbackend.go

@@ -47,6 +47,8 @@ type testEmulatorBackendType struct {
 	eventsFunctionType                 *sema.FunctionType
 	resetFunctionType                  *sema.FunctionType
 	moveTimeFunctionType               *sema.FunctionType
+	createSnapshotFunctionType         *sema.FunctionType
+	loadSnapshotFunctionType           *sema.FunctionType
 }
 
 func newTestEmulatorBackendType(
@@ -112,6 +114,16 @@ func newTestEmulatorBackendType(
 		testEmulatorBackendTypeMoveTimeFunctionName,
 	)
 
+	createSnapshotFunctionType := interfaceFunctionType(
+		blockchainBackendInterfaceType,
+		testEmulatorBackendTypeCreateSnapshotFunctionName,
+	)
+
+	loadSnapshotFunctionType := interfaceFunctionType(
+		blockchainBackendInterfaceType,
+		testEmulatorBackendTypeLoadSnapshotFunctionName,
+	)
+
 	compositeType := &sema.CompositeType{
 		Identifier: testEmulatorBackendTypeName,
 		Kind:       common.CompositeKindStructure,
@@ -194,6 +206,18 @@ func newTestEmulatorBackendType(
 			moveTimeFunctionType,
 			testEmulatorBackendTypeMoveTimeFunctionDocString,
 		),
+		sema.NewUnmeteredPublicFunctionMember(
+			compositeType,
+			testEmulatorBackendTypeCreateSnapshotFunctionName,
+			createSnapshotFunctionType,
+			testEmulatorBackendTypeCreateSnapshotFunctionDocString,
+		),
+		sema.NewUnmeteredPublicFunctionMember(
+			compositeType,
+			testEmulatorBackendTypeLoadSnapshotFunctionName,
+			loadSnapshotFunctionType,
+			testEmulatorBackendTypeLoadSnapshotFunctionDocString,
+		),
 	}
 
 	compositeType.Members = sema.MembersAsMap(members)
@@ -213,6 +237,8 @@ func newTestEmulatorBackendType(
 		eventsFunctionType:                 eventsFunctionType,
 		resetFunctionType:                  resetFunctionType,
 		moveTimeFunctionType:               moveTimeFunctionType,
+		createSnapshotFunctionType:         createSnapshotFunctionType,
+		loadSnapshotFunctionType:           loadSnapshotFunctionType,
 	}
 }
 
@@ -739,6 +765,58 @@ func (t *testEmulatorBackendType) newMoveTimeFunction(
 	)
 }
 
+// 'Emulator.createSnapshot' function
+
+const testEmulatorBackendTypeCreateSnapshotFunctionName = "createSnapshot"
+
+const testEmulatorBackendTypeCreateSnapshotFunctionDocString = `
+Creates a snapshot of the blockchain, at the
+current ledger state, with the given name.
+`
+
+func (t *testEmulatorBackendType) newCreateSnapshotFunction(
+	blockchain Blockchain,
+) *interpreter.HostFunctionValue {
+	return interpreter.NewUnmeteredHostFunctionValue(
+		t.createSnapshotFunctionType,
+		func(invocation interpreter.Invocation) interpreter.Value {
+			name, ok := invocation.Arguments[0].(*interpreter.StringValue)
+			if !ok {
+				panic(errors.NewUnreachableError())
+			}
+
+			err := blockchain.CreateSnapshot(name.Str)
+			return newErrorValue(invocation.Interpreter, err)
+		},
+	)
+}
+
+// 'Emulator.loadSnapshot' function
+
+const testEmulatorBackendTypeLoadSnapshotFunctionName = "loadSnapshot"
+
+const testEmulatorBackendTypeLoadSnapshotFunctionDocString = `
+Loads a snapshot of the blockchain, with the given name, and
+updates the current ledger state.
+`
+
+func (t *testEmulatorBackendType) newLoadSnapshotFunction(
+	blockchain Blockchain,
+) *interpreter.HostFunctionValue {
+	return interpreter.NewUnmeteredHostFunctionValue(
+		t.loadSnapshotFunctionType,
+		func(invocation interpreter.Invocation) interpreter.Value {
+			name, ok := invocation.Arguments[0].(*interpreter.StringValue)
+			if !ok {
+				panic(errors.NewUnreachableError())
+			}
+
+			err := blockchain.LoadSnapshot(name.Str)
+			return newErrorValue(invocation.Interpreter, err)
+		},
+	)
+}
+
 func (t *testEmulatorBackendType) newEmulatorBackend(
 	inter *interpreter.Interpreter,
 	blockchain Blockchain,
@@ -792,6 +870,14 @@ func (t *testEmulatorBackendType) newEmulatorBackend(
 			Name:  testEmulatorBackendTypeMoveTimeFunctionName,
 			Value: t.newMoveTimeFunction(blockchain),
 		},
+		{
+			Name:  testEmulatorBackendTypeCreateSnapshotFunctionName,
+			Value: t.newCreateSnapshotFunction(blockchain),
+		},
+		{
+			Name:  testEmulatorBackendTypeLoadSnapshotFunctionName,
+			Value: t.newLoadSnapshotFunction(blockchain),
+		},
 	}
 
 	// TODO: Use SimpleCompositeValue