[wip] more minimal version of coreth (to abstract miner, chain & txpool)

eth/backend.go

@@ -244,19 +244,20 @@ func New(
 
  eth.bloomIndexer.Start(eth.blockchain)
 
+ blockchain := BlockChain(eth.blockchain) // used in initializing the txpool and miner
  // Uncomment the following to enable the new blobpool
 
  // config.BlobPool.Datadir = ""
- // blobPool := blobpool.New(config.BlobPool, &chainWithFinalBlock{eth.blockchain})
+ // blobPool := blobpool.New(config.BlobPool, &chainWithFinalBlock{blockchain})
 
- legacyPool := legacypool.New(config.TxPool, eth.blockchain)
+ legacyPool := legacypool.New(config.TxPool, blockchain)
 
- eth.txPool, err = txpool.New(new(big.Int).SetUint64(config.TxPool.PriceLimit), eth.blockchain, []txpool.SubPool{legacyPool}) //, blobPool})
+ eth.txPool, err = txpool.New(new(big.Int).SetUint64(config.TxPool.PriceLimit), blockchain, []txpool.SubPool{legacyPool}) //, blobPool})
  if err != nil {
  return nil, err
  }
 
- eth.miner = miner.New(eth, &config.Miner, eth.blockchain.Config(), eth.EventMux(), eth.engine, clock)
+ eth.miner = miner.New(blockchain, eth.txPool, &config.Miner, blockchain.Config(), eth.EventMux(), eth.engine, clock)
 
  allowUnprotectedTxHashes := make(map[common.Hash]struct{})
  for _, txHash := range config.AllowUnprotectedTxHashes {

eth/chain_with_final_block.go

@@ -2,14 +2,13 @@
 package eth
 
 import (
- "github.com/ava-labs/coreth/core"
  "github.com/ava-labs/coreth/core/types"
 )
 
 const blocksToKeep = 604_800 // Approx. 2 weeks worth of blocks assuming 2s block time
 
 type chainWithFinalBlock struct {
- *core.BlockChain
+ BlockChain
 }
 
 // CurrentFinalBlock returns the current block below which blobs should not

eth/interfaces.go

@@ -0,0 +1,26 @@
+package eth
+
+import (
+ "github.com/ava-labs/coreth/consensus"
+ "github.com/ava-labs/coreth/core"
+ "github.com/ava-labs/coreth/core/state"
+ "github.com/ava-labs/coreth/core/txpool"
+ "github.com/ava-labs/coreth/core/types"
+ "github.com/ethereum/go-ethereum/common"
+ "github.com/ethereum/go-ethereum/core/vm"
+)
+
+type BlockChain interface {
+ HasBlock(common.Hash, uint64) bool
+ GetBlock(common.Hash, uint64) *types.Block
+ LastAcceptedBlock() *types.Block
+
+ consensus.ChainHeaderReader
+ Engine() consensus.Engine
+ CacheConfig() *core.CacheConfig
+ GetVMConfig() *vm.Config
+ StateAt(common.Hash) (*state.StateDB, error)
+
+ txpool.BlockChain
+ SenderCacher() *core.TxSenderCacher
+}

miner/interfaces.go

@@ -0,0 +1,29 @@
+// (c) 2024, Ava Labs, Inc. All rights reserved.
+// See the file LICENSE for licensing terms.
+
+package miner
+
+import (
+ "math/big"
+
+ "github.com/ava-labs/coreth/consensus"
+ "github.com/ava-labs/coreth/core"
+ "github.com/ava-labs/coreth/core/state"
+ "github.com/ava-labs/coreth/core/txpool"
+ "github.com/ethereum/go-ethereum/common"
+ "github.com/ethereum/go-ethereum/core/vm"
+)
+
+type TxPool interface {
+ Locals() []common.Address
+ PendingWithBaseFee(enforceTips bool, baseFee *big.Int) map[common.Address][]*txpool.LazyTransaction
+}
+
+type BlockChain interface {
+ consensus.ChainHeaderReader
+ Engine() consensus.Engine
+ HasBlock(common.Hash, uint64) bool
+ CacheConfig() *core.CacheConfig
+ GetVMConfig() *vm.Config
+ StateAt(common.Hash) (*state.StateDB, error)
+}

miner/miner.go

@@ -30,21 +30,13 @@ package miner
 import (
  "github.com/ava-labs/avalanchego/utils/timer/mockable"
  "github.com/ava-labs/coreth/consensus"
- "github.com/ava-labs/coreth/core"
- "github.com/ava-labs/coreth/core/txpool"
  "github.com/ava-labs/coreth/core/types"
  "github.com/ava-labs/coreth/params"
  "github.com/ava-labs/coreth/precompile/precompileconfig"
  "github.com/ethereum/go-ethereum/common"
  "github.com/ethereum/go-ethereum/event"
 )
 
-// Backend wraps all methods required for mining.
-type Backend interface {
- BlockChain() *core.BlockChain
- TxPool() *txpool.TxPool
-}
-
 // Config is the configuration parameters of mining.
 type Config struct {
  Etherbase common.Address `toml:",omitempty"` // Public address for block mining rewards
@@ -54,9 +46,9 @@ type Miner struct {
  worker *worker
 }
 
-func New(eth Backend, config *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, clock *mockable.Clock) *Miner {
+func New(chain BlockChain, txPool TxPool, config *Config, chainConfig *params.ChainConfig, mux *event.TypeMux, engine consensus.Engine, clock *mockable.Clock) *Miner {
  return &Miner{
- worker: newWorker(config, chainConfig, engine, eth, mux, clock),
+ worker: newWorker(config, chainConfig, engine, chain, txPool, mux, clock),
  }
 }
 

miner/worker.go

@@ -92,8 +92,8 @@ type worker struct {
  config *Config
  chainConfig *params.ChainConfig
  engine consensus.Engine
- eth  Backend
- chain *core.BlockChain
+ txPool TxPool
+ chain BlockChain
 
  // Feeds
  // TODO remove since this will never be written to
@@ -107,13 +107,13 @@ type worker struct {
  beaconRoot *common.Hash // TODO: set to empty hash, retained for upstream compatibility and future use
 }
 
-func newWorker(config *Config, chainConfig *params.ChainConfig, engine consensus.Engine, eth Backend, mux *event.TypeMux, clock *mockable.Clock) *worker {
+func newWorker(config *Config, chainConfig *params.ChainConfig, engine consensus.Engine, chain BlockChain, txPool TxPool, mux *event.TypeMux, clock *mockable.Clock) *worker {
  worker := &worker{
  config: config,
  chainConfig: chainConfig,
  engine: engine,
- eth:  eth,
- chain: eth.BlockChain(),
+ txPool: txPool,
+ chain: chain,
  mux: mux,
  coinbase: config.Etherbase,
  clock: clock,
@@ -137,7 +137,7 @@ func (w *worker) commitNewWork(predicateContext *precompileconfig.PredicateConte
 
  tstart := w.clock.Time()
  timestamp := uint64(tstart.Unix())
- parent := w.chain.CurrentBlock()
+ parent := w.chain.CurrentHeader()
  // Note: in order to support asynchronous block production, blocks are allowed to have
  // the same timestamp as their parent. This allows more than one block to be produced
  // per second.
@@ -216,11 +216,11 @@ func (w *worker) commitNewWork(predicateContext *precompileconfig.PredicateConte
  return nil, err
  }
 
- pending := w.eth.TxPool().PendingWithBaseFee(true, header.BaseFee)
+ pending := w.txPool.PendingWithBaseFee(true, header.BaseFee)
 
  // Split the pending transactions into locals and remotes.
  localTxs, remoteTxs := make(map[common.Address][]*txpool.LazyTransaction), pending
- for _, account := range w.eth.TxPool().Locals() {
+ for _, account := range w.txPool.Locals() {
  if txs := remoteTxs[account]; len(txs) > 0 {
  delete(remoteTxs, account)
  localTxs[account] = txs
@@ -245,7 +245,7 @@ func (w *worker) createCurrentEnvironment(predicateContext *precompileconfig.Pre
  if err != nil {
  return nil, err
  }
- state.StartPrefetcher("miner", w.eth.BlockChain().CacheConfig().TriePrefetcherParallelism)
+ state.StartPrefetcher("miner", w.chain.CacheConfig().TriePrefetcherParallelism)
  return &environment{
  signer: types.MakeSigner(w.chainConfig, header.Number, header.Time),
  state: state,

plugin/evm/block_builder.go

@@ -9,7 +9,6 @@ import (
 
  "github.com/ava-labs/avalanchego/utils/timer"
  "github.com/ava-labs/coreth/core"
- "github.com/ava-labs/coreth/core/txpool"
  "github.com/ava-labs/coreth/params"
 
  "github.com/ava-labs/avalanchego/snow"
@@ -27,7 +26,7 @@ type blockBuilder struct {
  ctx *snow.Context
  chainConfig *params.ChainConfig
 
- txPool *txpool.TxPool
+ txPool TxPool
  mempool *Mempool
 
  shutdownChan <-chan struct{}

plugin/evm/export_tx.go

@@ -9,7 +9,6 @@ import (
  "fmt"
  "math/big"
 
- "github.com/ava-labs/coreth/core/state"
  "github.com/ava-labs/coreth/params"
 
  "github.com/ava-labs/avalanchego/chains/atomic"
@@ -369,7 +368,7 @@ func (vm *VM) newExportTx(
 }
 
 // EVMStateTransfer executes the state update from the atomic export transaction
-func (utx *UnsignedExportTx) EVMStateTransfer(ctx *snow.Context, state *state.StateDB) error {
+func (utx *UnsignedExportTx) EVMStateTransfer(ctx *snow.Context, state StateDB) error {
  addrs := map[[20]byte]uint64{}
  for _, from := range utx.Ins {
  if from.AssetID == ctx.AVAXAssetID {

plugin/evm/gossip.go

@@ -20,7 +20,6 @@ import (
  "github.com/ava-labs/avalanchego/network/p2p/gossip"
 
  "github.com/ava-labs/coreth/core"
- "github.com/ava-labs/coreth/core/txpool"
  "github.com/ava-labs/coreth/core/types"
  "github.com/ava-labs/coreth/eth"
 )
@@ -114,7 +113,7 @@ func (tx *GossipAtomicTx) GossipID() ids.ID {
  return tx.Tx.ID()
 }
 
-func NewGossipEthTxPool(mempool *txpool.TxPool, registerer prometheus.Registerer) (*GossipEthTxPool, error) {
+func NewGossipEthTxPool(mempool TxPool, registerer prometheus.Registerer) (*GossipEthTxPool, error) {
  bloom, err := gossip.NewBloomFilter(registerer, "eth_tx_bloom_filter", txGossipBloomMinTargetElements, txGossipBloomTargetFalsePositiveRate, txGossipBloomResetFalsePositiveRate)
  if err != nil {
  return nil, fmt.Errorf("failed to initialize bloom filter: %w", err)
@@ -128,7 +127,7 @@ func NewGossipEthTxPool(mempool *txpool.TxPool, registerer prometheus.Registerer
 }
 
 type GossipEthTxPool struct {
- mempool *txpool.TxPool
+ mempool TxPool
  pendingTxs chan core.NewTxsEvent
 
  bloom *gossip.BloomFilter

plugin/evm/handler.go

@@ -18,7 +18,7 @@ import (
 type GossipHandler struct {
  vm *VM
  atomicMempool *Mempool
- txPool *txpool.TxPool
+ txPool TxPool
  stats GossipStats
 }
 

plugin/evm/import_tx.go

@@ -10,7 +10,6 @@ import (
  "math/big"
  "slices"
 
- "github.com/ava-labs/coreth/core/state"
  "github.com/ava-labs/coreth/params"
 
  "github.com/ava-labs/avalanchego/chains/atomic"
@@ -428,7 +427,7 @@ func (vm *VM) newImportTxWithUTXOs(
 
 // EVMStateTransfer performs the state transfer to increase the balances of
 // accounts accordingly with the imported EVMOutputs
-func (utx *UnsignedImportTx) EVMStateTransfer(ctx *snow.Context, state *state.StateDB) error {
+func (utx *UnsignedImportTx) EVMStateTransfer(ctx *snow.Context, state StateDB) error {
  for _, to := range utx.Outs {
  if to.AssetID == ctx.AVAXAssetID {
  log.Debug("crosschain", "src", utx.SourceChain, "addr", to.Address, "amount", to.Amount, "assetID", "AVAX")