defaults.go

// SPDX-License-Identifier: BUSL-1.1
//
// Copyright (C) 2025, Berachain Foundation. All rights reserved.
// Use of this software is governed by the Business Source License included
// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
//
// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
// VERSIONS OF THE LICENSED WORK.
//
// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
//
// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
// TITLE.

package config

import (
	cometbft "github.com/berachain/beacon-kit/consensus/cometbft/service"
	"github.com/berachain/beacon-kit/payload/builder"
)

// Consensus clients.
const (
	NumValidators = 5

	ClientValidator0 = "cl-validator-beaconkit-0"
	ClientValidator1 = "cl-validator-beaconkit-1"
	ClientValidator2 = "cl-validator-beaconkit-2"
	ClientValidator3 = "cl-validator-beaconkit-3"
	ClientValidator4 = "cl-validator-beaconkit-4"
)

// default network configuration.
//
//nolint:gochecknoglobals // it's a default value
var (
	// defaultChainID is the default chain ID for the network.
	defaultChainID = 80087
	// defaultChainSpec is the default chain spec for the network.
	defaultChainSpec = "devnet"
)

// DefaultE2ETestConfig provides a default configuration for end-to-end tests,
// pre-populating with a standard set of validators and no additional
// services.
func DefaultE2ETestConfig() *E2ETestConfig {
	return &E2ETestConfig{
		NetworkConfiguration: defaultNetworkConfiguration(),
		NodeSettings:         defaultNodeSettings(),
		EthJSONRPCEndpoints:  defaultEthJSONRPCEndpoints(),
		AdditionalServices:   defaultAdditionalServices(),
	}
}

func defaultNetworkConfiguration() NetworkConfiguration {
	return NetworkConfiguration{
		ChainID:    defaultChainID,
		ChainSpec:  defaultChainSpec,
		Validators: defaultValidators(),
		FullNodes:  defaultFullNodes(),
		SeedNodes:  defaultSeedNodes(),
	}
}

func defaultValidators() NodeSet {
	return NodeSet{
		Type: "validator",
		Nodes: []Node{
			{
				ElType: "nethermind",
				// TODO: restore once we solve https://github.com/berachain/beacon-kit/issues/2177
				Replicas: 0, // nethermind cannot keep up with deposits checks
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "geth",
				Replicas: 2, //nolint:mnd // we want two replicas here
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "reth",
				Replicas: 2, //nolint:mnd // we want two replicas here
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "erigon",
				Replicas: 1,
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "besu",
				Replicas: 0, // Besu causing flakey tests.
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
		},
	}
}

func defaultFullNodes() NodeSet {
	return NodeSet{
		Type: "full",
		Nodes: []Node{
			{
				ElType:   "nethermind",
				Replicas: 1,
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "reth",
				Replicas: 1,
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "geth",
				Replicas: 1,
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "erigon",
				Replicas: 1,
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
			{
				ElType:   "besu",
				Replicas: 1,
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
		},
	}
}

func defaultSeedNodes() NodeSet {
	return NodeSet{
		Type: "seed",
		Nodes: []Node{
			{
				ElType:   "geth",
				Replicas: 1,
				KZGImpl:  "crate-crypto/go-kzg-4844",
			},
		},
	}
}

func defaultNodeSettings() NodeSettings {
	return NodeSettings{
		ExecutionSettings: defaultExecutionSettings(),
		ConsensusSettings: defaultConsensusSettings(),
	}
}

func defaultExecutionSettings() ExecutionSettings {
	return ExecutionSettings{
		Specs: NodeSpecs{
			MinCPU:    0,
			MaxCPU:    0,
			MinMemory: 0,
			MaxMemory: 2048, //nolint:mnd // 2 GB
		},
		Images: map[string]string{
			"besu":       "hyperledger/besu:24.5.4",
			"erigon":     "erigontech/erigon:v2.60.9",
			"ethereumjs": "ethpandaops/ethereumjs:stable",
			"geth":       "ethereum/client-go:stable",
			"nethermind": "nethermind/nethermind:latest",
			"reth":       "ghcr.io/paradigmxyz/reth:latest",
		},
	}
}

func defaultConsensusSettings() ConsensusSettings {
	var (
		defaultCfg = cometbft.DefaultConfig()
		consensus  = defaultCfg.Consensus
		p2p        = defaultCfg.P2P

		builderCfg = builder.DefaultConfig()
	)

	return ConsensusSettings{
		Specs: NodeSpecs{
			MinCPU:    0,
			MaxCPU:    2000, //nolint:mnd // 2 vCPUs
			MinMemory: 0,
			MaxMemory: 2048, //nolint:mnd // 2 GB
		},
		Images: map[string]string{
			"beaconkit": "beacond:kurtosis-local",
		},
		Config: ConsensusConfig{
			TimeoutPropose:      consensus.TimeoutPropose.String(),
			TimeoutPrevote:      consensus.TimeoutPrevote.String(),
			TimeoutPrecommit:    consensus.TimeoutPrecommit.String(),
			TimeoutCommit:       consensus.TimeoutCommit.String(),
			MaxNumInboundPeers:  p2p.MaxNumInboundPeers,
			MaxNumOutboundPeers: p2p.MaxNumOutboundPeers,
		},
		AppConfig: AppConfig{
			PayloadTimeout:                builderCfg.PayloadTimeout.String(),
			EnableOptimisticPayloadBuilds: builderCfg.Enabled,
		},
	}
}

func defaultEthJSONRPCEndpoints() []EthJSONRPCEndpoint {
	return []EthJSONRPCEndpoint{
		{
			Type: "blutgang",
			Clients: []string{
				// "el-full-nethermind-0",
				// "el-full-reth-0",
				"el-full-geth-2",
				// "el-full-erigon-3",
				// "el-full-erigon-3",
				// Besu causing flakey tests.
				// "el-full-besu-4",
			},
		},
	}
}

func defaultAdditionalServices() []AdditionalService {
	return []AdditionalService{}
}