Submitter: setGasPrice() refactor #2462
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -346,119 +346,211 @@ | |
| } | ||
|
|
||
| // setGasPrice sets the gas price for the transaction. | ||
| // If a prevTx is specified, a bump will be attempted; otherwise values will be | ||
| // set from the gas oracle. | ||
| // If gas values exceed the configured max, an error will be returned. | ||
| func (t *txSubmitterImpl) setGasPrice(ctx context.Context, client client.EVM, | ||
| transactor *bind.TransactOpts, bigChainID *big.Int, prevTx *types.Transaction) (err error) { | ||
| ctx, span := t.metrics.Tracer().Start(ctx, "submitter.setGasPrice") | ||
|
|
||
| chainID := int(bigChainID.Uint64()) | ||
| useDynamic := t.config.SupportsEIP1559(chainID) | ||
| shouldBump := prevTx != nil | ||
|
|
||
| defer func() { | ||
| span.SetAttributes( | ||
| attribute.Int(metrics.ChainID, chainID), | ||
| attribute.Bool("use_dynamic", useDynamic), | ||
| attribute.Bool("should_bump", shouldBump), | ||
| attribute.String("gas_price", bigPtrToString(transactor.GasPrice)), | ||
| attribute.String("gas_fee_cap", bigPtrToString(transactor.GasFeeCap)), | ||
| attribute.String("gas_tip_cap", bigPtrToString(transactor.GasTipCap)), | ||
| ) | ||
| metrics.EndSpanWithErr(span, err) | ||
| }() | ||
|
|
||
| t.populateGasFromPrevTx(ctx, transactor, prevTx, useDynamic) | ||
| t.applyGasFloor(ctx, transactor, chainID, useDynamic, shouldBump) | ||
|
|
||
| err = t.applyGasFromOracle(ctx, transactor, client, useDynamic) | ||
| if err != nil { | ||
| return fmt.Errorf("could not populate gas from oracle: %w", err) | ||
| } | ||
|
|
||
| err = t.applyGasCeil(ctx, transactor, chainID, useDynamic) | ||
| if err != nil { | ||
| return fmt.Errorf("could not apply gas ceil: %w", err) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // populateGasFromPrevTx populates the gas fields from the previous transaction. | ||
| // Note that in the event of a tx type mismatch, gasFeeCap is copied to gasPrice, | ||
| // and gasPrice is copied to both gasFeeCap and gasTipCap in the opposite scenario. | ||
| // | ||
| //nolint:nestif | ||
| func (t *txSubmitterImpl) populateGasFromPrevTx(ctx context.Context, transactor *bind.TransactOpts, prevTx *types.Transaction, currentDynamic bool) { | ||
| if prevTx == nil { | ||
| return | ||
| } | ||
|
|
||
| _, span := t.metrics.Tracer().Start(ctx, "submitter.populateGasFromPrevTx") | ||
|
|
||
| defer func() { | ||
| span.SetAttributes( | ||
| attribute.String("gas_price", bigPtrToString(transactor.GasPrice)), | ||
| attribute.String("gas_fee_cap", bigPtrToString(transactor.GasFeeCap)), | ||
| attribute.String("gas_tip_cap", bigPtrToString(transactor.GasTipCap)), | ||
| ) | ||
| metrics.EndSpan(span) | ||
| }() | ||
|
|
||
| prevDynamic := prevTx.Type() == types.DynamicFeeTxType | ||
| if currentDynamic { | ||
| if prevDynamic { | ||
| transactor.GasFeeCap = core.CopyBigInt(prevTx.GasFeeCap()) | ||
| transactor.GasTipCap = core.CopyBigInt(prevTx.GasTipCap()) | ||
| } else { | ||
| transactor.GasFeeCap = core.CopyBigInt(prevTx.GasPrice()) | ||
| transactor.GasTipCap = core.CopyBigInt(prevTx.GasPrice()) | ||
| } | ||
| } else { | ||
| if prevDynamic { | ||
| transactor.GasPrice = core.CopyBigInt(prevTx.GasFeeCap()) | ||
| } else { | ||
| transactor.GasPrice = core.CopyBigInt(prevTx.GasPrice()) | ||
| } | ||
| } | ||
| } | ||
ChiTimesChi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| // applyGasFloor applies the min gas price from the config if values are unset. | ||
| // Otherwise, gas values are bumped by the configured GasBumpPercentage. | ||
| // | ||
| //nolint:cyclop,nestif | ||
| func (t *txSubmitterImpl) applyGasFloor(ctx context.Context, transactor *bind.TransactOpts, chainID int, useDynamic, shouldBump bool) { | ||
| _, span := t.metrics.Tracer().Start(ctx, "submitter.applyGasFloor") | ||
|
|
||
| defer func() { | ||
| span.SetAttributes( | ||
| attribute.String("gas_price", bigPtrToString(transactor.GasPrice)), | ||
| attribute.String("gas_fee_cap", bigPtrToString(transactor.GasFeeCap)), | ||
| attribute.String("gas_tip_cap", bigPtrToString(transactor.GasTipCap)), | ||
| attribute.Bool("should_bump", shouldBump), | ||
| ) | ||
| metrics.EndSpan(span) | ||
| }() | ||
|
|
||
| gasFloor := t.config.GetMinGasPrice(chainID) | ||
| if shouldBump { | ||
| bumpPct := t.config.GetGasBumpPercentage(chainID) | ||
| if useDynamic { | ||
| if transactor.GasFeeCap == nil { | ||
| transactor.GasFeeCap = gasFloor | ||
| span.AddEvent("gas fee cap is nil; setting to gas floor") | ||
| } else { | ||
| transactor.GasFeeCap = gas.BumpByPercent(transactor.GasFeeCap, bumpPct) | ||
| } | ||
| if transactor.GasTipCap == nil { | ||
| transactor.GasTipCap = gasFloor | ||
| span.AddEvent("gas tip cap is nil; setting to gas floor") | ||
| } else { | ||
| transactor.GasTipCap = gas.BumpByPercent(transactor.GasTipCap, bumpPct) | ||
ChiTimesChi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } else { | ||
| transactor.GasPrice = gas.BumpByPercent(transactor.GasPrice, bumpPct) | ||
| } | ||
| } else { | ||
| if useDynamic { | ||
| if transactor.GasFeeCap == nil || transactor.GasFeeCap.Cmp(gasFloor) < 0 { | ||
| transactor.GasFeeCap = gasFloor | ||
| } | ||
| if transactor.GasTipCap == nil || transactor.GasTipCap.Cmp(gasFloor) < 0 { | ||
| transactor.GasTipCap = gasFloor | ||
ChiTimesChi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
| } else if transactor.GasPrice == nil || transactor.GasPrice.Cmp(gasFloor) < 0 { | ||
| transactor.GasPrice = gasFloor | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // applyGasFromOracle fetches gas values from a RPC endpoint and attempts to set them. | ||
| // If values are already specified, they will be overridden if the oracle values are higher. | ||
| func (t *txSubmitterImpl) applyGasFromOracle(ctx context.Context, transactor *bind.TransactOpts, client client.EVM, useDynamic bool) (err error) { | ||
| ctx, span := t.metrics.Tracer().Start(ctx, "submitter.applyGasFromOracle") | ||
|
|
||
| defer func() { | ||
| metrics.EndSpanWithErr(span, err) | ||
| }() | ||
|
|
||
| if useDynamic { | ||
| suggestedGasFeeCap, err := client.SuggestGasPrice(ctx) | ||
ChiTimesChi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| if err != nil { | ||
| return fmt.Errorf("could not get gas fee cap: %w", err) | ||
| } | ||
| transactor.GasFeeCap = maxOfBig(transactor.GasFeeCap, suggestedGasFeeCap) | ||
| suggestedGasTipCap, err := client.SuggestGasTipCap(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("could not get gas tip cap: %w", err) | ||
| } | ||
| transactor.GasTipCap = maxOfBig(transactor.GasTipCap, suggestedGasTipCap) | ||
| span.SetAttributes( | ||
| attribute.String("suggested_gas_fee_cap", bigPtrToString(suggestedGasFeeCap)), | ||
| attribute.String("suggested_gas_tip_cap", bigPtrToString(suggestedGasTipCap)), | ||
| attribute.String("gas_fee_cap", bigPtrToString(transactor.GasFeeCap)), | ||
| attribute.String("gas_tip_cap", bigPtrToString(transactor.GasTipCap)), | ||
| ) | ||
| } else { | ||
| suggestedGasPrice, err := client.SuggestGasPrice(ctx) | ||
| if err != nil { | ||
| return fmt.Errorf("could not get gas price: %w", err) | ||
| } | ||
| transactor.GasPrice = maxOfBig(transactor.GasPrice, suggestedGasPrice) | ||
| span.SetAttributes( | ||
| attribute.String("suggested_gas_price", bigPtrToString(suggestedGasPrice)), | ||
| attribute.String("gas_price", bigPtrToString(transactor.GasPrice)), | ||
| ) | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| // applyGasCeil evaluates current gas values versus the configured maximum, and | ||
| // returns an error if they exceed the maximum. | ||
| func (t *txSubmitterImpl) applyGasCeil(ctx context.Context, transactor *bind.TransactOpts, chainID int, useDynamic bool) (err error) { | ||
| _, span := t.metrics.Tracer().Start(ctx, "submitter.applyGasCeil") | ||
|
|
||
| maxPrice := t.config.GetMaxGasPrice(chainID) | ||
|
|
||
| defer func() { | ||
| span.SetAttributes(attribute.String("max_price", bigPtrToString(maxPrice))) | ||
| metrics.EndSpanWithErr(span, err) | ||
| }() | ||
|
|
||
| if useDynamic { | ||
| if transactor.GasFeeCap.Cmp(maxPrice) > 0 { | ||
| return fmt.Errorf("gas fee cap %s exceeds max price %s", transactor.GasFeeCap, maxPrice) | ||
| } | ||
| // TODO: should maxPrice apply to GasTipCap as well? | ||
ChiTimesChi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } else { | ||
| if transactor.GasPrice.Cmp(maxPrice) > 0 { | ||
| return fmt.Errorf("gas price %s exceeds max price %s", transactor.GasPrice, maxPrice) | ||
| } | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func maxOfBig(a, b *big.Int) *big.Int { | ||
| if a == nil { | ||
| return b | ||
| } | ||
| if b == nil { | ||
| return a | ||
| } | ||
| if a.Cmp(b) > 0 { | ||
| return a | ||
| } | ||
| return b | ||
ChiTimesChi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| // getGasBlock gets the gas block for the given chain. | ||
| func (t *txSubmitterImpl) getGasBlock(ctx context.Context, chainClient client.EVM, chainID int) (gasBlock *types.Header, err error) { | ||
| ctx, span := t.metrics.Tracer().Start(ctx, "submitter.getGasBlock") | ||
|
|
||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Min gas price of 10 Gwei is an overshoot.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This makes sense- I'm confused of the intention here though in the base PR?
https://github.com/synapsecns/sanguine/pull/2432/files#diff-9cb5c46a90d8a5d8f06ab1c53594fbc934b93eaf5131c538424f0c4666f94f49R429
To me this seems like we will never set gas price below 10 gwei if no
prevTxis suppliedThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The unit there is in wei
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Let's introduce a min value for GasPrice/GasFeeCap (DefaultMinGasPrice) and a separate one for GasTipCap. The latter one is set to 10 Wei (aka just 10) in the base PR.