types

package
v0.0.0-...-1329066 Latest Latest
Warning

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

 Go to latest Published: Dec 9, 2024 License: MIT Imports: 31 Imported by: 0

Documentation

Overview

Copyright 2021 Evmos Foundation This file is part of Evmos' Ethermint library.

The Ethermint library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Ethermint library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Ethermint library. If not, see https://github.com/zeta-chain/ethermint/blob/main/LICENSE

Copyright 2021 Evmos Foundation This file is part of Evmos' Ethermint library.

The Ethermint library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Ethermint library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Ethermint library. If not, see https://github.com/zeta-chain/ethermint/blob/main/LICENSE

Copyright 2021 Evmos Foundation This file is part of Evmos' Ethermint library.

The Ethermint library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Ethermint library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Ethermint library. If not, see https://github.com/zeta-chain/ethermint/blob/main/LICENSE

Copyright 2021 Evmos Foundation This file is part of Evmos' Ethermint library.

The Ethermint library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Ethermint library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Ethermint library. If not, see https://github.com/zeta-chain/ethermint/blob/main/LICENSE

Copyright 2021 Evmos Foundation This file is part of Evmos' Ethermint library.

The Ethermint library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Ethermint library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Ethermint library. If not, see https://github.com/zeta-chain/ethermint/blob/main/LICENSE

Copyright 2021 Evmos Foundation This file is part of Evmos' Ethermint library.

The Ethermint library is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

The Ethermint library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with the Ethermint library. If not, see https://github.com/zeta-chain/ethermint/blob/main/LICENSE

Index

Constants

View Source 
const (
	EthPendingBlockNumber  = BlockNumber(-2)
	EthLatestBlockNumber   = BlockNumber(-1)
	EthEarliestBlockNumber = BlockNumber(0)
)
View Source 
const (
	BlockParamEarliest  = "earliest"
	BlockParamLatest    = "latest"
	BlockParamFinalized = "finalized"
	BlockParamSafe      = "safe"
	BlockParamPending   = "pending"
)
View Source 
const (
	MessageType     = "message"
	AmountType      = "amount"
	SenderType      = "sender"
	CosmosEVMTxType = 88
)
View Source 
const ExceedBlockGasLimitError = "out of gas in location: block gas meter; gasWanted:"

ExceedBlockGasLimitError defines the error message when tx execution exceeds the block gas limit. The tx fee is deducted in ante handler, so it shouldn't be ignored in JSON-RPC API.

Variables

This section is empty.

Functions

func BaseFeeFromEvents 

func BaseFeeFromEvents(events []abci.Event) *big.Int

BaseFeeFromEvents parses the feemarket basefee from cosmos events

func BlockMaxGasFromConsensusParams 

func BlockMaxGasFromConsensusParams(goCtx context.Context, clientCtx client.Context, blockHeight int64) (int64, error)

BlockMaxGasFromConsensusParams returns the gas limit for the current block from the chain consensus params.

func CheckTxFee 

func CheckTxFee(gasPrice *big.Int, gas uint64, cap float64) error

CheckTxFee is an internal function used to check whether the fee of the given transaction is _reasonable_(under the cap).

func ContextWithHeight 

func ContextWithHeight(height int64) context.Context

ContextWithHeight wraps a context with the a gRPC block height header. If the provided height is 0, it will return an empty context and the gRPC query will use the latest block height for querying. Note that all metadata are processed and removed by tendermint layer, so it wont be accessible at gRPC server level.

func EthHeaderFromTendermint 

func EthHeaderFromTendermint(
	header tmtypes.Header,
	bloom ethtypes.Bloom,
	baseFee *big.Int,
	miner sdk.AccAddress,
) *ethtypes.Header

EthHeaderFromTendermint is an util function that returns an Ethereum Header from a tendermint Header.

func FormatBlock 

func FormatBlock(
	header tmtypes.Header, size int, gasLimit int64,
	gasUsed *big.Int, transactions []interface{}, bloom ethtypes.Bloom,
	validatorAddr common.Address, baseFee *big.Int,
) map[string]interface{}

FormatBlock creates an ethereum block from a tendermint header and ethereum-formatted transactions.

func RawTxToEthTx 

func RawTxToEthTx(clientCtx client.Context, txBz tmtypes.Tx) ([]*evmtypes.MsgEthereumTx, error)

RawTxToEthTx returns a evm MsgEthereum transaction from raw tx bytes.

func TxExceedBlockGasLimit 

