feat: Add error message parsing for evm transactions in plan module (#…

…107)

.github/workflows/release_binary.yml

@@ -15,6 +15,21 @@ jobs:
     runs-on: ubuntu-latest
     environment: release
     steps:
+      - name: Free Disk Space (Ubuntu)
+        uses: jlumbroso/free-disk-space@main
+        with:
+          # this might remove tools that are actually needed,
+          # if set to "true" but frees about 6 GB
+          tool-cache: false
+
+          # all of these default to true, but feel free to set to
+          # "false" if necessary for your workflow
+          android: true
+          dotnet: true
+          haskell: true
+          large-packages: true
+          docker-images: true
+          swap-storage: true
       - uses: actions/checkout@v4
         with:
           submodules: true

x/btcstaking/keeper/btc_staking_test.go

@@ -208,7 +208,7 @@ func (suite *KeeperTestSuite) TestDelegate() {
 				suite.Require().NoError(err)
 				btcStakingRecord := suite.keeper.GetBTCStakingRecord(suite.ctx, *txHash)
 				suite.Require().NotNil(btcStakingRecord)
-				suite.Require().Contains(btcStakingRecord.MintYatResult, "execution reverted")
+				suite.Require().Contains(btcStakingRecord.MintYatResult, "contract call failed")
 			},
 			expectErr: false,
 		},

x/plan/keeper/evm.go

@@ -1,7 +1,9 @@
 package keeper
 
 import (
+	"bytes"
 	"encoding/json"
+	"errors"
 	"math/big"
 
 	"github.com/ethereum/go-ethereum/crypto"
@@ -20,6 +22,13 @@ import (
 	ethtypes "github.com/ethereum/go-ethereum/core/types"
 )
 
+var (
+	RevertSelectorInvalidParams      = crypto.Keccak256([]byte("InvalidParams()"))[:4]
+	RevertSelectorEmptyMerkleRoot    = crypto.Keccak256([]byte("EmptyMerkleRoot()"))[:4]
+	RevertSelectorAlreadyClaimed     = crypto.Keccak256([]byte("AlreadyClaimed()"))[:4]
+	RevertSelectorInvalidMerkleProof = crypto.Keccak256([]byte("InvalidMerkleProof()"))[:4]
+)
+
 // CallEVM performs a smart contract method call using given args
 func (k Keeper) CallEVM(
 	ctx sdk.Context,
@@ -68,7 +77,21 @@ func (k Keeper) CallEVMWithData(
 			return nil, errorsmod.Wrapf(errortypes.ErrJSONMarshal, "failed to marshal tx args: %s", err.Error())
 		}
 
-		// k.evmKeeper.
+		// k.evmKeeper.EthCall
+		callRes, err := k.evmKeeper.EthCall(sdk.WrapSDKContext(ctx), &evmtypes.EthCallRequest{
+			Args:    args,
+			GasCap:  config.DefaultGasCap,
+			ChainId: k.evmKeeper.ChainID().Int64(),
+		})
+		if err != nil {
+			return nil, err
+		}
+		if len(callRes.VmError) != 0 {
+			revertRetErr := UnpackRevert(callRes.Ret)
+			return nil, revertRetErr
+		}
+
+		// k.evmKeeper.EstimateGas
 		gasRes, err := k.evmKeeper.EstimateGas(sdk.WrapSDKContext(ctx), &evmtypes.EthCallRequest{
 			Args:    args,
 			GasCap:  config.DefaultGasCap,
@@ -152,3 +175,21 @@ func (k Keeper) DeployContract(
 
 	return contractAddr, nil
 }
+
+func UnpackRevert(data []byte) error {
+	if len(data) < 4 {
+		return errors.New("invalid data for unpacking")
+	}
+	switch {
+	case bytes.Equal(data[:4], RevertSelectorInvalidParams):
+		return errors.New("InvalidParams")
+	case bytes.Equal(data[:4], RevertSelectorEmptyMerkleRoot):
+		return errors.New("EmptyMerkleRoot")
+	case bytes.Equal(data[:4], RevertSelectorAlreadyClaimed):
+		return errors.New("AlreadyClaimed")
+	case bytes.Equal(data[:4], RevertSelectorInvalidMerkleProof):
+		return errors.New("InvalidMerkleProof")
+	}
+
+	return evmtypes.NewExecErrorWithReason(data)
+}

x/plan/types/expected_keepers.go

@@ -29,6 +29,7 @@ type EVMKeeper interface {
 	GetParams(ctx sdk.Context) evmtypes.Params
 	GetAccountWithoutBalance(ctx sdk.Context, addr common.Address) *statedb.Account
 	EstimateGas(c context.Context, req *evmtypes.EthCallRequest) (*evmtypes.EstimateGasResponse, error)
+	EthCall(c context.Context, req *evmtypes.EthCallRequest) (*evmtypes.MsgEthereumTxResponse, error)
 	ApplyMessage(ctx sdk.Context, msg core.Message, tracer vm.EVMLogger, commit bool) (*evmtypes.MsgEthereumTxResponse, error)
 	ChainID() *big.Int
 }