Enforce pricelimit in reward values returned from eth_feeHistory

.github/scripts/bootstrap_test.sh

@@ -81,6 +81,15 @@ function wait_shanghai() {
 # Run geth
 start_geth
 
+# Run these before any transactions are submitted
+echo "> Running Fee History tests"
+go test -count=1 -v ./tests/immutable \
+-privkey="$dir/cmd/geth/testdata/key.prv" \
+-rpc=http://localhost:8546 \
+-validatoradmin=http://localhost:8545 \
+-skipvoting=true \
+-run='.*FeeHistory.*'
+
 # Need to use 0x44 opcode for Prevrandao fork.
 echo "> Running post-prevrandao, pre-shanghai tests"
 go test -count=1 -v ./tests/immutable \

CHANGELOG.md

@@ -8,88 +8,89 @@ and this project adheres to
 
 ## [v1.0.0-beta.14]
 
-* Limit the number of bytes read by NR RPC middleware
-* Add fix [#30014](https://github.com/ethereum/go-ethereum/pull/30014) and [#30430](https://github.com/ethereum/go-ethereum/pull/30430) from upstream
+- Limit the number of bytes read by NR RPC middleware
+- Add fix [#30014](https://github.com/ethereum/go-ethereum/pull/30014) and [#30430](https://github.com/ethereum/go-ethereum/pull/30430) from upstream
+- Enforce pricelimit (100 gwei) on rewards values returned by `eth_feeHistory`
 
 ## [v1.0.0-beta.13]
 
-* Remove deployer allowlist
-* Add `GETH_FLAG_IMMUTABLE_LONG_RANGE_SYNC` flag to allow snap sync from genesis
+- Remove deployer allowlist
+- Add `GETH_FLAG_IMMUTABLE_LONG_RANGE_SYNC` flag to allow snap sync from genesis
 
 ## [v1.0.0-beta.12]
 
 #### Cancun
+
 This release enables Cancun fork on all Immutable zkEVM networks.
-| Network  | Unix Timestamp | Date |
+| Network | Unix Timestamp | Date |
 | -------- | ------- | ------- |
-| Devnet   | 1724796000 | Tue Aug 27 22:00:00 UTC 2024 |
-| Testnet  | 1727128800 | Mon Sep 23 22:00:00 UTC 2024 |
-| Mainnet  | 1728338400 | Mon Oct  7 22:00:00 UTC 2024 |
-
-* Enable `ExcessBlobGas`, `BlobGasUsed`, `ParentBeaconRoot`
-    * All values are `0x0`
-* Enable `WithdrawalsHash`, and `Withdrawals` headers
-    * `Withdrawals` are empty and `WithdrawalsHash` is the corresponding digest
-* Enable `TSTORE`, `TLOAD`, and `MCOPY` op codes
-* Enable `BLOBHASH` op code
-* Enable Point Evaluation precompile
-* Update `SELFDESTRUCT` op code
-* Update clique stack to support Cancun
-* Disable blob transactions
-* Re-order logic that sets blob block headers and beacon root header to after `engine.Prepare` in order to interoperate with clique which produces variable blocktimes (rather than fixed slots)
-
+| Devnet | 1724796000 | Tue Aug 27 22:00:00 UTC 2024 |
+| Testnet | 1727128800 | Mon Sep 23 22:00:00 UTC 2024 |
+| Mainnet | 1728338400 | Mon Oct 7 22:00:00 UTC 2024 |
+
+- Enable `ExcessBlobGas`, `BlobGasUsed`, `ParentBeaconRoot`
+  - All values are `0x0`
+- Enable `WithdrawalsHash`, and `Withdrawals` headers
+  - `Withdrawals` are empty and `WithdrawalsHash` is the corresponding digest
+- Enable `TSTORE`, `TLOAD`, and `MCOPY` op codes
+- Enable `BLOBHASH` op code
+- Enable Point Evaluation precompile
+- Update `SELFDESTRUCT` op code
+- Update clique stack to support Cancun
+- Disable blob transactions
+- Re-order logic that sets blob block headers and beacon root header to after `engine.Prepare` in order to interoperate with clique which produces variable blocktimes (rather than fixed slots)
 
 #### Other
 
-* Add `--gossipdefault` flag to toggle default geth tx gossiping
-* Add GETH_FLAG_P2P_SUBNET env var to limit inbound messages based on subnet
-* Add specific peer message handling in `eth/handler.go` to disable ingestion of state
-* Add `--rpcproxy` flag to toggle RPC proxy forwarding
-* Add RPC proxy forwarding to Immutable zkEVM
-* Add `--disabletxpoolgossip` flag to disable tx gossiping
-* Add `--gossipdefault` flag to toggle default geth tx gossiping
-* Add GETH_FLAG_P2P_SUBNET env var to limit inbound messages based on subnet
+- Add `--gossipdefault` flag to toggle default geth tx gossiping
+- Add GETH_FLAG_P2P_SUBNET env var to limit inbound messages based on subnet
+- Add specific peer message handling in `eth/handler.go` to disable ingestion of state
+- Add `--rpcproxy` flag to toggle RPC proxy forwarding
+- Add RPC proxy forwarding to Immutable zkEVM
+- Add `--disabletxpoolgossip` flag to disable tx gossiping
+- Add `--gossipdefault` flag to toggle default geth tx gossiping
+- Add GETH_FLAG_P2P_SUBNET env var to limit inbound messages based on subnet
 
 ## [v1.0.0-beta.11]
 
-* Added partner public role to init container logic
+- Added partner public role to init container logic
 
 ## [v1.0.0-beta.10]
 
-* Add log to correlate block period with block number and hash
+- Add log to correlate block period with block number and hash
 
 ## [v1.0.0-beta.9]
 
-* Reject forkids that do not contain prevrandao fork
-* Disable more RPC namespaces
-* Correct the embedded mainnet.toml's price limit value to 10 gwei
+- Reject forkids that do not contain prevrandao fork
+- Disable more RPC namespaces
+- Correct the embedded mainnet.toml's price limit value to 10 gwei
 
 ## [v1.0.0-beta.8]
 
-* Add prevrandao fork to forkid
-* Pull v1.13.15 from upstream: [ethereum/go-ethereum](https://github.com/ethereum/go-ethereum)
-* Log peer fullnames rather than abbreviated
-* Do not rate limit peer connections that match on the supplied networks from the net restrict configuration
-* Reduce p2p discv4 default refresh interval
+- Add prevrandao fork to forkid
+- Pull v1.13.15 from upstream: [ethereum/go-ethereum](https://github.com/ethereum/go-ethereum)
+- Log peer fullnames rather than abbreviated
+- Do not rate limit peer connections that match on the supplied networks from the net restrict configuration
+- Reduce p2p discv4 default refresh interval
 
 ## [v1.0.0-beta.7]
 
-* Create Prevrandao fork
-* Fix issues syncing with testnet and mainnet relating to Prevrandao fork
+- Create Prevrandao fork
+- Fix issues syncing with testnet and mainnet relating to Prevrandao fork
 
 ## [v1.0.0-beta.6]
 
-* Update geth version logic to be based on immutable/go-ethereum releases
-* Add `downloader/sync` metric
+- Update geth version logic to be based on immutable/go-ethereum releases
+- Add `downloader/sync` metric
 
 ## [v1.0.0-beta.5]
 
-* Pull v1.13.14 from upstream: [ethereum/go-ethereum](https://github.com/ethereum/go-ethereum)
-* Make `DefaultBaseFeeChangeDenominator` consistent with upstream (8) and mutate it based on chain configuration
-  * If chain configuration matches Immutable zkEVM network ID and clique settings, set `DefaultBaseFeeChangeDenominator` to 50
-* Validate chain configuration based on expected values if Immutable zkEVM network ID is specified
-* Use minimum price limit instead of last price to represent the priority fee of each fetched empty block inside suggested tip cap endpoint.
-* Add block period, block propagation, and suggested tip cap metrics
+- Pull v1.13.14 from upstream: [ethereum/go-ethereum](https://github.com/ethereum/go-ethereum)
+- Make `DefaultBaseFeeChangeDenominator` consistent with upstream (8) and mutate it based on chain configuration
+  - If chain configuration matches Immutable zkEVM network ID and clique settings, set `DefaultBaseFeeChangeDenominator` to 50
+- Validate chain configuration based on expected values if Immutable zkEVM network ID is specified
+- Use minimum price limit instead of last price to represent the priority fee of each fetched empty block inside suggested tip cap endpoint.
+- Add block period, block propagation, and suggested tip cap metrics
 
 ## [v1.0.0-beta.4]
 
@@ -106,13 +107,14 @@ This release enables Cancun fork on all Immutable zkEVM networks.
 ## [v1.0.0-beta.1]
 
 This release enables Shanghai fork on all Immutable zkEVM networks.
-| Network  | Unix Timestamp | Date |
+| Network | Unix Timestamp | Date |
 | -------- | ------- | ------- |
-| Devnet   | 1709067600 | Tue Feb 27 21:00:00 UTC 2024 |
-| Testnet  | 1710280800 | Tue Mar 12 22:00:00 UTC 2024 |
-| Mainnet  | 1711490400 | Tue Mar 26 22:00:00 UTC 2024 |
+| Devnet | 1709067600 | Tue Feb 27 21:00:00 UTC 2024 |
+| Testnet | 1710280800 | Tue Mar 12 22:00:00 UTC 2024 |
+| Mainnet | 1711490400 | Tue Mar 26 22:00:00 UTC 2024 |
 
 The following changes were made to support the forks:
+
 - Update clique to
   - allow for Shanghai to be enabled; and
   - log more detail around existence of withdrawals and withdrawals hashes
@@ -143,10 +145,10 @@ The following changes were made to support the forks:
 ## [v0.0.13]
 
 - Implement Immutable wallet backend
-    - Add AWS Secrets Manager backend store implementation for private key access via AWS
-    - Add local keystore backend store implementation for testing purposes
-    - Add `GETH_FLAG_IMMUTABLE_AWS_REGION` and `POD_NAMESPACE` env var support for configuring aws wallet backend
-    - Add `GETH_FLAG_PASSWORD_FILEPATH` env var to existing password filepath flag
+  - Add AWS Secrets Manager backend store implementation for private key access via AWS
+  - Add local keystore backend store implementation for testing purposes
+  - Add `GETH_FLAG_IMMUTABLE_AWS_REGION` and `POD_NAMESPACE` env var support for configuring aws wallet backend
+  - Add `GETH_FLAG_PASSWORD_FILEPATH` env var to existing password filepath flag
 - Added flag to disable Clique endpoints on RPC server
 - Added Clique Client
 - Added CLI for Clique Voting

eth/gasprice/feehistory.go

@@ -25,6 +25,7 @@ import (
 	"math/big"
 	"sync/atomic"
 
+	"github.com/ethereum/go-ethereum/cmd/geth/immutable/settings"
 	"github.com/ethereum/go-ethereum/common"
 	"github.com/ethereum/go-ethereum/consensus/misc/eip1559"
 	"github.com/ethereum/go-ethereum/core/types"
@@ -36,6 +37,8 @@ import (
 var (
 	errInvalidPercentile = errors.New("invalid reward percentile")
 	errRequestBeyondHead = errors.New("request beyond head block")
+	// CHANGE(immutable): Floor of priority fee is pricelimit
+	priceLimit = big.NewInt(int64(settings.PriceLimit))
 )
 
 const (
@@ -320,6 +323,16 @@ func (oracle *Oracle) FeeHistory(ctx context.Context, blocks uint64, unresolvedL
 	}
 	if len(rewardPercentiles) != 0 {
 		reward = reward[:firstMissing]
+		// CHANGE(immutable): Floor of priority fee is pricelimit
+		if oracle.backend.ChainConfig().IsImmutableZKEVM() {
+			for i := range reward {
+				for j := range reward[i] {
+					if reward[i][j].Cmp(priceLimit) < 0 {
+						reward[i][j] = priceLimit
+					}
+				}
+			}
+		}
 	} else {
 		reward = nil
 	}

tests/immutable/price_test.go

@@ -34,6 +34,33 @@ var (
 	underPriceLimit = big.NewInt(0).SetUint64(settings.PriceLimit - 1)
 )
 
+func TestImmutableFeeHistory_RewardAbovePriceLimit(t *testing.T) {
+	ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
+	defer cancel()
+	client, err := evm.NewClient(ctx, config.rpcURL, 1, 1)
+	require.NoError(t, err)
+
+	// Check that rewards is above price limit
+	block, err := client.BlockNumber(ctx)
+	require.NoError(t, err)
+
+	percentiles := [][]float64{
+		nil,
+		{0.25, 0.75},
+	}
+	for _, p := range percentiles {
+		feeHistory, err := client.EthClient().FeeHistory(ctx, 1, new(big.Int).SetUint64(block), p)
+		require.NoError(t, err)
+		for i := range feeHistory.Reward {
+			for j := range feeHistory.Reward[i] {
+				// Check that reward is above or equal to pricelimit
+				cmp := feeHistory.Reward[i][j].Cmp(priceLimit)
+				require.True(t, cmp == 0 || cmp == 1)
+			}
+		}
+	}
+}
+
 func TestImmutablePriceLimit_SuggestTipCap_IsAbovePriceLimit(t *testing.T) {
 	ctx, cancel := context.WithTimeout(context.Background(), 60*time.Second)
 	defer cancel()