func TxExceedBlockGasLimit(res *abci.ResponseDeliverTx) bool

TxExceedBlockGasLimit returns true if the tx exceeds block gas limit.

func TxSuccessOrExceedsBlockGasLimit 

func TxSuccessOrExceedsBlockGasLimit(res *abci.ResponseDeliverTx) bool

TxSuccessOrExceedsBlockGasLimit returns true if the transaction was successful or if it failed with an ExceedBlockGasLimit error

Types

type AccountResult 

type AccountResult struct {
	Address      common.Address  `json:"address"`
	AccountProof []string        `json:"accountProof"`
	Balance      *hexutil.Big    `json:"balance"`
	CodeHash     common.Hash     `json:"codeHash"`
	Nonce        hexutil.Uint64  `json:"nonce"`
	StorageHash  common.Hash     `json:"storageHash"`
	StorageProof []StorageResult `json:"storageProof"`
}

AccountResult struct for account proof

type AddrLocker 

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

AddrLocker is a mutex structure used to avoid querying outdated account data

func (*AddrLocker) LockAddr 

func (l *AddrLocker) LockAddr(address common.Address)

LockAddr locks an account's mutex. This is used to prevent another tx getting the same nonce until the lock is released. The mutex prevents the (an identical nonce) from being read again during the time that the first transaction is being signed.

func (*AddrLocker) UnlockAddr 

func (l *AddrLocker) UnlockAddr(address common.Address)

UnlockAddr unlocks the mutex of the given account.

type BlockNumber 

type BlockNumber int64

BlockNumber represents decoding hex string to block values

func NewBlockNumber 

func NewBlockNumber(n *big.Int) BlockNumber

NewBlockNumber creates a new BlockNumber instance.

func (BlockNumber) Int64 

func (bn BlockNumber) Int64() int64

Int64 converts block number to primitive type

func (BlockNumber) TmHeight 

func (bn BlockNumber) TmHeight() *int64

TmHeight is a util function used for the Tendermint RPC client. It returns nil if the block number is "latest". Otherwise, it returns the pointer of the int64 value of the height.

func (*BlockNumber) UnmarshalJSON 

func (bn *BlockNumber) UnmarshalJSON(data []byte) error

UnmarshalJSON parses the given JSON fragment into a BlockNumber. It supports: - "latest", "finalized", "earliest" or "pending" as string arguments - the block number Returned errors: - an invalid block number error when the given argument isn't a known strings - an out of range error when the given block number is either too little or too large

type BlockNumberOrHash 

type BlockNumberOrHash struct {
	BlockNumber *BlockNumber `json:"blockNumber,omitempty"`
	BlockHash   *common.Hash `json:"blockHash,omitempty"`
}

BlockNumberOrHash represents a block number or a block hash.

func (*BlockNumberOrHash) UnmarshalJSON 

func (bnh *BlockNumberOrHash) UnmarshalJSON(data []byte) error

type EventFormat 

type EventFormat int

EventFormat is the format version of the events.

To fix the issue of tx exceeds block gas limit, we changed the event format in a breaking way. But to avoid forcing clients to re-sync from scatch, we make json-rpc logic to be compatible with both formats.

type FeeHistoryResult 

type FeeHistoryResult struct {
	OldestBlock  *hexutil.Big     `json:"oldestBlock"`
	Reward       [][]*hexutil.Big `json:"reward,omitempty"`
	BaseFee      []*hexutil.Big   `json:"baseFeePerGas,omitempty"`
	GasUsedRatio []float64        `json:"gasUsedRatio"`
}
type Header struct {
	ParentHash common.Hash `json:"parentHash"       gencodec:"required"`
	UncleHash  common.Hash `json:"sha3Uncles"       gencodec:"required"`
	// update string avoid lost checksumed miner after MarshalText
	Coinbase    string              `json:"miner"`
	Root        common.Hash         `json:"stateRoot"        gencodec:"required"`
	TxHash      common.Hash         `json:"transactionsRoot" gencodec:"required"`
	ReceiptHash common.Hash         `json:"receiptsRoot"     gencodec:"required"`
	Bloom       ethtypes.Bloom      `json:"logsBloom"        gencodec:"required"`
	Difficulty  *hexutil.Big        `json:"difficulty"       gencodec:"required"`
	Number      *hexutil.Big        `json:"number"           gencodec:"required"`
	GasLimit    hexutil.Uint64      `json:"gasLimit"         gencodec:"required"`
	GasUsed     hexutil.Uint64      `json:"gasUsed"          gencodec:"required"`
	Time        hexutil.Uint64      `json:"timestamp"        gencodec:"required"`
	Extra       hexutil.Bytes       `json:"extraData"        gencodec:"required"`
	MixDigest   common.Hash         `json:"mixHash"`
	Nonce       ethtypes.BlockNonce `json:"nonce"`
	BaseFee     *hexutil.Big        `json:"baseFeePerGas"                        rlp:"optional"`
	// overwrite rlpHash
	Hash common.Hash `json:"hash"`
}

