eth: internal: add eth_maxEnvelopeGas API

Author: txhsl

eth/api_backend.go

@@ -30,6 +30,7 @@ import (
 	"github.com/ethereum/go-ethereum/core/bloombits"
 	"github.com/ethereum/go-ethereum/core/rawdb"
 	"github.com/ethereum/go-ethereum/core/state"
+	"github.com/ethereum/go-ethereum/core/systemcontracts"
 	"github.com/ethereum/go-ethereum/core/txpool"
 	"github.com/ethereum/go-ethereum/core/types"
 	"github.com/ethereum/go-ethereum/core/vm"
@@ -381,6 +382,14 @@ func (b *EthAPIBackend) EnvelopeFee(ctx context.Context) (*big.Int, error) {
 	return b.gpo.EnvelopeFee(ctx)
 }
 
+func (b *EthAPIBackend) MaxEnvelopeGas(ctx context.Context) (*big.Int, error) {
+	stateDb, err := b.eth.blockchain.State()
+	if err != nil {
+		return nil, err
+	}
+	return stateDb.GetState(systemcontracts.PolicyProxyHash, systemcontracts.GetMaxEnvelopeGasLimitStateHash()).Big(), nil
+}
+
 func (b *EthAPIBackend) FeeHistory(ctx context.Context, blockCount uint64, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (firstBlock *big.Int, reward [][]*big.Int, baseFee []*big.Int, gasUsedRatio []float64, err error) {
 	return b.gpo.FeeHistory(ctx, blockCount, lastBlock, rewardPercentiles)
 }

ethclient/ethclient.go

@@ -577,6 +577,15 @@ func (ec *Client) EnvelopeFee(ctx context.Context) (*big.Int, error) {
 	return (*big.Int)(&hex), nil
 }
 
+// MaxEnvelopeGas retrieves the currently maximum envelope gas limit policy.
+func (ec *Client) MaxEnvelopeGas(ctx context.Context) (*big.Int, error) {
+	var hex hexutil.Big
+	if err := ec.c.CallContext(ctx, &hex, "eth_maxEnvelopeGas"); err != nil {
+		return nil, err
+	}
+	return (*big.Int)(&hex), nil
+}
+
 type feeHistoryResultMarshaling struct {
 	OldestBlock  *hexutil.Big     `json:"oldestBlock"`
 	Reward       [][]*hexutil.Big `json:"reward,omitempty"`

ethclient/ethclient_test.go

@@ -515,6 +515,24 @@ func testStatusFunctions(t *testing.T, client *rpc.Client) {
 		t.Fatalf("unexpected gas tip cap: %v", gasTipCap)
 	}
 
+	// EnvelopeFee
+	envelopeFee, err := ec.EnvelopeFee(context.Background())
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if envelopeFee.Cmp(big.NewInt(0)) != 0 {
+		t.Fatalf("unexpected envelope fee: %v", envelopeFee)
+	}
+
+	// MaxEnvelopeGas
+	maxEnvelopeGas, err := ec.MaxEnvelopeGas(context.Background())
+	if err != nil {
+		t.Fatalf("unexpected error: %v", err)
+	}
+	if maxEnvelopeGas.Cmp(big.NewInt(0)) != 0 {
+		t.Fatalf("unexpected max envelope gas: %v", maxEnvelopeGas)
+	}
+
 	// FeeHistory
 	history, err := ec.FeeHistory(context.Background(), 1, big.NewInt(2), []float64{95, 99})
 	if err != nil {

internal/ethapi/api.go

@@ -104,6 +104,15 @@ func (s *EthereumAPI) EnvelopeFee(ctx context.Context) (*hexutil.Big, error) {
 	return (*hexutil.Big)(fee), err
 }
 
+// MaxEnvelopeGas returns the maximum envelope gas limit allowed by policy
+func (s *EthereumAPI) MaxEnvelopeGas(ctx context.Context) (*hexutil.Big, error) {
+	maxGas, err := s.b.MaxEnvelopeGas(ctx)
+	if err != nil {
+		return nil, err
+	}
+	return (*hexutil.Big)(maxGas), err
+}
+
 type feeHistoryResult struct {
 	OldestBlock  *hexutil.Big     `json:"oldestBlock"`
 	Reward       [][]*hexutil.Big `json:"reward,omitempty"`

internal/ethapi/api_test.go

@@ -471,6 +471,9 @@ func (b testBackend) SuggestGasTipCap(ctx context.Context) (*big.Int, error) {
 func (b testBackend) EnvelopeFee(ctx context.Context) (*big.Int, error) {
 	return big.NewInt(0), nil
 }
+func (b testBackend) MaxEnvelopeGas(ctx context.Context) (*big.Int, error) {
+	return big.NewInt(0), nil
+}
 func (b testBackend) FeeHistory(ctx context.Context, blockCount uint64, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (*big.Int, [][]*big.Int, []*big.Int, []float64, error) {
 	return nil, nil, nil, nil, nil
 }

internal/ethapi/backend.go

@@ -45,6 +45,7 @@ type Backend interface {
 
 	SuggestGasTipCap(ctx context.Context) (*big.Int, error)
 	EnvelopeFee(ctx context.Context) (*big.Int, error)
+	MaxEnvelopeGas(ctx context.Context) (*big.Int, error)
 	FeeHistory(ctx context.Context, blockCount uint64, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (*big.Int, [][]*big.Int, []*big.Int, []float64, error)
 	ChainDb() ethdb.Database
 	AccountManager() *accounts.Manager

internal/ethapi/transaction_args_test.go

@@ -317,6 +317,9 @@ func (b *backendMock) SuggestGasTipCap(ctx context.Context) (*big.Int, error) {
 func (b *backendMock) EnvelopeFee(ctx context.Context) (*big.Int, error) {
 	return big.NewInt(42), nil
 }
+func (b *backendMock) MaxEnvelopeGas(ctx context.Context) (*big.Int, error) {
+	return big.NewInt(42), nil
+}
 func (b *backendMock) CurrentHeader() *types.Header     { return b.current }
 func (b *backendMock) ChainConfig() *params.ChainConfig { return b.config }