Document and test RoundToBytes (#750)

* Test TestRoundToBytes * Improve docs of RoundToBytes
drand · Sep 14, 2020 · 8c2ee78 · 8c2ee78
1 parent 578d716
commit 8c2ee78
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/chain/store.go b/chain/store.go
@@ -36,7 +36,7 @@ type Cursor interface {
 	Last() *Beacon
 }
 
-// RoundToBytes provides a byte serialized form of a round number
+// RoundToBytes serializes a round number to bytes (8 bytes fixed length big-endian).
 func RoundToBytes(r uint64) []byte {
 	var buff bytes.Buffer
 	_ = binary.Write(&buff, binary.BigEndian, r)

diff --git a/chain/store_test.go b/chain/store_test.go
@@ -0,0 +1,14 @@
+package chain
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestRoundToBytes(t *testing.T) {
+	require.Equal(t, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00}, RoundToBytes(0))
+	require.Equal(t, []byte{0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x01}, RoundToBytes(1))
+	require.Equal(t, []byte{0x00, 0x00, 0x00, 0x2a, 0xec, 0x04, 0x83, 0xff}, RoundToBytes(184348345343))
+	require.Equal(t, []byte{0xA1, 0xB2, 0xC3, 0xD4, 0xE5, 0xF6, 0xA7, 0xB8}, RoundToBytes(0xA1B2C3D4E5F6A7B8))
+}