types

package
v0.15.0-rc.3 Latest Latest
Warning

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

Go to latest
Published: Sep 8, 2023 License: GPL-3.0 Imports: 23 Imported by: 12

Documentation

Overview

Package types contains data types related to Quai 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 (
	InternalTxType = iota
	ExternalTxType
	InternalToExternalTxType
)

Transaction types.

Variables

View Source
var (
	EmptyRootHash  = common.HexToHash("56e81f171bcc55a6ff8345e692c0f86e5b48e01b996cadc001622fb5e363b421")
	EmptyUncleHash = RlpHash([]*Header(nil))
	EmptyBodyHash  = common.HexToHash("51e1b9c1426a03bf73da3d98d9f384a49ded6a4d705dcdf25433915c3306826c")
)
View Source
var (
	ErrInvalidSig         = errors.New("invalid transaction v, r, s values")
	ErrExpectedProtection = errors.New("transaction signature is not protected")
	ErrTxTypeNotSupported = errors.New("transaction type not supported")
	ErrGasFeeCapTooLow    = errors.New("fee cap less than base fee")
)
View Source
var (
	ErrUnsupportedTxType = errors.New("tx type is not supported by this signer")
	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 DeriveSha

func DeriveSha(list DerivableList, hasher TrieHasher) common.Hash

DeriveSha creates the tree hashes of transactions and receipts in a block header.

func LogsBloom

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

LogsBloom returns the bloom bytes for the given logs

func RlpHash

func RlpHash(x interface{}) (h common.Hash)

RlpHash encodes x and hashes the encoded bytes.

func Sender

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

type AccessList []AccessTuple

AccessList is an access list.

func (AccessList) StorageKeys

func (al AccessList) StorageKeys() int

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

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 Quai blockchain.

func NewBlock

func NewBlock(header *Header, txs []*Transaction, uncles []*Header, etxs []*Transaction, subManifest BlockManifest, receipts []*Receipt, hasher TrieHasher) *Block

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) 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 (b *Block) DecodeRLP(s *rlp.Stream) error

DecodeRLP decodes the Quai RLP encoding into b.

func (*Block) Difficulty

func (b *Block) Difficulty(args ...int) *big.Int

func (*Block) EncodeRLP

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

EncodeRLP serializes b into the Quai RLP block format.

func (*Block) EtxHash

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

func (*Block) EtxRollupHash

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

func (*Block) ExtTransaction

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

func (*Block) ExtTransactions

func (b *Block) ExtTransactions() Transactions

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

func (b *Block) GetAppendTime() time.Duration

GetAppendTime returns the appendTime of the block The appendTime is computed on the first call and cached thereafter.

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

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

func (*Block) ManifestHash

func (b *Block) ManifestHash(args ...int) common.Hash

func (*Block) Nonce

func (b *Block) Nonce() BlockNonce

func (*Block) NonceU64

func (b *Block) NonceU64() uint64

func (*Block) Number

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

func (*Block) NumberU64

func (b *Block) NumberU64(args ...int) uint64

func (*Block) ParentDeltaS

func (b *Block) ParentDeltaS(args ...int) *big.Int

func (*Block) ParentEntropy

func (b *Block) ParentEntropy(args ...int) *big.Int

func (*Block) ParentHash

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

Wrapped header accessors

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

func (b *Block) SetAppendTime(appendTime time.Duration)

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

func (b *Block) SubManifest() BlockManifest

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, extTransactions []*Transaction, subManifest BlockManifest) *Block

WithBody returns a new block with the given transaction and uncle contents, for a single context

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 BlockManifest

type BlockManifest []common.Hash

BlockManifest is a list of block hashes, which implements DerivableList

func (BlockManifest) EncodeIndex

func (m BlockManifest) EncodeIndex(i int, w *bytes.Buffer)

EncodeIndex encodes the i'th blockhash to w.

func (BlockManifest) Len

func (m BlockManifest) Len() int

Len returns the length of s.

func (BlockManifest) Size

func (m BlockManifest) 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.

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

func (n BlockNonce) Bytes() []byte

Bytes() returns the raw bytes of the 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

CreateBloom creates a bloom filter out of the give Receipts (+Logs)

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
	ExtTransactions []*Transaction
	SubManifest     BlockManifest
}

Body is a simple (mutable, non-safe) data container for storing and moving a block's data contents (transactions and uncles) together.

type DerivableList

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

DerivableList is the input to DeriveSha. It is implemented by the 'Transactions' and 'Receipts' types. This is internal, do not use these methods.

type EtxSet

type EtxSet map[common.Hash]EtxSetEntry

