types

package
v1.0.4 Latest Latest
Warning

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

 Go to latest Published: Sep 26, 2025 License: GPL-3.0 Imports: 30 Imported by: 0

Documentation

Overview

Package types contains data types related to Ethereum consensus.

Index

Constants

View Source 
const (
	InvalidBidParamError = -38001
	InvalidPayBidTxError = -38002
	MevNotRunningError   = -38003
	MevBusyError         = -38004
	MevNotInTurnError    = -38005
)
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
	SetCodeTxType    = 0x04
)

Transaction types.

View Source 
const (
	BLSPublicKeyLength = 48
	BLSSignatureLength = 96

	MaxAttestationExtraLength = 256
)
View Source 
const TxDecodeConcurrencyForPerBid = 5

Variables

View Source 
var (
	ErrMevNotRunning = newBidError(errors.New("the validator stop accepting bids for now, try again later"), MevNotRunningError)
	ErrMevBusy       = newBidError(errors.New("the validator is working on too many bids, try again later"), MevBusyError)
	ErrMevNotInTurn  = newBidError(errors.New("the validator is not in-turn to propose currently, try again later"), MevNotInTurnError)
)
View Source 
var (
	// StatusVerified means the processing of request going as expected and found the root correctly.
	StatusVerified          = VerifyStatus{Code: 0x100}
	StatusFullVerified      = VerifyStatus{Code: 0x101, Msg: "state root full verified"}
	StatusPartiallyVerified = VerifyStatus{Code: 0x102, Msg: "state root partially verified, because of difflayer not found"}

	// StatusFailed means the request has something wrong.
	StatusFailed           = VerifyStatus{Code: 0x200}
	StatusDiffHashMismatch = VerifyStatus{Code: 0x201, Msg: "verify failed because of blockhash mismatch with diffhash"}
	StatusImpossibleFork   = VerifyStatus{Code: 0x202, Msg: "verify failed because of impossible fork detected"}

	// StatusUncertain means verify node can't give a certain result of the request.
	StatusUncertain    = VerifyStatus{Code: 0x300}
	StatusBlockTooNew  = VerifyStatus{Code: 0x301, Msg: "can’t verify because of block number larger than current height more than 11"}
	StatusBlockNewer   = VerifyStatus{Code: 0x302, Msg: "can’t verify because of block number larger than current height"}
	StatusPossibleFork = VerifyStatus{Code: 0x303, Msg: "can’t verify because of possible fork detected"}

	// StatusUnexpectedError is unexpected internal error.
	StatusUnexpectedError = VerifyStatus{Code: 0x400, Msg: "can’t verify because of unexpected internal error"}
)
View Source 
var (
	// EmptyRootHash is the known root hash of an empty merkle 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")

	// EmptyRequestsHash is the known hash of an empty request set, sha256("").
	EmptyRequestsHash = common.HexToHash("e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855")

	// EmptyVerkleHash is the known hash of an empty verkle trie.
	EmptyVerkleHash = common.Hash{}
)
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 DelegationPrefix = []byte{0xef, 0x01, 0x00}

DelegationPrefix is used by code to denote the account is delegating to another account.

View Source 
var EmptyBloom = Bloom{}
View Source 
var ErrInvalidChainId = errors.New("invalid chain id for signer")
View Source 
var NanoBlackList = []common.Address{
	common.HexToAddress("0x489A8756C18C0b8B24EC2a2b9FF3D4d447F79BEc"),
	common.HexToAddress("0xFd6042Df3D74ce9959922FeC559d7995F3933c55"),

	common.HexToAddress("0xdb789Eb5BDb4E559beD199B8b82dED94e1d056C9"),
}

This is introduced because of the Tendermint IAVL Merkle Proof verification exploitation.

Functions

func AddressToDelegation added in v1.0.4 

func AddressToDelegation(addr common.Address) []byte

AddressToDelegation adds the delegation prefix to the specified address.

func Bloom9 

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 CalcRequestsHash added in v1.0.4 

func CalcRequestsHash(requests [][]byte) common.Hash

CalcRequestsHash creates the block requestsHash value for a list of requests.

func CalcUncleHash 

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

