ante

package
v1.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 23, 2024 License: Apache-2.0 Imports: 30 Imported by: 0

Documentation

Overview

Package ante defines the SDK auth module's AnteHandler as well as an internal AnteHandler for an Ethereum transaction (i.e MsgEthereumTx).

During CheckTx, the transaction is passed through a series of pre-message execution validation checks such as signature and account verification in addition to minimum fees being checked. Otherwise, during DeliverTx, the transaction is simply passed to the EVM which will also perform the same series of checks. The distinction is made in CheckTx to prevent spam and DoS attacks.

Index

Constants

View Source 
const (
	LegacyTxType = iota
	AccessListTxType
	DynamicFeeTxType
)

Transaction types.

Variables

View Source 
var (
	ErrInvalidChainId     = errors.New("invalid chain id for signer")
	ErrTxTypeNotSupported = errors.New("transaction type not supported")
	ErrInvalidSig         = errors.New("invalid transaction v, r, s values")
)

Functions

func NewAnteHandler 

func NewAnteHandler(options HandlerOptions) sdk.AnteHandler

NewAnteHandler returns an ante handler responsible for attempting to route an Ethereum or SDK transaction to an internal ante handler for performing transaction-level processing (e.g. fee payment, signature verification) before being passed onto it's respective handler.

Types

type AccountKeeper 

type AccountKeeper interface {
	NewAccount(ctx sdk.Context, acc authtypes.AccountI) authtypes.AccountI
	NewAccountWithAddress(ctx sdk.Context, addr sdk.AccAddress) authtypes.AccountI
	SetAccount(ctx sdk.Context, acc authtypes.AccountI)
	GetAccount(ctx sdk.Context, addr sdk.AccAddress) authtypes.AccountI
	GetAllAccounts(ctx sdk.Context) (accounts []authtypes.AccountI)
	IterateAccounts(ctx sdk.Context, cb func(account authtypes.AccountI) bool)
	GetParams(ctx sdk.Context) (params authtypes.Params)
	GetModuleAddress(moduleName string) sdk.AccAddress
	GetSequence(sdk.Context, sdk.AccAddress) (uint64, error)
	RemoveAccount(ctx sdk.Context, account authtypes.AccountI)
}

type ChargeGasfreeFeesDecorator 

type ChargeGasfreeFeesDecorator struct {
	// contains filtered or unexported fields
}

ChargeGasfreeFeesDecorator enables custom fee charging for gas-free transactions on a per-message basis

func NewChargeGasfreeFeesDecorator 

func NewChargeGasfreeFeesDecorator(ak AccountKeeper, gasfreeKeeper gasfreekeeper.Keeper, microtxKeeper microtxkeeper.Keeper) ChargeGasfreeFeesDecorator

func (ChargeGasfreeFeesDecorator) AnteHandle 

func (satd ChargeGasfreeFeesDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error)

AnteHandle charges fees for gas-free transactions on a case-by-case basis

func (ChargeGasfreeFeesDecorator) DeductAnyMicrotxFees 

func (satd ChargeGasfreeFeesDecorator) DeductAnyMicrotxFees(ctx sdk.Context, tx sdk.Tx) error

type EthAccountVerificationDecorator 

type EthAccountVerificationDecorator struct {
	// contains filtered or unexported fields
}

EthAccountVerificationDecorator validates an account balance checks

func NewEthAccountVerificationDecorator 

func NewEthAccountVerificationDecorator(ak AccountKeeper, ek *evmkeeper.Keeper) EthAccountVerificationDecorator

NewEthAccountVerificationDecorator creates a new EthAccountVerificationDecorator

func (EthAccountVerificationDecorator) AnteHandle 

func (avd EthAccountVerificationDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error)

AnteHandle validates checks that the sender balance is greater than the total transaction cost. The account will be set to store if it doesn't exis, i.e cannot be found on store. This AnteHandler decorator will fail if: - any of the msgs is not a MsgEthereumTx - from address is empty - account balance is lower than the transaction cost

type EthSetPubkeyDecorator 

type EthSetPubkeyDecorator struct {
	// contains filtered or unexported fields
}

EthSetPubkeyDecorator sets the pubkey on the account for EVM Txs CONTRACT: Tx must contain a single ExtensionOptionsEthereumTx

This decorator should come AFTER assigning From on the Tx, AFTER signature verification, and AFTER the account is stored

func NewEthSetPubkeyDecorator 

func NewEthSetPubkeyDecorator(ak AccountKeeper, evmKeeper *evmkeeper.Keeper) EthSetPubkeyDecorator

