feat(rpc): add Other(String) variant to RethRpcModule for custom RPC modules #17758

fgimenez · 2025-08-08T00:14:37Z

Adds support for custom RPC modules by introducing an Other(String) variant to RethRpcModule. This allows users to configure and use RPC modules beyond the predefined set, enabling greater extensibility for custom implementations.

The PR also includes validation to warn users when they configure RPC modules that haven't been registered with the RPC builder, helping catch configuration errors early.

…modules

mattsse

introducing a new string based variant makes sense,

however we need a few additional cli level parse tests here that ensure that this behaves as expected,

and the validation part is a bit to restrict, if we skip ::Other then we likely dont need this?

however validation here is missing, the problematic part is something like --http.api eht which is clearly a typo that we currently dont catch,

since this is CLI specific, we need to make this behaviour somehow configurable.
my suggestion here would be introducing something liek

RethCliParsers {
  type ChainSpec:
  type RpcModules
}

and replacing C: ChainSpecParser with that

reth/crates/ethereum/cli/src/interface.rs

Line 30 in 6166209

    
           pub struct Cli<C: ChainSpecParser = EthereumChainSpecParser, Ext: clap::Args + fmt::Debug = NoArgs>

then we can configure how rpc modules are parsed

docs/vocs/docs/pages/cli/reth/node.mdx

crates/rpc/rpc-builder/src/lib.rs

…defaults

fgimenez · 2025-08-18T17:10:32Z

since this is CLI specific, we need to make this behaviour somehow configurable.
my suggestion here would be introducing something liek

makes total sense, done here 68f8abc

mattsse

after reviewing I understood why we don't integrate an rpcmoduleparser, we can't really propagate the module parser down to the rpcserverargs because then we leak an unconstrained generic all over the place, right?

so perhaps we enforce this either when we do cli::parse or we enforce this in the Nodecommand::run somewhere early

so we do need to instead validate the parsed modules after somewhere, unsure where the proper location for that is.

maybe this should actually be enforced by the parser impl for the Cli itself?

mattsse · 2025-08-19T12:47:41Z

crates/cli/util/src/parsers.rs

+    type ChainSpecParser: reth_cli::chainspec::ChainSpecParser + std::fmt::Debug;
+
+    /// The RPC module validator type.
+    type RpcModuleValidator: reth_rpc_server_types::RpcModuleValidator;


should we follow the same convention as ChainSpecParser here and move the parse_rpc_modules in the trait?

makes sense, moved

mattsse · 2025-08-19T12:50:44Z

crates/rpc/rpc-server-types/src/module.rs

