feat(parachain): Add CollationProtocol VaryingDataType

lib/parachain/collation_protocol.go

@@ -0,0 +1,98 @@
+package parachain
+
+import (
+	"github.com/ChainSafe/gossamer/lib/common"
+	"github.com/ChainSafe/gossamer/pkg/scale"
+)
+
+// CollationProtocol represents all network messages on the collation peer-set.
+type CollationProtocol scale.VaryingDataType
+
+// NewCollationProtocol returns a new collation protocol varying data type
+func NewCollationProtocol() CollationProtocol {
+	vdt := scale.MustNewVaryingDataType(NewCollatorProtocolMessage())
+	return CollationProtocol(vdt)
+}
+
+// Set will set a value using the underlying  varying data type
+func (c *CollationProtocol) Set(val scale.VaryingDataTypeValue) (err error) {
+	vdt := scale.VaryingDataType(*c)
+	err = vdt.Set(val)
+	if err != nil {
+		return
+	}
+	*c = CollationProtocol(vdt)
+	return
+}
+
+// Value returns the value from the underlying varying data type
+func (c *CollationProtocol) Value() (val scale.VaryingDataTypeValue, err error) {
+	vdt := scale.VaryingDataType(*c)
+	return vdt.Value()
+}
+
+// CollatorProtocolMessage represents Network messages used by the collator protocol subsystem
+type CollatorProtocolMessage scale.VaryingDataType
+
+// Index returns the index of varying data type
+func (CollatorProtocolMessage) Index() uint {
+	return 0
+}
+
+// NewCollatorProtocolMessage returns a new collator protocol message varying data type
+func NewCollatorProtocolMessage() CollatorProtocolMessage {
+	vdt := scale.MustNewVaryingDataType(Declare{}, AdvertiseCollation{}, CollationSeconded{})
+	return CollatorProtocolMessage(vdt)
+}
+
+// Set will set a value using the underlying  varying data type
+func (c *CollatorProtocolMessage) Set(val scale.VaryingDataTypeValue) (err error) {
+	vdt := scale.VaryingDataType(*c)
+	err = vdt.Set(val)
+	if err != nil {
+		return
+	}
+	*c = CollatorProtocolMessage(vdt)
+	return
+}
+
+// Value returns the value from the underlying varying data type
+func (c *CollatorProtocolMessage) Value() (val scale.VaryingDataTypeValue, err error) {
+	vdt := scale.VaryingDataType(*c)
+	return vdt.Value()
+}
+
+// Declare the intent to advertise collations under a collator ID, attaching a
+// signature of the `PeerId` of the node using the given collator ID key.
+type Declare struct {
+	CollatorId        CollatorID        `scale:"1"`
+	ParaID            uint32            `scale:"2"`
+	CollatorSignature CollatorSignature `scale:"3"`
+}
+
+// Index returns the index of varying data type
+func (Declare) Index() uint {
+	return 0
+}
+
+// AdvertiseCollation contains a relay parent hash and is used to advertise a collation to a validator.
+// This will only advertise a collation if there exists one for the given relay parent and the given peer is
+// set as validator for our para at the given relay parent.
+// It can only be sent once the peer has declared that they are a collator with given ID
+type AdvertiseCollation common.Hash
+
+// Index returns the index of varying data type
+func (AdvertiseCollation) Index() uint {
+	return 1
+}
+
+// CollationSeconded represents that a collation sent to a validator was seconded.
+type CollationSeconded struct {
+	Hash                         common.Hash                  `scale:"1"`
+	UncheckedSignedFullStatement UncheckedSignedFullStatement `scale:"2"`
+}
+
+// Index returns the index of varying data type
+func (CollationSeconded) Index() uint {
+	return 4
+}

lib/parachain/collation_protocol_test.go

