types

package
v0.0.0-...-215623d Latest Latest
Warning

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

 Go to latest Published: May 20, 2021 License: GPL-3.0 Imports: 30 Imported by: 0

Documentation

Overview

Package types contains data types related to Ethereum consensus.

Index

Constants

View Source 
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
)
View Source 
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)
)
View Source 
const (
	LegacyTxType = iota
	AccessListTxType
	DynamicFeeTxType
)

Transaction types.

Variables

View Source 
var (
	EmptyRootHash  = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
	EmptyUncleHash = rlpHash([]*Header(nil))
)
View Source 
var (
	ErrInvalidSig           = errors.New("invalid transaction v, r, s values")
	ErrUnexpectedProtection = errors.New("transaction type does not supported EIP-155 protected signatures")
	ErrInvalidTxType        = errors.New("transaction type not valid in this context")
	ErrTxTypeNotSupported   = errors.New("transaction type not supported")
)
View Source 
var ErrInvalidChainId = errors.New("invalid chain id for signer")

Functions

func Bloom9 

func Bloom9(data []byte) []byte

Bloom9 returns the bloom filter for the given data

func BloomLookup 

func BloomLookup(bin Bloom, topic bytesBacked) bool

BloomLookup is a convenience-method to check presence int he bloom filter

func CalcUncleHash 

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

func DeriveChainId 

func DeriveChainId(v *uint256.Int) *uint256.Int

deriveChainID derives the chain id from the given v parameter

func DeriveSha 

func DeriveSha(list DerivableList) common.Hash

func EncodeString 

func EncodeString(s []byte, w io.Writer, b []byte) error

func EncodeStringSizePrefix 

func EncodeStringSizePrefix(size int, w io.Writer, b []byte) error

func EncodeStructSizePrefix 

func EncodeStructSizePrefix(size int, w io.Writer, b []byte) error

func LogsBloom 

func LogsBloom(logs []*Log) []byte

LogsBloom returns the bloom bytes for the given logs

func MarshalTransactionsBinary 

func MarshalTransactionsBinary(txs Transactions) ([][]byte, error)

Types

type AccessList 

type AccessList []AccessTuple

AccessList is an EIP-2930 access list.

func (AccessList) StorageKeys 

func (al AccessList) StorageKeys() int

StorageKeys returns the total number of storage keys in the access list.

type AccessListTx 

type AccessListTx struct {
	LegacyTx
	ChainID    *uint256.Int
	AccessList AccessList // EIP-2930 access list
}

AccessListTx is the data of EIP-2930 access list transactions.

func (AccessListTx) AsMessage 

func (tx AccessListTx) AsMessage(s Signer, _ *big.Int) (Message, error)

AsMessage returns the transaction as a core.Message.

func (*AccessListTx) DecodeRLP 

func (tx *AccessListTx) DecodeRLP(s *rlp.Stream) error

func (AccessListTx) EncodeRLP 

func (tx AccessListTx) EncodeRLP(w io.Writer) error

EncodeRLP implements rlp.Encoder

func (AccessListTx) EncodingSize 

func (tx AccessListTx) EncodingSize() int

EncodingSize returns the RLP encoding size of the whole transaction envelope

func (AccessListTx) GetAccessList 

func (tx AccessListTx) GetAccessList() AccessList

func (AccessListTx) GetChainID 

func (tx AccessListTx) GetChainID() *uint256.Int

func (AccessListTx) GetSender 

func (tx AccessListTx) GetSender() (common.Address, bool)

func (AccessListTx) Hash 

func (tx AccessListTx) Hash() common.Hash

Hash computes the hash (but not for signatures!)

func (AccessListTx) MarshalBinary 

func (tx AccessListTx) MarshalBinary(w io.Writer) error

MarshalBinary returns the canonical encoding of the transaction. For legacy transactions, it returns the RLP encoding. For EIP-2718 typed transactions, it returns the type and payload.

func (AccessListTx) MarshalJSON 

