error-groups, tools, tests: add spec-mandated error-code fixtures for methods

src/error-groups/txpool-errors.yaml

@@ -7,3 +7,5 @@ TxPoolErrors:
       message: "Already known transaction"
     - code: 1001
       message: "Invalid sender"
+    - code: 1002
+      message: "Replacement transaction underpriced"

src/eth/execute.yaml

@@ -13,6 +13,10 @@
     name: Return data
     schema:
       $ref: '#/components/schemas/bytes'
+  error-groups:
+    - $ref: '#/components/error-groups/JSONRPCStandardErrors'
+    - $ref: '#/components/error-groups/ExecutionErrors'
+    - $ref: '#/components/error-groups/GasErrors'
   errors:
     - code: 3
       message: "execution reverted"
@@ -47,6 +51,10 @@
     name: Gas used
     schema:
       $ref: '#/components/schemas/uint'
+  error-groups:
+    - $ref: '#/components/error-groups/JSONRPCStandardErrors'
+    - $ref: '#/components/error-groups/ExecutionErrors'
+    - $ref: '#/components/error-groups/GasErrors'
   errors:
     - code: 3
       message: "execution reverted"

src/eth/filter.yaml

@@ -155,6 +155,8 @@
       schema:
         $ref: '#/components/schemas/Filter'
       required: true
+  error-groups:
+    - $ref: '#/components/error-groups/JSONRPCStandardErrors'
   errors:
     - code: 4444
       message: Pruned history unavailable

tests/eth_sendRawTransaction/send-already-known.io

@@ -0,0 +1,5 @@
+// re-sends a transaction that is already in the pool
+>> {"jsonrpc":"2.0","id":1,"method":"eth_sendRawTransaction","params":["0xf86c048405763d658261a894aa000000000000000000000000000000000000000a8211118718e5bb3abd10a0a0a4499575f90691cd45e1535022fa972ab54a4b1c9328a3cc6f2341ef534c1e9ba015d5834bc004a1c7cdc3c1f193a7536c9749de0fa4f23c890250b6b731d64e2c"]}
+<< {"jsonrpc":"2.0","id":1,"result":"0x2e8d0f5a901e194f349f21068312b40da5c7936f565b7e4137abaaa81adfc495"}
+>> {"jsonrpc":"2.0","id":2,"method":"eth_sendRawTransaction","params":["0xf86c048405763d658261a894aa000000000000000000000000000000000000000a8211118718e5bb3abd10a0a0a4499575f90691cd45e1535022fa972ab54a4b1c9328a3cc6f2341ef534c1e9ba015d5834bc004a1c7cdc3c1f193a7536c9749de0fa4f23c890250b6b731d64e2c"]}
+<< {"jsonrpc":"2.0","id":2,"error":{"code":1000,"message":"already known"}}

tests/eth_sendRawTransaction/send-insufficient-funds.io

@@ -0,0 +1,3 @@
+// sends a transaction with value exceeding sender balance
+>> {"jsonrpc":"2.0","id":1,"method":"eth_sendRawTransaction","params":["0xf879048405763d658261a894aa000000000000000000000000000000000000008fc097ce7bc90715b34b9f1000000002808718e5bb3abd109fa0a93b7157208ee6941f4ba0f5b306d2d1a4ee1ee1cf8fb9b3a820e66844c87fefa07b737cb54c1fc62a577ebcef3ae345c666ef077933407854841ff25f8696f226"]}
+<< {"jsonrpc":"2.0","id":1,"error":{"code":809,"message":"insufficient funds for gas * price + value: balance 1000000000000000000000000000000000001, tx cost 1000000000000000000000002290876125002, overshot 2290876125001"}}

tests/eth_sendRawTransaction/send-intrinsic-gas-too-low.io