func DepositLogToRequest added in v1.0.4 

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

DepositLogToRequest unpacks a serialized DepositEvent.

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 EncodeSigHeader added in v1.0.4 

func EncodeSigHeader(w io.Writer, header *Header, chainId *big.Int)

func FullAccountRLP added in v1.0.4 

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

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

func HashDifference added in v1.0.3 

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

HashDifference returns a new set of hashes that are present in a but not in b.

func HeaderParentHashFromRLP added in v1.0.4 

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 NewInvalidBidError added in v1.0.4 

func NewInvalidBidError(message string) *bidError

func NewInvalidPayBidTxError added in v1.0.4 

func NewInvalidPayBidTxError(message string) *bidError

func ParseDelegation added in v1.0.4 

func ParseDelegation(b []byte) (common.Address, bool)

ParseDelegation tries to parse the address from a delegation slice.

func SealHash added in v1.0.4 

func SealHash(header *Header, chainId *big.Int) (hash common.Hash)

SealHash returns the hash of a block prior to it being sealed.

func Sender 

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.0.4 

func SlimAccountRLP(account StateAccount) []byte

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

Types

type AccessList 

type AccessList []AccessTuple

AccessList is an EIP-2930 access list.

func (AccessList) StorageKeys 

func (al AccessList) StorageKeys() int

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

type AccessListTx 

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 

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 

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

MarshalJSON marshals as JSON.

func (*AccessTuple) UnmarshalJSON 

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

UnmarshalJSON unmarshals from JSON.

type Account added in v1.0.4 

type Account struct {
	Code        []byte                      `json:"code,omitempty"`
	Storage     map[common.Hash]common.Hash `json:"storage,omitempty"`
	Balance     *big.Int                    `json:"balance" gencodec:"required"`
	LockBalance *big.Int                    `json:"lock_balance,omitempty"`
	Nonce       uint64                      `json:"nonce,omitempty"`

	// used in tests
	PrivateKey []byte `json:"secretKey,omitempty"`
}

Account represents an Ethereum account and its attached data. This type is used to specify accounts in the genesis block state, and is also useful for JSON encoding/decoding of accounts.

func (Account) MarshalJSON added in v1.0.4 

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

MarshalJSON marshals as JSON.

func (*Account) UnmarshalJSON added in v1.0.4 

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

UnmarshalJSON unmarshals from JSON.

type AccountStorage added in v1.0.4 

type AccountStorage struct {
	StorageRoot  *common.Hash
	StorageSlots map[common.Hash]common.Hash
}

func (AccountStorage) MarshalJSON added in v1.0.4 

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

func (*AccountStorage) UnmarshalJSON added in v1.0.4 

func (a *AccountStorage) UnmarshalJSON(data []byte) error

type BLSPublicKey added in v1.0.4 

type BLSPublicKey [BLSPublicKeyLength]byte

func (BLSPublicKey) Bytes added in v1.0.4 

func (b BLSPublicKey) Bytes() []byte

type BLSSignature added in v1.0.4 

type BLSSignature [BLSSignatureLength]byte

type Bid added in v1.0.4 

type Bid struct {
	Builder      common.Address
	BlockNumber  uint64
	ParentHash   common.Hash
	Txs          Transactions
	UnRevertible mapset.Set[common.Hash]
	GasUsed      uint64
	GasFee       *big.Int
	BuilderFee   *big.Int
	// contains filtered or unexported fields
}

Bid represents a bid.

func (*Bid) Commit added in v1.0.4 

func (b *Bid) Commit()

func (*Bid) Hash added in v1.0.4 

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

Hash returns the bid hash.

func (*Bid) IsCommitted added in v1.0.4 

func (b *Bid) IsCommitted() bool

type BidArgs added in v1.0.4 

type BidArgs struct {
	// RawBid from builder directly
	RawBid *RawBid
	// Signature of the bid from builder
	Signature hexutil.Bytes `json:"signature"`

	// PayBidTx is a payment tx to builder from sentry, which is optional
	PayBidTx        hexutil.Bytes `json:"payBidTx"`
	PayBidTxGasUsed uint64        `json:"payBidTxGasUsed"`
}

