-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add a ReportCodec implementation that uses the generic Codec, fallbac…
…k to using the current specific ReportCodec if the generic codec is not provided
- Loading branch information
Showing
6 changed files
with
286 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,48 @@ | ||
| package median | ||
|
|
||
| import ( | ||
| "cmp" | ||
| "math/big" | ||
| "slices" | ||
| "sort" | ||
|
|
||
| "github.com/smartcontractkit/libocr/commontypes" | ||
| "github.com/smartcontractkit/libocr/offchainreporting2/reportingplugin/median" | ||
| ) | ||
|
|
||
| type aggregatedAttributedObservation struct { | ||
| Timestamp uint32 | ||
| Observers [32]commontypes.OracleID | ||
| Observations []*big.Int | ||
| JuelsPerFeeCoin *big.Int | ||
| } | ||
|
|
||
| func aggregate(observations []median.ParsedAttributedObservation) *aggregatedAttributedObservation { | ||
| // defensive copy | ||
| n := len(observations) | ||
| observations = append([]median.ParsedAttributedObservation{}, observations...) | ||
|
|
||
| aggregated := &aggregatedAttributedObservation{Observations: make([]*big.Int, len(observations))} | ||
|
|
||
| slices.SortFunc(observations, func(a, b median.ParsedAttributedObservation) int { | ||
| return cmp.Compare(a.Timestamp, b.Timestamp) | ||
| }) | ||
| aggregated.Timestamp = observations[n/2].Timestamp | ||
|
|
||
| // get median juelsPerFeeCoin | ||
| sort.Slice(observations, func(i, j int) bool { | ||
| return observations[i].JuelsPerFeeCoin.Cmp(observations[j].JuelsPerFeeCoin) < 0 | ||
| }) | ||
| aggregated.JuelsPerFeeCoin = observations[n/2].JuelsPerFeeCoin | ||
|
|
||
| // sort by values | ||
| sort.Slice(observations, func(i, j int) bool { | ||
| return observations[i].Value.Cmp(observations[j].Value) < 0 | ||
| }) | ||
|
|
||
| for i, o := range observations { | ||
| aggregated.Observers[i] = o.Observer | ||
| aggregated.Observations[i] = o.Value | ||
| } | ||
| return aggregated | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| package median | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "math/big" | ||
|
|
||
| "github.com/smartcontractkit/chainlink-common/pkg/types" | ||
| "github.com/smartcontractkit/libocr/offchainreporting2/reportingplugin/median" | ||
| ocrtypes "github.com/smartcontractkit/libocr/offchainreporting2plus/types" | ||
| ) | ||
|
|
||
| const typeName = "MedianReport" | ||
|
|
||
| func newReportCodec(codec types.Codec) (median.ReportCodec, error) { | ||
| if codec == nil { | ||
| return nil, errors.New("codec cannot be nil") | ||
| } | ||
| return &reportCodec{codec: codec}, nil | ||
| } | ||
|
|
||
| type reportCodec struct { | ||
| codec types.Codec | ||
| } | ||
|
|
||
| var _ median.ReportCodec = reportCodec{} | ||
|
|
||
| func (r reportCodec) BuildReport(observations []median.ParsedAttributedObservation) (ocrtypes.Report, error) { | ||
| agg := aggregate(observations) | ||
| return r.codec.Encode(context.Background(), agg, typeName) | ||
| } | ||
|
|
||
| func (r reportCodec) MedianFromReport(report ocrtypes.Report) (*big.Int, error) { | ||
| agg := &aggregatedAttributedObservation{} | ||
| if err := r.codec.Decode(context.Background(), report, agg, typeName); err != nil { | ||
| return nil, err | ||
| } | ||
| medianObservation := len(agg.Observations) / 2 | ||
| return agg.Observations[medianObservation], nil | ||
| } | ||
|
|
||
| func (r reportCodec) MaxReportLength(n int) (int, error) { | ||
| return r.codec.GetMaxDecodingSize(context.Background(), n, typeName) | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,170 @@ | ||
| package median | ||
|
|
||
| import ( | ||
| "context" | ||
| "errors" | ||
| "math/big" | ||
| "testing" | ||
|
|
||
| "github.com/smartcontractkit/libocr/commontypes" | ||
| "github.com/smartcontractkit/libocr/offchainreporting2/reportingplugin/median" | ||
| "github.com/smartcontractkit/libocr/offchainreporting2plus/types" | ||
| "github.com/stretchr/testify/assert" | ||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func TestReportCodec(t *testing.T) { | ||
| anyReports := []median.ParsedAttributedObservation{ | ||
| { | ||
| Timestamp: 123, | ||
| Value: big.NewInt(300), | ||
| JuelsPerFeeCoin: big.NewInt(100), | ||
| Observer: 0, | ||
| }, | ||
| { | ||
| Timestamp: 125, | ||
| Value: big.NewInt(200), | ||
| JuelsPerFeeCoin: big.NewInt(110), | ||
| Observer: 1, | ||
| }, | ||
| { | ||
| Timestamp: 124, | ||
| Value: big.NewInt(250), | ||
| JuelsPerFeeCoin: big.NewInt(90), | ||
| Observer: 2, | ||
| }, | ||
| } | ||
|
|
||
| aggReports := aggregatedAttributedObservation{ | ||
| Timestamp: 124, | ||
| Observers: [32]commontypes.OracleID{1, 2, 0}, | ||
| Observations: []*big.Int{ | ||
| big.NewInt(200), | ||
| big.NewInt(250), | ||
| big.NewInt(300), | ||
| }, | ||
| JuelsPerFeeCoin: big.NewInt(100), | ||
| } | ||
|
|
||
| anyEncodedReport := []byte{5, 6, 7, 8} | ||
|
|
||
| anyError := errors.New("nope not today") | ||
|
|
||
| t.Run("newReportCodec returns error if codec is nil", func(t *testing.T) { | ||
| _, err := newReportCodec(nil) | ||
| assert.Error(t, err) | ||
| }) | ||
|
|
||
| t.Run("BuildReport builds the type and delegates to generic codec", func(t *testing.T) { | ||
| reportCodec, err := newReportCodec(&testCodec{ | ||
| t: t, | ||
| expected: &aggReports, | ||
| result: anyEncodedReport, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| encoded, err := reportCodec.BuildReport(anyReports) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, types.Report(anyEncodedReport), encoded) | ||
| }) | ||
|
|
||
| t.Run("BuildReport returns error if codec returns error", func(t *testing.T) { | ||
| reportCodec, err := newReportCodec(&testCodec{ | ||
| t: t, | ||
| expected: &aggReports, | ||
| result: anyEncodedReport, | ||
| err: anyError, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| _, err = reportCodec.BuildReport(anyReports) | ||
| assert.Equal(t, anyError, err) | ||
| }) | ||
|
|
||
| t.Run("MedianFromReport delegates to codec and gets the median", func(t *testing.T) { | ||
| reportCodec, err := newReportCodec(&testCodec{ | ||
| t: t, | ||
| expected: anyEncodedReport, | ||
| result: aggReports, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| medianVal, err := reportCodec.MedianFromReport(anyEncodedReport) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, big.NewInt(250), medianVal) | ||
| }) | ||
|
|
||
| t.Run("MedianFromReport returns error if codec returns error", func(t *testing.T) { | ||
| reportCodec, err := newReportCodec(&testCodec{ | ||
| t: t, | ||
| expected: anyEncodedReport, | ||
| result: aggReports, | ||
| err: anyError, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| _, err = reportCodec.MedianFromReport(anyEncodedReport) | ||
| assert.Equal(t, anyError, err) | ||
| }) | ||
|
|
||
| anyN := 10 | ||
| anyLen := 200 | ||
| t.Run("MaxReportLength delegates to codec", func(t *testing.T) { | ||
| reportCodec, err := newReportCodec(&testCodec{ | ||
| t: t, | ||
| expected: anyN, | ||
| result: anyLen, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| length, err := reportCodec.MaxReportLength(anyN) | ||
| require.NoError(t, err) | ||
| assert.Equal(t, anyLen, length) | ||
| }) | ||
|
|
||
| t.Run("MaxReportLength returns error if codec returns error", func(t *testing.T) { | ||
| reportCodec, err := newReportCodec(&testCodec{ | ||
| t: t, | ||
| expected: 10, | ||
| result: anyLen, | ||
| err: anyError, | ||
| }) | ||
| require.NoError(t, err) | ||
|
|
||
| _, err = reportCodec.MaxReportLength(10) | ||
| assert.Equal(t, anyError, err) | ||
| }) | ||
| } | ||
|
|
||
| type testCodec struct { | ||
| t *testing.T | ||
| expected any | ||
| result any | ||
| err error | ||
| } | ||
|
|
||
| func (t *testCodec) Encode(_ context.Context, item any, itemType string) ([]byte, error) { | ||
| assert.Equal(t.t, t.expected, item) | ||
| assert.Equal(t.t, typeName, itemType) | ||
| return t.result.([]byte), t.err | ||
| } | ||
|
|
||
| func (t *testCodec) GetMaxEncodingSize(_ context.Context, n int, itemType string) (int, error) { | ||
| assert.Equal(t.t, t.expected, n) | ||
| assert.Equal(t.t, typeName, itemType) | ||
| return t.result.(int), t.err | ||
| } | ||
|
|
||
| func (t *testCodec) Decode(_ context.Context, raw []byte, into any, itemType string) error { | ||
| assert.Equal(t.t, t.expected, raw) | ||
| assert.Equal(t.t, typeName, itemType) | ||
| set := into.(*aggregatedAttributedObservation) | ||
| *set = t.result.(aggregatedAttributedObservation) | ||
| return t.err | ||
| } | ||
|
|
||
| func (t *testCodec) GetMaxDecodingSize(_ context.Context, n int, itemType string) (int, error) { | ||
| assert.Equal(t.t, t.expected, n) | ||
| assert.Equal(t.t, typeName, itemType) | ||
| return t.result.(int), t.err | ||
| } |