pkg/types/llo/ChannelDefinition: add AllowNilStreamValues (#1900)

aa

Author: brunotm

pkg/types/llo/types.go

@@ -260,6 +260,11 @@ type ChannelDefinition struct {
 	// Streams is the list of streams to be observed and aggregated
 	// by the protocol.
 	Streams []Stream `json:"streams"`
+	// AllowNilStreamValues controls whether channels with nil stream values
+	// are considered reportable.
+	// When true, nil stream values are allowed
+	// and the report codec needs to handle them accordingly.
+	AllowNilStreamValues bool `json:"allowNilStreamValues"`
 	// Opts contains configuration data for use in report generation
 	// for this channel, e.g. feed ID, expiry window, USD base fee etc
 	//
@@ -290,14 +295,21 @@ func (a ChannelDefinition) Equals(b ChannelDefinition) bool {
 	if a.ReportFormat != b.ReportFormat {
 		return false
 	}
+
+	if a.AllowNilStreamValues != b.AllowNilStreamValues {
+		return false
+	}
+
 	if len(a.Streams) != len(b.Streams) {
 		return false
 	}
+
 	for i, strm := range a.Streams {
 		if strm != b.Streams[i] {
 			return false
 		}
 	}
+
 	return bytes.Equal(a.Opts, b.Opts)
 }
 

pkg/types/llo/types_test.go

@@ -19,7 +19,8 @@ func Test_ChannelDefinitions_Serialization(t *testing.T) {
     ],
     "opts": null,
     "tombstone": false,
-	"source": 1
+	"source": 1,
+	"allowNilStreamValues": false
   },
   "1": {
     "reportFormat": "evm_premium_legacy",
@@ -35,7 +36,8 @@ func Test_ChannelDefinitions_Serialization(t *testing.T) {
       "baseUSDFee": "0.1"
     },
     "tombstone": false,
-	"source": 2
+	"source": 2,
+	"allowNilStreamValues": true
   }
 }`
 	var channelDefinitions ChannelDefinitions
@@ -132,6 +134,22 @@ func Test_ChannelDefinition_Equals(t *testing.T) {
 		assert.False(t, a.Equals(b))
 	})
 
+	t.Run("different AllowNilStreamValues", func(t *testing.T) {
+		a := ChannelDefinition{
+			ReportFormat:         ReportFormatJSON,
+			Streams:              []Stream{{0, AggregatorMedian}, {1, AggregatorMode}},
+			Opts:                 nil,
+			AllowNilStreamValues: false,
+		}
+		b := ChannelDefinition{
+			ReportFormat:         ReportFormatJSON,
+			Streams:              []Stream{{0, AggregatorMedian}, {1, AggregatorMode}},
+			Opts:                 nil,
+			AllowNilStreamValues: true,
+		}
+		assert.False(t, a.Equals(b))
+	})
+
 	t.Run("equal", func(t *testing.T) {
 		a := ChannelDefinition{
 			ReportFormat: ReportFormatJSON,
@@ -190,16 +208,18 @@ func Test_ChannelDefinitions_Value(t *testing.T) {
 	t.Run("valid JSON", func(t *testing.T) {
 		c := ChannelDefinitions{
 			0: {
-				ReportFormat: ReportFormatJSON,
-				Streams:      []Stream{{1, AggregatorMedian}, {2, AggregatorMode}},
-				Opts:         nil,
-				Source:       1,
+				ReportFormat:         ReportFormatJSON,
+				Streams:              []Stream{{1, AggregatorMedian}, {2, AggregatorMode}},
+				Opts:                 nil,
+				Source:               1,
+				AllowNilStreamValues: false,
 			},
 			1: {
-				ReportFormat: ReportFormatEVMPremiumLegacy,
-				Streams:      []Stream{{1, AggregatorMedian}, {2, AggregatorMedian}, {3, AggregatorQuote}},
-				Opts:         []byte(`{"baseUSDFee":"0.1","expirationWindow":86400,"feedId":"0x0003aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","multiplier":"1000000000000000000"}`),
-				Source:       2,
+				ReportFormat:         ReportFormatEVMPremiumLegacy,
+				Streams:              []Stream{{1, AggregatorMedian}, {2, AggregatorMedian}, {3, AggregatorQuote}},
+				Opts:                 []byte(`{"baseUSDFee":"0.1","expirationWindow":86400,"feedId":"0x0003aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa","multiplier":"1000000000000000000"}`),
+				Source:               2,
+				AllowNilStreamValues: true,
 			},
 		}
 		v, err := c.Value()
@@ -213,7 +233,8 @@ func Test_ChannelDefinitions_Value(t *testing.T) {
     ],
     "opts": null,
     "tombstone": false,
-	"source": 1
+	"source": 1,
+	"allowNilStreamValues": false
   },
   "1": {
     "reportFormat": "evm_premium_legacy",
@@ -229,7 +250,8 @@ func Test_ChannelDefinitions_Value(t *testing.T) {
       "multiplier": "1000000000000000000"
     },
     "tombstone": false,
-	"source": 2
+	"source": 2,
+	"allowNilStreamValues": true
   }
 }`
 		assert.JSONEq(t, expectedJSON, string(v.([]byte)))