Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Check if observations sorted before taking median #169

Merged
merged 1 commit into from
Oct 20, 2022
Merged

Check if observations sorted before taking median #169

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 22 additions & 9 deletions relayer/pkg/chainlink/ocr2/medianreport/report.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,7 @@ func (c ReportCodec) MedianFromReport(report types.Report) (*big.Int, error) {
return nil, errors.New("invalid report length")
}

// Decode the number of observations
numBig := junotypes.BytesToFelt(report[(timestampSizeBytes + observersSizeBytes):prefixSizeBytes]).Big()
if !numBig.IsUint64() {
return nil, errors.New("length of observations is invalid")
Expand All @@ -102,22 +103,34 @@ func (c ReportCodec) MedianFromReport(report types.Report) (*big.Int, error) {
return nil, errors.New("length of observations is invalid")
}

// Check if the report is big enough
n := int(n64)

if rLen < prefixSizeBytes+(observationSizeBytes*n)+juelsPerFeeCoinSizeBytes {
return nil, errors.New("report does not contain enough observations or is missing juels/feeCoin observation")
expectedLen := prefixSizeBytes + (observationSizeBytes * n) + juelsPerFeeCoinSizeBytes
if rLen < expectedLen {
return nil, errors.New("invalid report length, missing main or juelsPerFeeCoin observations")
}

var observations []*big.Int
// Decode observations
var oo []*big.Int
for i := 0; i < n; i++ {
start := prefixSizeBytes + observationSizeBytes*i
end := start + observationSizeBytes
o := junotypes.BytesToFelt(report[start:end]).Big()
o = starknet.FeltToSignedBig(&caigotypes.Felt{Int: o})
observations = append(observations, o)
o := starknet.FeltToSignedBig(&caigotypes.Felt{
Int: junotypes.BytesToFelt(report[start:end]).Big(),
})
oo = append(oo, o)
}

// Check if the report contains sorted observations
_less := func(i, j int) bool {
return oo[i].Cmp(oo[j]) < 0
}
sorted := sort.SliceIsSorted(oo, _less)
if !sorted {
return nil, errors.New("observations not sorted")
Comment on lines +124 to +130
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test case? otherwise, this looks great!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, but it's more involved than adding a simple test case (BuildReport always sorts, custom fuzzer could be built) so I'll defer to this GitHub Issue for now: #171

}

return observations[n/2], nil
return oo[n/2], nil
}

func (c ReportCodec) MaxReportLength(n int) int {
Expand All @@ -127,7 +140,7 @@ func (c ReportCodec) MaxReportLength(n int) int {
func SplitReport(report types.Report) ([][]byte, error) {
chunkSize := junotypes.FeltLength
if len(report)%chunkSize != 0 {
return [][]byte{}, errors.New("invalid length of the report")
return [][]byte{}, errors.New("invalid report length")
}

// order is guaranteed by buildReport:
Expand Down