func (tx AccessListTx) MarshalJSON() ([]byte, error)

func (AccessListTx) Protected 

func (tx AccessListTx) Protected() bool

func (AccessListTx) RawSignatureValues 

func (tx AccessListTx) RawSignatureValues() (*uint256.Int, *uint256.Int, *uint256.Int)

func (*AccessListTx) Sender 

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

func (*AccessListTx) SetSender 

func (tx *AccessListTx) SetSender(addr common.Address)

func (AccessListTx) SigningHash 

func (tx AccessListTx) SigningHash(chainID *big.Int) common.Hash

func (*AccessListTx) Size 

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

func (AccessListTx) Type 

func (tx AccessListTx) Type() byte

func (*AccessListTx) UnmarshalJSON 

func (tx *AccessListTx) UnmarshalJSON(input []byte) error

func (*AccessListTx) WithSignature 

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

type AccessTuple 

type AccessTuple struct {
	Address     common.Address `json:"address"        gencodec:"required"`
	StorageKeys []common.Hash  `json:"storageKeys"    gencodec:"required"`
}

AccessTuple is the element type of an access list.

func (AccessTuple) MarshalJSON 

func (a AccessTuple) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*AccessTuple) UnmarshalJSON 

func (a *AccessTuple) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

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 

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 

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

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

func (*Block) Bloom 

func (b *Block) Bloom() Bloom

func (*Block) Body 

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 

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

DecodeRLP decodes the Ethereum

func (*Block) DeprecatedTd 

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 

func (bb Block) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Ethereum RLP block format.

func (Block) EncodingSize 

func (bb Block) EncodingSize() int

func (*Block) Extra 

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

func (*Block) GasLimit 

func (b *Block) GasLimit() uint64

func (*Block) GasUsed 

func (b *Block) GasUsed() uint64

func (*Block) Hash 

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

Hash returns the keccak256 hash of b's header. The hash is computed on the first call and cached thereafter.

func (*Block) Header 

func (b *Block) Header() *Header

func (*Block) MixDigest 

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 

func (b *Block) NumberU64() uint64

func (*Block) ParentHash 

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

func (*Block) RawBody 

func (b *Block) RawBody() *RawBody

RawBody creates a RawBody based on the block. It is not very efficient, so will probably be removed in favour of RawBlock. Also it panics

func (*Block) ReceiptHash 

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

func (*Block) Root 

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

func (*Block) SanityCheck 

func (b *Block) SanityCheck() error

SanityCheck can be used to prevent that unbounded fields are stuffed with junk data to add processing overhead

func (*Block) Size 

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 (*Block) Time 

func (b *Block) Time() uint64

func (*Block) Transaction 

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

func (*Block) Transactions 

func (b *Block) Transactions() Transactions

func (*Block) TxHash 

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

func (*Block) UncleHash 

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

func (*Block) Uncles 

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

func (*Block) WithBody 

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

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

func (*Block) WithSeal 

func (b *Block) WithSeal(header *Header) *Block

WithSeal returns a new block with the data from b but the header replaced with the sealed one.

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

EncodeNonce converts the given integer to a block nonce.

func (BlockNonce) MarshalText 

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

MarshalText encodes n as a hex string with 0x prefix.

func (BlockNonce) Uint64 

func (n BlockNonce) Uint64() uint64

Uint64 returns the integer value of a block nonce.

func (*BlockNonce) UnmarshalText 

