feat: match runtime errors with geth (#1619)

* feat: match runtime errors with geth

* chore: linting fixes

state/runtime/evm/evm_test.go

@@ -156,7 +156,7 @@ func TestRun(t *testing.T) {
 				ReturnValue: nil,
 				GasLeft:     0,
 				GasUsed:     5000,
-				Err:         errStackUnderflow,
+				Err:         &runtime.StackUnderflowError{StackLen: 0, Required: 2},
 			},
 		},
 		{
@@ -339,7 +339,7 @@ func TestRunWithTracer(t *testing.T) {
 						"cost":            uint64(2),
 						"lastReturnData":  []byte{},
 						"depth":           1,
-						"err":             errStackUnderflow,
+						"err":             &runtime.StackUnderflowError{StackLen: 0, Required: 1},
 					},
 				},
 			},

state/runtime/evm/instructions.go

@@ -994,7 +994,7 @@ func opPush(n int) instruction {
 func opDup(n int) instruction {
 	return func(c *state) {
 		if !c.stackAtLeast(n) {
-			c.exit(errStackUnderflow)
+			c.exit(&runtime.StackUnderflowError{StackLen: c.sp, Required: n})
 		} else {
 			val := c.peekAt(n)
 			c.push1().Set(val)
@@ -1005,7 +1005,7 @@ func opDup(n int) instruction {
 func opSwap(n int) instruction {
 	return func(c *state) {
 		if !c.stackAtLeast(n + 1) {
-			c.exit(errStackUnderflow)
+			c.exit(&runtime.StackUnderflowError{StackLen: c.sp, Required: n + 1})
 		} else {
 			c.swap(n)
 		}
@@ -1023,7 +1023,7 @@ func opLog(size int) instruction {
 		}
 
 		if !c.stackAtLeast(2 + size) {
-			c.exit(errStackUnderflow)
+			c.exit(&runtime.StackUnderflowError{StackLen: c.sp, Required: 2 + size})
 
 			return
 		}

state/runtime/evm/state.go

@@ -38,8 +38,6 @@ const stackSize = 1024
 
 var (
 	errOutOfGas              = runtime.ErrOutOfGas
-	errStackUnderflow        = runtime.ErrStackUnderflow
-	errStackOverflow         = runtime.ErrStackOverflow
 	errRevert                = runtime.ErrExecutionReverted
 	errGasUintOverflow       = errors.New("gas uint64 overflow")
 	errWriteProtection       = errors.New("write protection")
@@ -245,7 +243,7 @@ func (c *state) Run() ([]byte, error) {
 
 		// check if the depth of the stack is enough for the instruction
 		if c.sp < inst.stack {
-			c.exit(errStackUnderflow)
+			c.exit(&runtime.StackUnderflowError{StackLen: c.sp, Required: inst.stack})
 			c.captureExecutionError(op.String(), c.ip, gasCopy, inst.gas)
 
 			break
@@ -266,7 +264,7 @@ func (c *state) Run() ([]byte, error) {
 
 		// check if stack size exceeds the max size
 		if c.sp > stackSize {
-			c.exit(errStackOverflow)
+			c.exit(&runtime.StackOverflowError{StackLen: c.sp, Limit: stackSize})
 
 			break
 		}

state/runtime/evm/state_test.go

@@ -3,6 +3,8 @@ package evm
 import (
 	"testing"
 
+	"github.com/0xPolygon/polygon-edge/state/runtime"
+
 	"github.com/stretchr/testify/assert"
 )
 
@@ -68,7 +70,7 @@ func TestStackOverflow(t *testing.T) {
 	s.host = &mockHost{}
 
 	_, err = s.Run()
-	assert.Equal(t, errStackOverflow, err)
+	assert.Equal(t, &runtime.StackOverflowError{StackLen: stackSize + 1, Limit: stackSize}, err)
 }
 
 func TestStackUnderflow(t *testing.T) {
@@ -99,7 +101,8 @@ func TestStackUnderflow(t *testing.T) {
 	s.host = &mockHost{}
 
 	_, err = s.Run()
-	assert.Equal(t, errStackUnderflow, err)
+	// need at least one operation on the stack
+	assert.Equal(t, &runtime.StackUnderflowError{StackLen: 0, Required: 1}, err)
 }
 
 func TestOpcodeNotFound(t *testing.T) {

state/runtime/runtime.go

@@ -2,6 +2,7 @@ package runtime
 
 import (
 	"errors"
+	"fmt"
 	"math/big"
 
 	"github.com/0xPolygon/polygon-edge/chain"
@@ -130,20 +131,40 @@ func (r *ExecutionResult) UpdateGasUsed(gasLimit uint64, refund uint64) {
 
 var (
 	ErrOutOfGas                 = errors.New("out of gas")
-	ErrStackOverflow            = errors.New("stack overflow")
-	ErrStackUnderflow           = errors.New("stack underflow")
 	ErrNotEnoughFunds           = errors.New("not enough funds")
 	ErrInsufficientBalance      = errors.New("insufficient balance for transfer")
-	ErrMaxCodeSizeExceeded      = errors.New("evm: max code size exceeded")
+	ErrMaxCodeSizeExceeded      = errors.New("max code size exceeded")
 	ErrContractAddressCollision = errors.New("contract address collision")
 	ErrDepth                    = errors.New("max call depth exceeded")
-	ErrExecutionReverted        = errors.New("execution was reverted")
+	ErrExecutionReverted        = errors.New("execution reverted")
 	ErrCodeStoreOutOfGas        = errors.New("contract creation code storage out of gas")
 	ErrUnauthorizedCaller       = errors.New("unauthorized caller")
 	ErrInvalidInputData         = errors.New("invalid input data")
 	ErrNotAuth                  = errors.New("not in allow list")
 )
 
+// StackUnderflowError wraps an evm error when the items on the stack less
+// than the minimal requirement.
+type StackUnderflowError struct {
+	StackLen int
+	Required int
+}
+
+func (e *StackUnderflowError) Error() string {
+	return fmt.Sprintf("stack underflow (%d <=> %d)", e.StackLen, e.Required)
+}
+
+// StackOverflowError wraps an evm error when the items on the stack exceeds
+// the maximum allowance.
+type StackOverflowError struct {
+	StackLen int
+	Limit    int
+}
+
+func (e *StackOverflowError) Error() string {
+	return fmt.Sprintf("stack limit reached %d (%d)", e.StackLen, e.Limit)
+}
+
 type CallType int
 
 const (