@@ -0,0 +1,3 @@
+// sends a transaction with gas below the intrinsic minimum
+>> {"jsonrpc":"2.0","id":1,"method":"eth_sendRawTransaction","params":["0xf868048405763d650194aa000000000000000000000000000000000000000a808718e5bb3abd109fa0c413e3d9e2011595cc27847e1a3e3549904d47384d7a71c9b9251fb845603e7fa0644eaaa2def4ca4a1c45c093090a28ea1067a9a4ca118c9dabbe4a8dbd1aecf1"]}
+<< {"jsonrpc":"2.0","id":1,"error":{"code":800,"message":"intrinsic gas too low: gas 1, minimum needed 21000"}}

tests/eth_sendRawTransaction/send-nonce-too-low.io

@@ -0,0 +1,3 @@
+// sends a transaction with a nonce below the sender's state nonce
+>> {"jsonrpc":"2.0","id":1,"method":"eth_sendRawTransaction","params":["0xf86a808405763d658261a894aa000000000000000000000000000000000000000a808718e5bb3abd10a0a05f7f21951b14d685214b378a8d430f72e037ca02004712cbfc75ed124d06547da01f33468ef4837ef389a72fa6b1d6d89b97196f39e96f493ce7f3e3161a577202"]}
+<< {"jsonrpc":"2.0","id":1,"error":{"code":1,"message":"nonce too low: next nonce 160, tx nonce 0"}}

tests/eth_sendRawTransaction/send-replacement-underpriced.io

@@ -0,0 +1,5 @@
+// replaces a pending transaction without the required price bump
+>> {"jsonrpc":"2.0","id":1,"method":"eth_sendRawTransaction","params":["0xf86c058405763d658261a894aa000000000000000000000000000000000000000a8222228718e5bb3abd10a0a00143985bad80a4c76d32fd0deca585931c5998b00b00b1f76c0377bb2592b7fda05f1be04cd9e422fb80f4acee750812bec39db8d9782256dbac21cc217793ebbb"]}
+<< {"jsonrpc":"2.0","id":1,"result":"0xdf2b049904f977cff86ae87ab3fbd82efafc5bf98c8c285994f415ae09347ba5"}
+>> {"jsonrpc":"2.0","id":2,"method":"eth_sendRawTransaction","params":["0xf86c058405763d658261a894aa00000000000000000000000000000000000000148233338718e5bb3abd109fa0dda8fd585c96a17f49cf8c6efa2a5ebdd9ea21f1e5e78f23cb45ddc4ecdc002fa01d48d97ee713c096ed1f5478775e5140fb93b688128ee56d669f0b75c9b5f0ae"]}
+<< {"jsonrpc":"2.0","id":2,"error":{"code":1002,"message":"replacement transaction underpriced"}}

tests/eth_sendRawTransaction/send-tip-above-fee-cap.io

@@ -0,0 +1,3 @@
+// sends a transaction with maxPriorityFeePerGas greater than maxFeePerGas
+>> {"jsonrpc":"2.0","id":1,"method":"eth_sendRawTransaction","params":["0x02f86b870c72dd9d5e883e048203e8018261a894aa000000000000000000000000000000000000000a80c080a07598a76d407d863e6dfb6a67a736782d0303fe47633fe28c1d7239d557cbd7e2a014f108ef0efc0234d5e64e4de30de849527b71cd1213eaaed1f99f29a0a9d3b5"]}
+<< {"jsonrpc":"2.0","id":1,"error":{"code":804,"message":"max priority fee per gas higher than max fee per gas"}}

tests/eth_sendRawTransaction/send-tx-gas-exceeds-block-limit.io

@@ -0,0 +1,3 @@
+// sends a transaction with gasLimit exceeding the block gasLimit
+>> {"jsonrpc":"2.0","id":1,"method":"eth_sendRawTransaction","params":["0xf86c048405763d6584047e7c4194aa000000000000000000000000000000000000000a808718e5bb3abd109fa052f7d99eba02d8b7e308b8d0882eae9af8a154770d790052651be01450f9533ba03c08c1f65cecd4a7e1cd218147e9fbcec1431a6e3f299723d093239ef819176d"]}
+<< {"jsonrpc":"2.0","id":1,"error":{"code":803,"message":"exceeds block gas limit"}}