func (EthSetPubkeyDecorator) AnteHandle 

func (espd EthSetPubkeyDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error)

AnteHandle sets the pubkey for the account

type EthVestingTransactionDecorator 

type EthVestingTransactionDecorator struct {
	// contains filtered or unexported fields
}

EthVestingTransactionDecorator validates if clawback vesting accounts are permitted to perform Ethereum Tx.

func NewEthVestingTransactionDecorator 

func NewEthVestingTransactionDecorator(ak AccountKeeper) EthVestingTransactionDecorator

func (EthVestingTransactionDecorator) AnteHandle 

func (vtd EthVestingTransactionDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error)

AnteHandle validates that a clawback vesting account has surpassed the vesting cliff and lockup period.

This AnteHandler decorator will fail if:

  • the message is not a MsgEthereumTx
  • sender account cannot be found
  • sender account is not a ClawbackvestingAccount
  • blocktime is before surpassing vesting cliff end (with zero vested coins) AND
  • blocktime is before surpassing all lockup periods (with non-zero locked coins)

type HandlerOptions 

type HandlerOptions struct {
	AccountKeeper   AccountKeeper
	BankKeeper      evmtypes.BankKeeper
	IBCKeeper       *ibckeeper.Keeper
	FeeMarketKeeper evmtypes.FeeMarketKeeper
	StakingKeeper   vestingtypes.StakingKeeper
	EvmKeeper       *evmkeeper.Keeper
	FeegrantKeeper  ante.FeegrantKeeper
	SignModeHandler authsigning.SignModeHandler
	SigGasConsumer  func(meter sdk.GasMeter, sig signing.SignatureV2, params authtypes.Params) error
	Cdc             codec.BinaryCodec
	MaxTxGasWanted  uint64
	GasfreeKeeper   *gasfreekeeper.Keeper
	MicrotxKeeper   *microtxkeeper.Keeper
}

HandlerOptions defines the list of module keepers required to run the canto AnteHandler decorators.

func (HandlerOptions) Validate 

func (options HandlerOptions) Validate() error

Validate checks if the keepers are defined

type SetAccountTypeDecorator 

type SetAccountTypeDecorator struct {
	// contains filtered or unexported fields
}

SetAccountTypeDecorator sets the account type to EthAccount for Ethermint pubkeys PubKeys must be set in context before this decorator runs ethAccountProto initializes an Ethermint account

CONTRACT: Tx must implement SignedTx interface (sdk.Tx interface + GetSigners() method)

func NewSetAccountTypeDecorator 

func NewSetAccountTypeDecorator(ak AccountKeeper, ethAccountProto func(sdk.AccAddress) authtypes.AccountI) SetAccountTypeDecorator

func (SetAccountTypeDecorator) AnteHandle 

func (satd SetAccountTypeDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (sdk.Context, error)

type SignedTx 

type SignedTx interface {
	sdk.Tx
	GetSigners() []sdk.AccAddress
}

type ValidatorCommissionDecorator 

type ValidatorCommissionDecorator struct {
	// contains filtered or unexported fields
}

ValidatorCommissionDecorator validates that the validator commission is always greater or equal than the min commission rate

func NewValidatorCommissionDecorator 

func NewValidatorCommissionDecorator(cdc codec.BinaryCodec) ValidatorCommissionDecorator

NewValidatorCommissionDecorator creates a new NewValidatorCommissionDecorator

func (ValidatorCommissionDecorator) AnteHandle 

func (vcd ValidatorCommissionDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error)

AnteHandle checks if the tx contains a staking create validator or edit validator. It errors if the the commission rate is below the min threshold.

type VestingDelegationDecorator 

type VestingDelegationDecorator struct {
	// contains filtered or unexported fields
}

VestingDelegationDecorator validates delegation of vested coins

func NewVestingDelegationDecorator 

func NewVestingDelegationDecorator(ak evmtypes.AccountKeeper, sk vestingtypes.StakingKeeper, cdc codec.BinaryCodec) VestingDelegationDecorator

NewVestingDelegationDecorator creates a new VestingDelegationDecorator

func (VestingDelegationDecorator) AnteHandle 

func (vdd VestingDelegationDecorator) AnteHandle(ctx sdk.Context, tx sdk.Tx, simulate bool, next sdk.AnteHandler) (newCtx sdk.Context, err error)

AnteHandle checks if the tx contains a staking delegation. It errors if the coins are still locked or the bond amount is greater than the coins already vested

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.