The EtxSet maps an ETX hash to the ETX and block number in which it became available. If no entry exists for a given ETX hash, then that ETX is not available.

func NewEtxSet

func NewEtxSet() EtxSet

func (*EtxSet) Update

func (set *EtxSet) Update(newInboundEtxs Transactions, currentHeight uint64)

updateInboundEtxs updates the set of inbound ETXs available to be mined into a block in this location. This method adds any new ETXs to the set and removes expired ETXs.

type EtxSetEntry

type EtxSetEntry struct {
	Height uint64
	ETX    Transaction
}

type ExternalTx

type ExternalTx struct {
	ChainID    *big.Int
	Nonce      uint64
	GasTipCap  *big.Int
	GasFeeCap  *big.Int
	Gas        uint64
	To         *common.Address `rlp:"nilString"` // nil means contract creation
	Value      *big.Int
	Data       []byte
	AccessList AccessList
	Sender     common.Address
}

type HashAndLocation

type HashAndLocation struct {
	Hash     common.Hash
	Location common.Location
}

type HashAndNumber

type HashAndNumber struct {
	Hash   common.Hash
	Number uint64
}
type Header struct {
	PowHash   atomic.Value
	PowDigest atomic.Value
	// contains filtered or unexported fields
}

Header represents a block header in the Quai blockchain.

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 EmptyHeader

func EmptyHeader() *Header

Construct an empty header

func (*Header) BaseFee

func (h *Header) BaseFee() *big.Int

func (*Header) Coinbase

func (h *Header) Coinbase() common.Address

func (*Header) DecodeRLP

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

DecodeRLP decodes the Quai header format into h.

func (*Header) Difficulty

func (h *Header) Difficulty() *big.Int

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

func (h *Header) EmptyEtxRollup() bool

EmptyEtxs returns true if there are no etxs for this header/block.

func (*Header) EmptyEtxs

func (h *Header) EmptyEtxs() bool

EmptyEtxs returns true if there are no etxs for this header/block.

func (*Header) EmptyManifest

func (h *Header) EmptyManifest() bool

EmptyTxs returns true if there are no txs for this header/block.

func (*Header) EmptyReceipts

func (h *Header) EmptyReceipts() bool

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

func (*Header) EmptyTxs

func (h *Header) EmptyTxs() bool

EmptyTxs returns true if there are no txs for this header/block.

func (*Header) EmptyUncles

func (h *Header) EmptyUncles() bool

EmptyUncles returns true if there are no uncles for this header/block.

func (*Header) EncodeRLP

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

EncodeRLP serializes h into the Quai RLP block format.

func (*Header) EtxHash

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

func (*Header) EtxRollupHash

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

func (*Header) Extra

func (h *Header) Extra() []byte

func (*Header) GasLimit

func (h *Header) GasLimit() uint64

func (*Header) GasUsed

func (h *Header) GasUsed() uint64

func (*Header) Hash

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

Hash returns the nonce'd hash of the header. This is just the Blake3 hash of SealHash suffixed with a nonce.

func (*Header) Location

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

func (*Header) ManifestHash

func (h *Header) ManifestHash(args ...int) common.Hash

func (*Header) ManifestHashArray

func (h *Header) ManifestHashArray() []common.Hash

func (Header) MarshalJSON

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

MarshalJSON marshals as JSON.

func (*Header) MixHash

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

func (*Header) Nonce

func (h *Header) Nonce() BlockNonce

func (*Header) NonceU64

func (h *Header) NonceU64() uint64

func (*Header) Number

func (h *Header) Number(args ...int) *big.Int

func (*Header) NumberArray

func (h *Header) NumberArray() []*big.Int

func (*Header) NumberU64

func (h *Header) NumberU64(args ...int) uint64

func (*Header) ParentDeltaS

func (h *Header) ParentDeltaS(args ...int) *big.Int

func (*Header) ParentEntropy

func (h *Header) ParentEntropy(args ...int) *big.Int

func (*Header) ParentHash

func (h *Header) ParentHash(args ...int) common.Hash

Localized accessors

func (*Header) ParentHashArray

func (h *Header) ParentHashArray() []common.Hash

Array accessors

func (*Header) RPCMarshalHeader

func (h *Header) RPCMarshalHeader() map[string]interface{}

RPCMarshalHeader converts the given header to the RPC output .

func (*Header) ReceiptHash

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

func (*Header) Root

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

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

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

SealHash returns the hash of a block prior to it being sealed.

func (*Header) SetBaseFee

func (h *Header) SetBaseFee(val *big.Int)

func (*Header) SetCoinbase

func (h *Header) SetCoinbase(val common.Address)