https://github.com/ethereum/go-ethereum/blob/release/1.11/core/types/gen_header_json.go#L18

type OneFeeHistory 

type OneFeeHistory struct {
	BaseFee, NextBaseFee *big.Int   // base fee for each block
	Reward               []*big.Int // each element of the array will have the tip provided to miners for the percentile given
	GasUsedRatio         float64    // the ratio of gas used to the gas limit for each block
}

type OverrideAccount 

type OverrideAccount struct {
	Nonce     *hexutil.Uint64              `json:"nonce"`
	Code      *hexutil.Bytes               `json:"code"`
	Balance   **hexutil.Big                `json:"balance"`
	State     *map[common.Hash]common.Hash `json:"state"`
	StateDiff *map[common.Hash]common.Hash `json:"stateDiff"`
}

OverrideAccount indicates the overriding fields of account during the execution of a message call. Note, state and stateDiff can't be specified at the same time. If state is set, message execution will only use the data in the given state. Otherwise if statDiff is set, all diff will be applied first and then execute the call message.

type ParsedTx 

type ParsedTx struct {
	// max uint32 means there is no sdk.Msg corresponding to eth tx
	MsgIndex int

	Hash common.Hash
	// -1 means uninitialized
	EthTxIndex int32
	GasUsed    uint64
	Failed     bool
	// Additional cosmos EVM tx fields
	TxHash    string
	Type      uint64
	Amount    *big.Int
	Recipient common.Address
	Sender    common.Address
	Nonce     uint64
	Data      []byte
}

ParsedTx is the tx infos parsed from events.

func NewParsedTx 

func NewParsedTx(msgIndex int) ParsedTx

NewParsedTx initialize a ParsedTx

type ParsedTxs 

type ParsedTxs struct {
	// one item per message
	Txs []ParsedTx
	// map tx hash to msg index
	TxHashes map[common.Hash]int
}

ParsedTxs is the tx infos parsed from eth tx events.

func ParseTxResult 

func ParseTxResult(result *abci.ResponseDeliverTx, tx sdk.Tx) (*ParsedTxs, error)

ParseTxResult parse eth tx infos from cosmos-sdk events. It supports two event formats, the formats are described in the comments of the format constants.

func (*ParsedTxs) AccumulativeGasUsed 

func (p *ParsedTxs) AccumulativeGasUsed(msgIndex int) (result uint64)

AccumulativeGasUsed calculates the accumulated gas used within the batch of txs

func (*ParsedTxs) GetTxByHash 

func (p *ParsedTxs) GetTxByHash(hash common.Hash) *ParsedTx

GetTxByHash find ParsedTx by tx hash, returns nil if not exists.

func (*ParsedTxs) GetTxByMsgIndex 

func (p *ParsedTxs) GetTxByMsgIndex(i int) *ParsedTx

GetTxByMsgIndex returns ParsedTx by msg index

func (*ParsedTxs) GetTxByTxIndex 

func (p *ParsedTxs) GetTxByTxIndex(txIndex int) *ParsedTx

GetTxByTxIndex returns ParsedTx by tx index

type QueryClient 

type QueryClient struct {
	tx.ServiceClient
	evmtypes.QueryClient
	FeeMarket feemarkettypes.QueryClient
}

QueryClient defines a gRPC Client used for:

  • Transaction simulation
  • EVM module queries
  • Fee market module queries

func NewQueryClient 

func NewQueryClient(clientCtx client.Context) *QueryClient

NewQueryClient creates a new gRPC query client

func (QueryClient) GetProof 

func (QueryClient) GetProof(clientCtx client.Context, storeKey string, key []byte) ([]byte, *crypto.ProofOps, error)

GetProof performs an ABCI query with the given key and returns a merkle proof. The desired tendermint height to perform the query should be set in the client context. The query will be performed at one below this height (at the IAVL version) in order to obtain the correct merkle proof. Proof queries at height less than or equal to 2 are not supported. Issue: https://github.com/cosmos/cosmos-sdk/issues/6567

