feat(abci): Utilize geth miner to build blocks

cosmos/miner/miner.go

@@ -0,0 +1,138 @@
+// SPDX-License-Identifier: BUSL-1.1
+//
+// Copyright (C) 2023, Berachain Foundation. All rights reserved.
+// Use of this software is govered by the Business Source License included
+// in the LICENSE file of this repository and at www.mariadb.com/bsl11.
+//
+// ANY USE OF THE LICENSED WORK IN VIOLATION OF THIS LICENSE WILL AUTOMATICALLY
+// TERMINATE YOUR RIGHTS UNDER THIS LICENSE FOR THE CURRENT AND ALL OTHER
+// VERSIONS OF THE LICENSED WORK.
+//
+// THIS LICENSE DOES NOT GRANT YOU ANY RIGHT IN ANY TRADEMARK OR LOGO OF
+// LICENSOR OR ITS AFFILIATES (PROVIDED THAT YOU MAY USE A TRADEMARK OR LOGO OF
+// LICENSOR AS EXPRESSLY REQUIRED BY THIS LICENSE).
+//
+// TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+// AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+// EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+// MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+// TITLE.
+
+// Package miner implements the Ethereum miner.
+package miner
+
+import (
+	"context"
+
+	abci "github.com/cometbft/cometbft/abci/types"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/ethereum/go-ethereum/common"
+	"github.com/ethereum/go-ethereum/miner"
+
+	evmtypes "pkg.berachain.dev/polaris/cosmos/x/evm/types"
+	"pkg.berachain.dev/polaris/eth/core/types"
+)
+
+// emptyHash is a common.Hash initialized to all zeros.
+var emptyHash = common.Hash{}
+
+// Miner implements the baseapp.TxSelector interface.
+type Miner struct {
+	*miner.Miner
+	serializer     evmtypes.TxSerializer
+	currentPayload *miner.Payload
+}
+
+// New produces a cosmos miner from a geth miner.
+func New(gm *miner.Miner) *Miner {
+	return &Miner{
+		Miner: gm,
+	}
+}
+
+// Init sets the transaction serializer.
+func (m *Miner) Init(serializer evmtypes.TxSerializer) {
+	m.serializer = serializer
+}
+
+// PrepareProposal implements baseapp.PrepareProposal.
+func (m *Miner) PrepareProposal(
+	ctx sdk.Context, _ *abci.RequestPrepareProposal,
+) (*abci.ResponsePrepareProposal, error) {
+	var txs [][]byte
+	var err error
+	if txs, err = m.buildBlock(ctx); err != nil {
+		return nil, err
+	}
+	return &abci.ResponsePrepareProposal{Txs: txs}, err
+}
+
+// buildBlock builds and submits a payload, it also waits for the txs
+// to resolve from the underying worker.
+func (m *Miner) buildBlock(ctx sdk.Context) ([][]byte, error) {
+	defer m.clearPayload()
+	if err := m.submitPayloadForBuilding(ctx); err != nil {
+		return nil, err
+	}
+	return m.resolveTxs(), nil
+}
+
+// submitPayloadForBuilding submits a payload for building.
+func (m *Miner) submitPayloadForBuilding(ctx context.Context) error {
+	var (
+		err     error
+		payload *miner.Payload
+		sCtx    = sdk.UnwrapSDKContext(ctx)
+	)
+
+	// Build Payload
+	if payload, err = m.BuildPayload(m.constructPayloadArgs(sCtx)); err != nil {
+		sCtx.Logger().Error("failed to build payload", "err", err)
+		return err
+	}
+	m.currentPayload = payload
+	sCtx.Logger().Info("submitted payload for building")
+	return nil
+}
+
+// constructPayloadArgs builds a payload to submit to the miner.
+func (m *Miner) constructPayloadArgs(ctx sdk.Context) *miner.BuildPayloadArgs {
+	return &miner.BuildPayloadArgs{
+		Timestamp:    uint64(ctx.BlockTime().Unix()),
+		FeeRecipient: common.Address{}, /* todo: set etherbase */
+		Random:       common.Hash{},    /* todo: generated random */
+		Withdrawals:  make(types.Withdrawals, 0),
+		BeaconRoot:   &emptyHash,
+	}
+}
+
+// resolveTxs resolves the transactions from the payload.
+func (m *Miner) resolveTxs() [][]byte {
+	if m.currentPayload == nil {
+		return nil
+	}
+	envelope := m.currentPayload.ResolveFull()
+	ethTxBzs := envelope.ExecutionPayload.Transactions
+	txs := make([][]byte, len(envelope.ExecutionPayload.Transactions))
+
+	// encode to sdk.txs and then
+	for i, ethTxBz := range ethTxBzs {
+		var tx types.Transaction
+		if err := tx.UnmarshalBinary(ethTxBz); err != nil {
+			return nil
+		}
+		bz, err := m.serializer.SerializeToBytes(&tx)
+		if err != nil {
+			panic(err)
+		}
+		txs[i] = bz
+	}
+	return txs
+}
+
+// clearPayload clears the payload.
+func (m *Miner) clearPayload() {
+	m.currentPayload = nil
+}

