fix: unknown solidity custom errors and packing failures

Author: nowooj

precompiles/common/errors.go

@@ -33,6 +33,10 @@ const (
 	ErrInvalidDescription = "invalid description: %v"
 	// ErrInvalidCommission is raised when the input commission cannot be cast to stakingtypes.CommissionRates{}.
 	ErrInvalidCommission = "invalid commission: %v"
+	// ErrUnknownSolidityCustomError is raised when the ABI does not contain the provided custom error.
+	ErrUnknownSolidityCustomError = "unknown solidity custom error: %s"
+	// ErrPackSolidityCustomErrorFailed is raised when ABI packing custom error args fails.
+	ErrPackSolidityCustomErrorFailed = "failed to pack solidity custom error %s: %s"
 
 	// SolidityErrInvalidNumberOfArgs is invalid number of arguments
 	SolidityErrInvalidNumberOfArgs = "InvalidNumberOfArgs"

precompiles/common/revert.go

@@ -2,6 +2,7 @@ package common
 
 import (
 	"errors"
+	"fmt"
 
 	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/ethereum/go-ethereum/core/vm"
@@ -33,7 +34,7 @@ func (e *RevertWithData) RevertData() []byte {
 func NewRevertWithSolidityError(moduleABI abi.ABI, errorName string, args ...interface{}) error {
 	customErr, ok := moduleABI.Errors[errorName]
 	if !ok {
-		reason := "unknown solidity custom error: " + errorName
+		reason := fmt.Sprintf(ErrUnknownSolidityCustomError, errorName)
 		revertReasonBz, encErr := evmtypes.RevertReasonBytes(reason)
 		if encErr != nil {
 			return errors.New(reason)
@@ -43,7 +44,12 @@ func NewRevertWithSolidityError(moduleABI abi.ABI, errorName string, args ...int
 
 	data, err := customErr.Inputs.Pack(args...)
 	if err != nil {
-		return err
+		reason := fmt.Sprintf(ErrPackSolidityCustomErrorFailed, errorName, err.Error())
+		revertReasonBz, encErr := evmtypes.RevertReasonBytes(reason)
+		if encErr != nil {
+			return errors.New(reason)
+		}
+		return &RevertWithData{data: revertReasonBz}
 	}
 	return &RevertWithData{data: append(customErr.ID[:4], data...)}
 }

precompiles/common/revert_test.go

@@ -5,6 +5,7 @@ import (
 	"math/big"
 	"testing"
 
+	"github.com/ethereum/go-ethereum/accounts/abi"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/vm"
 	"github.com/ethereum/go-ethereum/params"
@@ -36,3 +37,20 @@ func TestReturnRevertError_WithStringFallback(t *testing.T) {
 	require.ErrorIs(t, err, vm.ErrExecutionReverted)
 	require.NotEmpty(t, ret)
 }
+
+func TestReturnRevertError_WhenSolidityErrorPackFails_FallsBackToErrorStringRevert(t *testing.T) {
+	stateDB := statedbmocks.NewStateDB(t)
+	evm := vm.NewEVM(vm.BlockContext{BlockNumber: big.NewInt(1), Time: 1}, stateDB, params.TestChainConfig, vm.Config{})
+
+	// RequesterIsNotMsgSender(address,address) expects 2 args; provide 1 wrong-typed arg to force ABI pack failure.
+	customErr := cmn.NewRevertWithSolidityError(staking.ABI, "RequesterIsNotMsgSender", 123)
+	ret, err := cmn.ReturnRevertError(evm, customErr)
+
+	require.ErrorIs(t, err, vm.ErrExecutionReverted)
+	require.NotEmpty(t, ret)
+	require.Equal(t, ret, evm.ReturnData())
+
+	reason, unpackErr := abi.UnpackRevert(ret)
+	require.NoError(t, unpackErr)
+	require.Contains(t, reason, "failed to pack solidity custom error RequesterIsNotMsgSender")
+}