+/// Check if two strings are likely typos using edit distance.
+fn is_likely_typo(input: &str, target: &str) -> bool {
+    // Quick check: if lengths differ by more than 2, unlikely to be a typo
+    if input.len().abs_diff(target.len()) > 2 {
+        return false;
+    }
+
+    let distance = edit_distance(input, target);
+
+    // Consider it a typo if:
+    // - Distance is 1 (single char difference)
+    // - Distance is 2 and strings are at least 3 chars (for transpositions like "eth" -> "eht")
+    match distance {
+        1 => true,
+        2 => input.len() >= 3 && target.len() >= 3,
+        _ => false,
+    }
+}
+
+/// Calculate edit distance between two strings.
+fn edit_distance(s1: &str, s2: &str) -> usize {


dont think we need this

either the user input is valid, or it's not, no need to check for typos

ok, removed

mattsse · 2025-08-19T12:52:18Z

crates/rpc/rpc-builder/src/lib.rs

+                // Skip Other variants - they should be registered via extend_rpc_modules
+                if matches!(namespace, RethRpcModule::Other(_)) {


I prefer introducing is_other functions than adding matches! for checks like

yep, much beter, done

…ecParser pattern

fgimenez

so perhaps we enforce this either when we do cli::parse or we enforce this in the Nodecommand::run somewhere early

thx, great catch! now this is done after cli parsing, in with_runner_and_components during NodeCommand::run, ptal

fgimenez · 2025-08-19T15:10:15Z

crates/cli/util/src/parsers.rs

+    type ChainSpecParser: reth_cli::chainspec::ChainSpecParser + std::fmt::Debug;
+
+    /// The RPC module validator type.
+    type RpcModuleValidator: reth_rpc_server_types::RpcModuleValidator;


makes sense, moved

fgimenez · 2025-08-19T15:10:44Z

crates/rpc/rpc-builder/src/lib.rs

+                // Skip Other variants - they should be registered via extend_rpc_modules
+                if matches!(namespace, RethRpcModule::Other(_)) {


yep, much beter, done

fgimenez · 2025-08-19T15:18:59Z

crates/rpc/rpc-server-types/src/module.rs

+/// Check if two strings are likely typos using edit distance.
+fn is_likely_typo(input: &str, target: &str) -> bool {
+    // Quick check: if lengths differ by more than 2, unlikely to be a typo
+    if input.len().abs_diff(target.len()) > 2 {
+        return false;
+    }
+
+    let distance = edit_distance(input, target);
+
+    // Consider it a typo if:
+    // - Distance is 1 (single char difference)
+    // - Distance is 2 and strings are at least 3 chars (for transpositions like "eth" -> "eht")
+    match distance {
+        1 => true,
+        2 => input.len() >= 3 && target.len() >= 3,
+        _ => false,
+    }
+}
+
+/// Calculate edit distance between two strings.
+fn edit_distance(s1: &str, s2: &str) -> usize {


ok, removed

mattsse

great, I like this

I'd like for @klkvr to take a look as well before we merge this

since this is breaking we should time merging this appropriately

klkvr · 2025-08-28T11:08:10Z

crates/node/core/src/version.rs

        vergen_build_timestamp: Cow::Owned(env!("VERGEN_BUILD_TIMESTAMP").to_string()),
        vergen_cargo_target_triple: Cow::Owned(env!("VERGEN_CARGO_TARGET_TRIPLE").to_string()),
-        vergen_cargo_features: Cow::Owned(env!("VERGEN_CARGO_FEATURES").to_string()),
+        vergen_cargo_features: Cow::Owned(String::new()),


hmm not sure about this

klkvr · 2025-08-28T11:09:36Z

crates/ethereum/cli/src/interface.rs

 #[command(author, version =version_metadata().short_version.as_ref(), long_version = version_metadata().long_version.as_ref(), about = "Reth", long_about = None)]
-pub struct Cli<C: ChainSpecParser = EthereumChainSpecParser, Ext: clap::Args + fmt::Debug = NoArgs>
-{
+pub struct Cli<P: RethCliParsers = EthereumCliParsers, Ext: clap::Args + fmt::Debug = NoArgs> {


I'm wondering if a less invasive change would be to do Cli<C: ChainSpecParser = EthereumChainSpecParser, Ext: clap::Args + fmt::Debug = NoArgs, R: RpcModuleValidator = DefaultRpcModuleValidator>

That way we won't need to change most of the cli code

fgimenez · 2025-09-08T14:07:01Z

closing in favor of #18160

fgimenez self-assigned this Aug 8, 2025

fgimenez added C-enhancement New feature or request A-rpc Related to the RPC implementation labels Aug 8, 2025

github-project-automation bot added this to Reth Tracker Aug 8, 2025

github-project-automation bot moved this to Backlog in Reth Tracker Aug 8, 2025

fgimenez force-pushed the fgimenez/configurable-rpc-modules branch from 634edcd to 7c0cd10 Compare August 8, 2025 00:31

fgimenez moved this from Backlog to In Review in Reth Tracker Aug 12, 2025

fgimenez marked this pull request as ready for review August 12, 2025 13:58

fgimenez requested review from Rjected, RomanHodulak, gakonst, klkvr, mattsse and onbjerg as code owners August 12, 2025 13:58

fgimenez added the A-sdk Related to reth's use as a library label Aug 12, 2025

fgimenez added 3 commits August 18, 2025 08:21

feat(rpc): add Other(String) variant to RethRpcModule for custom RPC …

9d712bb

…modules

book

7dc76b0

add validation warnings for configured but unregistered RPC modules

c231143

fgimenez force-pushed the fgimenez/configurable-rpc-modules branch from 4c8b6a3 to c231143 Compare August 18, 2025 08:21

mattsse requested changes Aug 18, 2025

View reviewed changes

docs/vocs/docs/pages/cli/reth/node.mdx Outdated Show resolved Hide resolved

crates/rpc/rpc-builder/src/lib.rs Outdated Show resolved Hide resolved

crates/rpc/rpc-builder/src/lib.rs Outdated Show resolved Hide resolved

github-project-automation bot moved this from In Review to In Progress in Reth Tracker Aug 18, 2025

mattsse moved this from In Progress to In Review in Reth Tracker Aug 18, 2025

fgimenez added 4 commits August 18, 2025 16:25

introduce RethCliParsers

68f8abc

exclude other from standard module variant names

3462b40

remove validate_configured_modules

829e7a9

skip Other variant modules in reth_methods instead of creating empty …

ad527ce

…defaults

fgimenez added 3 commits August 18, 2025 17:12

fix wasm

7975200

zepter

f5d43ee

fix typos config

41b3fd2

fgimenez requested a review from DaniPopes as a code owner August 18, 2025 17:25

zepter

9c08aba

mattsse requested changes Aug 19, 2025

View reviewed changes

github-project-automation bot moved this from In Review to In Progress in Reth Tracker Aug 19, 2025

fgimenez added 4 commits August 19, 2025 14:48

validate RPC modules after CLI parsing

658b10f

move validate_selection to RpcModuleValidator trait following ChainSp…

1324f5f

…ecParser pattern

removed typo detection

d03eb12

add RethRpcModule::is_other

77448a7

fgimenez commented Aug 19, 2025

View reviewed changes

mattsse reviewed Aug 21, 2025

View reviewed changes

jenpaff moved this from In Progress to In Review in Reth Tracker Aug 22, 2025

mattsse assigned klkvr Aug 25, 2025

jenpaff unassigned fgimenez Aug 27, 2025

klkvr reviewed Aug 28, 2025

View reviewed changes

klkvr mentioned this pull request Aug 29, 2025

feat: support customizable RPC namespace parsers #18160

Merged

fgimenez closed this Sep 8, 2025

github-project-automation bot moved this from In Review to Done in Reth Tracker Sep 8, 2025

jenpaff moved this from Done to Out of Scope in Reth Tracker Sep 8, 2025

fgimenez deleted the fgimenez/configurable-rpc-modules branch September 8, 2025 16:13

		// Skip Other variants - they should be registered via extend_rpc_modules
		if matches!(namespace, RethRpcModule::Other(_)) {

feat(rpc): add Other(String) variant to RethRpcModule for custom RPC modules #17758

feat(rpc): add Other(String) variant to RethRpcModule for custom RPC modules #17758

Uh oh!

Conversation

fgimenez commented Aug 8, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mattsse left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fgimenez commented Aug 18, 2025

Uh oh!

mattsse left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fgimenez left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mattsse left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fgimenez commented Sep 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fgimenez commented Aug 8, 2025 •

edited

Loading