Move PolyBFT to Edge

.github/workflows/e2e.yaml

@@ -20,6 +20,8 @@ jobs:
         uses: actions/setup-go@v3
         with:
           go-version: 1.18.x
+      - name: Compile v3 contracts
+        run: make compile-v3-contracts
       - name: Run tests
         run: make test-e2e
       - name: Archive test logs

.github/workflows/lint.yml

@@ -24,5 +24,8 @@ jobs:
       - name: Checkout code
         uses: actions/checkout@v3
 
+      - name: Compile v3 contracts
+        run: make compile-v3-contracts
+
       - name: Lint
         uses: golangci/golangci-lint-action@v3

.github/workflows/test.yml

@@ -19,6 +19,9 @@ jobs:
         with:
           submodules: recursive
 
+      - name: Compile v3 contracts
+        run: make compile-v3-contracts
+
       - name: Run Go Test
         run: go test -coverprofile coverage.out -timeout 20m `go list ./... | grep -v e2e`
 

.gitignore

@@ -21,6 +21,9 @@ main
 
 # exclude build folder
 artifacts
+consensus/polybft/polybftcontracts/cache
+consensus/polybft/polybftcontracts/package-lock.json
+node_modules
 
 # Log files
 *.log

.gitmodules

@@ -1,3 +1,6 @@
 [submodule "tests/tests"]
 	path = tests/tests
 	url = https://github.com/ethereum/tests.git 
+[submodule "v3-contracts"]
+	path = v3-contracts
+	url = https://github.com/maticnetwork/v3-contracts.git

Makefile

@@ -11,10 +11,11 @@ bindata:
 .PHONY: protoc
 protoc:
 	protoc --go_out=. --go-grpc_out=. ./server/proto/*.proto
-	protoc --go_out=. --go-grpc_out=. ./protocol/proto/*.proto
+	#protoc --go_out=. --go-grpc_out=. ./protocol/proto/*.proto
 	protoc --go_out=. --go-grpc_out=. ./network/proto/*.proto
 	protoc --go_out=. --go-grpc_out=. ./txpool/proto/*.proto
 	protoc --go_out=. --go-grpc_out=. ./consensus/ibft/**/*.proto
+	protoc --go_out=. --go-grpc_out=. ./consensus/polybft/**/*.proto
 
 .PHONY: build
 build:
@@ -57,3 +58,7 @@ run-local:
 stop-local:
 	docker-compose -f ./docker/local/docker-compose.yml stop
 
+.PHONY: compile-v3-contracts
+compile-v3-contracts:
+	cd consensus/polybft/polybftcontracts && npm install && npm run compile
+

command/genesis/genesis.go

@@ -25,8 +25,6 @@ func GetCommand() *cobra.Command {
 	setFlags(genesisCmd)
 	setLegacyFlags(genesisCmd)
 
-	helper.SetRequiredFlags(genesisCmd, params.getRequiredFlags())
-
 	genesisCmd.AddCommand(
 		// genesis predeploy
 		predeploy.GetCommand(),
@@ -148,6 +146,40 @@ func setFlags(cmd *cobra.Command) {
 			"the maximum number of validators in the validator set for PoS",
 		)
 	}
+
+	// PolyBFT
+	{
+		cmd.Flags().IntVar(
+			&params.validatorSetSize,
+			validatorSetSizeFlag,
+			defaultValidatorSetSize,
+			"the total number of validators",
+		)
+		cmd.Flags().StringVar(
+			&params.polyBftValidatorPrefixPath,
+			polyBftValidatorPrefixPathFlag,
+			defaultPolyBftValidatorPrefixPath,
+			"prefix path for polybft validator folder directory",
+		)
+		cmd.Flags().Uint64Var(
+			&params.sprintSize,
+			sprintSizeFlag,
+			defaultSprintSize,
+			"the number of block included into a sprint",
+		)
+		cmd.Flags().DurationVar(
+			&params.blockTime,
+			blockTimeFlag,
+			defaultBlockTime,
+			"the predefined period which determines block creation frequency",
+		)
+		cmd.Flags().StringArrayVar(
+			&params.validators,
+			validatorsFlag,
+			[]string{},
+			"validators defined by user throughout a parameter (format: <address>:<blskey>)",
+		)
+	}
 }
 
 // setLegacyFlags sets the legacy flags to preserve backwards compatibility