func (*Header) SetDifficulty

func (h *Header) SetDifficulty(val *big.Int)

func (*Header) SetEtxHash

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

func (*Header) SetEtxRollupHash

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

func (*Header) SetExtra

func (h *Header) SetExtra(val []byte)

func (*Header) SetGasLimit

func (h *Header) SetGasLimit(val uint64)

func (*Header) SetGasUsed

func (h *Header) SetGasUsed(val uint64)

func (*Header) SetLocation

func (h *Header) SetLocation(val common.Location)

func (*Header) SetManifestHash

func (h *Header) SetManifestHash(val common.Hash, args ...int)

func (*Header) SetMixHash

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

func (*Header) SetNonce

func (h *Header) SetNonce(val BlockNonce)

func (*Header) SetNumber

func (h *Header) SetNumber(val *big.Int, args ...int)

func (*Header) SetParentDeltaS

func (h *Header) SetParentDeltaS(val *big.Int, args ...int)

func (*Header) SetParentEntropy

func (h *Header) SetParentEntropy(val *big.Int, args ...int)

func (*Header) SetParentHash

func (h *Header) SetParentHash(val common.Hash, args ...int)

func (*Header) SetReceiptHash

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

func (*Header) SetRoot

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

func (*Header) SetTime

func (h *Header) SetTime(val uint64)

func (*Header) SetTxHash

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

func (*Header) SetUncleHash

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

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

func (h *Header) Time() uint64

func (*Header) TxHash

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

func (*Header) UncleHash

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

func (*Header) UnmarshalJSON

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

UnmarshalJSON unmarshals from JSON.

type InternalToExternalTx

