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.

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

refactor(shwap): revert DataRoot -> DataHash #3585

Merged
merged 1 commit into from
Jul 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion share/eds/eds.go
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ func rootsToCids(eds *rsmt2d.ExtendedDataSquare) ([]cid.Cid, error) {

// ReadEDS reads the first EDS quadrant (1/4) from an io.Reader CAR file.
// Only the first quadrant will be read, which represents the original data.
// The returned EDS is guaranteed to be full and valid against the DataRoot, otherwise ReadEDS
// The returned EDS is guaranteed to be full and valid against the DataHash, otherwise ReadEDS
// errors.
func ReadEDS(ctx context.Context, r io.Reader, root share.DataHash) (eds *rsmt2d.ExtendedDataSquare, err error) {
_, span := tracer.Start(ctx, "read-eds")
Expand Down
6 changes: 3 additions & 3 deletions share/eds/store.go
Original file line number Diff line number Diff line change
Expand Up @@ -208,7 +208,7 @@ func (s *Store) watchForFailures(ctx context.Context) {
}
}

// Put stores the given data square with DataRoot's hash as a key.
// Put stores the given data square with DataHash's hash as a key.
//
// The square is verified on the Exchange level, and Put only stores the square, trusting it.
// The resulting file stores all the shares and NMT Merkle Proofs of the EDS.
Expand Down Expand Up @@ -335,7 +335,7 @@ func trackLateResult(opName string, res <-chan dagstore.ShardResult, metrics *me
}
}

// GetCAR takes a DataRoot and returns a buffered reader to the respective EDS serialized as a
// GetCAR takes a DataHash and returns a buffered reader to the respective EDS serialized as a
// CARv1 file.
// The Reader strictly reads the CAR header and first quadrant (1/4) of the EDS, omitting all the
// NMT Merkle proofs. Integrity of the store data is not verified.
Expand Down Expand Up @@ -522,7 +522,7 @@ func (s *Store) remove(ctx context.Context, root share.DataHash) (err error) {
return nil
}