@@ -164,19 +196,29 @@ func setLegacyFlags(cmd *cobra.Command) {
 	_ = cmd.Flags().MarkHidden(chainIDFlagLEGACY)
 }
 
-func runPreRun(_ *cobra.Command, _ []string) error {
+func runPreRun(cmd *cobra.Command, _ []string) error {
 	if err := params.validateFlags(); err != nil {
 		return err
 	}
 
+	helper.SetRequiredFlags(cmd, params.getRequiredFlags())
+
 	return params.initRawParams()
 }
 
 func runCommand(cmd *cobra.Command, _ []string) {
 	outputter := command.InitializeOutputter(cmd)
 	defer outputter.WriteOutput()
 
-	if err := params.generateGenesis(); err != nil {
+	var err error
+
+	if params.isPolyBFTConsensus() {
+		err = params.generatePolyBftGenesis()
+	} else {
+		err = params.generateGenesis()
+	}
+
+	if err != nil {
 		outputter.SetError(err)
 
 		return

command/genesis/params.go

@@ -3,6 +3,7 @@ package genesis
 import (
 	"errors"
 	"fmt"
+	"time"
 
 	"github.com/0xPolygon/polygon-edge/chain"
 	"github.com/0xPolygon/polygon-edge/command"
@@ -72,6 +73,14 @@ type genesisParams struct {
 	consensusEngineConfig map[string]interface{}
 
 	genesisConfig *chain.Chain
+
+	// PolyBFT
+	validatorSetSize int
+	sprintSize       uint64
+	blockTime        time.Duration
+	validators       []string
+
+	polyBftValidatorPrefixPath string
 }
 
 func (p *genesisParams) validateFlags() error {
@@ -93,7 +102,7 @@ func (p *genesisParams) validateFlags() error {
 	}
 
 	// Check that the epoch size is correct
-	if p.epochSize < 2 && server.ConsensusType(p.consensusRaw) == server.IBFTConsensus {
+	if p.epochSize < 2 && (p.isIBFTConsensus() || p.isPolyBFTConsensus()) {
 		// Epoch size must be greater than 1, so new transactions have a chance to be added to a block.
 		// Otherwise, every block would be an endblock (meaning it will not have any transactions).
 		// Check is placed here to avoid additional parsing if epochSize < 2
@@ -112,6 +121,10 @@ func (p *genesisParams) isIBFTConsensus() bool {
 	return server.ConsensusType(p.consensusRaw) == server.IBFTConsensus
 }
 
+func (p *genesisParams) isPolyBFTConsensus() bool {
+	return server.ConsensusType(p.consensusRaw) == server.PolyBFTConsensus
+}
+
 func (p *genesisParams) areValidatorsSetManually() bool {
 	return len(p.ibftValidatorsRaw) != 0
 }
@@ -121,14 +134,22 @@ func (p *genesisParams) areValidatorsSetByPrefix() bool {
 }
 
 func (p *genesisParams) getRequiredFlags() []string {
-	return []string{
-		command.BootnodeFlag,
+	if p.isIBFTConsensus() {
+		return []string{
+			command.BootnodeFlag,
+		}
 	}
+
+	return []string{}
 }
 
 func (p *genesisParams) initRawParams() error {
 	p.consensus = server.ConsensusType(p.consensusRaw)
 
+	if p.consensus == server.PolyBFTConsensus {
+		return nil
+	}
+
 	if err := p.initIBFTValidatorType(); err != nil {
 		return err
 	}