func (n *BlockNonce) UnmarshalText(input []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Blocks 

type Blocks []*Block

type Bloom 

type Bloom [BloomByteLength]byte

Bloom represents a 2048 bit bloom filter.

func BytesToBloom 

func BytesToBloom(b []byte) Bloom

BytesToBloom converts a byte slice to a bloom filter. It panics if b is not of suitable size.

func CreateBloom 

func CreateBloom(receipts Receipts) Bloom

func (*Bloom) Add 

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

Add adds d to the filter. Future calls of Test(d) will return true.

func (Bloom) Big 

func (b Bloom) Big() *big.Int

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

func (Bloom) Bytes 

func (b Bloom) Bytes() []byte

Bytes returns the backing byte slice of the bloom

func (Bloom) MarshalText 

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

MarshalText encodes b as a hex string with 0x prefix.

func (*Bloom) SetBytes 

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

SetBytes sets the content of b to the given bytes. It panics if d is not of suitable size.

func (Bloom) Test 

func (b Bloom) Test(topic []byte) bool

Test checks if the given topic is present in the bloom filter

func (*Bloom) UnmarshalText 

func (b *Bloom) UnmarshalText(input []byte) error

UnmarshalText b as a hex string with 0x prefix.

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.

func (*Body) DecodeRLP 

func (bb *Body) DecodeRLP(s *rlp.Stream) error

func (Body) EncodeRLP 

func (bb Body) EncodeRLP(w io.Writer) error

func (Body) EncodingSize 

func (bb Body) EncodingSize() int

func (*Body) SendersFromTxs 

func (b *Body) SendersFromTxs() []common.Address

Copy transaction senders from transactions to the body

func (*Body) SendersToTxs 

func (b *Body) SendersToTxs(senders []common.Address)

Copy transaction senders from body into the transactions

type BodyForStorage 

type BodyForStorage struct {
	BaseTxId uint64
	TxAmount uint32
	Uncles   []*Header
}

type CommonTx 

type CommonTx struct {
	TransactionMisc
	Nonce   uint64          // nonce of sender account
	Gas     uint64          // gas limit
	To      *common.Address `rlp:"nil"` // nil means contract creation
	Value   *uint256.Int    // wei amount
	Data    []byte          // contract invocation input data
	V, R, S uint256.Int     // signature values
}

func (CommonTx) GetData 

func (ct CommonTx) GetData() []byte

func (CommonTx) GetGas 

func (ct CommonTx) GetGas() uint64

func (CommonTx) GetNonce 

func (ct CommonTx) GetNonce() uint64

func (CommonTx) GetTo 

func (ct CommonTx) GetTo() *common.Address

func (CommonTx) GetValue 

func (ct CommonTx) GetValue() *uint256.Int

type DerivableList 

type DerivableList interface {
	Len() int
	EncodeIndex(i int, w *bytes.Buffer)
}

type DynamicFeeTransaction 

type DynamicFeeTransaction struct {
	CommonTx
	ChainID    *uint256.Int
	Tip        *uint256.Int
	FeeCap     *uint256.Int
	AccessList AccessList
}

func (DynamicFeeTransaction) AsMessage 

func (tx DynamicFeeTransaction) AsMessage(s Signer, baseFee *big.Int) (Message, error)

AsMessage returns the transaction as a core.Message.

func (DynamicFeeTransaction) Cost 

func (tx DynamicFeeTransaction) Cost() *uint256.Int

func (*DynamicFeeTransaction) DecodeRLP 

func (tx *DynamicFeeTransaction) DecodeRLP(s *rlp.Stream) error

func (DynamicFeeTransaction) EncodeRLP 

func (tx DynamicFeeTransaction) EncodeRLP(w io.Writer) error

func (DynamicFeeTransaction) EncodingSize 

func (tx DynamicFeeTransaction) EncodingSize() int

func (DynamicFeeTransaction) GetAccessList 

func (tx DynamicFeeTransaction) GetAccessList() AccessList

func (DynamicFeeTransaction) GetChainID 

func (tx DynamicFeeTransaction) GetChainID() *uint256.Int

func (DynamicFeeTransaction) GetPrice 

func (tx DynamicFeeTransaction) GetPrice() *uint256.Int

func (DynamicFeeTransaction) GetSender 

func (tx DynamicFeeTransaction) GetSender() (common.Address, bool)

func (DynamicFeeTransaction) Hash 

func (tx DynamicFeeTransaction) Hash() common.Hash

Hash computes the hash (but not for signatures!)

func (DynamicFeeTransaction) MarshalBinary 

func (tx DynamicFeeTransaction) MarshalBinary(w io.Writer) error

MarshalBinary returns the canonical encoding of the transaction. For legacy transactions, it returns the RLP encoding. For EIP-2718 typed transactions, it returns the type and payload.

func (DynamicFeeTransaction) MarshalJSON 

func (tx DynamicFeeTransaction) MarshalJSON() ([]byte, error)

func (DynamicFeeTransaction) Protected 

func (tx DynamicFeeTransaction) Protected() bool

func (DynamicFeeTransaction) RawSignatureValues 

func (tx DynamicFeeTransaction) RawSignatureValues() (*uint256.Int, *uint256.Int, *uint256.Int)

func (*DynamicFeeTransaction) Sender 

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

func (*DynamicFeeTransaction) SetSender 

func (tx *DynamicFeeTransaction) SetSender(addr common.Address)

func (DynamicFeeTransaction) SigningHash 

func (tx DynamicFeeTransaction) SigningHash(chainID *big.Int) common.Hash

func (*DynamicFeeTransaction) Size 

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

func (DynamicFeeTransaction) Type 

func (tx DynamicFeeTransaction) Type() byte

accessors for innerTx.

func (*DynamicFeeTransaction) UnmarshalJSON 

func (tx *DynamicFeeTransaction) UnmarshalJSON(input []byte) error

func (*DynamicFeeTransaction) WithSignature 

func (tx *DynamicFeeTransaction) WithSignature(signer Signer, sig []byte) (Transaction, error)
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"`
	BaseFee     *big.Int       `json:"baseFee"`
	Eip1559     bool           // to avoid relying on BaseFee != nil for that
}