type RPCTransaction 

type RPCTransaction struct {
	BlockHash        *common.Hash         `json:"blockHash"`
	BlockNumber      *hexutil.Big         `json:"blockNumber"`
	From             common.Address       `json:"from"`
	Gas              hexutil.Uint64       `json:"gas"`
	GasPrice         *hexutil.Big         `json:"gasPrice"`
	GasFeeCap        *hexutil.Big         `json:"maxFeePerGas,omitempty"`
	GasTipCap        *hexutil.Big         `json:"maxPriorityFeePerGas,omitempty"`
	Hash             common.Hash          `json:"hash"`
	Input            hexutil.Bytes        `json:"input"`
	Nonce            hexutil.Uint64       `json:"nonce"`
	To               *common.Address      `json:"to"`
	TransactionIndex *hexutil.Uint64      `json:"transactionIndex"`
	Value            *hexutil.Big         `json:"value"`
	Type             hexutil.Uint64       `json:"type"`
	Accesses         *ethtypes.AccessList `json:"accessList,omitempty"`
	ChainID          *hexutil.Big         `json:"chainId,omitempty"`
	V                *hexutil.Big         `json:"v"`
	R                *hexutil.Big         `json:"r"`
	S                *hexutil.Big         `json:"s"`
}

RPCTransaction represents a transaction that will serialize to the RPC representation of a transaction

func NewRPCTransaction 

func NewRPCTransaction(
	tx *ethtypes.Transaction, blockHash common.Hash, blockNumber, index uint64, baseFee *big.Int,
	chainID *big.Int,
) (*RPCTransaction, error)

NewTransactionFromData returns a transaction that will serialize to the RPC representation, with the given location metadata set (if available).

func NewRPCTransactionFromIncompleteMsg 

func NewRPCTransactionFromIncompleteMsg(
	msg *evmtypes.MsgEthereumTx, blockHash common.Hash, blockNumber, index uint64, baseFee *big.Int,
	chainID *big.Int, txAdditional *TxResultAdditionalFields,
) (*RPCTransaction, error)

NewRPCTransactionFromIncompleteMsg returns a transaction that will serialize to the RPC representation, with the given location metadata set (if available).

func NewTransactionFromMsg 

func NewTransactionFromMsg(
	msg *evmtypes.MsgEthereumTx,
	blockHash common.Hash,
	blockNumber, index uint64,
	baseFee *big.Int,
	chainID *big.Int,
	txAdditional *TxResultAdditionalFields,
) (*RPCTransaction, error)

NewTransactionFromMsg returns a transaction that will serialize to the RPC from incomplete message for cosmos EVM transactions.

type SignTransactionResult 

type SignTransactionResult struct {
	Raw hexutil.Bytes         `json:"raw"`
	Tx  *ethtypes.Transaction `json:"tx"`
}

SignTransactionResult represents a RLP encoded signed transaction.

type StateOverride 

type StateOverride map[common.Address]OverrideAccount

StateOverride is the collection of overridden accounts.

type StorageResult 

type StorageResult struct {
	Key   string       `json:"key"`
	Value *hexutil.Big `json:"value"`
	Proof []string     `json:"proof"`
}

StorageResult defines the format for storage proof return

type TxResultAdditionalFields 

type TxResultAdditionalFields struct {
	Value     *big.Int       `json:"amount"`
	Hash      common.Hash    `json:"hash"`
	TxHash    string         `json:"txHash"`
	Type      uint64         `json:"type"`
	Recipient common.Address `json:"recipient"`
	Sender    common.Address `json:"sender"`
	GasUsed   uint64         `json:"gasUsed"`
	Nonce     uint64         `json:"nonce"`
	Data      []byte         `json:"data"`
}

TxResultAdditionalFields allows to return additional cosmos EVM txs fields

func ParseTxBlockResult 

func ParseTxBlockResult(
	txResult *abci.ResponseDeliverTx,
	tx sdk.Tx,
	txIndex int,
	height int64,
) (*ethermint.TxResult, *TxResultAdditionalFields, error)

ParseTxIndexerResult parse tm tx result to a format compatible with the custom tx indexer.

func ParseTxIndexerResult 

func ParseTxIndexerResult(
	txResult *tmrpctypes.ResultTx,
	tx sdk.Tx,
	getter func(*ParsedTxs) *ParsedTx,
) (*ethermint.TxResult, *TxResultAdditionalFields, error)

ParseTxIndexerResult parse tm tx result to a format compatible with the custom tx indexer.

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.