BidArgs represents the arguments to submit a bid.

func (*BidArgs) EcrecoverSender added in v1.0.4 

func (b *BidArgs) EcrecoverSender() (common.Address, error)

func (*BidArgs) ToBid added in v1.0.4 

func (b *BidArgs) ToBid(builder common.Address, signer Signer) (*Bid, error)

type BidIssue added in v1.0.4 

type BidIssue struct {
	Validator common.Address
	Builder   common.Address
	BidHash   common.Hash
	Message   string
}

BidIssue represents a bid issue.

type BigInt added in v1.0.4 

type BigInt interface {
	SetBytes(buf []byte) *big.Int
	SetUint64(x uint64) *big.Int
}

type BlobSidecar added in v1.0.4 

type BlobSidecar struct {
	BlobTxSidecar
	BlockNumber *big.Int    `json:"blockNumber"`
	BlockHash   common.Hash `json:"blockHash"`
	TxIndex     uint64      `json:"transactionIndex"`
	TxHash      common.Hash `json:"transactionHash"`
}

func NewBlobSidecarFromTx added in v1.0.4 

func NewBlobSidecarFromTx(tx *Transaction) *BlobSidecar

func (*BlobSidecar) MarshalJSON added in v1.0.4 

func (s *BlobSidecar) MarshalJSON() ([]byte, error)

func (*BlobSidecar) SanityCheck added in v1.0.4 

func (s *BlobSidecar) SanityCheck(blockNumber *big.Int, blockHash common.Hash) error

func (*BlobSidecar) UnmarshalJSON added in v1.0.4 

func (s *BlobSidecar) UnmarshalJSON(input []byte) error

type BlobSidecars added in v1.0.4 

type BlobSidecars []*BlobSidecar

func (BlobSidecars) BlobTxSidecarList added in v1.0.4 

func (s BlobSidecars) BlobTxSidecarList() []*BlobTxSidecar

func (BlobSidecars) EncodeIndex added in v1.0.4 

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

EncodeIndex encodes the i'th BlobTxSidecar to w. Note that this does not check for errors because we assume that BlobSidecars will only ever contain valid sidecars

func (BlobSidecars) Len added in v1.0.4 

func (s BlobSidecars) Len() int

Len returns the length of s.

type BlobTx added in v1.0.4 

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 signing.
	Sidecar *BlobTxSidecar `rlp:"-"`

	// Signature values
	V *uint256.Int
	R *uint256.Int
	S *uint256.Int
}

BlobTx represents an EIP-4844 transaction.

type BlobTxSidecar added in v1.0.4 

type BlobTxSidecar struct {
	Blobs       []kzg4844.Blob       `json:"blobs"`       // Blobs needed by the blob pool
	Commitments []kzg4844.Commitment `json:"commitments"` // Commitments needed by the blob pool
	Proofs      []kzg4844.Proof      `json:"proofs"`      // Proofs needed by the blob pool
}

BlobTxSidecar contains the blobs of a blob transaction.

func (*BlobTxSidecar) BlobHashes added in v1.0.4 

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 

func NewBlock(header *Header, body *Body, 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 body elements and the receipts are used to recompute and overwrite the relevant portions of the header.

func NewBlockWithHeader 

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 (*Block) BaseFee added in v1.0.4 

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

func (*Block) BeaconRoot added in v1.0.4 

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

func (*Block) BlobGasUsed added in v1.0.4 

func (b *Block) BlobGasUsed() *uint64

func (*Block) Bloom 

func (b *Block) Bloom() Bloom

func (*Block) Body 

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) CleanSidecars added in v1.0.4 

func (b *Block) CleanSidecars()

func (*Block) Coinbase 

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

func (*Block) DecodeRLP 

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 

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

EncodeRLP serializes a block as RLP.

func (*Block) ExcessBlobGas added in v1.0.4 

func (b *Block) ExcessBlobGas() *uint64

func (*Block) ExecutionWitness added in v1.0.4 

func (b *Block) ExecutionWitness() *ExecutionWitness

ExecutionWitness returns the verkle execution witneess + proof for a block

func (*Block) Extra 

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

func (*Block) ExtraNonce 

