Documentation
¶
Overview ¶
Package types contains data types related to Ethereum consensus.
Index ¶
- Variables
- func BloomLookup(bin Bloom, topic bytesBacked) bool
- func CalcUncleHash(uncles []*Header) common.Hash
- func DeriveSha(list DerivableList) common.Hash
- func LogsBloom(logs []*Log) *big.Int
- func Number(b1, b2 *Block) bool
- func Sender(signer Signer, tx *Transaction) (common.Address, error)
- type Block
- func (b *Block) Bloom() Bloom
- func (b *Block) Body() *Body
- func (b *Block) Coinbase() common.Address
- func (b *Block) DecodeRLP(s *rlp.Stream) error
- func (b *Block) DeprecatedTd() *big.Int
- func (b *Block) Difficulty() *big.Int
- func (b *Block) EncodeRLP(w io.Writer) error
- func (b *Block) Extra() []byte
- func (b *Block) GasLimit() *big.Int
- func (b *Block) GasUsed() *big.Int
- func (b *Block) Hash() common.Hash
- func (b *Block) HashNoNonce() common.Hash
- func (b *Block) Header() *Header
- func (b *Block) MixDigest() common.Hash
- func (b *Block) Nonce() uint64
- func (b *Block) Number() *big.Int
- func (b *Block) NumberU64() uint64
- func (b *Block) ParentHash() common.Hash
- func (b *Block) ReceiptHash() common.Hash
- func (b *Block) Root() common.Hash
- func (b *Block) Size() common.StorageSize
- func (b *Block) String() string
- func (b *Block) Time() *big.Int
- func (b *Block) Transaction(hash common.Hash) *Transaction
- func (b *Block) Transactions() Transactions
- func (b *Block) TxHash() common.Hash
- func (b *Block) UncleHash() common.Hash
- func (b *Block) Uncles() []*Header
- func (b *Block) WithBody(transactions []*Transaction, uncles []*Header) *Block
- func (b *Block) WithSeal(header *Header) *Block
- type BlockBy
- type BlockNonce
- type Blocks
- type Bloom
- func (b *Bloom) Add(d *big.Int)
- func (b Bloom) Big() *big.Int
- func (b Bloom) Bytes() []byte
- func (b Bloom) MarshalText() ([]byte, error)
- func (b *Bloom) SetBytes(d []byte)
- func (b Bloom) Test(test *big.Int) bool
- func (b Bloom) TestBytes(test []byte) bool
- func (b *Bloom) UnmarshalText(input []byte) error
- type Body
- type DerivableList
- type EIP155Signer
- type FrontierSigner
- type Header
- type HomesteadSigner
- type Log
- type LogForStorage
- type Message
- type Receipt
- type ReceiptForStorage
- type Receipts
- type Signer
- type StorageBlock
- type Transaction
- func (tx *Transaction) AsMessage(s Signer) (Message, error)
- func (tx *Transaction) ChainId() *big.Int
- func (tx *Transaction) CheckNonce() bool
- func (tx *Transaction) Cost() *big.Int
- func (tx *Transaction) Data() []byte
- func (tx *Transaction) DecodeRLP(s *rlp.Stream) error
- func (tx *Transaction) EncodeRLP(w io.Writer) error
- func (tx *Transaction) Gas() *big.Int
- func (tx *Transaction) GasPrice() *big.Int
- func (tx *Transaction) Hash() common.Hash
- func (tx *Transaction) MarshalJSON() ([]byte, error)
- func (tx *Transaction) Nonce() uint64
- func (tx *Transaction) Protected() bool
- func (tx *Transaction) RawSignatureValues() (*big.Int, *big.Int, *big.Int)
- func (tx *Transaction) SigHash(signer Signer) common.Hash
- func (tx *Transaction) Size() common.StorageSize
- func (tx *Transaction) String() string
- func (tx *Transaction) To() *common.Address
- func (tx *Transaction) UnmarshalJSON(input []byte) error
- func (tx *Transaction) Value() *big.Int
- func (tx *Transaction) WithSignature(signer Signer, sig []byte) (*Transaction, error)
- type Transactions
- type TransactionsByPriceAndNonce
- type TxByNonce
- type TxByPrice
Constants ¶
This section is empty.
Variables ¶
var ( EmptyRootHash = DeriveSha(Transactions{}) EmptyUncleHash = CalcUncleHash(nil) )
var Bloom9 = bloom9
var ErrInvalidChainId = errors.New("invalid chaid id for signer")
var (
ErrInvalidSig = errors.New("invalid transaction v, r, s values")
)
Functions ¶
func BloomLookup ¶
func CalcUncleHash ¶ added in v0.9.34
func DeriveSha ¶
func DeriveSha(list DerivableList) common.Hash
func Sender ¶ added in v1.5.0
func Sender(signer Signer, tx *Transaction) (common.Address, error)
Sender returns the address derived from the signature (V, R, S) using secp256k1 elliptic curve and an error if it failed deriving or upon an incorrect signature.
Sender may cache the address, allowing it to be used regardless of signing method. The cache is invalidated if the cached signer does not match the signer used in the current call.
Types ¶
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 entire block in the Ethereum blockchain.
func NewBlock ¶ added in v0.8.5
func NewBlock(header *Header, txs []*Transaction, uncles []*Header, receipts []*Receipt) *Block
NewBlock creates a new block. The input data is copied, changes to header and to the field values will not affect the block.
The values of TxHash, UncleHash, ReceiptHash and Bloom in header are ignored and set to values derived from the given txs, uncles and receipts.
func NewBlockWithHeader ¶ added in v0.8.5
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) DeprecatedTd ¶ added in v1.2.2
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!
func (*Block) Difficulty ¶
func (*Block) EncodeRLP ¶ added in v0.9.17
EncodeRLP serializes b into the Ethereum RLP block format.
func (*Block) Hash ¶
Hash returns the keccak256 hash of b's header. The hash is computed on the first call and cached thereafter.
func (*Block) HashNoNonce ¶
func (*Block) ParentHash ¶ added in v0.8.5
func (*Block) ReceiptHash ¶ added in v0.9.34
func (*Block) Size ¶
func (b *Block) Size() common.StorageSize
func (*Block) Transaction ¶ added in v0.8.5
func (b *Block) Transaction(hash common.Hash) *Transaction
func (*Block) Transactions ¶
func (b *Block) Transactions() Transactions
type BlockNonce ¶ added in v0.9.34
type BlockNonce [8]byte
A BlockNonce is a 64-bit hash which proves (combined with the mix-hash) that a sufficient amount of computation has been carried out on a block.
func EncodeNonce ¶ added in v0.9.34
func EncodeNonce(i uint64) BlockNonce
EncodeNonce converts the given integer to a block nonce.
func (BlockNonce) MarshalText ¶ added in v1.6.0
func (n BlockNonce) MarshalText() ([]byte, error)
MarshalText encodes n as a hex string with 0x prefix.
func (BlockNonce) Uint64 ¶ added in v0.9.34
func (n BlockNonce) Uint64() uint64
Uint64 returns the integer value of a block nonce.
func (*BlockNonce) UnmarshalText ¶ added in v1.6.0
func (n *BlockNonce) UnmarshalText(input []byte) error
UnmarshalText implements encoding.TextUnmarshaler.
type Bloom ¶ added in v0.9.17
type Bloom [bloomLength]byte
Bloom represents a 256 bit bloom filter.
func BytesToBloom ¶ added in v0.9.17
BytesToBloom converts a byte slice to a bloom filter. It panics if b is not of suitable size.
func CreateBloom ¶
func (*Bloom) Add ¶ added in v1.3.1
Add adds d to the filter. Future calls of Test(d) will return true.
func (Bloom) MarshalText ¶ added in v1.6.0
MarshalText encodes b as a hex string with 0x prefix.
func (*Bloom) SetBytes ¶ added in v0.9.17
SetBytes sets the content of b to the given bytes. It panics if d is not of suitable size.
func (*Bloom) UnmarshalText ¶ added in v1.6.0
UnmarshalText b as a hex string with 0x prefix.
type Body ¶ added in v1.2.2
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 DerivableList ¶
type EIP155Signer ¶ added in v1.4.19
type EIP155Signer struct { HomesteadSigner // contains filtered or unexported fields }
EIP155Transaction implements TransactionInterface using the EIP155 rules
func NewEIP155Signer ¶ added in v1.4.19
func NewEIP155Signer(chainId *big.Int) EIP155Signer
func (EIP155Signer) Equal ¶ added in v1.5.0
func (s EIP155Signer) Equal(s2 Signer) bool
func (EIP155Signer) Hash ¶ added in v1.4.19
func (s EIP155Signer) Hash(tx *Transaction) common.Hash
Hash returns the hash to be signed by the sender. It does not uniquely identify the transaction.
func (EIP155Signer) PublicKey ¶ added in v1.4.19
func (s EIP155Signer) PublicKey(tx *Transaction) ([]byte, error)
func (EIP155Signer) WithSignature ¶ added in v1.4.19
func (s EIP155Signer) WithSignature(tx *Transaction, 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 FrontierSigner ¶ added in v1.4.19
type FrontierSigner struct{}
func (FrontierSigner) Equal ¶ added in v1.5.0
func (s FrontierSigner) Equal(s2 Signer) bool
func (FrontierSigner) Hash ¶ added in v1.4.19
func (fs FrontierSigner) Hash(tx *Transaction) common.Hash
Hash returns the hash to be sned by the sender. It does not uniquely identify the transaction.
func (FrontierSigner) PublicKey ¶ added in v1.4.19
func (fs FrontierSigner) PublicKey(tx *Transaction) ([]byte, error)
func (FrontierSigner) WithSignature ¶ added in v1.4.19
func (fs FrontierSigner) WithSignature(tx *Transaction, 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 Header ¶ added in v0.8.5
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 *big.Int `json:"gasLimit" gencodec:"required"` GasUsed *big.Int `json:"gasUsed" gencodec:"required"` Time *big.Int `json:"timestamp" gencodec:"required"` Extra []byte `json:"extraData" gencodec:"required"` MixDigest common.Hash `json:"mixHash" gencodec:"required"` Nonce BlockNonce `json:"nonce" gencodec:"required"` }
Header represents a block header in the Ethereum blockchain.
func CopyHeader ¶ added in v1.3.1
CopyHeader creates a deep copy of a block header to prevent side effects from modifying a header variable.
func (*Header) Hash ¶ added in v0.8.5
Hash returns the block hash of the header, which is simply the keccak256 hash of its RLP encoding.
func (*Header) HashNoNonce ¶ added in v0.8.5
HashNoNonce returns the hash which is used as input for the proof-of-work search.
func (Header) MarshalJSON ¶ added in v1.5.0
func (*Header) UnmarshalJSON ¶ added in v0.9.30
type HomesteadSigner ¶ added in v1.4.19
type HomesteadSigner struct{ FrontierSigner }
HomesteadTransaction implements TransactionInterface using the homestead rules.
func (HomesteadSigner) Equal ¶ added in v1.5.0
func (s HomesteadSigner) Equal(s2 Signer) bool
func (HomesteadSigner) PublicKey ¶ added in v1.4.19
func (hs HomesteadSigner) PublicKey(tx *Transaction) ([]byte, error)
func (HomesteadSigner) WithSignature ¶ added in v1.4.19
func (hs HomesteadSigner) WithSignature(tx *Transaction, 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 Log ¶ added in v1.5.6
type Log struct { // Consensus fields: // address of the contract that generated the event Address common.Address `json:"address" gencodec:"required"` // list of topics provided by the contract. Topics []common.Hash `json:"topics" gencodec:"required"` // supplied by the contract, usually ABI-encoded Data []byte `json:"data" gencodec:"required"` // Derived fields. These fields are filled in by the node // but not secured by consensus. // block in which the transaction was included BlockNumber uint64 `json:"blockNumber"` // hash of the transaction TxHash common.Hash `json:"transactionHash" gencodec:"required"` // index of the transaction in the block TxIndex uint `json:"transactionIndex" gencodec:"required"` // hash of the block in which the transaction was included BlockHash common.Hash `json:"blockHash"` // index of the log in the receipt Index uint `json:"logIndex" gencodec:"required"` // 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.
func (Log) MarshalJSON ¶ added in v1.5.6
func (*Log) UnmarshalJSON ¶ added in v1.5.6
type LogForStorage ¶ added in v1.5.6
type LogForStorage Log
LogForStorage is a wrapper around a Log that flattens and parses the entire content of a log including non-consensus fields.
type Message ¶ added in v1.5.0
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 ¶ added in v1.5.0
func (Message) CheckNonce ¶ added in v1.5.0
type Receipt ¶
type Receipt struct { // Consensus fields PostState []byte `json:"root" gencodec:"required"` CumulativeGasUsed *big.Int `json:"cumulativeGasUsed" gencodec:"required"` Bloom Bloom `json:"logsBloom" gencodec:"required"` Logs []*Log `json:"logs" gencodec:"required"` // Implementation fields (don't reorder!) TxHash common.Hash `json:"transactionHash" gencodec:"required"` ContractAddress common.Address `json:"contractAddress"` GasUsed *big.Int `json:"gasUsed" gencodec:"required"` }
Receipt represents the results of a transaction.
func NewReceipt ¶
NewReceipt creates a barebone transaction receipt, copying the init fields.
func (*Receipt) DecodeRLP ¶ added in v0.9.26
DecodeRLP implements rlp.Decoder, and loads the consensus fields of a receipt from an RLP stream.
func (*Receipt) EncodeRLP ¶ added in v0.9.17
EncodeRLP implements rlp.Encoder, and flattens the consensus fields of a receipt into an RLP stream.
func (Receipt) MarshalJSON ¶ added in v1.5.0
func (*Receipt) UnmarshalJSON ¶ added in v1.5.0
type ReceiptForStorage ¶ added in v0.9.26
type ReceiptForStorage Receipt
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.
type Receipts ¶
type Receipts []*Receipt
Receipts is a wrapper around a Receipt array to implement DerivableList.
type Signer ¶ added in v1.4.19
type Signer interface { // Hash returns the rlp encoded hash for signatures Hash(tx *Transaction) common.Hash // PubilcKey returns the public key derived from the signature PublicKey(tx *Transaction) ([]byte, error) // WithSignature returns a copy of the transaction with the given signature. // The signature must be encoded in [R || S || V] format where V is 0 or 1. WithSignature(tx *Transaction, sig []byte) (*Transaction, error) // Checks for equality on the signers Equal(Signer) bool }
func MakeSigner ¶ added in v1.4.19
func MakeSigner(config *params.ChainConfig, blockNumber *big.Int) Signer
MakeSigner returns a Signer based on the given chain config and block number.
type StorageBlock ¶ added in v0.9.17
type StorageBlock Block
[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.
type Transaction ¶
type Transaction struct {
// contains filtered or unexported fields
}
func NewContractCreation ¶ added in v0.9.34
func NewContractCreation(nonce uint64, amount, gasLimit, gasPrice *big.Int, data []byte) *Transaction
func NewTransaction ¶ added in v0.9.34
func SignTx ¶ added in v1.5.6
func SignTx(tx *Transaction, s Signer, prv *ecdsa.PrivateKey) (*Transaction, error)
SignTx signs the transaction using the given signer and private key
func (*Transaction) AsMessage ¶ added in v1.5.0
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 (*Transaction) ChainId ¶ added in v1.4.19
func (tx *Transaction) ChainId() *big.Int
ChainId returns which chain id this transaction was signed for (if at all)
func (*Transaction) CheckNonce ¶ added in v1.5.0
func (tx *Transaction) CheckNonce() bool
func (*Transaction) Cost ¶ added in v0.9.34
func (tx *Transaction) Cost() *big.Int
Cost returns amount + gasprice * gaslimit.
func (*Transaction) Data ¶
func (tx *Transaction) Data() []byte
func (*Transaction) DecodeRLP ¶ added in v0.9.34
func (tx *Transaction) DecodeRLP(s *rlp.Stream) error
DecodeRLP implements rlp.Decoder
func (*Transaction) EncodeRLP ¶ added in v0.9.34
func (tx *Transaction) EncodeRLP(w io.Writer) error
DecodeRLP implements rlp.Encoder
func (*Transaction) Gas ¶
func (tx *Transaction) Gas() *big.Int
func (*Transaction) GasPrice ¶
func (tx *Transaction) GasPrice() *big.Int
func (*Transaction) Hash ¶
func (tx *Transaction) Hash() common.Hash
Hash hashes the RLP encoding of tx. It uniquely identifies the transaction.
func (*Transaction) MarshalJSON ¶ added in v1.5.0
func (tx *Transaction) MarshalJSON() ([]byte, error)
func (*Transaction) Nonce ¶
func (tx *Transaction) Nonce() uint64
func (*Transaction) Protected ¶ added in v1.4.19
func (tx *Transaction) Protected() bool
Protected returns whether the transaction is protected from replay protection.
func (*Transaction) RawSignatureValues ¶ added in v1.4.19
func (*Transaction) SigHash ¶ added in v0.9.36
func (tx *Transaction) SigHash(signer Signer) common.Hash
SigHash returns the hash to be signed by the sender. It does not uniquely identify the transaction.
func (*Transaction) Size ¶ added in v0.9.30
func (tx *Transaction) Size() common.StorageSize
func (*Transaction) String ¶
func (tx *Transaction) String() string
func (*Transaction) To ¶
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 (*Transaction) UnmarshalJSON ¶ added in v1.5.0
func (tx *Transaction) UnmarshalJSON(input []byte) error
UnmarshalJSON decodes the web3 RPC transaction format.
func (*Transaction) Value ¶
func (tx *Transaction) Value() *big.Int
func (*Transaction) WithSignature ¶ added in v0.9.34
func (tx *Transaction) WithSignature(signer Signer, sig []byte) (*Transaction, error)
WithSignature returns a new transaction with the given signature. This signature needs to be formatted as described in the yellow paper (v+27).
type Transactions ¶
type Transactions []*Transaction
Transaction slice type for basic sorting.
func TxDifference ¶ added in v1.2.2
func TxDifference(a, b Transactions) (keep Transactions)
Returns a new set t which is the difference between a to b
func (Transactions) GetRlp ¶
func (s Transactions) GetRlp(i int) []byte
GetRlp implements Rlpable and returns the i'th element of s in rlp
func (Transactions) Swap ¶
func (s Transactions) Swap(i, j int)
Swap swaps the i'th and the j'th element in s
type TransactionsByPriceAndNonce ¶ added in v1.4.17
type TransactionsByPriceAndNonce struct {
// contains filtered or unexported fields
}
TransactionsByPriceAndNonce represents a set of transactions that can return transactions in a profit-maximising sorted order, while supporting removing entire batches of transactions for non-executable accounts.
func NewTransactionsByPriceAndNonce ¶ added in v1.4.17
func NewTransactionsByPriceAndNonce(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 providng it to the constructor.
func (*TransactionsByPriceAndNonce) Peek ¶ added in v1.4.17
func (t *TransactionsByPriceAndNonce) Peek() *Transaction
Peek returns the next transaction by price.
func (*TransactionsByPriceAndNonce) Pop ¶ added in v1.4.17
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 (*TransactionsByPriceAndNonce) Shift ¶ added in v1.4.17
func (t *TransactionsByPriceAndNonce) Shift()
Shift replaces the current best head with the next one from the same account.
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.
type TxByPrice ¶ added in v1.0.1
type TxByPrice Transactions
TxByPrice implements both the sort and the heap interface, making it useful for all at once sorting as well as individually adding and removing elements.