rename package: backend

consensus/consensus.go → backend/consensus.go

@@ -1,4 +1,4 @@
-package consensus
+package backend
 
 import (
 	"context"
@@ -17,8 +17,8 @@ import (
 )
 
 //	TODO: rename to Backend
-// Consensus is the public interface for consensus mechanism
-// Each consensus mechanism must implement this interface in order to be valid
+// Consensus is the public interface for backend mechanism
+// Each backend mechanism must implement this interface in order to be valid
 type Consensus interface {
 	// VerifyHeader verifies the header is correct
 	VerifyHeader(header *types.Header) error
@@ -36,28 +36,28 @@ type Consensus interface {
 	// GetSyncProgression retrieves the current sync progression, if any
 	GetSyncProgression() *progress.Progression
 
-	// Initialize initializes the consensus (e.g. setup data)
+	// Initialize initializes the backend (e.g. setup data)
 	Initialize() error
 
-	// Start starts the consensus and servers
+	// Start starts the backend and servers
 	Start() error
 
 	// Close closes the connection
 	Close() error
 }
 
-// Config is the configuration for the consensus
+// Config is the configuration for the backend
 type Config struct {
 	// Logger to be used by the backend
 	Logger *log.Logger
 
-	// Params are the params of the chain and the consensus
+	// Params are the params of the chain and the backend
 	Params *chain.Params
 
 	// Config defines specific configuration parameters for the backend
 	Config map[string]interface{}
 
-	// Path is the directory path for the consensus protocol tos tore information
+	// Path is the directory path for the backend protocol tos tore information
 	Path string
 }
 

consensus/dev/dev.go → backend/dev/dev.go

@@ -5,16 +5,16 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/0xPolygon/polygon-edge/backend"
 	"github.com/0xPolygon/polygon-edge/blockchain"
-	"github.com/0xPolygon/polygon-edge/consensus"
 	"github.com/0xPolygon/polygon-edge/helper/progress"
 	"github.com/0xPolygon/polygon-edge/state"
 	"github.com/0xPolygon/polygon-edge/txpool"
 	"github.com/0xPolygon/polygon-edge/types"
 	"github.com/hashicorp/go-hclog"
 )
 
-// Dev consensus protocol seals any new transaction immediately
+// Dev backend protocol seals any new transaction immediately
 type Dev struct {
 	logger hclog.Logger
 
@@ -30,8 +30,8 @@ type Dev struct {
 
 // Factory implements the base factory method
 func Factory(
-	params *consensus.ConsensusParams,
-) (consensus.Consensus, error) {
+	params *backend.ConsensusParams,
+) (backend.Consensus, error) {
 	logger := params.Logger.Named("dev")
 
 	d := &Dev{
@@ -56,12 +56,12 @@ func Factory(
 	return d, nil
 }
 
-// Initialize initializes the consensus
+// Initialize initializes the backend
 func (d *Dev) Initialize() error {
 	return nil
 }
 
-// Start starts the consensus mechanism
+// Start starts the backend mechanism
 func (d *Dev) Start() error {
 	go d.run()
 
@@ -82,7 +82,7 @@ func (d *Dev) nextNotify() chan struct{} {
 }
 
 func (d *Dev) run() {
-	d.logger.Info("consensus started")
+	d.logger.Info("backend started")
 
 	for {
 		// wait until there is a new txn
@@ -186,7 +186,7 @@ func (d *Dev) writeNewBlock(parent *types.Header) error {
 
 	// Build the actual block
 	// The header hash is computed inside buildBlock
-	block := consensus.BuildBlock(consensus.BuildBlockParams{
+	block := backend.BuildBlock(backend.BuildBlockParams{
 		Header:   header,
 		Txns:     txns,
 		Receipts: transition.Receipts(),

consensus/dummy/dummy.go → backend/dummy/dummy.go

@@ -1,8 +1,8 @@
 package dummy
 
 import (
+	"github.com/0xPolygon/polygon-edge/backend"
 	"github.com/0xPolygon/polygon-edge/blockchain"
-	"github.com/0xPolygon/polygon-edge/consensus"
 	"github.com/0xPolygon/polygon-edge/helper/progress"
 	"github.com/0xPolygon/polygon-edge/state"
 	"github.com/0xPolygon/polygon-edge/txpool"
@@ -20,7 +20,7 @@ type Dummy struct {
 	executor   *state.Executor
 }
 
-func Factory(params *consensus.ConsensusParams) (consensus.Consensus, error) {
+func Factory(params *backend.ConsensusParams) (backend.Consensus, error) {
 	logger := params.Logger.Named("dummy")
 
 	d := &Dummy{
@@ -36,7 +36,7 @@ func Factory(params *consensus.ConsensusParams) (consensus.Consensus, error) {
 	return d, nil
 }
 
-// Initialize initializes the consensus
+// Initialize initializes the backend
 func (d *Dummy) Initialize() error {
 	return nil
 }

consensus/ibft/extra.go → backend/ibft/extra.go

@@ -9,7 +9,7 @@ import (
 
 var (
 	// IstanbulDigest represents a hash of "Istanbul practical byzantine fault tolerance"
-	// to identify whether the block is from Istanbul consensus engine
+	// to identify whether the block is from Istanbul backend engine
 	IstanbulDigest = types.StringToHash("0x63746963616c2062797a616e74696e65206661756c7420746f6c6572616e6365")
 
 	// IstanbulExtraVanity represents a fixed number of extra-data bytes reserved for proposer vanity

consensus/ibft/hooks.go → backend/ibft/hooks.go

@@ -6,7 +6,7 @@ import (
 	"github.com/0xPolygon/polygon-edge/helper/common"
 )
 
-// Define the type of the IBFT consensus
+// Define the type of the IBFT backend
 
 type MechanismType string
 
@@ -85,10 +85,10 @@ const (
 )
 
 type ConsensusMechanism interface {
-	// GetType returns the type of IBFT consensus mechanism (PoA / PoS)
+	// GetType returns the type of IBFT backend mechanism (PoA / PoS)
 	GetType() MechanismType
 
-	// GetHookMap returns the hooks registered with the specific consensus mechanism
+	// GetHookMap returns the hooks registered with the specific backend mechanism
 	GetHookMap() map[HookType]func(interface{}) error
 
 	// IsAvailable returns whether the corresponding hook is available
@@ -175,7 +175,7 @@ type IBFTFork struct {
 	MinValidatorCount *common.JSONNumber `json:"minValidatorCount,omitempty"`
 }
 
-// ConsensusMechanismFactory is the factory function to create a consensus mechanism
+// ConsensusMechanismFactory is the factory function to create a backend mechanism
 type ConsensusMechanismFactory func(ibft *Ibft, params *IBFTFork) (ConsensusMechanism, error)
 
 var mechanismBackends = map[MechanismType]ConsensusMechanismFactory{

consensus/ibft/ibft.go → backend/ibft/ibft.go

@@ -9,8 +9,8 @@ import (
 	"reflect"
 	"time"
 
-	"github.com/0xPolygon/polygon-edge/consensus"
-	"github.com/0xPolygon/polygon-edge/consensus/ibft/proto"
+	"github.com/0xPolygon/polygon-edge/backend"
+	"github.com/0xPolygon/polygon-edge/backend/ibft/proto"
 	"github.com/0xPolygon/polygon-edge/crypto"
 	"github.com/0xPolygon/polygon-edge/helper/common"
 	"github.com/0xPolygon/polygon-edge/helper/hex"
@@ -32,8 +32,8 @@ const (
 
 var (
 	ErrInvalidHookParam     = errors.New("invalid IBFT hook param passed in")
-	ErrInvalidMechanismType = errors.New("invalid consensus mechanism type in params")
-	ErrMissingMechanismType = errors.New("missing consensus mechanism type in params")
+	ErrInvalidMechanismType = errors.New("invalid backend mechanism type in params")
+	ErrMissingMechanismType = errors.New("missing backend mechanism type in params")
 )
 
 type blockchainInterface interface {
@@ -54,14 +54,14 @@ type txPoolInterface interface {
 	ResetWithHeaders(headers ...*types.Header)
 }
 
-// Ibft represents the IBFT consensus mechanism object
+// Ibft represents the IBFT backend mechanism object
 type Ibft struct {
 	sealing bool // Flag indicating if the node is a sealer
 
-	logger hclog.Logger      // Output logger
-	config *consensus.Config // Consensus configuration
-	Grpc   *grpc.Server      // gRPC configuration
-	state  *currentState     // Reference to the current state
+	logger hclog.Logger    // Output logger
+	config *backend.Config // Consensus configuration
+	Grpc   *grpc.Server    // gRPC configuration
+	state  *currentState   // Reference to the current state
 
 	blockchain blockchainInterface // Interface exposed by the blockchain layer
 	executor   *state.Executor     // Reference to the state executor
@@ -89,7 +89,7 @@ type Ibft struct {
 	// aux test methods
 	forceTimeoutCh bool
 
-	metrics *consensus.Metrics
+	metrics *backend.Metrics
 
 	secretsManager secrets.SecretsManager
 
@@ -124,10 +124,10 @@ func (i *Ibft) runHook(hookName HookType, height uint64, hookParam interface{})
 	return nil
 }
 
-// Factory implements the base consensus Factory method
+// Factory implements the base backend Factory method
 func Factory(
-	params *consensus.ConsensusParams,
-) (consensus.Consensus, error) {
+	params *backend.ConsensusParams,
+) (backend.Consensus, error) {
 	//	defaults for user set fields in genesis
 	var (
 		epochSize          = uint64(DefaultEpochSize)
@@ -185,7 +185,7 @@ func Factory(
 	return p, nil
 }
 
-// Start starts the IBFT consensus
+// Start starts the IBFT backend
 func (i *Ibft) Initialize() error {
 	// Set up the snapshots
 	if err := i.setupSnapshot(); err != nil {
@@ -195,7 +195,7 @@ func (i *Ibft) Initialize() error {
 	return nil
 }
 
-// Start starts the IBFT consensus
+// Start starts the IBFT backend
 func (i *Ibft) Start() error {
 	// register the grpc operator
 	if i.Grpc != nil {
@@ -284,7 +284,7 @@ func GetIBFTForks(ibftConfig map[string]interface{}) ([]IBFTFork, error) {
 	return nil, errors.New("current IBFT type not found")
 }
 
-//  setupTransport read current mechanism in params and sets up consensus mechanism
+//  setupTransport read current mechanism in params and sets up backend mechanism
 func (i *Ibft) setupMechanism() error {
 	ibftForks, err := GetIBFTForks(i.config.Config)
 	if err != nil {
@@ -296,7 +296,7 @@ func (i *Ibft) setupMechanism() error {
 	for idx, fork := range ibftForks {
 		factory, ok := mechanismBackends[fork.Type]
 		if !ok {
-			return fmt.Errorf("consensus mechanism doesn't define: %s", fork.Type)
+			return fmt.Errorf("backend mechanism doesn't define: %s", fork.Type)
 		}
 
 		fork := fork
@@ -399,9 +399,9 @@ func (i *Ibft) createKey() error {
 
 const IbftKeyName = "validator.key"
 
-// start starts the IBFT consensus state machine
+// start starts the IBFT backend state machine
 func (i *Ibft) start() {
-	// consensus always starts in SyncState mode in case it needs
+	// backend always starts in SyncState mode in case it needs
 	// to sync with other nodes.
 	i.setState(SyncState)
 
@@ -563,7 +563,7 @@ func (i *Ibft) runSyncState() {
 	}
 }
 
-// shouldWriteTransactions checks if each consensus mechanism accepts a block with transactions at given height
+// shouldWriteTransactions checks if each backend mechanism accepts a block with transactions at given height
 // returns true if all mechanisms accept
 // otherwise return false
 func (i *Ibft) shouldWriteTransactions(height uint64) bool {
@@ -640,7 +640,7 @@ func (i *Ibft) buildBlock(snap *Snapshot, parent *types.Header) (*types.Block, e
 	header.GasUsed = transition.TotalGas()
 
 	// build the block
-	block := consensus.BuildBlock(consensus.BuildBlockParams{
+	block := backend.BuildBlock(backend.BuildBlockParams{
 		Header:   header,
 		Txns:     txns,
 		Receipts: transition.Receipts(),
@@ -754,7 +754,7 @@ func (i *Ibft) runAcceptState() { // start new round
 		return
 	}
 
-	//	TODO: this will affect is the node is even running consensus for some round
+	//	TODO: this will affect is the node is even running backend for some round
 	snap, err := i.getSnapshot(parent.Number)
 	if err != nil {
 		i.logger.Error("cannot find snapshot", "num", parent.Number)
@@ -763,7 +763,7 @@ func (i *Ibft) runAcceptState() { // start new round
 		return
 	}
 
-	//	TODO: this will affect is the node is even running consensus for some round
+	//	TODO: this will affect is the node is even running backend for some round
 	if !snap.Set.Includes(i.validatorKeyAddr) {
 		// we are not a validator anymore, move back to sync state
 		i.logger.Info("we are not a validator anymore")
@@ -1054,7 +1054,7 @@ func (i *Ibft) insertBlock(block *types.Block) error {
 	block.Header = header
 	block.Header.ComputeHash() // TODO: this is not needed
 
-	//	TODO: this is also not needed, consensus has already verified everything
+	//	TODO: this is also not needed, backend has already verified everything
 	// Verify the header only, since the block body is already verified
 	if err := i.VerifyHeader(block.Header); err != nil {
 		return err
@@ -1378,7 +1378,7 @@ func (i *Ibft) IsLastOfEpoch(number uint64) bool {
 	return number > 0 && number%i.epochSize == 0
 }
 
-// Close closes the IBFT consensus mechanism, and does write back to disk
+// Close closes the IBFT backend mechanism, and does write back to disk
 func (i *Ibft) Close() error {
 	close(i.closeCh)
 

consensus/ibft/ibft_test.go → backend/ibft/ibft_test.go

@@ -8,9 +8,9 @@ import (
 	"testing"
 	"time"
 
+	"github.com/0xPolygon/polygon-edge/backend"
+	"github.com/0xPolygon/polygon-edge/backend/ibft/proto"
 	"github.com/0xPolygon/polygon-edge/blockchain"
-	"github.com/0xPolygon/polygon-edge/consensus"
-	"github.com/0xPolygon/polygon-edge/consensus/ibft/proto"
 	"github.com/0xPolygon/polygon-edge/helper/common"
 	"github.com/0xPolygon/polygon-edge/helper/hex"
 	"github.com/0xPolygon/polygon-edge/helper/progress"
@@ -1204,7 +1204,7 @@ func newMockIbft(t *testing.T, accounts []string, account string) *mockIbft {
 
 	ibft := &Ibft{
 		logger:           hclog.NewNullLogger(),
-		config:           &consensus.Config{},
+		config:           &backend.Config{},
 		blockchain:       m,
 		validatorKey:     addr.priv,
 		validatorKeyAddr: addr.Address(),
@@ -1213,7 +1213,7 @@ func newMockIbft(t *testing.T, accounts []string, account string) *mockIbft {
 		operator:         &operator{},
 		state:            newState(),
 		epochSize:        DefaultEpochSize,
-		metrics:          consensus.NilMetrics(),
+		metrics:          backend.NilMetrics(),
 	}
 
 	initIbftMechanism(PoA, ibft)
@@ -1262,7 +1262,7 @@ func newMockIBFTWithMockBlockchain(
 
 	ibft := &Ibft{
 		logger:           hclog.NewNullLogger(),
-		config:           &consensus.Config{},
+		config:           &backend.Config{},
 		blockchain:       m,
 		validatorKey:     addr.priv,
 		validatorKeyAddr: addr.Address(),
@@ -1271,7 +1271,7 @@ func newMockIBFTWithMockBlockchain(
 		operator:         &operator{},
 		state:            newState(),
 		epochSize:        DefaultEpochSize,
-		metrics:          consensus.NilMetrics(),
+		metrics:          backend.NilMetrics(),
 	}
 
 	initIbftMechanism(PoA, ibft)