Documentation ¶
Overview ¶
Package types contains data types related to Ethereum consensus.
Index ¶
- Variables
- func BloomLookup(bin Bloom, topic []byte) bool
- func CalcUncleHash(uncles []*Header) common.Hash
- func DeriveSha(list DerivableList) common.Hash
- func LogsBloom(logs vm.Logs) *big.Int
- func Number(b1, b2 *Block) bool
- func Sender(signer Signer, tx *Transaction) (common.Address, error)
- func SignatureValues(signer Signer, tx *Transaction) (v byte, r *big.Int, s *big.Int)
- func SortByPriceAndNonce(txs []*Transaction)
- type BasicSigner
- func (s BasicSigner) Equal(s2 Signer) bool
- func (fs BasicSigner) Hash(tx *Transaction) common.Hash
- func (fs BasicSigner) PublicKey(tx *Transaction) ([]byte, error)
- func (fs BasicSigner) SignECDSA(tx *Transaction, prv *ecdsa.PrivateKey) (*Transaction, error)
- func (fs BasicSigner) WithSignature(tx *Transaction, sig []byte) (*Transaction, 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) ValidateFields() error
- func (b *Block) WithBody(transactions []*Transaction, uncles []*Header) *Block
- func (b *Block) WithMiningResult(nonce uint64, mixDigest common.Hash) *Block
- type BlockBy
- type BlockNonce
- type Blocks
- type Bloom
- type Body
- type ChainIdSigner
- func (s ChainIdSigner) Equal(s2 Signer) bool
- func (s ChainIdSigner) Hash(tx *Transaction) common.Hash
- func (s ChainIdSigner) PublicKey(tx *Transaction) ([]byte, error)
- func (s ChainIdSigner) SigECDSA(tx *Transaction, prv *ecdsa.PrivateKey) (*Transaction, error)
- func (s ChainIdSigner) SignECDSA(tx *Transaction, prv *ecdsa.PrivateKey) (*Transaction, error)
- func (s ChainIdSigner) WithSignature(tx *Transaction, sig []byte) (*Transaction, error)
- type DerivableList
- type Header
- type Log
- type LogForStorage
- type Receipt
- type ReceiptForStorage
- type ReceiptStatus
- type Receipts
- type Signer
- type StorageBlock
- type Transaction
- func (tx *Transaction) ChainId() *big.Int
- 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) From() (common.Address, error)
- func (tx *Transaction) Gas() *big.Int
- func (tx *Transaction) GasPrice() *big.Int
- func (tx *Transaction) Hash() common.Hash
- func (tx *Transaction) Nonce() uint64
- func (tx *Transaction) Protected() bool
- func (tx *Transaction) RawSignatureValues() (v *big.Int, r *big.Int, s *big.Int)
- func (tx *Transaction) SetSigner(s Signer)
- func (tx *Transaction) SigHash() common.Hash
- func (tx *Transaction) SignECDSA(prv *ecdsa.PrivateKey) (*Transaction, error)
- func (tx *Transaction) SignatureValues() (v byte, r *big.Int, s *big.Int)
- func (tx *Transaction) Size() common.StorageSize
- func (tx *Transaction) String() string
- func (tx *Transaction) To() *common.Address
- func (tx *Transaction) Value() *big.Int
- func (tx *Transaction) WithSignature(sig []byte) (*Transaction, error)
- func (tx *Transaction) WithSigner(signer Signer) *Transaction
- type Transactions
- 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 chain id for signer")
var ErrInvalidSig = errors.New("invalid v, r, s values")
var HeaderExtraMax = 32
HeaderExtraMax is the byte size limit for Header.Extra.
Functions ¶
func BloomLookup ¶
func CalcUncleHash ¶
func DeriveSha ¶
func DeriveSha(list DerivableList) common.Hash
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 ¶
SignatureValues returns the ECDSA signature values contained in the transaction.
func SortByPriceAndNonce ¶
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 ¶
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 ¶
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 ¶
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) HashNoNonce ¶
func (*Block) ParentHash ¶
func (*Block) ReceiptHash ¶
func (*Block) Size ¶
func (b *Block) Size() common.StorageSize
func (*Block) Transaction ¶
func (b *Block) Transaction(hash common.Hash) *Transaction
func (*Block) Transactions ¶
func (b *Block) Transactions() Transactions
func (*Block) ValidateFields ¶
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
func (BlockNonce) MarshalJSON ¶
func (n BlockNonce) MarshalJSON() ([]byte, error)
func (BlockNonce) Uint64 ¶
func (n BlockNonce) Uint64() uint64
type Bloom ¶
type Bloom [bloomLength]byte
func BytesToBloom ¶
func CreateBloom ¶
func (Bloom) MarshalJSON ¶
type Body ¶
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 Header ¶
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 ¶
CopyHeader creates a deep copy of a block header to prevent side effects from modifying a header variable.
func (*Header) HashNoNonce ¶
func (*Header) UnmarshalJSON ¶
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.
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.
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 ¶
NewReceipt creates a barebone transaction receipt, copying the init fields.
func (*Receipt) DecodeRLP ¶
DecodeRLP implements rlp.Decoder, and loads the consensus fields of a receipt from an RLP stream.
func (*Receipt) EncodeRLP ¶
EncodeRLP implements rlp.Encoder, and flattens the consensus fields of a receipt into an RLP stream.
type ReceiptForStorage ¶
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 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.
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 ¶
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 ¶
func NewContractCreation(nonce uint64, amount, gasLimit, gasPrice *big.Int, data []byte) *Transaction
func NewTransaction ¶
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 ¶
func (tx *Transaction) Cost() *big.Int
Cost returns amount + gasprice * gaslimit.
func (*Transaction) Data ¶
func (tx *Transaction) Data() []byte
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 (*Transaction) SetSigner ¶
func (tx *Transaction) SetSigner(s Signer)
func (*Transaction) SigHash ¶
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 ¶
func (tx *Transaction) SignECDSA(prv *ecdsa.PrivateKey) (*Transaction, error)
func (*Transaction) SignatureValues ¶
func (*Transaction) Size ¶
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 ¶
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 ¶
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) 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.
type TxByPrice ¶
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.