feat: Consensus initialization

Author: infrmtcs

.dockerignore

@@ -23,4 +23,9 @@ CODE_OF_CONDUCT.md
 CONTRIBUTING.md
 
 # Scripts
-scripts/
+scripts/
+
+.devbox/
+.plugins/
+tmp/
+snapshots/

blockchain/blockchain.go

@@ -52,7 +52,7 @@ type Reader interface {
 
 var (
 	ErrParentDoesNotMatchHead = errors.New("block's parent hash does not match head block hash")
-	SupportedStarknetVersion  = semver.MustParse("0.13.3")
+	SupportedStarknetVersion  = semver.MustParse("0.14.0")
 )
 
 func CheckBlockVersion(protocolVersion string) error {

cmd/juno/juno.go

@@ -60,6 +60,12 @@ const (
 	p2pPeersF                           = "p2p-peers"
 	p2pFeederNodeF                      = "p2p-feeder-node"
 	p2pPrivateKey                       = "p2p-private-key"
+	consensusF                          = "consensus"
+	consensusAddrF                      = "consensus-addr"
+	consensusPeersF                     = "consensus-peers"
+	consensusDBPathF                    = "consensus-db-path"
+	consensusMockIndexF                 = "consensus-mock-index" // TODO: remove this
+	consensusMockCountF                 = "consensus-mock-count" // TODO: remove this
 	metricsF                            = "metrics"
 	metricsHostF                        = "metrics-host"
 	metricsPortF                        = "metrics-port"
@@ -112,6 +118,12 @@ const (
 	defaultP2pPeers                           = ""
 	defaultP2pFeederNode                      = false
 	defaultP2pPrivateKey                      = ""
+	defaultConsensus                          = false
+	defaultConsensusAddr                      = ""
+	defaultConsensusPeers                     = ""
+	defaultConsensusDBPath                    = ""
+	defaultConsensusMockIndex                 = 0 // TODO: remove this
+	defaultConsensusMockCount                 = 1 // TODO: remove this
 	defaultMetrics                            = false
 	defaultMetricsPort                        = 9090
 	defaultGRPC                               = false
@@ -172,21 +184,27 @@ const (
 		"These peers can be either Feeder or regular nodes."
 	p2pFeederNodeUsage = "EXPERIMENTAL: Run juno as a feeder node which will only sync from feeder gateway and gossip the new" +
 		" blocks to the network."
-	p2pPrivateKeyUsage   = "EXPERIMENTAL: Hexadecimal representation of a private key on the Ed25519 elliptic curve."
-	metricsUsage         = "Enables the Prometheus metrics endpoint on the default port."
-	metricsHostUsage     = "The interface on which the Prometheus endpoint will listen for requests."
-	metricsPortUsage     = "The port on which the Prometheus endpoint will listen for requests."
-	grpcUsage            = "Enable the HTTP gRPC server on the default port."
-	grpcHostUsage        = "The interface on which the gRPC server will listen for requests."
-	grpcPortUsage        = "The port on which the gRPC server will listen for requests."
-	maxVMsUsage          = "Maximum number for VM instances to be used for RPC calls concurrently"
-	maxVMQueueUsage      = "Maximum number for requests to queue after reaching max-vms before starting to reject incoming requests"
-	remoteDBUsage        = "gRPC URL of a remote Juno node"
-	rpcMaxBlockScanUsage = "Maximum number of blocks scanned in single starknet_getEvents call"
-	dbCacheSizeUsage     = "Determines the amount of memory (in megabytes) allocated for caching data in the database."
-	dbMaxHandlesUsage    = "A soft limit on the number of open files that can be used by the DB"
-	gwAPIKeyUsage        = "API key for gateway endpoints to avoid throttling" //nolint: gosec
-	gwTimeoutsUsage      = "Timeouts for requests made to the gateway. Can be specified in three ways:\n" +
+	p2pPrivateKeyUsage      = "EXPERIMENTAL: Hexadecimal representation of a private key on the Ed25519 elliptic curve."
+	consensusUsage          = "EXPERIMENTAL: Enables the consensus server."
+	consensusAddrUsage      = "EXPERIMENTAL: Specify the address of the consensus server."
+	consensusPeersUsage     = "EXPERIMENTAL: Specify list of consensus peers split by a comma."
+	consensusDBPathUsage    = "EXPERIMENTAL: Specify the path to the consensus database."
+	consensusMockIndexUsage = "EXPERIMENTAL: Specify the index of the mock consensus server to use." // TODO: remove this
+	consensusMockCountUsage = "EXPERIMENTAL: Specify the number of mock consensus servers to use."   // TODO: remove this
+	metricsUsage            = "Enables the Prometheus metrics endpoint on the default port."
+	metricsHostUsage        = "The interface on which the Prometheus endpoint will listen for requests."
+	metricsPortUsage        = "The port on which the Prometheus endpoint will listen for requests."
+	grpcUsage               = "Enable the HTTP gRPC server on the default port."
+	grpcHostUsage           = "The interface on which the gRPC server will listen for requests."
+	grpcPortUsage           = "The port on which the gRPC server will listen for requests."
+	maxVMsUsage             = "Maximum number for VM instances to be used for RPC calls concurrently"
+	maxVMQueueUsage         = "Maximum number for requests to queue after reaching max-vms before starting to reject incoming requests"
+	remoteDBUsage           = "gRPC URL of a remote Juno node"
+	rpcMaxBlockScanUsage    = "Maximum number of blocks scanned in single starknet_getEvents call"
+	dbCacheSizeUsage        = "Determines the amount of memory (in megabytes) allocated for caching data in the database."
+	dbMaxHandlesUsage       = "A soft limit on the number of open files that can be used by the DB"
+	gwAPIKeyUsage           = "API key for gateway endpoints to avoid throttling" //nolint: gosec
+	gwTimeoutsUsage         = "Timeouts for requests made to the gateway. Can be specified in three ways:\n" +
 		"- Single value (e.g. '5s'): After each failure, the timeout will increase dynamically.\n" +
 		"- Comma-separated list (e.g. '5s,10s,20s'): Each value will be used in sequence after failures.\n" +
 		"- Single value with trailing comma (e.g. '5s,'): Uses a fixed timeout without dynamic adjustment."
@@ -374,6 +392,12 @@ func NewCmd(config *node.Config, run func(*cobra.Command, []string) error) *cobr
 	junoCmd.Flags().String(p2pPeersF, defaultP2pPeers, p2pPeersUsage)
 	junoCmd.Flags().Bool(p2pFeederNodeF, defaultP2pFeederNode, p2pFeederNodeUsage)
 	junoCmd.Flags().String(p2pPrivateKey, defaultP2pPrivateKey, p2pPrivateKeyUsage)
+	junoCmd.Flags().Bool(consensusF, defaultConsensus, consensusUsage)
+	junoCmd.Flags().String(consensusAddrF, defaultConsensusAddr, consensusAddrUsage)
+	junoCmd.Flags().String(consensusPeersF, defaultConsensusPeers, consensusPeersUsage)
+	junoCmd.Flags().String(consensusDBPathF, defaultConsensusDBPath, consensusDBPathUsage)
+	junoCmd.Flags().Int(consensusMockIndexF, defaultConsensusMockIndex, consensusMockIndexUsage) // TODO: remove this
+	junoCmd.Flags().Int(consensusMockCountF, defaultConsensusMockCount, consensusMockCountUsage) // TODO: remove this
 	junoCmd.Flags().Bool(metricsF, defaultMetrics, metricsUsage)
 	junoCmd.Flags().String(metricsHostF, defaultHost, metricsHostUsage)
 	junoCmd.Flags().Uint16(metricsPortF, defaultMetricsPort, metricsPortUsage)

docker-compose.consensus.yaml

@@ -0,0 +1,82 @@
+services:
+  node0:
+    image: nethermind/juno:consensus
+    ports:
+      - "6060:6060"
+    command: [
+      "--http",
+      "--http-host", "0.0.0.0",
+      "--network", "mainnet",
+      "--log-level", "debug",
+      "--disable-l1-verification",
+      "--db-path", "/db/main",
+      "--consensus",
+      "--consensus-db-path", "/db/consensus",
+      "--consensus-addr", "/ip4/0.0.0.0/tcp/7070",
+      "--consensus-peers", "",
+      "--consensus-mock-index", "0",
+      "--consensus-mock-count", "4",
+    ]
+
+  node1:
+    image: nethermind/juno:consensus
+    ports:
+      - "6061:6060"
+    depends_on:
+      - node0
+    command: [
+      "--http",
+      "--http-host", "0.0.0.0",
+      "--network", "mainnet",
+      "--log-level", "debug",
+      "--disable-l1-verification",
+      "--db-path", "/db/main",
+      "--consensus",
+      "--consensus-db-path", "/db/consensus",
+      "--consensus-addr", "/ip4/0.0.0.0/tcp/7070",
+      "--consensus-peers", "/dns4/node0/tcp/7070/p2p/12D3KooWDpJ7As7BWAwRMfu1VU2WCqNjvq387JEYKDBj4kx6nXTN",
+      "--consensus-mock-index", "1",
+      "--consensus-mock-count", "4",
+    ]
+
+  node2:
+    image: nethermind/juno:consensus
+    ports:
+      - "6062:6060"
+    depends_on:
+      - node1
+    command: [
+      "--http",
+      "--http-host", "0.0.0.0",
+      "--network", "mainnet",
+      "--log-level", "debug",
+      "--disable-l1-verification",
+      "--db-path", "/db/main",
+      "--consensus",
+      "--consensus-db-path", "/db/consensus",
+      "--consensus-addr", "/ip4/0.0.0.0/tcp/7070",
+      "--consensus-peers", "/dns4/node1/tcp/7070/p2p/12D3KooWPjceQrSwdWXPyLLeABRXmuqt69Rg3sBYbU1Nft9HyQ6X",
+      "--consensus-mock-index", "2",
+      "--consensus-mock-count", "4",
+    ]
+
+  node3:
+    image: nethermind/juno:consensus
+    ports:
+      - "6063:6060"
+    depends_on:
+      - node2
+    command: [
+      "--http",
+      "--http-host", "0.0.0.0",
+      "--network", "mainnet",
+      "--log-level", "debug",
+      "--disable-l1-verification",
+      "--db-path", "/db/main",
+      "--consensus",
+      "--consensus-db-path", "/db/consensus",
+      "--consensus-addr", "/ip4/0.0.0.0/tcp/7070",
+      "--consensus-peers", "/dns4/node2/tcp/7070/p2p/12D3KooWH3uVF6wv47WnArKHk5p6cvgCJEb74UTmxztmQDc298L3",
+      "--consensus-mock-index", "3",
+      "--consensus-mock-count", "4",
+    ]

node/node.go

@@ -16,6 +16,8 @@ import (
 	"github.com/NethermindEth/juno/builder"
 	"github.com/NethermindEth/juno/clients/feeder"
 	"github.com/NethermindEth/juno/clients/gateway"
+	"github.com/NethermindEth/juno/consensus"
+	"github.com/NethermindEth/juno/consensus/datasource"
 	"github.com/NethermindEth/juno/core"
 	"github.com/NethermindEth/juno/core/felt"
 	"github.com/NethermindEth/juno/db"
@@ -94,6 +96,13 @@ type Config struct {
 	P2PFeederNode bool   `mapstructure:"p2p-feeder-node"`
 	P2PPrivateKey string `mapstructure:"p2p-private-key"`
 
+	Consensus          bool   `mapstructure:"consensus"`
+	ConsensusAddr      string `mapstructure:"consensus-addr"`
+	ConsensusPeers     string `mapstructure:"consensus-peers"`
+	ConsensusDBPath    string `mapstructure:"consensus-db-path"`
+	ConsensusMockIndex int    `mapstructure:"consensus-mock-index"` // TODO: remove this
+	ConsensusMockCount int    `mapstructure:"consensus-mock-count"` // TODO: remove this
+
 	MaxVMs          uint `mapstructure:"max-vms"`
 	MaxVMQueue      uint `mapstructure:"max-vm-queue"`
 	RPCMaxBlockScan uint `mapstructure:"rpc-max-block-scan"`
@@ -223,12 +232,9 @@ func New(cfg *Config, version string, logLevel *utils.LogLevel) (*Node, error) {
 			WithLogger(log).
 			WithTimeouts(timeouts, fixed).
 			WithAPIKey(cfg.GatewayAPIKey)
-		feederGatewayDataSource := sync.NewFeederGatewayDataSource(chain, adaptfeeder.New(client))
-		synchronizer = sync.New(chain, feederGatewayDataSource, log, cfg.PendingPollInterval, dbIsRemote, database)
-		synchronizer.WithPlugin(junoPlugin)
-		chain.WithPendingBlockFn(synchronizer.PendingBlock)
 		gatewayClient = gateway.NewClient(cfg.Network.GatewayURL, log).WithUserAgent(ua).WithAPIKey(cfg.GatewayAPIKey)
 
+		syncDataSource := sync.NewFeederGatewayDataSource(chain, adaptfeeder.New(client))
 		if cfg.P2P {
 			if cfg.Network == utils.Mainnet {
 				return nil, fmt.Errorf("P2P cannot be used on %v network", utils.Mainnet)
@@ -246,8 +252,46 @@ func New(cfg *Config, version string, logLevel *utils.LogLevel) (*Node, error) {
 			}
 
 			services = append(services, p2pService)
+		} else if cfg.Consensus {
+			// TODO: Replace these mock components with the actual ones
+			mockConsensusServices := consensus.InitMockServices(0, 0, cfg.ConsensusMockIndex, cfg.ConsensusMockCount)
+
+			consensusDB, err := pebble.NewWithOptions(cfg.ConsensusDBPath, cfg.DBCacheSize, cfg.DBMaxHandles, cfg.Colour)
+			if err != nil {
+				return nil, fmt.Errorf("open consensus DB: %w", err)
+			}
+
+			consensusServices, err := consensus.Init(
+				log,
+				consensusDB,
+				chain,
+				nodeVM,
+				mockConsensusServices.NodeAddress,
+				mockConsensusServices.Validators,
+				mockConsensusServices.TimeoutFn,
+				cfg.ConsensusAddr,
+				mockConsensusServices.PrivateKey,
+			)
+			if err != nil {
+				return nil, fmt.Errorf("init consensus services: %w", err)
+			}
+
+			if err := consensus.Connect(context.Background(), consensusServices.Host, cfg.ConsensusPeers); err != nil {
+				return nil, fmt.Errorf("connect to consensus peers: %w", err)
+			}
+
+			dataSource := datasource.New(consensusServices.CommitListener, consensusServices.Proposer, consensusServices.P2P)
+			syncDataSource = dataSource
+
+			services = append(services, consensusServices.Proposer, consensusServices.P2P, consensusServices.Driver, dataSource)
 		}
 
+		if !cfg.P2P || cfg.P2PFeederNode {
+			synchronizer = sync.New(chain, syncDataSource, log, cfg.PendingPollInterval, dbIsRemote, database)
+			synchronizer.WithPlugin(junoPlugin)
+		}
+		chain.WithPendingBlockFn(synchronizer.PendingBlock)
+
 		var syncReader sync.Reader = &sync.NoopSynchronizer{}
 		if synchronizer != nil {
 			syncReader = synchronizer
@@ -460,7 +504,7 @@ func (n *Node) Run(ctx context.Context) {
 		return
 	}
 
-	if n.cfg.Sequencer {
+	if n.cfg.Sequencer || n.cfg.Consensus {
 		if err = buildGenesis(n.cfg.SeqGenesisFile, n.blockchain,
 			vm.New(false, n.log), uint64(n.cfg.RPCCallMaxSteps)); err != nil {
 			n.log.Errorw("Error building genesis state", "err", err)