internal/ethapi: add document for DoEstimateGas

jsvisa · jsvisa · commit aa47d0197a3b · 2023-08-01T23:14:38.000+08:00
Signed-off-by: jsvisa &lt;delweng@gmail.com&gt;
diff --git a/internal/ethapi/api.go b/internal/ethapi/api.go
@@ -1134,6 +1134,8 @@ func (s *BlockChainAPI) Call(ctx context.Context, args TransactionArgs, blockNrO
 	return result.Return(), result.Err
 }
 
+// DoEstimateGas estimates the gas needed to execute a specific transaction.
+// Note, the flag noBaseFee indicating whether to skip the base fee check
 func DoEstimateGas(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, gasCap uint64, noBaseFee bool) (hexutil.Uint64, error) {
 	// Binary search the gas requirement, as it may be higher than the amount used
 	var (

Original file line number	Diff line number	Diff line change
`@@ -1134,6 +1134,8 @@ func (s *BlockChainAPI) Call(ctx context.Context, args TransactionArgs, blockNrO`
`1134`	`1134`	`return result.Return(), result.Err`
`1135`	`1135`	`}`
`1136`	`1136`
	`1137`	`+// DoEstimateGas estimates the gas needed to execute a specific transaction.`
	`1138`	`+// Note, the flag noBaseFee indicating whether to skip the base fee check`
`1137`	`1139`	`func DoEstimateGas(ctx context.Context, b Backend, args TransactionArgs, blockNrOrHash rpc.BlockNumberOrHash, gasCap uint64, noBaseFee bool) (hexutil.Uint64, error) {`
`1138`	`1140`	`// Binary search the gas requirement, as it may be higher than the amount used`
`1139`	`1141`	`var (`