Add more documentation and move ExternalAdapter interface to core/securemint

Author: cll-gg

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

@@ -13,15 +13,15 @@ import (
 	"github.com/smartcontractkit/chainlink-common/pkg/types/core"
 )
 
-var _ core.ExternalAdapter = (*externalAdapterClient)(nil)
-
 // externalAdapterClient is a protobuf client that implements the core.ExternalAdapter interface.
 // It's basically a wrapper around the protobuf external adapter client so that it can be used as a core.ExternalAdapter.
 type externalAdapterClient struct {
 	lggr logger.Logger
 	grpc pb.ExternalAdapterClient
 }
 
+var _ core.ExternalAdapter = (*externalAdapterClient)(nil)
+
 func newExternalAdapterClient(lggr logger.Logger, cc grpc.ClientConnInterface) *externalAdapterClient {
 	return &externalAdapterClient{lggr: logger.Named(lggr, "ExternalAdapterClient"), grpc: pb.NewExternalAdapterClient(cc)}
 }
@@ -92,7 +92,6 @@ func newExternalAdapterServer(lggr logger.Logger, impl core.ExternalAdapter) *ex
 	return &externalAdapterServer{lggr: logger.Named(lggr, "ExternalAdapterServer"), impl: impl}
 }
 
-// TODO(gg): add unit tests for this
 func (d *externalAdapterServer) GetPayload(ctx context.Context, request *pb.Blocks) (*pb.ExternalAdapterPayload, error) {
 	d.lggr.Infof("GetPayload request pb server: %+v", request)
 

pkg/types/core/secure_mint_interface.go

@@ -2,11 +2,10 @@ package core
 
 import (
 	"context"
-	"math/big"
-	"time"
 
 	"github.com/smartcontractkit/chainlink-common/pkg/logger"
 	"github.com/smartcontractkit/chainlink-common/pkg/services"
+	"github.com/smartcontractkit/chainlink-common/pkg/types/core/securemint"
 	"github.com/smartcontractkit/libocr/offchainreporting2plus/ocr3types"
 )
 
@@ -16,40 +15,7 @@ const PluginSecureMintName = "securemint"
 type PluginSecureMint interface {
 	services.Service
 	// NewSecureMintFactory returns a ReportingPluginFactory for the secure mint plugin.
-	NewSecureMintFactory(ctx context.Context, lggr logger.Logger, externalAdapter ExternalAdapter) (ReportingPluginFactory[ChainSelector], error)
-}
-
-// ExternalAdapter is an alias for por.ExternalAdapter
-// TODO(gg): maybe move all por types that are used by the client (core node) to cl-common?
-// TODO(gg): Otherwise add godoc to all below types.
-// TODO(gg): should we put this under core/secure_mint? Or rename to SecureMintExternalAdapter? `core.ExternalAdapter` seems too broad for what it's doing.
-type ExternalAdapter interface {
-	GetPayload(ctx context.Context, blocks Blocks) (ExternalAdapterPayload, error)
-}
-
-type BlockNumber uint64
-
-type ChainSelector uint64
-
-type Blocks map[ChainSelector]BlockNumber
-
-type BlockMintablePair struct {
-	Block    BlockNumber
-	Mintable *big.Int
-}
-
-type Mintables map[ChainSelector]BlockMintablePair
-
-type ReserveInfo struct {
-	ReserveAmount *big.Int
-	Timestamp     time.Time
-}
-
-type ExternalAdapterPayload struct {
-	Mintables   Mintables   // The mintable amounts for each chain and its block.
-	ReserveInfo ReserveInfo // The latest reserve amount and timestamp used to calculate the minting allowance above.
-
-	LatestBlocks Blocks // The latest blocks for each chain.
+	NewSecureMintFactory(ctx context.Context, lggr logger.Logger, externalAdapter securemint.ExternalAdapter) (ReportingPluginFactory[securemint.ChainSelector], error)
 }
 
 // ReportingPluginFactory wraps ocr3types.ReportingPluginFactory[RI] to add a Service to it.

pkg/types/core/securemint/dependencies.go

@@ -0,0 +1,44 @@
+package securemint
+
+import (
+	"context"
+	"math/big"
+	"time"
+)
+
+// ExternalAdapter is an alias for por.ExternalAdapter
+// TODO(gg): maybe move all por types that are used by the client (core node) to cl-common?
+
+// ExternalAdapter is the component used by the secure mint plugin to request various secure mint related data points.
+type ExternalAdapter interface {
+	GetPayload(ctx context.Context, blocks Blocks) (ExternalAdapterPayload, error)
+}
+
+type BlockNumber uint64
+
+type ChainSelector uint64
+
+// Blocks contains the latest blocks per chain selector.
+type Blocks map[ChainSelector]BlockNumber
+
+// BlockMintablePair is a mintable amount at a certain block number.
+type BlockMintablePair struct {
+	Block    BlockNumber
+	Mintable *big.Int
+}
+
+type Mintables map[ChainSelector]BlockMintablePair
+
+// ReserveInfo is a reserve amount at a certain timestamp.
+type ReserveInfo struct {
+	ReserveAmount *big.Int
+	Timestamp     time.Time
+}
+
+// ExternalAdapterPayload is the response from an EA containing various secure mint related data points.
+type ExternalAdapterPayload struct {
+	Mintables   Mintables   // The mintable amounts for each chain and its block.
+	ReserveInfo ReserveInfo // The latest reserve amount and timestamp used to calculate the minting allowance above.
+
+	LatestBlocks Blocks // The latest blocks for each chain.
+}