Move securemint.Report from plugin repo to cl-common

Author: cll-gg

pkg/capabilities/consensus/ocr3/datafeeds/securemint_aggregator.go

@@ -12,7 +12,6 @@ import (
 
 	chainselectors "github.com/smartcontractkit/chain-selectors"
 	ocrcommon "github.com/smartcontractkit/libocr/commontypes"
-	ocr2types "github.com/smartcontractkit/libocr/offchainreporting2/types"
 	ocr3types "github.com/smartcontractkit/libocr/offchainreporting2plus/ocr3types"
 
 	"github.com/smartcontractkit/chainlink-common/pkg/capabilities"
@@ -61,17 +60,8 @@ const (
 	SolDataIDOutputFieldName        = SolanaEncoderKey("dataId")
 )
 
-// secureMintReport represents the inner report structure, mimics the Report type in the SM plugin repo
-// TODO(gg): move this from chainlink-secure-mint to cl-common?
-type secureMintReport struct {
-	ConfigDigest ocr2types.ConfigDigest `json:"configDigest"`
-	SeqNr        uint64                 `json:"seqNr"`
-	Block        uint64                 `json:"block"`
-	Mintable     *big.Int               `json:"mintable"`
-}
-
 type wrappedMintReport struct {
-	Report               secureMintReport        `json:"report"`
+	Report               securemint.Report       `json:"report"`
 	SolanaAccountContext solana.AccountMetaSlice `json:"solanaAccountContext,omitempty"`
 }
 
@@ -112,7 +102,7 @@ type evmReportFormatter struct {
 
 func (f *evmReportFormatter) packReport(lggr logger.Logger, wreport *wrappedMintReport) (*values.Map, error) {
 	report := wreport.Report
-	smReportAsAnswer, err := packSecureMintReportIntoUint224ForEVM(report.Mintable, report.Block)
+	smReportAsAnswer, err := packSecureMintReportIntoUint224ForEVM(report.Mintable, uint64(report.Block))
 	if err != nil {
 		return nil, fmt.Errorf("failed to pack secure mint report for evm into uint224: %w", err)
 	}
@@ -151,7 +141,7 @@ type solanaReportFormatter struct {
 func (f *solanaReportFormatter) packReport(lggr logger.Logger, wreport *wrappedMintReport) (*values.Map, error) {
 	report := wreport.Report
 	// pack answer
-	smReportAsAnswer, err := packSecureMintReportIntoU128ForSolana(report.Mintable, report.Block)
+	smReportAsAnswer, err := packSecureMintReportIntoU128ForSolana(report.Mintable, uint64(report.Block))
 	if err != nil {
 		return nil, fmt.Errorf("failed to pack secure mint report for solana into u128: %w", err)
 	}
@@ -335,9 +325,9 @@ func (a *SecureMintAggregator) extractAndValidateReports(lggr logger.Logger, obs
 			foundMatchingChainSelector = true
 
 			// Deserialize the inner secureMintReport
-			var innerReport secureMintReport
+			var innerReport securemint.Report
 			if err := json.Unmarshal(reportWithInfo.Report, &innerReport); err != nil {
-				lggr.Errorw("failed to unmarshal secureMintReport", "err", err)
+				lggr.Errorw("failed to unmarshal securemint.Report", "err", err)
 				continue
 			}
 			report := &wrappedMintReport{

pkg/capabilities/consensus/ocr3/datafeeds/securemint_aggregator_test.go

@@ -115,7 +115,7 @@ func TestSecureMintAggregator_Aggregate(t *testing.T) {
 				{
 					chainSelector: ethSepoliaChainSelector,
 					seqNr:         10,
-					report: &secureMintReport{
+					report: &securemint.Report{
 						ConfigDigest: ocr2types.ConfigDigest{0: 1, 31: 2},
 						SeqNr:        10,
 						Block:        1000,
@@ -125,7 +125,7 @@ func TestSecureMintAggregator_Aggregate(t *testing.T) {
 				{
 					chainSelector: bnbTestnetChainSelector,
 					seqNr:         10,
-					report: &secureMintReport{
+					report: &securemint.Report{
 						ConfigDigest: ocr2types.ConfigDigest{0: 2, 31: 3},
 						SeqNr:        10,
 						Block:        1100,
@@ -147,7 +147,7 @@ func TestSecureMintAggregator_Aggregate(t *testing.T) {
 				{
 					chainSelector: bnbTestnetChainSelector,
 					seqNr:         10,
-					report: &secureMintReport{
+					report: &securemint.Report{
 						ConfigDigest: ocr2types.ConfigDigest{0: 1, 31: 2},
 						SeqNr:        10,
 						Block:        1000,
@@ -180,7 +180,7 @@ func TestSecureMintAggregator_Aggregate(t *testing.T) {
 				{
 					chainSelector: solDevnetChainSelector,
 					seqNr:         10,
-					report: &secureMintReport{
+					report: &securemint.Report{
 						ConfigDigest: ocr2types.ConfigDigest{0: 1, 31: 2},
 						SeqNr:        10,
 						Block:        1000,
@@ -191,7 +191,7 @@ func TestSecureMintAggregator_Aggregate(t *testing.T) {
 				{
 					chainSelector: bnbTestnetChainSelector,
 					seqNr:         10,
-					report: &secureMintReport{
+					report: &securemint.Report{
 						ConfigDigest: ocr2types.ConfigDigest{0: 2, 31: 3},
 						SeqNr:        10,
 						Block:        1100,
@@ -377,7 +377,7 @@ func TestSecureMintAggregatorConfig_Validation(t *testing.T) {
 type ocrTriggerEventData struct {
 	chainSelector securemint.ChainSelector
 	seqNr         uint64
-	report        *secureMintReport
+	report        *securemint.Report
 	accCtx        solana.AccountMetaSlice
 }
 
@@ -431,7 +431,7 @@ func createSecureMintObservations(t *testing.T, events []ocrTriggerEventData) ma
 	return observations
 }
 
-func createReportBytes(t *testing.T, report *secureMintReport) []byte {
+func createReportBytes(t *testing.T, report *securemint.Report) []byte {
 	reportBytes, err := json.Marshal(report)
 	require.NoError(t, err)
 	return reportBytes

pkg/types/core/securemint/types.go

@@ -4,8 +4,23 @@ import (
 	"context"
 	"math/big"
 	"time"
+
+	"github.com/smartcontractkit/libocr/offchainreporting2/types"
 )
 
+// Report is the report that's created by the secure mint plugin.
+// It contains a mintable token amount at a certain block number for a specific chain.
+type Report struct {
+	ConfigDigest types.ConfigDigest
+	SeqNr        uint64
+	Block        BlockNumber
+	Mintable     *big.Int
+
+	// The following fields might be useful in the future, but are not currently used
+	// ReserveAmount *big.Int
+	// ReserveTimestamp time.Time
+}
+
 // 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)