Merge consortium v2 to master

Makefile

@@ -11,6 +11,20 @@
 GOBIN = ./build/bin
 GO ?= latest
 GORUN = go run
+RONIN_CONTRACTS_PATH = ../ronin-dpos-contracts
+RONIN_CONTRACTS_OUTPUT_PATH = ./tmp/contracts
+GEN_CONTRACTS_OUTPUT_PATH = ./consensus/consortium/generated_contracts
+
+generate-contract:
+	@echo "Generating"
+	solc --abi --bin $(RONIN_CONTRACTS_PATH)/contracts/ronin/staking/Staking.sol -o $(RONIN_CONTRACTS_OUTPUT_PATH)/staking --include-path $(RONIN_CONTRACTS_PATH)/node_modules/ --base-path $(RONIN_CONTRACTS_PATH) --overwrite --optimize
+	abigen --abi $(RONIN_CONTRACTS_OUTPUT_PATH)/staking/Staking.abi --bin $(RONIN_CONTRACTS_OUTPUT_PATH)/staking/Staking.bin --pkg staking --out $(GEN_CONTRACTS_OUTPUT_PATH)/staking/staking.go
+
+	solc --abi --bin $(RONIN_CONTRACTS_PATH)/contracts/ronin/validator/RoninValidatorSet.sol -o $(RONIN_CONTRACTS_OUTPUT_PATH)/validator --include-path $(RONIN_CONTRACTS_PATH)/node_modules/ --base-path $(RONIN_CONTRACTS_PATH) --overwrite --optimize
+	abigen --abi $(RONIN_CONTRACTS_OUTPUT_PATH)/validator/RoninValidatorSet.abi --bin $(RONIN_CONTRACTS_OUTPUT_PATH)/validator/RoninValidatorSet.bin --pkg roninValidatorSet --out $(GEN_CONTRACTS_OUTPUT_PATH)/ronin_validator_set/ronin_validator_set.go
+
+	solc --abi --bin $(RONIN_CONTRACTS_PATH)/contracts/ronin/SlashIndicator.sol -o $(RONIN_CONTRACTS_OUTPUT_PATH)/slashing --include-path $(RONIN_CONTRACTS_PATH)/node_modules/ --base-path $(RONIN_CONTRACTS_PATH) --overwrite --optimize
+	abigen --abi $(RONIN_CONTRACTS_OUTPUT_PATH)/slashing/SlashIndicator.abi --bin $(RONIN_CONTRACTS_OUTPUT_PATH)/slashing/SlashIndicator.bin --pkg slashIndicator --out $(GEN_CONTRACTS_OUTPUT_PATH)/slash_indicator/slash_indicator.go
 
 ronin:
 	$(GORUN) build/ci.go install ./cmd/ronin

accounts/accounts.go

@@ -39,6 +39,7 @@ const (
 	MimetypeDataWithValidator = "data/validator"
 	MimetypeTypedData         = "data/typed"
 	MimetypeClique            = "application/x-clique-header"
+	MimetypeConsortium        = "application/x-clique-header"
 	MimetypeTextPlain         = "text/plain"
 )
 

cmd/utils/flags.go

