Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test: add test case based on celestia-node usage #239

Merged
merged 5 commits into from
Jul 8, 2023
Merged

test: add test case based on celestia-node usage #239

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
5661af1
feat: NewExtendedDataSquare with chunkSize param
rootulp Jul 6, 2023
69a1aae
test: TestNewExtendedDataSquare
rootulp Jul 6, 2023
0b0674a
test: add test case based on celestia-node usage
rootulp Jul 7, 2023
604ae0a
Merge branch 'main' into rp/test-celestia-node-usage
rootulp Jul 7, 2023
11bb1c0
test: check all cells for equality
rootulp Jul 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 55 additions & 0 deletions rsmt2d_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/celestiaorg/rsmt2d"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

func TestEdsRepairRoundtripSimple(t *testing.T) {
Expand Down Expand Up @@ -157,3 +158,57 @@ func TestEdsRepairTwice(t *testing.T) {
})
}
}

// TestRepairWithOneQuarterPopulated is motivated by a use case from
// celestia-node. It verifies that a new EDS can be populated via SetCell. After
// enough chunks have been populated, it verifies that the EDS can be repaired.
// After the EDS is repaired, the test verifies that data in a repaired cell
// matches the expected data.
func TestRepairWithOneQuarterPopulated(t *testing.T) {
edsWidth := 4
chunkSize := 512

exampleEds := createExampleEds(t, chunkSize)

eds, err := rsmt2d.NewExtendedDataSquare(rsmt2d.NewLeoRSCodec(), rsmt2d.NewDefaultTree, uint(edsWidth), uint(chunkSize))
require.NoError(t, err)

// Populate EDS with 1/4 of chunks using SetCell
err = eds.SetCell(0, 0, exampleEds.GetCell(0, 0))
require.NoError(t, err)
err = eds.SetCell(0, 1, exampleEds.GetCell(0, 1))
require.NoError(t, err)
err = eds.SetCell(1, 0, exampleEds.GetCell(1, 0))
require.NoError(t, err)
err = eds.SetCell(1, 1, exampleEds.GetCell(1, 1))
require.NoError(t, err)
Comment on lines +176 to +184
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Considered refactoring to

	for row := 0; row < edsWidth/2; row++ {
		for col := 0; col < edsWidth/2; col++ {
			err = eds.SetCell(uint(row), uint(col), exampleEds.GetCell(uint(row), uint(col)))
			require.NoError(t, err)
		}
	}

but I think the existing implementation is easier to read.


// Verify that an unpopulated cell returns nil
assert.Nil(t, eds.GetCell(3, 3))

rowRoots, err := exampleEds.RowRoots()
require.NoError(t, err)
colRoots, err := exampleEds.ColRoots()
require.NoError(t, err)

// Repair the EDS
err = eds.Repair(rowRoots, colRoots)
assert.NoError(t, err)

assert.Equal(t, exampleEds.Flattened(), eds.Flattened())
}

func createExampleEds(t *testing.T, chunkSize int) (eds *rsmt2d.ExtendedDataSquare) {
ones := bytes.Repeat([]byte{1}, chunkSize)
twos := bytes.Repeat([]byte{2}, chunkSize)
threes := bytes.Repeat([]byte{3}, chunkSize)
fours := bytes.Repeat([]byte{4}, chunkSize)
ods := [][]byte{
ones, twos,
threes, fours,
}

eds, err := rsmt2d.ComputeExtendedDataSquare(ods, rsmt2d.NewLeoRSCodec(), rsmt2d.NewDefaultTree)
require.NoError(t, err)
return eds
}