prysm/beacon-chain/sync/data_columns_reconstruct.go

package sync

import (
	"context"
	"fmt"
	"slices"
	"time"

	"github.com/OffchainLabs/prysm/v6/beacon-chain/core/peerdas"
	fieldparams "github.com/OffchainLabs/prysm/v6/config/fieldparams"
	"github.com/OffchainLabs/prysm/v6/config/params"
	"github.com/OffchainLabs/prysm/v6/consensus-types/blocks"
	"github.com/OffchainLabs/prysm/v6/consensus-types/primitives"
	"github.com/OffchainLabs/prysm/v6/time/slots"
	"github.com/pkg/errors"
	"github.com/sirupsen/logrus"
)

const (
	broadcastMissingDataColumnsTimeIntoSlotMin = 1 * time.Second
	broadcastMissingDataColumnsSlack           = 2 * time.Second
)

// reconstructSaveBroadcastDataColumnSidecars reconstructs if possible and
// needed all data column sidecars. Then, it saves into the store missing
// sidecars. After a delay, it broadcasts in the background not seen via gossip
// (but reconstructed) sidecars.
func (s *Service) reconstructSaveBroadcastDataColumnSidecars(
	ctx context.Context,
	slot primitives.Slot,
	proposerIndex primitives.ValidatorIndex,
	root [fieldparams.RootLength]byte,
) error {
	startTime := time.Now()

	// Get the columns we store.
	storedDataColumns := s.cfg.dataColumnStorage.Summary(root)
	storedColumnsCount := storedDataColumns.Count()
	numberOfColumns := params.BeaconConfig().NumberOfColumns

	// Lock to prevent concurrent reconstructions.
	s.reconstructionLock.Lock()
	defer s.reconstructionLock.Unlock()

	// If reconstruction is not possible or if all columns are already stored, exit early.
	if storedColumnsCount < peerdas.MinimumColumnsCountToReconstruct() || storedColumnsCount == numberOfColumns {
		return nil
	}

	// Retrieve our local node info.
	nodeID := s.cfg.p2p.NodeID()
	custodyGroupCount := s.cfg.custodyInfo.ActualGroupCount()
	localNodeInfo, _, err := peerdas.Info(nodeID, custodyGroupCount)
	if err != nil {
		return errors.Wrap(err, "peer info")
	}

	// Load all the possible data columns sidecars, to minimize reconstruction time.
	verifiedSidecars, err := s.cfg.dataColumnStorage.Get(root, nil)
	if err != nil {
		return errors.Wrap(err, "get data column sidecars")
	}

	// Reconstruct all the data column sidecars.
	reconstructedSidecars, err := peerdas.ReconstructDataColumnSidecars(verifiedSidecars)
	if err != nil {
		return errors.Wrap(err, "reconstruct data column sidecars")
	}

	// Filter reconstructed sidecars to save.
	custodyColumns := localNodeInfo.CustodyColumns
	toSaveSidecars := make([]blocks.VerifiedRODataColumn, 0, len(custodyColumns))
	for _, sidecar := range reconstructedSidecars {
		if custodyColumns[sidecar.Index] {
			toSaveSidecars = append(toSaveSidecars, sidecar)
		}
	}

	// Save the data columns sidecars in the database.
	// Note: We do not call `receiveDataColumn`, because it will ignore
	// incoming data columns via gossip while we did not broadcast (yet) the reconstructed data columns.
	if err := s.cfg.dataColumnStorage.Save(toSaveSidecars); err != nil {
		return errors.Wrap(err, "save data column sidecars")
	}

	slotStartTime, err := slots.StartTime(s.cfg.clock.GenesisTime(), slot)
	if err != nil {
		return errors.Wrap(err, "failed to calculate slot start time")
	}
	log.WithFields(logrus.Fields{
		"root":                          fmt.Sprintf("%#x", root),
		"slot":                          slot,
		"fromColumnsCount":              storedColumnsCount,
		"sinceSlotStartTime":            time.Since(slotStartTime),
		"reconstructionAndSaveDuration": time.Since(startTime),
	}).Debug("Data columns reconstructed and saved")

	// Update reconstruction metrics
	dataColumnReconstructionHistogram.Observe(float64(time.Since(startTime).Milliseconds()))
	dataColumnReconstructionCounter.Add(float64(len(reconstructedSidecars) - len(verifiedSidecars)))

	// Schedule the broadcast.
	if err := s.scheduleMissingDataColumnSidecarsBroadcast(ctx, root, proposerIndex, slot); err != nil {
		return errors.Wrap(err, "schedule reconstructed data columns broadcast")
	}

	return nil
}

