IBFT 2.0

archive/restore.go

@@ -13,12 +13,16 @@ import (
 	"github.com/0xPolygon/polygon-edge/types"
 )
 
+const (
+	restore = "restore"
+)
+
 type blockchainInterface interface {
 	SubscribeEvents() blockchain.Subscription
 	Genesis() types.Hash
 	GetBlockByNumber(uint64, bool) (*types.Block, bool)
 	GetHashByNumber(uint64) types.Hash
-	WriteBlock(*types.Block) error
+	WriteBlock(*types.Block, string) error
 	VerifyFinalizedBlock(*types.Block) error
 }
 
@@ -78,7 +82,7 @@ func importBlocks(chain blockchainInterface, blockStream *blockStream, progressi
 			return err
 		}
 
-		if err := chain.WriteBlock(nextBlock); err != nil {
+		if err := chain.WriteBlock(nextBlock, restore); err != nil {
 			return err
 		}
 

archive/restore_test.go

@@ -49,7 +49,7 @@ func (m *mockChain) GetHashByNumber(num uint64) types.Hash {
 	return b.Hash()
 }
 
-func (m *mockChain) WriteBlock(block *types.Block) error {
+func (m *mockChain) WriteBlock(block *types.Block, _ string) error {
 	m.blocks = append(m.blocks, block)
 
 	return nil

blockchain/blockchain.go

@@ -71,6 +71,8 @@ type Blockchain struct {
 	stream *eventStream // Event subscriptions
 
 	gpAverage *gasPriceAverage // A reference to the average gas price
+
+	writeLock sync.Mutex
 }
 
 // gasPriceAverage keeps track of the average gas price (rolling average)
@@ -88,6 +90,7 @@ type Verifier interface {
 	PreStateCommit(header *types.Header, txn *state.Transition) error
 }
 
+// 	TODO: this should be part of Verifier (consensus)
 type Executor interface {
 	ProcessBlock(parentRoot types.Hash, block *types.Block, blockCreator types.Address) (*state.Transition, error)
 }
@@ -859,15 +862,15 @@ func (b *Blockchain) executeBlockTransactions(block *types.Block) (*BlockResult,
 
 // WriteBlock writes a single block to the local blockchain.
 // It doesn't do any kind of verification, only commits the block to the DB
-func (b *Blockchain) WriteBlock(block *types.Block) error {
-	// Log the information
-	b.logger.Info(
-		"write block",
-		"num",
-		block.Number(),
-		"parent",
-		block.ParentHash(),
-	)
+func (b *Blockchain) WriteBlock(block *types.Block, source string) error {
+	b.writeLock.Lock()
+	defer b.writeLock.Unlock()
+
+	if block.Number() <= b.Header().Number {
+		b.logger.Info("block already inserted", "block", block.Number(), "source", source)
+
+		return nil
+	}
 
 	header := block.Header
 
@@ -876,7 +879,7 @@ func (b *Blockchain) WriteBlock(block *types.Block) error {
 	}
 
 	// Write the header to the chain
-	evnt := &Event{}
+	evnt := &Event{Source: source}
 	if err := b.writeHeaderImpl(evnt, header); err != nil {
 		return err
 	}
@@ -906,8 +909,9 @@ func (b *Blockchain) WriteBlock(block *types.Block) error {
 
 	logArgs := []interface{}{
 		"number", header.Number,
+		"txs", len(block.Transactions),
 		"hash", header.Hash,
-		"txns", len(block.Transactions),
+		"parent", header.ParentHash,
 	}
 
 	if prevHeader, ok := b.GetHeaderByNumber(header.Number - 1); ok {

blockchain/storage/testing.go

@@ -1,7 +1,6 @@
 package storage
 
 import (
-	"fmt"
 	"math/big"
 	"reflect"
 	"testing"
@@ -416,11 +415,6 @@ func testWriteCanonicalHeader(t *testing.T, m PlaceholderStorage) {
 	assert.NoError(t, err)
 
 	if !reflect.DeepEqual(h, hh) {
-		fmt.Println("-- valid --")
-		fmt.Println(h)
-		fmt.Println("-- found --")
-		fmt.Println(hh)
-
 		t.Fatal("bad header")
 	}
 

command/genesis/genesis.go

@@ -2,7 +2,6 @@ package genesis
 
 import (
 	"fmt"
-
 	"github.com/0xPolygon/polygon-edge/command"
 	"github.com/0xPolygon/polygon-edge/command/helper"
 	"github.com/0xPolygon/polygon-edge/consensus/ibft"

command/genesis/params.go

@@ -193,7 +193,7 @@ func (p *genesisParams) initIBFTExtraData() {
 
 	ibftExtra := &ibft.IstanbulExtra{
 		Validators:    p.ibftValidators,
-		Seal:          []byte{},
+		ProposerSeal:  []byte{},
 		CommittedSeal: [][]byte{},
 	}
 

command/ibft/propose/params.go

@@ -3,10 +3,10 @@ package propose
 import (
 	"context"
 	"errors"
+	ibftOp "github.com/0xPolygon/polygon-edge/consensus/ibft/proto"
 
 	"github.com/0xPolygon/polygon-edge/command"
 	"github.com/0xPolygon/polygon-edge/command/helper"
-	ibftOp "github.com/0xPolygon/polygon-edge/consensus/ibft/proto"
 	"github.com/0xPolygon/polygon-edge/types"
 )
 

command/server/config/config.go

@@ -27,7 +27,6 @@ type Config struct {
 	LogLevel                 string     `json:"log_level" yaml:"log_level"`
 	RestoreFile              string     `json:"restore_file" yaml:"restore_file"`
 	BlockTime                uint64     `json:"block_time_s" yaml:"block_time_s"`
-	IBFTBaseTimeout          uint64     `json:"ibft_base_time_s" yaml:"ibft_base_time_s"`
 	Headers                  *Headers   `json:"headers" yaml:"headers"`
 	LogFilePath              string     `json:"log_to" yaml:"log_to"`
 	JSONRPCBatchRequestLimit uint64     `json:"json_rpc_batch_request_limit" yaml:"json_rpc_batch_request_limit"`
@@ -65,9 +64,6 @@ const (
 	// minimum block generation time in seconds
 	DefaultBlockTime uint64 = 2
 
-	// IBFT timeout in seconds
-	DefaultIBFTBaseTimeout uint64 = 10
-
 	// Multiplier to get IBFT timeout from block time
 	// timeout is calculated when IBFT timeout is not specified
 	BlockTimeMultiplierForTimeout uint64 = 5
@@ -103,10 +99,9 @@ func DefaultConfig() *Config {
 			PriceLimit: 0,
 			MaxSlots:   4096,
 		},
-		LogLevel:        "INFO",
-		RestoreFile:     "",
-		BlockTime:       DefaultBlockTime,
-		IBFTBaseTimeout: DefaultIBFTBaseTimeout,
+		LogLevel:    "INFO",
+		RestoreFile: "",
+		BlockTime:   DefaultBlockTime,
 		Headers: &Headers{
 			AccessControlAllowOrigins: []string{"*"},
 		},

command/server/init.go

@@ -20,7 +20,6 @@ import (
 
 var (
 	errInvalidBlockTime       = errors.New("invalid block time specified")
-	errWrongIBFTBaseTimeout   = errors.New("IBFT base timeout needs to be higher than block time")
 	errDataDirectoryUndefined = errors.New("data directory not defined")
 )
 
@@ -55,10 +54,6 @@ func (p *serverParams) initRawParams() error {
 		return err
 	}
 
-	if err := p.initIBFTBaseTimeout(); err != nil {
-		return err
-	}
-
 	if p.isDevMode {
 		p.initDevMode()
 	}
@@ -77,21 +72,6 @@ func (p *serverParams) initBlockTime() error {
 	return nil
 }
 
-func (p *serverParams) initIBFTBaseTimeout() error {
-	if p.rawConfig.IBFTBaseTimeout == 0 {
-		// Calculate from block time
-		p.rawConfig.IBFTBaseTimeout = p.rawConfig.BlockTime * config.BlockTimeMultiplierForTimeout
-
-		return nil
-	}
-
-	if p.rawConfig.IBFTBaseTimeout <= p.rawConfig.BlockTime {
-		return errWrongIBFTBaseTimeout
-	}
-
-	return nil
-}
-
 func (p *serverParams) initDataDirLocation() error {
 	if p.rawConfig.DataDir == "" {
 		return errDataDirectoryUndefined

command/server/params.go

@@ -33,13 +33,18 @@ const (
 	secretsConfigFlag            = "secrets-config"
 	restoreFlag                  = "restore"
 	blockTimeFlag                = "block-time"
-	ibftBaseTimeoutFlag          = "ibft-base-timeout"
 	devIntervalFlag              = "dev-interval"
 	devFlag                      = "dev"
 	corsOriginFlag               = "access-control-allow-origins"
 	logFileLocationFlag          = "log-to"
 )
 
+// Flags that are deprecated, but need to be preserved for
+// backwards compatibility with existing scripts
+const (
+	ibftBaseTimeoutFlagLEGACY = "ibft-base-timeout"
+)
+
 const (
 	unsetPeersValue = -1
 )
@@ -78,6 +83,8 @@ type serverParams struct {
 	jsonRPCBatchLengthLimit uint64
 	jsonRPCBlockRangeLimit  uint64
 
+	ibftBaseTimeoutLegacy uint64
+
 	genesisConfig *chain.Chain
 	secretsConfig *secrets.SecretsManagerConfig
 
@@ -158,15 +165,14 @@ func (p *serverParams) generateConfig() *server.Config {
 			MaxOutboundPeers: p.rawConfig.Network.MaxOutboundPeers,
 			Chain:            p.genesisConfig,
 		},
-		DataDir:         p.rawConfig.DataDir,
-		Seal:            p.rawConfig.ShouldSeal,
-		PriceLimit:      p.rawConfig.TxPool.PriceLimit,
-		MaxSlots:        p.rawConfig.TxPool.MaxSlots,
-		SecretsManager:  p.secretsConfig,
-		RestoreFile:     p.getRestoreFilePath(),
-		BlockTime:       p.rawConfig.BlockTime,
-		IBFTBaseTimeout: p.rawConfig.IBFTBaseTimeout,
-		LogLevel:        hclog.LevelFromString(p.rawConfig.LogLevel),
-		LogFilePath:     p.logFileLocation,
+		DataDir:        p.rawConfig.DataDir,
+		Seal:           p.rawConfig.ShouldSeal,
+		PriceLimit:     p.rawConfig.TxPool.PriceLimit,
+		MaxSlots:       p.rawConfig.TxPool.MaxSlots,
+		SecretsManager: p.secretsConfig,
+		RestoreFile:    p.getRestoreFilePath(),
+		BlockTime:      p.rawConfig.BlockTime,
+		LogLevel:       hclog.LevelFromString(p.rawConfig.LogLevel),
+		LogFilePath:    p.logFileLocation,
 	}
 }

command/server/server.go

@@ -186,17 +186,6 @@ func setFlags(cmd *cobra.Command) {
 		"minimum block time in seconds (at least 1s)",
 	)
 
-	cmd.Flags().Uint64Var(
-		&params.rawConfig.IBFTBaseTimeout,
-		ibftBaseTimeoutFlag,
-		// Calculate from block time if it is not given
-		0,
-		fmt.Sprintf(
-			"base IBFT timeout in seconds, it needs to be larger than block time. (block time * %d) is set if it's zero",
-			config.BlockTimeMultiplierForTimeout,
-		),
-	)
-
 	cmd.Flags().StringArrayVar(
 		&params.corsAllowedOrigins,
 		corsOriginFlag,
@@ -226,9 +215,24 @@ func setFlags(cmd *cobra.Command) {
 		"write all logs to the file at specified location instead of writing them to console",
 	)
 
+	setLegacyFlags(cmd)
 	setDevFlags(cmd)
 }
 
+// setLegacyFlags sets the legacy flags to preserve backwards compatibility
+// with running partners
+func setLegacyFlags(cmd *cobra.Command) {
+	// Legacy IBFT base timeout flag
+	cmd.Flags().Uint64Var(
+		&params.ibftBaseTimeoutLegacy,
+		ibftBaseTimeoutFlagLEGACY,
+		0,
+		"",
+	)
+
+	_ = cmd.Flags().MarkHidden(ibftBaseTimeoutFlagLEGACY)
+}
+
 func setDevFlags(cmd *cobra.Command) {
 	cmd.Flags().BoolVar(
 		&params.isDevMode,

consensus/consensus.go

@@ -46,36 +46,33 @@ type Consensus interface {
 
 // Config is the configuration for the consensus
 type Config struct {
-	// Logger to be used by the backend
+	// Logger to be used by the consensus
 	Logger *log.Logger
 
 	// Params are the params of the chain and the consensus
 	Params *chain.Params
 
-	// Config defines specific configuration parameters for the backend
+	// Config defines specific configuration parameters for the consensus
 	Config map[string]interface{}
 
 	// Path is the directory path for the consensus protocol tos tore information
 	Path string
 }
 
-type ConsensusParams struct {
-	Context         context.Context
-	Seal            bool
-	Config          *Config
-	Txpool          *txpool.TxPool
-	Network         *network.Server
-	Blockchain      *blockchain.Blockchain
-	Executor        *state.Executor
-	Grpc            *grpc.Server
-	Logger          hclog.Logger
-	Metrics         *Metrics
-	SecretsManager  secrets.SecretsManager
-	BlockTime       uint64
-	IBFTBaseTimeout uint64
+type Params struct {
+	Context        context.Context
+	Seal           bool
+	Config         *Config
+	TxPool         *txpool.TxPool
+	Network        *network.Server
+	Blockchain     *blockchain.Blockchain
+	Executor       *state.Executor
+	Grpc           *grpc.Server
+	Logger         hclog.Logger
+	Metrics        *Metrics
+	SecretsManager secrets.SecretsManager
+	BlockTime      uint64
 }
 
-// Factory is the factory function to create a discovery backend
-type Factory func(
-	*ConsensusParams,
-) (Consensus, error)
+// Factory is the factory function to create a discovery consensus
+type Factory func(*Params) (Consensus, error)