feat: cbor encoding of all referenced param & return types

Closes: #396

Author: rvagg

abi/cbor_test.go

@@ -22,3 +22,45 @@ func TestCborBytesTransparent(t *testing.T) {
 	require.NoError(t, bytesDeSer.UnmarshalCBOR(bytes.NewReader(tBytes)))
 	require.Equal(t, tBytes, bytesDeSer)
 }
+
+func TestCborSectorSize(t *testing.T) {
+	tSectorSize := abi.SectorSize(20 * 1024)
+
+	buf := new(bytes.Buffer)
+	require.NoError(t, tSectorSize.MarshalCBOR(buf))
+
+	sectorSizeSer := buf.Bytes()
+	t.Logf("Serialized SectorSize: %x", sectorSizeSer)
+
+	var sectorSizeDeSer abi.SectorSize
+	require.NoError(t, sectorSizeDeSer.UnmarshalCBOR(bytes.NewReader(sectorSizeSer)))
+	require.Equal(t, tSectorSize, sectorSizeDeSer)
+
+	var nullSectorSize *abi.SectorSize
+	buf = new(bytes.Buffer)
+	require.NoError(t, nullSectorSize.MarshalCBOR(buf))
+	require.Equal(t, []byte{0xf6}, buf.Bytes(), "null SectorSize should serialize to CBOR null")
+	require.NoError(t, nullSectorSize.UnmarshalCBOR(bytes.NewReader([]byte{0xf6})))
+	require.Nil(t, nullSectorSize, "unmarshaled null SectorSize should be nil")
+}
+
+func TestCborSectorNumber(t *testing.T) {
+	tSectorNumber := abi.SectorNumber(42)
+
+	buf := new(bytes.Buffer)
+	require.NoError(t, tSectorNumber.MarshalCBOR(buf))
+
+	sectorNumberSer := buf.Bytes()
+	t.Logf("Serialized SectorNumber: %x", sectorNumberSer)
+
+	var sectorNumberDeSer abi.SectorNumber
+	require.NoError(t, sectorNumberDeSer.UnmarshalCBOR(bytes.NewReader(sectorNumberSer)))
+	require.Equal(t, tSectorNumber, sectorNumberDeSer)
+
+	var nullSectorNumber *abi.SectorNumber
+	buf = new(bytes.Buffer)
+	require.NoError(t, nullSectorNumber.MarshalCBOR(buf))
+	require.Equal(t, []byte{0xf6}, buf.Bytes(), "null SectorNumber should serialize to CBOR null")
+	require.NoError(t, nullSectorNumber.UnmarshalCBOR(bytes.NewReader([]byte{0xf6})))
+	require.Nil(t, nullSectorNumber, "unmarshaled null SectorNumber should be nil")
+}

abi/cbor_uint_types.go

@@ -0,0 +1,94 @@
+package abi
+
+import (
+	"fmt"
+	"io"
+
+	cbg "github.com/whyrusleeping/cbor-gen"
+)
+
+// marshalNullableUint64 is a helper for marshaling nullable uint64 types
+func marshalNullableUint64(w io.Writer, v *uint64) error {
+	if v == nil {
+		_, err := w.Write(cbg.CborNull)
+		return err
+	}
+
+	if err := cbg.WriteMajorTypeHeader(w, cbg.MajUnsignedInt, *v); err != nil {
+		return err
+	}
+	return nil
+}
+
+// unmarshalNullableUint64 is a helper for unmarshaling nullable uint64 types
+func unmarshalNullableUint64(r io.Reader, v *uint64, typeName string) error {
+	cr := cbg.NewCborReader(r)
+	b, err := cr.ReadByte()
+	if err != nil {
+		return fmt.Errorf("failed to read byte for %s: %w", typeName, err)
+	}
+	if b == cbg.CborNull[0] {
+		// Null value - don't modify v as it might be nil
+		// Just return as we've successfully read a null
+		return nil
+	}
+
+	cr.UnreadByte()
+	maj, extra, err := cbg.CborReadHeader(cr)
+	if err != nil {
+		return fmt.Errorf("failed to parse CBOR header for %s: %w", typeName, err)
+	}
+
+	if maj != cbg.MajUnsignedInt {
+		return fmt.Errorf("wrong type for %s field: %d", typeName, maj)
+	}
+
+	*v = extra
+	return nil
+}
+
+func (t *SectorSize) MarshalCBOR(w io.Writer) error {
+	if t == nil {
+		_, err := w.Write(cbg.CborNull)
+		return err
+	}
+	return marshalNullableUint64(w, (*uint64)(t))
+}
+
+func (t *SectorSize) UnmarshalCBOR(r io.Reader) error {
+	if t == nil {
+		// Just consume the value without storing it
+		var dummy uint64
+		return unmarshalNullableUint64(r, &dummy, "SectorSize")
+	}
+
+	value := uint64(*t)
+	if err := unmarshalNullableUint64(r, &value, "SectorSize"); err != nil {
+		return err
+	}
+	*t = SectorSize(value)
+	return nil
+}
+
+func (t *SectorNumber) MarshalCBOR(w io.Writer) error {
+	if t == nil {
+		_, err := w.Write(cbg.CborNull)
+		return err
+	}
+	return marshalNullableUint64(w, (*uint64)(t))
+}
+
+func (t *SectorNumber) UnmarshalCBOR(r io.Reader) error {
+	if t == nil {
+		// Just consume the value without storing it
+		var dummy uint64
+		return unmarshalNullableUint64(r, &dummy, "SectorNumber")
+	}
+
+	value := uint64(*t)
+	if err := unmarshalNullableUint64(r, &value, "SectorNumber"); err != nil {
+		return err
+	}
+	*t = SectorNumber(value)
+	return nil
+}

builtin/v10/cron/cbor_gen.go

@@ -41,6 +41,7 @@ func main() {
 		cron.State{},
 		cron.Entry{},
 		// method params and returns
+		cron.ConstructorParams{},
 	); err != nil {
 		panic(err)
 	}

builtin/v10/gen/gen.go

@@ -41,6 +41,7 @@ func main() {
 		cron.State{},
 		cron.Entry{},
 		// method params and returns
+		cron.ConstructorParams{},
 	); err != nil {
 		panic(err)
 	}