feat(api): populate data field for revert error in EthEstimateGas and EthCall (#12553)

Co-authored-by: Aryan Tikarya <[email protected]>

Author: virajbhartiya

CHANGELOG.md

@@ -11,6 +11,7 @@
 - `lotus-shed indexes inspect-indexes` now performs a comprehensive comparison of the event index data for each message by comparing the AMT root CID from the message receipt with the root of a reconstructed AMT. Previously `inspect-indexes` simply compared event counts, comparing AMT roots confirms all the event data is byte-perfect. ([filecoin-project/lotus#12570](https://github.com/filecoin-project/lotus/pull/12570))
 - Expose APIs to list the miner IDs that are currently participating in F3 via node. ([filecoin-project/lotus#12608](https://github.com/filecoin-project/lotus/pull/12608))
 - Implement new `lotus f3` CLI commands to list F3 participants, dump manifest, get/list finality certificates and check the F3 status. ([filecoin-project/lotus#12617](https://github.com/filecoin-project/lotus/pull/12617), [filecoin-project/lotus#12627](https://github.com/filecoin-project/lotus/pull/12627))
+- Return a `"data"` field on the `"error"` returned from RPC when `eth_call` and `eth_estimateGas` APIs encounter `execution reverted` errors. ([filecoin-project/lotus#12553](https://github.com/filecoin-project/lotus/pull/12553))
 
 ## Bug Fixes
 - Fix a bug in the `lotus-shed indexes backfill-events` command that may result in either duplicate events being backfilled where there are existing events (such an operation *should* be idempotent) or events erroneously having duplicate `logIndex` values when queried via ETH APIs. ([filecoin-project/lotus#12567](https://github.com/filecoin-project/lotus/pull/12567))

api/api_errors.go

@@ -4,9 +4,13 @@ import (
 	"errors"
 	"reflect"
 
+	"golang.org/x/xerrors"
+
 	"github.com/filecoin-project/go-jsonrpc"
 )
 
+var invalidExecutionRevertedMsg = xerrors.New("invalid execution reverted error")
+
 const (
 	EOutOfGas = iota + jsonrpc.FirstUserCode
 	EActorNotFound
@@ -17,6 +21,7 @@ const (
 	EF3ParticipationTooManyInstances
 	EF3ParticipationTicketStartBeforeExisting
 	EF3NotReady
+	EExecutionReverted
 )
 
 var (
@@ -40,13 +45,15 @@ var (
 	// should back off and try again later.
 	ErrF3NotReady = &errF3NotReady{}
 
-	_ error = (*ErrOutOfGas)(nil)
-	_ error = (*ErrActorNotFound)(nil)
-	_ error = (*errF3Disabled)(nil)
-	_ error = (*errF3ParticipationTicketInvalid)(nil)
-	_ error = (*errF3ParticipationTicketExpired)(nil)
-	_ error = (*errF3ParticipationIssuerMismatch)(nil)
-	_ error = (*errF3NotReady)(nil)
+	_ error                 = (*ErrOutOfGas)(nil)
+	_ error                 = (*ErrActorNotFound)(nil)
+	_ error                 = (*errF3Disabled)(nil)
+	_ error                 = (*errF3ParticipationTicketInvalid)(nil)
+	_ error                 = (*errF3ParticipationTicketExpired)(nil)
+	_ error                 = (*errF3ParticipationIssuerMismatch)(nil)
+	_ error                 = (*errF3NotReady)(nil)
+	_ error                 = (*ErrExecutionReverted)(nil)
+	_ jsonrpc.RPCErrorCodec = (*ErrExecutionReverted)(nil)
 )
 
 func init() {
@@ -59,6 +66,7 @@ func init() {
 	RPCErrors.Register(EF3ParticipationTooManyInstances, new(*errF3ParticipationTooManyInstances))
 	RPCErrors.Register(EF3ParticipationTicketStartBeforeExisting, new(*errF3ParticipationTicketStartBeforeExisting))
 	RPCErrors.Register(EF3NotReady, new(*errF3NotReady))
+	RPCErrors.Register(EExecutionReverted, new(*ErrExecutionReverted))
 }
 
 func ErrorIsIn(err error, errorTypes []error) bool {
@@ -110,3 +118,45 @@ func (errF3ParticipationTicketStartBeforeExisting) Error() string {
 type errF3NotReady struct{}
 
 func (errF3NotReady) Error() string { return "f3 isn't yet ready to participate" }
+
+// ErrExecutionReverted is used to return execution reverted with a reason for a revert in the `data` field.
+type ErrExecutionReverted struct {
+	Message string
+	Data    string
+}
+
+// Error returns the error message.
+func (e *ErrExecutionReverted) Error() string { return e.Message }
+
+// FromJSONRPCError converts a JSONRPCError to ErrExecutionReverted.
+func (e *ErrExecutionReverted) FromJSONRPCError(jerr jsonrpc.JSONRPCError) error {
+	if jerr.Code != EExecutionReverted || jerr.Message == "" || jerr.Data == nil {
+		return invalidExecutionRevertedMsg
+	}
+
+	data, ok := jerr.Data.(string)
+	if !ok {
+		return xerrors.Errorf("expected string data in execution reverted error, got %T", jerr.Data)
+	}
+
+	e.Message = jerr.Message
+	e.Data = data
+	return nil
+}
+
+// ToJSONRPCError converts ErrExecutionReverted to a JSONRPCError.
+func (e *ErrExecutionReverted) ToJSONRPCError() (jsonrpc.JSONRPCError, error) {
+	return jsonrpc.JSONRPCError{
+		Code:    EExecutionReverted,
+		Message: e.Message,
+		Data:    e.Data,
+	}, nil
+}
+
+// NewErrExecutionReverted creates a new ErrExecutionReverted with the given reason.
+func NewErrExecutionReverted(reason string) *ErrExecutionReverted {
+	return &ErrExecutionReverted{
+		Message: "execution reverted",
+		Data:    reason,
+	}
+}

go.mod

@@ -47,7 +47,7 @@ require (
 	github.com/filecoin-project/go-f3 v0.7.0
 	github.com/filecoin-project/go-fil-commcid v0.2.0
 	github.com/filecoin-project/go-hamt-ipld/v3 v3.4.0
-	github.com/filecoin-project/go-jsonrpc v0.6.0
+	github.com/filecoin-project/go-jsonrpc v0.7.0
 	github.com/filecoin-project/go-padreader v0.0.1
 	github.com/filecoin-project/go-paramfetch v0.0.4
 	github.com/filecoin-project/go-state-types v0.15.0-rc1

go.sum

@@ -287,8 +287,8 @@ github.com/filecoin-project/go-hamt-ipld/v3 v3.0.1/go.mod h1:gXpNmr3oQx8l3o7qkGy
 github.com/filecoin-project/go-hamt-ipld/v3 v3.1.0/go.mod h1:bxmzgT8tmeVQA1/gvBwFmYdT8SOFUwB3ovSUfG1Ux0g=
 github.com/filecoin-project/go-hamt-ipld/v3 v3.4.0 h1:nYs6OPUF8KbZ3E8o9p9HJnQaE8iugjHR5WYVMcicDJc=
 github.com/filecoin-project/go-hamt-ipld/v3 v3.4.0/go.mod h1:s0qiHRhFyrgW0SvdQMSJFQxNa4xEIG5XvqCBZUEgcbc=
-github.com/filecoin-project/go-jsonrpc v0.6.0 h1:/fFJIAN/k6EgY90m7qbyfY28woMwyseZmh2gVs5sYjY=
-github.com/filecoin-project/go-jsonrpc v0.6.0/go.mod h1:/n/niXcS4ZQua6i37LcVbY1TmlJR0UIK9mDFQq2ICek=
+github.com/filecoin-project/go-jsonrpc v0.7.0 h1:mqA5pIOlBODx7ascY9cJdBAYonhgbdUOIn2dyYI1YBg=
+github.com/filecoin-project/go-jsonrpc v0.7.0/go.mod h1:lAUpS8BSVtKaA8+/CFUMA5dokMiSM7n0ehf8bHOFdpE=
 github.com/filecoin-project/go-padreader v0.0.1 h1:8h2tVy5HpoNbr2gBRr+WD6zV6VD6XHig+ynSGJg8ZOs=
 github.com/filecoin-project/go-padreader v0.0.1/go.mod h1:VYVPJqwpsfmtoHnAmPx6MUwmrK6HIcDqZJiuZhtmfLQ=
 github.com/filecoin-project/go-paramfetch v0.0.4 h1:H+Me8EL8T5+79z/KHYQQcT8NVOzYVqXIi7nhb48tdm8=