[RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type by commoddity · Pull Request #1633 · pokt-network/poktroll

commoddity · 2025-07-03T19:49:12Z

🌿 Summary

Enhances the Relay Miner to dynamically route incoming requests to different backend URLs based on the RPC type specified in the request header, enabling greater flexibility in handling protocol-specific relays.

NOTE: This PR specifically intends to be backward-compatible by introducing RPC-type specific service configs in addition to the default service config.

This means the YAML structure of the Relay Miner config is unchanged so the new functionality may be added in addition to existing configs but does not require NRs to change their config structure.

🌱 Primary Changes:

Introduced support for multiple service configurations within a single supplier via new rpc_type_service_configs YAML field.
Modified proxy request handling logic to route requests by inspecting the RPC-Type header and selecting the corresponding service configuration.
Added RPCType enum with validation logic to support known RPC types (e.g., json_rpc, rest).

🍃 Secondary changes:

Refactored config structures to distinguish between ServiceConfig and RPCTypeServiceConfigs.
Updated tests to validate new config parsing and proxy behavior under varied RPC-type scenarios.
Renamed usages of ServiceConfig to ServiceConfig across the codebase for alignment.

🛠️ Type of change

Select one or more from the following:

New feature, functionality or library

🤯 Sanity Checklist

I have updated the GitHub Issue 'assignees', 'reviewers', 'labels', 'project', 'iteration' and 'milestone'
For code, I have run 'make test_all'
I added TODOs where applicable

…vice configs for different RPC types

red-0ne

Great addition!

Thanks for keeping the config backward compatible.

Uniqueness of the RPC configs is guaranteed 👍

Left a few comments but no major blockers.

…n establishment

Olshansk

Biggest issue I see right now is the fact that we're changing configs, not updating docs, and some naming discrepencies.

…poktroll into rpc-type-backend-selection

…ction

…rpc-type-backend-selection

…network/poktroll into rpc-type-backend-selection

Olshansk

Posted a fair number of changes, but we're close!

Should be g2g after this round.

Olshansk

@commoddity I'm publishing a partial (early) review to make sure one of the comments gets out early.

Will keep reviewing.

Squash and merging into 1633.

Olshansk

@commoddity I squashed and merged my review here: #1669

LGTM otherwise. Let's merge it in!

* pokt/main: (34 commits) [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633) [Morse Recovery] Added new addresses for recovery (#1667) [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666) [Foundation] Remove `pulsar` (#1661) [RelayMiner] Add timeout support and improved logging to query clients (#1657) [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658) [Testing] Fixing flaky unit tests to make CI more reliable (#1662) [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660) [Morse Recovery] Add recovery addresses for issue #1654 (#1656) Refactor Tiltfile structure and enhance Pocketdex support. (#1640) [Morse Recovery] Updated Recovery Allowlist (#1651) [RelayMiner] Improve SafeReadBody concurrency safety by copying buffer data (#1650) Add a configurable max body size parameter to RelayMiner configuration. (#1566) Update upgrade_tx_v0.1.25_alpha.json feat: Improve relay request unmarshaling error handling and logging (#1649) [Docs] v0.1.25/26 upgrage artifacts (#1648) Remove settlement result from `EventClaimSettled` in `v0.127` release. (#1647) Revert "feat: Remove settlement result from EventClaimSettled" (#1643) [Code Health] Fix linter issues & attempt to fix flaky tests (#1646) Updating config-path-x.yaml with: schema header, owned app for config-path-1 ...

* pokt/chore/ibc: fix: TODOs fix: onchain upgrade [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633) [Morse Recovery] Added new addresses for recovery (#1667) [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666) [Foundation] Remove `pulsar` (#1661) [RelayMiner] Add timeout support and improved logging to query clients (#1657) [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658) [Testing] Fixing flaky unit tests to make CI more reliable (#1662) [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660) [Morse Recovery] Add recovery addresses for issue #1654 (#1656) First review

* chore/localnet/tilt: (88 commits) [Disk Utilization] refactor: remove unnecessary Msg.*Response fields (#1670) [RelayMiner] Bump SMT version (#1675) [IBC] Prepare pocket for IBC connectivity (#1262) fix: TODOs fix: onchain upgrade [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633) [Morse Recovery] Added new addresses for recovery (#1667) [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666) [Foundation] Remove `pulsar` (#1661) [RelayMiner] Add timeout support and improved logging to query clients (#1657) [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658) [Testing] Fixing flaky unit tests to make CI more reliable (#1662) [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660) [Morse Recovery] Add recovery addresses for issue #1654 (#1656) fixup! upgrade fixup! upgrade revertme: testing fixup! upgrade Refactor Tiltfile structure and enhance Pocketdex support. (#1640) [Morse Recovery] Updated Recovery Allowlist (#1651) ...

* chore/ibc-axelar: (92 commits) [Disk Utilization] refactor: remove unnecessary Msg.*Response fields (#1670) [RelayMiner] Bump SMT version (#1675) [IBC] Prepare pocket for IBC connectivity (#1262) fix: TODOs fix: onchain upgrade [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633) [Morse Recovery] Added new addresses for recovery (#1667) [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666) [Foundation] Remove `pulsar` (#1661) [RelayMiner] Add timeout support and improved logging to query clients (#1657) [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658) [Testing] Fixing flaky unit tests to make CI more reliable (#1662) [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660) [Morse Recovery] Add recovery addresses for issue #1654 (#1656) fixup! upgrade fixup! upgrade revertme: testing fixup! upgrade Refactor Tiltfile structure and enhance Pocketdex support. (#1640) [Morse Recovery] Updated Recovery Allowlist (#1651) ...

* chore/ibc-axelar: (88 commits) [Disk Utilization] refactor: remove unnecessary Msg.*Response fields (#1670) [RelayMiner] Bump SMT version (#1675) [IBC] Prepare pocket for IBC connectivity (#1262) fix: TODOs fix: onchain upgrade [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type (#1633) [Morse Recovery] Added new addresses for recovery (#1667) [DOCS][SERVICE] Adding danger for Grove employees on mainnet service creation (#1666) [Foundation] Remove `pulsar` (#1661) [RelayMiner] Add timeout support and improved logging to query clients (#1657) [RelayMiner] Replace buffer copying with explicit cleanup pattern in SafeReadBody (#1658) [Testing] Fixing flaky unit tests to make CI more reliable (#1662) [Scripts] Notes, events and queries to query `block` events and `tx` events (#1660) [Morse Recovery] Add recovery addresses for issue #1654 (#1656) fixup! upgrade fixup! upgrade revertme: testing fixup! upgrade Refactor Tiltfile structure and enhance Pocketdex support. (#1640) [Morse Recovery] Updated Recovery Allowlist (#1651) ...

feat: implement the ability for the relay miner to store multiple ser…

c074049

…vice configs for different RPC types

commoddity requested review from Olshansk, bryanchriswhite and red-0ne July 3, 2025 19:49

commoddity self-assigned this Jul 3, 2025

commoddity added the relayminer Changes related to the Relayminer label Jul 3, 2025

commoddity added this to Shannon Jul 3, 2025

github-project-automation Bot moved this to 📋 Backlog in Shannon Jul 3, 2025

commoddity added this to the RelayMiner Stability & Profitability milestone Jul 3, 2025

commoddity mentioned this pull request Jul 3, 2025

[SUPPLIER][RELAYMINER][SERVICE][DISCUSSION] Multiple services vs multiple endpoints for more complex use cases #1579

Closed

3 tasks

Olshansk moved this from 📋 Backlog to 🏗 In progress in Shannon Jul 6, 2025

red-0ne reviewed Jul 8, 2025

View reviewed changes

Pascal van Leeuwen added 5 commits July 8, 2025 20:12

chore: merge conflicts

4a85653

ping all configs, not only default config

6982691

add log and websocket rpc type

cebc6e7

fix: implement review comments

830aeb3

use rpc type header set to websocket to determine websocket connectio…

6e6e462

…n establishment

commoddity marked this pull request as ready for review July 8, 2025 19:46

commoddity requested review from red-0ne July 8, 2025 19:47

commoddity changed the title ~~[WIP][RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type~~ [RelayMiner] feat: relay miner routes to multiple backend URLs based on RPC Type Jul 8, 2025

Olshansk requested changes Jul 9, 2025

View reviewed changes

github-project-automation Bot moved this from 🏗 In progress to 👀 In review in Shannon Jul 9, 2025

Pascal van Leeuwen added 7 commits July 9, 2025 13:43

move service config selection logic to its own method

82ccb09

fix: implement review comments

55ce904

fix: implement review comments

f9e04f1

fix: implement review comments

23028e8

remove redundant error return from getServiceConfig

b47a91c

improve logs for service config type

5ba3a5a

improve log type for service config

df7aec2

Pascal van Leeuwen and others added 5 commits July 9, 2025 15:27

update config to work from yaml string

a2b9089

Merge branch 'main' into rpc-type-backend-selection

0f1720a

Merge branch 'main' into rpc-type-backend-selection

b9eab6e

add support for hybrid rpc type

a2503c3

Merge branch 'rpc-type-backend-selection' of github.com:pokt-network/…

471fe19

…poktroll into rpc-type-backend-selection

github-actions Bot added the consensus-breaking IMPORTANT! If the PR with this tag is merged, next release WILL HAVE TO BE an upgrade. label Jul 10, 2025

HarukaMa and others added 4 commits July 10, 2025 21:11

add websocket as possible backend for supplier

bb18178

Merge remote-tracking branch 'origin/main' into rpc-type-backend-sele…

ee1e13c

…ction

Merge branch 'main' of https://github.com/pokt-network/poktroll into …

0a625e4

…rpc-type-backend-selection

Merge branch 'rpc-type-backend-selection' of https://github.com/pokt-…

b539d31

…network/poktroll into rpc-type-backend-selection

Olshansk requested changes Jul 10, 2025

View reviewed changes

commoddity and others added 5 commits July 11, 2025 11:15

Merge branch 'main' into rpc-type-backend-selection

639c92f

fix: implement review comments

646594b

fix: implement review comments

53347f4

fix: implement review comments

9d70a35

fix: implement review comments

e5cf059

commoddity requested a review from Olshansk July 11, 2025 15:22

Olshansk requested changes Jul 11, 2025

View reviewed changes

Olshansk added 2 commits July 11, 2025 17:10

Merge branch 'main' into rpc-type-backend-selection

9aedd5f

[Review] Review of #1633 (#1669)

af01a44

Squash and merging into 1633.

Olshansk self-requested a review July 13, 2025 22:36

Olshansk approved these changes Jul 13, 2025

View reviewed changes

Merge branch 'main' into rpc-type-backend-selection

437ecc0

commoddity merged commit fab8a5d into main Jul 14, 2025
11 checks passed

github-project-automation Bot moved this from 👀 In review to ✅ Done in Shannon Jul 14, 2025

Conversation

commoddity commented Jul 3, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🌿 Summary

🌱 Primary Changes:

🍃 Secondary changes:

🛠️ Type of change

🤯 Sanity Checklist

Uh oh!

red-0ne left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Olshansk left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

commoddity commented Jul 3, 2025 •

edited

Loading