func (b *Block) ExtraNonce() uint64

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 

func (b *Block) Header() *Header

Header returns the block header (as a copy).

func (*Block) MixDigest 

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 

func (b *Block) NumberU64() uint64

func (*Block) ParentHash 

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

func (*Block) Provider 

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

func (*Block) ReceiptHash 

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

func (*Block) RequestsHash added in v1.0.4 

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

func (*Block) Root 

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

func (*Block) SanityCheck 

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) SetRoot 

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

func (*Block) Sidecars added in v1.0.4 

func (b *Block) Sidecars() BlobSidecars

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) TeamAddress 

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

func (*Block) TeamRate 

func (b *Block) TeamRate() uint64

func (*Block) Time 

func (b *Block) Time() uint64

func (*Block) Transaction 

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

func (*Block) Transactions 

func (b *Block) Transactions() Transactions

func (*Block) TxHash 

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

func (*Block) UncleHash 

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

func (*Block) Uncles 

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

func (*Block) ValidatorRate 

func (b *Block) ValidatorRate() uint64

func (*Block) WithBody 

func (b *Block) WithBody(body Body) *Block

WithBody returns a new block with the original header and a deep copy of the provided body.

func (*Block) WithSeal 

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) WithSidecars added in v1.0.4 

func (b *Block) WithSidecars(sidecars BlobSidecars) *Block

WithSidecars returns a block containing the given blobs.

func (*Block) WithWithdrawals added in v1.0.4 

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

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

func (*Block) WithWitness added in v1.0.4 

func (b *Block) WithWitness(witness *ExecutionWitness) *Block

func (*Block) Withdrawals added in v1.0.4 

func (b *Block) Withdrawals() Withdrawals

type BlockNonce 

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 

func EncodeNonce(i uint64) BlockNonce

EncodeNonce converts the given integer to a block nonce.

func (BlockNonce) MarshalText 

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

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

func (BlockNonce) Uint64 

func (n BlockNonce) Uint64() uint64

Uint64 returns the integer value of a block nonce.

func (*BlockNonce) UnmarshalText 

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

UnmarshalText implements encoding.TextUnmarshaler.

type Blocks 

type Blocks []*Block

type Bloom 

type Bloom [BloomByteLength]byte

Bloom represents a 2048 bit bloom filter.

func BytesToBloom 

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 

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

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

func (Bloom) Big 

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 

func (b Bloom) Bytes() []byte

Bytes returns the backing byte slice of the bloom

func (Bloom) MarshalText 

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

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

func (*Bloom) SetBytes 

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 

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

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

func (*Bloom) UnmarshalText 

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

UnmarshalText b as a hex string with 0x prefix.

type Body 

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 DiffAccount added in v1.0.4 

type DiffAccount struct {
	Account common.Hash
	Blob    []byte
}

type DiffAccountsInBlock added in v1.0.4 

type DiffAccountsInBlock struct {
	Number       uint64
	BlockHash    common.Hash
	Transactions []DiffAccountsInTx
}

type DiffAccountsInTx added in v1.0.4 

type DiffAccountsInTx struct {
	TxHash   common.Hash
	Accounts map[common.Address]*big.Int
}

type DiffCode added in v1.0.4 

type DiffCode struct {
	Hash common.Hash
	Code []byte
}

type DiffLayer added in v1.0.4 

type DiffLayer struct {
	BlockHash common.Hash
	Number    uint64
	Receipts  Receipts // Receipts are duplicated stored to simplify the logic
	Codes     []DiffCode
	Destructs []common.Address
	Accounts  []DiffAccount
	Storages  []DiffStorage

	DiffHash atomic.Value
}

func (*DiffLayer) DecodeRLP added in v1.0.4 

func (d *DiffLayer) DecodeRLP(s *rlp.Stream) error

DecodeRLP decodes the Ethereum

func (*DiffLayer) EncodeRLP added in v1.0.4 

func (d *DiffLayer) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Ethereum RLP block format.

type DiffStorage added in v1.0.4 

type DiffStorage struct {
	Account common.Hash
	Keys    []common.Hash // Keys are hashed ones
	Vals    [][]byte
}

func (*DiffStorage) Len added in v1.0.4 

func (storage *DiffStorage) Len() int

func (*DiffStorage) Less added in v1.0.4 

func (storage *DiffStorage) Less(i, j int) bool

func (*DiffStorage) Swap added in v1.0.4 

func (storage *DiffStorage) Swap(i, j int)

type DynamicFeeTx added in v1.0.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
	R *big.Int
	S *big.Int
}

DynamicFeeTx represents an EIP-1559 transaction.

type EIP155Signer 

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 

func NewEIP155Signer(chainId *big.Int) EIP155Signer

func (EIP155Signer) ChainID 

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

func (EIP155Signer) Equal 

func (s EIP155Signer) Equal(s2 Signer) bool

func (EIP155Signer) Hash 

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 

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

func (EIP155Signer) SignatureValues 

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 ExecutionWitness added in v1.0.4 

type ExecutionWitness struct {
	StateDiff   verkle.StateDiff    `json:"stateDiff"`
	VerkleProof *verkle.VerkleProof `json:"verkleProof"`
}

ExecutionWitness represents the witness + proof used in a verkle context, to provide the ability to execute a block statelessly.

type ExtDiffLayer added in v1.0.4 

type ExtDiffLayer struct {
	BlockHash common.Hash
	Number    uint64
	Receipts  []*ReceiptForStorage // Receipts are duplicated stored to simplify the logic
	Codes     []DiffCode
	Destructs []common.Address
	Accounts  []DiffAccount
	Storages  []DiffStorage
}

type FrontierSigner 

type FrontierSigner struct{}

FrontierSigner implements Signer interface using the frontier rules.

func (FrontierSigner) ChainID 

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

func (FrontierSigner) Equal 

func (fs FrontierSigner) Equal(s2 Signer) bool

func (FrontierSigner) Hash 

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 

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

func (FrontierSigner) SignatureValues 

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 GenesisAlloc added in v1.0.4 

type GenesisAlloc map[common.Address]Account

GenesisAlloc specifies the initial state of a genesis block.

func (*GenesisAlloc) UnmarshalJSON added in v1.0.4 

func (ga *GenesisAlloc) UnmarshalJSON(data []byte) error
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"`
	Provider      common.Address `json:"provider"         gencodec:"required"`
	TeamAddress   common.Address `json:"team_address"     gencodec:"required"`
	ValidatorRate uint64         `json:"validator_rate"     gencodec:"required"`
	TeamRate      uint64         `json:"team_rate"          gencodec:"required"`

	Nonce      BlockNonce `json:"nonce"`
	ExtraNonce BlockNonce `json:"extra_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"`

	// RequestsHash was added by EIP-7685 and is ignored in legacy headers.
	RequestsHash *common.Hash `json:"requestsHash" rlp:"optional"`
}

Header represents a block header in the Ethereum blockchain.

func CopyHeader 

func CopyHeader(h *Header) *Header

CopyHeader creates a deep copy of a block header.

func (*Header) EmptyBody 

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 

func (h *Header) EmptyReceipts() bool

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

func (*Header) EmptyWithdrawalsHash added in v1.0.4 

func (h *Header) EmptyWithdrawalsHash() bool

EmptyWithdrawalsHash returns true if the WithdrawalsHash is EmptyWithdrawalsHash.

func (*Header) EncodeRLP added in v1.0.4 

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

func (*Header) Hash 

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 

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

MarshalJSON marshals as JSON.

func (*Header) MilliTimestamp added in v1.0.4 

func (h *Header) MilliTimestamp() uint64

Ensure Milliseconds is less than 1000 when verifying the block header

func (*Header) SanityCheck 

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) SetMilliseconds added in v1.0.4 

func (h *Header) SetMilliseconds(milliseconds uint64)

SetMilliseconds can be called once millisecond representation supported

func (*Header) Size 

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 

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

UnmarshalJSON unmarshals from JSON.

type HomesteadSigner 

type HomesteadSigner struct{ FrontierSigner }

HomesteadSigner implements Signer interface using the homestead rules.

func (HomesteadSigner) ChainID 

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

func (HomesteadSigner) Equal 

