Refactor decode to use ff-signer

Signed-off-by: Dave Crighton <[email protected]>

Author: davecrighton

internal/ethereum/estimate_gas_test.go

@@ -17,7 +17,6 @@
 package ethereum
 
 import (
-	"context"
 	"encoding/hex"
 	"encoding/json"
 	"testing"
@@ -32,6 +31,12 @@ import (
 	"github.com/stretchr/testify/mock"
 )
 
+var testDefaultError = &abi.Entry{
+	Type:   abi.Error,
+	Name:   "Error",
+	Inputs: abi.ParameterArray{{Type: "string"}},
+}
+
 const sampleGasEstimate = `{
 	"ffcapi": {
 		"version": "v1.0.0",
@@ -150,7 +155,7 @@ func TestGasEstimateFailRevertReasonInData(t *testing.T) {
 	ctx, c, mRPC, done := newTestConnector(t)
 	defer done()
 
-	errData, err := defaultError.EncodeCallDataValues([]string{"this reason"})
+	errData, err := testDefaultError.EncodeCallDataValues([]string{"this reason"})
 	assert.NoError(t, err)
 	mRPC.On("CallRPC", mock.Anything, mock.Anything, "eth_estimateGas",
 		mock.MatchedBy(func(tx *ethsigner.Transaction) bool {
@@ -205,7 +210,7 @@ func TestGasEstimateFailThenRevertDataFromCall(t *testing.T) {
 	ctx, c, mRPC, done := newTestConnector(t)
 	defer done()
 
-	errData, err := defaultError.EncodeCallDataValues([]string{"this reason"})
+	errData, err := testDefaultError.EncodeCallDataValues([]string{"this reason"})
 	assert.NoError(t, err)
 	mRPC.On("CallRPC", mock.Anything, mock.Anything, "eth_estimateGas",
 		mock.MatchedBy(func(tx *ethsigner.Transaction) bool {
@@ -261,7 +266,7 @@ func TestGasEstimateFailCustomErrorCannotParse(t *testing.T) {
 	ctx, c, mRPC, done := newTestConnector(t)
 	defer done()
 
-	errData, err := defaultError.EncodeCallDataValues([]string{"this reason"})
+	errData, err := testDefaultError.EncodeCallDataValues([]string{"this reason"})
 	assert.NoError(t, err)
 	mRPC.On("CallRPC", mock.Anything, mock.Anything, "eth_estimateGas",
 		mock.MatchedBy(func(tx *ethsigner.Transaction) bool {
@@ -281,6 +286,3 @@ func TestGasEstimateFailCustomErrorCannotParse(t *testing.T) {
 
 }
 
-func TestFormatErrorComponentBadCV(t *testing.T) {
-	assert.Equal(t, "?", formatErrorComponent(context.Background(), &abi.ComponentValue{}))
-}

internal/ethereum/exec_query.go

@@ -17,11 +17,8 @@
 package ethereum
 
 import (
-	"bytes"
 	"context"
-	"encoding/hex"
 	"encoding/json"
-	"fmt"
 
 	"github.com/hyperledger/firefly-common/pkg/fftypes"
 	"github.com/hyperledger/firefly-common/pkg/i18n"
@@ -35,21 +32,6 @@ import (
 	"github.com/hyperledger/firefly-transaction-manager/pkg/ffcapi"
 )
 
-var (
-	// See https://docs.soliditylang.org/en/v0.8.14/control-structures.html#revert
-	// There default error for `revert("some error")` is a function Error(string)
-	defaultError = &abi.Entry{
-		Type: abi.Error,
-		Name: "Error",
-		Inputs: abi.ParameterArray{
-			{
-				Type: "string",
-			},
-		},
-	}
-	defaultErrorID = defaultError.FunctionSelectorBytes()
-)
-
 func (c *ethConnector) QueryInvoke(ctx context.Context, req *ffcapi.QueryInvokeRequest) (*ffcapi.QueryInvokeResponse, ffcapi.ErrorReason, error) {
 	// Parse the input JSON data, to build the call data
 	callData, method, err := c.prepareCallData(ctx, &req.TransactionInput)
@@ -165,126 +147,15 @@ func processRevertReason(ctx context.Context, outputData ethtypes.HexBytes0xPref
 	// result in a multiple of 32 bytes) and has exactly 4 extra bytes for a function
 	// signature
 	if len(outputData)%32 == 4 {
-		signature := outputData[0:4]
-		if bytes.Equal(signature, defaultErrorID) {
-			errorInfo, err := defaultError.DecodeCallDataCtx(ctx, outputData)
-			if err == nil && len(errorInfo.Children) == 1 {
-				if strError, ok := errorInfo.Children[0].Value.(string); ok {
-					return unwrapNestedRevertReasons(ctx, strError, 0, errorAbis)
-				}
-			}
-			log.L(ctx).Warnf("Invalid revert data: %s", outputData)
-		} else if len(errorAbis) > 0 {
-			// check if the signature matches any of the declared custom error definitions
-			for _, e := range errorAbis {
-				idBytes := e.FunctionSelectorBytes()
-				if bytes.Equal(signature, idBytes) {
-					err := formatCustomError(ctx, e, outputData)
-					if err == "" {
-						log.L(ctx).Warnf("Invalid revert data: %s", outputData)
-						break
-					}
-					return err
-				}
-			}
+		var errors abi.ABI
+		for _, e := range errorAbis {
+			errors = append(errors, e)
+		}
+		if result, ok := errors.UnwrapErrorStringCtx(ctx, outputData); ok {
+			return result
 		}
-		// we call this "transient error" because it signals to the caller of the case
-		// that the raw revert data is returned, then it gets thrown away. so no need to translate
 		log.L(ctx).Debugf("Directly returning revert reason: %s", outputData)
 		return outputData.String()
 	}
 	return ""
 }
-
-const maxNestedRevertDepth = 10
-
-// unwrapNestedRevertReasons handles Solidity contracts that catch a revert's raw bytes
-// and re-throw them inside a new Error(string) by doing string(reason). This produces
-// an Error(string) whose decoded "string" contains raw ABI-encoded error data
-// (including null bytes from ABI padding). We scan for all known error selectors
-// (Error(string) plus any custom errors from the ABI), decode the earliest match,
-// and recurse for nested Error(string) chains.
-func unwrapNestedRevertReasons(ctx context.Context, s string, depth int, errorAbis []*abi.Entry) string {
-	if depth >= maxNestedRevertDepth {
-		return sanitizeBinaryString([]byte(s))
-	}
-
-	raw := []byte(s)
-
-	// Find the earliest occurrence of any known error selector
-	bestIdx := -1
-	var bestEntry *abi.Entry
-	if idx := bytes.Index(raw, defaultErrorID); idx >= 0 {
-		bestIdx = idx
-		bestEntry = defaultError
-	}
-	for _, e := range errorAbis {
-		sel := e.FunctionSelectorBytes()
-		if idx := bytes.Index(raw, sel); idx >= 0 && (bestIdx < 0 || idx < bestIdx) {
-			bestIdx = idx
-			bestEntry = e
-		}
-	}
-
-	if bestIdx < 0 {
-		return sanitizeBinaryString(raw)
-	}
-
-	prefix := sanitizeBinaryString(raw[:bestIdx])
-	embedded := raw[bestIdx:]
-
-	if bestEntry == defaultError {
-		errorInfo, err := defaultError.DecodeCallDataCtx(ctx, embedded)
-		if err == nil && len(errorInfo.Children) == 1 {
-			if nested, ok := errorInfo.Children[0].Value.(string); ok {
-				return prefix + unwrapNestedRevertReasons(ctx, nested, depth+1, errorAbis)
-			}
-		}
-	} else {
-		formatted := formatCustomError(ctx, bestEntry, embedded)
-		if formatted != "" {
-			return prefix + formatted
-		}
-	}
-
-	log.L(ctx).Debugf("Could not decode nested revert at depth %d, hex-encoding remaining %d bytes", depth, len(embedded))
-	return prefix + "0x" + hex.EncodeToString(embedded)
-}
-
-// sanitizeBinaryString returns the input as a text string if it is entirely
-// printable ASCII, or hex-encodes the entire input otherwise. This all-or-nothing
-// approach avoids guessing where "readable" ends in an ambiguous binary blob.
-func sanitizeBinaryString(raw []byte) string {
-	for _, b := range raw {
-		if b < 32 || b >= 127 {
-			return "0x" + hex.EncodeToString(raw)
-		}
-	}
-	return string(raw)
-}
-
-func formatCustomError(ctx context.Context, e *abi.Entry, outputData ethtypes.HexBytes0xPrefix) string {
-	errorInfo, err := e.DecodeCallDataCtx(ctx, outputData)
-	if err == nil {
-		strError := fmt.Sprintf("%s(", e.Name)
-		for i, child := range errorInfo.Children {
-			strError += formatErrorComponent(ctx, child)
-			if i < len(errorInfo.Children)-1 {
-				strError += ", "
-			}
-		}
-		strError += ")"
-		return strError
-	}
-	return ""
-}
-
-func formatErrorComponent(ctx context.Context, child *abi.ComponentValue) string {
-	value, err := child.JSON()
-	if err != nil {
-		// if this part of the error structure failed to parse, simply append "?"
-		log.L(ctx).Warnf("Failed to parse component value in error: %+v", child)
-		return "?"
-	}
-	return string(value)
-}