README
¶
check_eth_config Task
Description
The check_eth_config task verifies that all execution clients in the network return consistent chain configuration via the eth_config JSON-RPC method as defined in EIP-7910. This task is essential for ensuring that all execution layer clients have the same fork configuration, including chain ID, fork IDs, activation times, precompiles, and system contracts. When mismatches are detected, the task provides a detailed diff showing which clients returned which configuration variants.
Configuration Parameters
-
clientPattern: A regex pattern to select specific execution client endpoints for queryingeth_config. This allows targeting specific clients within the network. An empty pattern (default) targets all ready execution clients. -
excludeClientPattern: A regex pattern to exclude certain execution clients from theeth_configcheck. This is useful for excluding known misconfigured or test clients from the consistency check. -
failOnMismatch: Determines whether the task should fail if any execution client returns a differenteth_configresponse. If set totrue(default), the task fails on configuration mismatches. If set tofalse, mismatches are logged but the task continues without failure. -
excludeSyncingClients: When set totrue, the task excludes execution clients that are currently syncing. If set tofalse(default), syncing clients are included in the check. This is useful for testing configuration consistency even before clients are fully synced, aseth_configreturns configuration data that doesn't depend on sync status.
Outputs
ethConfig: The referenceeth_configresponse from the first successful client query, returned as a JSON string. This output contains the complete fork configuration including current, next, and last fork details with activation times, chain ID, fork ID, blob schedule, precompiles, and system contracts.
Defaults
Default settings for the check_eth_config task:
- name: check_eth_config
config:
clientPattern: ""
excludeClientPattern: ""
failOnMismatch: true
excludeSyncingClients: false
Example Usage
Basic usage checking all execution clients:
- name: check_eth_config
title: "Verify eth_config consistency across all EL clients"
config:
failOnMismatch: true
Checking specific clients only:
- name: check_eth_config
title: "Verify eth_config for Geth clients only"
config:
clientPattern: ".*geth.*"
failOnMismatch: true
Non-blocking check that logs mismatches but doesn't fail:
- name: check_eth_config
title: "Monitor eth_config consistency"
config:
failOnMismatch: false
Only check fully synced clients:
- name: check_eth_config
title: "Verify eth_config for synced clients only"
config:
excludeSyncingClients: true
failOnMismatch: true
Implementation Details
The task queries the eth_config RPC method (EIP-7910) from all matching execution clients and performs a JSON-level comparison of the responses. When configurations match, the task succeeds and outputs the reference configuration. When mismatches are detected, the task provides a detailed error log showing:
- All unique configuration variants encountered
- Which clients returned each variant
- The full JSON structure of each variant for easy comparison
This makes it easy to diagnose configuration drift or misconfiguration across the execution layer.
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "check_eth_config" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Checks that all execution clients return the same eth_config (EIP-7910)", Category: "execution", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{ { Name: "ethConfig", Type: "string", Description: "The eth_config JSON returned by clients.", }, }, NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
ClientPattern string `` /* 126-byte string literal not displayed */
ExcludeClientPattern string `yaml:"excludeClientPattern" json:"excludeClientPattern" desc:"Regex pattern to exclude certain client endpoints."`
FailOnMismatch bool `yaml:"failOnMismatch" json:"failOnMismatch" desc:"If true, fail the task when client configurations do not match."`
ExcludeSyncingClients bool `` /* 128-byte string literal not displayed */
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files