func (hs HomesteadSigner) Equal(s2 Signer) bool

func (HomesteadSigner) Sender 

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

func (HomesteadSigner) SignatureValues 

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 KnownAccounts added in v1.0.4 

type KnownAccounts map[common.Address]AccountStorage

type LegacyTx 

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 

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 

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

func (Log) MarshalJSON 

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

MarshalJSON marshals as JSON.

func (*Log) UnmarshalJSON 

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

UnmarshalJSON unmarshals from JSON.

type MevParams added in v1.0.4 

type MevParams struct {
	ValidatorCommission   uint64 // 100 means 1%
	BidSimulationLeftOver time.Duration
	NoInterruptLeftOver   time.Duration
	MaxBidsPerBuilder     uint32 // Maximum number of bids allowed per builder per block
	GasCeil               uint64
	GasPrice              *big.Int // Minimum avg gas price for bid block
	BuilderFeeCeil        *big.Int
	Version               string
}

type OriginalDataAndReceipt 

type OriginalDataAndReceipt struct {
	Receipt Receipt     `json:"receipt"`
	TxData  Transaction `json:"txData"`
}

Receipt represents the results of a transaction.

type RawBid added in v1.0.4 

type RawBid struct {
	BlockNumber  uint64          `json:"blockNumber"`
	ParentHash   common.Hash     `json:"parentHash"`
	Txs          []hexutil.Bytes `json:"txs"`
	UnRevertible []common.Hash   `json:"unRevertible"`
	GasUsed      uint64          `json:"gasUsed"`
	GasFee       *big.Int        `json:"gasFee"`
	BuilderFee   *big.Int        `json:"builderFee"`
	// contains filtered or unexported fields
}

RawBid represents a raw bid from builder directly.

func (*RawBid) DecodeTxs added in v1.0.4 

func (b *RawBid) DecodeTxs(signer Signer) ([]*Transaction, error)

func (*RawBid) Hash added in v1.0.4 

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

Hash returns the hash of the bid.

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 

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 

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.0.4 

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

MarshalBinary returns the consensus encoding of the receipt.

func (Receipt) MarshalJSON 

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

MarshalJSON marshals as JSON.

func (*Receipt) Size 

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.0.4 

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 

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

UnmarshalJSON unmarshals from JSON.

type ReceiptForStorage 

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 

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 

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 

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 

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 SetCodeAuthorization added in v1.0.4 

type SetCodeAuthorization struct {
	ChainID uint256.Int    `json:"chainId" gencodec:"required"`
	Address common.Address `json:"address" gencodec:"required"`
	Nonce   uint64         `json:"nonce" gencodec:"required"`
	V       uint8          `json:"yParity" gencodec:"required"`
	R       uint256.Int    `json:"r" gencodec:"required"`
	S       uint256.Int    `json:"s" gencodec:"required"`
}

SetCodeAuthorization is an authorization from an account to deploy code at its address.

func SignSetCode added in v1.0.4 

func SignSetCode(prv *ecdsa.PrivateKey, auth SetCodeAuthorization) (SetCodeAuthorization, error)

SignSetCode creates a signed the SetCode authorization.

func (*SetCodeAuthorization) Authority added in v1.0.4 

func (a *SetCodeAuthorization) Authority() (common.Address, error)

Authority recovers the authorizing account of an authorization.

func (SetCodeAuthorization) MarshalJSON added in v1.0.4 

func (s SetCodeAuthorization) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*SetCodeAuthorization) UnmarshalJSON added in v1.0.4 

func (s *SetCodeAuthorization) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type SetCodeTx added in v1.0.4 

type SetCodeTx 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
	AuthList   []SetCodeAuthorization

	// Signature values
	V *uint256.Int
	R *uint256.Int
	S *uint256.Int
}

SetCodeTx implements the EIP-7702 transaction type which temporarily installs the code at the signer's address.

type Signer 

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 

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 

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 

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.0.4 

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 

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.0.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.

func NewPragueSigner added in v1.0.4 

func NewPragueSigner(chainId *big.Int) Signer

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

type SlashIndicatorFinalityEvidenceWrapper added in v1.0.4 

