feat: implement extended commands for relay cli by natanasow · Pull Request #5188 · hiero-ledger/hiero-json-rpc-relay

natanasow · 2026-03-30T07:49:44Z

Description

Implement the following CLI options:

--json-pretty-print-enable - true/false
--rpc-http-enabled - true/false - RELAY_RPC_HTTP_ENABLED
--rpc-ws-enabled - true/false - RELAY_RPC_WS_ENABLED
--rpc-http-api - RELAY_RPC_HTTP_API what subdomain (ETH, DEBUG, ADMIN, TRACE are enabled)
-- rpc-ws-api - RELAY_RPC_WS_API what subdomain (ETH, DEBUG, ADMIN, TRACE are enabled)

Related issue(s)

Fixes #5132

Testing Guide

Changes from original design (optional)

N/A

Additional work needed (optional)

N/A

Checklist

I've assigned an assignee to this PR and related issue(s) (if applicable)
I've assigned a label to this PR and related issue(s) (if applicable)
I've assigned a milestone to this PR and related issue(s) (if applicable)
I've updated documentation (code comments, README, etc. if applicable)
I've done sufficient testing (unit, integration, etc.)

Signed-off-by: nikolay <n.atanasow94@gmail.com>

…mplement-extended-commands-for-relay-cli # Conflicts: # bin/hiero-relay.js

Signed-off-by: nikolay <n.atanasow94@gmail.com>

codacy-production · 2026-04-01T05:46:33Z

Up to standards ✅

🟢 Issues 0 issues

Results:
0 new issues

View in Codacy

🟢 Metrics 0 complexity · 0 duplication

Metric Results

Complexity 0

Duplication 0

View in Codacy

_{TIP This summary will be updated as you push new changes. Give us feedback}

…mplement-extended-commands-for-relay-cli # Conflicts: # bin/hiero-relay.js

Signed-off-by: nikolay <n.atanasow94@gmail.com>

…mplement-extended-commands-for-relay-cli

jasuwienas

Looks great overall, I just have a few suggestions/questions.

bin/hiero-relay.js

bin/hiero-relay.md

src/server/koaJsonRpc/index.ts

bin/hiero-relay.js

BartoszSolkaBD · 2026-04-02T07:24:25Z

bin/hiero-relay.md

+**Start relay with both http and ws servers with specific subdomains**
+
+```bash
+hiero-relay -n testnet -r --rpc-ws-enabled true --rpc-http-api eth net debug --rpc-ws-api web3


I'm unable to make it work locally.

I'm running the relay with -n testnet -r --rpc-http-api eth commands, but I'am still able to query debug_getRawTransaction

I DMed you, but I'll drop it here for visibility to other reviewers.

Make sure you delete your local .standalone, then run npm run build && node scripts/build-standalone.js before testing these extended options.

Signed-off-by: nikolay <n.atanasow94@gmail.com>

quiet-node

Clean work but some concerns

quiet-node · 2026-04-07T19:29:38Z

src/ws-server/controllers/jsonRpcController.ts


+  const subdomain = method.split('_')[0] ?? null;
+  if (!RELAY_RPC_WS_API.has(subdomain)) {
+    return jsonRespError(null, spec.MethodNotFound(subdomain), requestDetails.requestId);
+  }
+


This subdomain check calls method.split('_') before validateJsonRpcRequest runs. If a WS client sends a request without a method field, method is undefined and this throws a TypeError. Would it make sense to move the subdomain check after validateJsonRpcRequest (which already guards against missing/invalid method fields) to avoid the crash.

quiet-node · 2026-04-07T19:35:37Z

src/server/koaJsonRpc/index.ts

+    const subdomain = request.method.split('_')[0] ?? null;
+    if (!RELAY_RPC_HTTP_API.has(subdomain)) {
+      return jsonRespError(request.id, spec.MethodNotFound(subdomain), requestId);
+    }
+
    try {


spec.MethodNotFound(subdomain) in this logic for both HTTP and WS passes only the subdomain prefix (e.g., "eth") instead of the full method name (e.g., "eth_call"). This produces misleading errors like "Method eth not found". The existing verifySupportedMethod path correctly uses request.method. I think we should use request.method here too for consistency

quiet-node · 2026-04-07T19:37:09Z

src/ws-server/controllers/jsonRpcController.ts


+  const subdomain = method.split('_')[0] ?? null;
+  if (!RELAY_RPC_WS_API.has(subdomain)) {
+    return jsonRespError(null, spec.MethodNotFound(subdomain), requestDetails.requestId);


This hardcodes null as the response ID. Every other jsonRespError call in this file uses request.id || null, and the HTTP equivalent correctly uses request.id. Per JSON-RPC 2.0 spec, the error response must echo the request's id for client correlation. Let's change it to request.id || null to be compliant

quiet-node · 2026-04-07T19:45:15Z

bin/hiero-relay.md

+**Start relay with ws server only:**
+
+```bash
+hiero-relay -n testnet -r --rpc-http-enabled false --rpc-ws-enabled


Correct me if I'm wrong but but yargs boolean options don't seem to work this way. It parses as the flag being present (true) plus a positional arg "false".

So with yargs type: 'boolean', --rpc-http-enabled false parses as:

argv['rpc-http-enabled'] = true (the flag is present, so true)

argv._ = ['false'] (false becomes a positional argument)

To disable a boolean flag in yargs, users must use --no-rpc-http-enabled. The documented example won't disable the HTTP server as intended, and the validation guard becomes unreachable when following the docs. Can you double check and make sure?

quiet-node · 2026-04-07T19:47:16Z

src/config-service/services/globalConfig.ts

+  RELAY_RPC_HTTP_API: {
+    type: 'strArray',
+    required: false,
+    defaultValue: ['eth', 'debug', 'net', 'web3', 'txpool', 'trace', 'admin'],
+  },
+  RELAY_RPC_WS_API: {
+    type: 'strArray',
+    required: false,
+    defaultValue: ['eth', 'debug', 'net', 'web3', 'txpool', 'trace', 'admin'],
+  },
  REQUEST_ID_IS_OPTIONAL: {


Nit: This new config keysuse a RELAY_ prefix, but the related keys RPC_HTTP_ENABLED / RPC_WS_ENABLED from PR #5074 don't. Since these are all part of the same RPC transport feature family, could we align the naming? Dropping the RELAY_ prefix (RPC_HTTP_API, RPC_WS_API) would be consistent and non-breaking.

quiet-node · 2026-04-07T19:50:17Z

bin/hiero-relay.js

+        if (!argv['rpc-http-enabled'] && !argv['rpc-ws-enabled']) {
+          parser.showHelp();
+          console.log('\nError: At least one transport must be enabled (--rpc-http-enabled or --rpc-ws-enabled)');
+          return;
+        }
        const readOnlyEnvs = CliHelper.populateEnvBaseOnReadOnlyOption(argv);


This transport validation guard here is placed after the --config-file early return. Users who start the relay with -c ./my.env where both transports are disabled get no CLI warning then the child process spawns and only fails at runtime via logger.fatal. Would it make sense to parse the .env file and checking transport config before spawning, so both paths give the same immediate feedback.

chore: add extended commands

bad6268

Signed-off-by: nikolay <n.atanasow94@gmail.com>

natanasow added this to the 0.77.0 milestone Mar 30, 2026

natanasow self-assigned this Mar 30, 2026

natanasow added the enhancement New feature or request label Mar 30, 2026

natanasow changed the base branch from main to 5131-implement-base-commands-for-relay-cli March 30, 2026 07:49

natanasow added 2 commits March 30, 2026 11:35

Merge branch '5131-implement-base-commands-for-relay-cli' into 5132-i…

3bad14e

…mplement-extended-commands-for-relay-cli # Conflicts: # bin/hiero-relay.js

chore: add http/ws apis envs

04f80c6

Signed-off-by: nikolay <n.atanasow94@gmail.com>

Merge branch '5131-implement-base-commands-for-relay-cli' into 5132-i…

c5b9821

…mplement-extended-commands-for-relay-cli # Conflicts: # bin/hiero-relay.js

jasuwienas mentioned this pull request Apr 1, 2026

feat: allow user to pick server that should be started (#4797) [breaking change] #4798

Closed

5 tasks

chore: add docs

5c05dcd

Signed-off-by: nikolay <n.atanasow94@gmail.com>

natanasow marked this pull request as ready for review April 1, 2026 12:28

natanasow requested review from a team as code owners April 1, 2026 12:28

natanasow requested a review from konstantinabl April 1, 2026 12:29

chore: add example

5253302

Signed-off-by: nikolay <n.atanasow94@gmail.com>

natanasow requested a review from BartoszSolkaBD April 1, 2026 12:38

Merge branch '5131-implement-base-commands-for-relay-cli' into 5132-i…

c8e7dfe

…mplement-extended-commands-for-relay-cli

jasuwienas reviewed Apr 2, 2026

View reviewed changes

bin/hiero-relay.js Outdated Show resolved Hide resolved

bin/hiero-relay.md Outdated Show resolved Hide resolved

src/server/koaJsonRpc/index.ts Outdated Show resolved Hide resolved

BartoszSolkaBD suggested changes Apr 2, 2026

View reviewed changes

natanasow added 3 commits April 2, 2026 11:56

chore: fix path

a8361b6

Signed-off-by: nikolay <n.atanasow94@gmail.com>

chore: fix imports

25004b7

Signed-off-by: nikolay <n.atanasow94@gmail.com>

chore: resolve comments

2a393f7

Signed-off-by: nikolay <n.atanasow94@gmail.com>

natanasow requested a review from jasuwienas April 2, 2026 13:46

chore: resolve comments

1c27e9f

Signed-off-by: nikolay <n.atanasow94@gmail.com>

BartoszSolkaBD approved these changes Apr 3, 2026

View reviewed changes

quiet-node reviewed Apr 7, 2026

View reviewed changes

Conversation

natanasow commented Mar 30, 2026

Description

Related issue(s)

Testing Guide

Changes from original design (optional)

Additional work needed (optional)

Checklist

Uh oh!

codacy-production bot commented Apr 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Up to standards ✅

Uh oh!

jasuwienas left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

quiet-node 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codacy-production bot commented Apr 1, 2026 •

edited

Loading