feat: add pbtime util package

pbtime/README.md

@@ -0,0 +1,3 @@
+# pbtime
+
+pbtime is a Go package, part of the core Cosmos SDK module with helper methods for [protobuf timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#timestamp).

pbtime/cmp.go

@@ -0,0 +1,32 @@
+package pbtime
+
+import (
+	"time"
+
+	tspb "google.golang.org/protobuf/types/known/timestamppb"
+)
+
+func IsZero(t *tspb.Timestamp) bool {
+	return t == nil || t.Nanos == 0 && t.Seconds == 0
+}
+
+// Commpare t1 and t2 and returns -1 when t1 < t2, 0 when t1 == t2 and 1 otherwise.
+// Panics if t1 or t2 is nil
+func Compare(t1, t2 *tspb.Timestamp) int {
+	if t1.Seconds == t2.Seconds && t1.Nanos == t2.Nanos {
+		return 0
+	}
+	if t1.Seconds < t2.Seconds || t1.Seconds == t2.Seconds && t1.Nanos < t2.Nanos {
+		return -1
+	}
+	return 1
+}
+
+func Add(t *tspb.Timestamp, d time.Duration) *tspb.Timestamp {
+	if d == 0 {
+		t2 := *t
+		return &t2
+	}
+	t2 := t.AsTime()
+	return tspb.New(t2.Add(d))
+}

pbtime/cmp_test.go

@@ -0,0 +1,79 @@
+package pbtime
+
+import (
+	"fmt"
+	"testing"
+	"time"
+
+	"math/rand"
+
+	"github.com/stretchr/testify/require"
+	tspb "google.golang.org/protobuf/types/known/timestamppb"
+)
+
+func new(s int64, n int32) *tspb.Timestamp {
+	return &tspb.Timestamp{Seconds: s, Nanos: n}
+}
+
+func TestIsZero(t *testing.T) {
+	tcs := []struct {
+		t        *tspb.Timestamp
+		expected bool
+	}{
+		{&tspb.Timestamp{}, true},
+		{new(0, 0), true},
+
+		{new(1, 0), true},
+		{new(0, 1), false},
+		{tspb.New(time.Time{}), false},
+	}
+
+	for i, tc := range tcs {
+		require.Equal(t, tc.expected, IsZero(tc.t), "test_id %d", i)
+	}
+}
+
+func TestCmpare(t *testing.T) {
+	tcs := []struct {
+		t1       *tspb.Timestamp
+		t2       *tspb.Timestamp
+		expected int
+	}{
+		{&tspb.Timestamp{}, &tspb.Timestamp{}, 0},
+		{new(1, 1), new(1, 1), 0},
+		{new(-1, 1), new(-1, 1), 0},
+		{new(231, -5), new(231, -5), 0},
+
+		{new(1, -1), new(1, 0), -1},
+		{new(1, -1), new(12, -1), -1},
+		{new(-11, -1), new(-1, -1), -1},
+
+		{new(1, -1), new(0, -1), 1},
+		{new(1, -1), new(1, -2), 1},
+	}
+	for i, tc := range tcs {
+		t.Run(fmt.Sprint("test ", i), func(t *testing.T) {
+			r := Compare(tc.t1, tc.t2)
+			require.Equal(t, tc.expected, r)
+		})
+	}
+}
+
+func TestAddFuzzy(t *testing.T) {
+	requier := require.New(t)
+	check := func(s, n int64, d time.Duration) {
+		t := time.Unix(s, n)
+		t_expected := t.Add(d)
+		tb := tspb.New(t)
+		tb = Add(tb, d)
+		requier.Equal(*tspb.New(t_expected), *tb)
+	}
+
+	for i := 0; i < 2000; i++ {
+		s, n, d := rand.Int63(), rand.Int63(), time.Duration(rand.Int63())
+		check(s, n, d)
+	}
+	check(0, 0, 0)
+	check(1, 2, 0)
+	check(-1, -1, 1)
+}