cosmos/cosmos.go → cosmos/miner/miner_test.go

@@ -18,4 +18,32 @@
 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
 // TITLE.
 
-package cosmos
+package miner
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestMiner(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "cosmos/miner")
+}
+
+var _ = Describe("", func() {
+
+	var (
+	// t       = GinkgoT()
+	// txPool  *mocks.GethTxPool
+	// sdkTx   *mocks.SdkTx
+	// mempool *Miner
+	// ctx     = context.Background()
+	)
+
+	BeforeEach(func() {
+		// mempool = &Miner{}
+	})
+
+})

cosmos/x/evm/keeper/abci.go

@@ -28,11 +28,11 @@ import (
 
 func (k *Keeper) BeginBlocker(ctx context.Context) error {
 	// Prepare the Polaris Ethereum block.
-	_ = k.polaris.Miner().Prepare(ctx, uint64(sdk.UnwrapSDKContext(ctx).BlockHeight()))
+	_ = k.polaris.SPMiner().Prepare(ctx, uint64(sdk.UnwrapSDKContext(ctx).BlockHeight()))
 	return nil
 }
 
 func (k *Keeper) EndBlock(ctx context.Context) error {
 	// Finalize the Polaris Ethereum block.
-	return k.polaris.Miner().Finalize(ctx)
+	return k.polaris.SPMiner().Finalize(ctx)
 }

cosmos/x/evm/keeper/host.go

@@ -106,9 +106,11 @@ func NewHost(
 func (h *host) SetupPrecompiles() error {
 	// Set the query context function for the block and state plugins
 	pcs := h.pcs().GetPrecompiles()
+
 	if err := h.pp.RegisterPrecompiles(pcs); err != nil {
 		return err
 	}
+
 	h.sp.SetPrecompileLogFactory(pclog.NewFactory(pcs))
 	return nil
 }

cosmos/x/evm/keeper/processor.go

@@ -43,7 +43,7 @@ func (k *Keeper) ProcessTransaction(
 		"reset gas meter prior to ethereum state transition")
 
 	// Process the transaction and return the EVM's execution result.
-	receipt, err := k.polaris.Miner().ProcessTransaction(ctx, tx)
+	receipt, err := k.polaris.SPMiner().ProcessTransaction(ctx, tx)
 	if err != nil {
 		k.Logger(sCtx).Error("failed to process transaction", "err", err)
 		return nil, err

e2e/hive/simulators/rpc-compat/tests/eth_getBlockByNumber/get-block-n.io

@@ -1,2 +1,2 @@
 >> {"jsonrpc":"2.0","id":1,"method":"eth_getBlockByNumber","params":["0x0",true]}
-<< {"jsonrpc":"2.0","id":1,"result":{"baseFeePerGas":"0x3b9aca00","difficulty":"0x1","extraData":"0x","gasLimit":"0x4c4b40","gasUsed":"0x0","hash":"0x1fc027d65f820d3eef441ebeec139ebe09e471cf98516dce7b5643ccb27f418c","logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","miner":"0x0000000000000000000000000000000000000000","mixHash":"0x0000000000000000000000000000000000000000000000000000000000000000","nonce":"0x0000000000000000","number":"0x0","parentHash":"0x0000000000000000000000000000000000000000000000000000000000000000","receiptsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","sha3Uncles":"0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347","size":"0x21e","stateRoot":"0x078dc6061b1d8eaa8493384b59c9c65ceb917201221d08b80c4de6770b6ec7e7","timestamp":"0x0","totalDifficulty":"0x1","transactions":[],"transactionsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","uncles":[],"withdrawals": null,"withdrawalsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"}}
+<< {"jsonrpc":"2.0","id":1,"result":{"baseFeePerGas":"0x3b9aca00","difficulty":"0x1","extraData":"0x","gasLimit":"0x4c4b40","gasUsed":"0x0","hash":"0x1fc027d65f820d3eef441ebeec139ebe09e471cf98516dce7b5643ccb27f418c","logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","miner":"0x0000000000000000000000000000000000000000","mixHash":"0x0000000000000000000000000000000000000000000000000000000000000000","nonce":"0x0000000000000000","number":"0x0","parentHash":"0x0000000000000000000000000000000000000000000000000000000000000000","receiptsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","sha3Uncles":"0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347","size":"0x21f","stateRoot":"0x078dc6061b1d8eaa8493384b59c9c65ceb917201221d08b80c4de6770b6ec7e7","timestamp":"0x0","totalDifficulty":"0x1","transactions":[],"transactionsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","uncles":[],"withdrawals": [],"withdrawalsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"}}

e2e/hive/simulators/rpc-compat/tests/eth_getBlockByNumber/get-block-notfound.io

@@ -0,0 +1,2 @@
+>> {"jsonrpc":"2.0","id":1,"method":"eth_getBlockByNumber","params":["0x3e8",true]}
+<< {"jsonrpc":"2.0","id":1,"result":null}

e2e/hive/simulators/rpc-compat/tests/eth_getBlockByNumber/get-genesis.io

@@ -1,2 +1,2 @@
 >> {"jsonrpc":"2.0","id":1,"method":"eth_getBlockByNumber","params":["0x0",true]}
-<< {"jsonrpc":"2.0","id":1,"result":{"baseFeePerGas":"0x3b9aca00","difficulty":"0x1","extraData":"0x","gasLimit":"0x4c4b40","gasUsed":"0x0","hash":"0x1fc027d65f820d3eef441ebeec139ebe09e471cf98516dce7b5643ccb27f418c","logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","miner":"0x0000000000000000000000000000000000000000","mixHash":"0x0000000000000000000000000000000000000000000000000000000000000000","nonce":"0x0000000000000000","number":"0x0","parentHash":"0x0000000000000000000000000000000000000000000000000000000000000000","receiptsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","sha3Uncles":"0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347","size":"0x21e","stateRoot":"0x078dc6061b1d8eaa8493384b59c9c65ceb917201221d08b80c4de6770b6ec7e7","timestamp":"0x0","totalDifficulty":"0x1","transactions":[],"transactionsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","uncles":[],"withdrawals": null,"withdrawalsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"}}
+<< {"jsonrpc":"2.0","id":1,"result":{"baseFeePerGas":"0x3b9aca00","difficulty":"0x1","extraData":"0x","gasLimit":"0x4c4b40","gasUsed":"0x0","hash":"0x1fc027d65f820d3eef441ebeec139ebe09e471cf98516dce7b5643ccb27f418c","logsBloom":"0x00000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000","miner":"0x0000000000000000000000000000000000000000","mixHash":"0x0000000000000000000000000000000000000000000000000000000000000000","nonce":"0x0000000000000000","number":"0x0","parentHash":"0x0000000000000000000000000000000000000000000000000000000000000000","receiptsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","sha3Uncles":"0x1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347","size":"0x21f","stateRoot":"0x078dc6061b1d8eaa8493384b59c9c65ceb917201221d08b80c4de6770b6ec7e7","timestamp":"0x0","totalDifficulty":"0x1","transactions":[],"transactionsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421","uncles":[],"withdrawals": [],"withdrawalsRoot":"0x56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421"}}