types

package
v1.13.3 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2023 License: GPL-3.0 Imports: 25 Imported by: 28,848

Documentation

Overview

Package types contains data types related to Ethereum consensus.

Index

Constants

View Source 
const (
	// BloomByteLength represents the number of bytes used in a header log bloom.
	BloomByteLength = 256

	// BloomBitLength represents the number of bits used in a header log bloom.
	BloomBitLength = 8 * BloomByteLength
)
View Source 
const (
	// ReceiptStatusFailed is the status code of a transaction if execution failed.
	ReceiptStatusFailed = uint64(0)

	// ReceiptStatusSuccessful is the status code of a transaction if execution succeeded.
	ReceiptStatusSuccessful = uint64(1)
)
View Source 
const (
	LegacyTxType     = 0x00
	AccessListTxType = 0x01
	DynamicFeeTxType = 0x02
	BlobTxType       = 0x03
)

Transaction types.

Variables

View Source 
var (
	// EmptyRootHash is the known root hash of an empty trie.
	EmptyRootHash = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")

	// EmptyUncleHash is the known hash of the empty uncle set.
	EmptyUncleHash = rlpHash([]*Header(nil)) // 1dcc4de8dec75d7aab85b567b6ccd41ad312451b948a7413f0a142fd40d49347

	// EmptyCodeHash is the known hash of the empty EVM bytecode.
	EmptyCodeHash = crypto.Keccak256Hash(nil) // c5d2460186f7233c927e7db2dcc703c0e500b653ca82273b7bfad8045d85a470

	// EmptyTxsHash is the known hash of the empty transaction set.
	EmptyTxsHash = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")

	// EmptyReceiptsHash is the known hash of the empty receipt set.
	EmptyReceiptsHash = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")

	// EmptyWithdrawalsHash is the known hash of the empty withdrawal set.
	EmptyWithdrawalsHash = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
)
View Source 
var (
	ErrInvalidSig           = errors.New("invalid transaction v, r, s values")
	ErrUnexpectedProtection = errors.New("transaction type does not supported EIP-155 protected signatures")
	ErrInvalidTxType        = errors.New("transaction type not valid in this context")
	ErrTxTypeNotSupported   = errors.New("transaction type not supported")
	ErrGasFeeCapTooLow      = errors.New("fee cap less than base fee")
)
View Source 
var ErrInvalidChainId = errors.New("invalid chain id for signer")

Functions

func Bloom9 added in v0.9.17 

func Bloom9(data []byte) []byte

Bloom9 returns the bloom filter for the given data

func BloomLookup 

func BloomLookup(bin Bloom, topic bytesBacked) bool

BloomLookup is a convenience-method to check presence in the bloom filter

func CalcUncleHash added in v0.9.34 

func CalcUncleHash(uncles []*Header) common.Hash

func DeriveSha 

func DeriveSha(list DerivableList, hasher TrieHasher) common.Hash

DeriveSha creates the tree hashes of transactions, receipts, and withdrawals in a block header.

func FullAccountRLP added in v1.12.1 

func FullAccountRLP(data []byte) ([]byte, error)

FullAccountRLP converts data on the 'slim RLP' format into the full RLP-format.

func HashDifference added in v1.10.19 

func HashDifference(a, b []common.Hash) []common.Hash

HashDifference returns a new set which is the difference between a and b.

func HeaderParentHashFromRLP added in v1.10.14 

func HeaderParentHashFromRLP(header []byte) common.Hash

HeaderParentHashFromRLP returns the parentHash of an RLP-encoded header. If 'header' is invalid, the zero hash is returned.

func LogsBloom 

func LogsBloom(logs []*Log) []byte

LogsBloom returns the bloom bytes for the given logs

func Sender added in v1.5.0 

func Sender(signer Signer, tx *Transaction) (common.Address, error)

Sender returns the address derived from the signature (V, R, S) using secp256k1 elliptic curve and an error if it failed deriving or upon an incorrect signature.

Sender may cache the address, allowing it to be used regardless of signing method. The cache is invalidated if the cached signer does not match the signer used in the current call.

func SlimAccountRLP added in v1.12.1 

func SlimAccountRLP(account StateAccount) []byte

SlimAccountRLP encodes the state account in 'slim RLP' format.

func TrieRootHash added in v1.12.1 

func TrieRootHash(hash common.Hash) common.Hash

TrieRootHash returns the hash itself if it's non-empty or the predefined emptyHash one instead.

Types

type AccessList added in v1.10.0 

type AccessList []AccessTuple

AccessList is an EIP-2930 access list.

func (AccessList) StorageKeys added in v1.10.0 

func (al AccessList) StorageKeys() int

StorageKeys returns the total number of storage keys in the access list.

type AccessListTx added in v1.10.0 

type AccessListTx struct {
	ChainID    *big.Int        // destination chain ID
	Nonce      uint64          // nonce of sender account
	GasPrice   *big.Int        // wei per gas
	Gas        uint64          // gas limit
	To         *common.Address `rlp:"nil"` // nil means contract creation
	Value      *big.Int        // wei amount
	Data       []byte          // contract invocation input data
	AccessList AccessList      // EIP-2930 access list
	V, R, S    *big.Int        // signature values
}

AccessListTx is the data of EIP-2930 access list transactions.

type AccessTuple added in v1.10.0 

type AccessTuple struct {
	Address     common.Address `json:"address"     gencodec:"required"`
	StorageKeys []common.Hash  `json:"storageKeys" gencodec:"required"`
}

AccessTuple is the element type of an access list.

func (AccessTuple) MarshalJSON added in v1.10.0 

func (a AccessTuple) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*AccessTuple) UnmarshalJSON added in v1.10.0 

func (a *AccessTuple) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type BlobTx added in v1.12.0 

type BlobTx struct {
	ChainID    *uint256.Int
	Nonce      uint64
	GasTipCap  *uint256.Int // a.k.a. maxPriorityFeePerGas
	GasFeeCap  *uint256.Int // a.k.a. maxFeePerGas
	Gas        uint64
	To         common.Address
	Value      *uint256.Int
	Data       []byte
	AccessList AccessList
	BlobFeeCap *uint256.Int // a.k.a. maxFeePerBlobGas
	BlobHashes []common.Hash

	// A blob transaction can optionally contain blobs. This field must be set when BlobTx
	// is used to create a transaction for sigining.
	Sidecar *BlobTxSidecar `rlp:"-"`

	// Signature values
	V *uint256.Int `json:"v" gencodec:"required"`
	R *uint256.Int `json:"r" gencodec:"required"`
	S *uint256.Int `json:"s" gencodec:"required"`
}

BlobTx represents an EIP-4844 transaction.

type BlobTxSidecar added in v1.13.0 

type BlobTxSidecar struct {
	Blobs       []kzg4844.Blob       // Blobs needed by the blob pool
	Commitments []kzg4844.Commitment // Commitments needed by the blob pool
	Proofs      []kzg4844.Proof      // Proofs needed by the blob pool
}

BlobTxSidecar contains the blobs of a blob transaction.

func (*BlobTxSidecar) BlobHashes added in v1.13.0 

func (sc *BlobTxSidecar) BlobHashes() []common.Hash

BlobHashes computes the blob hashes of the given blobs.

type Block 

type Block struct {

	// These fields are used by package eth to track
	// inter-peer block relay.
	ReceivedAt   time.Time
	ReceivedFrom interface{}
	// contains filtered or unexported fields
}

Block represents an Ethereum block.

Note the Block type tries to be 'immutable', and contains certain caches that rely on that. The rules around block immutability are as follows:

  • We copy all data when the block is constructed. This makes references held inside the block independent of whatever value was passed in.

  • We copy all header data on access. This is because any change to the header would mess up the cached hash and size values in the block. Calling code is expected to take advantage of this to avoid over-allocating!

  • When new body data is attached to the block, a shallow copy of the block is returned. This ensures block modifications are race-free.

  • We do not copy body data on access because it does not affect the caches, and also because it would be too expensive.

func NewBlock added in v0.8.4 

func NewBlock(header *Header, txs []*Transaction, uncles []*Header, receipts []*Receipt, hasher TrieHasher) *Block

NewBlock creates a new block. The input data is copied, changes to header and to the field values will not affect the block.

The values of TxHash, UncleHash, ReceiptHash and Bloom in header are ignored and set to values derived from the given txs, uncles and receipts.

func NewBlockWithHeader added in v0.8.4 

func NewBlockWithHeader(header *Header) *Block

NewBlockWithHeader creates a block with the given header data. The header data is copied, changes to header and to the field values will not affect the block.

func NewBlockWithWithdrawals added in v1.11.0 

func NewBlockWithWithdrawals(header *Header, txs []*Transaction, uncles []*Header, receipts []*Receipt, withdrawals []*Withdrawal, hasher TrieHasher) *Block

NewBlockWithWithdrawals creates a new block with withdrawals. The input data is copied, changes to header and to the field values will not affect the block.

The values of TxHash, UncleHash, ReceiptHash and Bloom in header are ignored and set to values derived from the given txs, uncles and receipts.

func (*Block) BaseFee added in v1.10.4 

func (b *Block) BaseFee() *big.Int

func (*Block) BeaconRoot added in v1.13.0 

func (b *Block) BeaconRoot() *common.Hash

func (*Block) BlobGasUsed added in v1.12.1 

func (b *Block) BlobGasUsed() *uint64

func (*Block) Bloom added in v0.8.4 

func (b *Block) Bloom() Bloom

func (*Block) Body added in v1.4.0 

func (b *Block) Body() *Body

Body returns the non-header content of the block. Note the returned data is not an independent copy.

func (*Block) Coinbase 

func (b *Block) Coinbase() common.Address

func (*Block) DecodeRLP added in v0.8.4 

func (b *Block) DecodeRLP(s *rlp.Stream) error

DecodeRLP decodes a block from RLP.

func (*Block) Difficulty 

func (b *Block) Difficulty() *big.Int

func (*Block) EncodeRLP added in v0.9.17 

func (b *Block) EncodeRLP(w io.Writer) error

EncodeRLP serializes a block as RLP.

func (*Block) ExcessBlobGas added in v1.12.1 

func (b *Block) ExcessBlobGas() *uint64

func (*Block) Extra 

func (b *Block) Extra() []byte

func (*Block) GasLimit 

func (b *Block) GasLimit() uint64

func (*Block) GasUsed 

func (b *Block) GasUsed() uint64

func (*Block) Hash 

func (b *Block) Hash() common.Hash

Hash returns the keccak256 hash of b's header. The hash is computed on the first call and cached thereafter.

func (*Block) Header added in v0.8.4 

func (b *Block) Header() *Header

Header returns the block header (as a copy).

func (*Block) MixDigest added in v0.9.17 

func (b *Block) MixDigest() common.Hash

func (*Block) Nonce 

func (b *Block) Nonce() uint64

func (*Block) Number 

func (b *Block) Number() *big.Int

func (*Block) NumberU64 added in v0.8.4 

func (b *Block) NumberU64() uint64

func (*Block) ParentHash added in v0.8.4 

func (b *Block) ParentHash() common.Hash

func (*Block) ReceiptHash added in v0.9.34 

func (b *Block) ReceiptHash() common.Hash

func (*Block) Root 

func (b *Block) Root() common.Hash

func (*Block) SanityCheck added in v1.9.0 

func (b *Block) SanityCheck() error

SanityCheck can be used to prevent that unbounded fields are stuffed with junk data to add processing overhead

func (*Block) Size 

func (b *Block) Size() uint64

Size returns the true RLP encoded storage size of the block, either by encoding and returning it, or returning a previously cached value.

func (*Block) Time 

func (b *Block) Time() uint64

func (*Block) Transaction added in v0.8.4 

func (b *Block) Transaction(hash common.Hash) *Transaction

func (*Block) Transactions 

func (b *Block) Transactions() Transactions

func (*Block) TxHash added in v0.9.34 

func (b *Block) TxHash() common.Hash

func (*Block) UncleHash added in v0.9.34 

func (b *Block) UncleHash() common.Hash

func (*Block) Uncles 

func (b *Block) Uncles() []*Header

func (*Block) WithBody added in v1.2.2 

func (b *Block) WithBody(transactions []*Transaction, uncles []*Header) *Block

WithBody returns a copy of the block with the given transaction and uncle contents.

func (*Block) WithSeal added in v1.6.0 

func (b *Block) WithSeal(header *Header) *Block

WithSeal returns a new block with the data from b but the header replaced with the sealed one.

func (*Block) WithWithdrawals added in v1.11.0 

func (b *Block) WithWithdrawals(withdrawals []*Withdrawal) *Block

WithWithdrawals returns a copy of the block containing the given withdrawals.

func (*Block) Withdrawals added in v1.11.0 

func (b *Block) Withdrawals() Withdrawals

type BlockNonce added in v0.9.34 

type BlockNonce [8]byte

A BlockNonce is a 64-bit hash which proves (combined with the mix-hash) that a sufficient amount of computation has been carried out on a block.

func EncodeNonce added in v0.9.34 

func EncodeNonce(i uint64) BlockNonce

EncodeNonce converts the given integer to a block nonce.

func (BlockNonce) MarshalText added in v1.6.0 

func (n BlockNonce) MarshalText() ([]byte, error)

MarshalText encodes n as a hex string with 0x prefix.

func (BlockNonce) Uint64 added in v0.9.34 

func (n BlockNonce) Uint64() uint64

Uint64 returns the integer value of a block nonce.

func (*BlockNonce) UnmarshalText added in v1.6.0 

func (n *BlockNonce) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Blocks 

type Blocks []*Block

type Bloom added in v0.9.17 

type Bloom [BloomByteLength]byte

Bloom represents a 2048 bit bloom filter.

func BytesToBloom added in v0.9.17 

func BytesToBloom(b []byte) Bloom

BytesToBloom converts a byte slice to a bloom filter. It panics if b is not of suitable size.

func CreateBloom 

func CreateBloom(receipts Receipts) Bloom

CreateBloom creates a bloom filter out of the give Receipts (+Logs)

func (*Bloom) Add added in v1.3.1 

func (b *Bloom) Add(d []byte)

Add adds d to the filter. Future calls of Test(d) will return true.

func (Bloom) Big added in v0.9.17 

func (b Bloom) Big() *big.Int

Big converts b to a big integer. Note: Converting a bloom filter to a big.Int and then calling GetBytes does not return the same bytes, since big.Int will trim leading zeroes

func (Bloom) Bytes added in v0.9.17 

func (b Bloom) Bytes() []byte

Bytes returns the backing byte slice of the bloom

func (Bloom) MarshalText added in v1.6.0 

func (b Bloom) MarshalText() ([]byte, error)

MarshalText encodes b as a hex string with 0x prefix.

func (*Bloom) SetBytes added in v0.9.17 

func (b *Bloom) SetBytes(d []byte)

SetBytes sets the content of b to the given bytes. It panics if d is not of suitable size.

func (Bloom) Test added in v1.3.1 

func (b Bloom) Test(topic []byte) bool

Test checks if the given topic is present in the bloom filter

func (*Bloom) UnmarshalText added in v1.6.0 

func (b *Bloom) UnmarshalText(input []byte) error

UnmarshalText b as a hex string with 0x prefix.

type Body added in v1.2.2 

type Body struct {
	Transactions []*Transaction
	Uncles       []*Header
	Withdrawals  []*Withdrawal `rlp:"optional"`
}

Body is a simple (mutable, non-safe) data container for storing and moving a block's data contents (transactions and uncles) together.

type DerivableList 

type DerivableList interface {
	Len() int
	EncodeIndex(int, *bytes.Buffer)
}

DerivableList is the input to DeriveSha. It is implemented by the 'Transactions' and 'Receipts' types. This is internal, do not use these methods.

type DynamicFeeTx added in v1.10.4 

type DynamicFeeTx struct {
	ChainID    *big.Int
	Nonce      uint64
	GasTipCap  *big.Int // a.k.a. maxPriorityFeePerGas
	GasFeeCap  *big.Int // a.k.a. maxFeePerGas
	Gas        uint64
	To         *common.Address `rlp:"nil"` // nil means contract creation
	Value      *big.Int
	Data       []byte
	AccessList AccessList

	// Signature values
	V *big.Int `json:"v" gencodec:"required"`
	R *big.Int `json:"r" gencodec:"required"`
	S *big.Int `json:"s" gencodec:"required"`
}

DynamicFeeTx represents an EIP-1559 transaction.

type EIP155Signer added in v1.4.19 

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

EIP155Signer implements Signer using the EIP-155 rules. This accepts transactions which are replay-protected as well as unprotected homestead transactions.

func NewEIP155Signer added in v1.4.19 

func NewEIP155Signer(chainId *big.Int) EIP155Signer

func (EIP155Signer) ChainID added in v1.10.0 

func (s EIP155Signer) ChainID() *big.Int

func (EIP155Signer) Equal added in v1.5.0 

func (s EIP155Signer) Equal(s2 Signer) bool

func (EIP155Signer) Hash added in v1.4.19 

func (s EIP155Signer) Hash(tx *Transaction) common.Hash

Hash returns the hash to be signed by the sender. It does not uniquely identify the transaction.

func (EIP155Signer) Sender added in v1.7.1 

func (s EIP155Signer) Sender(tx *Transaction) (common.Address, error)

func (EIP155Signer) SignatureValues added in v1.7.1 

func (s EIP155Signer) SignatureValues(tx *Transaction, sig []byte) (R, S, V *big.Int, err error)

SignatureValues returns signature values. This signature needs to be in the [R || S || V] format where V is 0 or 1.

type FrontierSigner added in v1.4.19 

type FrontierSigner struct{}

FrontierSigner implements Signer interface using the frontier rules.

func (FrontierSigner) ChainID added in v1.10.0 

func (s FrontierSigner) ChainID() *big.Int

func (FrontierSigner) Equal added in v1.5.0 

func (s FrontierSigner) Equal(s2 Signer) bool

func (FrontierSigner) Hash added in v1.4.19 

func (fs FrontierSigner) Hash(tx *Transaction) common.Hash

Hash returns the hash to be signed by the sender. It does not uniquely identify the transaction.

func (FrontierSigner) Sender added in v1.7.1 

func (fs FrontierSigner) Sender(tx *Transaction) (common.Address, error)

func (FrontierSigner) SignatureValues added in v1.7.1 

func (fs FrontierSigner) SignatureValues(tx *Transaction, sig []byte) (r, s, v *big.Int, err error)

SignatureValues returns signature values. This signature needs to be in the [R || S || V] format where V is 0 or 1. 

type Header struct {
	ParentHash  common.Hash    `json:"parentHash"       gencodec:"required"`
	UncleHash   common.Hash    `json:"sha3Uncles"       gencodec:"required"`
	Coinbase    common.Address `json:"miner"`
	Root        common.Hash    `json:"stateRoot"        gencodec:"required"`
	TxHash      common.Hash    `json:"transactionsRoot" gencodec:"required"`
	ReceiptHash common.Hash    `json:"receiptsRoot"     gencodec:"required"`
	Bloom       Bloom          `json:"logsBloom"        gencodec:"required"`
	Difficulty  *big.Int       `json:"difficulty"       gencodec:"required"`
	Number      *big.Int       `json:"number"           gencodec:"required"`
	GasLimit    uint64         `json:"gasLimit"         gencodec:"required"`
	GasUsed     uint64         `json:"gasUsed"          gencodec:"required"`
	Time        uint64         `json:"timestamp"        gencodec:"required"`
	Extra       []byte         `json:"extraData"        gencodec:"required"`
	MixDigest   common.Hash    `json:"mixHash"`
	Nonce       BlockNonce     `json:"nonce"`

	// BaseFee was added by EIP-1559 and is ignored in legacy headers.
	BaseFee *big.Int `json:"baseFeePerGas" rlp:"optional"`

	// WithdrawalsHash was added by EIP-4895 and is ignored in legacy headers.
	WithdrawalsHash *common.Hash `json:"withdrawalsRoot" rlp:"optional"`

	// BlobGasUsed was added by EIP-4844 and is ignored in legacy headers.
	BlobGasUsed *uint64 `json:"blobGasUsed" rlp:"optional"`

	// ExcessBlobGas was added by EIP-4844 and is ignored in legacy headers.
	ExcessBlobGas *uint64 `json:"excessBlobGas" rlp:"optional"`

	// ParentBeaconRoot was added by EIP-4788 and is ignored in legacy headers.
	ParentBeaconRoot *common.Hash `json:"parentBeaconBlockRoot" rlp:"optional"`
}

Header represents a block header in the Ethereum blockchain.

func CopyHeader added in v1.3.1 

func CopyHeader(h *Header) *Header

CopyHeader creates a deep copy of a block header.

func (*Header) EmptyBody added in v1.9.18 

func (h *Header) EmptyBody() bool

EmptyBody returns true if there is no additional 'body' to complete the header that is: no transactions, no uncles and no withdrawals.

func (*Header) EmptyReceipts added in v1.9.18 

func (h *Header) EmptyReceipts() bool

EmptyReceipts returns true if there are no receipts for this header/block.

func (*Header) EncodeRLP added in v1.10.17 

func (obj *Header) EncodeRLP(_w io.Writer) error

func (*Header) Hash added in v0.8.4 

func (h *Header) Hash() common.Hash

Hash returns the block hash of the header, which is simply the keccak256 hash of its RLP encoding.

func (Header) MarshalJSON added in v1.5.0 

func (h Header) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Header) SanityCheck added in v1.9.0 

func (h *Header) SanityCheck() error

SanityCheck checks a few basic things -- these checks are way beyond what any 'sane' production values should hold, and can mainly be used to prevent that the unbounded fields are stuffed with junk data to add processing overhead

func (*Header) Size added in v1.8.0 

func (h *Header) Size() common.StorageSize

Size returns the approximate memory used by all internal contents. It is used to approximate and limit the memory consumption of various caches.

func (*Header) UnmarshalJSON added in v0.9.28 

func (h *Header) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type HomesteadSigner added in v1.4.19 

type HomesteadSigner struct{ FrontierSigner }

HomesteadSigner implements Signer interface using the homestead rules.

func (HomesteadSigner) ChainID added in v1.10.0 

func (s HomesteadSigner) ChainID() *big.Int

func (HomesteadSigner) Equal added in v1.5.0 

func (s HomesteadSigner) Equal(s2 Signer) bool

func (HomesteadSigner) Sender added in v1.7.1 

func (hs HomesteadSigner) Sender(tx *Transaction) (common.Address, error)

func (HomesteadSigner) SignatureValues added in v1.7.1 

func (hs HomesteadSigner) SignatureValues(tx *Transaction, sig []byte) (r, s, v *big.Int, err error)

SignatureValues returns signature values. This signature needs to be in the [R || S || V] format where V is 0 or 1.

type LegacyTx added in v1.10.0 

type LegacyTx struct {
	Nonce    uint64          // nonce of sender account
	GasPrice *big.Int        // wei per gas
	Gas      uint64          // gas limit
	To       *common.Address `rlp:"nil"` // nil means contract creation
	Value    *big.Int        // wei amount
	Data     []byte          // contract invocation input data
	V, R, S  *big.Int        // signature values
}

LegacyTx is the transaction data of the original Ethereum transactions.

type Log added in v1.5.6 

type Log struct {
	// Consensus fields:
	// address of the contract that generated the event
	Address common.Address `json:"address" gencodec:"required"`
	// list of topics provided by the contract.
	Topics []common.Hash `json:"topics" gencodec:"required"`
	// supplied by the contract, usually ABI-encoded
	Data []byte `json:"data" gencodec:"required"`

	// Derived fields. These fields are filled in by the node
	// but not secured by consensus.
	// block in which the transaction was included
	BlockNumber uint64 `json:"blockNumber" rlp:"-"`
	// hash of the transaction
	TxHash common.Hash `json:"transactionHash" gencodec:"required" rlp:"-"`
	// index of the transaction in the block
	TxIndex uint `json:"transactionIndex" rlp:"-"`
	// hash of the block in which the transaction was included
	BlockHash common.Hash `json:"blockHash" rlp:"-"`
	// index of the log in the block
	Index uint `json:"logIndex" rlp:"-"`

	// The Removed field is true if this log was reverted due to a chain reorganisation.
	// You must pay attention to this field if you receive logs through a filter query.
	Removed bool `json:"removed" rlp:"-"`
}

Log represents a contract log event. These events are generated by the LOG opcode and stored/indexed by the node.

func (*Log) EncodeRLP added in v1.5.6 

func (obj *Log) EncodeRLP(_w io.Writer) error

func (Log) MarshalJSON added in v1.5.6 

func (l Log) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Log) UnmarshalJSON added in v1.5.6 

func (l *Log) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type Receipt 

type Receipt struct {
	// Consensus fields: These fields are defined by the Yellow Paper
	Type              uint8  `json:"type,omitempty"`
	PostState         []byte `json:"root"`
	Status            uint64 `json:"status"`
	CumulativeGasUsed uint64 `json:"cumulativeGasUsed" gencodec:"required"`
	Bloom             Bloom  `json:"logsBloom"         gencodec:"required"`
	Logs              []*Log `json:"logs"              gencodec:"required"`

	// Implementation fields: These fields are added by geth when processing a transaction.
	TxHash            common.Hash    `json:"transactionHash" gencodec:"required"`
	ContractAddress   common.Address `json:"contractAddress"`
	GasUsed           uint64         `json:"gasUsed" gencodec:"required"`
	EffectiveGasPrice *big.Int       `json:"effectiveGasPrice"` // required, but tag omitted for backwards compatibility
	BlobGasUsed       uint64         `json:"blobGasUsed,omitempty"`
	BlobGasPrice      *big.Int       `json:"blobGasPrice,omitempty"`

	// Inclusion information: These fields provide information about the inclusion of the
	// transaction corresponding to this receipt.
	BlockHash        common.Hash `json:"blockHash,omitempty"`
	BlockNumber      *big.Int    `json:"blockNumber,omitempty"`
	TransactionIndex uint        `json:"transactionIndex"`
}

Receipt represents the results of a transaction.

func NewReceipt 

func NewReceipt(root []byte, failed bool, cumulativeGasUsed uint64) *Receipt

NewReceipt creates a barebone transaction receipt, copying the init fields. Deprecated: create receipts using a struct literal instead.

func (*Receipt) DecodeRLP added in v0.9.26 

func (r *Receipt) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder, and loads the consensus fields of a receipt from an RLP stream.

func (*Receipt) EncodeRLP added in v0.9.17 

func (r *Receipt) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder, and flattens the consensus fields of a receipt into an RLP stream. If no post state is present, byzantium fork is assumed.

func (*Receipt) MarshalBinary added in v1.10.10 

func (r *Receipt) MarshalBinary() ([]byte, error)

MarshalBinary returns the consensus encoding of the receipt.

func (Receipt) MarshalJSON added in v1.5.0 

func (r Receipt) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Receipt) Size added in v1.8.0 

func (r *Receipt) Size() common.StorageSize

Size returns the approximate memory used by all internal contents. It is used to approximate and limit the memory consumption of various caches.

func (*Receipt) UnmarshalBinary added in v1.10.10 

func (r *Receipt) UnmarshalBinary(b []byte) error

UnmarshalBinary decodes the consensus encoding of receipts. It supports legacy RLP receipts and EIP-2718 typed receipts.

func (*Receipt) UnmarshalJSON added in v1.5.0 

func (r *Receipt) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type ReceiptForStorage added in v0.9.26 

type ReceiptForStorage Receipt

ReceiptForStorage is a wrapper around a Receipt with RLP serialization that omits the Bloom field and deserialization that re-computes it.

func (*ReceiptForStorage) DecodeRLP added in v1.3.1 

func (r *ReceiptForStorage) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder, and loads both consensus and implementation fields of a receipt from an RLP stream.

func (*ReceiptForStorage) EncodeRLP added in v0.9.26 

func (r *ReceiptForStorage) EncodeRLP(_w io.Writer) error

