Documentation
¶
Overview ¶
Package types contains data types related to Ethereum consensus.
Index ¶
- Constants
- Variables
- func Bloom9(data []byte) []byte
- func BloomLookup(bin Bloom, topic bytesBacked) bool
- func CalcUncleHash(uncles []*Header) common.Hash
- func DeriveSha(list DerivableList, hasher TrieHasher) common.Hash
- func HeaderParentHashFromRLP(header []byte) common.Hash
- func LogsBloom(logs []*Log) []byte
- func Sender(signer Signer, tx *Transaction) (common.Address, error)
- type AccessList
- type AccessListTx
- type AccessTuple
- type Block
- func (b *Block) BaseFee() *big.Int
- 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) Difficulty() *big.Int
- func (b *Block) EncodeRLP(w io.Writer) error
- func (b *Block) Extra() []byte
- func (b *Block) GasLimit() uint64
- func (b *Block) GasUsed() uint64
- func (b *Block) Hash() 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) SanityCheck() error
- func (b *Block) Size() common.StorageSize
- func (b *Block) Time() uint64
- 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 BlockNonce
- type Blocks
- type Bloom
- type Body
- type DerivableList
- type DynamicFeeTx
- type EIP155Signer
- func (s EIP155Signer) ChainID() *big.Int
- func (s EIP155Signer) Equal(s2 Signer) bool
- func (s EIP155Signer) Hash(tx *Transaction) common.Hash
- func (s EIP155Signer) Sender(tx *Transaction) (common.Address, error)
- func (s EIP155Signer) SignatureValues(tx *Transaction, sig []byte) (R, S, V *big.Int, err error)
- type FrontierSigner
- func (s FrontierSigner) ChainID() *big.Int
- func (s FrontierSigner) Equal(s2 Signer) bool
- func (fs FrontierSigner) Hash(tx *Transaction) common.Hash
- func (fs FrontierSigner) Sender(tx *Transaction) (common.Address, error)
- func (fs FrontierSigner) SignatureValues(tx *Transaction, sig []byte) (r, s, v *big.Int, err error)
- type Header
- type HomesteadSigner
- type LegacyTx
- type Log
- type LogForStorage
- type Message
- func (m Message) AccessList() AccessList
- func (m Message) Data() []byte
- func (m Message) From() common.Address
- func (m Message) Gas() uint64
- func (m Message) GasFeeCap() *big.Int
- func (m Message) GasPrice() *big.Int
- func (m Message) GasTipCap() *big.Int
- func (m Message) IsFake() bool
- func (m Message) Nonce() uint64
- func (m Message) To() *common.Address
- func (m Message) Value() *big.Int
- type Receipt
- func (r *Receipt) DecodeRLP(s *rlp.Stream) error
- func (r *Receipt) EncodeRLP(w io.Writer) error
- func (r *Receipt) MarshalBinary() ([]byte, error)
- func (r Receipt) MarshalJSON() ([]byte, error)
- func (r *Receipt) Size() common.StorageSize
- func (r *Receipt) UnmarshalBinary(b []byte) error
- func (r *Receipt) UnmarshalJSON(input []byte) error
- type ReceiptForStorage
- type Receipts
- type Signer
- type StateAccount
- type Transaction
- func MustSignNewTx(prv *ecdsa.PrivateKey, s Signer, txdata TxData) *Transaction
- func NewContractCreation(nonce uint64, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte) *Transaction
- func NewTransaction(nonce uint64, to common.Address, amount *big.Int, gasLimit uint64, ...) *Transaction
- func NewTx(inner TxData) *Transaction
- func SignNewTx(prv *ecdsa.PrivateKey, s Signer, txdata TxData) (*Transaction, error)
- func SignTx(tx *Transaction, s Signer, prv *ecdsa.PrivateKey) (*Transaction, error)
- func (tx *Transaction) AccessList() AccessList
- func (tx *Transaction) AsMessage(s Signer, baseFee *big.Int) (Message, error)
- 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) EffectiveGasTip(baseFee *big.Int) (*big.Int, error)
- func (tx *Transaction) EffectiveGasTipCmp(other *Transaction, baseFee *big.Int) int
- func (tx *Transaction) EffectiveGasTipIntCmp(other *big.Int, baseFee *big.Int) int
- func (tx *Transaction) EffectiveGasTipValue(baseFee *big.Int) *big.Int
- func (tx *Transaction) EncodeRLP(w io.Writer) error
- func (tx *Transaction) Gas() uint64
- func (tx *Transaction) GasFeeCap() *big.Int
- func (tx *Transaction) GasFeeCapCmp(other *Transaction) int
- func (tx *Transaction) GasFeeCapIntCmp(other *big.Int) int
- func (tx *Transaction) GasPrice() *big.Int
- func (tx *Transaction) GasTipCap() *big.Int
- func (tx *Transaction) GasTipCapCmp(other *Transaction) int
- func (tx *Transaction) GasTipCapIntCmp(other *big.Int) int
- func (tx *Transaction) Hash() common.Hash
- func (tx *Transaction) MarshalBinary() ([]byte, error)
- func (t *Transaction) MarshalJSON() ([]byte, error)
- func (tx *Transaction) Nonce() uint64
- func (tx *Transaction) Protected() bool
- func (tx *Transaction) RawSignatureValues() (v, r, s *big.Int)
- func (tx *Transaction) Size() common.StorageSize
- func (tx *Transaction) To() *common.Address
- func (tx *Transaction) Type() uint8
- func (tx *Transaction) UnmarshalBinary(b []byte) error
- func (t *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 TrieHasher
- type TxByNonce
- type TxByPriceAndTime
- type TxData
- type TxWithMinerFee
Constants ¶
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 )
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) )
const ( LegacyTxType = iota AccessListTxType DynamicFeeTxType )
Transaction types.
Variables ¶
var ( EmptyRootHash = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421") EmptyUncleHash = rlpHash([]*Header(nil)) )
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") ErrGasFeeCapTooLow = errors.New("fee cap less than base fee") )
var ErrInvalidChainId = errors.New("invalid chain id for signer")
Functions ¶
func BloomLookup ¶
BloomLookup is a convenience-method to check presence int he bloom filter
func CalcUncleHash ¶ added in v0.9.34
func DeriveSha ¶
func DeriveSha(list DerivableList, hasher TrieHasher) common.Hash
DeriveSha creates the tree hashes of transactions and receipts in a block header.
func HeaderParentHashFromRLP ¶ added in v1.10.14
HeaderParentHashFromRLP returns the parentHash of an RLP-encoded header. If 'header' is invalid, the zero hash is returned.
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 AccessList ¶ added in v1.10.0
type AccessList []AccessTuple
AccessList is an EIP-2930 access list.
func (AccessList) StorageKeys ¶ added in v1.10.0
func (al AccessList) StorageKeys() int
StorageKeys returns the total number of storage keys in the access list.
type AccessListTx ¶ added in v1.10.0
type AccessListTx struct { ChainID *big.Int // destination chain ID Nonce uint64 // nonce of sender account GasPrice *big.Int // wei per gas Gas uint64 // gas limit To *common.Address `rlp:"nil"` // nil means contract creation Value *big.Int // wei amount Data []byte // contract invocation input data AccessList AccessList // EIP-2930 access list V, R, S *big.Int // signature values }
AccessListTx is the data of EIP-2930 access list transactions.
type AccessTuple ¶ added in v1.10.0
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 ¶ added in v1.10.0
func (a AccessTuple) MarshalJSON() ([]byte, error)
MarshalJSON marshals as JSON.
func (*AccessTuple) UnmarshalJSON ¶ added in v1.10.0
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 ¶ added in v0.8.4
func NewBlock(header *Header, txs []*Transaction, uncles []*Header, receipts []*Receipt, hasher TrieHasher) *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
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) 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) ParentHash ¶ added in v0.8.4
func (*Block) ReceiptHash ¶ added in v0.9.34
func (*Block) SanityCheck ¶ added in v1.9.0
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) Transaction ¶ added in v0.8.4
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 [BloomByteLength]byte
Bloom represents a 2048 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 ¶
CreateBloom creates a bloom filter out of the give Receipts (+Logs)
func (*Bloom) Add ¶ added in v1.3.1
Add adds d to the filter. Future calls of Test(d) will return true.
func (Bloom) Big ¶ added in v0.9.17
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) 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 ¶
DerivableList is the input to DeriveSha. It is implemented by the 'Transactions' and 'Receipts' types. This is internal, do not use these methods.
type DynamicFeeTx ¶ added in v1.10.4
type DynamicFeeTx struct { ChainID *big.Int Nonce uint64 GasTipCap *big.Int // a.k.a. maxPriorityFeePerGas GasFeeCap *big.Int // a.k.a. maxFeePerGas Gas uint64 To *common.Address `rlp:"nil"` // nil means contract creation Value *big.Int Data []byte AccessList AccessList // Signature values V *big.Int `json:"v" gencodec:"required"` R *big.Int `json:"r" gencodec:"required"` S *big.Int `json:"s" gencodec:"required"` }
type EIP155Signer ¶ added in v1.4.19
type EIP155Signer struct {
// contains filtered or unexported fields
}
EIP155Signer implements Signer using the EIP-155 rules. This accepts transactions which are replay-protected as well as unprotected homestead transactions.
func NewEIP155Signer ¶ added in v1.4.19
func NewEIP155Signer(chainId *big.Int) EIP155Signer
func (EIP155Signer) ChainID ¶ added in v1.10.0
func (s EIP155Signer) ChainID() *big.Int
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) Sender ¶ added in v1.7.1
func (s EIP155Signer) Sender(tx *Transaction) (common.Address, error)
func (EIP155Signer) SignatureValues ¶ added in v1.7.1
func (s EIP155Signer) SignatureValues(tx *Transaction, sig []byte) (R, S, V *big.Int, err error)
SignatureValues returns signature values. 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) ChainID ¶ added in v1.10.0
func (s FrontierSigner) ChainID() *big.Int
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 signed by the sender. It does not uniquely identify the transaction.
func (FrontierSigner) Sender ¶ added in v1.7.1
func (fs FrontierSigner) Sender(tx *Transaction) (common.Address, error)
func (FrontierSigner) SignatureValues ¶ added in v1.7.1
func (fs FrontierSigner) SignatureValues(tx *Transaction, sig []byte) (r, s, v *big.Int, err error)
SignatureValues returns signature values. This signature needs to be in the [R || S || V] format where V is 0 or 1.
type Header ¶ added in v0.8.4
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 was added by EIP-1559 and is ignored in legacy headers. BaseFee *big.Int `json:"baseFeePerGas" rlp:"optional"` }
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) EmptyBody ¶ added in v1.9.18
EmptyBody returns true if there is no additional 'body' to complete the header that is: no transactions and no uncles.
func (*Header) EmptyReceipts ¶ added in v1.9.18
EmptyReceipts returns true if there are no receipts for this header/block.
func (*Header) Hash ¶ added in v0.8.4
Hash returns the block hash of the header, which is simply the keccak256 hash of its RLP encoding.
func (Header) MarshalJSON ¶ added in v1.5.0
MarshalJSON marshals as JSON.
func (*Header) SanityCheck ¶ added in v1.9.0
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 ¶ added in v1.8.0
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 ¶ added in v0.9.28
UnmarshalJSON unmarshals from JSON.
type HomesteadSigner ¶ added in v1.4.19
type HomesteadSigner struct{ FrontierSigner }
HomesteadTransaction implements TransactionInterface using the homestead rules.
func (HomesteadSigner) ChainID ¶ added in v1.10.0
func (s HomesteadSigner) ChainID() *big.Int
func (HomesteadSigner) Equal ¶ added in v1.5.0
func (s HomesteadSigner) Equal(s2 Signer) bool
func (HomesteadSigner) Sender ¶ added in v1.7.1
func (hs HomesteadSigner) Sender(tx *Transaction) (common.Address, error)
func (HomesteadSigner) SignatureValues ¶ added in v1.7.1
func (hs HomesteadSigner) SignatureValues(tx *Transaction, sig []byte) (r, s, v *big.Int, err error)
SignatureValues returns signature values. This signature needs to be in the [R || S || V] format where V is 0 or 1.
type LegacyTx ¶ added in v1.10.0
type LegacyTx struct { Nonce uint64 // nonce of sender account GasPrice *big.Int // wei per gas Gas uint64 // gas limit To *common.Address `rlp:"nil"` // nil means contract creation Value *big.Int // wei amount Data []byte // contract invocation input data V, R, S *big.Int // signature values }
LegacyTx is the transaction data of regular Ethereum transactions.
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"` // hash of the block in which the transaction was included BlockHash common.Hash `json:"blockHash"` // index of the log in the block Index uint `json:"logIndex"` // 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
MarshalJSON marshals as JSON.
func (*Log) UnmarshalJSON ¶ added in v1.5.6
UnmarshalJSON unmarshals from JSON.
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) AccessList ¶ added in v1.10.0
func (m Message) AccessList() AccessList
type Receipt ¶
type Receipt struct { // Consensus fields: These fields are defined by the Yellow Paper Type uint8 `json:"type,omitempty"` PostState []byte `json:"root"` Status uint64 `json:"status"` CumulativeGasUsed uint64 `json:"cumulativeGasUsed" gencodec:"required"` Bloom Bloom `json:"logsBloom" gencodec:"required"` Logs []*Log `json:"logs" gencodec:"required"` // 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"` ContractAddress common.Address `json:"contractAddress"` GasUsed uint64 `json:"gasUsed" gencodec:"required"` // Inclusion information: These fields provide information about the inclusion of the // transaction corresponding to this receipt. BlockHash common.Hash `json:"blockHash,omitempty"` BlockNumber *big.Int `json:"blockNumber,omitempty"` TransactionIndex uint `json:"transactionIndex"` }
Receipt represents the results of a transaction.
func NewReceipt ¶
NewReceipt creates a barebone transaction receipt, copying the init fields. Deprecated: create receipts using a struct literal instead.
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. If no post state is present, byzantium fork is assumed.
func (*Receipt) MarshalBinary ¶ added in v1.10.10
MarshalBinary returns the consensus encoding of the receipt.
func (Receipt) MarshalJSON ¶ added in v1.5.0
MarshalJSON marshals as JSON.
func (*Receipt) Size ¶ added in v1.8.0
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) UnmarshalBinary ¶ added in v1.10.10
UnmarshalBinary decodes the consensus encoding of receipts. It supports legacy RLP receipts and EIP-2718 typed receipts.
func (*Receipt) UnmarshalJSON ¶ added in v1.5.0
UnmarshalJSON unmarshals from JSON.
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 implements DerivableList for receipts.
func (Receipts) DeriveFields ¶ added in v1.9.0
func (rs Receipts) DeriveFields(config *params.ChainConfig, hash common.Hash, number uint64, txs Transactions) error
DeriveFields fills the receipts with their computed fields based on consensus data and contextual infos like containing block and transactions.
func (Receipts) EncodeIndex ¶ added in v1.10.0
EncodeIndex encodes the i'th receipt to w.
type Signer ¶ added in v1.4.19
type Signer interface { // Sender returns the sender address of the transaction. Sender(tx *Transaction) (common.Address, error) // SignatureValues returns the raw R, S, V values corresponding to the // given signature. SignatureValues(tx *Transaction, sig []byte) (r, s, v *big.Int, err error) ChainID() *big.Int // Hash returns 'signature hash', i.e. the transaction hash that is signed by the // private key. This hash does not uniquely identify the transaction. Hash(tx *Transaction) common.Hash // Equal returns true if the given signer is the same as the receiver. Equal(Signer) bool }
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 ¶ added in v1.10.0
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 ¶ added in v1.10.0
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 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.
func NewEIP2930Signer ¶ added in v1.10.0
NewEIP2930Signer returns a signer that accepts EIP-2930 access list transactions, EIP-155 replay protected transactions, and legacy Homestead transactions.
func NewLondonSigner ¶ added in v1.10.4
NewLondonSigner returns a signer that accepts - EIP-1559 dynamic fee transactions - EIP-2930 access list transactions, - EIP-155 replay protected transactions, and - legacy Homestead transactions.
type StateAccount ¶ added in v1.10.9
type StateAccount struct { Nonce uint64 Balance *big.Int Root common.Hash // merkle root of the storage trie CodeHash []byte }
StateAccount is the Ethereum consensus representation of accounts. These objects are stored in the main account trie.
type Transaction ¶
type Transaction struct {
// contains filtered or unexported fields
}
Transaction is an Ethereum transaction.
func MustSignNewTx ¶ added in v1.10.0
func MustSignNewTx(prv *ecdsa.PrivateKey, s Signer, txdata TxData) *Transaction
MustSignNewTx creates a transaction and signs it. This panics if the transaction cannot be signed.
func NewContractCreation ¶ added in v0.9.34
func NewContractCreation(nonce uint64, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte) *Transaction
NewContractCreation creates an unsigned legacy transaction. Deprecated: use NewTx instead.
func NewTransaction ¶ added in v0.9.34
func NewTransaction(nonce uint64, to common.Address, amount *big.Int, gasLimit uint64, gasPrice *big.Int, data []byte) *Transaction
NewTransaction creates an unsigned legacy transaction. Deprecated: use NewTx instead.
func NewTx ¶ added in v1.10.0
func NewTx(inner TxData) *Transaction
NewTx creates a new transaction.
func SignNewTx ¶ added in v1.10.0
func SignNewTx(prv *ecdsa.PrivateKey, s Signer, txdata TxData) (*Transaction, error)
SignNewTx creates a transaction and signs it.
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) AccessList ¶ added in v1.10.0
func (tx *Transaction) AccessList() AccessList
AccessList returns the access list of the transaction.
func (*Transaction) AsMessage ¶ added in v1.5.0
AsMessage returns the transaction as a core.Message.
func (*Transaction) ChainId ¶ added in v1.4.19
func (tx *Transaction) ChainId() *big.Int
ChainId returns the EIP155 chain ID of the transaction. The return value will always be non-nil. For legacy transactions which are not replay-protected, the return value is zero.
func (*Transaction) Cost ¶ added in v0.9.34
func (tx *Transaction) Cost() *big.Int
Cost returns gas * gasPrice + value.
func (*Transaction) Data ¶
func (tx *Transaction) Data() []byte
Data returns the input data of the transaction.
func (*Transaction) DecodeRLP ¶ added in v0.9.34
func (tx *Transaction) DecodeRLP(s *rlp.Stream) error
DecodeRLP implements rlp.Decoder
func (*Transaction) EffectiveGasTip ¶ added in v1.10.4
EffectiveGasTip returns the effective miner gasTipCap for the given base fee. Note: if the effective gasTipCap is negative, this method returns both error the actual negative value, _and_ ErrGasFeeCapTooLow
func (*Transaction) EffectiveGasTipCmp ¶ added in v1.10.4
func (tx *Transaction) EffectiveGasTipCmp(other *Transaction, baseFee *big.Int) int
EffectiveGasTipCmp compares the effective gasTipCap of two transactions assuming the given base fee.
func (*Transaction) EffectiveGasTipIntCmp ¶ added in v1.10.4
EffectiveGasTipIntCmp compares the effective gasTipCap of a transaction to the given gasTipCap.
func (*Transaction) EffectiveGasTipValue ¶ added in v1.10.4
func (tx *Transaction) EffectiveGasTipValue(baseFee *big.Int) *big.Int
EffectiveGasTipValue is identical to EffectiveGasTip, but does not return an error in case the effective gasTipCap is negative
func (*Transaction) EncodeRLP ¶ added in v0.9.34
func (tx *Transaction) EncodeRLP(w io.Writer) error
EncodeRLP implements rlp.Encoder
func (*Transaction) Gas ¶
func (tx *Transaction) Gas() uint64
Gas returns the gas limit of the transaction.
func (*Transaction) GasFeeCap ¶ added in v1.10.4
func (tx *Transaction) GasFeeCap() *big.Int
GasFeeCap returns the fee cap per gas of the transaction.
func (*Transaction) GasFeeCapCmp ¶ added in v1.10.4
func (tx *Transaction) GasFeeCapCmp(other *Transaction) int
GasFeeCapCmp compares the fee cap of two transactions.
func (*Transaction) GasFeeCapIntCmp ¶ added in v1.10.4
func (tx *Transaction) GasFeeCapIntCmp(other *big.Int) int
GasFeeCapIntCmp compares the fee cap of the transaction against the given fee cap.
func (*Transaction) GasPrice ¶
func (tx *Transaction) GasPrice() *big.Int
GasPrice returns the gas price of the transaction.
func (*Transaction) GasTipCap ¶ added in v1.10.4
func (tx *Transaction) GasTipCap() *big.Int
GasTipCap returns the gasTipCap per gas of the transaction.
func (*Transaction) GasTipCapCmp ¶ added in v1.10.4
func (tx *Transaction) GasTipCapCmp(other *Transaction) int
GasTipCapCmp compares the gasTipCap of two transactions.
func (*Transaction) GasTipCapIntCmp ¶ added in v1.10.4
func (tx *Transaction) GasTipCapIntCmp(other *big.Int) int
GasTipCapIntCmp compares the gasTipCap of the transaction against the given gasTipCap.
func (*Transaction) Hash ¶
func (tx *Transaction) Hash() common.Hash
Hash returns the transaction hash.
func (*Transaction) MarshalBinary ¶ added in v1.10.0
func (tx *Transaction) MarshalBinary() ([]byte, 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 (*Transaction) MarshalJSON ¶ added in v1.5.0
func (t *Transaction) MarshalJSON() ([]byte, error)
MarshalJSON marshals as JSON with a hash.
func (*Transaction) Nonce ¶
func (tx *Transaction) Nonce() uint64
Nonce returns the sender account nonce of the transaction.
func (*Transaction) Protected ¶ added in v1.4.19
func (tx *Transaction) Protected() bool
Protected says whether the transaction is replay-protected.
func (*Transaction) RawSignatureValues ¶ added in v1.4.19
func (tx *Transaction) RawSignatureValues() (v, r, s *big.Int)
RawSignatureValues returns the V, R, S signature values of the transaction. The return values should not be modified by the caller.
func (*Transaction) Size ¶ added in v0.9.28
func (tx *Transaction) Size() common.StorageSize
Size returns the true RLP encoded storage size of the transaction, either by encoding and returning it, or returning a previously cached value.
func (*Transaction) To ¶
func (tx *Transaction) To() *common.Address
To returns the recipient address of the transaction. For contract-creation transactions, To returns nil.
func (*Transaction) Type ¶ added in v1.10.0
func (tx *Transaction) Type() uint8
Type returns the transaction type.
func (*Transaction) UnmarshalBinary ¶ added in v1.10.0
func (tx *Transaction) UnmarshalBinary(b []byte) error
UnmarshalBinary decodes the canonical encoding of transactions. It supports legacy RLP transactions and EIP2718 typed transactions.
func (*Transaction) UnmarshalJSON ¶ added in v1.5.0
func (t *Transaction) UnmarshalJSON(input []byte) error
UnmarshalJSON unmarshals from JSON.
func (*Transaction) Value ¶
func (tx *Transaction) Value() *big.Int
Value returns the ether amount of the transaction.
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 in the [R || S || V] format where V is 0 or 1.
type Transactions ¶
type Transactions []*Transaction
Transactions implements DerivableList for transactions.
func TxDifference ¶ added in v1.2.2
func TxDifference(a, b Transactions) Transactions
TxDifference returns a new set which is the difference between a and b.
func (Transactions) EncodeIndex ¶ added in v1.10.0
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.
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-maximizing sorted order, while supporting removing entire batches of transactions for non-executable accounts.
func NewTransactionsByPriceAndNonce ¶ added in v1.4.17
func NewTransactionsByPriceAndNonce(signer Signer, txs map[common.Address]Transactions, baseFee *big.Int) *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) 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 TrieHasher ¶ added in v1.10.0
TrieHasher is the tool used to calculate the hash of derivable list. This is internal, do not use.
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 TxByPriceAndTime ¶ added in v1.9.19
type TxByPriceAndTime []*TxWithMinerFee
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 ¶ added in v1.9.19
func (s TxByPriceAndTime) Len() int
func (TxByPriceAndTime) Less ¶ added in v1.9.19
func (s TxByPriceAndTime) Less(i, j int) bool
func (*TxByPriceAndTime) Pop ¶ added in v1.9.19
func (s *TxByPriceAndTime) Pop() interface{}
func (*TxByPriceAndTime) Push ¶ added in v1.9.19
func (s *TxByPriceAndTime) Push(x interface{})
func (TxByPriceAndTime) Swap ¶ added in v1.9.19
func (s TxByPriceAndTime) Swap(i, j int)
type TxData ¶ added in v1.10.0
type TxData interface {
// contains filtered or unexported methods
}
TxData is the underlying data of a transaction.
This is implemented by DynamicFeeTx, LegacyTx and AccessListTx.
type TxWithMinerFee ¶ added in v1.10.4
type TxWithMinerFee struct {
// contains filtered or unexported fields
}
TxWithMinerFee wraps a transaction with its gas price or effective miner gasTipCap
func NewTxWithMinerFee ¶ added in v1.10.4
func NewTxWithMinerFee(tx *Transaction, baseFee *big.Int) (*TxWithMinerFee, error)
NewTxWithMinerFee creates a wrapped transaction, calculating the effective miner gasTipCap if a base fee is provided. Returns error in case of a negative effective miner gasTipCap.