Header represents a block header in the Ethereum blockchain. DESCRIBED: docs/programmers_guide/guide.md#organising-ethereum-state-into-a-merkle-tree

func CopyHeader 

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

func (h *Header) DecodeRLP(s *rlp.Stream) error

func (*Header) EmptyBody 

func (h *Header) EmptyBody() bool

EmptyBody returns true if there is no additional 'body' to complete the header that is: no transactions and no uncles.

func (*Header) EmptyReceipts 

func (h *Header) EmptyReceipts() bool

EmptyReceipts returns true if there are no receipts for this header/block.

func (Header) EncodeRLP 

func (h Header) EncodeRLP(w io.Writer) error

func (Header) EncodingSize 

func (h Header) EncodingSize() int

func (*Header) Hash 

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

Hash returns the block hash of the header, which is simply the keccak256 hash of its RLP encoding.

func (Header) MarshalJSON 

func (h Header) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Header) SanityCheck 

func (h *Header) SanityCheck() error

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 (*Header) Size 

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.

func (*Header) UnmarshalJSON 

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

UnmarshalJSON unmarshals from JSON.

type LegacyTx 

type LegacyTx struct {
	CommonTx
	GasPrice *uint256.Int // wei per gas
}

LegacyTx is the transaction data of regular Ethereum transactions.

func NewContractCreation 

func NewContractCreation(nonce uint64, amount *uint256.Int, gasLimit uint64, gasPrice *uint256.Int, data []byte) *LegacyTx

NewContractCreation creates an unsigned legacy transaction. Deprecated: use NewTx instead.

func NewTransaction 

func NewTransaction(nonce uint64, to common.Address, amount *uint256.Int, gasLimit uint64, gasPrice *uint256.Int, data []byte) *LegacyTx

NewTransaction creates an unsigned legacy transaction. Deprecated: use NewTx instead.

func (LegacyTx) AsMessage 

func (tx LegacyTx) AsMessage(s Signer, _ *big.Int) (Message, error)

AsMessage returns the transaction as a core.Message.

func (LegacyTx) Cost 

func (tx LegacyTx) Cost() *uint256.Int

func (*LegacyTx) DecodeRLP 

func (tx *LegacyTx) DecodeRLP(s *rlp.Stream, encodingSize uint64) error