tools/cmd/rpctestgen/ethclient.go

@@ -7,11 +7,15 @@ import (
 	"io"
 	"net/http"
 	"os"
+	"regexp"
 	"strings"
 
 	"github.com/ethereum/go-ethereum/rpc"
 )
 
+// errorCodeRe matches the `"code":<int>` field inside a JSON-RPC error object.
+var errorCodeRe = regexp.MustCompile(`("error"\s*:\s*\{[^}]*?"code"\s*:\s*)-?\d+`)
+
 type ethclientHandler struct {
 	rpc       *rpc.Client
 	logFile   *os.File
@@ -72,6 +76,44 @@ func (l *ethclientHandler) Close() {
 	}
 }
 
+// RewriteLastErrorCode substitutes the `code` digits in the last "<< " error
+// response of the current log file, so fixtures assert the spec-mandated code
+// regardless of what the reference client returned.
+func (l *ethclientHandler) RewriteLastErrorCode(code int) error {
+	if l.logFile == nil {
+		return fmt.Errorf("no log file open")
+	}
+	filename := l.logFile.Name()
+	if err := l.logFile.Close(); err != nil {
+		return err
+	}
+	l.logFile = nil
+	l.transport.w = nil
+
+	data, err := os.ReadFile(filename)
+	if err != nil {
+		return err
+	}
+	lines := strings.Split(string(data), "\n")
+	idx := -1
+	for i := len(lines) - 1; i >= 0; i-- {
+		if strings.HasPrefix(lines[i], "<< ") {
+			idx = i
+			break
+		}
+	}
+	if idx < 0 {
+		return fmt.Errorf("no response line found in %s", filename)
+	}
+	replacement := fmt.Sprintf("${1}%d", code)
+	rewritten := errorCodeRe.ReplaceAllString(lines[idx], replacement)
+	if rewritten == lines[idx] {
+		return fmt.Errorf("ExpectErrorCode set but no error.code field found in %s", filename)
+	}
+	lines[idx] = rewritten
+	return os.WriteFile(filename, []byte(strings.Join(lines, "\n")), 0644)
+}
+
 // loggingRoundTrip writes requests and responses to the test log.
 type loggingRoundTrip struct {
 	w     io.Writer

tools/cmd/rpctestgen/generate.go

@@ -89,6 +89,14 @@ func runGenerator(ctx context.Context) error {
 				fails++
 				continue
 			}
+			if test.ExpectErrorCode != 0 {
+				if err := handler.RewriteLastErrorCode(test.ExpectErrorCode); err != nil {
+					fmt.Println(" fail.")
+					fmt.Fprintf(os.Stderr, "failed to rewrite error code in %s/%s: %s\n", methodTest.Name, test.Name, err)
+					fails++
+					continue
+				}
+			}
 			fmt.Println("  done.")
 			handler.Close()
 		}

tools/cmd/speccheck/check.go

@@ -18,12 +18,16 @@ func checkSpec(methods map[string]*methodSchema, rts []*roundTrip, re *regexp.Re
 		if !ok {
 			return fmt.Errorf("undefined method: %s", rt.method)
 		}
-		// skip validator of test if name includes "invalid" as the schema
-		// doesn't yet support it.
-		// TODO(matt): create error schemas.
+		// Exempts tests on methods that haven't adopted error-groups yet;
+		// remove once they do.
 		if strings.Contains(rt.name, "invalid") {
 			continue
 		}
+		// Error responses: validate the code against the spec
+		if rt.response.Result == nil && rt.response.Error != nil {
+			checkError(method, rt)
+			continue
+		}
 		if len(method.params) < len(rt.params) {
 			return fmt.Errorf("%s: too many parameters", method.name)
 		}
@@ -40,10 +44,6 @@ func checkSpec(methods map[string]*methodSchema, rts []*roundTrip, re *regexp.Re
 				return fmt.Errorf("unable to validate parameter in %s: %s", rt.name, err)
 			}
 		}
