github.1485827954.workers.dev/ethereum/go-ethereum@v1.14.3/ethclient/simulated/options.go (about)

     1  // Copyright 2024 The go-ethereum Authors
     2  // This file is part of the go-ethereum library.
     3  //
     4  // The go-ethereum library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The go-ethereum library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  package simulated
    18  
    19  import (
    20  	"math/big"
    21  
    22  	"github.com/ethereum/go-ethereum/eth/ethconfig"
    23  	"github.com/ethereum/go-ethereum/node"
    24  )
    25  
    26  // WithBlockGasLimit configures the simulated backend to target a specific gas limit
    27  // when producing blocks.
    28  func WithBlockGasLimit(gaslimit uint64) func(nodeConf *node.Config, ethConf *ethconfig.Config) {
    29  	return func(nodeConf *node.Config, ethConf *ethconfig.Config) {
    30  		ethConf.Genesis.GasLimit = gaslimit
    31  		ethConf.Miner.GasCeil = gaslimit
    32  	}
    33  }
    34  
    35  // WithCallGasLimit configures the simulated backend to cap eth_calls to a specific
    36  // gas limit when running client operations.
    37  func WithCallGasLimit(gaslimit uint64) func(nodeConf *node.Config, ethConf *ethconfig.Config) {
    38  	return func(nodeConf *node.Config, ethConf *ethconfig.Config) {
    39  		ethConf.RPCGasCap = gaslimit
    40  	}
    41  }
    42  
    43  // WithMinerMinTip configures the simulated backend to require a specific minimum
    44  // gas tip for a transaction to be included.
    45  //
    46  // 0 is not possible as a live Geth node would reject that due to DoS protection,
    47  // so the simulated backend will replicate that behavior for consistency.
    48  func WithMinerMinTip(tip *big.Int) func(nodeConf *node.Config, ethConf *ethconfig.Config) {
    49  	if tip == nil || tip.Sign() <= 0 {
    50  		panic("invalid miner minimum tip")
    51  	}
    52  	return func(nodeConf *node.Config, ethConf *ethconfig.Config) {
    53  		ethConf.Miner.GasPrice = tip
    54  	}
    55  }