DecodeRLP decodes LegacyTx but with the list token already consumed and encodingSize being presented

func (LegacyTx) EncodeRLP 

func (tx LegacyTx) EncodeRLP(w io.Writer) error

func (LegacyTx) EncodingSize 

func (tx LegacyTx) EncodingSize() int

func (LegacyTx) GetAccessList 

func (tx LegacyTx) GetAccessList() AccessList

func (LegacyTx) GetChainID 

func (tx LegacyTx) GetChainID() *uint256.Int

func (LegacyTx) GetPrice 

func (tx LegacyTx) GetPrice() *uint256.Int

func (LegacyTx) GetSender 

func (tx LegacyTx) GetSender() (common.Address, bool)

func (LegacyTx) Hash 

func (tx LegacyTx) Hash() common.Hash

Hash computes the hash (but not for signatures!)

func (LegacyTx) MarshalBinary 

func (tx LegacyTx) MarshalBinary(w io.Writer) error

func (LegacyTx) MarshalJSON 

func (tx LegacyTx) MarshalJSON() ([]byte, error)

func (LegacyTx) Protected 

func (tx LegacyTx) Protected() bool

func (LegacyTx) RawSignatureValues 

func (tx LegacyTx) RawSignatureValues() (*uint256.Int, *uint256.Int, *uint256.Int)

func (*LegacyTx) Sender 

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

func (*LegacyTx) SetSender 

func (tx *LegacyTx) SetSender(addr common.Address)

func (LegacyTx) SigningHash 

func (tx LegacyTx) SigningHash(chainID *big.Int) common.Hash

func (*LegacyTx) Size 

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

func (LegacyTx) Type 

func (tx LegacyTx) Type() byte

func (*LegacyTx) UnmarshalJSON 

func (tx *LegacyTx) UnmarshalJSON(input []byte) error

func (*LegacyTx) WithSignature 

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

type Log 

type Log struct {
	// Consensus fields:
	// address of the contract that generated the event
	Address common.Address `json:"address" gencodec:"required" codec:"1"`
	// list of topics provided by the contract.
	Topics []common.Hash `json:"topics" gencodec:"required" codec:"2"`
	// supplied by the contract, usually ABI-encoded
	Data []byte `json:"data" gencodec:"required" codec:"3"`

	// 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" codec:"-"`
	// hash of the transaction
	TxHash common.Hash `json:"transactionHash" gencodec:"required" codec:"-"`
	// index of the transaction in the block
	TxIndex uint `json:"transactionIndex" codec:"-"`
	// hash of the block in which the transaction was included
	BlockHash common.Hash `json:"blockHash" codec:"-"`
	// index of the log in the block
	Index uint `json:"logIndex" codec:"-"`

	// 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" codec:"-"`
}

Log represents a contract log event. These events are generated by the LOG opcode and stored/indexed by the node.

func (*Log) CodecDecodeSelf 

func (x *Log) CodecDecodeSelf(d *codec1978.Decoder)

func (*Log) CodecEncodeSelf 

func (x *Log) CodecEncodeSelf(e *codec1978.Encoder)

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

func (x *Log) IsCodecEmpty() bool

func (Log) MarshalJSON 

func (l Log) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Log) UnmarshalJSON 

func (l *Log) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

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.

Note some redundant fields(e.g. block number, tx hash etc) will be assembled later.

func (*LogForStorage) EncodeRLP 

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

EncodeRLP implements rlp.Encoder.

type Logs 

type Logs []*Log

func (*Logs) CodecDecodeSelf 

func (x *Logs) CodecDecodeSelf(d *codec1978.Decoder)

func (Logs) CodecEncodeSelf 

func (x Logs) CodecEncodeSelf(e *codec1978.Encoder)

type Message 

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 

func NewMessage(from common.Address, to *common.Address, nonce uint64, amount *uint256.Int, gasLimit uint64, gasPrice *uint256.Int, feeCap, tip *uint256.Int, data []byte, accessList AccessList, checkNonce bool) Message

