rename to SampleCoords

blob/service_test.go

@@ -145,9 +145,9 @@ func TestBlobService_Get(t *testing.T) {
 				shareOffset := 0
 				for i := range blobs {
 					row, col := calculateIndex(len(h.DAH.RowRoots), blobs[i].index)
-					idx := shwap.SampleIndex{Row: row, Col: col}
+					idx := shwap.SampleCoords{Row: row, Col: col}
 					require.NoError(t, err)
-					smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleIndex{idx})
+					smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleCoords{idx})
 					require.NoError(t, err)
 					require.True(t, bytes.Equal(smpls[0].Share.ToBytes(), resultShares[shareOffset].ToBytes()),
 						fmt.Sprintf("issue on %d attempt. ROW:%d, COL: %d, blobIndex:%d", i, row, col, blobs[i].index),
@@ -489,10 +489,10 @@ func TestService_GetSingleBlobWithoutPadding(t *testing.T) {
 	h, err := service.headerGetter(ctx, 1)
 	require.NoError(t, err)
 	row, col := calculateIndex(len(h.DAH.RowRoots), newBlob.index)
-	idx := shwap.SampleIndex{Row: row, Col: col}
+	idx := shwap.SampleCoords{Row: row, Col: col}
 	require.NoError(t, err)
 
-	smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleIndex{idx})
+	smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleCoords{idx})
 	require.NoError(t, err)
 
 	assert.Equal(t, smpls[0].Share, resultShares[0])
@@ -526,10 +526,10 @@ func TestService_Get(t *testing.T) {
 		assert.Equal(t, b.Commitment, blob.Commitment)
 
 		row, col := calculateIndex(len(h.DAH.RowRoots), b.index)
-		idx := shwap.SampleIndex{Row: row, Col: col}
+		idx := shwap.SampleCoords{Row: row, Col: col}
 		require.NoError(t, err)
 
-		smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleIndex{idx})
+		smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleCoords{idx})
 		require.NoError(t, err)
 
 		assert.Equal(t, smpls[0].Share, resultShares[shareOffset], fmt.Sprintf("issue on %d attempt", i))
@@ -588,10 +588,10 @@ func TestService_GetAllWithoutPadding(t *testing.T) {
 		require.True(t, blobs[i].compareCommitments(blob.Commitment))
 
 		row, col := calculateIndex(len(h.DAH.RowRoots), blob.index)
-		idx := shwap.SampleIndex{Row: row, Col: col}
+		idx := shwap.SampleCoords{Row: row, Col: col}
 		require.NoError(t, err)
 
-		smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleIndex{idx})
+		smpls, err := service.shareGetter.GetSamples(ctx, h, []shwap.SampleCoords{idx})
 		require.NoError(t, err)
 
 		assert.Equal(t, smpls[0].Share, resultShares[shareOffset])
