fix: revert tx when block gas limit exceeded (backport: #10770) #10814

yihuang · 2021-12-20T07:17:56Z

Description

backport from #10770, but used a different solution from the master one, because of difference in code structure.

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...

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 ! in the type prefix if API or client breaking change
confirmed all author checklist items have been addressed
reviewed state machine logic
reviewed API design and naming
reviewed documentation is accurate
reviewed tests and test coverage
manually tested (if applicable)

amaury1093 · 2022-01-03T13:35:27Z

oh nice, thanks a lot. I'm putting in draft for now, let's merge #10770 first.

yihuang · 2022-01-04T12:01:58Z

I guess we better write a unit test for this too, but I find it not easy to do that? which test suite is the best place to write a test case for this?

yihuang · 2022-01-11T10:12:24Z

baseapp/baseapp.go

@@ -586,11 +586,6 @@ func (app *BaseApp) runTx(mode runTxMode, txBytes []byte) (gInfo sdk.GasInfo, re
 		return gInfo, nil, nil, sdkerrors.Wrap(sdkerrors.ErrOutOfGas, "no block gas left to run tx")
 	}

-	var startingGas uint64


no need to check overflow since it's already handled in ConsumeGas.

amaury1093

this seems correct to me, @yihuang did you think of how we can write a test for this?

Edit: maybe in TestMaxBlockGasLimits in baseapp_test?

amaury1093 · 2022-01-11T12:15:33Z

baseapp/baseapp.go

 	defer func() {
 		if mode == runTxModeDeliver {
-			ctx.BlockGasMeter().ConsumeGas(
-				ctx.GasMeter().GasConsumedToLimit(), "block gas meter",
-			)
-
-			if ctx.BlockGasMeter().GasConsumed() < startingGas {
-				panic(sdk.ErrorGasOverflow{Descriptor: "tx gas summation"})
-			}
+			consumeBlockGas()


Can we remove this defer func?

AFAIK, there's no gas consumption after runMsgs. So if we put consumeBlockGas in runTx, before store write, then it should be okay?

We need defer function to consume block gas when panic happens I think.

Okay, let's maybe keep it for now

yihuang · 2022-01-11T15:10:08Z

this seems correct to me, @yihuang did you think of how we can write a test for this?

Edit: maybe in TestMaxBlockGasLimits in baseapp_test?

I tried before, find it very tedious to set up the environment, let me try it again.

yihuang · 2022-01-11T17:25:43Z

this seems correct to me, @yihuang did you think of how we can write a test for this?

Edit: maybe in TestMaxBlockGasLimits in baseapp_test?

We can't do that in baseapp_test, because baseapp module is imported by keeper, if we setup keepers, it'll cause cyclic import. we need to use sth like SimApp.

- used a different solution. changelog

yihuang · 2022-01-11T18:40:17Z

this seems correct to me, @yihuang did you think of how we can write a test for this?

Edit: maybe in TestMaxBlockGasLimits in baseapp_test?

tests added.

amaury1093

thanks a lot

Let's get this released today 😎

robert-zaremba

utACK, left few tiny comments.

baseapp/baseapp.go

robert-zaremba · 2022-01-12T10:33:48Z

baseapp/baseapp.go

@@ -677,6 +677,9 @@ func (app *BaseApp) runTx(mode runTxMode, txBytes []byte) (gInfo sdk.GasInfo, re
 	// Result if any single message fails or does not have a registered Handler.
 	result, err = app.runMsgs(runMsgCtx, msgs, mode)
 	if err == nil && mode == runTxModeDeliver {
+		// When block gas exceeds, it'll panic and won't commit the cached store.
+		consumeBlockGas()


do we need to call it here? It's already called in defer (line 614)

do we need to call it here? It's already called in defer (line 614)

That's the main purpose of this PR, call it here so if block gas limit exceeded, it'll panic and won't execute the msCache.Write(), so the tx msg side effects are not persisted.

makes sense. Thanks!

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

amaury1093 · 2022-01-12T15:19:21Z

Merging!

…cosmos#10814) * revert tx when block gas limit exceeded (backport: cosmos#10770) - used a different solution. changelog * add unit test * Update baseapp/baseapp.go Co-authored-by: Robert Zaremba <robert@zaremba.ch> * simplfy the defer function Co-authored-by: Robert Zaremba <robert@zaremba.ch>

yihuang requested review from aaronc and alexanderbez as code owners December 20, 2021 07:17

yihuang changed the title ~~revert tx when block gas limit exceeded (backport: #10770)~~ fix: revert tx when block gas limit exceeded (backport: #10770) Dec 20, 2021

yihuang mentioned this pull request Dec 21, 2021

Missing transactions while looping through eth_getBlockByNumber crypto-org-chain/cronos#268

Closed

tomtau mentioned this pull request Jan 3, 2022

chore: v0.45.0 Release Notes #10760

Merged

20 tasks

amaury1093 marked this pull request as draft January 3, 2022 13:35

yihuang force-pushed the block-gas-0.45 branch from 41009cb to e73a18e Compare January 4, 2022 04:52

yihuang mentioned this pull request Jan 4, 2022

Problem: recent ethermint and cosmos-sdk fixes not included crypto-org-chain/cronos#289

Merged

13 tasks

fedekunze added the backport/0.45.x label Jan 4, 2022

yihuang force-pushed the block-gas-0.45 branch 3 times, most recently from d6862eb to fc6b209 Compare January 10, 2022 07:47

amaury1093 mentioned this pull request Jan 11, 2022

fix: should revert tx when block gas limit exceeded #10770

Merged

19 tasks

yihuang commented Jan 11, 2022

View reviewed changes

yihuang marked this pull request as ready for review January 11, 2022 10:29

amaury1093 reviewed Jan 11, 2022

View reviewed changes

amaury1093 requested a review from robert-zaremba January 11, 2022 12:09

amaury1093 removed the backport/0.45.x label Jan 11, 2022

amaury1093 added this to the v0.45.0 milestone Jan 11, 2022

amaury1093 reviewed Jan 11, 2022

View reviewed changes

blushi assigned amaury1093 Jan 11, 2022

yihuang added 2 commits January 12, 2022 02:29

revert tx when block gas limit exceeded (backport: cosmos#10770)

8c9a098

- used a different solution. changelog

add unit test

3d67fa8

yihuang force-pushed the block-gas-0.45 branch from 4f9cf40 to 3d67fa8 Compare January 11, 2022 18:29

yihuang requested a review from amaury1093 January 11, 2022 18:39

amaury1093 approved these changes Jan 12, 2022

View reviewed changes

robert-zaremba approved these changes Jan 12, 2022

View reviewed changes

yihuang and others added 2 commits January 12, 2022 21:22

Update baseapp/baseapp.go

f8fcd45

Co-authored-by: Robert Zaremba <robert@zaremba.ch>

simplfy the defer function

c0fc7a9

amaury1093 merged commit ba1e099 into cosmos:release/v0.45.x Jan 12, 2022

yihuang deleted the block-gas-0.45 branch January 12, 2022 15:28

nddeluca mentioned this pull request Jan 14, 2022

State Breaking: Backport fix to prevent failed transactions from commiting state when block gas limit is reached Kava-Labs/cosmos-sdk#21

Merged

faddat mentioned this pull request Feb 28, 2022

v0.45.x akash-network/cosmos-sdk#176

Closed

8 tasks

coderabbitai bot mentioned this pull request Apr 19, 2024

Problem: panic on invalid elasticity_multiplier crypto-org-chain/cronos#1397

Merged

13 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: revert tx when block gas limit exceeded (backport: #10770) #10814

fix: revert tx when block gas limit exceeded (backport: #10770) #10814

yihuang commented Dec 20, 2021 •

edited

amaury1093 commented Jan 3, 2022

yihuang commented Jan 4, 2022 •

edited

yihuang Jan 11, 2022

amaury1093 left a comment •

edited

amaury1093 Jan 11, 2022

yihuang Jan 11, 2022

amaury1093 Jan 11, 2022

yihuang commented Jan 11, 2022

yihuang commented Jan 11, 2022

yihuang commented Jan 11, 2022

amaury1093 left a comment

robert-zaremba left a comment

robert-zaremba Jan 12, 2022

yihuang Jan 12, 2022 •

edited

robert-zaremba Jan 12, 2022

amaury1093 commented Jan 12, 2022

fix: revert tx when block gas limit exceeded (backport: #10770) #10814

fix: revert tx when block gas limit exceeded (backport: #10770) #10814

Conversation

yihuang commented Dec 20, 2021 • edited

Description

Author Checklist

Reviewers Checklist

amaury1093 commented Jan 3, 2022

yihuang commented Jan 4, 2022 • edited

yihuang Jan 11, 2022

Choose a reason for hiding this comment

amaury1093 left a comment • edited

Choose a reason for hiding this comment

amaury1093 Jan 11, 2022

Choose a reason for hiding this comment

yihuang Jan 11, 2022

Choose a reason for hiding this comment

amaury1093 Jan 11, 2022

Choose a reason for hiding this comment

yihuang commented Jan 11, 2022

yihuang commented Jan 11, 2022

yihuang commented Jan 11, 2022

amaury1093 left a comment

Choose a reason for hiding this comment

robert-zaremba left a comment

Choose a reason for hiding this comment

robert-zaremba Jan 12, 2022

Choose a reason for hiding this comment

yihuang Jan 12, 2022 • edited

Choose a reason for hiding this comment

robert-zaremba Jan 12, 2022

Choose a reason for hiding this comment

amaury1093 commented Jan 12, 2022

yihuang commented Dec 20, 2021 •

edited

yihuang commented Jan 4, 2022 •

edited

amaury1093 left a comment •

edited

yihuang Jan 12, 2022 •

edited