func (Message) AccessList 

func (m Message) AccessList() AccessList

func (Message) CheckNonce 

func (m Message) CheckNonce() bool

func (Message) Data 

func (m Message) Data() []byte

func (Message) FeeCap 

func (m Message) FeeCap() *uint256.Int

func (Message) From 

func (m Message) From() common.Address

func (Message) Gas 

func (m Message) Gas() uint64

func (Message) GasPrice 

func (m Message) GasPrice() *uint256.Int

func (Message) Nonce 

func (m Message) Nonce() uint64

func (Message) Tip 

func (m Message) Tip() *uint256.Int

func (Message) To 

func (m Message) To() *common.Address

func (Message) Value 

func (m Message) Value() *uint256.Int

type RawBody 

type RawBody struct {
	Transactions [][]byte
	Uncles       []*Header
}

RawBody is semi-parsed variant of Body, where transactions are still unparsed RLP strings It is useful in the situations when actual transaction context is not important, for example when downloading Block bodies from other peers or serving them to other peers

func (*RawBody) DecodeRLP 

func (rb *RawBody) DecodeRLP(s *rlp.Stream) error

func (RawBody) EncodeRLP 

func (rb RawBody) EncodeRLP(w io.Writer) error

func (RawBody) EncodingSize 

func (rb RawBody) EncodingSize() int

type Receipt 

type Receipt struct {
	// Consensus fields: These fields are defined by the Yellow Paper
	Type              uint8  `json:"type,omitempty"`
	PostState         []byte `json:"root" codec:"1"`
	Status            uint64 `json:"status" codec:"2"`
	CumulativeGasUsed uint64 `json:"cumulativeGasUsed" gencodec:"required" codec:"3"`
	Bloom             Bloom  `json:"logsBloom"         gencodec:"required" codec:"-"`
	Logs              Logs   `json:"logs"              gencodec:"required" codec:"-"`

	// 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" codec:"-"`
	ContractAddress common.Address `json:"contractAddress" codec:"-"`
	GasUsed         uint64         `json:"gasUsed" gencodec:"required" codec:"-"`

	// Inclusion information: These fields provide information about the inclusion of the
	// transaction corresponding to this receipt.
	BlockHash        common.Hash `json:"blockHash,omitempty" codec:"-"`
	BlockNumber      *big.Int    `json:"blockNumber,omitempty" codec:"-"`
	TransactionIndex uint        `json:"transactionIndex" codec:"-"`
}

Receipt represents the results of a transaction. DESCRIBED: docs/programmers_guide/guide.md#organising-ethereum-state-into-a-merkle-tree

func NewReceipt 

func NewReceipt(failed bool, cumulativeGasUsed uint64) *Receipt

NewReceipt creates a barebone transaction receipt, copying the init fields. Deprecated: create receipts using a struct literal instead.

func (*Receipt) CodecDecodeSelf 

func (x *Receipt) CodecDecodeSelf(d *codec1978.Decoder)

func (*Receipt) CodecEncodeSelf 

func (x *Receipt) CodecEncodeSelf(e *codec1978.Encoder)

func (*Receipt) DecodeRLP 

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 

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

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.

func (*Receipt) IsCodecEmpty 

func (x *Receipt) IsCodecEmpty() bool

func (Receipt) MarshalJSON 

func (r Receipt) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Receipt) Size 

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.

func (*Receipt) UnmarshalJSON 

func (r *Receipt) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

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.

func (*ReceiptForStorage) DecodeRLP 

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 

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 Receipts 

type Receipts []*Receipt

Receipts implements DerivableList for receipts.

func (*Receipts) CodecDecodeSelf 

func (x *Receipts) CodecDecodeSelf(d *codec1978.Decoder)

func (Receipts) CodecEncodeSelf 

func (x Receipts) CodecEncodeSelf(e *codec1978.Encoder)

func (Receipts) DeriveFields 

func (r Receipts) DeriveFields(hash common.Hash, number uint64, txs Transactions, senders []common.Address) error

