import "github.com/ethereum/go-ethereum/core/types"
Package types contains data types related to Ethereum consensus.
block.go bloom9.go derive_sha.go gen_header_json.go gen_log_json.go gen_receipt_json.go gen_tx_json.go log.go receipt.go transaction.go transaction_signing.go
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
)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)
)var (
EmptyRootHash = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
EmptyUncleHash = rlpHash([]*Header(nil))
)Bloom9 returns the bloom filter for the given data
BloomLookup is a convenience-method to check presence int he bloom filter
func DeriveSha(list DerivableList, hasher Hasher) common.Hash
LogsBloom returns the bloom bytes for the given logs
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.
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 entire block in the Ethereum blockchain.
func NewBlock(header *Header, txs []*Transaction, uncles []*Header, receipts []*Receipt, hasher Hasher) *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.
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.
Body returns the non-header content of the block.
DecodeRLP decodes the Ethereum
DeprecatedTd is an old relic for extracting the TD of a block. It is in the code solely to facilitate upgrading the database from the old format to the new, after which it should be deleted. Do not use!
EncodeRLP serializes b into the Ethereum RLP block format.
Hash returns the keccak256 hash of b's header. The hash is computed on the first call and cached thereafter.
SanityCheck can be used to prevent that unbounded fields are stuffed with junk data to add processing overhead
func (b *Block) Size() common.StorageSize
Size returns the true RLP encoded storage size of the block, either by encoding and returning it, or returning a previsouly cached value.
func (b *Block) Transaction(hash common.Hash) *Transaction
func (b *Block) Transactions() Transactions
func (b *Block) WithBody(transactions []*Transaction, uncles []*Header) *Block
WithBody returns a new block with the given transaction and uncle contents.
WithSeal returns a new block with the data from b but the header replaced with the sealed one.
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(i uint64) BlockNonce
EncodeNonce converts the given integer to a block nonce.
func (n BlockNonce) MarshalText() ([]byte, error)
MarshalText encodes n as a hex string with 0x prefix.
func (n BlockNonce) Uint64() uint64
Uint64 returns the integer value of a block nonce.
func (n *BlockNonce) UnmarshalText(input []byte) error
UnmarshalText implements encoding.TextUnmarshaler.
type Bloom [BloomByteLength]byte
Bloom represents a 2048 bit bloom filter.
BytesToBloom converts a byte slice to a bloom filter. It panics if b is not of suitable size.
CreateBloom creates a bloom filter out of the give Receipts (+Logs)
Add adds d to the filter. Future calls of Test(d) will return true.
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
Bytes returns the backing byte slice of the bloom
MarshalText encodes b as a hex string with 0x prefix.
SetBytes sets the content of b to the given bytes. It panics if d is not of suitable size.
Test checks if the given topic is present in the bloom filter
UnmarshalText b as a hex string with 0x prefix.
type Body struct {
Transactions []*Transaction
Uncles []*Header
}Body is a simple (mutable, non-safe) data container for storing and moving a block's data contents (transactions and uncles) together.
type EIP155Signer struct {
// contains filtered or unexported fields
}EIP155Transaction implements Signer using the EIP155 rules.
func NewEIP155Signer(chainId *big.Int) EIP155Signer
func (s EIP155Signer) Equal(s2 Signer) bool
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 (s EIP155Signer) Sender(tx *Transaction) (common.Address, error)
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 struct{}func (s FrontierSigner) Equal(s2 Signer) bool
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 (fs FrontierSigner) Sender(tx *Transaction) (common.Address, error)
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.
Hasher is the tool used to calculate the hash of derivable list.
type Header struct {
ParentHash common.Hash `json:"parentHash" gencodec:"required"`
UncleHash common.Hash `json:"sha3Uncles" gencodec:"required"`
Coinbase common.Address `json:"miner" gencodec:"required"`
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"`
}Header represents a block header in the Ethereum blockchain.
CopyHeader creates a deep copy of a block header to prevent side effects from modifying a header variable.
EmptyBody returns true if there is no additional 'body' to complete the header that is: no transactions and no uncles.
EmptyReceipts returns true if there are no receipts for this header/block.
Hash returns the block hash of the header, which is simply the keccak256 hash of its RLP encoding.
MarshalJSON marshals as JSON.
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 (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.
UnmarshalJSON unmarshals from JSON.
type HomesteadSigner struct{ FrontierSigner }HomesteadTransaction implements TransactionInterface using the homestead rules.
func (s HomesteadSigner) Equal(s2 Signer) bool
func (hs HomesteadSigner) Sender(tx *Transaction) (common.Address, error)
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 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"`
// hash of the transaction
TxHash common.Hash `json:"transactionHash" gencodec:"required"`
// index of the transaction in the block
TxIndex uint `json:"transactionIndex"`
// hash of the block in which the transaction was included
BlockHash common.Hash `json:"blockHash"`
// index of the log in the block
Index uint `json:"logIndex"`
// 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"`
}Log represents a contract log event. These events are generated by the LOG opcode and stored/indexed by the node.
DecodeRLP implements rlp.Decoder.
EncodeRLP implements rlp.Encoder.
MarshalJSON marshals as JSON.
UnmarshalJSON unmarshals from JSON.
LogForStorage is a wrapper around a Log that flattens and parses the entire content of a log including non-consensus fields.
func (l *LogForStorage) DecodeRLP(s *rlp.Stream) error
DecodeRLP implements rlp.Decoder.
Note some redundant fields(e.g. block number, tx hash etc) will be assembled later.
func (l *LogForStorage) EncodeRLP(w io.Writer) error
EncodeRLP implements rlp.Encoder.
type Message struct {
// contains filtered or unexported fields
}Message is a fully derived transaction and implements core.Message
NOTE: In a future PR this will be removed.
func NewMessage(from common.Address, to *common.Address, nonce uint64, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte, checkNonce bool) Message
type Receipt struct {
// Consensus fields: These fields are defined by the Yellow Paper
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.
// They are stored in the chain database.
TxHash common.Hash `json:"transactionHash" gencodec:"required"`
ContractAddress common.Address `json:"contractAddress"`
GasUsed uint64 `json:"gasUsed" gencodec:"required"`
// 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.
NewReceipt creates a barebone transaction receipt, copying the init fields.
DecodeRLP implements rlp.Decoder, and loads the consensus fields of a receipt from an RLP stream.
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.
MarshalJSON marshals as JSON.
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.
UnmarshalJSON unmarshals from JSON.
ReceiptForStorage is a wrapper around a Receipt that flattens and parses the entire content of a receipt, as opposed to only the consensus fields originally.
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 (r *ReceiptForStorage) EncodeRLP(w io.Writer) error
EncodeRLP implements rlp.Encoder, and flattens all content fields of a receipt into an RLP stream.
Receipts is a wrapper around a Receipt array to implement DerivableList.
func (r Receipts) DeriveFields(config *params.ChainConfig, hash common.Hash, number uint64, txs Transactions) error
DeriveFields fills the receipts with their computed fields based on consensus data and contextual infos like containing block and transactions.
GetRlp returns the RLP encoding of one receipt from the list.
Len returns the number of receipts in this list.
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)
// Hash returns the hash to be signed.
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. Note that this interface is not a stable API and may change at any time to accommodate new protocol rules.
MakeSigner returns a Signer based on the given chain config and block number.
[deprecated by eth/63] StorageBlock defines the RLP encoding of a Block stored in the state database. The StorageBlock encoding contains fields that would otherwise need to be recomputed.
func (b *StorageBlock) DecodeRLP(s *rlp.Stream) error
[deprecated by eth/63]
type Transaction struct {
// contains filtered or unexported fields
}func NewContractCreation(nonce uint64, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte) *Transaction
func NewTransaction(nonce uint64, to common.Address, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte) *Transaction
func SignTx(tx *Transaction, s Signer, prv *ecdsa.PrivateKey) (*Transaction, error)
SignTx signs the transaction using the given signer and private key
func (tx *Transaction) AsMessage(s Signer) (Message, error)
AsMessage returns the transaction as a core.Message.
AsMessage requires a signer to derive the sender.
XXX Rename message to something less arbitrary?
func (tx *Transaction) ChainId() *big.Int
ChainId returns which chain id this transaction was signed for (if at all)
func (tx *Transaction) CheckNonce() bool
func (tx *Transaction) Cost() *big.Int
Cost returns amount + gasprice * gaslimit.
func (tx *Transaction) Data() []byte
func (tx *Transaction) DecodeRLP(s *rlp.Stream) error
DecodeRLP implements rlp.Decoder
func (tx *Transaction) EncodeRLP(w io.Writer) error
EncodeRLP implements rlp.Encoder
func (tx *Transaction) Gas() uint64
func (tx *Transaction) GasPrice() *big.Int
func (tx *Transaction) GasPriceCmp(other *Transaction) int
func (tx *Transaction) GasPriceIntCmp(other *big.Int) int
func (tx *Transaction) Hash() common.Hash
Hash hashes the RLP encoding of tx. It uniquely identifies the transaction.
func (tx *Transaction) MarshalJSON() ([]byte, error)
MarshalJSON encodes the web3 RPC transaction format.
func (tx *Transaction) Nonce() uint64
func (tx *Transaction) Protected() bool
Protected returns whether the transaction is protected from replay protection.
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 (tx *Transaction) Size() common.StorageSize
Size returns the true RLP encoded storage size of the transaction, either by encoding and returning it, or returning a previously cached value.
func (tx *Transaction) To() *common.Address
To returns the recipient address of the transaction. It returns nil if the transaction is a contract creation.
func (tx *Transaction) UnmarshalJSON(input []byte) error
UnmarshalJSON decodes the web3 RPC transaction format.
func (tx *Transaction) Value() *big.Int
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.
type Transactions []*Transaction
Transactions is a Transaction slice type for basic sorting.
func TxDifference(a, b Transactions) Transactions
TxDifference returns a new set which is the difference between a and b.
func (s Transactions) GetRlp(i int) []byte
GetRlp implements Rlpable and returns the i'th element of s in rlp.
func (s Transactions) Len() int
Len returns the length of s.
func (s Transactions) Swap(i, j int)
Swap swaps the i'th and the j'th element in s.
type TransactionsByPriceAndNonce struct {
// contains filtered or unexported fields
}TransactionsByPriceAndNonce represents a set of transactions that can return transactions in a profit-maximizing sorted order, while supporting removing entire batches of transactions for non-executable accounts.
func NewTransactionsByPriceAndNonce(signer Signer, txs map[common.Address]Transactions) *TransactionsByPriceAndNonce
NewTransactionsByPriceAndNonce creates a transaction set that can retrieve price sorted transactions in a nonce-honouring way.
Note, the input map is reowned so the caller should not interact any more with if after providing it to the constructor.
func (t *TransactionsByPriceAndNonce) Peek() *Transaction
Peek returns the next transaction by price.
func (t *TransactionsByPriceAndNonce) Pop()
Pop removes the best transaction, *not* replacing it with the next one from the same account. This should be used when a transaction cannot be executed and hence all subsequent ones should be discarded from the same account.
func (t *TransactionsByPriceAndNonce) Shift()
Shift replaces the current best head with the next one from the same account.
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.
type TxByPriceAndTime Transactions
TxByPriceAndTime implements both the sort and the heap interface, making it useful for all at once sorting as well as individually adding and removing elements.
func (s TxByPriceAndTime) Len() int
func (s TxByPriceAndTime) Less(i, j int) bool
func (s *TxByPriceAndTime) Pop() interface{}
func (s *TxByPriceAndTime) Push(x interface{})
func (s TxByPriceAndTime) Swap(i, j int)
Package types imports 20 packages (graph) and is imported by 5894 packages. Updated 2020-11-25. Refresh now. Tools for package owners.