@@ -914,7 +914,7 @@ func createService(ctx context.Context, t testing.TB, shares []libshare.Share) *
 			return nd, err
 		})
 	shareGetter.EXPECT().GetSamples(gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().
-		DoAndReturn(func(ctx context.Context, h *header.ExtendedHeader, indices []shwap.SampleIndex) ([]shwap.Sample, error) {
+		DoAndReturn(func(ctx context.Context, h *header.ExtendedHeader, indices []shwap.SampleCoords) ([]shwap.Sample, error) {
 			smpl, err := accessor.Sample(ctx, indices[0])
 			return []shwap.Sample{smpl}, err
 		})

nodebuilder/share/share.go

@@ -47,7 +47,7 @@ type Module interface {
 	// GetShare gets a Share by coordinates in EDS.
 	GetShare(ctx context.Context, height uint64, row, col int) (libshare.Share, error)
 	// GetSamples gets sample for given indices.
-	GetSamples(ctx context.Context, header *header.ExtendedHeader, indices []shwap.SampleIndex) ([]shwap.Sample, error)
+	GetSamples(ctx context.Context, header *header.ExtendedHeader, indices []shwap.SampleCoords) ([]shwap.Sample, error)
 	// GetEDS gets the full EDS identified by the given extended header.
 	GetEDS(ctx context.Context, height uint64) (*rsmt2d.ExtendedDataSquare, error)
 	// GetNamespaceData gets all shares from an EDS within the given namespace.
@@ -71,7 +71,7 @@ type API struct {
 		GetSamples func(
 			ctx context.Context,
 			header *header.ExtendedHeader,
-			indices []shwap.SampleIndex,
+			indices []shwap.SampleCoords,
 		) ([]shwap.Sample, error) `perm:"read"`
 		GetEDS func(
 			ctx context.Context,
@@ -99,7 +99,7 @@ func (api *API) GetShare(ctx context.Context, height uint64, row, col int) (libs
 }
 
 func (api *API) GetSamples(ctx context.Context, header *header.ExtendedHeader,
-	indices []shwap.SampleIndex,
+	indices []shwap.SampleCoords,
 ) ([]shwap.Sample, error) {
 	return api.Internal.GetSamples(ctx, header, indices)
 }
@@ -132,9 +132,9 @@ func (m module) GetShare(ctx context.Context, height uint64, row, col int) (libs
 		return libshare.Share{}, err
 	}
 
-	idx := shwap.SampleIndex{Row: row, Col: col}
+	idx := shwap.SampleCoords{Row: row, Col: col}
 
-	smpls, err := m.getter.GetSamples(ctx, header, []shwap.SampleIndex{idx})
+	smpls, err := m.getter.GetSamples(ctx, header, []shwap.SampleCoords{idx})
 	if err != nil {
 		return libshare.Share{}, err
 	}
@@ -143,7 +143,7 @@ func (m module) GetShare(ctx context.Context, height uint64, row, col int) (libs
 }
 
 func (m module) GetSamples(ctx context.Context, header *header.ExtendedHeader,
-	indices []shwap.SampleIndex,
+	indices []shwap.SampleCoords,
 ) ([]shwap.Sample, error) {
 	return m.getter.GetSamples(ctx, header, indices)
 }

share/availability/light/availability.go

@@ -115,9 +115,9 @@ func (la *ShareAvailability) SharesAvailable(ctx context.Context, header *header
 
 	log.Debugw("starting sampling session", "root", dah.String())
 
-	idxs := make([]shwap.SampleIndex, len(samples.Remaining))
+	idxs := make([]shwap.SampleCoords, len(samples.Remaining))
 	for i, s := range samples.Remaining {
-		idxs[i] = shwap.SampleIndex{Row: s.Row, Col: s.Col}
+		idxs[i] = shwap.SampleCoords{Row: s.Row, Col: s.Col}
 	}
 
 	smpls, err := la.getter.GetSamples(ctx, header, idxs)
@@ -197,7 +197,7 @@ func (la *ShareAvailability) Prune(ctx context.Context, h *header.ExtendedHeader
 
 	// delete stored samples
 	for _, sample := range result.Available {
-		idx := shwap.SampleIndex{Row: sample.Row, Col: sample.Col}
+		idx := shwap.SampleCoords{Row: sample.Row, Col: sample.Col}
 
 		blk, err := bitswap.NewEmptySampleBlock(h.Height(), idx, len(h.DAH.RowRoots))
 		if err != nil {

share/availability/light/availability_test.go

@@ -51,7 +51,7 @@ func TestSharesAvailableSuccess(t *testing.T) {
 	getter.EXPECT().
 		GetSamples(gomock.Any(), eh, gomock.Any()).
 		DoAndReturn(
-			func(_ context.Context, hdr *header.ExtendedHeader, indices []shwap.SampleIndex) ([]shwap.Sample, error) {
+			func(_ context.Context, hdr *header.ExtendedHeader, indices []shwap.SampleCoords) ([]shwap.Sample, error) {
 				acc := eds.Rsmt2D{ExtendedDataSquare: square}
 				smpls := make([]shwap.Sample, len(indices))
 				for i, idx := range indices {
@@ -279,7 +279,7 @@ func (g successGetter) sampledList() []Sample {
 }
 
 func (g successGetter) GetSamples(_ context.Context, hdr *header.ExtendedHeader,
-	indices []shwap.SampleIndex,
+	indices []shwap.SampleCoords,
 ) ([]shwap.Sample, error) {
 	g.Lock()
 	defer g.Unlock()

share/eds/accessor.go

@@ -25,7 +25,7 @@ type Accessor interface {
 	// 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.
-	Sample(ctx context.Context, idx shwap.SampleIndex) (shwap.Sample, error)
+	Sample(ctx context.Context, idx shwap.SampleCoords) (shwap.Sample, error)
 	// AxisHalf returns half of shares axis of the given type and index. Side is determined by
 	// implementation. Implementations should indicate the side in the returned AxisHalf.
 	AxisHalf(ctx context.Context, axisType rsmt2d.Axis, axisIdx int) (AxisHalf, error)

share/eds/close_once.go

@@ -57,7 +57,7 @@ func (c *closeOnce) AxisRoots(ctx context.Context) (*share.AxisRoots, error) {
 	return c.f.AxisRoots(ctx)
 }
 
-func (c *closeOnce) Sample(ctx context.Context, idx shwap.SampleIndex) (shwap.Sample, error) {
+func (c *closeOnce) Sample(ctx context.Context, idx shwap.SampleCoords) (shwap.Sample, error) {
 	if c.closed.Load() {
 		return shwap.Sample{}, errAccessorClosed
 	}

share/eds/close_once_test.go

@@ -20,7 +20,7 @@ func TestWithClosedOnce(t *testing.T) {
 	stub := &stubEdsAccessorCloser{}
 	closedOnce := WithClosedOnce(stub)
 
-	_, err := closedOnce.Sample(ctx, shwap.SampleIndex{})
+	_, err := closedOnce.Sample(ctx, shwap.SampleCoords{})
 	require.NoError(t, err)
 	_, err = closedOnce.AxisHalf(ctx, rsmt2d.Row, 0)
 	require.NoError(t, err)
@@ -33,7 +33,7 @@ func TestWithClosedOnce(t *testing.T) {
 	require.True(t, stub.closed)
 
 	// Ensure that the underlying file is not accessible after closing
-	_, err = closedOnce.Sample(ctx, shwap.SampleIndex{})
+	_, err = closedOnce.Sample(ctx, shwap.SampleCoords{})
 	require.ErrorIs(t, err, errAccessorClosed)
 	_, err = closedOnce.AxisHalf(ctx, rsmt2d.Row, 0)
 	require.ErrorIs(t, err, errAccessorClosed)
@@ -59,7 +59,7 @@ func (s *stubEdsAccessorCloser) AxisRoots(context.Context) (*share.AxisRoots, er
 	return &share.AxisRoots{}, nil
 }
 
-func (s *stubEdsAccessorCloser) Sample(context.Context, shwap.SampleIndex) (shwap.Sample, error) {
+func (s *stubEdsAccessorCloser) Sample(context.Context, shwap.SampleCoords) (shwap.Sample, error) {
 	return shwap.Sample{}, nil
 }
 

share/eds/proofs_cache.go

@@ -112,7 +112,7 @@ func (c *proofsCache) AxisRoots(ctx context.Context) (*share.AxisRoots, error) {
 	return roots, nil
 }
 
-func (c *proofsCache) Sample(ctx context.Context, idx shwap.SampleIndex) (shwap.Sample, error) {
+func (c *proofsCache) Sample(ctx context.Context, idx shwap.SampleCoords) (shwap.Sample, error) {
 	axisType, axisIdx, shrIdx := rsmt2d.Row, idx.Row, idx.Col
 	ax, err := c.axisWithProofs(ctx, axisType, axisIdx)
 	if err != nil {

share/eds/rsmt2d.go

@@ -46,15 +46,15 @@ func (eds *Rsmt2D) AxisRoots(context.Context) (*share.AxisRoots, error) {
 // Sample returns share and corresponding proof for row and column indices.
 func (eds *Rsmt2D) Sample(
 	_ context.Context,
-	idx shwap.SampleIndex,
+	idx shwap.SampleCoords,
 ) (shwap.Sample, error) {
 	return eds.SampleForProofAxis(idx, rsmt2d.Row)
 }
 
 // SampleForProofAxis samples a share from an Extended Data Square based on the provided
 // row and column indices and proof axis. It returns a sample with the share and proof.
 func (eds *Rsmt2D) SampleForProofAxis(
-	idx shwap.SampleIndex,
+	idx shwap.SampleCoords,
 	proofType rsmt2d.Axis,
 ) (shwap.Sample, error) {
 	axisIdx, shrIdx := relativeIndexes(idx.Row, idx.Col, proofType)

share/eds/rsmt2d_test.go

@@ -56,7 +56,7 @@ func TestRsmt2dSampleForProofAxis(t *testing.T) {
 	for _, proofType := range []rsmt2d.Axis{rsmt2d.Row, rsmt2d.Col} {
 		for rowIdx := 0; rowIdx < odsSize*2; rowIdx++ {
 			for colIdx := 0; colIdx < odsSize*2; colIdx++ {
-				idx := shwap.SampleIndex{Row: rowIdx, Col: colIdx}
+				idx := shwap.SampleCoords{Row: rowIdx, Col: colIdx}
 
 				sample, err := accessor.SampleForProofAxis(idx, proofType)
 				require.NoError(t, err)

share/eds/testing.go

@@ -148,7 +148,7 @@ func testAccessorSample(
 		// t.Parallel() this fails the test for some reason
 		for rowIdx := 0; rowIdx < width; rowIdx++ {
 			for colIdx := 0; colIdx < width; colIdx++ {
-				idx := shwap.SampleIndex{Row: rowIdx, Col: colIdx}
+				idx := shwap.SampleCoords{Row: rowIdx, Col: colIdx}
 				testSample(ctx, t, acc, roots, idx)
 			}
 		}
@@ -163,8 +163,8 @@ func testAccessorSample(
 		for rowIdx := 0; rowIdx < width; rowIdx++ {
 			for colIdx := 0; colIdx < width; colIdx++ {
 				wg.Add(1)
-				idx := shwap.SampleIndex{Row: rowIdx, Col: colIdx}
-				go func(idx shwap.SampleIndex) {
+				idx := shwap.SampleCoords{Row: rowIdx, Col: colIdx}
+				go func(idx shwap.SampleCoords) {
 					defer wg.Done()
 					testSample(ctx, t, acc, roots, idx)
 				}(idx)
@@ -186,7 +186,7 @@ func testAccessorSample(
 				defer wg.Done()
 				rowIdx := rand.IntN(int(eds.Width())) //nolint:gosec
 				colIdx := rand.IntN(int(eds.Width())) //nolint:gosec
-				testSample(ctx, t, acc, roots, shwap.SampleIndex{Row: rowIdx, Col: colIdx})
+				testSample(ctx, t, acc, roots, shwap.SampleCoords{Row: rowIdx, Col: colIdx})
 			}()
 		}
 		wg.Wait()
@@ -198,7 +198,7 @@ func testSample(
 	t *testing.T,
 	acc Accessor,
 	roots *share.AxisRoots,
-	idx shwap.SampleIndex,
+	idx shwap.SampleCoords,
 ) {
 	shr, err := acc.Sample(ctx, idx)
 	require.NoError(t, err)
@@ -447,7 +447,7 @@ func BenchGetSampleFromAccessor(
 			name := fmt.Sprintf("Size:%v/quadrant:%s", size, q)
 			b.Run(name, func(b *testing.B) {
 				rowIdx, colIdx := q.coordinates(acc.Size(ctx))
-				idx := shwap.SampleIndex{Row: rowIdx, Col: colIdx}
+				idx := shwap.SampleCoords{Row: rowIdx, Col: colIdx}
 
 				// warm up cache
 				_, err := acc.Sample(ctx, idx)

share/eds/validation.go

@@ -34,7 +34,7 @@ func (f validation) Size(ctx context.Context) int {
 	return int(size)
 }
 
-func (f validation) Sample(ctx context.Context, idx shwap.SampleIndex) (shwap.Sample, error) {
+func (f validation) Sample(ctx context.Context, idx shwap.SampleCoords) (shwap.Sample, error) {
 	_, err := shwap.NewSampleID(1, idx, f.Size(ctx))
 	if err != nil {
 		return shwap.Sample{}, fmt.Errorf("sample validation: %w", err)

share/eds/validation_test.go

@@ -34,7 +34,7 @@ func TestValidation_Sample(t *testing.T) {
 			accessor := &Rsmt2D{ExtendedDataSquare: randEDS}
 			validation := WithValidation(AccessorAndStreamer(accessor, nil))
 
-			idx := shwap.SampleIndex{Row: tt.rowIdx, Col: tt.colIdx}
+			idx := shwap.SampleCoords{Row: tt.rowIdx, Col: tt.colIdx}
 
 			_, err := validation.Sample(context.Background(), idx)
 			if tt.expectFail {

share/shwap/getter.go

@@ -32,7 +32,7 @@ type Getter interface {
 	// GetSamples gets samples by their indices.
 	// Returns Sample slice with requested number of samples in the requested order.
 	// May return partial response with some samples being empty if they weren't found.
-	GetSamples(ctx context.Context, header *header.ExtendedHeader, indices []SampleIndex) ([]Sample, error)
+	GetSamples(ctx context.Context, header *header.ExtendedHeader, indices []SampleCoords) ([]Sample, error)
 
 	// GetEDS gets the full EDS identified by the given extended header.
 	GetEDS(context.Context, *header.ExtendedHeader) (*rsmt2d.ExtendedDataSquare, error)

share/shwap/getters/cascade.go

@@ -43,7 +43,7 @@ func NewCascadeGetter(getters []shwap.Getter) *CascadeGetter {
 
 // GetSamples gets samples from any of registered shwap.Getters in cascading order.
 func (cg *CascadeGetter) GetSamples(ctx context.Context, hdr *header.ExtendedHeader,
-	indices []shwap.SampleIndex,
+	indices []shwap.SampleCoords,
 ) ([]shwap.Sample, error) {
 	ctx, span := tracer.Start(ctx, "cascade/get-samples", trace.WithAttributes(
 		attribute.Int("amount", len(indices)),

share/shwap/getters/cascade_test.go

@@ -30,7 +30,7 @@ func TestCascadeGetter(t *testing.T) {
 	getter := NewCascadeGetter(getters)
 	t.Run("GetShare", func(t *testing.T) {
 		for _, eh := range headers {
-			sh, err := getter.GetSamples(ctx, eh, []shwap.SampleIndex{{}})
+			sh, err := getter.GetSamples(ctx, eh, []shwap.SampleCoords{{}})
 			assert.NoError(t, err)
 			assert.NotEmpty(t, sh)
 		}

share/shwap/getters/testing.go

@@ -38,7 +38,7 @@ type SingleEDSGetter struct {
 
 // GetSamples get samples from a kept EDS if exist and if the correct root is given.
 func (seg *SingleEDSGetter) GetSamples(ctx context.Context, hdr *header.ExtendedHeader,
-	indices []shwap.SampleIndex,
+	indices []shwap.SampleCoords,
 ) ([]shwap.Sample, error) {
 	err := seg.checkRoots(hdr.DAH)
 	if err != nil {

share/shwap/p2p/bitswap/getter.go

@@ -79,7 +79,7 @@ func (g *Getter) Stop() {
 func (g *Getter) GetSamples(
 	ctx context.Context,
 	hdr *header.ExtendedHeader,
-	indices []shwap.SampleIndex,
+	indices []shwap.SampleCoords,
 ) ([]shwap.Sample, error) {
 	if len(indices) == 0 {
 		return nil, fmt.Errorf("no sample indicies to fetch")

share/shwap/p2p/bitswap/sample_block.go

@@ -47,7 +47,7 @@ type SampleBlock struct {
 }
 
 // NewEmptySampleBlock constructs a new empty SampleBlock.
-func NewEmptySampleBlock(height uint64, idx shwap.SampleIndex, edsSize int) (*SampleBlock, error) {
+func NewEmptySampleBlock(height uint64, idx shwap.SampleCoords, edsSize int) (*SampleBlock, error) {
 	id, err := shwap.NewSampleID(height, idx, edsSize)
 	if err != nil {
 		return nil, err
@@ -94,7 +94,7 @@ func (sb *SampleBlock) Marshal() ([]byte, error) {
 }
 
 func (sb *SampleBlock) Populate(ctx context.Context, eds eds.Accessor) error {
-	idx := shwap.SampleIndex{Row: sb.ID.RowIndex, Col: sb.ID.ShareIndex}
+	idx := shwap.SampleCoords{Row: sb.ID.RowIndex, Col: sb.ID.ShareIndex}
 
 	smpl, err := eds.Sample(ctx, idx)
 	if err != nil {