Merge branch 'main' into blob/fix-const

go.mod

@@ -8,7 +8,7 @@ require (
 	github.com/celestiaorg/nmt v0.21.0
 	github.com/stretchr/testify v1.9.0
 	golang.org/x/exp v0.0.0-20231206192017-f3f8817b8deb
-	google.golang.org/protobuf v1.33.0
+	google.golang.org/protobuf v1.34.1
 )
 
 require (

go.sum

@@ -95,8 +95,8 @@ google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyac
 google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY=
 google.golang.org/grpc v1.27.0/go.mod h1:qbnxyOmOxrQa7FizSgH+ReBfzJrCY1pSN7KXBS8abTk=
 google.golang.org/grpc v1.28.0/go.mod h1:rpkK4SK4GF4Ach/+MFLZUBavHOvF2JJB5uozKKal+60=
-google.golang.org/protobuf v1.33.0 h1:uNO2rsAINq/JlFpSdYEKIZ0uKD/R9cpdv0T+yoGwGmI=
-google.golang.org/protobuf v1.33.0/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
+google.golang.org/protobuf v1.34.1 h1:9ddQBjfCyZPOHPUiPxpYESBLc+T8P3E+Vo4IbKZgFWg=
+google.golang.org/protobuf v1.34.1/go.mod h1:c6P6GXX6sHbq/GpV6MGZEdwhWPcYBgnhAHhKbcUYpos=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
 gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=

namespace/namespace.go

@@ -119,23 +119,23 @@ func (n Namespace) IsSecondaryReserved() bool {
 }
 
 func (n Namespace) IsParityShares() bool {
-	return bytes.Equal(n.Bytes(), ParitySharesNamespace.Bytes())
+	return n.Equals(ParitySharesNamespace)
 }
 
 func (n Namespace) IsTailPadding() bool {
-	return bytes.Equal(n.Bytes(), TailPaddingNamespace.Bytes())
+	return n.Equals(TailPaddingNamespace)
 }
 
 func (n Namespace) IsPrimaryReservedPadding() bool {
-	return bytes.Equal(n.Bytes(), PrimaryReservedPaddingNamespace.Bytes())
+	return n.Equals(PrimaryReservedPaddingNamespace)
 }
 
 func (n Namespace) IsTx() bool {
-	return bytes.Equal(n.Bytes(), TxNamespace.Bytes())
+	return n.Equals(TxNamespace)
 }
 
 func (n Namespace) IsPayForBlob() bool {
-	return bytes.Equal(n.Bytes(), PayForBlobNamespace.Bytes())
+	return n.Equals(PayForBlobNamespace)
 }
 
 func (n Namespace) Repeat(times int) []Namespace {
@@ -147,23 +147,34 @@ func (n Namespace) Repeat(times int) []Namespace {
 }
 
 func (n Namespace) Equals(n2 Namespace) bool {
-	return bytes.Equal(n.Bytes(), n2.Bytes())
+	return n.Version == n2.Version && bytes.Equal(n.ID, n2.ID)
 }
 
 func (n Namespace) IsLessThan(n2 Namespace) bool {
-	return bytes.Compare(n.Bytes(), n2.Bytes()) == -1
+	return n.Compare(n2) == -1
 }
 
 func (n Namespace) IsLessOrEqualThan(n2 Namespace) bool {
-	return bytes.Compare(n.Bytes(), n2.Bytes()) < 1
+	return n.Compare(n2) < 1
 }
 
 func (n Namespace) IsGreaterThan(n2 Namespace) bool {
-	return bytes.Compare(n.Bytes(), n2.Bytes()) == 1
+	return n.Compare(n2) == 1
 }
 
 func (n Namespace) IsGreaterOrEqualThan(n2 Namespace) bool {
-	return bytes.Compare(n.Bytes(), n2.Bytes()) > -1
+	return n.Compare(n2) > -1
+}
+
+func (n Namespace) Compare(n2 Namespace) int {
+	switch {
+	case n.Version == n2.Version:
+		return bytes.Compare(n.ID, n2.ID)
+	case n.Version < n2.Version:
+		return -1
+	default:
+		return 1
+	}
 }
 
 // leftPad returns a new byte slice with the provided byte slice left-padded to the provided size.

namespace/namespace_test.go

@@ -7,6 +7,7 @@ import (
 	"testing"
 
 	"github.com/stretchr/testify/assert"
+	"github.com/stretchr/testify/require"
 )
 
 var (
@@ -297,3 +298,121 @@ func TestIsReserved(t *testing.T) {
 		assert.Equal(t, tc.want, got)
 	}
 }
+
+func Test_compareMethods(t *testing.T) {
+	minID := RandomBlobNamespaceID()
+	maxID := RandomBlobNamespaceID()
+	// repeat until maxID meets our expectations (maxID > minID).
+	for bytes.Compare(maxID, minID) != 1 {
+		maxID = RandomBlobNamespaceID()
+	}
+
+	vers := []byte{NamespaceVersionZero, NamespaceVersionMax}
+	ids := [][]byte{minID, maxID}
+
+	// collect all possible pairs: (ver1 ?? ver2) x (id1 ?? id2)
+	var testPairs [][2]Namespace
+	for _, ver1 := range vers {
+		for _, ver2 := range vers {
+			for _, id1 := range ids {
+				for _, id2 := range ids {
+					testPairs = append(testPairs, [2]Namespace{
+						{Version: ver1, ID: id1},
+						{Version: ver2, ID: id2},
+					})
+				}
+			}
+		}
+	}
+	require.Len(t, testPairs, 16) // len(vers) * len(vers) * len(ids) * len(ids)
+
+	type testCase struct {
+		name string
+		fn   func(n, n2 Namespace) bool
+		old  func(n, n2 Namespace) bool
+	}
+	testCases := []testCase{
+		{
+			name: "Equals",
+			fn:   Namespace.Equals,
+			old: func(n, n2 Namespace) bool {
+				return bytes.Equal(n.Bytes(), n2.Bytes())
+			},
+		},
+		{
+			name: "IsLessThan",
+			fn:   Namespace.IsLessThan,
+			old: func(n, n2 Namespace) bool {
+				return bytes.Compare(n.Bytes(), n2.Bytes()) == -1
+			},
+		},
+		{
+			name: "IsLessOrEqualThan",
+			fn:   Namespace.IsLessOrEqualThan,
+			old: func(n, n2 Namespace) bool {
+				return bytes.Compare(n.Bytes(), n2.Bytes()) < 1
+			},
+		},
+		{
+			name: "IsGreaterThan",
+			fn:   Namespace.IsGreaterThan,
+			old: func(n, n2 Namespace) bool {
+				return bytes.Compare(n.Bytes(), n2.Bytes()) == 1
+			},
+		},
+		{
+			name: "IsGreaterOrEqualThan",
+			fn:   Namespace.IsGreaterOrEqualThan,
+			old: func(n, n2 Namespace) bool {
+				return bytes.Compare(n.Bytes(), n2.Bytes()) > -1
+			},
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			for i, p := range testPairs {
+				n, n2 := p[0], p[1]
+				got := tc.fn(n, n2)
+				want := tc.old(n, n2)
+				assert.Equal(t, want, got, "for pair %d", i)
+			}
+		})
+	}
+}
+
+func BenchmarkEqual(b *testing.B) {
+	n1 := RandomNamespace()
+	n2 := RandomNamespace()
+	// repeat until n2 meets our expectations (n1 != n2).
+	for n1.Equals(n2) {
+		n2 = RandomNamespace()
+	}
+
+	b.ResetTimer()
+	b.ReportAllocs()
+
+	for i := 0; i < b.N; i++ {
+		if n1.Equals(n2) {
+			b.Fatal()
+		}
+	}
+}
+
+func BenchmarkCompare(b *testing.B) {
+	n1 := RandomNamespace()
+	n2 := RandomNamespace()
+	// repeat until n2 meets our expectations (n1 > n2).
+	for n1.Compare(n2) != 1 {
+		n2 = RandomNamespace()
+	}
+
+	b.ResetTimer()
+	b.ReportAllocs()
+
+	for i := 0; i < b.N; i++ {
+		if n1.Compare(n2) != 1 {
+			b.Fatal()
+		}
+	}
+}