@@ -1659,6 +1659,8 @@ func SetEthConfig(ctx *cli.Context, stack *node.Node, cfg *ethconfig.Config) {
 	if ctx.GlobalIsSet(VMEnableDebugFlag.Name) {
 		// TODO(fjl): force-enable this in --dev mode
 		cfg.EnablePreimageRecording = ctx.GlobalBool(VMEnableDebugFlag.Name)
+		// set debug environment to true
+		os.Setenv("DEBUG", "true")
 	}
 
 	if ctx.GlobalIsSet(RPCGlobalGasCapFlag.Name) {

consensus/clique/clique.go

@@ -562,20 +562,24 @@ func (c *Clique) Prepare(chain consensus.ChainHeaderReader, header *types.Header
 
 // Finalize implements consensus.Engine, ensuring no uncles are set, nor block
 // rewards given.
-func (c *Clique) Finalize(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header) {
+func (c *Clique) Finalize(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs *[]*types.Transaction,
+	uncles []*types.Header, receipts *[]*types.Receipt, systemTxs *[]*types.Transaction, usedGas *uint64) error {
 	// No block rewards in PoA, so the state remains as is and uncles are dropped
 	header.Root = state.IntermediateRoot(chain.Config().IsEIP158(header.Number))
 	header.UncleHash = types.CalcUncleHash(nil)
+
+	return nil
 }
 
 // FinalizeAndAssemble implements consensus.Engine, ensuring no uncles are set,
 // nor block rewards given, and returns the final block.
-func (c *Clique) FinalizeAndAssemble(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction, uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error) {
+func (c *Clique) FinalizeAndAssemble(chain consensus.ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction,
+	uncles []*types.Header, receipts []*types.Receipt) (*types.Block, []*types.Receipt, error) {
 	// Finalize block
-	c.Finalize(chain, header, state, txs, uncles)
+	c.Finalize(chain, header, state, &txs, uncles, nil, nil, nil)
 
 	// Assemble and return the final block for sealing
-	return types.NewBlock(header, txs, nil, receipts, trie.NewStackTrie(nil)), nil
+	return types.NewBlock(header, txs, nil, receipts, trie.NewStackTrie(nil)), receipts, nil
 }
 
 // Authorize injects a private key into the consensus engine to mint new blocks
@@ -588,6 +592,10 @@ func (c *Clique) Authorize(signer common.Address, signFn SignerFn) {
 	c.signFn = signFn
 }
 
+func (c *Clique) Delay(chain consensus.ChainReader, header *types.Header) *time.Duration {
+	return nil
+}
+
 // Seal implements consensus.Engine, attempting to create a sealed block using
 // the local signing credentials.
 func (c *Clique) Seal(chain consensus.ChainHeaderReader, block *types.Block, results chan<- *types.Block, stop <-chan struct{}) error {

consensus/consensus.go

@@ -18,8 +18,10 @@
 package consensus
 
 import (
-	"github.com/ethereum/go-ethereum/ethdb"
 	"math/big"
+	"time"
+
+	"github.com/ethereum/go-ethereum/ethdb"
 
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/state"
@@ -28,6 +30,10 @@ import (
 	"github.com/ethereum/go-ethereum/rpc"
 )
 
+var (
+	SystemAddress = common.HexToAddress("0xffffFFFfFFffffffffffffffFfFFFfffFFFfFFfE")
+)
+
 // ChainHeaderReader defines a small collection of methods needed to access the local
 // blockchain during header verification.
 type ChainHeaderReader interface {
@@ -93,16 +99,16 @@ type Engine interface {
 	//
 	// Note: The block header and state database might be updated to reflect any
 	// consensus rules that happen at finalization (e.g. block rewards).
-	Finalize(chain ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction,
-		uncles []*types.Header)
+	Finalize(chain ChainHeaderReader, header *types.Header, state *state.StateDB, txs *[]*types.Transaction,
+		uncles []*types.Header, receipts *[]*types.Receipt, systemTxs *[]*types.Transaction, usedGas *uint64) error
 
 	// FinalizeAndAssemble runs any post-transaction state modifications (e.g. block
 	// rewards) and assembles the final block.
 	//
 	// Note: The block header and state database might be updated to reflect any
 	// consensus rules that happen at finalization (e.g. block rewards).
 	FinalizeAndAssemble(chain ChainHeaderReader, header *types.Header, state *state.StateDB, txs []*types.Transaction,
-		uncles []*types.Header, receipts []*types.Receipt) (*types.Block, error)
+		uncles []*types.Header, receipts []*types.Receipt) (*types.Block, []*types.Receipt, error)
 
 	// Seal generates a new sealing request for the given input block and pushes
 	// the result into the given channel.
@@ -121,6 +127,9 @@ type Engine interface {
 	// APIs returns the RPC APIs this consensus engine provides.
 	APIs(chain ChainHeaderReader) []rpc.API
 
+	// Delay returns the max duration the miner can commit txs
+	Delay(chain ChainReader, header *types.Header) *time.Duration
+
 	// Close terminates any background threads maintained by the consensus engine.
 	Close() error
 }
@@ -132,3 +141,10 @@ type PoW interface {
 	// Hashrate returns the current mining hashrate of a PoW consensus engine.
 	Hashrate() float64
 }
+
+type PoSA interface {
+	Engine
+
+	IsSystemTransaction(tx *types.Transaction, header *types.Header) (bool, error)
+	IsSystemContract(to *common.Address) bool
+}

consensus/consortium/common/constants.go

@@ -0,0 +1,53 @@
+package common
+
+import (
+	"errors"
+	"github.com/ethereum/go-ethereum/crypto"
+)
+
+const (
+	ExtraSeal = crypto.SignatureLength // Fixed number of extra-data suffix bytes reserved for signer seal
+)
+
+var (
+	// ErrMissingSignature is returned if a block's extra-data section doesn't seem
+	// to contain a 65 byte secp256k1 signature.
+	ErrMissingSignature = errors.New("extra-data 65 byte signature suffix missing")
+
+	// ErrUnknownBlock is returned when the list of signers is requested for a block
+	// that is not part of the local blockchain.
+	ErrUnknownBlock = errors.New("unknown block")
+
+	// ErrMissingVanity is returned if a block's extra-data section is shorter than
+	// 32 bytes, which is required to store the signer vanity.
+	ErrMissingVanity = errors.New("extra-data 32 byte vanity prefix missing")
+
+	// ErrExtraValidators is returned if non-sprint-end block contain validator data in
+	// their extra-data fields.
+	ErrExtraValidators = errors.New("non-sprint-end block contains extra validator list")
+
+	// ErrInvalidSpanValidators is returned if a block contains an
+	// invalid list of validators (i.e. non divisible by 20 bytes).
+	ErrInvalidSpanValidators = errors.New("invalid validator list on sprint end block")
+
+	// ErrInvalidMixDigest is returned if a block's mix digest is non-zero.
+	ErrInvalidMixDigest = errors.New("non-zero mix digest")
+
+	// ErrInvalidUncleHash is returned if a block contains an non-empty uncle list.
+	ErrInvalidUncleHash = errors.New("non empty uncle hash")
+
+	// ErrInvalidDifficulty is returned if the difficulty of a block neither 1 or 2.
+	ErrInvalidDifficulty = errors.New("invalid difficulty")
+
+	// ErrInvalidCheckpointSigners is returned if a checkpoint block contains an
+	// invalid list of signers (i.e. non divisible by 20 bytes).
+	ErrInvalidCheckpointSigners = errors.New("invalid signer list on checkpoint block")
+
+	// ErrRecentlySigned is returned if a header is signed by an authorized entity
+	// that already signed a header recently, thus is temporarily not allowed to.
+	ErrRecentlySigned = errors.New("signed recently, must wait for others")
+
+	// ErrWrongDifficulty is returned if the difficulty of a block doesn't match the
+	// turn of the signer.
+	ErrWrongDifficulty = errors.New("wrong difficulty")
+)

consensus/consortium/common/context.go

@@ -0,0 +1,24 @@
+package common
+
+import (
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/consensus"
+	"github.com/ethereum/go-ethereum/core/types"
+)
+
+// ChainContext supports retrieving headers and consensus parameters from the
+// current blockchain to be used during transaction processing.
+type ChainContext struct {
+	Chain      consensus.ChainHeaderReader
+	Consortium consensus.Engine
+}
+
+// Engine retrieves the chain's consensus engine.
+func (c ChainContext) Engine() consensus.Engine {
+	return c.Consortium
+}
+
+// GetHeader returns the hash corresponding to their hash.
+func (c ChainContext) GetHeader(hash common.Hash, number uint64) *types.Header {
+	return c.Chain.GetHeader(hash, number)
+}