// Get reads EDS out of Store by given DataRoot.
// Get reads EDS out of Store by given DataHash.
//
// It reads only one quadrant(1/4) of the EDS and verifies the integrity of the stored data by
// recomputing it.
Expand Down
4 changes: 2 additions & 2 deletions share/new_eds/accessor.go
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ import (
type Accessor interface {
// Size returns square size of the Accessor.
Size(ctx context.Context) int
// DataRoot returns data hash of the Accessor.
DataRoot(ctx context.Context) (share.DataHash, error)
// DataHash returns data hash of the Accessor.
DataHash(ctx context.Context) (share.DataHash, error)
// Sample returns share and corresponding proof for row and column indices. Implementation can
// choose which axis to use for proof. Chosen axis for proof should be indicated in the returned
// Sample.
Expand Down
5 changes: 2 additions & 3 deletions share/new_eds/close_once.go
Original file line number Diff line number Diff line change
Expand Up @@ -42,12 +42,11 @@ func (c *closeOnce) Size(ctx context.Context) int {
return c.f.Size(ctx)
}

// DataRoot returns root hash of Accessor's underlying EDS.
func (c *closeOnce) DataRoot(ctx context.Context) (share.DataHash, error) {
func (c *closeOnce) DataHash(ctx context.Context) (share.DataHash, error) {
if c.closed.Load() {
return nil, errAccessorClosed
}
return c.f.DataRoot(ctx)
return c.f.DataHash(ctx)
}

func (c *closeOnce) Sample(ctx context.Context, rowIdx, colIdx int) (shwap.Sample, error) {
Expand Down
2 changes: 1 addition & 1 deletion share/new_eds/close_once_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ func (s *stubEdsAccessorCloser) Size(context.Context) int {
return 0
}

func (s *stubEdsAccessorCloser) DataRoot(context.Context) (share.DataHash, error) {
func (s *stubEdsAccessorCloser) DataHash(context.Context) (share.DataHash, error) {
return nil, nil
}

Expand Down
4 changes: 2 additions & 2 deletions share/new_eds/proofs_cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,8 @@ func (c *proofsCache) Size(ctx context.Context) int {
return int(size)
}

func (c *proofsCache) DataRoot(ctx context.Context) (share.DataHash, error) {
return c.inner.DataRoot(ctx)
func (c *proofsCache) DataHash(ctx context.Context) (share.DataHash, error) {
return c.inner.DataHash(ctx)
}

func (c *proofsCache) Sample(ctx context.Context, rowIdx, colIdx int) (shwap.Sample, error) {
Expand Down
4 changes: 2 additions & 2 deletions share/new_eds/rsmt2d.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ func (eds *Rsmt2D) Size(context.Context) int {
return int(eds.Width())
}

// DataRoot returns data hash of the Accessor.
func (eds *Rsmt2D) DataRoot(context.Context) (share.DataHash, error) {
// DataHash returns data hash of the Accessor.
func (eds *Rsmt2D) DataHash(context.Context) (share.DataHash, error) {
roots, err := share.NewAxisRoots(eds.ExtendedDataSquare)
if err != nil {
return share.DataHash{}, fmt.Errorf("while creating data root: %w", err)
Expand Down
2 changes: 1 addition & 1 deletion store/cache/accessor_cache_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ func (m *mockAccessor) Size(context.Context) int {
panic("implement me")
}

func (m *mockAccessor) DataRoot(context.Context) (share.DataHash, error) {
func (m *mockAccessor) DataHash(context.Context) (share.DataHash, error) {
panic("implement me")
}

Expand Down
4 changes: 2 additions & 2 deletions store/cache/noop.go
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ func (n NoopFile) Size(context.Context) int {
return 0
}

// DataRoot returns root hash of Accessor's underlying EDS.
func (n NoopFile) DataRoot(context.Context) (share.DataHash, error) {
// DataHash returns root hash of Accessor's underlying EDS.
func (n NoopFile) DataHash(context.Context) (share.DataHash, error) {
return nil, nil
}

Expand Down
4 changes: 2 additions & 2 deletions store/file/ods.go
Original file line number Diff line number Diff line change
Expand Up @@ -120,8 +120,8 @@ func (f *ODSFile) size() int {
return int(f.hdr.squareSize)
}

// DataRoot returns root hash of Accessor's underlying EDS.
func (f *ODSFile) DataRoot(context.Context) (share.DataHash, error) {
// DataHash returns root hash of Accessor's underlying EDS.
func (f *ODSFile) DataHash(context.Context) (share.DataHash, error) {
return f.hdr.datahash, nil
}

Expand Down
5 changes: 2 additions & 3 deletions store/file/q1q4_file.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,9 +53,8 @@ func (f *Q1Q4File) Size(ctx context.Context) int {
return f.ods.Size(ctx)
}

// DataRoot returns root hash of Accessor's underlying EDS.
func (f *Q1Q4File) DataRoot(ctx context.Context) (share.DataHash, error) {
return f.ods.DataRoot(ctx)
func (f *Q1Q4File) DataHash(ctx context.Context) (share.DataHash, error) {
return f.ods.DataHash(ctx)
}

func (f *Q1Q4File) Sample(ctx context.Context, rowIdx, colIdx int) (shwap.Sample, error) {
Expand Down
6 changes: 3 additions & 3 deletions store/store_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -184,7 +184,7 @@ func TestEDSStore(t *testing.T) {
// assert that the empty file is, in fact, empty
f, err := edsStore.GetByDataRoot(ctx, roots.Hash())
require.NoError(t, err)
hash, err := f.DataRoot(ctx)
hash, err := f.DataHash(ctx)
require.NoError(t, err)
require.True(t, hash.IsEmptyEDS())
})
Expand All @@ -206,7 +206,7 @@ func TestEDSStore(t *testing.T) {
// assert that the empty file can be accessed by height
f, err := edsStore.GetByHeight(ctx, height)
require.NoError(t, err)
hash, err := f.DataRoot(ctx)
hash, err := f.DataHash(ctx)
require.NoError(t, err)
require.True(t, hash.IsEmptyEDS())
require.NoError(t, f.Close())
Expand Down Expand Up @@ -237,7 +237,7 @@ func TestEDSStore(t *testing.T) {
for i := from; i <= to; i++ {
f, err := edsStore.GetByHeight(ctx, uint64(i))
require.NoError(t, err)
hash, err := f.DataRoot(ctx)
hash, err := f.DataHash(ctx)
require.NoError(t, err)
require.True(t, hash.IsEmptyEDS())
require.NoError(t, f.Close())
Expand Down
Loading