-
Notifications
You must be signed in to change notification settings - Fork 297
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refactor!: version gas scheduler variables (#3735)
## Overview - Fixes #3404 - Fixes #3748 - Fixes #3762 --------- Co-authored-by: Rootul P <[email protected]>
- Loading branch information
1 parent
0f1a99b
commit 857d107
Showing
24 changed files
with
596 additions
and
97 deletions.
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
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 |
|---|---|---|
| @@ -0,0 +1,151 @@ | ||
| package ante | ||
|
|
||
| import ( | ||
| "encoding/hex" | ||
|
|
||
| "cosmossdk.io/errors" | ||
| "github.com/celestiaorg/celestia-app/v3/pkg/appconsts" | ||
| v2 "github.com/celestiaorg/celestia-app/v3/pkg/appconsts/v2" | ||
| "github.com/cosmos/cosmos-sdk/codec/legacy" | ||
| "github.com/cosmos/cosmos-sdk/crypto/keys/multisig" | ||
| "github.com/cosmos/cosmos-sdk/crypto/keys/secp256k1" | ||
| cryptotypes "github.com/cosmos/cosmos-sdk/crypto/types" | ||
| sdk "github.com/cosmos/cosmos-sdk/types" | ||
| sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" | ||
| "github.com/cosmos/cosmos-sdk/types/tx/signing" | ||
| "github.com/cosmos/cosmos-sdk/x/auth/ante" | ||
| "github.com/cosmos/cosmos-sdk/x/auth/migrations/legacytx" | ||
| authsigning "github.com/cosmos/cosmos-sdk/x/auth/signing" | ||
| auth "github.com/cosmos/cosmos-sdk/x/auth/types" | ||
| ) | ||
|
|
||
| var ( | ||
| // Simulation signature values used to estimate gas consumption. | ||
| key = make([]byte, secp256k1.PubKeySize) | ||
| simSecp256k1Pubkey = &secp256k1.PubKey{Key: key} | ||
| simSecp256k1Sig [64]byte | ||
| ) | ||
|
|
||
| func init() { | ||
| // Decodes a valid hex string into a sepc256k1Pubkey for use in transaction simulation | ||
| bz, _ := hex.DecodeString("035AD6810A47F073553FF30D2FCC7E0D3B1C0B74B61A1AAA2582344037151E143A") | ||
| copy(key, bz) | ||
| simSecp256k1Pubkey.Key = key | ||
| } | ||
|
|
||
| // ConsumeTxSizeGasDecorator will take in parameters and consume gas proportional | ||
| // to the size of tx before calling next AnteHandler. Note, the gas costs will be | ||
| // slightly over estimated due to the fact that any given signing account may need | ||
| // to be retrieved from state. | ||
| // | ||
| // CONTRACT: If simulate=true, then signatures must either be completely filled | ||
| // in or empty. | ||
| // CONTRACT: To use this decorator, signatures of transaction must be represented | ||
| // as legacytx.StdSignature otherwise simulate mode will incorrectly estimate gas cost. | ||
|
|
||
| // The code was copied from celestia's fork of the cosmos-sdk: | ||
| // https://github.com/celestiaorg/cosmos-sdk/blob/release/v0.46.x-celestia/x/auth/ante/basic.go | ||
| // In app versions v2 and below, the txSizeCostPerByte used for gas cost estimation is taken from the auth module. | ||
| // In app v3 and above, the versioned constant appconsts.TxSizeCostPerByte is used. | ||
| type ConsumeTxSizeGasDecorator struct { | ||
| ak ante.AccountKeeper | ||
| } | ||
|
|
||
| func NewConsumeGasForTxSizeDecorator(ak ante.AccountKeeper) ConsumeTxSizeGasDecorator { | ||
| return ConsumeTxSizeGasDecorator{ | ||
| ak: ak, | ||
| } | ||
| } | ||
|
|
||
| func (cgts ConsumeTxSizeGasDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error) { | ||
| sigTx, ok := tx.(authsigning.SigVerifiableTx) | ||
| if !ok { | ||
| return ctx, errors.Wrap(sdkerrors.ErrTxDecode, "invalid tx type") | ||
| } | ||
| params := cgts.ak.GetParams(ctx) | ||
|
|
||
| consumeGasForTxSize(ctx, sdk.Gas(len(ctx.TxBytes())), params) | ||
|
|
||
| // simulate gas cost for signatures in simulate mode | ||
| if simulate { | ||
| // in simulate mode, each element should be a nil signature | ||
| sigs, err := sigTx.GetSignaturesV2() | ||
| if err != nil { | ||
| return ctx, err | ||
| } | ||
| n := len(sigs) | ||
|
|
||
| for i, signer := range sigTx.GetSigners() { | ||
| // if signature is already filled in, no need to simulate gas cost | ||
| if i < n && !isIncompleteSignature(sigs[i].Data) { | ||
| continue | ||
| } | ||
|
|
||
| var pubkey cryptotypes.PubKey | ||
|
|
||
| acc := cgts.ak.GetAccount(ctx, signer) | ||
|
|
||
| // use placeholder simSecp256k1Pubkey if sig is nil | ||
| if acc == nil || acc.GetPubKey() == nil { | ||
| pubkey = simSecp256k1Pubkey | ||
| } else { | ||
| pubkey = acc.GetPubKey() | ||
| } | ||
|
|
||
| // use stdsignature to mock the size of a full signature | ||
| simSig := legacytx.StdSignature{ //nolint:staticcheck // this will be removed when proto is ready | ||
| Signature: simSecp256k1Sig[:], | ||
| PubKey: pubkey, | ||
| } | ||
|
|
||
| sigBz := legacy.Cdc.MustMarshal(simSig) | ||
| txBytes := sdk.Gas(len(sigBz) + 6) | ||
|
|
||
| // If the pubkey is a multi-signature pubkey, then we estimate for the maximum | ||
| // number of signers. | ||
| if _, ok := pubkey.(*multisig.LegacyAminoPubKey); ok { | ||
| txBytes *= params.TxSigLimit | ||
| } | ||
|
|
||
| consumeGasForTxSize(ctx, txBytes, params) | ||
| } | ||
| } | ||
|
|
||
| return next(ctx, tx, simulate) | ||
| } | ||
|
|
||
| // isIncompleteSignature tests whether SignatureData is fully filled in for simulation purposes | ||
| func isIncompleteSignature(data signing.SignatureData) bool { | ||
| if data == nil { | ||
| return true | ||
| } | ||
|
|
||
| switch data := data.(type) { | ||
| case *signing.SingleSignatureData: | ||
| return len(data.Signature) == 0 | ||
| case *signing.MultiSignatureData: | ||
| if len(data.Signatures) == 0 { | ||
| return true | ||
| } | ||
| for _, s := range data.Signatures { | ||
| if isIncompleteSignature(s) { | ||
| return true | ||
| } | ||
| } | ||
| } | ||
|
|
||
| return false | ||
| } | ||
|
|
||
| // consumeGasForTxSize consumes gas based on the size of the transaction. | ||
| // It uses different parameters depending on the app version. | ||
| func consumeGasForTxSize(ctx sdk.Context, txBytes uint64, params auth.Params) { | ||
| // For app v2 and below we should get txSizeCostPerByte from auth module | ||
| if ctx.BlockHeader().Version.App <= v2.Version { | ||
| ctx.GasMeter().ConsumeGas(params.TxSizeCostPerByte*txBytes, "txSize") | ||
| } else { | ||
| // From v3 onwards, we should get txSizeCostPerByte from appconsts | ||
| txSizeCostPerByte := appconsts.TxSizeCostPerByte(ctx.BlockHeader().Version.App) | ||
| ctx.GasMeter().ConsumeGas(txSizeCostPerByte*txBytes, "txSize") | ||
| } | ||
| } |
Oops, something went wrong.