polygon/heimdall: tidy client naming (#12686)

Makefile

@@ -230,6 +230,7 @@ devtools:
 
 ## mocks:                             generate test mocks
 mocks:
+	@cd erigon-lib && $(MAKE) mocks
 	rm -f $(GOBIN)/mockgen
 	$(GOBUILD) -o "$(GOBIN)/mockgen" go.uber.org/mock/mockgen
 	grep -r -l --exclude-dir="erigon-lib" --exclude-dir="tests" --exclude-dir="*$(GOBINREL)*" "^// Code generated by MockGen. DO NOT EDIT.$$" . | xargs rm -r

cmd/devnet/services/polygon/heimdall.go

@@ -424,7 +424,7 @@ func (h *Heimdall) Start(ctx context.Context) error {
 	return startHTTPServer(ctx, server, "devnet Heimdall service", h.logger)
 }
 
-func makeHeimdallRouter(ctx context.Context, client heimdall.HeimdallClient) *chi.Mux {
+func makeHeimdallRouter(ctx context.Context, client heimdall.Client) *chi.Mux {
 	router := chi.NewRouter()
 
 	writeResponse := func(w http.ResponseWriter, result any, err error) {

cmd/devnet/services/polygon/heimdall_test.go

@@ -34,7 +34,7 @@ func TestHeimdallServer(t *testing.T) {
 
 	ctx := context.Background()
 	ctrl := gomock.NewController(t)
-	client := heimdall.NewMockHeimdallClient(ctrl)
+	client := heimdall.NewMockClient(ctrl)
 
 	events := []*heimdall.EventRecordWithTime{
 		{

cmd/devnet/services/polygon/heimdallsim/heimdall_simulator.go

@@ -43,7 +43,7 @@ type HeimdallSimulator struct {
 	logger log.Logger
 }
 
-var _ heimdall.HeimdallClient = (*HeimdallSimulator)(nil)
+var _ heimdall.Client = (*HeimdallSimulator)(nil)
 
 type sprintLengthCalculator struct{}
 

cmd/integration/commands/stages.go

@@ -1539,7 +1539,7 @@ func overrideStorageMode(db kv.RwDB, logger log.Logger) error {
 	})
 }
 
-func initConsensusEngine(ctx context.Context, cc *chain2.Config, dir string, db kv.RwDB, blockReader services.FullBlockReader, logger log.Logger) (engine consensus.Engine, heimdallClient heimdall.HeimdallClient) {
+func initConsensusEngine(ctx context.Context, cc *chain2.Config, dir string, db kv.RwDB, blockReader services.FullBlockReader, logger log.Logger) (engine consensus.Engine, heimdallClient heimdall.Client) {
 	config := ethconfig.Defaults
 
 	var consensusConfig interface{}
@@ -1551,7 +1551,7 @@ func initConsensusEngine(ctx context.Context, cc *chain2.Config, dir string, db
 		consensusConfig = cc.Bor
 		config.HeimdallURL = HeimdallURL
 		if !config.WithoutHeimdall {
-			heimdallClient = heimdall.NewHeimdallClient(config.HeimdallURL, logger)
+			heimdallClient = heimdall.NewHttpClient(config.HeimdallURL, logger)
 		}
 	} else {
 		consensusConfig = &config.Ethash

erigon-lib/Makefile

@@ -95,7 +95,7 @@ grpc: protoc-all
 mocks:
 	rm -f $(GOBIN)/mockgen
 	$(GOBUILD) -o "$(GOBIN)/mockgen" go.uber.org/mock/mockgen
-#	grep -r -l --exclude-dir="*$(GOBINREL)*" "^// Code generated by MockGen. DO NOT EDIT.$$" . | xargs rm -r
+	grep -r -l --exclude-dir="*$(GOBINREL)*" "^// Code generated by MockGen. DO NOT EDIT.$$" . | xargs rm -r
 	PATH="$(GOBIN):$(PATH)" go generate -run "mockgen" ./...
 
 lintci-deps:

eth/backend.go

@@ -530,15 +530,15 @@ func New(ctx context.Context, stack *node.Node, config *ethconfig.Config, logger
 		consensusConfig = &config.Ethash
 	}
 
-	var heimdallClient heimdall.HeimdallClient
+	var heimdallClient heimdall.Client
 	var polygonBridge *bridge.Service
 	var heimdallService *heimdall.Service
 	var bridgeRPC *bridge.BackendServer
 	var heimdallRPC *heimdall.BackendServer
 
 	if chainConfig.Bor != nil {
 		if !config.WithoutHeimdall {
-			heimdallClient = heimdall.NewHeimdallClient(config.HeimdallURL, logger)
+			heimdallClient = heimdall.NewHttpClient(config.HeimdallURL, logger)
 		}
 
 		if config.PolygonSync {

eth/ethconsensusconfig/config.go

@@ -45,7 +45,7 @@ import (
 )
 
 func CreateConsensusEngine(ctx context.Context, nodeConfig *nodecfg.Config, chainConfig *chain.Config, config interface{}, notify []string, noVerify bool,
-	heimdallClient heimdall.HeimdallClient, withoutHeimdall bool, blockReader services.FullBlockReader, readonly bool,
+	heimdallClient heimdall.Client, withoutHeimdall bool, blockReader services.FullBlockReader, readonly bool,
 	logger log.Logger, polygonBridge *bridge.Service, heimdallService *heimdall.Service,
 ) consensus.Engine {
 	var eng consensus.Engine

eth/stagedsync/bor_heimdall_shared.go

@@ -42,7 +42,7 @@ func FetchSpanZeroForMiningIfNeeded(
 	ctx context.Context,
 	db kv.RwDB,
 	blockReader services.FullBlockReader,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	heimdallStore heimdall.Store,
 	logger log.Logger,
 ) error {
@@ -106,7 +106,7 @@ func fetchAndWriteHeimdallSpan(
 	ctx context.Context,
 	spanID uint64,
 	tx kv.RwTx,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	heimdallStore heimdall.Store,
 	logPrefix string,
 	logger log.Logger,
@@ -201,7 +201,7 @@ func fetchAndWriteHeimdallCheckpoint(
 	ctx context.Context,
 	checkpointId uint64,
 	tx kv.RwTx,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	heimdallStore heimdall.Store,
 	logPrefix string,
 	logger log.Logger,
@@ -305,7 +305,7 @@ func fetchAndWriteHeimdallMilestone(
 	ctx context.Context,
 	milestoneId uint64,
 	tx kv.RwTx,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	heimdallStore heimdall.Store,
 	logPrefix string,
 	logger log.Logger,
@@ -332,7 +332,7 @@ func fetchRequiredHeimdallStateSyncEventsIfNeeded(
 	tx kv.RwTx,
 	borConfig *borcfg.BorConfig,
 	blockReader services.FullBlockReader,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	bridgeStore bridge.Store,
 	chainID string,
 	logPrefix string,
@@ -371,7 +371,7 @@ func fetchAndWriteHeimdallStateSyncEvents(
 	tx kv.RwTx,
 	config *borcfg.BorConfig,
 	blockReader services.FullBlockReader,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	bridgeStore bridge.Store,
 	chainID string,
 	logPrefix string,

eth/stagedsync/stage_bor_heimdall.go

@@ -62,7 +62,7 @@ type BorHeimdallCfg struct {
 	miningState     *MiningState
 	chainConfig     *chain.Config
 	borConfig       *borcfg.BorConfig
-	heimdallClient  heimdall.HeimdallClient
+	heimdallClient  heimdall.Client
 	heimdallStore   heimdall.Store
 	bridgeStore     bridge.Store
 	blockReader     services.FullBlockReader
@@ -79,7 +79,7 @@ func StageBorHeimdallCfg(
 	snapDb kv.RwDB,
 	miningState MiningState,
 	chainConfig chain.Config,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	heimdallStore heimdall.Store,
 	bridgeStore bridge.Store,
 	blockReader services.FullBlockReader,
@@ -651,7 +651,7 @@ func initValidatorSets(
 	tx kv.RwTx,
 	blockReader services.FullBlockReader,
 	config *borcfg.BorConfig,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	heimdallStore heimdall.Store,
 	chain consensus.ChainHeaderReader,
 	blockNum uint64,

eth/stagedsync/stage_polygon_sync.go

@@ -55,7 +55,7 @@ func NewPolygonSyncStageCfg(
 	logger log.Logger,
 	chainConfig *chain.Config,
 	db kv.RwDB,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	heimdallStore heimdall.Store,
 	bridgeStore bridge.Store,
 	sentry sentryproto.SentryClient,

eth/stagedsync/stagedsynctest/harness.go

@@ -27,11 +27,12 @@ import (
 	"testing"
 	"time"
 
-	"github.com/erigontech/erigon-lib/kv/order"
 	"github.com/holiman/uint256"
 	"github.com/stretchr/testify/require"
 	"go.uber.org/mock/gomock"
 
+	"github.com/erigontech/erigon-lib/kv/order"
+
 	"github.com/erigontech/erigon-lib/chain"
 	libcommon "github.com/erigontech/erigon-lib/common"
 	"github.com/erigontech/erigon-lib/crypto"
@@ -64,7 +65,7 @@ func InitHarness(ctx context.Context, t *testing.T, cfg HarnessCfg) Harness {
 	blockReader := m.BlockReader
 	borConsensusDB := memdb.NewTestDB(t)
 	ctrl := gomock.NewController(t)
-	heimdallClient := heimdall.NewMockHeimdallClient(ctrl)
+	heimdallClient := heimdall.NewMockClient(ctrl)
 	miningState := stagedsync.NewMiningState(&ethconfig.Defaults.Miner)
 	bridgeStore := bridge.NewDbStore(m.DB)
 	heimdallStore := heimdall.NewDbStore(m.DB)
@@ -180,7 +181,7 @@ type Harness struct {
 	miningSync                 *stagedsync.Sync
 	miningState                stagedsync.MiningState
 	bhCfg                      stagedsync.BorHeimdallCfg
-	heimdallClient             *heimdall.MockHeimdallClient
+	heimdallClient             *heimdall.MockClient
 	heimdallNextMockSpan       *heimdall.Span
 	heimdallLastEventID        uint64
 	heimdallLastEventHeaderNum uint64

polygon/bor/bor.go

@@ -325,7 +325,7 @@ type Bor struct {
 
 	spanner         Spanner
 	stateReceiver   StateReceiver
-	HeimdallClient  heimdall.HeimdallClient
+	HeimdallClient  heimdall.Client
 	useSpanReader   bool
 	spanReader      spanReader
 	useBridgeReader bool
@@ -354,7 +354,7 @@ func New(
 	db kv.RwDB,
 	blockReader services.FullBlockReader,
 	spanner Spanner,
-	heimdallClient heimdall.HeimdallClient,
+	heimdallClient heimdall.Client,
 	genesisContracts StateReceiver,
 	logger log.Logger,
 	bridgeReader bridgeReader,
@@ -1608,7 +1608,7 @@ func (c *Bor) CommitStates(
 	return nil
 }
 
-func (c *Bor) SetHeimdallClient(h heimdall.HeimdallClient) {
+func (c *Bor) SetHeimdallClient(h heimdall.Client) {
 	c.HeimdallClient = h
 }
 

polygon/bor/bor_internal_test.go

@@ -1,3 +1,19 @@
+// Copyright 2024 The Erigon Authors
+// This file is part of Erigon.
+//
+// Erigon is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Lesser General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Erigon is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Lesser General Public License for more details.
+//
+// You should have received a copy of the GNU Lesser General Public License
+// along with Erigon. If not, see <http://www.gnu.org/licenses/>.
+
 package bor
 
 import (

polygon/bor/finality/whitelist.go

@@ -32,7 +32,7 @@ import (
 )
 
 type config struct {
-	heimdall    heimdall.HeimdallClient
+	heimdall    heimdall.Client
 	borDB       kv.RwDB
 	chainDB     kv.RwDB
 	blockReader services.BlockReader
@@ -45,7 +45,7 @@ type BorAPI interface {
 	GetRootHash(start uint64, end uint64) (string, error)
 }
 
-func Whitelist(heimdall heimdall.HeimdallClient, borDB kv.RwDB, chainDB kv.RwDB, blockReader services.BlockReader, logger log.Logger, borAPI BorAPI, closeCh chan struct{}) {
+func Whitelist(heimdall heimdall.Client, borDB kv.RwDB, chainDB kv.RwDB, blockReader services.BlockReader, logger log.Logger, borAPI BorAPI, closeCh chan struct{}) {
 	if !flags.Milestone {
 		return
 	}
@@ -111,7 +111,7 @@ func startNoAckMilestoneByIDService(config *config) {
 	RetryHeimdallHandler(handleNoAckMilestoneByID, config, tickerDuration, noAckMilestoneTimeout, fnName)
 }
 
-type heimdallHandler func(ctx context.Context, heimdallClient heimdall.HeimdallClient, config *config) error
+type heimdallHandler func(ctx context.Context, heimdallClient heimdall.Client, config *config) error
 
 func RetryHeimdallHandler(fn heimdallHandler, config *config, tickerDuration time.Duration, timeout time.Duration, fnName string) {
 	retryHeimdallHandler(fn, config, tickerDuration, timeout, fnName)
@@ -174,7 +174,7 @@ func retryHeimdallHandler(fn heimdallHandler, config *config, tickerDuration tim
 }
 
 // handleWhitelistCheckpoint handles the checkpoint whitelist mechanism.
-func handleWhitelistCheckpoint(ctx context.Context, heimdallClient heimdall.HeimdallClient, config *config) error {
+func handleWhitelistCheckpoint(ctx context.Context, heimdallClient heimdall.Client, config *config) error {
 	service := whitelist.GetWhitelistingService()
 
 	// Create a new bor verifier, which will be used to verify checkpoints and milestones
@@ -194,7 +194,7 @@ func handleWhitelistCheckpoint(ctx context.Context, heimdallClient heimdall.Heim
 }
 
 // handleMilestone handles the milestone mechanism.
-func handleMilestone(ctx context.Context, heimdallClient heimdall.HeimdallClient, config *config) error {
+func handleMilestone(ctx context.Context, heimdallClient heimdall.Client, config *config) error {
 	service := whitelist.GetWhitelistingService()
 
 	// Create a new bor verifier, which will be used to verify checkpoints and milestones
@@ -222,7 +222,7 @@ func handleMilestone(ctx context.Context, heimdallClient heimdall.HeimdallClient
 	return nil
 }
 
-func handleNoAckMilestone(ctx context.Context, heimdallClient heimdall.HeimdallClient, config *config) error {
+func handleNoAckMilestone(ctx context.Context, heimdallClient heimdall.Client, config *config) error {
 	service := whitelist.GetWhitelistingService()
 	milestoneID, err := fetchNoAckMilestone(ctx, heimdallClient, config.logger)
 
@@ -239,7 +239,7 @@ func handleNoAckMilestone(ctx context.Context, heimdallClient heimdall.HeimdallC
 	return nil
 }
 
-func handleNoAckMilestoneByID(ctx context.Context, heimdallClient heimdall.HeimdallClient, config *config) error {
+func handleNoAckMilestoneByID(ctx context.Context, heimdallClient heimdall.Client, config *config) error {
 	service := whitelist.GetWhitelistingService()
 	milestoneIDs := service.GetMilestoneIDsList()
 

polygon/bor/finality/whitelist_helpers.go

@@ -42,7 +42,7 @@ var (
 
 // fetchWhitelistCheckpoint fetches the latest checkpoint from it's local heimdall
 // and verifies the data against bor data.
-func fetchWhitelistCheckpoint(ctx context.Context, heimdallClient heimdall.HeimdallClient, verifier *borVerifier, config *config) (uint64, common.Hash, error) {
+func fetchWhitelistCheckpoint(ctx context.Context, heimdallClient heimdall.Client, verifier *borVerifier, config *config) (uint64, common.Hash, error) {
 	var (
 		blockNum  uint64
 		blockHash common.Hash
@@ -82,7 +82,7 @@ func fetchWhitelistCheckpoint(ctx context.Context, heimdallClient heimdall.Heimd
 
 // fetchWhitelistMilestone fetches the latest milestone from it's local heimdall
 // and verifies the data against bor data.
-func fetchWhitelistMilestone(ctx context.Context, heimdallClient heimdall.HeimdallClient, verifier *borVerifier, config *config) (uint64, common.Hash, error) {
+func fetchWhitelistMilestone(ctx context.Context, heimdallClient heimdall.Client, verifier *borVerifier, config *config) (uint64, common.Hash, error) {
 	var (
 		num  uint64
 		hash common.Hash
@@ -117,7 +117,7 @@ func fetchWhitelistMilestone(ctx context.Context, heimdallClient heimdall.Heimda
 	return num, hash, nil
 }
 
-func fetchNoAckMilestone(ctx context.Context, heimdallClient heimdall.HeimdallClient, logger log.Logger) (string, error) {
+func fetchNoAckMilestone(ctx context.Context, heimdallClient heimdall.Client, logger log.Logger) (string, error) {
 	var (
 		milestoneID string
 	)
@@ -136,7 +136,7 @@ func fetchNoAckMilestone(ctx context.Context, heimdallClient heimdall.HeimdallCl
 	return milestoneID, nil
 }
 
-func fetchNoAckMilestoneByID(ctx context.Context, heimdallClient heimdall.HeimdallClient, milestoneID string, logger log.Logger) error {
+func fetchNoAckMilestoneByID(ctx context.Context, heimdallClient heimdall.Client, milestoneID string, logger log.Logger) error {
 	err := heimdallClient.FetchNoAckMilestone(ctx, milestoneID)
 	if errors.Is(err, heimdall.ErrServiceUnavailable) {
 		logger.Debug("[bor.heimdall] Failed to fetch no-ack milestone by ID", "milestoneID", milestoneID, "err", err)

polygon/bridge/service_test.go

@@ -42,10 +42,10 @@ var defaultBorConfig = borcfg.BorConfig{
 	StateSyncConfirmationDelay: map[string]uint64{"0": 1},
 }
 
-func setup(t *testing.T, borConfig borcfg.BorConfig) (*heimdall.MockHeimdallClient, *Service) {
+func setup(t *testing.T, borConfig borcfg.BorConfig) (*heimdall.MockClient, *Service) {
 	ctrl := gomock.NewController(t)
 	logger := testlog.Logger(t, log.LvlDebug)
-	heimdallClient := heimdall.NewMockHeimdallClient(ctrl)
+	heimdallClient := heimdall.NewMockClient(ctrl)
 	b := NewService(ServiceConfig{
 		Store:        NewMdbxStore(t.TempDir(), logger, false, 1),
 		Logger:       logger,