// scheduleMissingDataColumnSidecarsBroadcast schedules the broadcast of missing
// (aka. not seen via gossip but reconstructed) sidecars.
func (s *Service) scheduleMissingDataColumnSidecarsBroadcast(
	ctx context.Context,
	root [fieldparams.RootLength]byte,
	proposerIndex primitives.ValidatorIndex,
	slot primitives.Slot,
) error {
	log := log.WithFields(logrus.Fields{
		"root": fmt.Sprintf("%x", root),
		"slot": slot,
	})

	// Get the time corresponding to the start of the slot.
	genesisTime := s.cfg.chain.GenesisTime()
	slotStartTime, err := slots.StartTime(genesisTime, slot)
	if err != nil {
		return errors.Wrap(err, "failed to calculate slot start time")
	}

	// Compute the waiting time. This could be negative. In such a case, broadcast immediately.
	randFloat := s.reconstructionRandGen.Float64()
	timeIntoSlot := broadcastMissingDataColumnsTimeIntoSlotMin + time.Duration(float64(broadcastMissingDataColumnsSlack)*randFloat)
	broadcastTime := slotStartTime.Add(timeIntoSlot)
	waitingTime := time.Until(broadcastTime)
	time.AfterFunc(waitingTime, func() {
		// Return early if the context was canceled during the waiting time.
		if err := ctx.Err(); err != nil {
			return
		}

		if err := s.broadcastMissingDataColumnSidecars(slot, proposerIndex, root, timeIntoSlot); err != nil {
			log.WithError(err).Error("Failed to broadcast missing data column sidecars")
		}
	})

	return nil
}

func (s *Service) broadcastMissingDataColumnSidecars(
	slot primitives.Slot,
	proposerIndex primitives.ValidatorIndex,
	root [fieldparams.RootLength]byte,
	timeIntoSlot time.Duration,
) error {
	// Get the node ID.
	nodeID := s.cfg.p2p.NodeID()

	// Get the custody group count.
	custodyGroupCount := s.cfg.custodyInfo.ActualGroupCount()

	// Retrieve the local node info.
	localNodeInfo, _, err := peerdas.Info(nodeID, custodyGroupCount)
	if err != nil {
		return errors.Wrap(err, "peerdas info")
	}

	// Compute the missing data columns (data columns we should custody but we did not received via gossip.)
	missingColumns := make([]uint64, 0, len(localNodeInfo.CustodyColumns))
	for column := range localNodeInfo.CustodyColumns {
		if !s.hasSeenDataColumnIndex(slot, proposerIndex, column) {
			missingColumns = append(missingColumns, column)
		}
	}

	// Return early if there are no missing data columns.
	if len(missingColumns) == 0 {
		return nil
	}

	// Load from the store the non received but reconstructed data column.
	verifiedRODataColumnSidecars, err := s.cfg.dataColumnStorage.Get(root, missingColumns)
	if err != nil {
		return errors.Wrap(err, "data column storage get")
	}

	broadcastedColumns := make([]uint64, 0, len(verifiedRODataColumnSidecars))
	for _, verifiedRODataColumn := range verifiedRODataColumnSidecars {
		broadcastedColumns = append(broadcastedColumns, verifiedRODataColumn.Index)
		// Compute the subnet for this column.
		subnet := peerdas.ComputeSubnetForDataColumnSidecar(verifiedRODataColumn.Index)

		// Broadcast the missing data column.
		if err := s.cfg.p2p.BroadcastDataColumn(root, subnet, verifiedRODataColumn.DataColumnSidecar); err != nil {
			log.WithError(err).Error("Broadcast data column")
		}

		// Now, we can set the data column as seen.
		s.setSeenDataColumnIndex(slot, proposerIndex, verifiedRODataColumn.Index)
	}

	if logrus.GetLevel() >= logrus.DebugLevel {
		// Sort for nice logging.
		slices.Sort(broadcastedColumns)
		slices.Sort(missingColumns)

		log.WithFields(logrus.Fields{
			"timeIntoSlot":   timeIntoSlot,
			"missingColumns": missingColumns,
			"broadcasted":    broadcastedColumns,
		}).Debug("Start broadcasting not seen via gossip but reconstructed data columns")
	}

	return nil
}