@@ -0,0 +1,122 @@
+package parachain
+
+import (
+	_ "embed"
+	"fmt"
+	"testing"
+
+	"github.com/ChainSafe/gossamer/lib/common"
+	"github.com/ChainSafe/gossamer/pkg/scale"
+	"github.com/stretchr/testify/require"
+	"gopkg.in/yaml.v3"
+)
+
+//go:embed testdata/collation_protocol.yaml
+var testDataCollationProtocolRaw string
+
+var testDataCollationProtocol map[string]string
+
+func init() {
+	err := yaml.Unmarshal([]byte(testDataCollationProtocolRaw), &testDataCollationProtocol)
+	if err != nil {
+		fmt.Println("Error unmarshaling test data:", err)
+		return
+	}
+}
+
+func TestCollationProtocol(t *testing.T) {
+	t.Parallel()
+
+	var collatorID CollatorID
+	tempCollatID := common.MustHexToBytes("0x48215b9d322601e5b1a95164cea0dc4626f545f98343d07f1551eb9543c4b147")
+	copy(collatorID[:], tempCollatID)
+
+	var collatorSignature CollatorSignature
+	tempSignature := common.MustHexToBytes(testSDMHex["collatorSignature"])
+	copy(collatorSignature[:], tempSignature)
+
+	var validatorSignature ValidatorSignature
+	copy(validatorSignature[:], tempSignature)
+
+	hash5 := getDummyHash(5)
+
+	secondedEnumValue := Seconded{
+		Descriptor: CandidateDescriptor{
+			ParaID:                      uint32(1),
+			RelayParent:                 hash5,
+			Collator:                    collatorID,
+			PersistedValidationDataHash: hash5,
+			PovHash:                     hash5,
+			ErasureRoot:                 hash5,
+			Signature:                   collatorSignature,
+			ParaHead:                    hash5,
+			ValidationCodeHash:          ValidationCodeHash(hash5),
+		},
+		Commitments: CandidateCommitments{
+			UpwardMessages:            []UpwardMessage{{1, 2, 3}},
+			HorizontalMessages:        []OutboundHrmpMessage{},
+			NewValidationCode:         &ValidationCode{1, 2, 3},
+			HeadData:                  headData{1, 2, 3},
+			ProcessedDownwardMessages: uint32(5),
+			HrmpWatermark:             uint32(0),
+		},
+	}
+
+	statementWithSeconded := NewStatement()
+	err := statementWithSeconded.Set(secondedEnumValue)
+	require.NoError(t, err)
+
+	testCases := []struct {
+		name          string
+		enumValue     scale.VaryingDataTypeValue
+		encodingValue []byte
+	}{
+		{
+			name: "Declare",
+			enumValue: Declare{
+				CollatorId:        collatorID,
+				ParaID:            uint32(5),
+				CollatorSignature: collatorSignature,
+			},
+			encodingValue: common.MustHexToBytes(testDataCollationProtocol["declare"]),
+		},
+		{
+			name:          "AdvertiseCollation",
+			enumValue:     AdvertiseCollation(hash5),
+			encodingValue: common.MustHexToBytes("0x00010505050505050505050505050505050505050505050505050505050505050505"),
+		},
+		{
+			name: "CollationSeconded",
+			enumValue: CollationSeconded{
+				Hash: hash5,
+				UncheckedSignedFullStatement: UncheckedSignedFullStatement{
+					Payload:        statementWithSeconded,
+					ValidatorIndex: ValidatorIndex(5),
+					Signature:      validatorSignature,
+				},
+			},
+			encodingValue: common.MustHexToBytes(testDataCollationProtocol["collationSeconded"]),
+		},
+	}
+
+	for _, c := range testCases {
+		c := c
+		t.Run(c.name, func(t *testing.T) {
+			t.Parallel()
+
+			vdt_parent := NewCollationProtocol()
+			vdt_child := NewCollatorProtocolMessage()
+
+			err := vdt_child.Set(c.enumValue)
+			require.NoError(t, err)
+
+			err = vdt_parent.Set(vdt_child)
+			require.NoError(t, err)
+
+			bytes, err := scale.Marshal(vdt_parent)
+			require.NoError(t, err)
+
+			require.Equal(t, c.encodingValue, bytes)
+		})
+	}
+}

lib/parachain/testdata/collation_protocol.yaml

@@ -0,0 +1,4 @@
+
+declare: "0x000048215b9d322601e5b1a95164cea0dc4626f545f98343d07f1551eb9543c4b14705000000c67cb93bf0a36fcee3d29de8a6a69a759659680acf486475e0a2552a5fbed87e45adce5f290698d8596095722b33599227f7461f51af8617c8be74b894cf1b86"
+
+collationSeconded: "0x000405050505050505050505050505050505050505050505050505050505050505050101000000050505050505050505050505050505050505050505050505050505050505050548215b9d322601e5b1a95164cea0dc4626f545f98343d07f1551eb9543c4b147050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505c67cb93bf0a36fcee3d29de8a6a69a759659680acf486475e0a2552a5fbed87e45adce5f290698d8596095722b33599227f7461f51af8617c8be74b894cf1b8605050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505050505040c01020300010c0102030c010203050000000000000005000000c67cb93bf0a36fcee3d29de8a6a69a759659680acf486475e0a2552a5fbed87e45adce5f290698d8596095722b33599227f7461f51af8617c8be74b894cf1b86"