78e2e35f80
## Description When locally working with golangci-lint, we can see that there were many deprecation warnings about sdk.Int. This PR resolves that and makes 1-2 other linting related changes. Issue on linting coming next. This also moves BitCurve to bitCurve. I expect that this set of changes will require several pull requests, one of them to the settings for the linter. It also does a gofumpt, because we had various formatting-related linters fail, too. --- ### 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... - [x] included the correct [type prefix](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) in the PR title - [ ] added `!` to the type prefix if API or client breaking change - [x] targeted the correct branch (see [PR Targeting](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#pr-targeting)) - [x] provided a link to the relevant issue or specification - [ ] followed the guidelines for [building modules](https://github.com/cosmos/cosmos-sdk/blob/main/docs/building-modules) - [ ] included the necessary unit and integration [tests](https://github.com/cosmos/cosmos-sdk/blob/main/CONTRIBUTING.md#testing) - [x] added a changelog entry to `CHANGELOG.md` - [ ] included comments for [documenting Go code](https://blog.golang.org/godoc) - [ ] updated the relevant documentation or specification - [x] reviewed "Files changed" and left comments if necessary - [x] 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](https://github.com/commitizen/conventional-commit-types/blob/v3.0.0/index.json) 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)
75 lines
2.5 KiB
Go
75 lines
2.5 KiB
Go
package ante
|
|
|
|
import (
|
|
"fmt"
|
|
|
|
sdk "github.com/cosmos/cosmos-sdk/types"
|
|
sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
|
|
"github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx"
|
|
)
|
|
|
|
var _ GasTx = (*legacytx.StdTx)(nil) // assert StdTx implements GasTx
|
|
|
|
// GasTx defines a Tx with a GetGas() method which is needed to use SetUpContextDecorator
|
|
type GasTx interface {
|
|
sdk.Tx
|
|
GetGas() uint64
|
|
}
|
|
|
|
// SetUpContextDecorator sets the GasMeter in the Context and wraps the next AnteHandler with a defer clause
|
|
// to recover from any downstream OutOfGas panics in the AnteHandler chain to return an error with information
|
|
// on gas provided and gas used.
|
|
// CONTRACT: Must be first decorator in the chain
|
|
// CONTRACT: Tx must implement GasTx interface
|
|
type SetUpContextDecorator struct{}
|
|
|
|
func NewSetUpContextDecorator() SetUpContextDecorator {
|
|
return SetUpContextDecorator{}
|
|
}
|
|
|
|
func (sud SetUpContextDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error) {
|
|
// all transactions must implement GasTx
|
|
gasTx, ok := tx.(GasTx)
|
|
if !ok {
|
|
// Set a gas meter with limit 0 as to prevent an infinite gas meter attack
|
|
// during runTx.
|
|
newCtx = SetGasMeter(simulate, ctx, 0)
|
|
return newCtx, sdkerrors.Wrap(sdkerrors.ErrTxDecode, "Tx must be GasTx")
|
|
}
|
|
|
|
newCtx = SetGasMeter(simulate, ctx, gasTx.GetGas())
|
|
|
|
// Decorator will catch an OutOfGasPanic caused in the next antehandler
|
|
// AnteHandlers must have their own defer/recover in order for the BaseApp
|
|
// to know how much gas was used! This is because the GasMeter is created in
|
|
// the AnteHandler, but if it panics the context won't be set properly in
|
|
// runTx's recover call.
|
|
defer func() {
|
|
if r := recover(); r != nil {
|
|
switch rType := r.(type) {
|
|
case sdk.ErrorOutOfGas:
|
|
log := fmt.Sprintf(
|
|
"out of gas in location: %v; gasWanted: %d, gasUsed: %d",
|
|
rType.Descriptor, gasTx.GetGas(), newCtx.GasMeter().GasConsumed())
|
|
|
|
err = sdkerrors.Wrap(sdkerrors.ErrOutOfGas, log)
|
|
default:
|
|
panic(r)
|
|
}
|
|
}
|
|
}()
|
|
|
|
return next(newCtx, tx, simulate)
|
|
}
|
|
|
|
// SetGasMeter returns a new context with a gas meter set from a given context.
|
|
func SetGasMeter(simulate bool, ctx sdk.Context, gasLimit uint64) sdk.Context {
|
|
// In various cases such as simulation and during the genesis block, we do not
|
|
// meter any gas utilization.
|
|
if simulate || ctx.BlockHeight() == 0 {
|
|
return ctx.WithGasMeter(sdk.NewInfiniteGasMeter())
|
|
}
|
|
|
|
return ctx.WithGasMeter(sdk.NewGasMeter(gasLimit))
|
|
}
|