feat: exit warmup dynamically based on Kademlia peer stabilization (#5077)

Author: gacevicljubisa

cmd/bee/cmd/cmd.go

@@ -271,7 +271,7 @@ func (c *command) setAllFlags(cmd *cobra.Command) {
 	cmd.Flags().String(optionNameRedistributionAddress, "", "redistribution contract address")
 	cmd.Flags().String(optionNameStakingAddress, "", "staking contract address")
 	cmd.Flags().Uint64(optionNameBlockTime, 5, "chain block time")
-	cmd.Flags().Duration(optionWarmUpTime, time.Minute*5, "time to warmup the node before some major protocols can be kicked off")
+	cmd.Flags().Duration(optionWarmUpTime, time.Minute*5, "maximum node warmup duration; proceeds when stable or after this time")
 	cmd.Flags().Bool(optionNameMainNet, true, "triggers connect to main net bootnodes.")
 	cmd.Flags().Bool(optionNameRetrievalCaching, true, "enable forwarded content caching")
 	cmd.Flags().Bool(optionNameResync, false, "forces the node to resync postage contract data")

cmd/bee/cmd/start.go

@@ -279,57 +279,57 @@ func buildBeeNode(ctx context.Context, c *command, cmd *cobra.Command, logger lo
 	}
 
 	b, err := node.NewBee(ctx, c.config.GetString(optionNameP2PAddr), signerConfig.publicKey, signerConfig.signer, networkID, logger, signerConfig.libp2pPrivateKey, signerConfig.pssPrivateKey, signerConfig.session, &node.Options{
-		DataDir:                       c.config.GetString(optionNameDataDir),
+		Addr:                          c.config.GetString(optionNameP2PAddr),
+		AllowPrivateCIDRs:             c.config.GetBool(optionNameAllowPrivateCIDRs),
+		APIAddr:                       c.config.GetString(optionNameAPIAddr),
+		BlockchainRpcEndpoint:         c.config.GetString(optionNameBlockchainRpcEndpoint),
+		BlockProfile:                  c.config.GetBool(optionNamePProfBlock),
+		BlockTime:                     networkConfig.blockTime,
+		BootnodeMode:                  bootNode,
+		Bootnodes:                     networkConfig.bootNodes,
 		CacheCapacity:                 c.config.GetUint64(optionNameCacheCapacity),
-		DBOpenFilesLimit:              c.config.GetUint64(optionNameDBOpenFilesLimit),
+		ChainID:                       networkConfig.chainID,
+		ChequebookEnable:              c.config.GetBool(optionNameChequebookEnable),
+		CORSAllowedOrigins:            c.config.GetStringSlice(optionCORSAllowedOrigins),
+		DataDir:                       c.config.GetString(optionNameDataDir),
 		DBBlockCacheCapacity:          c.config.GetUint64(optionNameDBBlockCacheCapacity),
-		DBWriteBufferSize:             c.config.GetUint64(optionNameDBWriteBufferSize),
 		DBDisableSeeksCompaction:      c.config.GetBool(optionNameDBDisableSeeksCompaction),
-		APIAddr:                       c.config.GetString(optionNameAPIAddr),
-		Addr:                          c.config.GetString(optionNameP2PAddr),
-		NATAddr:                       c.config.GetString(optionNameNATAddr),
+		DBOpenFilesLimit:              c.config.GetUint64(optionNameDBOpenFilesLimit),
+		DBWriteBufferSize:             c.config.GetUint64(optionNameDBWriteBufferSize),
+		EnableStorageIncentives:       c.config.GetBool(optionNameStorageIncentivesEnable),
 		EnableWS:                      c.config.GetBool(optionNameP2PWSEnable),
-		WelcomeMessage:                c.config.GetString(optionWelcomeMessage),
-		Bootnodes:                     networkConfig.bootNodes,
-		CORSAllowedOrigins:            c.config.GetStringSlice(optionCORSAllowedOrigins),
-		TracingEnabled:                c.config.GetBool(optionNameTracingEnabled),
-		TracingEndpoint:               tracingEndpoint,
-		TracingServiceName:            c.config.GetString(optionNameTracingServiceName),
+		FullNodeMode:                  fullNode,
 		Logger:                        logger,
+		MinimumStorageRadius:          c.config.GetUint(optionMinimumStorageRadius),
+		MutexProfile:                  c.config.GetBool(optionNamePProfMutex),
+		NATAddr:                       c.config.GetString(optionNameNATAddr),
+		NeighborhoodSuggester:         neighborhoodSuggester,
+		PaymentEarly:                  c.config.GetInt64(optionNamePaymentEarly),
 		PaymentThreshold:              c.config.GetString(optionNamePaymentThreshold),
 		PaymentTolerance:              c.config.GetInt64(optionNamePaymentTolerance),
-		PaymentEarly:                  c.config.GetInt64(optionNamePaymentEarly),
-		ResolverConnectionCfgs:        resolverCfgs,
-		BootnodeMode:                  bootNode,
-		BlockchainRpcEndpoint:         c.config.GetString(optionNameBlockchainRpcEndpoint),
-		SwapFactoryAddress:            c.config.GetString(optionNameSwapFactoryAddress),
-		SwapInitialDeposit:            c.config.GetString(optionNameSwapInitialDeposit),
-		SwapEnable:                    c.config.GetBool(optionNameSwapEnable),
-		ChequebookEnable:              c.config.GetBool(optionNameChequebookEnable),
-		FullNodeMode:                  fullNode,
 		PostageContractAddress:        c.config.GetString(optionNamePostageContractAddress),
 		PostageContractStartBlock:     c.config.GetUint64(optionNamePostageContractStartBlock),
 		PriceOracleAddress:            c.config.GetString(optionNamePriceOracleAddress),
 		RedistributionContractAddress: c.config.GetString(optionNameRedistributionAddress),
-		StakingContractAddress:        c.config.GetString(optionNameStakingAddress),
-		BlockTime:                     networkConfig.blockTime,
-		WarmupTime:                    c.config.GetDuration(optionWarmUpTime),
-		ChainID:                       networkConfig.chainID,
-		RetrievalCaching:              c.config.GetBool(optionNameRetrievalCaching),
+		ReserveCapacityDoubling:       c.config.GetInt(optionReserveCapacityDoubling),
+		ResolverConnectionCfgs:        resolverCfgs,
 		Resync:                        c.config.GetBool(optionNameResync),
-		BlockProfile:                  c.config.GetBool(optionNamePProfBlock),
-		MutexProfile:                  c.config.GetBool(optionNamePProfMutex),
-		StaticNodes:                   staticNodes,
-		AllowPrivateCIDRs:             c.config.GetBool(optionNameAllowPrivateCIDRs),
-		UsePostageSnapshot:            c.config.GetBool(optionNameUsePostageSnapshot),
-		EnableStorageIncentives:       c.config.GetBool(optionNameStorageIncentivesEnable),
+		RetrievalCaching:              c.config.GetBool(optionNameRetrievalCaching),
+		StakingContractAddress:        c.config.GetString(optionNameStakingAddress),
 		StatestoreCacheCapacity:       c.config.GetUint64(optionNameStateStoreCacheCapacity),
+		StaticNodes:                   staticNodes,
+		SwapEnable:                    c.config.GetBool(optionNameSwapEnable),
+		SwapFactoryAddress:            c.config.GetString(optionNameSwapFactoryAddress),
+		SwapInitialDeposit:            c.config.GetString(optionNameSwapInitialDeposit),
 		TargetNeighborhood:            c.config.GetString(optionNameTargetNeighborhood),
-		NeighborhoodSuggester:         neighborhoodSuggester,
-		WhitelistedWithdrawalAddress:  c.config.GetStringSlice(optionNameWhitelistedWithdrawalAddress),
+		TracingEnabled:                c.config.GetBool(optionNameTracingEnabled),
+		TracingEndpoint:               tracingEndpoint,
+		TracingServiceName:            c.config.GetString(optionNameTracingServiceName),
 		TrxDebugMode:                  c.config.GetBool(optionNameTransactionDebugMode),
-		MinimumStorageRadius:          c.config.GetUint(optionMinimumStorageRadius),
-		ReserveCapacityDoubling:       c.config.GetInt(optionReserveCapacityDoubling),
+		UsePostageSnapshot:            c.config.GetBool(optionNameUsePostageSnapshot),
+		WarmupTime:                    c.config.GetDuration(optionWarmUpTime),
+		WelcomeMessage:                c.config.GetString(optionWelcomeMessage),
+		WhitelistedWithdrawalAddress:  c.config.GetStringSlice(optionNameWhitelistedWithdrawalAddress),
 	})
 
 	return b, err

go.mod

@@ -49,6 +49,7 @@ require (
 	golang.org/x/term v0.27.0
 	golang.org/x/time v0.5.0
 	gopkg.in/yaml.v2 v2.4.0
+	resenje.org/feed v0.1.2
 	resenje.org/multex v0.1.0
 	resenje.org/singleflight v0.4.0
 	resenje.org/web v0.4.3

go.sum

@@ -1532,6 +1532,8 @@ lukechampine.com/blake3 v1.3.0 h1:sJ3XhFINmHSrYCgl958hscfIa3bw8x4DqMP3u1YvoYE=
 lukechampine.com/blake3 v1.3.0/go.mod h1:0OFRp7fBtAylGVCO40o87sbupkyIGgbpv1+M1k1LM6k=
 resenje.org/daemon v0.1.2/go.mod h1:mF5JRpH3EbrxI9WoeKY78e6PqSsbBtX9jAQL5vj/GBA=
 resenje.org/email v0.1.3/go.mod h1:OhAVLRG3vqd9NSgayN3pAgzxTmc2B6mAefgShZvEgf0=
+resenje.org/feed v0.1.2 h1:3OianQkoI4EalWx1SlzHtGjUMsoB4XTJQbeehWiyeFI=
+resenje.org/feed v0.1.2/go.mod h1:ABlv4P3svuZY3dkZq3un+XIEoX+TDwbGEkjLcSP8TnM=
 resenje.org/jsonhttp v0.2.0/go.mod h1:EDyeguyTWj2fU3D3SCE0qNTgthzyEkHYLM1uu0uikHU=
 resenje.org/logging v0.1.5/go.mod h1:1IdoCm3+UwYfsplxDGV2pHCkUrLlQzlWwp4r28XfPx4=
 resenje.org/marshal v0.1.1/go.mod h1:P7Cla6Ju5CFvW4Y8JbRgWX1Hcy4L1w4qcCsyadO7G94=

packaging/bee.yaml

@@ -110,7 +110,7 @@ password-file: "/var/lib/bee/password"
 # use-postage-snapshot: false
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace
 # verbosity: info
-## time to warmup the node before some major protocols can be kicked off
+## maximum node warmup duration; proceeds when stable or after this time
 # warmup-time: 5m0s
 ## send a welcome message string during handshakes
 # welcome-message: ""

packaging/docker/env

@@ -123,7 +123,7 @@
 # BEE_TRANSACTION_DEBUG_MODE=false
 ## bootstrap node using postage snapshot from the network
 # BEE_USE_POSTAGE_SNAPSHOT=false
-## time to warmup the node before some major protocols can be kicked off
+## maximum node warmup duration; proceeds when stable or after this time
 # BEE_WARMUP_TIME=
 ## withdrawal target addresses
 # BEE_WITHDRAWAL_ADDRESSES_WHITELIST=

packaging/homebrew-amd64/bee.yaml

@@ -110,7 +110,7 @@ password-file: "/usr/local/var/lib/swarm-bee/password"
 # use-postage-snapshot: false
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace
 # verbosity: info
-## time to warmup the node before some major protocols can be kicked off
+## maximum node warmup duration; proceeds when stable or after this time
 # warmup-time: 5m0s
 ## send a welcome message string during handshakes
 # welcome-message: ""

packaging/homebrew-arm64/bee.yaml

@@ -110,7 +110,7 @@ password-file: "/opt/homebrew/var/lib/swarm-bee/password"
 # use-postage-snapshot: false
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace
 # verbosity: info
-## time to warmup the node before some major protocols can be kicked off
+## maximum node warmup duration; proceeds when stable or after this time
 # warmup-time: 5m0s
 ## send a welcome message string during handshakes
 # welcome-message: ""

packaging/scoop/bee.yaml

@@ -110,7 +110,7 @@ password-file: "./password"
 # use-postage-snapshot: false
 ## log verbosity level 0=silent, 1=error, 2=warn, 3=info, 4=debug, 5=trace
 # verbosity: info
-## time to warmup the node before some major protocols can be kicked off
+## maximum node warmup duration; proceeds when stable or after this time
 # warmup-time: 5m0s
 ## send a welcome message string during handshakes
 # welcome-message: ""

pkg/node/bootstrap.go

@@ -35,6 +35,7 @@ import (
 	"github.com/ethersphere/bee/v2/pkg/retrieval"
 	"github.com/ethersphere/bee/v2/pkg/settlement/pseudosettle"
 	"github.com/ethersphere/bee/v2/pkg/spinlock"
+	"github.com/ethersphere/bee/v2/pkg/stabilization"
 	"github.com/ethersphere/bee/v2/pkg/storage"
 	"github.com/ethersphere/bee/v2/pkg/storer"
 	"github.com/ethersphere/bee/v2/pkg/swarm"
@@ -72,9 +73,9 @@ func bootstrapNode(
 	networkID uint64,
 	logger log.Logger,
 	libp2pPrivateKey *ecdsa.PrivateKey,
+	detector *stabilization.Detector,
 	o *Options,
 ) (snapshot *postage.ChainSnapshot, retErr error) {
-
 	tracer, tracerCloser, err := tracing.NewTracer(&tracing.Options{
 		Enabled:     o.TracingEnabled,
 		Endpoint:    o.TracingEndpoint,
@@ -116,7 +117,7 @@ func bootstrapNode(
 	}
 	b.hiveCloser = hive
 
-	kad, err := kademlia.New(swarmAddress, addressbook, hive, p2ps, logger,
+	kad, err := kademlia.New(swarmAddress, addressbook, hive, p2ps, detector, logger,
 		kademlia.Options{Bootnodes: bootnodes, BootnodeMode: o.BootnodeMode, StaticNodes: o.StaticNodes, DataDir: o.DataDir})
 	if err != nil {
 		return nil, fmt.Errorf("unable to create kademlia: %w", err)
@@ -339,7 +340,6 @@ func getLatestSnapshot(
 }
 
 func batchStoreExists(s storage.StateStorer) (bool, error) {
-
 	hasOne := false
 	err := s.Iterate("batchstore_", func(key, value []byte) (stop bool, err error) {
 		hasOne = true