Collator v3

cmd/geth/main.go

@@ -125,6 +125,9 @@ var (
 		utils.MinerExtraDataFlag,
 		utils.MinerRecommitIntervalFlag,
 		utils.MinerNoVerfiyFlag,
+		utils.MinerCollatorPluginEnableFlag,
+		utils.MinerCollatorPluginPath,
+		utils.MinerCollatorPluginConfigPath,
 		utils.NATFlag,
 		utils.NoDiscoverFlag,
 		utils.DiscoveryV5Flag,

cmd/utils/flags.go

@@ -477,6 +477,19 @@ var (
 		Name:  "miner.noverify",
 		Usage: "Disable remote sealing verification",
 	}
+	MinerCollatorPluginEnableFlag = cli.BoolFlag{
+		Name:  "miner.enablecollatorplugin",
+		Usage: "Enable custom miner collator",
+	}
+	MinerCollatorPluginPath = cli.StringFlag{
+		Name:  "miner.collatorpluginfile",
+		Usage: "Path to collator plugin compiled as shared library",
+	}
+	MinerCollatorPluginConfigPath = cli.StringFlag{
+		Name:  "miner.collatorpluginconfigfile",
+		Usage: "Path to custom collator config toml",
+	}
+
 	// Account settings
 	UnlockedAccountFlag = cli.StringFlag{
 		Name:  "unlock",
@@ -1401,6 +1414,15 @@ func setMiner(ctx *cli.Context, cfg *miner.Config) {
 	if ctx.GlobalIsSet(MinerNoVerfiyFlag.Name) {
 		cfg.Noverify = ctx.GlobalBool(MinerNoVerfiyFlag.Name)
 	}
+	if ctx.GlobalIsSet(MinerCollatorPluginEnableFlag.Name) {
+		cfg.UseCustomCollator = ctx.GlobalBool(MinerCollatorPluginEnableFlag.Name)
+	}
+	if ctx.GlobalIsSet(MinerCollatorPluginPath.Name) {
+		cfg.CollatorPath = ctx.GlobalString(MinerCollatorPluginPath.Name)
+	}
+	if ctx.GlobalIsSet(MinerCollatorPluginConfigPath.Name) {
+		cfg.CollatorConfigPath = ctx.GlobalString(MinerCollatorPluginConfigPath.Name)
+	}
 }
 
 func setWhitelist(ctx *cli.Context, cfg *ethconfig.Config) {

core/vm/interface.go

@@ -76,6 +76,22 @@ type StateDB interface {
 	ForEachStorage(common.Address, func(common.Hash, common.Hash) bool) error
 }
 
+type StateReader interface {
+	GetBalance(common.Address) *big.Int
+	GetNonce(common.Address) uint64
+	GetCodeHash(common.Address) common.Hash
+	GetCode(common.Address) []byte
+	GetCodeSize(common.Address) int
+	GetRefund() uint64
+	GetCommittedState(common.Address, common.Hash) common.Hash
+	GetState(common.Address, common.Hash) common.Hash
+	HasSuicided(common.Address) bool
+	Exist(common.Address) bool
+	Empty(common.Address) bool
+	AddressInAccessList(addr common.Address) bool
+	SlotInAccessList(addr common.Address, slot common.Hash) (addressOk bool, slotOk bool)
+}
+
 // CallContext provides a basic interface for the EVM calling conventions. The EVM
 // depends on this context being implemented for doing subcalls and initialising new EVM contracts.
 type CallContext interface {

eth/backend.go

@@ -111,6 +111,19 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
 		log.Warn("Sanitizing invalid miner gas price", "provided", config.Miner.GasPrice, "updated", ethconfig.Defaults.Miner.GasPrice)
 		config.Miner.GasPrice = new(big.Int).Set(ethconfig.Defaults.Miner.GasPrice)
 	}
+
+	var minerCollator miner.Collator
+	var minerCollatorAPI miner.CollatorAPI
+
+	if config.Miner.UseCustomCollator {
+		log.Info("using custom mining collator")
+		var err error
+		minerCollator, minerCollatorAPI, err = miner.LoadCollator(config.Miner.CollatorPath, config.Miner.CollatorConfigPath)
+		if err != nil {
+			return nil, err
+		}
+	}
+
 	if config.NoPruning && config.TrieDirtyCache > 0 {
 		if config.SnapshotCache > 0 {
 			config.TrieCleanCache += config.TrieDirtyCache * 3 / 5
@@ -225,7 +238,7 @@ func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error) {
 		return nil, err
 	}
 
-	eth.miner = miner.New(eth, &config.Miner, chainConfig, eth.EventMux(), eth.engine, eth.isLocalBlock)
+	eth.miner = miner.New(eth, &config.Miner, chainConfig, eth.EventMux(), eth.engine, eth.isLocalBlock, minerCollator, minerCollatorAPI)
 	eth.miner.SetExtra(makeExtraData(config.Miner.ExtraData))
 
 	eth.APIBackend = &EthAPIBackend{stack.Config().ExtRPCEnabled(), stack.Config().AllowUnprotectedTxs, eth, nil}
@@ -297,6 +310,15 @@ func (s *Ethereum) APIs() []rpc.API {
 	// Append any APIs exposed explicitly by the consensus engine
 	apis = append(apis, s.engine.APIs(s.BlockChain())...)
 
+	if s.config.Miner.UseCustomCollator && s.miner.API != nil {
+		apis = append(apis, rpc.API{
+			Namespace: "minercollator",
+			Version:   s.miner.API.Version(),
+			Service:   s.miner.API.Service(),
+			Public:    true,
+		})
+	}
+
 	// Append all the local APIs and return
 	return append(apis, []rpc.API{
 		{

eth/ethconfig/config.go

@@ -83,10 +83,13 @@ var Defaults = Config{
 	TrieTimeout:             60 * time.Minute,
 	SnapshotCache:           102,
 	Miner: miner.Config{
-		GasFloor: 8000000,
-		GasCeil:  8000000,
-		GasPrice: big.NewInt(params.GWei),
-		Recommit: 3 * time.Second,
+		GasFloor:           8000000,
+		GasCeil:            8000000,
+		GasPrice:           big.NewInt(params.GWei),
+		Recommit:           3 * time.Second,
+		UseCustomCollator:  false,
+		CollatorPath:       "",
+		CollatorConfigPath: "",
 	},
 	TxPool:      core.DefaultTxPoolConfig,
 	RPCGasCap:   50000000,