EncodeRLP implements rlp.Encoder, and flattens all content fields of a receipt into an RLP stream.

type Receipts 

type Receipts []*Receipt

Receipts implements DerivableList for receipts.

func (Receipts) DeriveFields added in v1.9.0 

func (rs Receipts) DeriveFields(config *params.ChainConfig, hash common.Hash, number uint64, time uint64, baseFee *big.Int, blobGasPrice *big.Int, txs []*Transaction) error

DeriveFields fills the receipts with their computed fields based on consensus data and contextual infos like containing block and transactions.

func (Receipts) EncodeIndex added in v1.10.0 

func (rs Receipts) EncodeIndex(i int, w *bytes.Buffer)

EncodeIndex encodes the i'th receipt to w.

func (Receipts) Len 

func (rs Receipts) Len() int

Len returns the number of receipts in this list.

type Signer added in v1.4.19 

type Signer interface {
	// Sender returns the sender address of the transaction.
	Sender(tx *Transaction) (common.Address, error)

	// SignatureValues returns the raw R, S, V values corresponding to the
	// given signature.
	SignatureValues(tx *Transaction, sig []byte) (r, s, v *big.Int, err error)
	ChainID() *big.Int

	// Hash returns 'signature hash', i.e. the transaction hash that is signed by the
	// private key. This hash does not uniquely identify the transaction.
	Hash(tx *Transaction) common.Hash

	// Equal returns true if the given signer is the same as the receiver.
	Equal(Signer) bool
}

Signer encapsulates transaction signature handling. The name of this type is slightly misleading because Signers don't actually sign, they're just for validating and processing of signatures.

Note that this interface is not a stable API and may change at any time to accommodate new protocol rules.

func LatestSigner added in v1.10.0 

func LatestSigner(config *params.ChainConfig) Signer

LatestSigner returns the 'most permissive' Signer available for the given chain configuration. Specifically, this enables support of all types of transactions when their respective forks are scheduled to occur at any block number (or time) in the chain config.

Use this in transaction-handling code where the current block number is unknown. If you have the current block number available, use MakeSigner instead.

func LatestSignerForChainID added in v1.10.0 

func LatestSignerForChainID(chainID *big.Int) Signer

LatestSignerForChainID returns the 'most permissive' Signer available. Specifically, this enables support for EIP-155 replay protection and all implemented EIP-2718 transaction types if chainID is non-nil.

Use this in transaction-handling code where the current block number and fork configuration are unknown. If you have a ChainConfig, use LatestSigner instead. If you have a ChainConfig and know the current block number, use MakeSigner instead.

func MakeSigner added in v1.4.19 

func MakeSigner(config *params.ChainConfig, blockNumber *big.Int, blockTime uint64) Signer

MakeSigner returns a Signer based on the given chain config and block number.

func NewCancunSigner added in v1.12.0 

func NewCancunSigner(chainId *big.Int) Signer

NewCancunSigner returns a signer that accepts - EIP-4844 blob transactions - EIP-1559 dynamic fee transactions - EIP-2930 access list transactions, - EIP-155 replay protected transactions, and - legacy Homestead transactions.

func NewEIP2930Signer added in v1.10.0 

func NewEIP2930Signer(chainId *big.Int) Signer

NewEIP2930Signer returns a signer that accepts EIP-2930 access list transactions, EIP-155 replay protected transactions, and legacy Homestead transactions.

func NewLondonSigner added in v1.10.4 

func NewLondonSigner(chainId *big.Int) Signer

NewLondonSigner returns a signer that accepts - EIP-1559 dynamic fee transactions - EIP-2930 access list transactions, - EIP-155 replay protected transactions, and - legacy Homestead transactions.

type SlimAccount added in v1.12.1 

type SlimAccount struct {
	Nonce    uint64
	Balance  *big.Int
	Root     []byte // Nil if root equals to types.EmptyRootHash
	CodeHash []byte // Nil if hash equals to types.EmptyCodeHash
}

SlimAccount is a modified version of an Account, where the root is replaced with a byte slice. This format can be used to represent full-consensus format or slim format which replaces the empty root and code hash as nil byte slice.

type StateAccount added in v1.10.9 

type StateAccount struct {
	Nonce    uint64
	Balance  *big.Int
	Root     common.Hash // merkle root of the storage trie
	CodeHash []byte
}

StateAccount is the Ethereum consensus representation of accounts. These objects are stored in the main account trie.

func FullAccount added in v1.12.1 

func FullAccount(data []byte) (*StateAccount, error)

FullAccount decodes the data on the 'slim RLP' format and returns the consensus format account.

func NewEmptyStateAccount added in v1.12.1 

func NewEmptyStateAccount() *StateAccount

NewEmptyStateAccount constructs an empty state account.

func (*StateAccount) Copy added in v1.12.1 

func (acct *StateAccount) Copy() *StateAccount

Copy returns a deep-copied state account object.

func (*StateAccount) EncodeRLP added in v1.10.17 

func (obj *StateAccount) EncodeRLP(_w io.Writer) error

type Transaction 

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

Transaction is an Ethereum transaction.

func MustSignNewTx added in v1.10.0 

func MustSignNewTx(prv *ecdsa.PrivateKey, s Signer, txdata TxData) *Transaction

MustSignNewTx creates a transaction and signs it. This panics if the transaction cannot be signed.

func NewContractCreation added in v0.9.34 

func NewContractCreation(nonce uint64, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte) *Transaction

NewContractCreation creates an unsigned legacy transaction. Deprecated: use NewTx instead.

func NewTransaction added in v0.9.34 

func NewTransaction(nonce uint64, to common.Address, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte) *Transaction

