Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(x/auth): remove misleading gas wanted value from tx simulation failure response #18772

Merged
merged 3 commits into from
Dec 18, 2023

Conversation

yihuang
Copy link
Collaborator

@yihuang yihuang commented Dec 18, 2023

We were puzzled by the huge gas wanted value output in the simulation failure response (With gas wanted: '18446744073709551615' and gas used: '318310'), thought we made some mistake in building the tx, but actually it's not the gas wanted we set in the tx, but due to an InfinitGasMeter is set in simulation mode bypassing the tx gas limit, which makes the GasWanted to be MaxUint64.

We suggest to remove this misleading value from the response.

Description

Closes: #XXXX


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • reviewed "Files changed" and left comments if necessary
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • updated the relevant documentation or specification, including comments for documenting Go code
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

We were puzzled by the huge gas wanted value logged by simulation failure, thought we made some mistake in tx building,
but actually it's not the gas wanted set in the tx, but due to an `InfinitGasMeter` is set in simulation mode bypassing the input gas limit,
which makes the `gasInfo.GasWanted` to be `MaxUint64`.

So I suggest we don't output this value here at all.
@yihuang yihuang requested a review from a team as a code owner December 18, 2023 03:31
Copy link
Contributor

coderabbitai bot commented Dec 18, 2023

Walkthrough

The recent changes involve the removal of misleading information regarding 'gas wanted' from the transaction simulation failure logs. This adjustment was made to ensure that the error messages are clear and do not provide unnecessary or incorrect data that could confuse users during transaction simulation errors.

Changes

File(s) Change Summary
CHANGELOG.md, x/auth/tx/service.go Removed misleading gas wanted information from transaction simulation failure logs and error messages.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on X ?


Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can reply to a review comment made by CodeRabbit.
  • You can tag CodeRabbit on specific lines of code or files in the PR by tagging @coderabbitai in a comment.
  • You can tag @coderabbitai in a PR comment and ask one-off questions about the PR and the codebase. Use quoted replies to pass the context for follow-up questions.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CHANGELOG.md Outdated Show resolved Hide resolved
@yihuang yihuang changed the title Problem: tx simulation failure log reports wrong gas wanted value fix: remove misleading gas wanted value from tx simulation failure response Dec 18, 2023
x/auth/tx/service.go Outdated Show resolved Hide resolved
Co-authored-by: Aleksandr Bezobchuk <[email protected]>
@julienrbrt julienrbrt added backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release labels Dec 18, 2023
@julienrbrt julienrbrt changed the title fix: remove misleading gas wanted value from tx simulation failure response fix(x/auth): remove misleading gas wanted value from tx simulation failure response Dec 18, 2023
@julienrbrt julienrbrt enabled auto-merge December 18, 2023 09:30
@julienrbrt julienrbrt added this pull request to the merge queue Dec 18, 2023
Merged via the queue into cosmos:main with commit e0b1675 Dec 18, 2023
57 of 59 checks passed
mergify bot pushed a commit that referenced this pull request Dec 18, 2023
…ilure response (#18772)

Co-authored-by: Aleksandr Bezobchuk <[email protected]>
(cherry picked from commit e0b1675)

# Conflicts:
#	CHANGELOG.md
mergify bot pushed a commit that referenced this pull request Dec 18, 2023
…ilure response (#18772)

Co-authored-by: Aleksandr Bezobchuk <[email protected]>
(cherry picked from commit e0b1675)

# Conflicts:
#	CHANGELOG.md
julienrbrt added a commit that referenced this pull request Dec 18, 2023
…ilure response (backport #18772) (#18775)

Co-authored-by: yihuang <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
atheeshp pushed a commit that referenced this pull request Dec 19, 2023
…ilure response (backport #18772) (#18776)

Co-authored-by: yihuang <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
MSalopek pushed a commit to informalsystems/cosmos-sdk that referenced this pull request Feb 27, 2024
…ilure response (backport cosmos#18772) (cosmos#18776)

Co-authored-by: yihuang <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
@faddat faddat mentioned this pull request Mar 20, 2024
12 tasks
emidev98 pushed a commit to terra-money/cosmos-sdk that referenced this pull request Mar 21, 2024
…ilure response (backport cosmos#18772) (cosmos#18776)

Co-authored-by: yihuang <[email protected]>
Co-authored-by: Julien Robert <[email protected]>
@faddat faddat mentioned this pull request Nov 8, 2024
12 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release backport/v0.50.x PR scheduled for inclusion in the v0.50's next stable release C:x/auth
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants