types

package
v5.5.2+incompatible Latest Latest
Warning

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

 Go to latest Published: Nov 8, 2018 License: GPL-3.0 Imports: 19 Imported by: 82

Documentation

Overview

Package types contains data types related to Ethereum consensus.

Index

Constants

This section is empty.

Variables

View Source 
var (
	EmptyRootHash  = DeriveSha(Transactions{})
	EmptyUncleHash = CalcUncleHash(nil)
)
View Source 
var Bloom9 = bloom9
View Source 
var ErrInvalidChainId = errors.New("invalid chain id for signer")
View Source 
var ErrInvalidSig = errors.New("invalid v, r, s values")
View Source 
var HeaderExtraMax = 32

HeaderExtraMax is the byte size limit for Header.Extra.

Functions

func BloomLookup 

func BloomLookup(bin Bloom, topic []byte) bool

func CalcUncleHash added in v0.9.34 

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

func DeriveSha 

func DeriveSha(list DerivableList) common.Hash

func LogsBloom 

func LogsBloom(logs vm.Logs) *big.Int

func Number 

func Number(b1, b2 *Block) bool

func Sender 

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

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

From may cache the address, allowing it to be used regardless of signing method.

func SignatureValues 

func SignatureValues(signer Signer, tx *Transaction) (v byte, r *big.Int, s *big.Int)

SignatureValues returns the ECDSA signature values contained in the transaction.

func SortByPriceAndNonce added in v1.3.4 

func SortByPriceAndNonce(txs []*Transaction)

SortByPriceAndNonce sorts the transactions by price in such a way that the nonce orderings within a single account are maintained.

Note, this is not as trivial as it seems from the first look as there are three different criteria that need to be taken into account (price, nonce, account match), which cannot be done with any plain sorting method, as certain items cannot be compared without context.

This method first sorts the separates the list of transactions into individual sender accounts and sorts them by nonce. After the account nonce ordering is satisfied, the results are merged back together by price, always comparing only the head transaction from each account. This is done via a heap to keep it fast.

Types

type BasicSigner 

type BasicSigner struct{}

func (BasicSigner) Equal 

func (s BasicSigner) Equal(s2 Signer) bool

func (BasicSigner) Hash 

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

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

func (BasicSigner) PublicKey 

func (fs BasicSigner) PublicKey(tx *Transaction) ([]byte, error)

func (BasicSigner) SignECDSA 

func (fs BasicSigner) SignECDSA(tx *Transaction, prv *ecdsa.PrivateKey) (*Transaction, error)

func (BasicSigner) WithSignature 

func (fs BasicSigner) WithSignature(tx *Transaction, sig []byte) (*Transaction, error)

WithSignature returns a new transaction with the given snature. This snature needs to be formatted as described in the yellow paper (v+27).

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
}

func NewBlock added in v0.8.4 

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

func NewBlockWithHeader(header *Header) *Block

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

func (*Block) Bloom added in v0.8.4 

func (b *Block) Bloom() Bloom

func (*Block) Body added in v1.4.0 

func (b *Block) Body() *Body

Body returns the non-header content of the block.

func (*Block) Coinbase 

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

func (*Block) DecodeRLP added in v0.8.4 

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

func (*Block) DeprecatedTd added in v1.2.2 

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

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 (b *Block) Difficulty() *big.Int

func (*Block) EncodeRLP added in v0.9.17 

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

func (*Block) Extra 

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

func (*Block) GasLimit 

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

func (*Block) GasUsed 

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

func (*Block) Hash 

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

func (*Block) HashNoNonce 

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

func (*Block) Header added in v0.8.4 

func (b *Block) Header() *Header

func (*Block) MixDigest added in v0.9.17 

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

func (*Block) Nonce 

func (b *Block) Nonce() uint64

func (*Block) Number 

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

func (*Block) NumberU64 added in v0.8.4 

func (b *Block) NumberU64() uint64

func (*Block) ParentHash added in v0.8.4 

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

func (*Block) ReceiptHash added in v0.9.34 

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

func (*Block) Root 

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

func (*Block) Size 

func (b *Block) Size() common.StorageSize

func (*Block) String 

func (b *Block) String() string

func (*Block) Time 

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

func (*Block) Transaction added in v0.8.4 

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

func (*Block) Transactions 

func (b *Block) Transactions() Transactions

func (*Block) TxHash added in v0.9.34 

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

func (*Block) UncleHash added in v0.9.34 

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

func (*Block) Uncles 

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

TODO: copies

func (*Block) ValidateFields added in v0.9.17 

func (b *Block) ValidateFields() error

func (*Block) WithBody added in v1.2.2 

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

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

func (*Block) WithMiningResult added in v0.9.34 

func (b *Block) WithMiningResult(nonce uint64, mixDigest common.Hash) *Block

WithMiningResult returns a new block with the data from b where nonce and mix digest are set to the provided values.

type BlockBy 

type BlockBy func(b1, b2 *Block) bool

func (BlockBy) Sort 

func (self BlockBy) Sort(blocks Blocks)

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

func (BlockNonce) MarshalJSON added in v1.4.0 

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

func (BlockNonce) Uint64 added in v0.9.34 

func (n BlockNonce) Uint64() uint64

type Blocks 

type Blocks []*Block

type Bloom added in v0.9.17 

type Bloom [bloomLength]byte

func BytesToBloom added in v0.9.17 

func BytesToBloom(b []byte) Bloom

func CreateBloom 

func CreateBloom(receipts Receipts) Bloom

func (*Bloom) Add added in v1.3.1 

func (b *Bloom) Add(d *big.Int)

func (Bloom) Bytes added in v0.9.17 

func (b Bloom) Bytes() []byte

func (Bloom) MarshalJSON added in v1.4.0 

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

func (*Bloom) SetBytes added in v0.9.17 

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

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 ChainIdSigner 

type ChainIdSigner struct {
	BasicSigner
	// contains filtered or unexported fields
}

EIP155Transaction implements TransactionInterface using the EIP155 rules

func NewChainIdSigner 

func NewChainIdSigner(chainId *big.Int) ChainIdSigner

func (ChainIdSigner) Equal 

func (s ChainIdSigner) Equal(s2 Signer) bool

func (ChainIdSigner) Hash 

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

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

func (ChainIdSigner) PublicKey 

func (s ChainIdSigner) PublicKey(tx *Transaction) ([]byte, error)

func (ChainIdSigner) SigECDSA 

func (s ChainIdSigner) SigECDSA(tx *Transaction, prv *ecdsa.PrivateKey) (*Transaction, error)

func (ChainIdSigner) SignECDSA 

func (s ChainIdSigner) SignECDSA(tx *Transaction, prv *ecdsa.PrivateKey) (*Transaction, error)

func (ChainIdSigner) WithSignature 

func (s ChainIdSigner) WithSignature(tx *Transaction, 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 DerivableList 

type DerivableList interface {
	Len() int
	GetRlp(i int) []byte
}
type Header struct {
	ParentHash  common.Hash    // Hash to the previous block
	UncleHash   common.Hash    // Uncles of this block
	Coinbase    common.Address // The coin base address
	Root        common.Hash    // Block Trie state
	TxHash      common.Hash    // Tx sha
	ReceiptHash common.Hash    // Receipt sha
	Bloom       Bloom          // Bloom
	Difficulty  *big.Int       // Difficulty for the current block
	Number      *big.Int       // The block number
	GasLimit    *big.Int       // Gas limit
	GasUsed     *big.Int       // Gas used
	Time        *big.Int       // Creation time
	Extra       []byte         // Freeform descriptor
	MixDigest   common.Hash    // for quick difficulty verification
	Nonce       BlockNonce
}

func CopyHeader added in v1.3.1 

func CopyHeader(h *Header) *Header

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

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

func (*Header) HashNoNonce added in v0.8.4 

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

func (*Header) String added in v0.8.4 

func (h *Header) String() string

func (*Header) UnmarshalJSON added in v0.9.28 

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

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"`
	// 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) DecodeRLP 

func (l *Log) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder.

func (*Log) EncodeRLP 

func (l *Log) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder.

func (*Log) String 

func (l *Log) String() string

type LogForStorage 

type LogForStorage Log

LogForStorage is a wrapper around a Log that flattens and parses the entire content of a log including non-consensus fields.

func (*LogForStorage) DecodeRLP 

func (l *LogForStorage) DecodeRLP(s *rlp.Stream) error

DecodeRLP implements rlp.Decoder.

func (*LogForStorage) EncodeRLP 

func (l *LogForStorage) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder.

type Receipt 

type Receipt struct {
	// Consensus fields
	PostState         []byte
	CumulativeGasUsed *big.Int
	Bloom             Bloom
	Logs              vm.Logs

	// Implementation fields
	TxHash          common.Hash
	ContractAddress common.Address
	GasUsed         *big.Int
	Status          ReceiptStatus
}

Receipt represents the results of a transaction.

func NewReceipt 

func NewReceipt(root []byte, cumulativeGasUsed *big.Int) *Receipt

NewReceipt creates a barebone transaction receipt, copying the init fields.

func (*Receipt) DecodeRLP added in v0.9.26 

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

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

func (*Receipt) EncodeRLP added in v0.9.17 

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

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

func (*Receipt) RlpEncode 

func (r *Receipt) RlpEncode() []byte

RlpEncode implements common.RlpEncode required for SHA3 derivation.

func (*Receipt) String 

func (r *Receipt) String() string

String implements the Stringer interface.

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.

func (*ReceiptForStorage) DecodeRLP added in v1.3.1 

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

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

func (*ReceiptForStorage) EncodeRLP added in v0.9.26 

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

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

type ReceiptStatus 

type ReceiptStatus byte
const (
	TxFailure       ReceiptStatus = 0
	TxSuccess       ReceiptStatus = 1
	TxStatusUnknown ReceiptStatus = 0xFF
)

type Receipts 

type Receipts []*Receipt

Receipts is a wrapper around a Receipt array to implement types.DerivableList.

func (Receipts) GetRlp 

func (r Receipts) GetRlp(i int) []byte

GetRlp returns the RLP encoding of one receipt from the list.

func (Receipts) Len 

func (r Receipts) Len() int

Len returns the number of receipts in this list.

type Signer 

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)
	// SignECDSA signs the transaction with the given and returns a copy of the tx
	SignECDSA(tx *Transaction, prv *ecdsa.PrivateKey) (*Transaction, error)
	// WithSignature returns a copy of the transaction with the given signature
	WithSignature(tx *Transaction, sig []byte) (*Transaction, error)
	// Checks for equality on the signers
	Equal(Signer) bool
}

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.

