Deprecate gas_adjustment in favor of new gas_multiplier setting
#2353
Conversation
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
romac
force-pushed
the
romac/2174-gas-multiplier
branch
from
13592de
to
d39d677
Compare
romac
force-pushed
the
romac/2174-gas-multiplier
branch
from
d39d677
to
e4cb25c
Compare
romac
force-pushed
the
romac/2174-gas-multiplier
branch
from
9b67d25
to
54d2899
Compare
romac
requested review from
adizere,
seanchen1991,
ancazamfir,
mzabaluev and
soareschen
as code owners
ljoss17
reviewed
Jun 30, 2022
relayer/src/chain/cosmos/gas.rs
Outdated
Comment on lines
79
to
85
| let gas = if digits.len() == 1 { | ||
| // If the result fits in a u64, use that | ||
| digits[0] | ||
| } else { | ||
| // Otherwise, use u64::MAX | ||
| u64::MAX | ||
| }; |
There was a problem hiding this comment.
The case where the gas_amount is simulated to 0 will cause to have the computed gas being u64::MAX, and thus the value returned by adjust_estimated_gas to be the max_gas configured.
Is this expected ? In the case this is expected, should there be a trace warning or error to inform that the simulated gas for the tx was 0 ?
ljoss17
approved these changes
Jun 30, 2022
hu55a1n1
pushed a commit
to hu55a1n1/hermes
that referenced
this pull request
Sep 13, 2022
…nformalsystems#2353) # Description This PR does the following: (cf. informalsystems#2174 (comment)) 1. Let's deprecate `gas_adjustment`. The name of the setting does not properly convey what is used for imho, and its semantics (multiply the estimated gas by the value and add it to the estimation) are confusing. 2. Instead, replace it with a `gas_multiplier` setting, with the following semantics: take the estimated gas and multiply it by the value of the setting. Meaning that when we previously had `gas_adjustment = 0.1`, which increases the gas by 10%, we would now have `gas_multiplier = 1.1`. This PR enforces a lower bound of `1.0` for the new setting but no upper bound so that people are free to use as high gas as they want. # Commits * Deprecate `gas_adjustment` in favor of new `gas_multiplier` setting * Add changelog entry * Add tests for `adjust_gas` * Fix `unused_variable` warning * Improve tests * Fix typo in test code * Use 1.1 gas_multiplier in mock tests * Return zero when `gas_amount` is zero, instead of max_gas * Short-circuit when gas_amount = 0 or gas_multiplier = 1
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes: #2174
Description
This PR does the following: (cf. #2174 (comment))
gas_adjustment. The name of the setting does not properly convey what is used for imho, and its semantics (multiply the estimated gas by the value and add it to the estimation) are confusing.gas_multipliersetting, with the following semantics: take the estimated gas and multiply it by the value of the setting.Meaning that when we previously had
gas_adjustment = 0.1, which increases the gas by 10%, we would now havegas_multiplier = 1.1.This PR enforces a lower bound of
1.0for the new setting but no upper bound so that people are free to use as high gas as they want.Note regarding backward incompatibility
This PR aims to hand-hold operators to use the new setting instead of the old one whenever they update to the Hermes version including these changes (1.0.0).
If an operator is still using the
gas_adjustmentsetting in their config, they will be greeted with the following message when they try to run any command, as well asconfig validate:Note: the message above arises when
gas_adjustmentis set to0.1in the config of chainibc-0.PR author checklist:
unclog.docs/).Reviewer checklist:
Files changedin the GitHub PR explorer.