go: add support for v8 schema

Author: brunotm

go/report/report.go

@@ -8,11 +8,12 @@ import (
 	v2 "github.com/smartcontractkit/data-streams-sdk/go/report/v2"
 	v3 "github.com/smartcontractkit/data-streams-sdk/go/report/v3"
 	v4 "github.com/smartcontractkit/data-streams-sdk/go/report/v4"
+	v8 "github.com/smartcontractkit/data-streams-sdk/go/report/v8"
 )
 
 // Data represents the actual report data and attributes
 type Data interface {
-	v1.Data | v2.Data | v3.Data | v4.Data
+	v1.Data | v2.Data | v3.Data | v4.Data | v8.Data
 	Schema() abi.Arguments
 }
 

go/report/report_test.go

@@ -12,6 +12,7 @@ import (
 	v2 "github.com/smartcontractkit/data-streams-sdk/go/report/v2"
 	v3 "github.com/smartcontractkit/data-streams-sdk/go/report/v3"
 	v4 "github.com/smartcontractkit/data-streams-sdk/go/report/v4"
+	v8 "github.com/smartcontractkit/data-streams-sdk/go/report/v8"
 )
 
 func TestReport(t *testing.T) {
@@ -70,6 +71,20 @@ func TestReport(t *testing.T) {
 	if !reflect.DeepEqual(v4Report, rv4) {
 		t.Errorf("expected: %#v, got: %#v", v4Report, rv4)
 	}
+
+	b, err = schema.Pack(v8Report.ReportContext, v8Report.ReportBlob, v8Report.RawRs, v8Report.RawSs, v8Report.RawVs)
+	if err != nil {
+		t.Errorf("failed to encode report: %s", err)
+	}
+
+	rv8, err := Decode[v8.Data](b)
+	if err != nil {
+		t.Errorf("failed to decode report: %s", err)
+	}
+
+	if !reflect.DeepEqual(v8Report, rv8) {
+		t.Errorf("expected: %#v, got: %#v", v8Report, rv8)
+	}
 }
 
 var v1Report = &Report[v1.Data]{
@@ -108,6 +123,15 @@ var v4Report = &Report[v4.Data]{
 	RawVs:         [32]uint8{00, 01, 10, 74, 67, 29, 24, 17, 12, 18, 22, 11, 69, 11, 63, 86, 12, 86, 23, 58, 13, 53, 29, 12, 17, 10, 17, 12, 63, 27, 12, 14},
 }
 
+var v8Report = &Report[v8.Data]{
+	Data:          v8Data,
+	ReportContext: [3][32]uint8{},
+	ReportBlob:    mustPackData(v8Data),
+	RawRs:         [][32]uint8{{00, 01, 10, 74, 67, 29, 24, 17, 12, 18, 22, 11, 69, 11, 63, 86, 12, 86, 23, 58, 13, 53, 29, 12, 17, 10, 17, 12, 63, 27, 12, 14}},
+	RawSs:         [][32]uint8{{01, 02, 10, 73, 65, 19, 14, 27, 42, 48, 52, 18, 39, 116, 67, 85, 13, 82, 33, 48, 23, 33, 49, 32, 67, 50, 37, 32, 63, 77, 14, 64}},
+	RawVs:         [32]uint8{00, 01, 10, 74, 67, 29, 24, 17, 12, 18, 22, 11, 69, 11, 63, 86, 12, 86, 23, 58, 13, 53, 29, 12, 17, 10, 17, 12, 63, 27, 12, 14},
+}
+
 var v1Data = v1.Data{
 	FeedID:                [32]uint8{00, 01, 107, 74, 167, 229, 124, 167, 182, 138, 225, 191, 69, 101, 63, 86, 182, 86, 253, 58, 163, 53, 239, 127, 174, 105, 107, 102, 63, 27, 132, 114},
 	ObservationsTimestamp: uint32(time.Now().Unix()),
@@ -153,6 +177,18 @@ var v4Data = v4.Data{
 	MarketStatus:          v4.MarketStatusOpen,
 }
 
+var v8Data = v8.Data{
+	FeedID:                [32]uint8{00, 8, 107, 74, 167, 229, 124, 167, 182, 138, 225, 191, 69, 101, 63, 86, 182, 86, 253, 58, 163, 53, 239, 127, 174, 105, 107, 102, 63, 27, 132, 114},
+	ValidFromTimestamp:    uint32(time.Now().Unix()),
+	ObservationsTimestamp: uint32(time.Now().Unix()),
+	NativeFee:             big.NewInt(10),
+	LinkFee:               big.NewInt(10),
+	ExpiresAt:             uint32(time.Now().Unix()) + 100,
+	LastUpdateTimestamp:   uint64(time.Now().UnixNano() - int64(10*time.Second)),
+	MidPrice:              big.NewInt(100),
+	MarketStatus:          1,
+}
+
 func mustPackData(d interface{}) []byte {
 	var args []interface{}
 	var dataSchema abi.Arguments
@@ -207,6 +243,19 @@ func mustPackData(d interface{}) []byte {
 			v.BenchmarkPrice,
 			v.MarketStatus,
 		}
+	case v8.Data:
+		dataSchema = v8.Schema()
+		args = []interface{}{
+			v.FeedID,
+			v.ValidFromTimestamp,
+			v.ObservationsTimestamp,
+			v.NativeFee,
+			v.LinkFee,
+			v.ExpiresAt,
+			v.LastUpdateTimestamp,
+			v.MidPrice,
+			v.MarketStatus,
+		}
 	default:
 		panic(fmt.Sprintf("invalid type to pack: %#v", v))
 	}

go/report/v8/data.go

@@ -0,0 +1,70 @@
+package v8
+
+import (
+	"fmt"
+	"math/big"
+
+	"github.com/ethereum/go-ethereum/accounts/abi"
+	"github.com/smartcontractkit/data-streams-sdk/go/feed"
+)
+
+var schema = Schema()
+
+// Schema returns this data version schema
+func Schema() abi.Arguments {
+	mustNewType := func(t string) abi.Type {
+		result, err := abi.NewType(t, "", []abi.ArgumentMarshaling{})
+		if err != nil {
+			panic(fmt.Sprintf("Unexpected error during abi.NewType: %s", err))
+		}
+		return result
+	}
+	return abi.Arguments([]abi.Argument{
+		{Name: "feedId", Type: mustNewType("bytes32")},
+		{Name: "validFromTimestamp", Type: mustNewType("uint32")},
+		{Name: "observationsTimestamp", Type: mustNewType("uint32")},
+		{Name: "nativeFee", Type: mustNewType("uint192")},
+		{Name: "linkFee", Type: mustNewType("uint192")},
+		{Name: "expiresAt", Type: mustNewType("uint32")},
+		{Name: "lastUpdateTimestamp", Type: mustNewType("uint64")},
+		{Name: "midPrice", Type: mustNewType("int192")},
+		{Name: "marketStatus", Type: mustNewType("uint32")},
+	})
+}
+
+const (
+	MarketStatusUnknown uint32 = iota
+	MarketStatusClosed
+	MarketStatusOpen
+)
+
+// Data is the container for this schema attributes
+type Data struct {
+	FeedID                feed.ID `abi:"feedId"`
+	ObservationsTimestamp uint32
+	MidPrice              *big.Int
+	MarketStatus          uint32
+	LastUpdateTimestamp   uint64
+	ValidFromTimestamp    uint32
+	ExpiresAt             uint32
+	LinkFee               *big.Int
+	NativeFee             *big.Int
+}
+
+// Schema returns this data version schema
+func (Data) Schema() abi.Arguments {
+	return Schema()
+}
+
+// Decode decodes the serialized data bytes
+func Decode(data []byte) (*Data, error) {
+	values, err := schema.Unpack(data)
+	if err != nil {
+		return nil, fmt.Errorf("failed to decode report: %w", err)
+	}
+	decoded := new(Data)
+	if err = schema.Copy(decoded, values); err != nil {
+		return nil, fmt.Errorf("failed to copy report values to struct: %w", err)
+	}
+	return decoded, nil
+}

go/report/v8/data_test.go

@@ -0,0 +1,47 @@
+package v8
+
+import (
+	"math/big"
+	"reflect"
+	"testing"
+	"time"
+)
+
+func TestData(t *testing.T) {
+	r := &Data{
+		FeedID:                [32]uint8{00, 8, 107, 74, 167, 229, 124, 167, 182, 138, 225, 191, 69, 101, 63, 86, 182, 86, 253, 58, 163, 53, 239, 127, 174, 105, 107, 102, 63, 27, 132, 114},
+		ValidFromTimestamp:    uint32(time.Now().Unix()),
+		ObservationsTimestamp: uint32(time.Now().Unix()),
+		NativeFee:             big.NewInt(10),
+		LinkFee:               big.NewInt(10),
+		ExpiresAt:             uint32(time.Now().Unix()) + 100,
+		LastUpdateTimestamp:   uint64(time.Now().UnixNano() - int64(10*time.Second)),
+		MidPrice:              big.NewInt(100),
+		MarketStatus:          MarketStatusOpen,
+	}
+
+	b, err := schema.Pack(
+		r.FeedID,
+		r.ValidFromTimestamp,
+		r.ObservationsTimestamp,
+		r.NativeFee,
+		r.LinkFee,
+		r.ExpiresAt,
+		r.LastUpdateTimestamp,
+		r.MidPrice,
+		r.MarketStatus,
+	)
+
+	if err != nil {
+		t.Errorf("failed to serialize report: %s", err)
+	}
+
+	d, err := Decode(b)
+	if err != nil {
+		t.Errorf("failed to deserialize report: %s", err)
+	}
+
+	if !reflect.DeepEqual(r, d) {
+		t.Errorf("expected: %#v, got %#v", r, d)
+	}
+}