Export DeepCopy function for external library users

Co-authored-by: adlerjohn <[email protected]>

Author: Copilot

extendeddatasquare.go

@@ -234,15 +234,15 @@ func (eds *ExtendedDataSquare) deepCopy(codec Codec) (ExtendedDataSquare, error)
 
 // Col returns a column slice.
 // The returned slice references internal data and should not be modified.
-// If modification is needed, the caller should make a copy using deepCopy().
+// If modification is needed, the caller should make a copy using DeepCopy().
 func (eds *ExtendedDataSquare) Col(colIdx uint) [][]byte {
 	return eds.col(colIdx)
 }
 
 // ColRoots returns the Merkle roots of all the columns in the square. Returns
 // an error if the EDS is incomplete (i.e. some shares are nil).
 // The returned slice references internal data and should not be modified.
-// If modification is needed, the caller should make a copy using deepCopy().
+// If modification is needed, the caller should make a copy using DeepCopy().
 func (eds *ExtendedDataSquare) ColRoots() ([][]byte, error) {
 	colRoots, err := eds.getColRoots()
 	if err != nil {
@@ -253,15 +253,15 @@ func (eds *ExtendedDataSquare) ColRoots() ([][]byte, error) {
 
 // Row returns a row slice.
 // The returned slice references internal data and should not be modified.
-// If modification is needed, the caller should make a copy using deepCopy().
+// If modification is needed, the caller should make a copy using DeepCopy().
 func (eds *ExtendedDataSquare) Row(rowIdx uint) [][]byte {
 	return eds.row(rowIdx)
 }
 
 // RowRoots returns the Merkle roots of all the rows in the square. Returns an
 // error if the EDS is incomplete (i.e. some shares are nil).
 // The returned slice references internal data and should not be modified.
-// If modification is needed, the caller should make a copy using deepCopy().
+// If modification is needed, the caller should make a copy using DeepCopy().
 func (eds *ExtendedDataSquare) RowRoots() ([][]byte, error) {
 	rowRoots, err := eds.getRowRoots()
 	if err != nil {
@@ -270,11 +270,11 @@ func (eds *ExtendedDataSquare) RowRoots() ([][]byte, error) {
 	return rowRoots, nil
 }
 
-// deepCopy returns a deep copy of the given slice of byte slices.
+// DeepCopy returns a deep copy of the given slice of byte slices.
 // This function is available for callers who need to make a copy of data
 // returned by methods like Row(), Col(), RowRoots(), ColRoots(), or Flattened()
 // when they intend to modify the data.
-func deepCopy(original [][]byte) [][]byte {
+func DeepCopy(original [][]byte) [][]byte {
 	dest := make([][]byte, len(original))
 	for i, cell := range original {
 		if cell == nil {
@@ -293,7 +293,7 @@ func (eds *ExtendedDataSquare) Width() uint {
 
 // Flattened returns the extended data square as a flattened slice of bytes.
 // The returned slice references internal data and should not be modified.
-// If modification is needed, the caller should make a copy using deepCopy().
+// If modification is needed, the caller should make a copy using DeepCopy().
 func (eds *ExtendedDataSquare) Flattened() [][]byte {
 	return eds.dataSquare.Flattened()
 }

extendeddatasquare_test.go

@@ -433,7 +433,7 @@ func TestDeepCopy(t *testing.T) {
 		require.NoError(t, err)
 	}
 
-	copied := deepCopy(original)
+	copied := DeepCopy(original)
 	require.Equal(t, original, copied)
 
 	// modify the original and ensure the copy is not affected
@@ -442,7 +442,7 @@ func TestDeepCopy(t *testing.T) {
 }
 
 // TestDirectReferences verifies that the exported methods return direct references
-// to internal data for performance reasons, and demonstrates how to use deepCopy
+// to internal data for performance reasons, and demonstrates how to use DeepCopy
 // when modification is needed.
 func TestDirectReferences(t *testing.T) {
 	codec := NewLeoRSCodec()
@@ -459,8 +459,8 @@ func TestDirectReferences(t *testing.T) {
 		// Should be the same underlying slice (direct reference)
 		require.True(t, &row1[0] == &row2[0], "Row() should return direct references")
 
-		// If caller needs to modify, they should use deepCopy
-		rowCopy := deepCopy(row1)
+		// If caller needs to modify, they should use DeepCopy
+		rowCopy := DeepCopy(row1)
 		rowCopy[0][0]++ // safe to modify
 
 		// Original should be unchanged
@@ -474,8 +474,8 @@ func TestDirectReferences(t *testing.T) {
 		// Should be the same underlying slice (direct reference)
 		require.True(t, &col1[0] == &col2[0], "Col() should return direct references")
 
-		// If caller needs to modify, they should use deepCopy
-		colCopy := deepCopy(col1)
+		// If caller needs to modify, they should use DeepCopy
+		colCopy := DeepCopy(col1)
 		colCopy[0][0]++ // safe to modify
 
 		// Original should be unchanged
@@ -491,8 +491,8 @@ func TestDirectReferences(t *testing.T) {
 		// Should be the same underlying slice (direct reference)
 		require.True(t, &roots1[0] == &roots2[0], "RowRoots() should return direct references")
 
-		// If caller needs to modify, they should use deepCopy
-		rootsCopy := deepCopy(roots1)
+		// If caller needs to modify, they should use DeepCopy
+		rootsCopy := DeepCopy(roots1)
 		rootsCopy[0][0]++ // safe to modify
 
 		// Original should be unchanged
@@ -508,8 +508,8 @@ func TestDirectReferences(t *testing.T) {
 		// Should be the same underlying slice (direct reference)
 		require.True(t, &roots1[0] == &roots2[0], "ColRoots() should return direct references")
 
-		// If caller needs to modify, they should use deepCopy
-		rootsCopy := deepCopy(roots1)
+		// If caller needs to modify, they should use DeepCopy
+		rootsCopy := DeepCopy(roots1)
 		rootsCopy[0][0]++ // safe to modify
 
 		// Original should be unchanged
@@ -526,8 +526,8 @@ func TestDirectReferences(t *testing.T) {
 		// But the underlying byte slices should be the same (shared data)
 		require.True(t, &flat1[0][0] == &flat2[0][0], "Flattened() should share underlying byte slices")
 
-		// If caller needs to modify, they should use deepCopy
-		flatCopy := deepCopy(flat1)
+		// If caller needs to modify, they should use DeepCopy
+		flatCopy := DeepCopy(flat1)
 		flatCopy[0][0]++ // safe to modify
 
 		// Original should be unchanged