type InternalToExternalTx struct {
	ChainID    *big.Int
	Nonce      uint64
	GasTipCap  *big.Int
	GasFeeCap  *big.Int
	Gas        uint64
	To         *common.Address `rlp:"nilString"` // nil means contract creation
	Value      *big.Int
	Data       []byte     // this probably is not applicable
	AccessList AccessList // this probably is not applicable

	ETXGasLimit   uint64
	ETXGasPrice   *big.Int
	ETXGasTip     *big.Int
	ETXData       []byte
	ETXAccessList 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 InternalTx

type InternalTx struct {
	ChainID    *big.Int
	Nonce      uint64
	GasTipCap  *big.Int
	GasFeeCap  *big.Int
	Gas        uint64
	To         *common.Address `rlp:"nilString"` // 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 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"`
	// 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) 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) 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 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 *big.Int, gasLimit uint64, gasPrice, gasFeeCap, gasTipCap *big.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) ETXAccessList

func (m Message) ETXAccessList() AccessList

func (Message) ETXData

func (m Message) ETXData() []byte

func (Message) ETXGasLimit

func (m Message) ETXGasLimit() uint64

func (Message) ETXGasPrice

func (m Message) ETXGasPrice() *big.Int

func (Message) ETXGasTip

func (m Message) ETXGasTip() *big.Int

func (Message) ETXSender

func (m Message) ETXSender() common.Address

func (Message) From

func (m Message) From() common.Address

func (Message) Gas

func (m Message) Gas() uint64

func (Message) GasFeeCap

func (m Message) GasFeeCap() *big.Int

func (Message) GasPrice

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

func (Message) GasTipCap

func (m Message) GasTipCap() *big.Int

func (Message) Nonce

func (m Message) Nonce() uint64

func (Message) To

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

func (Message) Type

func (m Message) Type() byte

func (Message) Value

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

type PendingEtxs

type PendingEtxs struct {
	Header *Header      `json:"header" gencodec:"required"`
	Etxs   Transactions `json:"etxs"   gencodec:"required"`
}

PendingEtxs are ETXs which have been emitted from the zone which produced the given block. Specifically, it contains the collection of ETXs emitted since our prior coincident with our sub in that slice. In Prime context, our subordinate will be a region node, so the Etxs list will contain the rollup of ETXs emitted from each zone block since the zone's prior coincidence with the region. In Region context, our subordinate chain will be the zone itself, so the Etxs list will just contain the ETXs emitted directly in that zone block (a.k.a. a singleton).

func (*PendingEtxs) IsValid

func (p *PendingEtxs) IsValid(hasher TrieHasher) bool

type PendingEtxsRollup

type PendingEtxsRollup struct {
	Header   *Header       `json:"header" gencodec:"required"`
	Manifest BlockManifest `json:"manifest" gencodec:"required"`
}

PendingEtxsRollup is Header and manifest Hash of that header that should be forward propagated

func (*PendingEtxsRollup) IsValid

func (p *PendingEtxsRollup) IsValid(hasher TrieHasher) bool

type PendingHeader

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

PendingHeader stores the header and termini value associated with the header.

func CopyPendingHeader

func CopyPendingHeader(ph *PendingHeader) *PendingHeader

func NewPendingHeader

func NewPendingHeader(header *Header, termini Termini) PendingHeader

func (*PendingHeader) DecodeRLP

func (p *PendingHeader) DecodeRLP(s *rlp.Stream) error

DecodeRLP decodes the Quai RLP encoding into pending header format.

func (PendingHeader) EncodeRLP

func (p PendingHeader) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Quai RLP format.

func (PendingHeader) Header

func (ph PendingHeader) Header() *Header

accessor methods for pending header

func (*PendingHeader) SetHeader

func (ph *PendingHeader) SetHeader(header *Header)

func (*PendingHeader) SetTermini

func (ph *PendingHeader) SetTermini(termini Termini)

func (PendingHeader) Termini

func (ph PendingHeader) Termini() Termini

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 quai 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"`
	Etxs             []*Transaction `json:"etxs"`
}

Receipt represents the results of a transaction.

func NewReceipt

func NewReceipt(root []byte, 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) 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.

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

func (r Receipt) Supported() bool

Supported returns true if the receipt type is supported

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

func (r 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

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 Signer

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.

func LatestSigner

func LatestSigner(config *params.ChainConfig) Signer

LatestSigner returns the 'most permissive' Signer available for the given chain configuration. 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

LatestSigner returns the 'most permissive' Signer available for the given chain configuration. Use this in transaction-handling code where the current block number is unknown. If you have the current block number available, use MakeSigner instead.

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

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

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

func NewSigner

func NewSigner(chainId *big.Int) Signer

NewSigner instantiates a new signer object

type SignerV1

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

SignerV1 is the mainnet launch version of the signer module. Future versions may be defined if protocol changes are required

func (SignerV1) ChainID

func (s SignerV1) ChainID() *big.Int

func (SignerV1) Equal

func (s SignerV1) Equal(s2 Signer) bool

func (SignerV1) Hash

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

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

func (SignerV1) Sender

func (s SignerV1) Sender(tx *Transaction) (common.Address, error)

func (SignerV1) SignatureValues

func (s SignerV1) SignatureValues(tx *Transaction, sig []byte) (R, S, V *big.Int, err error)

type Termini

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

Termini stores the dom terminus (i.e the previous dom block) and subTermini(i.e the dom blocks that have occured in the subordinate chains)

func CopyTermini

func CopyTermini(termini Termini) Termini

func EmptyTermini

func EmptyTermini() Termini

func (*Termini) DecodeRLP

func (t *Termini) DecodeRLP(s *rlp.Stream) error

DecodeRLP decodes the Quai RLP encoding into pending header format.

func (Termini) DomTerminus

func (t Termini) DomTerminus() common.Hash

func (Termini) EncodeRLP

func (t Termini) EncodeRLP(w io.Writer) error

EncodeRLP serializes b into the Quai RLP format.

func (*Termini) IsValid

func (t *Termini) IsValid() bool

func (Termini) MarshalJSON

func (t Termini) MarshalJSON() ([]byte, error)

func (Termini) RPCMarshalTermini

func (t Termini) RPCMarshalTermini() map[string]interface{}

func (*Termini) SetDomTerminus

func (t *Termini) SetDomTerminus(domTerminus common.Hash)

func (*Termini) SetSubTermini

func (t *Termini) SetSubTermini(subTermini []common.Hash)

func (*Termini) SetSubTerminiAtIndex

func (t *Termini) SetSubTerminiAtIndex(val common.Hash, args ...int)

func (Termini) SubTermini

func (t Termini) SubTermini() []common.Hash

func (Termini) SubTerminiAtIndex

func (t Termini) SubTerminiAtIndex(args ...int) common.Hash

func (*Termini) UnmarshalJSON

func (t *Termini) UnmarshalJSON(input []byte) error

type Transaction

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

Transaction is a Quai transaction.

func MustSignNewTx

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 NewTx

func NewTx(inner TxData) *Transaction

NewTx creates a new transaction.

func SignNewTx

func SignNewTx(prv *ecdsa.PrivateKey, s Signer, txdata TxData) (*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 (*Transaction) AccessList

func (tx *Transaction) AccessList() AccessList

AccessList returns the access list of the transaction.

func (*Transaction) AsMessage

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

AsMessage returns the transaction as a core.Message.

func (*Transaction) AsMessageWithSender

func (tx *Transaction) AsMessageWithSender(s Signer, baseFee *big.Int, sender *common.InternalAddress) (Message, error)

AsMessageWithSender returns the transaction as a core.Message.

func (*Transaction) ChainId

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

ChainId returns the chain ID of the transaction. The return value will always be non-nil.

func (*Transaction) ConfirmationCtx

func (tx *Transaction) ConfirmationCtx() int

ConfirmationCtx indicates the chain context at which this ETX becomes confirmed and referencable to the destination chain

func (*Transaction) Cost

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

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

DecodeRLP implements rlp.Decoder

func (*Transaction) ETXAccessList

func (tx *Transaction) ETXAccessList() AccessList

ETXAccessList returns the access list of the transaction.

func (*Transaction) ETXData

func (tx *Transaction) ETXData() []byte

ETXData returns the input data of the external transaction.

func (*Transaction) ETXGasLimit

func (tx *Transaction) ETXGasLimit() uint64

ETXGasLimit returns the fee cap per gas of the transaction.

func (*Transaction) ETXGasPrice

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

ETXGasPrice returns the gas price of the external transaction.

func (*Transaction) ETXGasTip

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

ETXGasTip returns the gasTipCap per gas of the external transaction.

func (*Transaction) ETXSender

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

func (*Transaction) EffectiveGasTip

func (tx *Transaction) EffectiveGasTip(baseFee *big.Int) (*big.Int, error)

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

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

func (tx *Transaction) EffectiveGasTipIntCmp(other *big.Int, baseFee *big.Int) int

EffectiveGasTipIntCmp compares the effective gasTipCap of a transaction to the given gasTipCap.

func (*Transaction) EffectiveGasTipValue

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

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

EncodeRLP implements rlp.Encoder

func (*Transaction) From

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

func (*Transaction) FromChain

func (tx *Transaction) FromChain() common.Location

FromChain returns the chain location this transaction originated from

func (*Transaction) Gas

func (tx *Transaction) Gas() uint64

Gas returns the gas limit of the transaction.

func (*Transaction) GasFeeCap

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

GasFeeCap returns the fee cap per gas of the transaction.

func (*Transaction) GasFeeCapCmp

func (tx *Transaction) GasFeeCapCmp(other *Transaction) int

GasFeeCapCmp compares the fee cap of two transactions.

func (*Transaction) GasFeeCapIntCmp

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

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

GasTipCap returns the gasTipCap per gas of the transaction.

func (*Transaction) GasTipCapCmp

func (tx *Transaction) GasTipCapCmp(other *Transaction) int

GasTipCapCmp compares the gasTipCap of two transactions.

func (*Transaction) GasTipCapIntCmp

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

func (tx *Transaction) IsInternalToExternalTx() (inner *InternalToExternalTx, ok bool)

func (*Transaction) MarshalBinary

func (tx *Transaction) MarshalBinary() ([]byte, error)

MarshalBinary returns the canonical encoding of the transaction.

func (*Transaction) MarshalJSON

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

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

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

func (tx *Transaction) Type() uint8

Type returns the transaction type.

func (*Transaction) UnmarshalBinary

func (tx *Transaction) UnmarshalBinary(b []byte) error

UnmarshalBinary decodes the canonical encoding of transactions.

func (*Transaction) UnmarshalJSON

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

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

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

func (s Transactions) FilterConfirmationCtx(ctx int) Transactions

FilterConfirmationCtx returns the subset of transactions who can be confirmed at the given context

func (Transactions) FilterToLocation

func (s Transactions) FilterToLocation(l common.Location) Transactions

FilterByLocation returns the subset of transactions with a 'to' address which belongs the given chain location

func (Transactions) FilterToSlice

func (s Transactions) FilterToSlice(slice common.Location, minCtx int) Transactions

FilterToSlice returns the subset of transactions with a 'to' address which belongs to the given slice location, at or above the given minimum context

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 map[common.AddressBytes]Transactions, baseFee *big.Int, sort bool) *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

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

func (t *TransactionsByPriceAndNonce) PopNoSort()

Pop the first transaction without sorting

func (*TransactionsByPriceAndNonce) Shift

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

type TrieHasher

type TrieHasher interface {
	Reset()
	Update([]byte, []byte)
	Hash() common.Hash
}

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.

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 []*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

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)

type TxData

type TxData interface {
	// contains filtered or unexported methods
}

TxData is the underlying data of a transaction.

This is implemented by InternalTx, ExternalTx and InternalToExternal.

func GetInnerForTesting

func GetInnerForTesting(tx *Transaction) TxData

This function must only be used by tests

type TxWithMinerFee

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

TxWithMinerFee wraps a transaction with its gas price or effective miner gasTipCap

func NewTxWithMinerFee

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL