Merge pull request #1293 from nspcc-dev/fix/return

Check return values count for external contract calls

pkg/core/interop_system.go

@@ -519,6 +519,7 @@ func contractCallExInternal(ic *interop.Context, h []byte, name string, args []s
 		}
 		// use Jump not Call here because context was loaded in LoadScript above.
 		ic.VM.Jump(ic.VM.Context(), md.Offset)
+		ic.VM.Context().CheckReturn = true
 	}
 
 	md = cs.Manifest.ABI.GetMethod(manifest.MethodInit)

pkg/core/interop_system_test.go

@@ -335,6 +335,8 @@ func getTestContractState() (*state.Contract, *state.Contract) {
 		byte(opcode.DROP), byte(opcode.RET),
 		byte(opcode.INITSSLOT), 1, byte(opcode.PUSH3), byte(opcode.STSFLD0), byte(opcode.RET),
 		byte(opcode.LDSFLD0), byte(opcode.ADD), byte(opcode.RET),
+		byte(opcode.PUSH1), byte(opcode.PUSH2), byte(opcode.RET),
+		byte(opcode.RET),
 	}
 	h := hash.Hash160(script)
 	m := manifest.NewManifest(h)
@@ -372,6 +374,16 @@ func getTestContractState() (*state.Contract, *state.Contract) {
 			},
 			ReturnType: smartcontract.IntegerType,
 		},
+		{
+			Name:       "invalidReturn",
+			Offset:     15,
+			ReturnType: smartcontract.IntegerType,
+		},
+		{
+			Name:       "justReturn",
+			Offset:     18,
+			ReturnType: smartcontract.IntegerType,
+		},
 	}
 	cs := &state.Contract{
 		Script:   script,
@@ -385,6 +397,8 @@ func getTestContractState() (*state.Contract, *state.Contract) {
 	perm.Methods.Add("add")
 	perm.Methods.Add("drop")
 	perm.Methods.Add("add3")
+	perm.Methods.Add("invalidReturn")
+	perm.Methods.Add("justReturn")
 	m.Permissions = append(m.Permissions, *perm)
 
 	return cs, &state.Contract{
@@ -465,6 +479,28 @@ func TestContractCall(t *testing.T) {
 			stackitem.NewArray([]stackitem.Item{stackitem.Make(1)}), "add", h.BytesBE()))
 	})
 