func (*StorageBlock) DecodeRLP added in v0.9.17 

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

[deprecated by eth/63]

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 NewTransaction(nonce uint64, to common.Address, amount, gasLimit, gasPrice *big.Int, data []byte) *Transaction

func (*Transaction) ChainId 

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

ChainId returns which chain id this transaction was signed for (if at all)

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

func (*Transaction) EncodeRLP added in v0.9.34 

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

func (*Transaction) From 

func (tx *Transaction) From() (common.Address, error)

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

func (tx *Transaction) Nonce() uint64

func (*Transaction) Protected 

func (tx *Transaction) Protected() bool

Protected returns whether the transaction is protected from replay protection

func (*Transaction) RawSignatureValues 

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

func (*Transaction) SetSigner 

func (tx *Transaction) SetSigner(s Signer)

func (*Transaction) SigHash added in v0.9.36 

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

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

func (*Transaction) SignECDSA added in v0.8.4 

func (tx *Transaction) SignECDSA(prv *ecdsa.PrivateKey) (*Transaction, error)

func (*Transaction) SignatureValues added in v0.9.34 

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

func (*Transaction) Size added in v0.9.28 

func (tx *Transaction) Size() common.StorageSize

func (*Transaction) String 

func (tx *Transaction) String() string

func (*Transaction) To 

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

func (*Transaction) Value 

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

func (*Transaction) WithSignature added in v0.9.34 

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

func (*Transaction) WithSigner 

func (tx *Transaction) WithSigner(signer Signer) *Transaction

type Transactions 

type Transactions []*Transaction

Transaction slice type for basic sorting.

func TxDifference added in v1.2.2 

func TxDifference(a, b Transactions) (diff 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) Len 

func (s Transactions) Len() int

Len returns the length of s

func (Transactions) Swap 

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

Swap swaps the i'th and the j'th element in s

type TxByNonce 

type TxByNonce Transactions

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

func (TxByNonce) Len added in v1.3.4 

func (s TxByNonce) Len() int

func (TxByNonce) Less 

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

func (TxByNonce) Swap added in v1.3.4 

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

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

func (TxByPrice) Len added in v1.3.4 

func (s TxByPrice) Len() int

func (TxByPrice) Less added in v1.0.1 

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

func (*TxByPrice) Pop added in v1.3.4 

func (s *TxByPrice) Pop() interface{}

func (*TxByPrice) Push added in v1.3.4 

func (s *TxByPrice) Push(x interface{})

func (TxByPrice) Swap added in v1.3.4 

func (s TxByPrice) Swap(i, j 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.