make gatewayConnector into a gRPC service by jinhoonbang · Pull Request #1233 · smartcontractkit/chainlink-common

jinhoonbang · 2025-06-04T10:07:59Z

make gatewayConnector into a gRPC service
move common Gateway code from core for re-use in capabilities repo

https://smartcontract-it.atlassian.net/browse/PRODCRE-409

… in capability repo

Copilot

Pull Request Overview

This PR refactors the gatewayConnector into a gRPC service while extracting common gateway code for reuse in the capabilities repo. Key changes include new proto definitions and generated files for gateway messages, the addition of gRPC client/server implementations for gateway connectors, and updates to capabilities services to integrate the gatewayConnector dependency.

Reviewed Changes

Copilot reviewed 37 out of 37 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
pkg/loop/internal/pb/gatewayconnector/gateway_common.proto	New proto definitions for gateway message types
pkg/loop/internal/core/services/gateway/gateway_connector_handler.go	Implementation of the gateway connector handler client/server
pkg/loop/internal/core/services/gateway/gateway_connector.go	Adds gRPC client and server for gateway connector and integrates AddHandler functionality
pkg/loop/internal/core/services/capability/standard/*	Updates to include a new gatewayConnector dependency in capability initialization flows
pkg/capabilities/*	Updates across capabilities proto and generated files to add the gateway connector parameter
go.mod	Minor dependency updates

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

justinkaseman · 2025-06-11T21:09:51Z

-func (cs *CronServer) Initialise(ctx context.Context, config string, telemetryService core.TelemetryService, store core.KeyValueStore, capabilityRegistry core.CapabilitiesRegistry, errorLog core.ErrorLog, pipelineRunner core.PipelineRunnerService, relayerSet core.RelayerSet, oracleFactory core.OracleFactory) error {
-	if err := cs.CronCapability.Initialise(ctx, config, telemetryService, store, errorLog, pipelineRunner, relayerSet, oracleFactory); err != nil {
+func (cs *CronServer) Initialise(ctx context.Context, config string, telemetryService core.TelemetryService, store core.KeyValueStore, capabilityRegistry core.CapabilitiesRegistry, errorLog core.ErrorLog, pipelineRunner core.PipelineRunnerService, relayerSet core.RelayerSet, oracleFactory core.OracleFactory, gatewayConnector core.GatewayConnector) error {
+	if err := cs.CronCapability.Initialise(ctx, config, telemetryService, store, errorLog, pipelineRunner, relayerSet, oracleFactory, gatewayConnector); err != nil {


This will fail with the current Cron Trigger https://github.com/smartcontractkit/capabilities/blob/main/cron/trigger/trigger.go#L100

will update once this PR is merged

justinkaseman · 2025-06-11T21:11:05Z

 		pipelineRunner core.PipelineRunnerService,
 		relayerSet core.RelayerSet,
 		oracleFactory core.OracleFactory,
+		gatewayConnector core.GatewayConnector,


This change will need to be carried through to each capability. Is there a fast follow planned for that?

yes can update all capabilities after this PR is merged

justinkaseman · 2025-06-11T21:12:51Z

+)
+
+// GatewayConnector is a component run by Nodes to connect to a set of Gateways.
+type GatewayConnector interface {


Is there a ticket already made to track consuming this code shuffle back into core?

draft PR: smartcontractkit/chainlink#17892
ticket : https://smartcontract-it.atlassian.net/browse/PRODCRE-462

bolekk · 2025-06-12T02:27:57Z

+// GatewayConnector is a component run by Nodes to connect to a set of Gateways.
+type GatewayConnector interface {
+	// Start starts the GatewayConnector
+	Start(context.Context) error


I think we don't need Start and Close here. This interface is exposed to capabilities but under the hood there is a singleton object and its lifecycle is managed by core.

I was under the impression that this interface is used in both core and capabilities. Are you suggesting we keep this interface narrow and define a broader interface in core like below? That sounds totally feasible too:

type GatewayConnector interface { services.Service network.ConnectionInitiator core.GatewayConnector // narrow interface defined in chainlink-common for shared functionalities // between core and capabilities repo }

bolekk · 2025-06-12T03:10:11Z

+
+import "google/protobuf/empty.proto";
+
+message MessageBody {


I don't like that the Message struct is duplicated as a proto. It was supposed to be an internal representation. Over the wire we send JSON-RPC-encoded messages. If @DeividasK adds his own version of Message, we would need to duplicate it too.

Another option to consider is to send raw bytes in the gRPC service and decode in the Handler using our own JSON-RPC codec. WDYT? cc @cedric-cordenier

Longer term, when we move to don2don framework for Gateways, we'll be passing raw bytes anyway.

Does that imply that original JSON-RPC from the user will be relayed from the gateway to the DONs as "pass-through"? What if the gateway needs to append some data before sending the request data to the DONs? Sending raw bytes makes sense to me but the underlying message format should allow for wrapping the original request with additional data. Gateway Message format already allows for such flexibility because it has a raw bytes payload field. Thoughts?

Another option to consider is to send raw bytes in the gRPC service and decode in the Handler using our own JSON-RPC codec. WDYT? cc @cedric-cordenier

I agree with this (and in fact that was my understanding of how Deividas was going to refactor things anyway)

bolekk · 2025-06-12T03:10:32Z

+
+message SendMessageRequest {
+  string gateway_id = 1;
+  Message message = 2;


We could put a byte array here (see comment above).

jinhoonbang · 2025-06-12T14:31:11Z

Closing this PR and dividing it into 3 separate ones:

make gatewayConnector into a gRPC service #1256 - make gateway connector into a grpc service. no breaking changes.
move common gateway code from core #1257 - move common gateway code for reuse in capabilities repo. no breaking changes. Unblocks progress in capabilities repo.
add gateway connector to standard capabilities interface #1258 - update standard capabilities interface with gateway connector. Breaking change for chainlink core and capabilities repo

cc @bolekk

jinhoonbang requested review from MStreet3, bolekk and justinkaseman June 4, 2025 10:08

jinhoonbang requested review from a team as code owners June 4, 2025 10:08

jinhoonbang requested a review from Atrax1 June 4, 2025 10:08

jinhoonbang had a problem deploying to integration June 4, 2025 10:08 — with GitHub Actions Error

gateway connector as grpc service. move common gateway code for reuse…

59461ad

… in capability repo

jinhoonbang force-pushed the PRODCRE-409-gateway-connector-as-grpc-service branch from 221b69a to 59461ad Compare June 4, 2025 10:10

jinhoonbang temporarily deployed to integration June 4, 2025 10:11 — with GitHub Actions Inactive

jinhoonbang had a problem deploying to integration June 4, 2025 10:11 — with GitHub Actions Error

jinhoonbang had a problem deploying to integration June 4, 2025 10:11 — with GitHub Actions Failure

jinhoonbang had a problem deploying to integration June 4, 2025 10:15 — with GitHub Actions Error

jinhoonbang had a problem deploying to integration June 4, 2025 10:17 — with GitHub Actions Error

jinhoonbang had a problem deploying to integration June 4, 2025 10:18 — with GitHub Actions Error

jinhoonbang force-pushed the PRODCRE-409-gateway-connector-as-grpc-service branch from a97cdd2 to 59461ad Compare June 4, 2025 10:18

jinhoonbang had a problem deploying to integration June 4, 2025 10:18 — with GitHub Actions Failure

jinhoonbang temporarily deployed to integration June 4, 2025 10:18 — with GitHub Actions Inactive

jinhoonbang requested a review from Copilot June 5, 2025 17:09

Copilot AI reviewed Jun 5, 2025

View reviewed changes

Comment thread pkg/loop/internal/core/services/gateway/gateway_connector.go Outdated

Update pkg/loop/internal/core/services/gateway/gateway_connector.go

45cf774

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

jinhoonbang had a problem deploying to integration June 5, 2025 17:10 — with GitHub Actions Failure

jinhoonbang temporarily deployed to integration June 5, 2025 17:10 — with GitHub Actions Inactive

add mocks

d27dce9

jinhoonbang had a problem deploying to integration June 6, 2025 12:59 — with GitHub Actions Failure

jinhoonbang temporarily deployed to integration June 6, 2025 12:59 — with GitHub Actions Inactive

rename gateway request to outbound http request

5f7deb0

justinkaseman reviewed Jun 11, 2025

View reviewed changes

justinkaseman self-requested a review June 11, 2025 22:10

bolekk reviewed Jun 12, 2025

View reviewed changes

jinhoonbang mentioned this pull request Jun 12, 2025

implement HTTP action capability without deduplication smartcontractkit/capabilities#111

Merged

jinhoonbang closed this Jun 12, 2025

jinhoonbang requested a review from bolekk June 13, 2025 09:21

Uh oh!

Conversation

jinhoonbang commented Jun 4, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

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!

Choose a reason for hiding this comment

Uh oh!

jinhoonbang Jun 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

Uh oh!

Uh oh!

Uh oh!

jinhoonbang commented Jun 12, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

jinhoonbang Jun 12, 2025 •

edited

Loading