920ed764db
Includes: * restricted/types/withdrawal.go * Additions to restricted/types/blocks.go Note that I have not currently included withdrawal_gen.go, which does not appear on the surface to be necessar,y but that may require adjustment if testing shows otherwise.
457 lines
14 KiB
Go
457 lines
14 KiB
Go
// Copyright 2014 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
// Package types contains data types related to Ethereum consensus.
|
|
package types
|
|
|
|
import (
|
|
"encoding/binary"
|
|
"fmt"
|
|
"io"
|
|
"math/big"
|
|
"reflect"
|
|
"sync/atomic"
|
|
"time"
|
|
|
|
"github.com/openrelayxyz/plugeth-utils/core"
|
|
"github.com/openrelayxyz/plugeth-utils/restricted/hexutil"
|
|
"github.com/openrelayxyz/plugeth-utils/restricted/rlp"
|
|
)
|
|
|
|
var (
|
|
EmptyRootHash = core.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
|
|
EmptyUncleHash = rlpHash([]*Header(nil))
|
|
)
|
|
|
|
// 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.
|
|
type BlockNonce [8]byte
|
|
|
|
// EncodeNonce converts the given integer to a block nonce.
|
|
func EncodeNonce(i uint64) BlockNonce {
|
|
var n BlockNonce
|
|
binary.BigEndian.PutUint64(n[:], i)
|
|
return n
|
|
}
|
|
|
|
// Uint64 returns the integer value of a block nonce.
|
|
func (n BlockNonce) Uint64() uint64 {
|
|
return binary.BigEndian.Uint64(n[:])
|
|
}
|
|
|
|
// MarshalText encodes n as a hex string with 0x prefix.
|
|
func (n BlockNonce) MarshalText() ([]byte, error) {
|
|
return hexutil.Bytes(n[:]).MarshalText()
|
|
}
|
|
|
|
// UnmarshalText implements encoding.TextUnmarshaler.
|
|
func (n *BlockNonce) UnmarshalText(input []byte) error {
|
|
return hexutil.UnmarshalFixedText("BlockNonce", input, n[:])
|
|
}
|
|
|
|
//go:generate go run github.com/fjl/gencodec -type Header -field-override headerMarshaling -out gen_header_json.go
|
|
//go:generate go run ../../rlp/rlpgen -type Header -out gen_header_rlp.go
|
|
|
|
// Header represents a block header in the Ethereum blockchain.
|
|
type Header struct {
|
|
ParentHash core.Hash `json:"parentHash" gencodec:"required"`
|
|
UncleHash core.Hash `json:"sha3Uncles" gencodec:"required"`
|
|
Coinbase core.Address `json:"miner"`
|
|
Root core.Hash `json:"stateRoot" gencodec:"required"`
|
|
TxHash core.Hash `json:"transactionsRoot" gencodec:"required"`
|
|
ReceiptHash core.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 core.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 *core.Hash `json:"withdrawalsRoot" rlp:"optional"`
|
|
|
|
/*
|
|
TODO (MariusVanDerWijden) Add this field once needed
|
|
// Random was added during the merge and contains the BeaconState randomness
|
|
Random core.Hash `json:"random" rlp:"optional"`
|
|
*/
|
|
}
|
|
|
|
// field type overrides for gencodec
|
|
type headerMarshaling struct {
|
|
Difficulty *hexutil.Big
|
|
Number *hexutil.Big
|
|
GasLimit hexutil.Uint64
|
|
GasUsed hexutil.Uint64
|
|
Time hexutil.Uint64
|
|
Extra hexutil.Bytes
|
|
BaseFee *hexutil.Big
|
|
Hash core.Hash `json:"hash"` // adds call to Hash() in MarshalJSON
|
|
}
|
|
|
|
// Hash returns the block hash of the header, which is simply the keccak256 hash of its
|
|
// RLP encoding.
|
|
func (h *Header) Hash() core.Hash {
|
|
return rlpHash(h)
|
|
}
|
|
|
|
var headerSize = float64(reflect.TypeOf(Header{}).Size())
|
|
|
|
// Size returns the approximate memory used by all internal contents. It is used
|
|
// to approximate and limit the memory consumption of various caches.
|
|
func (h *Header) Size() float64 {
|
|
return headerSize + float64(len(h.Extra)+(h.Difficulty.BitLen()+h.Number.BitLen())/8)
|
|
}
|
|
|
|
|
|
// 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) SanityCheck() error {
|
|
if h.Number != nil && !h.Number.IsUint64() {
|
|
return fmt.Errorf("too large block number: bitlen %d", h.Number.BitLen())
|
|
}
|
|
if h.Difficulty != nil {
|
|
if diffLen := h.Difficulty.BitLen(); diffLen > 80 {
|
|
return fmt.Errorf("too large block difficulty: bitlen %d", diffLen)
|
|
}
|
|
}
|
|
if eLen := len(h.Extra); eLen > 100*1024 {
|
|
return fmt.Errorf("too large block extradata: size %d", eLen)
|
|
}
|
|
if h.BaseFee != nil {
|
|
if bfLen := h.BaseFee.BitLen(); bfLen > 256 {
|
|
return fmt.Errorf("too large base fee: bitlen %d", bfLen)
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// EmptyBody returns true if there is no additional 'body' to complete the header
|
|
// that is: no transactions, no uncles and no withdrawals.
|
|
func (h *Header) EmptyBody() bool {
|
|
if h.WithdrawalsHash == nil {
|
|
return h.TxHash == EmptyRootHash && h.UncleHash == EmptyUncleHash
|
|
}
|
|
return h.TxHash == EmptyRootHash && h.UncleHash == EmptyUncleHash && *h.WithdrawalsHash == EmptyRootHash
|
|
}
|
|
|
|
// EmptyReceipts returns true if there are no receipts for this header/block.
|
|
func (h *Header) EmptyReceipts() bool {
|
|
return h.ReceiptHash == EmptyRootHash
|
|
}
|
|
|
|
// Body is a simple (mutable, non-safe) data container for storing and moving
|
|
// a block's data contents (transactions and uncles) together.
|
|
type Body struct {
|
|
Transactions []*Transaction
|
|
Uncles []*Header
|
|
Withdrawals []*Withdrawal `rlp:"optional"`
|
|
}
|
|
|
|
// Block represents an entire block in the Ethereum blockchain.
|
|
type Block struct {
|
|
header *Header
|
|
uncles []*Header
|
|
transactions Transactions
|
|
withdrawals Withdrawals
|
|
|
|
// caches
|
|
hash atomic.Value
|
|
size atomic.Value
|
|
|
|
// These fields are used by package eth to track
|
|
// inter-peer block relay.
|
|
ReceivedAt time.Time
|
|
ReceivedFrom interface{}
|
|
}
|
|
|
|
// "external" block encoding. used for eth protocol, etc.
|
|
type extblock struct {
|
|
Header *Header
|
|
Txs []*Transaction
|
|
Uncles []*Header
|
|
Withdrawals []*Withdrawal `rlp:"optional"`
|
|
}
|
|
|
|
// 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 NewBlock(header *Header, txs []*Transaction, uncles []*Header, receipts []*Receipt, hasher TrieHasher) *Block {
|
|
b := &Block{header: CopyHeader(header)}
|
|
|
|
// TODO: panic if len(txs) != len(receipts)
|
|
if len(txs) == 0 {
|
|
b.header.TxHash = EmptyRootHash
|
|
} else {
|
|
b.header.TxHash = DeriveSha(Transactions(txs), hasher)
|
|
b.transactions = make(Transactions, len(txs))
|
|
copy(b.transactions, txs)
|
|
}
|
|
|
|
if len(receipts) == 0 {
|
|
b.header.ReceiptHash = EmptyRootHash
|
|
} else {
|
|
b.header.ReceiptHash = DeriveSha(Receipts(receipts), hasher)
|
|
b.header.Bloom = CreateBloom(receipts)
|
|
}
|
|
|
|
if len(uncles) == 0 {
|
|
b.header.UncleHash = EmptyUncleHash
|
|
} else {
|
|
b.header.UncleHash = CalcUncleHash(uncles)
|
|
b.uncles = make([]*Header, len(uncles))
|
|
for i := range uncles {
|
|
b.uncles[i] = CopyHeader(uncles[i])
|
|
}
|
|
}
|
|
|
|
return b
|
|
}
|
|
|
|
// 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 NewBlockWithWithdrawals(header *Header, txs []*Transaction, uncles []*Header, receipts []*Receipt, withdrawals []*Withdrawal, hasher TrieHasher) *Block {
|
|
b := NewBlock(header, txs, uncles, receipts, hasher)
|
|
|
|
if withdrawals == nil {
|
|
b.header.WithdrawalsHash = nil
|
|
} else if len(withdrawals) == 0 {
|
|
b.header.WithdrawalsHash = &EmptyRootHash
|
|
} else {
|
|
h := DeriveSha(Withdrawals(withdrawals), hasher)
|
|
b.header.WithdrawalsHash = &h
|
|
}
|
|
|
|
return b.WithWithdrawals(withdrawals)
|
|
}
|
|
|
|
// 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 NewBlockWithHeader(header *Header) *Block {
|
|
return &Block{header: CopyHeader(header)}
|
|
}
|
|
|
|
// CopyHeader creates a deep copy of a block header to prevent side effects from
|
|
// modifying a header variable.
|
|
func CopyHeader(h *Header) *Header {
|
|
cpy := *h
|
|
if cpy.Difficulty = new(big.Int); h.Difficulty != nil {
|
|
cpy.Difficulty.Set(h.Difficulty)
|
|
}
|
|
if cpy.Number = new(big.Int); h.Number != nil {
|
|
cpy.Number.Set(h.Number)
|
|
}
|
|
if h.BaseFee != nil {
|
|
cpy.BaseFee = new(big.Int).Set(h.BaseFee)
|
|
}
|
|
if len(h.Extra) > 0 {
|
|
cpy.Extra = make([]byte, len(h.Extra))
|
|
copy(cpy.Extra, h.Extra)
|
|
}
|
|
if h.WithdrawalsHash != nil {
|
|
*cpy.WithdrawalsHash = *h.WithdrawalsHash
|
|
}
|
|
return &cpy
|
|
}
|
|
|
|
// DecodeRLP decodes the Ethereum
|
|
func (b *Block) DecodeRLP(s *rlp.Stream) error {
|
|
var eb extblock
|
|
_, size, _ := s.Kind()
|
|
if err := s.Decode(&eb); err != nil {
|
|
return err
|
|
}
|
|
b.header, b.uncles, b.transactions, b.withdrawals = eb.Header, eb.Uncles, eb.Txs, eb.Withdrawals
|
|
b.size.Store(rlp.ListSize(size))
|
|
return nil
|
|
}
|
|
|
|
// EncodeRLP serializes b into the Ethereum RLP block format.
|
|
func (b *Block) EncodeRLP(w io.Writer) error {
|
|
return rlp.Encode(w, extblock{
|
|
Header: b.header,
|
|
Txs: b.transactions,
|
|
Uncles: b.uncles,
|
|
Withdrawals: b.withdrawals,
|
|
})
|
|
}
|
|
|
|
// TODO: copies
|
|
|
|
func (b *Block) Uncles() []*Header { return b.uncles }
|
|
func (b *Block) Transactions() Transactions { return b.transactions }
|
|
|
|
func (b *Block) Transaction(hash core.Hash) *Transaction {
|
|
for _, transaction := range b.transactions {
|
|
if transaction.Hash() == hash {
|
|
return transaction
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (b *Block) Number() *big.Int { return new(big.Int).Set(b.header.Number) }
|
|
func (b *Block) GasLimit() uint64 { return b.header.GasLimit }
|
|
func (b *Block) GasUsed() uint64 { return b.header.GasUsed }
|
|
func (b *Block) Difficulty() *big.Int { return new(big.Int).Set(b.header.Difficulty) }
|
|
func (b *Block) Time() uint64 { return b.header.Time }
|
|
|
|
func (b *Block) NumberU64() uint64 { return b.header.Number.Uint64() }
|
|
func (b *Block) MixDigest() core.Hash { return b.header.MixDigest }
|
|
func (b *Block) Nonce() uint64 { return binary.BigEndian.Uint64(b.header.Nonce[:]) }
|
|
func (b *Block) Bloom() Bloom { return b.header.Bloom }
|
|
func (b *Block) Coinbase() core.Address { return b.header.Coinbase }
|
|
func (b *Block) Root() core.Hash { return b.header.Root }
|
|
func (b *Block) ParentHash() core.Hash { return b.header.ParentHash }
|
|
func (b *Block) TxHash() core.Hash { return b.header.TxHash }
|
|
func (b *Block) ReceiptHash() core.Hash { return b.header.ReceiptHash }
|
|
func (b *Block) UncleHash() core.Hash { return b.header.UncleHash }
|
|
func (b *Block) Extra() []byte { return core.CopyBytes(b.header.Extra) }
|
|
|
|
func (b *Block) BaseFee() *big.Int {
|
|
if b.header.BaseFee == nil {
|
|
return nil
|
|
}
|
|
return new(big.Int).Set(b.header.BaseFee)
|
|
}
|
|
|
|
func (b *Block) Withdrawals() Withdrawals {
|
|
return b.withdrawals
|
|
}
|
|
|
|
func (b *Block) Header() *Header { return CopyHeader(b.header) }
|
|
|
|
// Body returns the non-header content of the block.
|
|
func (b *Block) Body() *Body { return &Body{b.transactions, b.uncles, b.withdrawals} }
|
|
|
|
// Size returns the true RLP encoded storage size of the block, either by encoding
|
|
// and returning it, or returning a previously cached value.
|
|
func (b *Block) Size() uint64 {
|
|
if size := b.size.Load(); size != nil {
|
|
return size.(uint64)
|
|
}
|
|
c := writeCounter(0)
|
|
rlp.Encode(&c, b)
|
|
b.size.Store(uint64(c))
|
|
return uint64(c)
|
|
}
|
|
|
|
// SanityCheck can be used to prevent that unbounded fields are
|
|
// stuffed with junk data to add processing overhead
|
|
func (b *Block) SanityCheck() error {
|
|
return b.header.SanityCheck()
|
|
}
|
|
|
|
type writeCounter uint64
|
|
|
|
func (c *writeCounter) Write(b []byte) (int, error) {
|
|
*c += writeCounter(len(b))
|
|
return len(b), nil
|
|
}
|
|
|
|
func CalcUncleHash(uncles []*Header) core.Hash {
|
|
if len(uncles) == 0 {
|
|
return EmptyUncleHash
|
|
}
|
|
return rlpHash(uncles)
|
|
}
|
|
|
|
// WithSeal returns a new block with the data from b but the header replaced with
|
|
// the sealed one.
|
|
func (b *Block) WithSeal(header *Header) *Block {
|
|
cpy := *header
|
|
|
|
return &Block{
|
|
header: &cpy,
|
|
transactions: b.transactions,
|
|
uncles: b.uncles,
|
|
withdrawals: b.withdrawals,
|
|
}
|
|
}
|
|
|
|
// WithBody returns a new block with the given transaction and uncle contents.
|
|
func (b *Block) WithBody(transactions []*Transaction, uncles []*Header) *Block {
|
|
block := &Block{
|
|
header: CopyHeader(b.header),
|
|
transactions: make([]*Transaction, len(transactions)),
|
|
uncles: make([]*Header, len(uncles)),
|
|
}
|
|
copy(block.transactions, transactions)
|
|
for i := range uncles {
|
|
block.uncles[i] = CopyHeader(uncles[i])
|
|
}
|
|
return block
|
|
}
|
|
|
|
// WithWithdrawals sets the withdrawal contents of a block, does not return a new block.
|
|
func (b *Block) WithWithdrawals(withdrawals []*Withdrawal) *Block {
|
|
if withdrawals != nil {
|
|
b.withdrawals = make([]*Withdrawal, len(withdrawals))
|
|
copy(b.withdrawals, withdrawals)
|
|
}
|
|
return b
|
|
}
|
|
|
|
// Hash returns the keccak256 hash of b's header.
|
|
// The hash is computed on the first call and cached thereafter.
|
|
func (b *Block) Hash() core.Hash {
|
|
if hash := b.hash.Load(); hash != nil {
|
|
return hash.(core.Hash)
|
|
}
|
|
v := b.header.Hash()
|
|
b.hash.Store(v)
|
|
return v
|
|
}
|
|
|
|
type Blocks []*Block
|
|
|
|
// HeaderParentHashFromRLP returns the parentHash of an RLP-encoded
|
|
// header. If 'header' is invalid, the zero hash is returned.
|
|
func HeaderParentHashFromRLP(header []byte) core.Hash {
|
|
// parentHash is the first list element.
|
|
listContent, _, err := rlp.SplitList(header)
|
|
if err != nil {
|
|
return core.Hash{}
|
|
}
|
|
parentHash, _, err := rlp.SplitString(listContent)
|
|
if err != nil {
|
|
return core.Hash{}
|
|
}
|
|
if len(parentHash) != 32 {
|
|
return core.Hash{}
|
|
}
|
|
return core.BytesToHash(parentHash)
|
|
}
|