Add more comments and move adapters around + rename

Author: cll-gg

pkg/loop/internal/reportingplugin/securemint/pb_client.go

@@ -14,8 +14,6 @@ import (
 	"github.com/smartcontractkit/chainlink-common/pkg/types/core"
 )
 
-var _ core.PluginSecureMint = (*PluginSecureMintClient)(nil)
-
 // PluginSecureMintClient is a client that runs on the core node to connect to the SecureMint LOOP server.
 type PluginSecureMintClient struct {
 	// hashicorp plugin client
@@ -26,6 +24,8 @@ type PluginSecureMintClient struct {
 	reportingPluginService pb.ReportingPluginServiceClient
 }
 
+var _ core.PluginSecureMint = (*PluginSecureMintClient)(nil)
+
 func NewPluginSecureMintClient(brokerCfg net.BrokerConfig) *PluginSecureMintClient {
 	brokerCfg.Logger = logger.Named(brokerCfg.Logger, "PluginSecureMintClient")
 	pc := goplugin.NewPluginClient(brokerCfg)
@@ -72,7 +72,7 @@ func (c *PluginSecureMintClient) NewSecureMintFactory(
 		return reply.ID, deps, nil
 	})
 
-	return &ocr3ReportingPluginFactoryAdapter{
+	return &ocr3ReportingPluginFactoryBytesToChainSelectorAdapter{
 		ocr3.NewReportingPluginFactoryClient(c.BrokerExt, cc), // protobuf client
 	}, nil
 }

pkg/loop/internal/reportingplugin/securemint/pb_server.go

@@ -11,23 +11,26 @@ import (
 	"github.com/smartcontractkit/chainlink-common/pkg/loop/internal/pb"
 	ocr3pb "github.com/smartcontractkit/chainlink-common/pkg/loop/internal/pb/ocr3"
 	"github.com/smartcontractkit/chainlink-common/pkg/types/core"
-	"github.com/smartcontractkit/libocr/offchainreporting2plus/ocr3types"
 )
 
-var _ pb.ReportingPluginServiceServer = (*pluginSecureMintServer)(nil)
-
+// pluginSecureMintServer is the protobuf server that runs on the loopp plugin side to handle requests from the core node.
 type pluginSecureMintServer struct {
 	pb.UnimplementedReportingPluginServiceServer
 
 	*net.BrokerExt
 	impl core.PluginSecureMint
 }
 
+var _ pb.ReportingPluginServiceServer = (*pluginSecureMintServer)(nil)
+
+// NewValidationService is not implemented for the secure mint plugin.
 func (m *pluginSecureMintServer) NewValidationService(ctx context.Context, request *pb.ValidationServiceRequest) (*pb.ValidationServiceResponse, error) {
 	m.Logger.Infof("NewValidationService called, not implemented")
 	return &pb.ValidationServiceResponse{}, nil
 }
 
+// NewReportingPluginFactory is called by the core node to create a new reporting plugin factory.
+// It delegates to the NewSecureMintFactory function in the plugin implementation.
 func (m *pluginSecureMintServer) NewReportingPluginFactory(ctx context.Context, request *pb.NewReportingPluginFactoryRequest) (*pb.NewReportingPluginFactoryReply, error) {
 	m.Logger.Infof("NewReportingPluginFactory called, delegating to impl.NewSecureMintFactory")
 
@@ -55,6 +58,7 @@ func (m *pluginSecureMintServer) NewReportingPluginFactory(ctx context.Context,
 	return &pb.NewReportingPluginFactoryReply{ID: id}, nil
 }
 
+// RegisterPluginSecureMintServer registers the plugin server with the given broker and broker config so that it can be called by the protobuf client.
 func RegisterPluginSecureMintServer(server *grpc.Server, broker net.Broker, brokerCfg net.BrokerConfig, impl core.PluginSecureMint) error {
 	pb.RegisterServiceServer(server, &goplugin.ServiceServer{Srv: impl})
 	pb.RegisterReportingPluginServiceServer(server, newPluginSecureMintServer(&net.BrokerExt{Broker: broker, BrokerConfig: brokerCfg}, impl))
@@ -64,18 +68,3 @@ func RegisterPluginSecureMintServer(server *grpc.Server, broker net.Broker, brok
 func newPluginSecureMintServer(b *net.BrokerExt, gp core.PluginSecureMint) *pluginSecureMintServer {
 	return &pluginSecureMintServer{BrokerExt: b.WithName("PluginSecureMintServer"), impl: gp}
 }
-
-var _ ocr3types.ReportingPluginFactory[[]byte] = (*reportingPluginFactoryChainSelectorToBytesAdapter)(nil)
-
-// reportingPluginFactoryChainSelectorToBytesAdapter is a wrapper around the ReportingPluginFactory to implement ocr3types.ReportingPluginFactory[[]byte]
-type reportingPluginFactoryChainSelectorToBytesAdapter struct {
-	ocr3types.ReportingPluginFactory[core.ChainSelector]
-}
-
-func (r *reportingPluginFactoryChainSelectorToBytesAdapter) NewReportingPlugin(ctx context.Context, config ocr3types.ReportingPluginConfig) (ocr3types.ReportingPlugin[[]byte], ocr3types.ReportingPluginInfo, error) {
-	plugin, info, err := r.ReportingPluginFactory.NewReportingPlugin(ctx, config)
-	if err != nil {
-		return nil, ocr3types.ReportingPluginInfo{}, err
-	}
-	return &reportingPluginChainSelectorToBytesAdapter{plugin: plugin}, info, nil
-}

pkg/loop/internal/reportingplugin/securemint/reportingplugin_adapter.go

@@ -10,14 +10,14 @@ import (
 	"github.com/smartcontractkit/libocr/offchainreporting2plus/types"
 )
 
-// ocr3ReportingPluginFactoryAdapter wraps a core.OCR3ReportingPluginFactory to implement ReportingPluginFactory[core.ChainSelector]
-type ocr3ReportingPluginFactoryAdapter struct {
+// ocr3ReportingPluginFactoryBytesToChainSelectorAdapter wraps a core.OCR3ReportingPluginFactory to implement ReportingPluginFactory[core.ChainSelector]
+type ocr3ReportingPluginFactoryBytesToChainSelectorAdapter struct {
 	core.OCR3ReportingPluginFactory
 }
 
-func (a *ocr3ReportingPluginFactoryAdapter) NewReportingPlugin(ctx context.Context, config ocr3types.ReportingPluginConfig) (ocr3types.ReportingPlugin[core.ChainSelector], ocr3types.ReportingPluginInfo, error) {
-	// The core.OCR3ReportingPluginFactory works with []byte, but we need to return core.ChainSelector
-	// We'll need to convert between the types here
+var _ ocr3types.ReportingPluginFactory[core.ChainSelector] = (*ocr3ReportingPluginFactoryBytesToChainSelectorAdapter)(nil)
+
+func (a *ocr3ReportingPluginFactoryBytesToChainSelectorAdapter) NewReportingPlugin(ctx context.Context, config ocr3types.ReportingPluginConfig) (ocr3types.ReportingPlugin[core.ChainSelector], ocr3types.ReportingPluginInfo, error) {
 	plugin, info, err := a.OCR3ReportingPluginFactory.NewReportingPlugin(ctx, config)
 	if err != nil {
 		return nil, ocr3types.ReportingPluginInfo{}, err
@@ -33,6 +33,8 @@ type reportingPluginBytesToChainSelectorAdapter struct {
 	plugin ocr3types.ReportingPlugin[[]byte]
 }
 
+var _ ocr3types.ReportingPlugin[core.ChainSelector] = (*reportingPluginBytesToChainSelectorAdapter)(nil)
+
 func (r *reportingPluginBytesToChainSelectorAdapter) Query(ctx context.Context, outctx ocr3types.OutcomeContext) (types.Query, error) {
 	return r.plugin.Query(ctx, outctx)
 }
@@ -113,11 +115,28 @@ func (r *reportingPluginBytesToChainSelectorAdapter) Close() error {
 	return r.plugin.Close()
 }
 
+// reportingPluginFactoryChainSelectorToBytesAdapter wraps a ReportingPluginFactory[core.ChainSelector] to implement ocr3types.ReportingPluginFactory[[]byte]
+type reportingPluginFactoryChainSelectorToBytesAdapter struct {
+	ocr3types.ReportingPluginFactory[core.ChainSelector]
+}
+
+var _ ocr3types.ReportingPluginFactory[[]byte] = (*reportingPluginFactoryChainSelectorToBytesAdapter)(nil)
+
+func (r *reportingPluginFactoryChainSelectorToBytesAdapter) NewReportingPlugin(ctx context.Context, config ocr3types.ReportingPluginConfig) (ocr3types.ReportingPlugin[[]byte], ocr3types.ReportingPluginInfo, error) {
+	plugin, info, err := r.ReportingPluginFactory.NewReportingPlugin(ctx, config)
+	if err != nil {
+		return nil, ocr3types.ReportingPluginInfo{}, err
+	}
+	return &reportingPluginChainSelectorToBytesAdapter{plugin: plugin}, info, nil
+}
+
 // reportingPluginChainSelectorToBytesAdapter wraps a ReportingPlugin[core.ChainSelector] to implement ReportingPlugin[[]byte]
 type reportingPluginChainSelectorToBytesAdapter struct {
 	plugin ocr3types.ReportingPlugin[core.ChainSelector]
 }
 
+var _ ocr3types.ReportingPlugin[[]byte] = (*reportingPluginChainSelectorToBytesAdapter)(nil)
+
 func (r *reportingPluginChainSelectorToBytesAdapter) Query(ctx context.Context, outctx ocr3types.OutcomeContext) (types.Query, error) {
 	return r.plugin.Query(ctx, outctx)
 }

pkg/loop/internal/reportingplugin/securemint/reportingplugin_adapter_test.go

@@ -14,8 +14,6 @@ import (
 	"github.com/smartcontractkit/libocr/offchainreporting2plus/types"
 )
 
-// TODO(gg): add other unit tests where possible
-
 func TestReportingPluginBytesToChainSelectorAdapter_Reports(t *testing.T) {
 	tests := []struct {
 		name          string