Updated relayer ccip provider interface to use dedicated args (#1497)

Author: amit-momin

pkg/loop/internal/pb/relayer.pb.go

@@ -50,12 +50,18 @@ message RelayArgs {
   string providerType = 6;
 }
 
-// RelayArgs represents [github.com/smartcontractkit/chainlink-common/pkg/types.PluginArgs].
+// PluginArgs represents [github.com/smartcontractkit/chainlink-common/pkg/types.PluginArgs].
 message PluginArgs {
   string transmitterID = 1;
   bytes pluginConfig = 2;
 }
 
+message CCIPProviderArgs {
+  bytes externalJobID = 1; // [32]byte
+  bytes contractReaderConfig = 2;
+  bytes chainWriterConfig = 3;
+}
+
 // NewContractWriterRequest has request parameters for [github.com/smartcontractkit/chainlink-common/pkg/loop.Relayer.NewContractWriter].
 message NewContractWriterRequest {
     bytes contractWriterConfig = 1;
@@ -99,7 +105,7 @@ message NewConfigProviderReply {
 
 // NewCCIPProviderRequest has arguments for [github.com/smartcontractkit/chainlink-common/pkg/loop.Relayer.NewCCIPProvider].
 message NewCCIPProviderRequest {
-  RelayArgs relayArgs = 1;
+  CCIPProviderArgs ccipProviderArgs = 1;
 }
 
 // NewCCIPProviderReply has return arguments for [github.com/smartcontractkit/chainlink-common/pkg/loop.Relayer.NewCCIPProvider].

pkg/loop/internal/pb/relayer.proto

@@ -288,16 +288,13 @@ func (r *relayerClient) NewLLOProvider(ctx context.Context, rargs types.RelayArg
 	return nil, fmt.Errorf("llo provider not supported: %w", errors.ErrUnsupported)
 }
 
-func (r *relayerClient) NewCCIPProvider(ctx context.Context, rargs types.RelayArgs) (types.CCIPProvider, error) {
+func (r *relayerClient) NewCCIPProvider(ctx context.Context, rargs types.CCIPProviderArgs) (types.CCIPProvider, error) {
 	cc := r.NewClientConn("CCIPProvider", func(ctx context.Context) (uint32, net.Resources, error) {
 		reply, err := r.relayer.NewCCIPProvider(ctx, &pb.NewCCIPProviderRequest{
-			RelayArgs: &pb.RelayArgs{
+			CcipProviderArgs: &pb.CCIPProviderArgs{
 				ExternalJobID: rargs.ExternalJobID[:],
-				JobID:         rargs.JobID,
-				ContractID:    rargs.ContractID,
-				New:           rargs.New,
-				RelayConfig:   rargs.RelayConfig,
-				ProviderType:  rargs.ProviderType,
+				ContractReaderConfig: rargs.ContractReaderConfig,
+				ChainWriterConfig: rargs.ChainWriterConfig,
 			},
 		})
 		if err != nil {
@@ -717,22 +714,19 @@ func (r *relayerServer) newCommitProvider(ctx context.Context, relayArgs types.R
 }
 
 func (r *relayerServer) NewCCIPProvider(ctx context.Context, request *pb.NewCCIPProviderRequest) (*pb.NewCCIPProviderReply, error) {
-	rargs := request.RelayArgs
+	rargs := request.CcipProviderArgs
 
 	exJobID, err := uuid.FromBytes(rargs.ExternalJobID)
 	if err != nil {
 		return nil, fmt.Errorf("invalid uuid bytes for ExternalJobID: %w", err)
 	}
-	relayArgs := types.RelayArgs{
+	ccipProviderArgs := types.CCIPProviderArgs{
 		ExternalJobID: exJobID,
-		JobID:         rargs.JobID,
-		ContractID:    rargs.ContractID,
-		New:           rargs.New,
-		RelayConfig:   rargs.RelayConfig,
-		ProviderType:  rargs.ProviderType,
+		ContractReaderConfig: rargs.ContractReaderConfig,
+		ChainWriterConfig: rargs.ChainWriterConfig,
 	}
 
-	provider, err := r.impl.NewCCIPProvider(ctx, relayArgs)
+	provider, err := r.impl.NewCCIPProvider(ctx, ccipProviderArgs)
 	if err != nil {
 		return nil, err
 	}

pkg/loop/internal/relayer/relayer.go

@@ -7,6 +7,7 @@ import (
 	"fmt"
 	"math/big"
 	"reflect"
+	"slices"
 	"testing"
 
 	"github.com/google/uuid"
@@ -72,6 +73,7 @@ type staticRelayerConfig struct {
 	relayArgs              types.RelayArgs
 	pluginArgs             types.PluginArgs
 	contractReaderConfig   []byte
+	chainWriterConfig      []byte
 	medianProvider         testtypes.MedianProviderTester
 	agnosticProvider       testtypes.PluginProviderTester
 	mercuryProvider        mercurytest.MercuryProviderTester
@@ -96,6 +98,7 @@ func newStaticRelayerConfig(lggr logger.Logger, staticChecks bool) staticRelayer
 		relayArgs:              RelayArgs,
 		pluginArgs:             PluginArgs,
 		contractReaderConfig:   []byte("test"),
+		chainWriterConfig:      []byte("chainwriterconfig"),
 		medianProvider:         mediantest.MedianProvider(lggr),
 		mercuryProvider:        mercurytest.MercuryProvider(lggr),
 		executionProvider:      cciptest.ExecutionProvider(lggr),
@@ -306,8 +309,13 @@ func (s staticRelayer) NewLLOProvider(ctx context.Context, r types.RelayArgs, p
 	return nil, errors.New("not implemented")
 }
 
-func (s staticRelayer) NewCCIPProvider(ctx context.Context, r types.RelayArgs) (types.CCIPProvider, error) {
-	if s.StaticChecks && !equalRelayArgs(r, s.relayArgs) {
+func (s staticRelayer) NewCCIPProvider(ctx context.Context, r types.CCIPProviderArgs) (types.CCIPProvider, error) {
+	ccipProviderArgs := types.CCIPProviderArgs {
+		ExternalJobID: s.relayArgs.ExternalJobID,
+		ContractReaderConfig: s.contractReaderConfig,
+		ChainWriterConfig: s.chainWriterConfig,
+	}
+	if s.StaticChecks && !equalCCIPProviderArgs(r, ccipProviderArgs) {
 		return nil, fmt.Errorf("expected relay args:\n\t%v\nbut got:\n\t%v", s.relayArgs, r)
 	}
 	return ccipocr3test.CCIPProvider(logger.Nop()), nil
@@ -459,6 +467,12 @@ func equalRelayArgs(a, b types.RelayArgs) bool {
 		bytes.Equal(a.RelayConfig, b.RelayConfig)
 }
 
+func equalCCIPProviderArgs(a, b types.CCIPProviderArgs) bool {
+	return a.ExternalJobID == b.ExternalJobID &&
+		slices.Equal(a.ContractReaderConfig, b.ContractReaderConfig) &&
+		slices.Equal(a.ChainWriterConfig, b.ChainWriterConfig)
+}
+
 func newRelayArgsWithProviderType(_type types.OCR2PluginType) types.RelayArgs {
 	return types.RelayArgs{
 		ExternalJobID: RelayArgs.ExternalJobID,

pkg/loop/internal/relayer/test/relayer.go

@@ -58,7 +58,7 @@ type Relayer interface {
 	NewConfigProvider(context.Context, types.RelayArgs) (types.ConfigProvider, error)
 	NewPluginProvider(context.Context, types.RelayArgs, types.PluginArgs) (types.PluginProvider, error)
 	NewLLOProvider(context.Context, types.RelayArgs, types.PluginArgs) (types.LLOProvider, error)
-	NewCCIPProvider(context.Context, types.RelayArgs) (types.CCIPProvider, error)
+	NewCCIPProvider(context.Context, types.CCIPProviderArgs) (types.CCIPProvider, error)
 }
 
 // Keystore This interface contains all the keystore GRPC functionality, keystore.Keystore is meant to be exposed to consumers and the keystore.Management interface in exposed only to the core node

pkg/loop/internal/types/types.go

@@ -85,7 +85,7 @@ func (r *RelayerService) NewLLOProvider(ctx context.Context, rargs types.RelayAr
 	return r.Service.NewLLOProvider(ctx, rargs, pargs)
 }
 
-func (r *RelayerService) NewCCIPProvider(ctx context.Context, rargs types.RelayArgs) (types.CCIPProvider, error) {
+func (r *RelayerService) NewCCIPProvider(ctx context.Context, rargs types.CCIPProviderArgs) (types.CCIPProvider, error) {
 	if err := r.WaitCtx(ctx); err != nil {
 		return nil, err
 	}

pkg/loop/mocks/relayer.go

@@ -3,6 +3,7 @@ package types
 import (
 	"context"
 
+	"github.com/google/uuid"
 	"github.com/smartcontractkit/chainlink-common/pkg/services"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/ccip"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/ccipocr3"
@@ -53,3 +54,11 @@ type CCIPProvider interface {
 	ContractTransmitter() ocr3types.ContractTransmitter[[]byte]
 	Codec() ccipocr3.Codec
 }
+
+// CCIPProviderArgs are the args required to create a CCIP Provider through a Relayer.
+// The are common to all relayer implementations.
+type CCIPProviderArgs struct {
+	ExternalJobID        uuid.UUID 
+	ContractReaderConfig []byte
+	ChainWriterConfig    []byte
+}

pkg/loop/relayer_service.go

@@ -255,7 +255,7 @@ type Relayer interface {
 
 	NewOCR3CapabilityProvider(ctx context.Context, rargs RelayArgs, pargs PluginArgs) (OCR3CapabilityProvider, error)
 
-	NewCCIPProvider(ctx context.Context, rargs RelayArgs) (CCIPProvider, error)
+	NewCCIPProvider(ctx context.Context, rargs CCIPProviderArgs) (CCIPProvider, error)
 }
 
 var _ Relayer = &UnimplementedRelayer{}
@@ -366,6 +366,6 @@ func (u *UnimplementedRelayer) NewOCR3CapabilityProvider(ctx context.Context, ra
 	return nil, status.Errorf(codes.Unimplemented, "method NewOCR3CapabilityProvider not implemented")
 }
 
-func (u *UnimplementedRelayer) NewCCIPProvider(ctx context.Context, rargs RelayArgs) (CCIPProvider, error) {
+func (u *UnimplementedRelayer) NewCCIPProvider(ctx context.Context, rargs CCIPProviderArgs) (CCIPProvider, error) {
 	return nil, status.Errorf(codes.Unimplemented, "method NewCCIPProvider not implemented")
 }