DeriveFields fills the receipts with their computed fields based on consensus data and contextual infos like containing block and transactions.

func (Receipts) EncodeIndex 

func (rs Receipts) EncodeIndex(i int, w *bytes.Buffer)

EncodeIndex encodes the i'th receipt to w.

func (Receipts) Len 

func (rs Receipts) Len() int

Len returns the number of receipts in this list.

type ReceiptsForStorage 

type ReceiptsForStorage []*ReceiptForStorage

type Signer 

type Signer struct {
	// contains filtered or unexported fields
}

Signer encapsulates transaction signature handling. The name of this type is slightly misleading because Signers don't actually sign, they're just for validating and processing of signatures.

Note that this interface is not a stable API and may change at any time to accommodate new protocol rules.

func LatestSigner 

func LatestSigner(config *params.ChainConfig) *Signer

LatestSigner returns the 'most permissive' Signer available for the given chain configuration. Specifically, this enables support of EIP-155 replay protection and EIP-2930 access list transactions when their respective forks are scheduled to occur at any block number in the chain config.

Use this in transaction-handling code where the current block number is unknown. If you have the current block number available, use MakeSigner instead.

func LatestSignerForChainID 

func LatestSignerForChainID(chainID *big.Int) *Signer

LatestSignerForChainID returns the 'most permissive' Signer available. Specifically, this enables support for EIP-155 replay protection and all implemented EIP-2718 transaction types if chainID is non-nil.

Use this in transaction-handling code where the current block number and fork configuration are unknown. If you have a ChainConfig, use LatestSigner instead. If you have a ChainConfig and know the current block number, use MakeSigner instead.

func MakeFrontierSigner 

func MakeFrontierSigner() *Signer

func MakeSigner 

func MakeSigner(config *params.ChainConfig, blockNumber uint64) *Signer

MakeSigner returns a Signer based on the given chain config and block number.

func (Signer) ChainID 

func (sg Signer) ChainID() *uint256.Int

func (Signer) Equal 

func (sg Signer) Equal(other Signer) bool

Equal returns true if the given signer is the same as the receiver.

func (Signer) Sender 

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

Sender returns the sender address of the transaction.

func (Signer) SenderWithContext 

func (sg Signer) SenderWithContext(context *secp256k1.Context, tx Transaction) (common.Address, error)

SenderWithContext returns the sender address of the transaction.

func (Signer) SignatureValues 

func (sg Signer) SignatureValues(tx Transaction, sig []byte) (R, S, V *uint256.Int, err error)

SignatureValues returns the raw R, S, V values corresponding to the given signature.

func (Signer) String 

func (sg Signer) String() string

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.

func (*StorageBlock) DecodeRLP 

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

[deprecated by eth/63]

type Transaction 

type Transaction interface {
	Type() byte
	GetChainID() *uint256.Int
	GetNonce() uint64
	GetPrice() *uint256.Int
	Cost() *uint256.Int
	GetGas() uint64
	GetValue() *uint256.Int
	Time() time.Time
	GetTo() *common.Address
	AsMessage(s Signer, baseFee *big.Int) (Message, error)
	WithSignature(signer Signer, sig []byte) (Transaction, error)
	Hash() common.Hash
	SigningHash(chainID *big.Int) common.Hash
	Size() common.StorageSize
	GetData() []byte
	GetAccessList() AccessList
	Protected() bool
	RawSignatureValues() (*uint256.Int, *uint256.Int, *uint256.Int)
	MarshalBinary(w io.Writer) 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.
	Sender(Signer) (common.Address, error)
	GetSender() (common.Address, bool)
	SetSender(common.Address)
}

Transaction is an Ethereum transaction.

func DecodeTransaction 

func DecodeTransaction(s *rlp.Stream) (Transaction, error)

func MustSignNewTx 

func MustSignNewTx(prv *ecdsa.PrivateKey, s Signer, tx Transaction) Transaction

MustSignNewTx creates a transaction and signs it. This panics if the transaction cannot be signed.