-		if rt.response.Result == nil && rt.response.Error != nil {
-			// skip validation of errors, they haven't been standardized
-			continue
-		}
 		if err := validate(&method.result.schema, rt.response.Result, fmt.Sprintf("%s.result", rt.method)); err != nil {
 			// Print out the value and schema if there is an error to further debug.
 			buf, _ := json.Marshal(method.result.schema)
@@ -58,6 +58,27 @@ func checkSpec(methods map[string]*methodSchema, rts []*roundTrip, re *regexp.Re
 	return nil
 }
 
+// checkError warns when a fixture's error.code isn't in the method's spec errors.
+func checkError(method *methodSchema, rt *roundTrip) {
+	if len(method.errors) == 0 {
+		return
+	}
+	code := rt.response.Error.Code
+	for _, e := range method.errors {
+		if e.Code == code {
+			if rt.response.Error.Message != e.Message {
+				// Message-mismatch warning is intentionally suppressed until
+				// clients converge on spec wording.
+				// fmt.Printf("[WARN]: ERROR MESSAGE: %q does not match expected: %q in %s\n",
+				// 	rt.response.Error.Message, e.Message, rt.name)
+			}
+			return
+		}
+	}
+	fmt.Printf("[WARN]: ERROR CODE: %d not found for method %s in %s\n",
+		code, method.name, rt.name)
+}
+
 // validateParam validates the provided value against schema using the url base.
 func validate(schema *openrpc.JSONSchemaObject, val []byte, url string) error {
 	// Set $schema explicitly to force jsonschema to use draft 2019-09.

tools/cmd/speccheck/spec.go

@@ -14,12 +14,18 @@ type ContentDescriptor struct {
 	schema   openrpc.JSONSchemaObject
 }
 
+type specError struct {
+	Code    int    `json:"code"`
+	Message string `json:"message"`
+}
+
 // methodSchema stores all the schemas neccessary to validate a request or
 // response corresponding to the method.
 type methodSchema struct {
 	name   string
 	params []*ContentDescriptor
 	result *ContentDescriptor
+	errors []specError
 }
 
 // parseSpec reads an OpenRPC specification and parses out each
@@ -30,6 +36,12 @@ func parseSpec(filename string) (map[string]*methodSchema, error) {
 		return nil, fmt.Errorf("unable to read spec: %v", err)
 	}
 
+	// Re-parse raw JSON for errors — the meta-schema library doesn't expose them.
+	methodErrors, err := parseMethodErrors(filename)
+	if err != nil {
+		return nil, fmt.Errorf("unable to parse method errors: %v", err)
+	}
+
 	// Iterate over each method in the OpenRPC spec and pull out the parameter
 	// schema and result schema.
 	parsed := make(map[string]*methodSchema)
@@ -79,12 +91,41 @@ func parseSpec(filename string) (map[string]*methodSchema, error) {
 			required: required,
 			schema:   *obj.Schema.JSONSchemaObject,
 		}
+
+		ms.errors = methodErrors[string(*method.Name)]
 		parsed[string(*method.Name)] = &ms
 	}
 
 	return parsed, nil
 }
 
+type rawMethod struct {
+	Name   string      `json:"name"`
+	Errors []specError `json:"errors"`
+}
+
+type rawSpec struct {
+	Methods []rawMethod `json:"methods"`
+}
+
+func parseMethodErrors(filename string) (map[string][]specError, error) {
+	data, err := os.ReadFile(filename)
+	if err != nil {
+		return nil, err
+	}
+	var spec rawSpec
+	if err := json.Unmarshal(data, &spec); err != nil {
+		return nil, err
+	}
+	result := make(map[string][]specError)
+	for _, m := range spec.Methods {
+		if len(m.Errors) > 0 {
+			result[m.Name] = m.Errors
+		}
+	}
+	return result, nil
+}
+
 // parseParamValues parses each parameter out of the raw json value in its own byte
 // slice.
 func parseParamValues(raw json.RawMessage) ([][]byte, error) {