type SlashIndicatorFinalityEvidenceWrapper struct {
	VoteA    SlashIndicatorVoteDataWrapper
	VoteB    SlashIndicatorVoteDataWrapper
	VoteAddr string
}

func NewSlashIndicatorFinalityEvidenceWrapper added in v1.0.4 

func NewSlashIndicatorFinalityEvidenceWrapper(vote1, vote2 *VoteEnvelope) *SlashIndicatorFinalityEvidenceWrapper

type SlashIndicatorVoteDataWrapper added in v1.0.4 

type SlashIndicatorVoteDataWrapper struct {
	SrcNum  *big.Int
	SrcHash string
	TarNum  *big.Int
	TarHash string
	Sig     string
}

type SlimAccount added in v1.0.4 

type SlimAccount struct {
	Nonce       uint64
	Balance     *uint256.Int
	LockBalance *uint256.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.0.4 

type StateAccount struct {
	Nonce       uint64
	Balance     *uint256.Int
	LockBalance *uint256.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.0.4 

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.0.4 

func NewEmptyStateAccount() *StateAccount

NewEmptyStateAccount constructs an empty state account.

func (*StateAccount) Copy added in v1.0.4 

func (acct *StateAccount) Copy() *StateAccount

Copy returns a deep-copied state account object.

func (*StateAccount) EncodeRLP added in v1.0.4 

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 

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 

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 

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 

func NewTx(inner TxData) *Transaction

NewTx creates a new transaction.

func SignNewTx 

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

SignNewTx creates a transaction and signs it.

func SignTx 

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 

func (tx *Transaction) AccessList() AccessList

AccessList returns the access list of the transaction.

func (*Transaction) BlobGas added in v1.0.4 

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.0.4 

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.0.4 

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

BlobGasFeeCapCmp compares the blob fee cap of two transactions.

func (*Transaction) BlobGasFeeCapIntCmp added in v1.0.4 

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.0.4 

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.0.4 

func (tx *Transaction) BlobTxSidecar() *BlobTxSidecar

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

func (*Transaction) ChainId 

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 

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 

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

DecodeRLP implements rlp.Decoder

func (*Transaction) EffectiveGasTip added in v1.0.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.0.4 

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

EffectiveGasTipCmp compares the effective gasTipCap of two transactions assuming the given base fee. The effective gas tip is the minimum of: 1. The transaction's gasTipCap 2. The transaction's gasFeeCap minus the base fee

Returns: 

-1 if tx's effective gas tip is less than other's
 0 if they are equal
+1 if tx's effective gas tip is greater than other's

func (*Transaction) EffectiveGasTipIntCmp added in v1.0.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.0.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 

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.0.4 

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

GasFeeCap returns the fee cap per gas of the transaction.

func (*Transaction) GasFeeCapCmp added in v1.0.4 

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

GasFeeCapCmp compares the fee cap of two transactions.

func (*Transaction) GasFeeCapIntCmp added in v1.0.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) GasPriceCmp 

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

GasPriceCmp compares the gas prices of two transactions.

func (*Transaction) GasPriceIntCmp 

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

GasPriceIntCmp compares the gas price of the transaction against the given price.

func (*Transaction) GasTipCap added in v1.0.4 

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

GasTipCap returns the gasTipCap per gas of the transaction.

func (*Transaction) GasTipCapCmp added in v1.0.4 

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

GasTipCapCmp compares the gasTipCap of two transactions.

func (*Transaction) GasTipCapIntCmp added in v1.0.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 

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 

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 

func (tx *Transaction) Protected() bool

Protected says whether the transaction is replay-protected.

func (*Transaction) RawSignatureValues 

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. The return values may be nil or zero, if the transaction is unsigned.

func (*Transaction) SetCodeAuthorities added in v1.0.4 

func (tx *Transaction) SetCodeAuthorities() []common.Address

SetCodeAuthorities returns a list of unique authorities from the authorization list.

func (*Transaction) SetCodeAuthorizations added in v1.0.4 

func (tx *Transaction) SetCodeAuthorizations() []SetCodeAuthorization

SetCodeAuthorizations returns the authorizations list of the transaction.

func (*Transaction) SetTime added in v1.0.4 

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 

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.0.4 

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 

func (tx *Transaction) Type() uint8

Type returns the transaction type.

func (*Transaction) UnmarshalBinary 

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 

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) WithBlobTxSidecar added in v1.0.4 