func SignNewTx 

func SignNewTx(prv *ecdsa.PrivateKey, s Signer, tx Transaction) (Transaction, error)

SignNewTx creates a transaction and signs it.

func SignTx 

func SignTx(tx Transaction, s Signer, prv *ecdsa.PrivateKey) (Transaction, error)

SignTx signs the transaction using the given signer and private key.

func UnmarshalTransactionFromBinary 

func UnmarshalTransactionFromBinary(data []byte) (Transaction, error)

func UnmarshalTransactionFromJSON 

func UnmarshalTransactionFromJSON(input []byte) (Transaction, error)

func UnmarshalTransactionsFromBinary 

func UnmarshalTransactionsFromBinary(txs [][]byte) ([]Transaction, error)

type TransactionMisc 

type TransactionMisc struct {
	// contains filtered or unexported fields
}

TransactionMisc is collection of miscelaneous fields for transaction that is supposed to be embedded into concrete implementations of different transaction types

func (TransactionMisc) From 

func (tm TransactionMisc) From() *atomic.Value

func (TransactionMisc) Time 

func (tm TransactionMisc) Time() time.Time

type Transactions 

type Transactions []Transaction

Transactions implements DerivableList for transactions.

func TxDifference 

func TxDifference(a, b Transactions) Transactions

TxDifference returns a new set which is the difference between a and b.

func (Transactions) EncodeIndex 

func (s Transactions) EncodeIndex(i int, w *bytes.Buffer)

EncodeIndex encodes the i'th transaction to w. Note that this does not check for errors because we assume that *Transaction will only ever contain valid txs that were either constructed by decoding or via public API in this package.

func (Transactions) Len 

func (s Transactions) Len() int

Len returns the length of s.

type TransactionsByPriceAndNonce 

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 

func NewTransactionsByPriceAndNonce(signer Signer, txs TransactionsGroupedBySender) *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 (*TransactionsByPriceAndNonce) Empty 

func (t *TransactionsByPriceAndNonce) Empty() bool

func (*TransactionsByPriceAndNonce) Peek 

func (t *TransactionsByPriceAndNonce) Peek() Transaction

Peek returns the next transaction by price.

func (*TransactionsByPriceAndNonce) Pop 

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 

func (t *TransactionsByPriceAndNonce) Shift()

Shift replaces the current best head with the next one from the same account.

type TransactionsFixedOrder 

type TransactionsFixedOrder struct {
	Transactions
}

TransactionsFixedOrder 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 NewTransactionsFixedOrder 

func NewTransactionsFixedOrder(txs Transactions) *TransactionsFixedOrder

NewTransactionsFixedOrder 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 (*TransactionsFixedOrder) Empty 

func (t *TransactionsFixedOrder) Empty() bool

func (*TransactionsFixedOrder) Peek 

func (t *TransactionsFixedOrder) Peek() Transaction

Peek returns the next transaction by price.

func (*TransactionsFixedOrder) Pop 

func (t *TransactionsFixedOrder) 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 (*TransactionsFixedOrder) Shift 

func (t *TransactionsFixedOrder) Shift()

Shift replaces the current best head with the next one from the same account.

type TransactionsGroupedBySender 

type TransactionsGroupedBySender []Transactions

TransactionsGroupedBySender - lists of transactions grouped by sender

type TransactionsStream 

type TransactionsStream interface {
	Empty() bool
	Peek() Transaction
	Shift()
	Pop()
}

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 

func (s TxByNonce) Len() int

func (TxByNonce) Less 

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

func (TxByNonce) Swap 

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

type TxByPriceAndTime 

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 (TxByPriceAndTime) Len 

func (s TxByPriceAndTime) Len() int

func (TxByPriceAndTime) Less 

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

func (*TxByPriceAndTime) Pop 

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

func (*TxByPriceAndTime) Push 

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

func (TxByPriceAndTime) Swap 

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

Source Files

View all Source files

Directories

Path Synopsis

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.