feat(runtime): Polaris Runtime Module

cosmos/runtime/depinject.go

@@ -0,0 +1,80 @@
+// 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 runtime
+
+import (
+	"cosmossdk.io/depinject"
+	"cosmossdk.io/log"
+
+	"pkg.berachain.dev/polaris/cosmos/config"
+	evmkeeper "pkg.berachain.dev/polaris/cosmos/x/evm/keeper"
+	ethlog "pkg.berachain.dev/polaris/eth/log"
+	"pkg.berachain.dev/polaris/eth/polar"
+)
+
+// DepInjectInput is the input for the dep inject framework.
+type DepInjectInput struct {
+	depinject.In
+
+	Logger    log.Logger
+	EVMKeeper *evmkeeper.Keeper
+	Config    func() *config.Config
+}
+
+// DepInjectOutput is the output for the dep inject framework.
+type DepInjectOutput struct {
+	depinject.Out
+
+	Polaris *Polaris
+}
+
+// ProvidePolarisRuntime creates a new Polaris runtime from the provided
+// dependencies.
+func ProvidePolarisRuntime(input DepInjectInput) DepInjectOutput {
+	cfg := input.Config()
+	node, err := polar.NewGethNetworkingStack(&cfg.Node)
+	if err != nil {
+		panic(err)
+	}
+
+	polaris := polar.NewWithNetworkingStack(
+		&cfg.Polar, input.EVMKeeper.Host, node, ethlog.FuncHandler(
+			func(r *ethlog.Record) error {
+				polarisGethLogger := input.Logger.With("module", "polaris-geth")
+				switch r.Lvl { //nolint:nolintlint,exhaustive // linter is bugged.
+				case ethlog.LvlTrace, ethlog.LvlDebug:
+					polarisGethLogger.Debug(r.Msg, r.Ctx...)
+				case ethlog.LvlInfo, ethlog.LvlWarn:
+					polarisGethLogger.Info(r.Msg, r.Ctx...)
+				case ethlog.LvlError, ethlog.LvlCrit:
+					polarisGethLogger.Error(r.Msg, r.Ctx...)
+				}
+				return nil
+			}),
+	)
+
+	return DepInjectOutput{
+		Polaris: &Polaris{
+			Polaris:   polaris,
+			EVMKeeper: input.EVMKeeper,
+		},
+	}
+}

cosmos/runtime/runtime.go

@@ -0,0 +1,117 @@
+// 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 runtime
+
+import (
+	"cosmossdk.io/log"
+	storetypes "cosmossdk.io/store/types"
+
+	"github.com/cosmos/cosmos-sdk/baseapp"
+	"github.com/cosmos/cosmos-sdk/client"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+
+	"github.com/ethereum/go-ethereum/beacon/engine"
+	"github.com/ethereum/go-ethereum/node"
+
+	libtx "pkg.berachain.dev/polaris/cosmos/lib/tx"
+	"pkg.berachain.dev/polaris/cosmos/miner"
+	"pkg.berachain.dev/polaris/cosmos/txpool"
+	evmkeeper "pkg.berachain.dev/polaris/cosmos/x/evm/keeper"
+	enginep "pkg.berachain.dev/polaris/cosmos/x/evm/plugins/engine"
+	evmtypes "pkg.berachain.dev/polaris/cosmos/x/evm/types"
+	coretypes "pkg.berachain.dev/polaris/eth/core/types"
+	"pkg.berachain.dev/polaris/eth/polar"
+)
+
+type Polaris struct {
+	*polar.Polaris
+
+	// polaris keepers
+	EVMKeeper *evmkeeper.Keeper
+
+	// polaris componets
+	mm *miner.Miner
+	mp *txpool.Mempool
+}
+
+func (p *Polaris) Setup(bApp *baseapp.BaseApp) error {
+	// SetupPrecompiles is used to setup the precompile contracts post depinject.
+	if err := p.EVMKeeper.SetupPrecompiles(); err != nil {
+		return err
+	}
+
+	// Init is used to setup the polaris struct.
+	if err := p.Polaris.Init(); err != nil {
+		return err
+	}
+
+	// Setup TxPool Wrapper
+	p.mp = txpool.New(p.TxPool())
+	bApp.SetMempool(p.mp)
+
+	p.mm = miner.New(p.Miner())
+	bApp.SetPrepareProposal(p.mm.PrepareProposal)
+
+	// TODO: deprecate this
+	p.EVMKeeper.SetBlockchain(p.Blockchain())
+
+	return nil
+}
+
+func (p *Polaris) Init(clientCtx client.Context, logger log.Logger) error {
+	// Initialize services.
+	p.mm.Init(libtx.NewSerializer[*engine.ExecutionPayloadEnvelope](
+		clientCtx.TxConfig, evmtypes.WrapPayload))
+
+	p.mp.Init(logger, clientCtx, libtx.NewSerializer[*coretypes.Transaction](
+		clientCtx.TxConfig, evmtypes.WrapTx))
+
+	// Register services with Polaris.
+	p.RegisterServices(clientCtx, []node.Lifecycle{
+		p.mp,
+	})
+	return nil
+}
+
+// Register Services allows for the application to register lifecycles with the evm
+// networking stack.
+func (p *Polaris) RegisterServices(clientContext client.Context, lcs []node.Lifecycle) {
+	// TODO: probably get rid of engine plugin or something and handle rpc methods better.
+	p.EVMKeeper.Host.GetEnginePlugin().(enginep.Plugin).Start(clientContext)
+
+	// Register the services with polaris.
+	for _, lc := range lcs {
+		p.RegisterService(lc)
+	}
+
+	// Start the services.
+	if err := p.StartServices(); err != nil {
+		panic(err)
+	}
+}
+
+func (p *Polaris) LoadLastState(cms storetypes.CommitMultiStore, appHeight uint64) error {
+	cmsCtx := sdk.Context{}.
+		WithMultiStore(cms).
+		WithGasMeter(storetypes.NewInfiniteGasMeter()).
+		WithBlockGasMeter(storetypes.NewInfiniteGasMeter()).WithEventManager(sdk.NewEventManager())
+	return p.Blockchain().LoadLastState(cmsCtx, appHeight)
+}