NewTransaction creates an unsigned legacy transaction. Deprecated: use NewTx instead.

func NewTx added in v1.10.0 

func NewTx(inner TxData) *Transaction

NewTx creates a new transaction.

func SignNewTx added in v1.10.0 

func SignNewTx(prv *ecdsa.PrivateKey, s Signer, txdata TxData) (*Transaction, error)

SignNewTx creates a transaction and signs it.

func SignTx added in v1.5.6 

func SignTx(tx *Transaction, s Signer, prv *ecdsa.PrivateKey) (*Transaction, error)

SignTx signs the transaction using the given signer and private key.

func (*Transaction) AccessList added in v1.10.0 

func (tx *Transaction) AccessList() AccessList

AccessList returns the access list of the transaction.

func (*Transaction) BlobGas added in v1.12.0 

func (tx *Transaction) BlobGas() uint64

BlobGas returns the blob gas limit of the transaction for blob transactions, 0 otherwise.

func (*Transaction) BlobGasFeeCap added in v1.12.0 

func (tx *Transaction) BlobGasFeeCap() *big.Int

BlobGasFeeCap returns the blob gas fee cap per blob gas of the transaction for blob transactions, nil otherwise.

func (*Transaction) BlobGasFeeCapCmp added in v1.12.0 

func (tx *Transaction) BlobGasFeeCapCmp(other *Transaction) int

BlobGasFeeCapCmp compares the blob fee cap of two transactions.

func (*Transaction) BlobGasFeeCapIntCmp added in v1.12.0 

func (tx *Transaction) BlobGasFeeCapIntCmp(other *big.Int) int

BlobGasFeeCapIntCmp compares the blob fee cap of the transaction against the given blob fee cap.

func (*Transaction) BlobHashes added in v1.12.0 

func (tx *Transaction) BlobHashes() []common.Hash

BlobHashes returns the hashes of the blob commitments for blob transactions, nil otherwise.

func (*Transaction) BlobTxSidecar added in v1.13.0 

func (tx *Transaction) BlobTxSidecar() *BlobTxSidecar

BlobTxSidecar returns the sidecar of a blob transaction, nil otherwise.

func (*Transaction) ChainId added in v1.4.19 

func (tx *Transaction) ChainId() *big.Int

ChainId returns the EIP155 chain ID of the transaction. The return value will always be non-nil. For legacy transactions which are not replay-protected, the return value is zero.

func (*Transaction) Cost added in v0.9.34 

func (tx *Transaction) Cost() *big.Int

Cost returns (gas * gasPrice) + (blobGas * blobGasPrice) + value.

func (*Transaction) Data 

func (tx *Transaction) Data() []byte

Data returns the input data of the transaction.

func (*Transaction) DecodeRLP added in v0.9.34 

func (tx *Transaction) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder

func (*Transaction) EffectiveGasTip added in v1.10.4 

func (tx *Transaction) EffectiveGasTip(baseFee *big.Int) (*big.Int, error)

EffectiveGasTip returns the effective miner gasTipCap for the given base fee. Note: if the effective gasTipCap is negative, this method returns both error the actual negative value, _and_ ErrGasFeeCapTooLow

func (*Transaction) EffectiveGasTipCmp added in v1.10.4 

func (tx *Transaction) EffectiveGasTipCmp(other *Transaction, baseFee *big.Int) int

EffectiveGasTipCmp compares the effective gasTipCap of two transactions assuming the given base fee.

func (*Transaction) EffectiveGasTipIntCmp added in v1.10.4 

func (tx *Transaction) EffectiveGasTipIntCmp(other *big.Int, baseFee *big.Int) int

EffectiveGasTipIntCmp compares the effective gasTipCap of a transaction to the given gasTipCap.

func (*Transaction) EffectiveGasTipValue added in v1.10.4 

func (tx *Transaction) EffectiveGasTipValue(baseFee *big.Int) *big.Int

EffectiveGasTipValue is identical to EffectiveGasTip, but does not return an error in case the effective gasTipCap is negative

func (*Transaction) EncodeRLP added in v0.9.34 

func (tx *Transaction) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder

func (*Transaction) Gas 

func (tx *Transaction) Gas() uint64

Gas returns the gas limit of the transaction.

func (*Transaction) GasFeeCap added in v1.10.4 

func (tx *Transaction) GasFeeCap() *big.Int

GasFeeCap returns the fee cap per gas of the transaction.

func (*Transaction) GasFeeCapCmp added in v1.10.4 

func (tx *Transaction) GasFeeCapCmp(other *Transaction) int

GasFeeCapCmp compares the fee cap of two transactions.

func (*Transaction) GasFeeCapIntCmp added in v1.10.4 

func (tx *Transaction) GasFeeCapIntCmp(other *big.Int) int

GasFeeCapIntCmp compares the fee cap of the transaction against the given fee cap.

func (*Transaction) GasPrice 

func (tx *Transaction) GasPrice() *big.Int

GasPrice returns the gas price of the transaction.

func (*Transaction) GasTipCap added in v1.10.4 

func (tx *Transaction) GasTipCap() *big.Int

GasTipCap returns the gasTipCap per gas of the transaction.

func (*Transaction) GasTipCapCmp added in v1.10.4 

func (tx *Transaction) GasTipCapCmp(other *Transaction) int

GasTipCapCmp compares the gasTipCap of two transactions.

func (*Transaction) GasTipCapIntCmp added in v1.10.4 

func (tx *Transaction) GasTipCapIntCmp(other *big.Int) int

GasTipCapIntCmp compares the gasTipCap of the transaction against the given gasTipCap.

func (*Transaction) Hash 

func (tx *Transaction) Hash() common.Hash

Hash returns the transaction hash.

func (*Transaction) MarshalBinary added in v1.10.0 

