Merge remote-tracking branch 'upstream/main' into fix-boilerplates

Author: yihuang

CHANGELOG.md

@@ -28,16 +28,19 @@
 - [\#576](https://github.com/cosmos/evm/pull/576) Parse logs from the txResult.Data and avoid emitting EVM events to cosmos-sdk events.
 - [\#584](https://github.com/cosmos/evm/pull/584) Fill block hash and timestamp for json rpc.
 - [\#582](https://github.com/cosmos/evm/pull/582) Add block max-gas (from genesis.json) and new min-tip (from app.toml/flags) ingestion into mempool config
+- [\#580](https://github.com/cosmos/evm/pull/580) add appside mempool e2e test
 - [\#598](https://github.com/cosmos/evm/pull/598) Reduce number of times CreateQueryContext in mempool.
 - [\#606](https://github.com/cosmos/evm/pull/606) Regenerate mock file for bank keeper related test.
+- [\#609](https://github.com/cosmos/evm/pull/609) Make `erc20Keeper` optional in the EVM keeper
 - [\#624](https://github.com/cosmos/evm/pull/624) Cleanup unnecessary `fix-revert-gas-refund-height`.
+- [\#635](https://github.com/cosmos/evm/pull/635) Move DefaultStaticPrecompiles to /evm and allow projects to set it by default alongside the keeper.
 - [\#577](https://github.com/cosmos/evm/pull/577) Cleanup precompiles boilerplate code.
 
 ### FEATURES
 
 - [\#346](https://github.com/cosmos/evm/pull/346) Add eth_createAccessList method and implementation
 - [\#502](https://github.com/cosmos/evm/pull/502) Add block time in derived logs.
-- [\#588](https://github.com/cosmos/evm/pull/588) go-ethereum metrics are now available in Cosmos SDK's telemetry server at host:port/geth/metrics (default localhost:1317/geth/metrics).
+- [\#633](https://github.com/cosmos/evm/pull/633) go-ethereum metrics are now emitted on a separate server. default address: 127.0.0.1:8100.
 
 ### STATE BREAKING
 

contrib/images/evmd-env/Dockerfile

@@ -22,7 +22,7 @@ RUN addgroup -g 1025 nonroot
 RUN adduser -D nonroot -u 1025 -G nonroot
 
 # Set up the runtime environment
-EXPOSE 26656 26657 1317 9090
+EXPOSE 26656 26657 1317 9090 26660 8545 8100
 STOPSIGNAL SIGTERM
 VOLUME /evmd
 WORKDIR /evmd

docs/migrations/v0.4.0_to_v0.5.0_UNRELEASED.md

@@ -80,6 +80,39 @@ mempoolConfig.CosmosPoolConfig = &cosmosCfg
 mempoolConfig.BroadCastTxFn = func(txs []*ethtypes.Transaction) error { return nil }
 ```
 
+### Default Precompiles
+
+Default precompiles have been moved to `/evm/precompiles/types/defaults.go` and the function name was
+changed to `DefaultStaticPrecompiles`. The function signature has also changed, and now takes pointers
+as inputs for the `Erc20Keeper` and `TransferKeeper`. Finally, the `WithStaticPrecompiles` builder
+function can now happen *alongside the keeper instantiation*, and not after. The new wiring is shown below:
+
+```go
+	app.EVMKeeper = evmkeeper.NewKeeper(
+		appCodec, keys[evmtypes.StoreKey], tkeys[evmtypes.TransientKey], keys,
+		authtypes.NewModuleAddress(govtypes.ModuleName),
+		app.AccountKeeper,
+		app.PreciseBankKeeper,
+		app.StakingKeeper,
+		app.FeeMarketKeeper,
+		&app.ConsensusParamsKeeper,
+		&app.Erc20Keeper,
+		tracer,
+	).WithStaticPrecompiles(
+		precompiletypes.DefaultStaticPrecompiles(
+			*app.StakingKeeper,
+			app.DistrKeeper,
+			app.BankKeeper,
+			&app.Erc20Keeper, // UPDATED
+			&app.TransferKeeper, // UPDATED
+			app.IBCKeeper.ChannelKeeper,
+			app.GovKeeper,
+			app.SlashingKeeper,
+			appCodec,
+		),
+	)
+```
+
 ---
 
 ## 3) Build & quick tests

evmd/README.md

@@ -43,7 +43,7 @@ For the sake of this example, we'll be using Metamask:
 
 1. Use the following seed phrase when adding a new wallet:
 `gesture inject test cycle original hollow east ridge hen combine
-junk child baconzero hope comfort vacuum milk pitch cage oppose
+junk child bacon zero hope comfort vacuum milk pitch cage oppose
 unhappy lunar seat`
 2. On the top left of the Metamask extension, click the Network button.
 3. Click Add custom network from the bottom of the modal.

evmd/app.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"errors"
 	"fmt"
+	precompiletypes "github.com/cosmos/evm/precompiles/types"
 	"io"
 
 	"os"
@@ -486,6 +487,18 @@ func NewExampleApp(
 		&app.ConsensusParamsKeeper,
 		&app.Erc20Keeper,
 		tracer,
+	).WithStaticPrecompiles(
+		precompiletypes.DefaultStaticPrecompiles(
+			*app.StakingKeeper,
+			app.DistrKeeper,
+			app.BankKeeper,
+			&app.Erc20Keeper,
+			&app.TransferKeeper,
+			app.IBCKeeper.ChannelKeeper,
+			app.GovKeeper,
+			app.SlashingKeeper,
+			appCodec,
+		),
 	)
 
 	app.Erc20Keeper = erc20keeper.NewKeeper(
@@ -561,23 +574,6 @@ func NewExampleApp(
 	// Override the ICS20 app module
 	transferModule := transfer.NewAppModule(app.TransferKeeper)
 
-	// NOTE: we are adding all available Cosmos EVM EVM extensions.
-	// Not all of them need to be enabled, which can be configured on a per-chain basis.
-	app.EVMKeeper.WithStaticPrecompiles(
-		NewAvailableStaticPrecompiles(
-			*app.StakingKeeper,
-			app.DistrKeeper,
-			app.PreciseBankKeeper,
-			app.Erc20Keeper,
-			app.TransferKeeper,
-			app.IBCKeeper.ChannelKeeper,
-			app.EVMKeeper,
-			app.GovKeeper,
-			app.SlashingKeeper,
-			app.AppCodec(),
-		),
-	)
-
 	/****  Module Options ****/
 
 	// NOTE: Any module instantiated in the module manager that is later modified

evmd/cmd/evmd/cmd/testnet.go

@@ -288,9 +288,10 @@ func initTestnetFiles(
 		sdkGRPCPort = 9090
 
 		// evmGRPC           = 9900 // TODO: maybe need this? idk.
-		evmJSONRPC        = 8545
-		evmJSONRPCWS      = 8546
-		evmJSONRPCMetrics = 6065
+		evmJSONRPC         = 8545
+		evmJSONRPCWS       = 8546
+		evmJSONRPCMetrics  = 6065
+		evmGethMetricsPort = 8100
 	)
 	p2pPortStart := 26656
 
@@ -317,6 +318,7 @@ func initTestnetFiles(
 			evmCfg.JSONRPC.Address = fmt.Sprintf("127.0.0.1:%d", evmJSONRPC+evmPortOffset)
 			evmCfg.JSONRPC.MetricsAddress = fmt.Sprintf("127.0.0.1:%d", evmJSONRPCMetrics+evmPortOffset)
 			evmCfg.JSONRPC.WsAddress = fmt.Sprintf("127.0.0.1:%d", evmJSONRPCWS+evmPortOffset)
+			evmCfg.EVM.GethMetricsAddress = fmt.Sprintf("127.0.0.1:%d", evmGethMetricsPort+evmPortOffset)
 		} else {
 			evmCfg.JSONRPC.WsAddress = fmt.Sprintf("0.0.0.0:%d", evmJSONRPCWS)
 			evmCfg.JSONRPC.Address = fmt.Sprintf("0.0.0.0:%d", evmJSONRPC)

metrics/geth.go

@@ -0,0 +1,59 @@
+package metrics
+
+import (
+	"context"
+	"errors"
+	"net/http"
+	"time"
+
+	gethmetrics "github.com/ethereum/go-ethereum/metrics"
+	gethprom "github.com/ethereum/go-ethereum/metrics/prometheus"
+
+	"cosmossdk.io/log"
+)
+
+// StartGethMetricServer starts the geth metrics server on the specified address.
+func StartGethMetricServer(ctx context.Context, log log.Logger, addr string) error {
+	mux := http.NewServeMux()
+	mux.Handle("/metrics", gethprom.Handler(gethmetrics.DefaultRegistry))
+
+	server := &http.Server{
+		Addr:              addr,
+		Handler:           mux,
+		ReadTimeout:       10 * time.Second,
+		WriteTimeout:      10 * time.Second,
+		ReadHeaderTimeout: 10 * time.Second,
+	}
+
+	errCh := make(chan error, 1)
+
+	go func() {
+		log.Info("starting geth metrics server...", "address", addr)
+		errCh <- server.ListenAndServe()
+	}()
+
+	// Start a blocking select to wait for an indication to stop the server or that
+	// the server failed to start properly.
+	select {
+	case <-ctx.Done():
+		// The calling process canceled or closed the provided context, so we must
+		// gracefully stop the metrics server.
+		log.Info("stopping geth metrics server...", "address", addr)
+
+		shutdownCtx, cancel := context.WithTimeout(context.Background(), 5*time.Second)
+		defer cancel()
+
+		if err := server.Shutdown(shutdownCtx); err != nil {
+			log.Error("geth metrics server shutdown error", "err", err)
+			return err
+		}
+		return nil
+
+	case err := <-errCh:
+		if err != nil && !errors.Is(err, http.ErrServerClosed) {
+			log.Error("failed to start geth metrics server", "err", err)
+			return err
+		}
+		return nil
+	}
+}

evmd/precompiles.go renamed to precompiles/types/defaults.go

@@ -1,11 +1,9 @@
-package evmd
+package types
 
 import (
 	"fmt"
 	"maps"
 
-	addresscodec "github.com/cosmos/cosmos-sdk/codec/address"
-	sdk "github.com/cosmos/cosmos-sdk/types"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/core/vm"
 
@@ -20,11 +18,13 @@ import (
 	stakingprecompile "github.com/cosmos/evm/precompiles/staking"
 	erc20Keeper "github.com/cosmos/evm/x/erc20/keeper"
 	transferkeeper "github.com/cosmos/evm/x/ibc/transfer/keeper"
-	evmkeeper "github.com/cosmos/evm/x/vm/keeper"
 	channelkeeper "github.com/cosmos/ibc-go/v10/modules/core/04-channel/keeper"
 
 	"cosmossdk.io/core/address"
+
 	"github.com/cosmos/cosmos-sdk/codec"
+	addresscodec "github.com/cosmos/cosmos-sdk/codec/address"
+	sdktypes "github.com/cosmos/cosmos-sdk/types"
 	distributionkeeper "github.com/cosmos/cosmos-sdk/x/distribution/keeper"
 	govkeeper "github.com/cosmos/cosmos-sdk/x/gov/keeper"
 	slashingkeeper "github.com/cosmos/cosmos-sdk/x/slashing/keeper"
@@ -42,9 +42,9 @@ type Optionals struct {
 
 func defaultOptionals() Optionals {
 	return Optionals{
-		AddressCodec:       addresscodec.NewBech32Codec(sdk.GetConfig().GetBech32AccountAddrPrefix()),
-		ValidatorAddrCodec: addresscodec.NewBech32Codec(sdk.GetConfig().GetBech32ValidatorAddrPrefix()),
-		ConsensusAddrCodec: addresscodec.NewBech32Codec(sdk.GetConfig().GetBech32ConsensusAddrPrefix()),
+		AddressCodec:       addresscodec.NewBech32Codec(sdktypes.GetConfig().GetBech32AccountAddrPrefix()),
+		ValidatorAddrCodec: addresscodec.NewBech32Codec(sdktypes.GetConfig().GetBech32ValidatorAddrPrefix()),
+		ConsensusAddrCodec: addresscodec.NewBech32Codec(sdktypes.GetConfig().GetBech32ConsensusAddrPrefix()),
 	}
 }
 
@@ -70,17 +70,16 @@ func WithConsensusAddrCodec(codec address.Codec) Option {
 
 const bech32PrecompileBaseGas = 6_000
 
-// NewAvailableStaticPrecompiles returns the list of all available static precompiled contracts from Cosmos EVM.
+// DefaultStaticPrecompiles returns the list of all available static precompiled contracts from Cosmos EVM.
 //
 // NOTE: this should only be used during initialization of the Keeper.
-func NewAvailableStaticPrecompiles(
+func DefaultStaticPrecompiles(
 	stakingKeeper stakingkeeper.Keeper,
 	distributionKeeper distributionkeeper.Keeper,
 	bankKeeper cmn.BankKeeper,
-	erc20Keeper erc20Keeper.Keeper,
-	transferKeeper transferkeeper.Keeper,
+	erc20Keeper *erc20Keeper.Keeper,
+	transferKeeper *transferkeeper.Keeper,
 	channelKeeper *channelkeeper.Keeper,
-	evmKeeper *evmkeeper.Keeper,
 	govKeeper govkeeper.Keeper,
 	slashingKeeper slashingkeeper.Keeper,
 	codec codec.Codec,

rpc/backend/call_tx.go

@@ -160,6 +160,25 @@ func (b *Backend) SendRawTransaction(data hexutil.Bytes) (common.Hash, error) {
 			b.Logger.Debug("transaction queued due to nonce gap", "hash", txHash.Hex())
 			return txHash, nil
 		}
+		if b.Mempool != nil && strings.Contains(err.Error(), mempool.ErrNonceLow.Error()) {
+			from, err := ethSigner.Sender(tx)
+			if err != nil {
+				return common.Hash{}, fmt.Errorf("failed to get sender address: %w", err)
+			}
+			nonce, err := b.getAccountNonce(from, false, b.ClientCtx.Height, b.Logger)
+			if err != nil {
+				return common.Hash{}, fmt.Errorf("failed to get sender's current nonce: %w", err)
+			}
+
+			// SendRawTransaction returns error when tx.Nonce is lower than committed nonce
+			if tx.Nonce() < nonce {
+				return common.Hash{}, err
+			}
+
+			// SendRawTransaction does not return error when committed nonce <= tx.Nonce < pending nonce
+			return txHash, nil
+		}
+
 		b.Logger.Error("failed to broadcast tx", "error", err.Error())
 		return txHash, fmt.Errorf("failed to broadcast transaction: %w", err)
 	}

server/config/config.go

@@ -3,6 +3,7 @@ package config
 import (
 	"errors"
 	"fmt"
+	"net/netip"
 	"path"
 	"time"
 
@@ -66,6 +67,9 @@ const (
 	// DefaultEVMMinTip is the default minimum priority fee for the mempool
 	DefaultEVMMinTip = 0
 
+	// DefaultGethMetricsAddress is the default port for the geth metrics server.
+	DefaultGethMetricsAddress = "127.0.0.1:8100"
+
 	// DefaultGasCap is the default cap on gas that can be used in eth_call/estimateGas
 	DefaultGasCap uint64 = 25_000_000
 
@@ -145,6 +149,8 @@ type EVMConfig struct {
 	EVMChainID uint64 `mapstructure:"evm-chain-id"`
 	// MinTip defines the minimum priority fee for the mempool
 	MinTip uint64 `mapstructure:"min-tip"`
+	// GethMetricsAddress is the address the geth metrics server will bind to. Default 127.0.0.1:8100
+	GethMetricsAddress string `mapstructure:"geth-metrics-address"`
 }
 
 // JSONRPCConfig defines configuration for the EVM RPC server.
@@ -213,6 +219,7 @@ func DefaultEVMConfig() *EVMConfig {
 		EVMChainID:              DefaultEVMChainID,
 		EnablePreimageRecording: DefaultEnablePreimageRecording,
 		MinTip:                  DefaultEVMMinTip,
+		GethMetricsAddress:      DefaultGethMetricsAddress,
 	}
 }
 
@@ -222,6 +229,10 @@ func (c EVMConfig) Validate() error {
 		return fmt.Errorf("invalid tracer type %s, available types: %v", c.Tracer, evmTracers)
 	}
 
+	if _, err := netip.ParseAddrPort(c.GethMetricsAddress); err != nil {
+		return fmt.Errorf("invalid geth metrics address %q: %w", c.GethMetricsAddress, err)
+	}
+
 	return nil
 }