diff --git a/beacon-chain/blockchain/process_block.go b/beacon-chain/blockchain/process_block.go index 0fb7d107d0..2890321e5f 100644 --- a/beacon-chain/blockchain/process_block.go +++ b/beacon-chain/blockchain/process_block.go @@ -584,7 +584,7 @@ func (s *Service) runLateBlockTasks() { // It returns a map where each key represents a missing BlobSidecar index. // An empty map means we have all indices; a non-empty map can be used to compare incoming // BlobSidecars against the set of known missing sidecars. -func missingBlobIndices(bs *filesystem.BlobStorage, root [fieldparams.RootLength]byte, expected [][]byte, slot primitives.Slot) (map[uint64]bool, error) { +func missingBlobIndices(store *filesystem.BlobStorage, root [fieldparams.RootLength]byte, expected [][]byte, slot primitives.Slot) (map[uint64]bool, error) { maxBlobsPerBlock := params.BeaconConfig().MaxBlobsPerBlock(slot) if len(expected) == 0 { return nil, nil @@ -592,7 +592,7 @@ func missingBlobIndices(bs *filesystem.BlobStorage, root [fieldparams.RootLength if len(expected) > maxBlobsPerBlock { return nil, errMaxBlobsExceeded } - indices := bs.Summary(root) + indices := store.Summary(root) missing := make(map[uint64]bool, len(expected)) for i := range expected { if len(expected[i]) > 0 && !indices.HasIndex(uint64(i)) { @@ -607,7 +607,7 @@ func missingBlobIndices(bs *filesystem.BlobStorage, root [fieldparams.RootLength // It returns a map where each key represents a missing DataColumnSidecar index. // An empty map means we have all indices; a non-empty map can be used to compare incoming // DataColumns against the set of known missing sidecars. -func missingDataColumnIndices(bs *filesystem.DataColumnStorage, root [fieldparams.RootLength]byte, expected map[uint64]bool) (map[uint64]bool, error) { +func missingDataColumnIndices(store *filesystem.DataColumnStorage, root [fieldparams.RootLength]byte, expected map[uint64]bool) (map[uint64]bool, error) { if len(expected) == 0 { return nil, nil } @@ -619,7 +619,7 @@ func missingDataColumnIndices(bs *filesystem.DataColumnStorage, root [fieldparam } // Get a summary of the data columns stored in the database. - summary := bs.Summary(root) + summary := store.Summary(root) // Check all expected data columns against the summary. missing := make(map[uint64]bool) @@ -717,7 +717,7 @@ func (s *Service) areDataColumnsAvailable( summary := s.dataColumnStorage.Summary(root) storedDataColumnsCount := summary.Count() - minimumColumnCountToReconstruct := peerdas.MinimumColumnsCountToReconstruct() + minimumColumnCountToReconstruct := peerdas.MinimumColumnCountToReconstruct() // As soon as we have enough data column sidecars, we can reconstruct the missing ones. // We don't need to wait for the rest of the data columns to declare the block as available. @@ -820,7 +820,7 @@ func (s *Service) areDataColumnsAvailable( missingIndices = uint64MapToSortedSlice(missingMap) } - return errors.Wrapf(ctx.Err(), "data column sidecars slot: %d, BlockRoot: %#x, missing %v", block.Slot(), root, missingIndices) + return errors.Wrapf(ctx.Err(), "data column sidecars slot: %d, BlockRoot: %#x, missing: %v", block.Slot(), root, missingIndices) } } } diff --git a/beacon-chain/blockchain/process_block_test.go b/beacon-chain/blockchain/process_block_test.go index 59c9ac6e8a..28d5b8117d 100644 --- a/beacon-chain/blockchain/process_block_test.go +++ b/beacon-chain/blockchain/process_block_test.go @@ -2889,7 +2889,7 @@ func TestIsDataAvailable(t *testing.T) { }) t.Run("Fulu - more than half of the columns in custody", func(t *testing.T) { - minimumColumnsCountToReconstruct := peerdas.MinimumColumnsCountToReconstruct() + minimumColumnsCountToReconstruct := peerdas.MinimumColumnCountToReconstruct() indices := make([]uint64, 0, minimumColumnsCountToReconstruct) for i := range minimumColumnsCountToReconstruct { indices = append(indices, i) @@ -2974,7 +2974,7 @@ func TestIsDataAvailable(t *testing.T) { startWaiting := make(chan bool) - minimumColumnsCountToReconstruct := peerdas.MinimumColumnsCountToReconstruct() + minimumColumnsCountToReconstruct := peerdas.MinimumColumnCountToReconstruct() indices := make([]uint64, 0, minimumColumnsCountToReconstruct-missingColumns) for i := range minimumColumnsCountToReconstruct - missingColumns { diff --git a/beacon-chain/blockchain/receive_data_column.go b/beacon-chain/blockchain/receive_data_column.go index 1fdb3473d8..bf362d84a9 100644 --- a/beacon-chain/blockchain/receive_data_column.go +++ b/beacon-chain/blockchain/receive_data_column.go @@ -17,7 +17,7 @@ func (s *Service) ReceiveDataColumns(dataColumnSidecars []blocks.VerifiedRODataC // ReceiveDataColumn receives a single data column. func (s *Service) ReceiveDataColumn(dataColumnSidecar blocks.VerifiedRODataColumn) error { if err := s.dataColumnStorage.Save([]blocks.VerifiedRODataColumn{dataColumnSidecar}); err != nil { - return errors.Wrap(err, "save data column sidecars") + return errors.Wrap(err, "save data column sidecar") } return nil diff --git a/beacon-chain/blockchain/setup_test.go b/beacon-chain/blockchain/setup_test.go index 754147369a..c76d07116d 100644 --- a/beacon-chain/blockchain/setup_test.go +++ b/beacon-chain/blockchain/setup_test.go @@ -89,7 +89,7 @@ func (mb *mockBroadcaster) BroadcastLightClientFinalityUpdate(_ context.Context, return nil } -func (mb *mockBroadcaster) BroadcastDataColumn(_ [fieldparams.RootLength]byte, _ uint64, _ *ethpb.DataColumnSidecar) error { +func (mb *mockBroadcaster) BroadcastDataColumnSidecar(_ [fieldparams.RootLength]byte, _ uint64, _ *ethpb.DataColumnSidecar) error { mb.broadcastCalled = true return nil } diff --git a/beacon-chain/core/peerdas/reconstruction.go b/beacon-chain/core/peerdas/reconstruction.go index 306ef2be70..9d0bff13c6 100644 --- a/beacon-chain/core/peerdas/reconstruction.go +++ b/beacon-chain/core/peerdas/reconstruction.go @@ -18,8 +18,8 @@ var ( ErrBlobsCellsProofsMismatch = errors.New("blobs and cells proofs mismatch") ) -// MinimumColumnsCountToReconstruct return the minimum number of columns needed to proceed to a reconstruction. -func MinimumColumnsCountToReconstruct() uint64 { +// MinimumColumnCountToReconstruct return the minimum number of columns needed to proceed to a reconstruction. +func MinimumColumnCountToReconstruct() uint64 { // If the number of columns is odd, then we need total / 2 + 1 columns to reconstruct. // If the number of columns is even, then we need total / 2 columns to reconstruct. return (params.BeaconConfig().NumberOfColumns + 1) / 2 @@ -58,7 +58,7 @@ func ReconstructDataColumnSidecars(inVerifiedRoSidecars []blocks.VerifiedRODataC // Check if there is enough sidecars to reconstruct the missing columns. sidecarCount := len(sidecarByIndex) - if uint64(sidecarCount) < MinimumColumnsCountToReconstruct() { + if uint64(sidecarCount) < MinimumColumnCountToReconstruct() { return nil, ErrNotEnoughDataColumnSidecars } diff --git a/beacon-chain/core/peerdas/reconstruction_test.go b/beacon-chain/core/peerdas/reconstruction_test.go index 735116e8ad..f16423a822 100644 --- a/beacon-chain/core/peerdas/reconstruction_test.go +++ b/beacon-chain/core/peerdas/reconstruction_test.go @@ -48,7 +48,7 @@ func TestMinimumColumnsCountToReconstruct(t *testing.T) { params.OverrideBeaconConfig(cfg) // Compute the minimum number of columns needed to reconstruct. - actual := peerdas.MinimumColumnsCountToReconstruct() + actual := peerdas.MinimumColumnCountToReconstruct() require.Equal(t, tc.expected, actual) }) } @@ -100,7 +100,7 @@ func TestReconstructDataColumnSidecars(t *testing.T) { t.Run("not enough columns to enable reconstruction", func(t *testing.T) { _, _, verifiedRoSidecars := util.GenerateTestFuluBlockWithSidecars(t, 3) - minimum := peerdas.MinimumColumnsCountToReconstruct() + minimum := peerdas.MinimumColumnCountToReconstruct() _, err := peerdas.ReconstructDataColumnSidecars(verifiedRoSidecars[:minimum-1]) require.ErrorIs(t, err, peerdas.ErrNotEnoughDataColumnSidecars) }) diff --git a/beacon-chain/p2p/broadcaster.go b/beacon-chain/p2p/broadcaster.go index c504a11524..7fdcf6ff95 100644 --- a/beacon-chain/p2p/broadcaster.go +++ b/beacon-chain/p2p/broadcaster.go @@ -305,15 +305,15 @@ func (s *Service) BroadcastLightClientFinalityUpdate(ctx context.Context, update return nil } -// BroadcastDataColumn broadcasts a data column to the p2p network, the message is assumed to be +// BroadcastDataColumnSidecar broadcasts a data column to the p2p network, the message is assumed to be // broadcasted to the current fork and to the input column subnet. -func (s *Service) BroadcastDataColumn( +func (s *Service) BroadcastDataColumnSidecar( root [fieldparams.RootLength]byte, dataColumnSubnet uint64, dataColumnSidecar *ethpb.DataColumnSidecar, ) error { // Add tracing to the function. - ctx, span := trace.StartSpan(s.ctx, "p2p.BroadcastDataColumn") + ctx, span := trace.StartSpan(s.ctx, "p2p.BroadcastDataColumnSidecar") defer span.End() // Ensure the data column sidecar is not nil. @@ -330,12 +330,12 @@ func (s *Service) BroadcastDataColumn( } // Non-blocking broadcast, with attempts to discover a column subnet peer if none available. - go s.internalBroadcastDataColumn(ctx, root, dataColumnSubnet, dataColumnSidecar, forkDigest) + go s.internalBroadcastDataColumnSidecar(ctx, root, dataColumnSubnet, dataColumnSidecar, forkDigest) return nil } -func (s *Service) internalBroadcastDataColumn( +func (s *Service) internalBroadcastDataColumnSidecar( ctx context.Context, root [fieldparams.RootLength]byte, columnSubnet uint64, @@ -343,7 +343,7 @@ func (s *Service) internalBroadcastDataColumn( forkDigest [fieldparams.VersionLength]byte, ) { // Add tracing to the function. - _, span := trace.StartSpan(ctx, "p2p.internalBroadcastDataColumn") + _, span := trace.StartSpan(ctx, "p2p.internalBroadcastDataColumnSidecar") defer span.End() // Increase the number of broadcast attempts. diff --git a/beacon-chain/p2p/broadcaster_test.go b/beacon-chain/p2p/broadcaster_test.go index 94abd3d13a..49ddf07ed1 100644 --- a/beacon-chain/p2p/broadcaster_test.go +++ b/beacon-chain/p2p/broadcaster_test.go @@ -716,7 +716,7 @@ func TestService_BroadcastDataColumn(t *testing.T) { // Attempt to broadcast nil object should fail. var emptyRoot [fieldparams.RootLength]byte - err = service.BroadcastDataColumn(emptyRoot, subnet, nil) + err = service.BroadcastDataColumnSidecar(emptyRoot, subnet, nil) require.ErrorContains(t, "attempted to broadcast nil", err) // Subscribe to the topic. @@ -727,7 +727,7 @@ func TestService_BroadcastDataColumn(t *testing.T) { time.Sleep(50 * time.Millisecond) // Broadcast to peers and wait. - err = service.BroadcastDataColumn(emptyRoot, subnet, sidecar) + err = service.BroadcastDataColumnSidecar(emptyRoot, subnet, sidecar) require.NoError(t, err) // Receive the message. diff --git a/beacon-chain/p2p/interfaces.go b/beacon-chain/p2p/interfaces.go index 9db9328a5c..e0ae32e1f3 100644 --- a/beacon-chain/p2p/interfaces.go +++ b/beacon-chain/p2p/interfaces.go @@ -51,7 +51,7 @@ type ( BroadcastBlob(ctx context.Context, subnet uint64, blob *ethpb.BlobSidecar) error BroadcastLightClientOptimisticUpdate(ctx context.Context, update interfaces.LightClientOptimisticUpdate) error BroadcastLightClientFinalityUpdate(ctx context.Context, update interfaces.LightClientFinalityUpdate) error - BroadcastDataColumn(root [fieldparams.RootLength]byte, columnSubnet uint64, dataColumnSidecar *ethpb.DataColumnSidecar) error + BroadcastDataColumnSidecar(root [fieldparams.RootLength]byte, columnSubnet uint64, dataColumnSidecar *ethpb.DataColumnSidecar) error } // SetStreamHandler configures p2p to handle streams of a certain topic ID. diff --git a/beacon-chain/p2p/testing/fuzz_p2p.go b/beacon-chain/p2p/testing/fuzz_p2p.go index 675429cd9f..58be1faa48 100644 --- a/beacon-chain/p2p/testing/fuzz_p2p.go +++ b/beacon-chain/p2p/testing/fuzz_p2p.go @@ -167,8 +167,8 @@ func (*FakeP2P) BroadcastLightClientFinalityUpdate(_ context.Context, _ interfac return nil } -// BroadcastDataColumn -- fake. -func (*FakeP2P) BroadcastDataColumn(_ [fieldparams.RootLength]byte, _ uint64, _ *ethpb.DataColumnSidecar) error { +// BroadcastDataColumnSidecar -- fake. +func (*FakeP2P) BroadcastDataColumnSidecar(_ [fieldparams.RootLength]byte, _ uint64, _ *ethpb.DataColumnSidecar) error { return nil } diff --git a/beacon-chain/p2p/testing/mock_broadcaster.go b/beacon-chain/p2p/testing/mock_broadcaster.go index abdb811d4f..ac7c951ffe 100644 --- a/beacon-chain/p2p/testing/mock_broadcaster.go +++ b/beacon-chain/p2p/testing/mock_broadcaster.go @@ -62,8 +62,8 @@ func (m *MockBroadcaster) BroadcastLightClientFinalityUpdate(_ context.Context, return nil } -// BroadcastDataColumn broadcasts a data column for mock. -func (m *MockBroadcaster) BroadcastDataColumn([fieldparams.RootLength]byte, uint64, *ethpb.DataColumnSidecar) error { +// BroadcastDataColumnSidecar broadcasts a data column for mock. +func (m *MockBroadcaster) BroadcastDataColumnSidecar([fieldparams.RootLength]byte, uint64, *ethpb.DataColumnSidecar) error { m.BroadcastCalled.Store(true) return nil } diff --git a/beacon-chain/p2p/testing/p2p.go b/beacon-chain/p2p/testing/p2p.go index c00ba0ddd7..5726d36a4f 100644 --- a/beacon-chain/p2p/testing/p2p.go +++ b/beacon-chain/p2p/testing/p2p.go @@ -228,8 +228,8 @@ func (p *TestP2P) BroadcastLightClientFinalityUpdate(_ context.Context, _ interf return nil } -// BroadcastDataColumn broadcasts a data column for mock. -func (p *TestP2P) BroadcastDataColumn([fieldparams.RootLength]byte, uint64, *ethpb.DataColumnSidecar) error { +// BroadcastDataColumnSidecar broadcasts a data column for mock. +func (p *TestP2P) BroadcastDataColumnSidecar([fieldparams.RootLength]byte, uint64, *ethpb.DataColumnSidecar) error { p.BroadcastCalled.Store(true) return nil } diff --git a/beacon-chain/rpc/lookup/blocker.go b/beacon-chain/rpc/lookup/blocker.go index 1a77d0d93b..a986bfa4fe 100644 --- a/beacon-chain/rpc/lookup/blocker.go +++ b/beacon-chain/rpc/lookup/blocker.go @@ -355,7 +355,7 @@ func (p *BeaconDbBlocker) blobsFromStoredDataColumns(block blocks.ROBlock, indic stored := summary.Stored() count := uint64(len(stored)) - if count < peerdas.MinimumColumnsCountToReconstruct() { + if count < peerdas.MinimumColumnCountToReconstruct() { // There is no way to reconstruct the data columns. return nil, &core.RpcError{ Err: errors.Errorf("the node does not custody enough data columns to reconstruct blobs - please start the beacon node with the `--%s` flag to ensure this call to succeed, or retry later if it is already the case", flags.SubscribeAllDataSubnets.Name), diff --git a/beacon-chain/rpc/lookup/blocker_test.go b/beacon-chain/rpc/lookup/blocker_test.go index 76d2f0344f..f347c82766 100644 --- a/beacon-chain/rpc/lookup/blocker_test.go +++ b/beacon-chain/rpc/lookup/blocker_test.go @@ -443,7 +443,7 @@ func TestGetBlob(t *testing.T) { setupFulu(t) _, dataColumnStorage := filesystem.NewEphemeralDataColumnStorageAndFs(t) - err = dataColumnStorage.Save(verifiedRoDataColumnSidecars[1 : peerdas.MinimumColumnsCountToReconstruct()+1]) + err = dataColumnStorage.Save(verifiedRoDataColumnSidecars[1 : peerdas.MinimumColumnCountToReconstruct()+1]) require.NoError(t, err) blocker := &BeaconDbBlocker{ diff --git a/beacon-chain/sync/data_columns_reconstruct.go b/beacon-chain/sync/data_columns_reconstruct.go index b278177c72..25831b7fbf 100644 --- a/beacon-chain/sync/data_columns_reconstruct.go +++ b/beacon-chain/sync/data_columns_reconstruct.go @@ -44,7 +44,7 @@ func (s *Service) reconstructSaveBroadcastDataColumnSidecars( numberOfColumns := params.BeaconConfig().NumberOfColumns // If reconstruction is not possible or if all columns are already stored, exit early. - if storedColumnsCount < peerdas.MinimumColumnsCountToReconstruct() || storedColumnsCount == numberOfColumns { + if storedColumnsCount < peerdas.MinimumColumnCountToReconstruct() || storedColumnsCount == numberOfColumns { return nil } @@ -198,7 +198,7 @@ func (s *Service) broadcastMissingDataColumnSidecars( subnet := peerdas.ComputeSubnetForDataColumnSidecar(verifiedRODataColumn.Index) // Broadcast the missing data column. - if err := s.cfg.p2p.BroadcastDataColumn(root, subnet, verifiedRODataColumn.DataColumnSidecar); err != nil { + if err := s.cfg.p2p.BroadcastDataColumnSidecar(root, subnet, verifiedRODataColumn.DataColumnSidecar); err != nil { log.WithError(err).Error("Broadcast data column") } diff --git a/beacon-chain/sync/data_columns_reconstruct_test.go b/beacon-chain/sync/data_columns_reconstruct_test.go index e3c0cae667..606ead059f 100644 --- a/beacon-chain/sync/data_columns_reconstruct_test.go +++ b/beacon-chain/sync/data_columns_reconstruct_test.go @@ -30,7 +30,7 @@ func TestReconstructDataColumns(t *testing.T) { root, block := roBlock.Root(), roBlock.Block() slot, proposerIndex := block.Slot(), block.ProposerIndex() - minimumCount := peerdas.MinimumColumnsCountToReconstruct() + minimumCount := peerdas.MinimumColumnCountToReconstruct() t.Run("not enough stored sidecars", func(t *testing.T) { storage := filesystem.NewEphemeralDataColumnStorage(t) @@ -61,7 +61,7 @@ func TestReconstructDataColumns(t *testing.T) { const cgc = 8 storage := filesystem.NewEphemeralDataColumnStorage(t) - minimumCount := peerdas.MinimumColumnsCountToReconstruct() + minimumCount := peerdas.MinimumColumnCountToReconstruct() err := storage.Save(verifiedRoDataColumns[:minimumCount]) require.NoError(t, err) diff --git a/beacon-chain/sync/subscriber_beacon_blocks.go b/beacon-chain/sync/subscriber_beacon_blocks.go index c8b83f134b..df69cb4011 100644 --- a/beacon-chain/sync/subscriber_beacon_blocks.go +++ b/beacon-chain/sync/subscriber_beacon_blocks.go @@ -151,7 +151,7 @@ func (s *Service) processDataColumnSidecarsFromExecution(ctx context.Context, ro sidecar := sidecars[columnIndex] - if err := s.cfg.p2p.BroadcastDataColumn(blockRoot, sidecar.Index, sidecar.DataColumnSidecar); err != nil { + if err := s.cfg.p2p.BroadcastDataColumnSidecar(blockRoot, sidecar.Index, sidecar.DataColumnSidecar); err != nil { log.WithError(err).Error("Failed to broadcast data column") } diff --git a/beacon-chain/sync/subscriber_data_column_sidecar.go b/beacon-chain/sync/subscriber_data_column_sidecar.go index 144da4896a..c983a95685 100644 --- a/beacon-chain/sync/subscriber_data_column_sidecar.go +++ b/beacon-chain/sync/subscriber_data_column_sidecar.go @@ -18,7 +18,7 @@ func (s *Service) dataColumnSubscriber(ctx context.Context, msg proto.Message) e } if err := s.receiveDataColumnSidecar(ctx, sidecar); err != nil { - return errors.Wrap(err, "receive data column") + return errors.Wrap(err, "receive data column sidecar") } slot := sidecar.Slot() @@ -26,7 +26,7 @@ func (s *Service) dataColumnSubscriber(ctx context.Context, msg proto.Message) e root := sidecar.BlockRoot() if err := s.reconstructSaveBroadcastDataColumnSidecars(ctx, slot, proposerIndex, root); err != nil { - return errors.Wrap(err, "reconstruct data columns") + return errors.Wrap(err, "reconstruct/save/broadcast data column sidecars") } return nil diff --git a/changelog/jtraglia_various-renaming.md b/changelog/jtraglia_various-renaming.md new file mode 100644 index 0000000000..1285ad889b --- /dev/null +++ b/changelog/jtraglia_various-renaming.md @@ -0,0 +1,3 @@ +### Changed + +- Renamed various variables/functions to be more clear.