cosmos/x/evm/genesis_test.go

@@ -33,6 +33,8 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	stakingkeeper "github.com/cosmos/cosmos-sdk/x/staking/keeper"
 
+	"github.com/ethereum/go-ethereum/consensus/beacon"
+
 	"pkg.berachain.dev/polaris/cosmos/config"
 	"pkg.berachain.dev/polaris/cosmos/precompile/staking"
 	testutil "pkg.berachain.dev/polaris/cosmos/testutil"
@@ -90,6 +92,10 @@ var _ = Describe("", func() {
 			log.NewTestLogger(GinkgoT()),
 			cfg,
 		)
+		k.SetBlockchain(
+			core.NewChain(k.Host, beacon.NewFaker()),
+		)
+
 		err = k.SetupPrecompiles()
 		Expect(err).ToNot(HaveOccurred())
 		am = evm.NewAppModule(k, ak)
@@ -112,28 +118,28 @@ var _ = Describe("", func() {
 				Expect(err).ToNot(HaveOccurred())
 			})
 			It("should contain the same genesis header values", func() {
-				bp := k.Polaris().Host().GetBlockPlugin()
+				bp := k.Host.GetBlockPlugin()
 				expectedHeader := ethGen.ToBlock().Header()
 				Expect(bp.GetHeaderByNumber(0)).To(Equal(expectedHeader))
 			})
 			It("should have the correct balances", func() {
-				sp := k.Polaris().Host().GetStatePlugin()
+				sp := k.Host.GetStatePlugin()
 				for addr, acc := range ethGen.Alloc {
 					balance := sp.GetBalance(addr)
 					cmp := balance.Cmp(acc.Balance)
 					Expect(cmp).To(BeZero())
 				}
 			})
 			It("should have the correct code", func() {
-				sp := k.Polaris().Host().GetStatePlugin()
+				sp := k.Host.GetStatePlugin()
 				for addr, acc := range ethGen.Alloc {
 					code := sp.GetCode(addr)
 					cmp := bytes.Compare(code, acc.Code)
 					Expect(cmp).To(BeZero())
 				}
 			})
 			It("should have the correct hash", func() {
-				sp := k.Polaris().Host().GetStatePlugin()
+				sp := k.Host.GetStatePlugin()
 				for addr, acc := range ethGen.Alloc {
 					for key, expectedHash := range acc.Storage {
 						actualHash := sp.GetState(addr, key)

cosmos/x/evm/keeper/genesis.go

@@ -31,10 +31,10 @@ import (
 // InitGenesis is called during the InitGenesis.
 func (k *Keeper) InitGenesis(ctx sdk.Context, genState *core.Genesis) error {
 	// TODO: Feels jank as fuck lol, but it works.
-	genState.Config = k.host.GetConfigurationPlugin().ChainConfig()
+	genState.Config = k.Host.GetConfigurationPlugin().ChainConfig()
 
 	// Initialize all the plugins.
-	for _, plugin := range k.host.GetAllPlugins() {
+	for _, plugin := range k.Host.GetAllPlugins() {
 		// checks whether plugin implements methods of HasGenesis and executes them if it does
 		if plugin, ok := utils.GetAs[plugins.HasGenesis](plugin); ok {
 			if err := plugin.InitGenesis(ctx, genState); err != nil {
@@ -44,15 +44,15 @@ func (k *Keeper) InitGenesis(ctx sdk.Context, genState *core.Genesis) error {
 	}
 
 	// Insert to chain.
-	k.polaris.Blockchain().
+	k.chain.
 		PreparePlugins(ctx.WithEventManager(sdk.NewEventManager()))
-	return k.polaris.Blockchain().InsertBlockWithoutSetHead(genState.ToBlock())
+	return k.chain.InsertBlockWithoutSetHead(genState.ToBlock())
 }
 
 // ExportGenesis returns the exported genesis state.
 func (k *Keeper) ExportGenesis(ctx sdk.Context) *core.Genesis {
 	genesisState := new(core.Genesis)
-	for _, plugin := range k.host.GetAllPlugins() {
+	for _, plugin := range k.Host.GetAllPlugins() {
 		if plugin, ok := utils.GetAs[plugins.HasGenesis](plugin); ok {
 			plugin.ExportGenesis(ctx, genesisState)
 		}

cosmos/x/evm/keeper/host.go

@@ -39,17 +39,9 @@ import (
 )
 
 // Compile-time interface assertion.
-var _ core.PolarisHostChain = (*host)(nil)
-
-// Host is the interface that must be implemented by the host.
-// It includes core.PolarisHostChain and functions that are called in other packages.
-type Host interface {
-	core.PolarisHostChain
-	GetAllPlugins() []any
-	SetupPrecompiles() error
-}
+var _ core.PolarisHostChain = (*Host)(nil)
 
-type host struct {
+type Host struct {
 	// The various plugins that are are used to implement core.PolarisHostChain.
 	bp     block.Plugin
 	cp     configuration.Plugin
@@ -74,9 +66,9 @@ func NewHost(
 	precompiles func() *ethprecompile.Injector,
 	qc func() func(height int64, prove bool) (sdk.Context, error),
 	logger log.Logger,
-) Host {
+) *Host {
 	// We setup the host with some Cosmos standard sauce.
-	h := &host{}
+	h := &Host{}
 
 	// Build the Plugins
 	h.bp = block.NewPlugin(storeKey, sk)
@@ -89,7 +81,6 @@ func NewHost(
 	h.logger = logger
 
 	// Setup the state, precompile, historical, and txpool plugins
-	// TODO: re-enable historical plugin using ABCI listener.
 	h.hp = historical.NewPlugin(h.cp, h.bp, nil, h.storeKey)
 	h.pp = precompile.NewPlugin()
 	h.sp = state.NewPlugin(h.ak, h.storeKey, nil)
@@ -100,7 +91,7 @@ func NewHost(
 }
 
 // SetupPrecompiles intializes the precompile contracts.
-func (h *host) SetupPrecompiles() error {
+func (h *Host) SetupPrecompiles() error {
 	// Set the query context function for the block and state plugins
 	pcs := h.pcs().GetPrecompiles()
 
@@ -113,34 +104,34 @@ func (h *host) SetupPrecompiles() error {
 }
 
 // GetBlockPlugin returns the header plugin.
-func (h *host) GetBlockPlugin() core.BlockPlugin {
+func (h *Host) GetBlockPlugin() core.BlockPlugin {
 	return h.bp
 }
 
 // GetConfigurationPlugin returns the configuration plugin.
-func (h *host) GetConfigurationPlugin() core.ConfigurationPlugin {
+func (h *Host) GetConfigurationPlugin() core.ConfigurationPlugin {
 	return h.cp
 }
 
 // GetEnginePlugin returns the engine plugin.
-func (h *host) GetEnginePlugin() core.EnginePlugin {
+func (h *Host) GetEnginePlugin() core.EnginePlugin {
 	return h.ep
 }
-func (h *host) GetHistoricalPlugin() core.HistoricalPlugin {
+func (h *Host) GetHistoricalPlugin() core.HistoricalPlugin {
 	return h.hp
 }
 
 // GetPrecompilePlugin returns the precompile plugin.
-func (h *host) GetPrecompilePlugin() core.PrecompilePlugin {
+func (h *Host) GetPrecompilePlugin() core.PrecompilePlugin {
 	return h.pp
 }
 
 // GetStatePlugin returns the state plugin.
-func (h *host) GetStatePlugin() core.StatePlugin {
+func (h *Host) GetStatePlugin() core.StatePlugin {
 	return h.sp
 }
 
 // GetAllPlugins returns all the plugins.
-func (h *host) GetAllPlugins() []any {
+func (h *Host) GetAllPlugins() []any {
 	return []any{h.bp, h.cp, h.hp, h.pp, h.sp}
 }