func (tx *Transaction) WithBlobTxSidecar(sideCar *BlobTxSidecar) *Transaction

WithBlobTxSidecar returns a copy of tx with the blob sidecar added.

func (*Transaction) WithSignature 

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.0.4 

func (tx *Transaction) WithoutBlobTxSidecar() *Transaction

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

type TransactionOpts added in v1.0.4 

type TransactionOpts struct {
	KnownAccounts  KnownAccounts   `json:"knownAccounts"`
	BlockNumberMin *hexutil.Uint64 `json:"blockNumberMin,omitempty"`
	BlockNumberMax *hexutil.Uint64 `json:"blockNumberMax,omitempty"`
	TimestampMin   *hexutil.Uint64 `json:"timestampMin,omitempty"`
	TimestampMax   *hexutil.Uint64 `json:"timestampMax,omitempty"`
}

func (TransactionOpts) MarshalJSON added in v1.0.4 

func (t TransactionOpts) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*TransactionOpts) UnmarshalJSON added in v1.0.4 

func (t *TransactionOpts) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type Transactions 

type Transactions []*Transaction

Transactions implements DerivableList for transactions.

func TxDifference 

func TxDifference(a, b Transactions) Transactions

TxDifference returns a new set of transactions that are present in a but not in b.

func (Transactions) EncodeIndex 

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 

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 

func (s TxByNonce) Len() int

func (TxByNonce) Less 

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

func (TxByNonce) Swap 

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

type TxData 

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 ValidatorsBitSet added in v1.0.4 

type ValidatorsBitSet uint64

type VerifyStatus added in v1.0.4 

type VerifyStatus struct {
	Code uint16
	Msg  string
}

type VoteAttestation added in v1.0.4 

type VoteAttestation struct {
	VoteAddressSet ValidatorsBitSet // The bitset marks the voted validators.
	AggSignature   BLSSignature     // The aggregated BLS signature of the voted validators' signatures.
	Data           *VoteData        // The vote data for fast finality.
	Extra          []byte           // Reserved for future usage.
}

VoteAttestation represents the votes of super majority validators.

type VoteData added in v1.0.4 

type VoteData struct {
	SourceNumber uint64      // The source block number should be the latest justified block number.
	SourceHash   common.Hash // The block hash of the source block.
	TargetNumber uint64      // The target block number which validator wants to vote for.
	TargetHash   common.Hash // The block hash of the target block.
}

VoteData represents the vote range that validator voted for fast finality.

func (*VoteData) Hash added in v1.0.4 

func (d *VoteData) Hash() common.Hash

Hash returns the hash of the vote data.

type VoteEnvelope added in v1.0.4 

type VoteEnvelope struct {
	VoteAddress BLSPublicKey // The BLS public key of the validator.
	Signature   BLSSignature // Validator's signature for the vote data.
	Data        *VoteData    // The vote data for fast finality.
	// contains filtered or unexported fields
}

VoteEnvelope represents the vote of a single validator.

func (*VoteEnvelope) Hash added in v1.0.4 

func (v *VoteEnvelope) Hash() common.Hash

Hash returns the vote's hash.

func (*VoteEnvelope) Verify added in v1.0.4 

func (v *VoteEnvelope) Verify() error

Verify vote using BLS.

type Withdrawal added in v1.0.4 

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.0.4 

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

func (Withdrawal) MarshalJSON added in v1.0.4 

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

MarshalJSON marshals as JSON.

func (*Withdrawal) UnmarshalJSON added in v1.0.4 

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

UnmarshalJSON unmarshals from JSON.

type Withdrawals added in v1.0.4 

type Withdrawals []*Withdrawal

Withdrawals implements DerivableList for withdrawals.

func (Withdrawals) EncodeIndex added in v1.0.4 

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.0.4 

func (s Withdrawals) Len() int

Len returns the length of s.

func (Withdrawals) Size added in v1.0.4 

func (s Withdrawals) Size() int

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.