+	t.Run("ReturnValues", func(t *testing.T) {
+		t.Run("Many", func(t *testing.T) {
+			loadScript(ic, currScript, 42)
+			ic.VM.Estack().PushVal(stackitem.NewArray(nil))
+			ic.VM.Estack().PushVal("invalidReturn")
+			ic.VM.Estack().PushVal(h.BytesBE())
+			require.NoError(t, contractCall(ic))
+			require.Error(t, ic.VM.Run())
+		})
+		t.Run("Void", func(t *testing.T) {
+			loadScript(ic, currScript, 42)
+			ic.VM.Estack().PushVal(stackitem.NewArray(nil))
+			ic.VM.Estack().PushVal("justReturn")
+			ic.VM.Estack().PushVal(h.BytesBE())
+			require.NoError(t, contractCall(ic))
+			require.NoError(t, ic.VM.Run())
+			require.Equal(t, 2, ic.VM.Estack().Len())
+			require.Equal(t, stackitem.Null{}, ic.VM.Estack().Pop().Item())
+			require.Equal(t, big.NewInt(42), ic.VM.Estack().Pop().Value())
+		})
+	})
+
 	t.Run("IsolatedStack", func(t *testing.T) {
 		loadScript(ic, currScript, 42)
 		ic.VM.Estack().PushVal(stackitem.NewArray(nil))

pkg/core/native/contract.go

@@ -61,6 +61,7 @@ func (cs *Contracts) GetPersistScript() []byte {
 		emit.Opcode(w.BinWriter, opcode.NEWARRAY)
 		emit.String(w.BinWriter, "onPersist")
 		emit.AppCall(w.BinWriter, md.Hash)
+		emit.Opcode(w.BinWriter, opcode.DROP)
 	}
 	cs.persistScript = w.Bytes()
 	return cs.persistScript

pkg/smartcontract/param_type.go

@@ -20,18 +20,18 @@ type ParamType int
 // A list of supported smart contract parameter types.
 const (
 	UnknownType          ParamType = -1
-	SignatureType        ParamType = 0x00
+	AnyType              ParamType = 0x00
-	BoolType             ParamType = 0x01
+	BoolType             ParamType = 0x10
-	IntegerType          ParamType = 0x02
+	IntegerType          ParamType = 0x11
-	Hash160Type          ParamType = 0x03
+	ByteArrayType        ParamType = 0x12
-	Hash256Type          ParamType = 0x04
+	StringType           ParamType = 0x13
-	ByteArrayType        ParamType = 0x05
+	Hash160Type          ParamType = 0x14
-	PublicKeyType        ParamType = 0x06
+	Hash256Type          ParamType = 0x15
-	StringType           ParamType = 0x07
+	PublicKeyType        ParamType = 0x16
-	ArrayType            ParamType = 0x10
+	SignatureType        ParamType = 0x17
-	MapType              ParamType = 0x12
+	ArrayType            ParamType = 0x20
-	InteropInterfaceType ParamType = 0xf0
+	MapType              ParamType = 0x22
-	AnyType              ParamType = 0xfe
+	InteropInterfaceType ParamType = 0x30
 	VoidType             ParamType = 0xff
 )
 

pkg/vm/context.go

@@ -44,6 +44,9 @@ type Context struct {
 
 	// Call flags this context was created with.
 	callFlag smartcontract.CallFlag
+
+	// CheckReturn specifies if amount of return values needs to be checked.
+	CheckReturn bool
 }
 
 var errNoInstParam = errors.New("failed to read instruction parameter")

pkg/vm/emit/emit.go

@@ -159,20 +159,6 @@ func AppCallWithOperationAndArgs(w *io.BinWriter, scriptHash util.Uint160, opera
 	AppCall(w, scriptHash)
 }
 
-// AppCallWithOperationAndData emits an appcall with the given operation and data.
-func AppCallWithOperationAndData(w *io.BinWriter, scriptHash util.Uint160, operation string, data []byte) {
-	Bytes(w, data)
-	String(w, operation)
-	AppCall(w, scriptHash)
-}
-
-// AppCallWithOperation emits an appcall with the given operation.
-func AppCallWithOperation(w *io.BinWriter, scriptHash util.Uint160, operation string) {
-	Bool(w, false)
-	String(w, operation)
-	AppCall(w, scriptHash)
-}
-
 func isInstructionJmp(op opcode.Opcode) bool {
 	return opcode.JMP <= op && op <= opcode.CALLL
 }

pkg/vm/vm.go

@@ -1391,6 +1391,13 @@ func (v *VM) unloadContext(ctx *Context) {
 	if ctx.static != nil && currCtx != nil && ctx.static != currCtx.static {
 		ctx.static.Clear()
 	}
+	if ctx.CheckReturn {
+		if currCtx != nil && ctx.estack.len == 0 {
+			currCtx.estack.PushVal(stackitem.Null{})
+		} else if ctx.estack.len > 1 {
+			panic("return value amount is > 1")
+		}
+	}
 }
 
 // getTryParams splits TRY(L) instruction parameter into offsets for catch and finally blocks.
@@ -1437,6 +1444,7 @@ func (v *VM) Jump(ctx *Context, offset int) {
 // pushes new context to the invocation state
 func (v *VM) Call(ctx *Context, offset int) {
 	newCtx := ctx.Copy()
+	newCtx.CheckReturn = false
 	newCtx.local = nil
 	newCtx.arguments = nil
 	v.istack.PushVal(newCtx)

pkg/vm/vm_test.go

@@ -959,6 +959,14 @@ func TestCALLA(t *testing.T) {
 	t.Run("Good", getTestFuncForVM(prog, 5, stackitem.NewPointer(4, prog)))
 }
 
+func TestCALL(t *testing.T) {
+	prog := makeProgram(
+		opcode.CALL, 4, opcode.ADD, opcode.RET,
+		opcode.CALL, 3, opcode.RET,
+		opcode.PUSH1, opcode.PUSH2, opcode.RET)
+	runWithArgs(t, prog, 3)
+}
+
 func TestNOT(t *testing.T) {
 	prog := makeProgram(opcode.NOT)
 	t.Run("Bool", getTestFuncForVM(prog, true, false))