func (tx *Transaction) MarshalBinary() ([]byte, error)

MarshalBinary returns the canonical encoding of the transaction. For legacy transactions, it returns the RLP encoding. For EIP-2718 typed transactions, it returns the type and payload.

func (*Transaction) MarshalJSON added in v1.5.0 

func (tx *Transaction) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON with a hash.

func (*Transaction) Nonce 

func (tx *Transaction) Nonce() uint64

Nonce returns the sender account nonce of the transaction.

func (*Transaction) Protected added in v1.4.19 

func (tx *Transaction) Protected() bool

Protected says whether the transaction is replay-protected.

func (*Transaction) RawSignatureValues added in v1.4.19 

func (tx *Transaction) RawSignatureValues() (v, r, s *big.Int)

RawSignatureValues returns the V, R, S signature values of the transaction. The return values should not be modified by the caller.

func (*Transaction) SetTime added in v1.12.1 

func (tx *Transaction) SetTime(t time.Time)

SetTime sets the decoding time of a transaction. This is used by tests to set arbitrary times and by persistent transaction pools when loading old txs from disk.

func (*Transaction) Size added in v0.9.28 

func (tx *Transaction) Size() uint64

Size returns the true encoded storage size of the transaction, either by encoding and returning it, or returning a previously cached value.

func (*Transaction) Time added in v1.12.1 

func (tx *Transaction) Time() time.Time

Time returns the time when the transaction was first seen on the network. It is a heuristic to prefer mining older txs vs new all other things equal.

func (*Transaction) To 

func (tx *Transaction) To() *common.Address

To returns the recipient address of the transaction. For contract-creation transactions, To returns nil.

func (*Transaction) Type added in v1.10.0 

func (tx *Transaction) Type() uint8

Type returns the transaction type.

func (*Transaction) UnmarshalBinary added in v1.10.0 

func (tx *Transaction) UnmarshalBinary(b []byte) error

UnmarshalBinary decodes the canonical encoding of transactions. It supports legacy RLP transactions and EIP-2718 typed transactions.

func (*Transaction) UnmarshalJSON added in v1.5.0 

func (tx *Transaction) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

func (*Transaction) Value 

func (tx *Transaction) Value() *big.Int

Value returns the ether amount of the transaction.

func (*Transaction) WithSignature added in v0.9.34 

func (tx *Transaction) WithSignature(signer Signer, sig []byte) (*Transaction, error)

WithSignature returns a new transaction with the given signature. This signature needs to be in the [R || S || V] format where V is 0 or 1.

func (*Transaction) WithoutBlobTxSidecar added in v1.13.0 

func (tx *Transaction) WithoutBlobTxSidecar() *Transaction

WithoutBlobTxSidecar returns a copy of tx with the blob sidecar removed.

type Transactions 

type Transactions []*Transaction

Transactions implements DerivableList for transactions.

func TxDifference added in v1.2.2 

func TxDifference(a, b Transactions) Transactions

TxDifference returns a new set which is the difference between a and b.

func (Transactions) EncodeIndex added in v1.10.0 

func (s Transactions) EncodeIndex(i int, w *bytes.Buffer)

EncodeIndex encodes the i'th transaction to w. Note that this does not check for errors because we assume that *Transaction will only ever contain valid txs that were either constructed by decoding or via public API in this package.

func (Transactions) Len 

func (s Transactions) Len() int

Len returns the length of s.

type TrieHasher added in v1.10.0 

type TrieHasher interface {
	Reset()
	Update([]byte, []byte) error
	Hash() common.Hash
}

TrieHasher is the tool used to calculate the hash of derivable list. This is internal, do not use.

type TxByNonce 

type TxByNonce Transactions

TxByNonce implements the sort interface to allow sorting a list of transactions by their nonces. This is usually only useful for sorting transactions from a single account, otherwise a nonce comparison doesn't make much sense.

func (TxByNonce) Len added in v1.3.4 

func (s TxByNonce) Len() int

func (TxByNonce) Less 

func (s TxByNonce) Less(i, j int) bool

func (TxByNonce) Swap added in v1.3.4 

func (s TxByNonce) Swap(i, j int)

type TxData added in v1.10.0 

type TxData interface {
	// contains filtered or unexported methods
}

TxData is the underlying data of a transaction.

This is implemented by DynamicFeeTx, LegacyTx and AccessListTx.

type Withdrawal added in v1.11.0 

type Withdrawal struct {
	Index     uint64         `json:"index"`          // monotonically increasing identifier issued by consensus layer
	Validator uint64         `json:"validatorIndex"` // index of validator associated with withdrawal
	Address   common.Address `json:"address"`        // target address for withdrawn ether
	Amount    uint64         `json:"amount"`         // value of withdrawal in Gwei
}

Withdrawal represents a validator withdrawal from the consensus layer.

func (*Withdrawal) EncodeRLP added in v1.11.0 

func (obj *Withdrawal) EncodeRLP(_w io.Writer) error

func (Withdrawal) MarshalJSON added in v1.11.0 

func (w Withdrawal) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Withdrawal) UnmarshalJSON added in v1.11.0 

func (w *Withdrawal) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type Withdrawals added in v1.11.0 

type Withdrawals []*Withdrawal

Withdrawals implements DerivableList for withdrawals.

func (Withdrawals) EncodeIndex added in v1.11.0 

func (s Withdrawals) EncodeIndex(i int, w *bytes.Buffer)

EncodeIndex encodes the i'th withdrawal to w. Note that this does not check for errors because we assume that *Withdrawal will only ever contain valid withdrawals that were either constructed by decoding or via public API in this package.

func (Withdrawals) Len added in v1.11.0 

func (s Withdrawals) Len() int

Len returns the length of s.

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.