core

package
v1.14.12 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2024 License: GPL-3.0 Imports: 52 Imported by: 6,332

Documentation

Overview

Package core implements the Ethereum consensus protocol.

Index

Examples

Constants

View Source 
const (

	// BlockChainVersion ensures that an incompatible database forces a resync from scratch.
	//
	// Changelog:
	//
	// - Version 4
	//   The following incompatible database changes were added:
	//   * the `BlockNumber`, `TxHash`, `TxIndex`, `BlockHash` and `Index` fields of log are deleted
	//   * the `Bloom` field of receipt is deleted
	//   * the `BlockIndex` and `TxIndex` fields of txlookup are deleted
	// - Version 5
	//  The following incompatible database changes were added:
	//    * the `TxHash`, `GasCost`, and `ContractAddress` fields are no longer stored for a receipt
	//    * the `TxHash`, `GasCost`, and `ContractAddress` fields are computed by looking up the
	//      receipts' corresponding block
	// - Version 6
	//  The following incompatible database changes were added:
	//    * Transaction lookup information stores the corresponding block number instead of block hash
	// - Version 7
	//  The following incompatible database changes were added:
	//    * Use freezer as the ancient database to maintain all ancient data
	// - Version 8
	//  The following incompatible database changes were added:
	//    * New scheme for contract code in order to separate the codes and trie nodes
	BlockChainVersion uint64 = 8
)

Variables

View Source 
var (
	// ErrKnownBlock is returned when a block to import is already known locally.
	ErrKnownBlock = errors.New("block already known")

	// ErrNoGenesis is returned when there is no Genesis Block.
	ErrNoGenesis = errors.New("genesis not found in chain")
)
View Source 
var (
	// ErrNonceTooLow is returned if the nonce of a transaction is lower than the
	// one present in the local chain.
	ErrNonceTooLow = errors.New("nonce too low")

	// ErrNonceTooHigh is returned if the nonce of a transaction is higher than the
	// next one expected based on the local chain.
	ErrNonceTooHigh = errors.New("nonce too high")

	// ErrNonceMax is returned if the nonce of a transaction sender account has
	// maximum allowed value and would become invalid if incremented.
	ErrNonceMax = errors.New("nonce has max value")

	// ErrGasLimitReached is returned by the gas pool if the amount of gas required
	// by a transaction is higher than what's left in the block.
	ErrGasLimitReached = errors.New("gas limit reached")

	// ErrInsufficientFundsForTransfer is returned if the transaction sender doesn't
	// have enough funds for transfer(topmost call only).
	ErrInsufficientFundsForTransfer = errors.New("insufficient funds for transfer")

	// ErrMaxInitCodeSizeExceeded is returned if creation transaction provides the init code bigger
	// than init code size limit.
	ErrMaxInitCodeSizeExceeded = errors.New("max initcode size exceeded")

	// ErrInsufficientBalanceWitness is returned if the transaction sender has enough
	// funds to cover the transfer, but not enough to pay for witness access/modification
	// costs for the transaction
	ErrInsufficientBalanceWitness = errors.New("insufficient funds to cover witness access costs for transaction")

	// ErrInsufficientFunds is returned if the total cost of executing a transaction
	// is higher than the balance of the user's account.
	ErrInsufficientFunds = errors.New("insufficient funds for gas * price + value")

	// ErrGasUintOverflow is returned when calculating gas usage.
	ErrGasUintOverflow = errors.New("gas uint64 overflow")

	// ErrIntrinsicGas is returned if the transaction is specified to use less gas
	// than required to start the invocation.
	ErrIntrinsicGas = errors.New("intrinsic gas too low")

	// ErrTxTypeNotSupported is returned if a transaction is not supported in the
	// current network configuration.
	ErrTxTypeNotSupported = types.ErrTxTypeNotSupported

	// ErrTipAboveFeeCap is a sanity error to ensure no one is able to specify a
	// transaction with a tip higher than the total fee cap.
	ErrTipAboveFeeCap = errors.New("max priority fee per gas higher than max fee per gas")

	// ErrTipVeryHigh is a sanity error to avoid extremely big numbers specified
	// in the tip field.
	ErrTipVeryHigh = errors.New("max priority fee per gas higher than 2^256-1")

	// ErrFeeCapVeryHigh is a sanity error to avoid extremely big numbers specified
	// in the fee cap field.
	ErrFeeCapVeryHigh = errors.New("max fee per gas higher than 2^256-1")

	// ErrFeeCapTooLow is returned if the transaction fee cap is less than the
	// base fee of the block.
	ErrFeeCapTooLow = errors.New("max fee per gas less than block base fee")

	// ErrSenderNoEOA is returned if the sender of a transaction is a contract.
	ErrSenderNoEOA = errors.New("sender not an eoa")

	// ErrBlobFeeCapTooLow is returned if the transaction fee cap is less than the
	// blob gas fee of the block.
	ErrBlobFeeCapTooLow = errors.New("max fee per blob gas less than block blob gas fee")

	// ErrMissingBlobHashes is returned if a blob transaction has no blob hashes.
	ErrMissingBlobHashes = errors.New("blob transaction missing blob hashes")

	// ErrBlobTxCreate is returned if a blob transaction has no explicit to field.
	ErrBlobTxCreate = errors.New("blob transaction of type create")
)

List of evm-call-message pre-checking errors. All state transition messages will be pre-checked before execution. If any invalidation detected, the corresponding error should be returned which is defined here.

- If the pre-checking happens in the miner, then the transaction won't be packed. - If the pre-checking happens in the block processing procedure, then a "BAD BLOCk" error should be emitted.

View Source 
var SenderCacher = newTxSenderCacher(runtime.NumCPU())

SenderCacher is a concurrent transaction sender recoverer and cacher.

Functions

func ApplyTransaction added in v1.3.2 

func ApplyTransaction(config *params.ChainConfig, bc ChainContext, author *common.Address, gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *uint64, cfg vm.Config) (*types.Receipt, error)

ApplyTransaction attempts to apply a transaction to the given state database and uses the input parameters for its environment. It returns the receipt for the transaction, gas used and an error if the transaction failed, indicating the block was invalid.

func ApplyTransactionWithEVM added in v1.14.0 

func ApplyTransactionWithEVM(msg *Message, config *params.ChainConfig, gp *GasPool, statedb *state.StateDB, blockNumber *big.Int, blockHash common.Hash, tx *types.Transaction, usedGas *uint64, evm *vm.EVM) (receipt *types.Receipt, err error)

ApplyTransactionWithEVM attempts to apply a transaction to the given state database and uses the input parameters for its environment similar to ApplyTransaction. However, this method takes an already created EVM instance as input.

func CalcGasLimit added in v0.8.4 

func CalcGasLimit(parentGasLimit, desiredLimit uint64) uint64

CalcGasLimit computes the gas limit of the next block after parent. It aims to keep the baseline gas close to the provided target, and increase it towards the target if the baseline gas is lower.

func CanTransfer added in v1.5.5 

func CanTransfer(db vm.StateDB, addr common.Address, amount *uint256.Int) bool

CanTransfer checks whether there are enough funds in the address' account to make a transfer. This does not take the necessary gas in to account to make the transfer valid.

func ExecuteStateless added in v1.14.6 

func ExecuteStateless(config *params.ChainConfig, block *types.Block, witness *stateless.Witness) (common.Hash, common.Hash, error)

ExecuteStateless runs a stateless execution based on a witness, verifies everything it can locally and returns the state root and receipt root, that need the other side to explicitly check.

This method is a bit of a sore thumb here, but:

  • It cannot be placed in core/stateless, because state.New prodces a circular dep
  • It cannot be placed outside of core, because it needs to construct a dud headerchain

TODO(karalabe): Would be nice to resolve both issues above somehow and move it.

func GenerateChain added in v0.9.34 

func GenerateChain(config *params.ChainConfig, parent *types.Block, engine consensus.Engine, db ethdb.Database, n int, gen func(int, *BlockGen)) ([]*types.Block, []types.Receipts)

GenerateChain creates a chain of n blocks. The first block's parent will be the provided parent. db is used to store intermediate states and should contain the parent's state trie.

The generator function is called with a new block generator for every block. Any transactions and uncles added to the generator become part of the block. If gen is nil, the blocks will be empty and their coinbase will be the zero address.

Blocks created by GenerateChain do not contain valid proof of work values. Inserting them into BlockChain requires use of FakePow or a similar non-validating proof of work implementation.

Example 
var (
	key1, _ = crypto.HexToECDSA("b71c71a67e1177ad4e901695e1b4b9ee17ae16c6668d313eac2f96dbcda3f291")
	key2, _ = crypto.HexToECDSA("8a1f9a8f95be41cd7ccb6168179afb4504aefe388d1e14474d32c45c72ce7b7a")
	key3, _ = crypto.HexToECDSA("49a7b37aa6f6645917e7b807e9d1c00d4fa71f18343b0d4122a4d2df64dd6fee")
	addr1   = crypto.PubkeyToAddress(key1.PublicKey)
	addr2   = crypto.PubkeyToAddress(key2.PublicKey)
	addr3   = crypto.PubkeyToAddress(key3.PublicKey)
	db      = rawdb.NewMemoryDatabase()
	genDb   = rawdb.NewMemoryDatabase()
)

// Ensure that key1 has some funds in the genesis block.
gspec := &Genesis{
	Config: &params.ChainConfig{HomesteadBlock: new(big.Int)},
	Alloc:  types.GenesisAlloc{addr1: {Balance: big.NewInt(1000000)}},
}
genesis := gspec.MustCommit(genDb, triedb.NewDatabase(genDb, triedb.HashDefaults))

// This call generates a chain of 5 blocks. The function runs for
// each block and adds different features to gen based on the
// block index.
signer := types.HomesteadSigner{}
chain, _ := GenerateChain(gspec.Config, genesis, ethash.NewFaker(), genDb, 5, func(i int, gen *BlockGen) {
	switch i {
	case 0:
		// In block 1, addr1 sends addr2 some ether.
		tx, _ := types.SignTx(types.NewTransaction(gen.TxNonce(addr1), addr2, big.NewInt(10000), params.TxGas, nil, nil), signer, key1)
		gen.AddTx(tx)
	case 1:
		// In block 2, addr1 sends some more ether to addr2.
		// addr2 passes it on to addr3.
		tx1, _ := types.SignTx(types.NewTransaction(gen.TxNonce(addr1), addr2, big.NewInt(1000), params.TxGas, nil, nil), signer, key1)
		tx2, _ := types.SignTx(types.NewTransaction(gen.TxNonce(addr2), addr3, big.NewInt(1000), params.TxGas, nil, nil), signer, key2)
		gen.AddTx(tx1)
		gen.AddTx(tx2)
	case 2:
		// Block 3 is empty but was mined by addr3.
		gen.SetCoinbase(addr3)
		gen.SetExtra([]byte("yeehaw"))
	case 3:
		// Block 4 includes blocks 2 and 3 as uncle headers (with modified extra data).
		b2 := gen.PrevBlock(1).Header()
		b2.Extra = []byte("foo")
		gen.AddUncle(b2)
		b3 := gen.PrevBlock(2).Header()
		b3.Extra = []byte("foo")
		gen.AddUncle(b3)
	}
})

// Import the chain. This runs all block validation rules.
blockchain, _ := NewBlockChain(db, DefaultCacheConfigWithScheme(rawdb.HashScheme), gspec, nil, ethash.NewFaker(), vm.Config{}, nil)
defer blockchain.Stop()

if i, err := blockchain.InsertChain(chain); err != nil {
	fmt.Printf("insert error (block %d): %v\n", chain[i].NumberU64(), err)
	return
}

state, _ := blockchain.State()
fmt.Printf("last block: #%d\n", blockchain.CurrentBlock().Number)
fmt.Println("balance of addr1:", state.GetBalance(addr1))
fmt.Println("balance of addr2:", state.GetBalance(addr2))
fmt.Println("balance of addr3:", state.GetBalance(addr3))

Output:

last block: #5
balance of addr1: 989000
balance of addr2: 10000
balance of addr3: 19687500000000001000

func GenerateChainWithGenesis added in v1.11.0 

func GenerateChainWithGenesis(genesis *Genesis, engine consensus.Engine, n int, gen func(int, *BlockGen)) (ethdb.Database, []*types.Block, []types.Receipts)

GenerateChainWithGenesis is a wrapper of GenerateChain which will initialize genesis block to database first according to the provided genesis specification then generate chain on top.

func GenerateVerkleChain added in v1.14.0 

func GenerateVerkleChain(config *params.ChainConfig, parent *types.Block, engine consensus.Engine, db ethdb.Database, trdb *triedb.Database, n int, gen func(int, *BlockGen)) ([]*types.Block, []types.Receipts, []*verkle.VerkleProof, []verkle.StateDiff)

func GenerateVerkleChainWithGenesis added in v1.14.0 

func GenerateVerkleChainWithGenesis(genesis *Genesis, engine consensus.Engine, n int, gen func(int, *BlockGen)) (ethdb.Database, []*types.Block, []types.Receipts, []*verkle.VerkleProof, []verkle.StateDiff)

func GetHashFn added in v1.4.0 

func GetHashFn(ref *types.Header, chain ChainContext) func(n uint64) common.Hash

GetHashFn returns a GetHashFunc which retrieves header hashes by number

func IntrinsicGas added in v0.9.17 

func IntrinsicGas(data []byte, accessList types.AccessList, isContractCreation, isHomestead, isEIP2028, isEIP3860 bool) (uint64, error)

IntrinsicGas computes the 'intrinsic gas' for a message with the given data.

func LoadChainConfig added in v1.12.0 

func LoadChainConfig(db ethdb.Database, genesis *Genesis) (*params.ChainConfig, error)

LoadChainConfig loads the stored chain config if it is already present in database, otherwise, return the config in the provided genesis specification.

func MakeReceipt added in v1.14.9 

func MakeReceipt(evm *vm.EVM, result *ExecutionResult, statedb *state.StateDB, blockNumber *big.Int, blockHash common.Hash, tx *types.Transaction, usedGas uint64, root []byte) *types.Receipt

MakeReceipt generates the receipt object for a transaction given its execution result.

func NewEVMBlockContext added in v1.9.25 

func NewEVMBlockContext(header *types.Header, chain ChainContext, author *common.Address) vm.BlockContext

NewEVMBlockContext creates a new context for use in the EVM.

func NewEVMTxContext added in v1.9.25 

func NewEVMTxContext(msg *Message) vm.TxContext

NewEVMTxContext creates a new transaction context for a single transaction.

func ParseDepositLogs added in v1.14.9 

func ParseDepositLogs(logs []*types.Log, config *params.ChainConfig) ([]byte, error)

ParseDepositLogs extracts the EIP-6110 deposit values from logs emitted by BeaconDepositContract.

func ProcessBeaconBlockRoot added in v1.13.0 

func ProcessBeaconBlockRoot(beaconRoot common.Hash, vmenv *vm.EVM, statedb vm.StateDB)

ProcessBeaconBlockRoot applies the EIP-4788 system call to the beacon block root contract. This method is exported to be used in tests.

func ProcessConsolidationQueue added in v1.14.12 

func ProcessConsolidationQueue(vmenv *vm.EVM, statedb vm.StateDB) []byte

ProcessConsolidationQueue calls the EIP-7251 consolidation queue contract. It returns the opaque request data returned by the contract.

func ProcessParentBlockHash added in v1.14.9 

func ProcessParentBlockHash(prevHash common.Hash, vmenv *vm.EVM, statedb vm.StateDB)

ProcessParentBlockHash stores the parent block hash in the history storage contract as per EIP-2935.

func ProcessWithdrawalQueue added in v1.14.12 

func ProcessWithdrawalQueue(vmenv *vm.EVM, statedb vm.StateDB) []byte

ProcessWithdrawalQueue calls the EIP-7002 withdrawal queue contract. It returns the opaque request data returned by the contract.

func SetupGenesisBlock added in v1.6.0 

func SetupGenesisBlock(db ethdb.Database, triedb *triedb.Database, genesis *Genesis) (*params.ChainConfig, common.Hash, error)

SetupGenesisBlock writes or updates the genesis block in db. The block that will be used is: 

                     genesis == nil       genesis != nil
                  +------------------------------------------
db has no genesis |  main-net default  |  genesis
db has genesis    |  from DB           |  genesis (if compatible)

The stored chain configuration will be updated if it is compatible (i.e. does not specify a fork block below the local head block). In case of a conflict, the error is a *params.ConfigCompatError and the new, unwritten config is returned.

The returned chain configuration is never nil.

func SetupGenesisBlockWithOverride added in v1.8.20 

func SetupGenesisBlockWithOverride(db ethdb.Database, triedb *triedb.Database, genesis *Genesis, overrides *ChainOverrides) (*params.ChainConfig, common.Hash, error)

func Transfer added in v1.3.1 

func Transfer(db vm.StateDB, sender, recipient common.Address, amount *uint256.Int)

Transfer subtracts amount from sender and adds amount to recipient using the given Db

Types

type BlockChain added in v1.3.1 

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

BlockChain represents the canonical chain given a database with a genesis block. The Blockchain manages chain imports, reverts, chain reorganisations.

Importing blocks in to the block chain happens according to the set of rules defined by the two stage Validator. Processing of blocks is done using the Processor which processes the included transaction. The validation of the state is done in the second part of the Validator. Failing results in aborting of the import.

The BlockChain also helps in returning blocks from **any** chain included in the database as well as blocks that represents the canonical chain. It's important to note that GetBlock can return any block and does not need to be included in the canonical one where as GetBlockByNumber always represents the canonical chain.

func NewBlockChain added in v1.3.1 

func NewBlockChain(db ethdb.Database, cacheConfig *CacheConfig, genesis *Genesis, overrides *ChainOverrides, engine consensus.Engine, vmConfig vm.Config, txLookupLimit *uint64) (*BlockChain, error)

NewBlockChain returns a fully initialised block chain using information available in the database. It initialises the default Ethereum Validator and Processor.

func (*BlockChain) Config added in v1.4.1 

func (bc *BlockChain) Config() *params.ChainConfig

Config retrieves the chain's fork configuration.

func (*BlockChain) ContractCodeWithPrefix added in v1.9.20 

func (bc *BlockChain) ContractCodeWithPrefix(hash common.Hash) ([]byte, error)

ContractCodeWithPrefix retrieves a blob of data associated with a contract hash either from ephemeral in-memory cache, or from persistent storage.

If the code doesn't exist in the in-memory cache, check the storage with new code scheme.

func (*BlockChain) CurrentBlock added in v1.3.1 

func (bc *BlockChain) CurrentBlock() *types.Header

CurrentBlock retrieves the current head block of the canonical chain. The block is retrieved from the blockchain's internal cache.

func (*BlockChain) CurrentFinalBlock added in v1.11.3 

func (bc *BlockChain) CurrentFinalBlock() *types.Header

CurrentFinalBlock retrieves the current finalized block of the canonical chain. The block is retrieved from the blockchain's internal cache.

func (*BlockChain) CurrentHeader added in v1.3.1 

func (bc *BlockChain) CurrentHeader() *types.Header

CurrentHeader retrieves the current head header of the canonical chain. The header is retrieved from the HeaderChain's internal cache.

func (*BlockChain) CurrentSafeBlock added in v1.10.21 

func (bc *BlockChain) CurrentSafeBlock() *types.Header

CurrentSafeBlock retrieves the current safe block of the canonical chain. The block is retrieved from the blockchain's internal cache.

func (*BlockChain) CurrentSnapBlock added in v1.11.3 

func (bc *BlockChain) CurrentSnapBlock() *types.Header

CurrentSnapBlock retrieves the current snap-sync head block of the canonical chain. The block is retrieved from the blockchain's internal cache.

func (*BlockChain) Engine added in v1.6.0 

func (bc *BlockChain) Engine() consensus.Engine

Engine retrieves the blockchain's consensus engine.

func (*BlockChain) Export added in v1.3.1 

func (bc *BlockChain) Export(w io.Writer) error

Export writes the active chain to the given writer.

func (*BlockChain) ExportN added in v1.3.1 

func (bc *BlockChain) ExportN(w io.Writer, first uint64, last uint64) error

ExportN writes a subset of the active chain to the given writer.

func (*BlockChain) GasLimit added in v1.3.1 

func (bc *BlockChain) GasLimit() uint64

GasLimit returns the gas limit of the current HEAD block.

func (*BlockChain) Genesis added in v1.3.1 

func (bc *BlockChain) Genesis() *types.Block

Genesis retrieves the chain's genesis block.

func (*BlockChain) GetAncestor added in v1.8.11 

func (bc *BlockChain) GetAncestor(hash common.Hash, number, ancestor uint64, maxNonCanonical *uint64) (common.Hash, uint64)

GetAncestor retrieves the Nth ancestor of a given block. It assumes that either the given block or a close ancestor of it is canonical. maxNonCanonical points to a downwards counter limiting the number of blocks to be individually checked before we reach the canonical chain.

Note: ancestor == 0 returns the same block, 1 returns its parent and so on.

func (*BlockChain) GetBlock added in v1.3.1 

func (bc *BlockChain) GetBlock(hash common.Hash, number uint64) *types.Block

GetBlock retrieves a block from the database by hash and number, caching it if found.

func (*BlockChain) GetBlockByHash added in v1.5.0 

func (bc *BlockChain) GetBlockByHash(hash common.Hash) *types.Block

GetBlockByHash retrieves a block from the database by hash, caching it if found.

func (*BlockChain) GetBlockByNumber added in v1.3.1 

func (bc *BlockChain) GetBlockByNumber(number uint64) *types.Block

GetBlockByNumber retrieves a block from the database by number, caching it (associated with its hash) if found.

func (*BlockChain) GetBlocksFromHash added in v1.3.1 

func (bc *BlockChain) GetBlocksFromHash(hash common.Hash, n int) (blocks []*types.Block)

GetBlocksFromHash returns the block corresponding to hash and up to n-1 ancestors. [deprecated by eth/62]

func (*BlockChain) GetBody added in v1.3.1 

func (bc *BlockChain) GetBody(hash common.Hash) *types.Body

GetBody retrieves a block body (transactions and uncles) from the database by hash, caching it if found.

func (*BlockChain) GetBodyRLP added in v1.3.1 

func (bc *BlockChain) GetBodyRLP(hash common.Hash) rlp.RawValue

GetBodyRLP retrieves a block body in RLP encoding from the database by hash, caching it if found.

func (*BlockChain) GetCanonicalHash added in v1.9.6 

func (bc *BlockChain) GetCanonicalHash(number uint64) common.Hash

GetCanonicalHash returns the canonical hash for a given block number

func (*BlockChain) GetHeader added in v1.3.1 

func (bc *BlockChain) GetHeader(hash common.Hash, number uint64) *types.Header

GetHeader retrieves a block header from the database by hash and number, caching it if found.

func (*BlockChain) GetHeaderByHash added in v1.5.0 

func (bc *BlockChain) GetHeaderByHash(hash common.Hash) *types.Header

GetHeaderByHash retrieves a block header from the database by hash, caching it if found.

func (*BlockChain) GetHeaderByNumber added in v1.3.1 

func (bc *BlockChain) GetHeaderByNumber(number uint64) *types.Header

GetHeaderByNumber retrieves a block header from the database by number, caching it (associated with its hash) if found.

func (*BlockChain) GetHeadersFrom added in v1.10.14 

func (bc *BlockChain) GetHeadersFrom(number, count uint64) []rlp.RawValue

GetHeadersFrom returns a contiguous segment of headers, in rlp-form, going backwards from the given number.

func (*BlockChain) GetReceiptsByHash added in v1.8.0 

func (bc *BlockChain) GetReceiptsByHash(hash common.Hash) types.Receipts

GetReceiptsByHash retrieves the receipts for all transactions in a given block.

func (*BlockChain) GetTd added in v1.3.1 

func (bc *BlockChain) GetTd(hash common.Hash, number uint64) *big.Int

GetTd retrieves a block's total difficulty in the canonical chain from the database by hash and number, caching it if found.

func (*BlockChain) GetTransactionLookup added in v1.9.3 

func (bc *BlockChain) GetTransactionLookup(hash common.Hash) (*rawdb.LegacyTxLookupEntry, *types.Transaction, error)

GetTransactionLookup retrieves the lookup along with the transaction itself associate with the given transaction hash.

An error will be returned if the transaction is not found, and background indexing for transactions is still in progress. The transaction might be reachable shortly once it's indexed.

A null will be returned in the transaction is not found and background transaction indexing is already finished. The transaction is not existent from the node's perspective.

func (*BlockChain) GetTrieFlushInterval added in v1.12.1 

func (bc *BlockChain) GetTrieFlushInterval() time.Duration

GetTrieFlushInterval gets the in-memory tries flushAlloc interval

func (*BlockChain) GetUnclesInChain added in v1.3.1 

func (bc *BlockChain) GetUnclesInChain(block *types.Block, length int) []*types.Header

GetUnclesInChain retrieves all the uncles from a given block backwards until a specific distance is reached.

func (*BlockChain) GetVMConfig added in v1.8.20 

func (bc *BlockChain) GetVMConfig() *vm.Config

GetVMConfig returns the block chain VM config.

func (*BlockChain) HasBlock added in v1.3.1 

func (bc *BlockChain) HasBlock(hash common.Hash, number uint64) bool

HasBlock checks if a block is fully present in the database or not.

func (*BlockChain) HasBlockAndState added in v1.3.3 

func (bc *BlockChain) HasBlockAndState(hash common.Hash, number uint64) bool

HasBlockAndState checks if a block and associated state trie is fully present in the database or not, caching it if present.

func (*BlockChain) HasFastBlock added in v1.8.19 

func (bc *BlockChain) HasFastBlock(hash common.Hash, number uint64) bool

HasFastBlock checks if a fast block is fully present in the database or not.

func (*BlockChain) HasHeader added in v1.3.1 

func (bc *BlockChain) HasHeader(hash common.Hash, number uint64) bool

HasHeader checks if a block header is present in the database or not, caching it if present.

func (*BlockChain) HasState added in v1.8.0 

func (bc *BlockChain) HasState(hash common.Hash) bool

HasState checks if state trie is fully present in the database or not.

func (*BlockChain) HeaderChain added in v1.13.12 

func (bc *BlockChain) HeaderChain() *HeaderChain

HeaderChain returns the underlying header chain.

func (*BlockChain) InsertBlockWithoutSetHead added in v1.10.14 

func (bc *BlockChain) InsertBlockWithoutSetHead(block *types.Block, makeWitness bool) (*stateless.Witness, error)

InsertBlockWithoutSetHead executes the block, runs the necessary verification upon it and then persist the block and the associate state into the database. The key difference between the InsertChain is it won't do the canonical chain updating. It relies on the additional SetCanonical call to finalize the entire procedure.

func (*BlockChain) InsertChain added in v1.3.1 

func (bc *BlockChain) InsertChain(chain types.Blocks) (int, error)

InsertChain attempts to insert the given batch of blocks in to the canonical chain or, otherwise, create a fork. If an error is returned it will return the index number of the failing block as well an error describing what went wrong. After insertion is done, all accumulated events will be fired.

func (*BlockChain) InsertHeaderChain added in v1.3.1 

func (bc *BlockChain) InsertHeaderChain(chain []*types.Header) (int, error)

InsertHeaderChain attempts to insert the given header chain in to the local chain, possibly creating a reorg. If an error is returned, it will return the index number of the failing header as well an error describing what went wrong.

func (*BlockChain) InsertReceiptChain added in v1.3.1 

func (bc *BlockChain) InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts, ancientLimit uint64) (int, error)

InsertReceiptChain attempts to complete an already existing header chain with transaction and receipt data.

func (*BlockChain) Processor added in v1.3.2 

func (bc *BlockChain) Processor() Processor

Processor returns the current processor.

func (*BlockChain) Reset added in v1.3.1 

func (bc *BlockChain) Reset() error

Reset purges the entire blockchain, restoring it to its genesis state.

func (*BlockChain) ResetWithGenesisBlock added in v1.3.1 

func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block) error

ResetWithGenesisBlock purges the entire blockchain, restoring it to the specified genesis state.

func (*BlockChain) SetBlockValidatorAndProcessorForTesting added in v1.10.21 

func (bc *BlockChain) SetBlockValidatorAndProcessorForTesting(v Validator, p Processor)

SetBlockValidatorAndProcessorForTesting sets the current validator and processor. This method can be used to force an invalid blockchain to be verified for tests. This method is unsafe and should only be used before block import starts.

func (*BlockChain) SetCanonical added in v1.10.18 

func (bc *BlockChain) SetCanonical(head *types.Block) (common.Hash, error)

SetCanonical rewinds the chain to set the new head block as the specified block. It's possible that the state of the new head is missing, and it will be recovered in this function as well.

func (*BlockChain) SetFinalized added in v1.10.18 

func (bc *BlockChain) SetFinalized(header *types.Header)

SetFinalized sets the finalized block.

func (*BlockChain) SetHead added in v1.3.1 

func (bc *BlockChain) SetHead(head uint64) error

SetHead rewinds the local chain to a new head. Depending on whether the node was snap synced or full synced and in which state, the method will try to delete minimal data from disk whilst retaining chain consistency.

func (*BlockChain) SetHeadWithTimestamp added in v1.11.0 

func (bc *BlockChain) SetHeadWithTimestamp(timestamp uint64) error

SetHeadWithTimestamp rewinds the local chain to a new head that has at max the given timestamp. Depending on whether the node was snap synced or full synced and in which state, the method will try to delete minimal data from disk whilst retaining chain consistency.

func (*BlockChain) SetSafe added in v1.10.21 

func (bc *BlockChain) SetSafe(header *types.Header)

SetSafe sets the safe block.

func (*BlockChain) SetTrieFlushInterval added in v1.11.0 

func (bc *BlockChain) SetTrieFlushInterval(interval time.Duration)

SetTrieFlushInterval configures how often in-memory tries are persisted to disk. The interval is in terms of block processing time, not wall clock. It is thread-safe and can be called repeatedly without side effects.

func (*BlockChain) SnapSyncCommitHead added in v1.10.14 

func (bc *BlockChain) SnapSyncCommitHead(hash common.Hash) error

SnapSyncCommitHead sets the current head block to the one defined by the hash irrelevant what the chain contents were prior.

func (*BlockChain) Snapshots added in v1.10.0 

func (bc *BlockChain) Snapshots() *snapshot.Tree

Snapshots returns the blockchain snapshot tree.

func (*BlockChain) State added in v1.3.1 

func (bc *BlockChain) State() (*state.StateDB, error)

State returns a new mutable state based on the current HEAD block.

func (*BlockChain) StateAt added in v1.4.14 

func (bc *BlockChain) StateAt(root common.Hash) (*state.StateDB, error)

StateAt returns a new mutable state based on a particular point in time.

func (*BlockChain) StateCache added in v1.8.19 

func (bc *BlockChain) StateCache() state.Database

StateCache returns the caching database underpinning the blockchain instance.

func (*BlockChain) Stop added in v1.3.1 

func (bc *BlockChain) Stop()

Stop stops the blockchain service. If any imports are currently in progress it will abort them using the procInterrupt.

func (*BlockChain) StopInsert added in v1.9.15 

func (bc *BlockChain) StopInsert()

StopInsert interrupts all insertion methods, causing them to return errInsertionInterrupted as soon as possible. Insertion is permanently disabled after calling this method.

func (*BlockChain) SubscribeBlockProcessingEvent added in v1.9.0 

func (bc *BlockChain) SubscribeBlockProcessingEvent(ch chan<- bool) event.Subscription

SubscribeBlockProcessingEvent registers a subscription of bool where true means block processing has started while false means it has stopped.

func (*BlockChain) SubscribeChainEvent added in v1.7.0 

func (bc *BlockChain) SubscribeChainEvent(ch chan<- ChainEvent) event.Subscription

SubscribeChainEvent registers a subscription of ChainEvent.

func (*BlockChain) SubscribeChainHeadEvent added in v1.7.0 

func (bc *BlockChain) SubscribeChainHeadEvent(ch chan<- ChainHeadEvent) event.Subscription

SubscribeChainHeadEvent registers a subscription of ChainHeadEvent.

func (*BlockChain) SubscribeLogsEvent added in v1.7.0 

func (bc *BlockChain) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription

SubscribeLogsEvent registers a subscription of []*types.Log.

func (*BlockChain) SubscribeRemovedLogsEvent added in v1.7.0 

func (bc *BlockChain) SubscribeRemovedLogsEvent(ch chan<- RemovedLogsEvent) event.Subscription

SubscribeRemovedLogsEvent registers a subscription of RemovedLogsEvent.

func (*BlockChain) TrieDB added in v1.11.0 

func (bc *BlockChain) TrieDB() *triedb.Database

TrieDB retrieves the low level trie database used for data storage.

func (*BlockChain) TxIndexProgress added in v1.13.11 

func (bc *BlockChain) TxIndexProgress() (TxIndexProgress, error)

TxIndexProgress returns the transaction indexing progress.

func (*BlockChain) Validator added in v1.3.2 

func (bc *BlockChain) Validator() Validator

Validator returns the current validator.

type BlockGen added in v0.9.34 

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

BlockGen creates blocks for testing. See GenerateChain for a detailed explanation.

func (*BlockGen) AddTx added in v0.9.34 

func (b *BlockGen) AddTx(tx *types.Transaction)

AddTx adds a transaction to the generated block. If no coinbase has been set, the block's coinbase is set to the zero address.

AddTx panics if the transaction cannot be executed. In addition to the protocol-imposed limitations (gas limit, etc.), there are some further limitations on the content of transactions that can be added. Notably, contract code relying on the BLOCKHASH instruction will panic during execution if it attempts to access a block number outside of the range created by GenerateChain.

func (*BlockGen) AddTxWithChain added in v1.8.3 

func (b *BlockGen) AddTxWithChain(bc *BlockChain, tx *types.Transaction)

AddTxWithChain adds a transaction to the generated block. If no coinbase has been set, the block's coinbase is set to the zero address.

AddTxWithChain panics if the transaction cannot be executed. In addition to the protocol-imposed limitations (gas limit, etc.), there are some further limitations on the content of transactions that can be added. If contract code relies on the BLOCKHASH instruction, the block in chain will be returned.

func (*BlockGen) AddTxWithVMConfig added in v1.11.0 

func (b *BlockGen) AddTxWithVMConfig(tx *types.Transaction, config vm.Config)

AddTxWithVMConfig adds a transaction to the generated block. If no coinbase has been set, the block's coinbase is set to the zero address. The evm interpreter can be customized with the provided vm config.

func (*BlockGen) AddUncheckedReceipt added in v1.3.1 

func (b *BlockGen) AddUncheckedReceipt(receipt *types.Receipt)

AddUncheckedReceipt forcefully adds a receipts to the block without a backing transaction.

AddUncheckedReceipt will cause consensus failures when used during real chain processing. This is best used in conjunction with raw block insertion.

func (*BlockGen) AddUncheckedTx added in v1.9.0 

func (b *BlockGen) AddUncheckedTx(tx *types.Transaction)

AddUncheckedTx forcefully adds a transaction to the block without any validation.

AddUncheckedTx will cause consensus failures when used during real chain processing. This is best used in conjunction with raw block insertion.

func (*BlockGen) AddUncle added in v0.9.34 

func (b *BlockGen) AddUncle(h *types.Header)

AddUncle adds an uncle header to the generated block.

func (*BlockGen) AddWithdrawal added in v1.11.0 

func (b *BlockGen) AddWithdrawal(w *types.Withdrawal) uint64

AddWithdrawal adds a withdrawal to the generated block. It returns the withdrawal index.

func (*BlockGen) BaseFee added in v1.10.4 

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

BaseFee returns the EIP-1559 base fee of the block being generated.

func (*BlockGen) Difficulty added in v1.13.5 

func (b *BlockGen) Difficulty() *big.Int

Difficulty returns the currently calculated difficulty of the block.

func (*BlockGen) Gas added in v1.13.5 

func (b *BlockGen) Gas() uint64

Gas returns the amount of gas left in the current block.

func (*BlockGen) GetBalance added in v1.10.2 

func (b *BlockGen) GetBalance(addr common.Address) *uint256.Int

GetBalance returns the balance of the given address at the generated block.

func (*BlockGen) Number added in v1.4.0 

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

Number returns the block number of the block being generated.

func (*BlockGen) OffsetTime added in v1.2.2 

func (b *BlockGen) OffsetTime(seconds int64)

OffsetTime modifies the time instance of a block, implicitly changing its associated difficulty. It's useful to test scenarios where forking is not tied to chain length directly.

func (*BlockGen) PrevBlock added in v0.9.34 

func (b *BlockGen) PrevBlock(index int) *types.Block

PrevBlock returns a previously generated block by number. It panics if num is greater or equal to the number of the block being generated. For index -1, PrevBlock returns the parent block given to GenerateChain.

func (*BlockGen) SetCoinbase added in v0.9.34 

func (b *BlockGen) SetCoinbase(addr common.Address)

SetCoinbase sets the coinbase of the generated block. It can be called at most once.

func (*BlockGen) SetDifficulty added in v1.9.0 

func (b *BlockGen) SetDifficulty(diff *big.Int)

SetDifficulty sets the difficulty field of the generated block. This method is useful for Clique tests where the difficulty does not depend on time. For the ethash tests, please use OffsetTime, which implicitly recalculates the diff.

func (*BlockGen) SetExtra added in v0.9.34 

func (b *BlockGen) SetExtra(data []byte)

SetExtra sets the extra data field of the generated block.

func (*BlockGen) SetNonce added in v1.8.16 

func (b *BlockGen) SetNonce(nonce types.BlockNonce)

SetNonce sets the nonce field of the generated block.

func (*BlockGen) SetParentBeaconRoot added in v1.13.5 

func (b *BlockGen) SetParentBeaconRoot(root common.Hash)

SetParentBeaconRoot sets the parent beacon root field of the generated block.

func (*BlockGen) SetPoS added in v1.11.0 

func (b *BlockGen) SetPoS()

SetPoS makes the header a PoS-header (0 difficulty)

func (*BlockGen) Signer added in v1.13.5 

func (b *BlockGen) Signer() types.Signer

Signer returns a valid signer instance for the current block.

func (*BlockGen) Timestamp added in v1.11.4 

func (b *BlockGen) Timestamp() uint64

Timestamp returns the timestamp of the block being generated.

func (*BlockGen) TxNonce added in v0.9.34 

func (b *BlockGen) TxNonce(addr common.Address) uint64

TxNonce returns the next valid transaction nonce for the account at addr. It panics if the account does not exist.

type BlockValidator added in v1.3.2 

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

BlockValidator is responsible for validating block headers, uncles and processed state.

BlockValidator implements Validator.

func NewBlockValidator added in v1.3.2 

func NewBlockValidator(config *params.ChainConfig, blockchain *BlockChain) *BlockValidator

NewBlockValidator returns a new block validator which is safe for re-use

func (*BlockValidator) ValidateBody added in v1.6.0 

func (v *BlockValidator) ValidateBody(block *types.Block) error

ValidateBody validates the given block's uncles and verifies the block header's transaction and uncle roots. The headers are assumed to be already validated at this point.

func (*BlockValidator) ValidateState added in v1.3.2 

func (v *BlockValidator) ValidateState(block *types.Block, statedb *state.StateDB, res *ProcessResult, stateless bool) error

ValidateState validates the various changes that happen after a state transition, such as amount of used gas, the receipt roots and the state root itself.

type BloomIndexer added in v1.10.0 

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

BloomIndexer implements a core.ChainIndexer, building up a rotated bloom bits index for the Ethereum header bloom filters, permitting blazing fast filtering.

func (*BloomIndexer) Commit added in v1.10.0 

func (b *BloomIndexer) Commit() error

Commit implements core.ChainIndexerBackend, finalizing the bloom section and writing it out into the database.

func (*BloomIndexer) Process added in v1.10.0 

func (b *BloomIndexer) Process(ctx context.Context, header *types.Header) error

Process implements core.ChainIndexerBackend, adding a new header's bloom into the index.

func (*BloomIndexer) Prune added in v1.10.0 

func (b *BloomIndexer) Prune(threshold uint64) error

Prune returns an empty error since we don't support pruning here.

func (*BloomIndexer) Reset added in v1.10.0 

func (b *BloomIndexer) Reset(ctx context.Context, section uint64, lastSectionHead common.Hash) error

Reset implements core.ChainIndexerBackend, starting a new bloombits index section.

type CacheConfig added in v1.8.0 

type CacheConfig struct {
	TrieCleanLimit      int           // Memory allowance (MB) to use for caching trie nodes in memory
	TrieCleanNoPrefetch bool          // Whether to disable heuristic state prefetching for followup blocks
	TrieDirtyLimit      int           // Memory limit (MB) at which to start flushing dirty trie nodes to disk
	TrieDirtyDisabled   bool          // Whether to disable trie write caching and GC altogether (archive node)
	TrieTimeLimit       time.Duration // Time limit after which to flush the current in-memory trie to disk
	SnapshotLimit       int           // Memory allowance (MB) to use for caching snapshot entries in memory
	Preimages           bool          // Whether to store preimage of trie key to the disk
	StateHistory        uint64        // Number of blocks from head whose state histories are reserved.
	StateScheme         string        // Scheme used to store ethereum states and merkle tree nodes on top

	SnapshotNoBuild bool // Whether the background generation is allowed
	SnapshotWait    bool // Wait for snapshot construction on startup. TODO(karalabe): This is a dirty hack for testing, nuke it
}

CacheConfig contains the configuration values for the trie database and state snapshot these are resident in a blockchain.

func DefaultCacheConfigWithScheme added in v1.13.0 

func DefaultCacheConfigWithScheme(scheme string) *CacheConfig

DefaultCacheConfigWithScheme returns a deep copied default cache config with a provided trie node scheme.

type ChainContext added in v1.6.0 

type ChainContext interface {
	// Engine retrieves the chain's consensus engine.
	Engine() consensus.Engine

	// GetHeader returns the header corresponding to the hash/number argument pair.
	GetHeader(common.Hash, uint64) *types.Header
}

ChainContext supports retrieving headers and consensus parameters from the current blockchain to be used during transaction processing.

type ChainEvent added in v0.8.4 

type ChainEvent struct {
	Header *types.Header
}

type ChainHeadEvent added in v0.9.17 

type ChainHeadEvent struct {
	Header *types.Header
}

type ChainIndexer added in v1.7.0 

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

ChainIndexer does a post-processing job for equally sized sections of the canonical chain (like BlooomBits and CHT structures). A ChainIndexer is connected to the blockchain through the event system by starting a ChainHeadEventLoop in a goroutine.

Further child ChainIndexers can be added which use the output of the parent section indexer. These child indexers receive new head notifications only after an entire section has been finished or in case of rollbacks that might affect already finished sections.

func NewBloomIndexer added in v1.10.0 

func NewBloomIndexer(db ethdb.Database, size, confirms uint64) *ChainIndexer

NewBloomIndexer returns a chain indexer that generates bloom bits data for the canonical chain for fast logs filtering.

func NewChainIndexer added in v1.7.0 

func NewChainIndexer(chainDb ethdb.Database, indexDb ethdb.Database, backend ChainIndexerBackend, section, confirm uint64, throttling time.Duration, kind string) *ChainIndexer

NewChainIndexer creates a new chain indexer to do background processing on chain segments of a given size after certain number of confirmations passed. The throttling parameter might be used to prevent database thrashing.

func (*ChainIndexer) AddCheckpoint added in v1.8.15 

func (c *ChainIndexer) AddCheckpoint(section uint64, shead common.Hash)

AddCheckpoint adds a checkpoint. Sections are never processed and the chain is not expected to be available before this point. The indexer assumes that the backend has sufficient information available to process subsequent sections.

Note: knownSections == 0 and storedSections == checkpointSections until syncing reaches the checkpoint

func (*ChainIndexer) AddChildIndexer added in v1.7.0 

func (c *ChainIndexer) AddChildIndexer(indexer *ChainIndexer)

AddChildIndexer adds a child ChainIndexer that can use the output of this one

func (*ChainIndexer) Close added in v1.7.0 

func (c *ChainIndexer) Close() error

Close tears down all goroutines belonging to the indexer and returns any error that might have occurred internally.

func (*ChainIndexer) Prune added in v1.9.17 

func (c *ChainIndexer) Prune(threshold uint64) error

Prune deletes all chain data older than given threshold.

func (*ChainIndexer) SectionHead added in v1.7.3 

func (c *ChainIndexer) SectionHead(section uint64) common.Hash

SectionHead retrieves the last block hash of a processed section from the index database.

func (*ChainIndexer) Sections added in v1.7.0 

func (c *ChainIndexer) Sections() (uint64, uint64, common.Hash)

Sections returns the number of processed sections maintained by the indexer and also the information about the last header indexed for potential canonical verifications.

func (*ChainIndexer) Start added in v1.7.0 

func (c *ChainIndexer) Start(chain ChainIndexerChain)

Start creates a goroutine to feed chain head events into the indexer for cascading background processing. Children do not need to be started, they are notified about new events by their parents.

type ChainIndexerBackend added in v1.7.0 

type ChainIndexerBackend interface {
	// Reset initiates the processing of a new chain segment, potentially terminating
	// any partially completed operations (in case of a reorg).
	Reset(ctx context.Context, section uint64, prevHead common.Hash) error

	// Process crunches through the next header in the chain segment. The caller
	// will ensure a sequential order of headers.
	Process(ctx context.Context, header *types.Header) error

	// Commit finalizes the section metadata and stores it into the database.
	Commit() error

	// Prune deletes the chain index older than the given threshold.
	Prune(threshold uint64) error
}

ChainIndexerBackend defines the methods needed to process chain segments in the background and write the segment results into the database. These can be used to create filter blooms or CHTs.

type ChainIndexerChain added in v1.7.3 

type ChainIndexerChain interface {
	// CurrentHeader retrieves the latest locally known header.
	CurrentHeader() *types.Header

	// SubscribeChainHeadEvent subscribes to new head header notifications.
	SubscribeChainHeadEvent(ch chan<- ChainHeadEvent) event.Subscription
}

ChainIndexerChain interface is used for connecting the indexer to a blockchain

type ChainOverrides added in v1.11.0 

type ChainOverrides struct {
	OverrideCancun *uint64
	OverrideVerkle *uint64
}

ChainOverrides contains the changes to chain config.

type DeleteBlockContentCallback added in v1.9.0 

type DeleteBlockContentCallback func(ethdb.KeyValueWriter, common.Hash, uint64)

DeleteBlockContentCallback is a callback function that is called by SetHead before each header is deleted.

type ExecutionResult added in v1.9.14 

type ExecutionResult struct {
	UsedGas     uint64 // Total used gas, not including the refunded gas
	RefundedGas uint64 // Total gas refunded after execution
	Err         error  // Any error encountered during the execution(listed in core/vm/errors.go)
	ReturnData  []byte // Returned data from evm(function result or data supplied with revert opcode)
}

ExecutionResult includes all output after executing given evm message no matter the execution itself is successful or not.

func ApplyMessage added in v0.9.17 

func ApplyMessage(evm *vm.EVM, msg *Message, gp *GasPool) (*ExecutionResult, error)

ApplyMessage computes the new state by applying the given message against the old state within the environment.

ApplyMessage returns the bytes returned by any EVM execution (if it took place), the gas used (which includes gas refunds) and an error if it failed. An error always indicates a core error meaning that the message would always fail for that particular state and would never be accepted within a block.

func (*ExecutionResult) Failed added in v1.9.14 

func (result *ExecutionResult) Failed() bool

Failed returns the indicator whether the execution is successful or not

func (*ExecutionResult) Return added in v1.9.14 

func (result *ExecutionResult) Return() []byte

Return is a helper function to help caller distinguish between revert reason and function return. Return returns the data after execution if no error occurs.

func (*ExecutionResult) Revert added in v1.9.14 

func (result *ExecutionResult) Revert() []byte

Revert returns the concrete revert reason if the execution is aborted by `REVERT` opcode. Note the reason can be nil if no data supplied with revert opcode.

func (*ExecutionResult) Unwrap added in v1.9.14 

func (result *ExecutionResult) Unwrap() error

Unwrap returns the internal evm error which allows us for further analysis outside.

type GasPool added in v1.0.3 

type GasPool uint64

GasPool tracks the amount of gas available during execution of the transactions in a block. The zero value is a pool with zero gas available.

func (*GasPool) AddGas added in v1.0.3 

func (gp *GasPool) AddGas(amount uint64) *GasPool

AddGas makes gas available for execution.

func (*GasPool) Gas added in v1.8.0 

func (gp *GasPool) Gas() uint64

Gas returns the amount of gas remaining in the pool.

func (*GasPool) SetGas added in v1.11.3 

func (gp *GasPool) SetGas(gas uint64)

SetGas sets the amount of gas with the provided number.

func (*GasPool) String added in v1.3.1 

func (gp *GasPool) String() string

func (*GasPool) SubGas added in v1.0.3 

func (gp *GasPool) SubGas(amount uint64) error

SubGas deducts the given amount from the pool if enough gas is available and returns an error otherwise.

type Genesis 

type Genesis struct {
	Config     *params.ChainConfig `json:"config"`
	Nonce      uint64              `json:"nonce"`
	Timestamp  uint64              `json:"timestamp"`
	ExtraData  []byte              `json:"extraData"`
	GasLimit   uint64              `json:"gasLimit"   gencodec:"required"`
	Difficulty *big.Int            `json:"difficulty" gencodec:"required"`
	Mixhash    common.Hash         `json:"mixHash"`
	Coinbase   common.Address      `json:"coinbase"`
	Alloc      types.GenesisAlloc  `json:"alloc"      gencodec:"required"`

	// These fields are used for consensus tests. Please don't use them
	// in actual genesis blocks.
	Number        uint64      `json:"number"`
	GasUsed       uint64      `json:"gasUsed"`
	ParentHash    common.Hash `json:"parentHash"`
	BaseFee       *big.Int    `json:"baseFeePerGas"` // EIP-1559
	ExcessBlobGas *uint64     `json:"excessBlobGas"` // EIP-4844
	BlobGasUsed   *uint64     `json:"blobGasUsed"`   // EIP-4844
}

Genesis specifies the header fields, state of a genesis block. It also defines hard fork switch-over blocks through the chain configuration.

func DefaultGenesisBlock added in v1.4.0 

func DefaultGenesisBlock() *Genesis

DefaultGenesisBlock returns the Ethereum main net genesis block.

func DefaultHoleskyGenesisBlock added in v1.13.0 

func DefaultHoleskyGenesisBlock() *Genesis

DefaultHoleskyGenesisBlock returns the Holesky network genesis block.

func DefaultSepoliaGenesisBlock added in v1.10.12 

func DefaultSepoliaGenesisBlock() *Genesis

DefaultSepoliaGenesisBlock returns the Sepolia network genesis block.

func DeveloperGenesisBlock added in v1.7.3 

func DeveloperGenesisBlock(gasLimit uint64, faucet *common.Address) *Genesis

DeveloperGenesisBlock returns the 'geth --dev' genesis block.

func ReadGenesis added in v1.11.0 

func ReadGenesis(db ethdb.Database) (*Genesis, error)

func (*Genesis) Commit added in v1.6.0 

func (g *Genesis) Commit(db ethdb.Database, triedb *triedb.Database) (*types.Block, error)

Commit writes the block and state of a genesis specification to the database. The block is committed as the canonical head block.

func (*Genesis) IsVerkle added in v1.13.6 

func (g *Genesis) IsVerkle() bool

IsVerkle indicates whether the state is already stored in a verkle tree at genesis time.

func (Genesis) MarshalJSON added in v1.6.0 

func (g Genesis) MarshalJSON() ([]byte, error)

MarshalJSON marshals as JSON.

func (*Genesis) MustCommit added in v1.6.0 

func (g *Genesis) MustCommit(db ethdb.Database, triedb *triedb.Database) *types.Block

MustCommit writes the genesis block and state to db, panicking on error. The block is committed as the canonical head block.

func (*Genesis) ToBlock added in v1.6.0 

func (g *Genesis) ToBlock() *types.Block

ToBlock returns the genesis block according to genesis specification.

func (*Genesis) UnmarshalJSON added in v1.6.0 

func (g *Genesis) UnmarshalJSON(input []byte) error

UnmarshalJSON unmarshals from JSON.

type GenesisAccount deprecated added in v1.2.2 

type GenesisAccount = types.Account

Deprecated: use types.Account instead.

type GenesisAlloc deprecated added in v1.6.0 

type GenesisAlloc = types.GenesisAlloc

Deprecated: use types.GenesisAlloc instead.

type GenesisMismatchError added in v1.6.0 

type GenesisMismatchError struct {
	Stored, New common.Hash
}

GenesisMismatchError is raised when trying to overwrite an existing genesis block with an incompatible one.

func (*GenesisMismatchError) Error added in v1.6.0 

func (e *GenesisMismatchError) Error() string

type HeaderChain added in v1.4.0 

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

HeaderChain implements the basic block header chain logic. It is not usable in itself, but rather an internal structure of core.Blockchain.

HeaderChain is responsible for maintaining the header chain including the header query and updating.

The data components maintained by HeaderChain include:

- total difficulty - header - block hash -> number mapping - canonical number -> hash mapping - head header flag.

It is not thread safe, the encapsulating chain structures should do the necessary mutex locking/unlocking.

func NewHeaderChain added in v1.4.0 

func NewHeaderChain(chainDb ethdb.Database, config *params.ChainConfig, engine consensus.Engine, procInterrupt func() bool) (*HeaderChain, error)

NewHeaderChain creates a new HeaderChain structure. ProcInterrupt points to the parent's interrupt semaphore.

func (*HeaderChain) Config added in v1.6.0 

func (hc *HeaderChain) Config() *params.ChainConfig

Config retrieves the header chain's chain configuration.

func (*HeaderChain) CurrentHeader added in v1.4.0 

func (hc *HeaderChain) CurrentHeader() *types.Header

CurrentHeader retrieves the current head header of the canonical chain. The header is retrieved from the HeaderChain's internal cache.

func (*HeaderChain) Engine added in v1.6.0 

func (hc *HeaderChain) Engine() consensus.Engine

Engine retrieves the header chain's consensus engine.

func (*HeaderChain) GetAncestor added in v1.8.11 

func (hc *HeaderChain) GetAncestor(hash common.Hash, number, ancestor uint64, maxNonCanonical *uint64) (common.Hash, uint64)

GetAncestor retrieves the Nth ancestor of a given block. It assumes that either the given block or a close ancestor of it is canonical. maxNonCanonical points to a downwards counter limiting the number of blocks to be individually checked before we reach the canonical chain.

Note: ancestor == 0 returns the same block, 1 returns its parent and so on.

func (*HeaderChain) GetBlock added in v1.6.0 

func (hc *HeaderChain) GetBlock(hash common.Hash, number uint64) *types.Block

GetBlock implements consensus.ChainReader, and returns nil for every input as a header chain does not have blocks available for retrieval.

func (*HeaderChain) GetBlockNumber added in v1.5.0 

func (hc *HeaderChain) GetBlockNumber(hash common.Hash) *uint64

GetBlockNumber retrieves the block number belonging to the given hash from the cache or database

func (*HeaderChain) GetCanonicalHash added in v1.9.6 

func (hc *HeaderChain) GetCanonicalHash(number uint64) common.Hash

func (*HeaderChain) GetHeader added in v1.4.0 

func (hc *HeaderChain) GetHeader(hash common.Hash, number uint64) *types.Header

GetHeader retrieves a block header from the database by hash and number, caching it if found.

func (*HeaderChain) GetHeaderByHash added in v1.5.0 

func (hc *HeaderChain) GetHeaderByHash(hash common.Hash) *types.Header

GetHeaderByHash retrieves a block header from the database by hash, caching it if found.

func (*HeaderChain) GetHeaderByNumber added in v1.4.0 

func (hc *HeaderChain) GetHeaderByNumber(number uint64) *types.Header

GetHeaderByNumber retrieves a block header from the database by number, caching it (associated with its hash) if found.

func (*HeaderChain) GetHeadersFrom added in v1.10.14 

func (hc *HeaderChain) GetHeadersFrom(number, count uint64) []rlp.RawValue

GetHeadersFrom returns a contiguous segment of headers, in rlp-form, going backwards from the given number. If the 'number' is higher than the highest local header, this method will return a best-effort response, containing the headers that we do have.

func (*HeaderChain) GetTd added in v1.4.0 

func (hc *HeaderChain) GetTd(hash common.Hash, number uint64) *big.Int

GetTd retrieves a block's total difficulty in the canonical chain from the database by hash and number, caching it if found.

func (*HeaderChain) HasHeader added in v1.4.0 

func (hc *HeaderChain) HasHeader(hash common.Hash, number uint64) bool

HasHeader checks if a block header is present in the database or not. In theory, if header is present in the database, all relative components like td and hash->number should be present too.

func (*HeaderChain) InsertHeaderChain added in v1.4.0 

func (hc *HeaderChain) InsertHeaderChain(chain []*types.Header, start time.Time) (WriteStatus, error)

InsertHeaderChain inserts the given headers and does the reorganisations.

The validity of the headers is NOT CHECKED by this method, i.e. they need to be validated by ValidateHeaderChain before calling InsertHeaderChain.

This insert is all-or-nothing. If this returns an error, no headers were written, otherwise they were all processed successfully.

The returned 'write status' says if the inserted headers are part of the canonical chain or a side chain.

func (*HeaderChain) Reorg added in v1.10.14 

func (hc *HeaderChain) Reorg(headers []*types.Header) error

Reorg reorgs the local canonical chain into the specified chain. The reorg can be classified into two cases: (a) extend the local chain (b) switch the head to the given header.

func (*HeaderChain) SetCurrentHeader added in v1.4.0 

func (hc *HeaderChain) SetCurrentHeader(head *types.Header)

SetCurrentHeader sets the in-memory head header marker of the canonical chan as the given header.

func (*HeaderChain) SetGenesis added in v1.4.0 

func (hc *HeaderChain) SetGenesis(head *types.Header)

SetGenesis sets a new genesis block header for the chain

func (*HeaderChain) SetHead added in v1.4.0 

func (hc *HeaderChain) SetHead(head uint64, updateFn UpdateHeadBlocksCallback, delFn DeleteBlockContentCallback)

SetHead rewinds the local chain to a new head. Everything above the new head will be deleted and the new one set.

func (*HeaderChain) SetHeadWithTimestamp added in v1.11.0 

func (hc *HeaderChain) SetHeadWithTimestamp(time uint64, updateFn UpdateHeadBlocksCallback, delFn DeleteBlockContentCallback)

SetHeadWithTimestamp rewinds the local chain to a new head timestamp. Everything above the new head will be deleted and the new one set.

func (*HeaderChain) ValidateHeaderChain added in v1.6.0 

func (hc *HeaderChain) ValidateHeaderChain(chain []*types.Header) (int, error)

func (*HeaderChain) WriteHeaders added in v1.10.14 

func (hc *HeaderChain) WriteHeaders(headers []*types.Header) (int, error)

WriteHeaders writes a chain of headers into the local chain, given that the parents are already known. The chain head header won't be updated in this function, the additional SetCanonical is expected in order to finish the entire procedure.

type Message 

type Message struct {
	To            *common.Address
	From          common.Address
	Nonce         uint64
	Value         *big.Int
	GasLimit      uint64
	GasPrice      *big.Int
	GasFeeCap     *big.Int
	GasTipCap     *big.Int
	Data          []byte
	AccessList    types.AccessList
	BlobGasFeeCap *big.Int
	BlobHashes    []common.Hash

	// When SkipNonceChecks is true, the message nonce is not checked against the
	// account nonce in state.
	// This field will be set to true for operations like RPC eth_call.
	SkipNonceChecks bool

	// When SkipFromEOACheck is true, the message sender is not checked to be an EOA.
	SkipFromEOACheck bool
}

A Message contains the data derived from a single transaction that is relevant to state processing.

func TransactionToMessage added in v1.11.4 

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

TransactionToMessage converts a transaction into a Message.

type NewTxsEvent added in v1.8.9 

type NewTxsEvent struct{ Txs []*types.Transaction }

NewTxsEvent is posted when a batch of transactions enter the transaction pool.

type Prefetcher added in v1.9.0 

type Prefetcher interface {
	// Prefetch processes the state changes according to the Ethereum rules by running
	// the transaction messages using the statedb, but any changes are discarded. The
	// only goal is to pre-cache transaction signatures and state trie nodes.
	Prefetch(block *types.Block, statedb *state.StateDB, cfg vm.Config, interrupt *atomic.Bool)
}

Prefetcher is an interface for pre-caching transaction signatures and state.

type ProcessResult added in v1.14.9 

type ProcessResult struct {
	Receipts types.Receipts
	Requests [][]byte
	Logs     []*types.Log
	GasUsed  uint64
}

ProcessResult contains the values computed by Process.

type Processor added in v1.3.2 

type Processor interface {
	// Process processes the state changes according to the Ethereum rules by running
	// the transaction messages using the statedb and applying any rewards to both
	// the processor (coinbase) and any included uncles.
	Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (*ProcessResult, error)
}

Processor is an interface for processing blocks using a given initial state.

type RemovedLogsEvent added in v1.4.0 

type RemovedLogsEvent struct{ Logs []*types.Log }

RemovedLogsEvent is posted when a reorg happens

type StateProcessor added in v1.3.2 

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

StateProcessor is a basic Processor, which takes care of transitioning state from one point to another.

StateProcessor implements Processor.

func NewStateProcessor added in v1.3.2 

func NewStateProcessor(config *params.ChainConfig, chain *HeaderChain) *StateProcessor

NewStateProcessor initialises a new StateProcessor.

func (*StateProcessor) Process added in v1.3.2 

func (p *StateProcessor) Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (*ProcessResult, error)

Process processes the state changes according to the Ethereum rules by running the transaction messages using the statedb and applying any rewards to both the processor (coinbase) and any included uncles.

Process returns the receipts and logs accumulated during the process and returns the amount of gas that was used in the process. If any of the transactions failed to execute due to insufficient gas it will return an error.

type StateTransition 

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

StateTransition represents a state transition.

== The State Transitioning Model

A state transition is a change made when a transaction is applied to the current world state. The state transitioning model does all the necessary work to work out a valid new state root.

  1. Nonce handling
  2. Pre pay gas
  3. Create a new state object if the recipient is nil
  4. Value transfer

== If contract creation == 

4a. Attempt to run transaction data
4b. If valid, use result as code for the new state object

== end ==

  1. Run Script section
  2. Derive new state root

func NewStateTransition 

func NewStateTransition(evm *vm.EVM, msg *Message, gp *GasPool) *StateTransition

NewStateTransition initialises and returns a new state transition object.

func (*StateTransition) TransitionDb added in v1.4.0 

func (st *StateTransition) TransitionDb() (*ExecutionResult, error)

TransitionDb will transition the state by applying the current message and returning the evm execution result with following fields.

  • used gas: total gas used (including gas being refunded)
  • returndata: the returned data from evm
  • concrete execution error: various EVM errors which abort the execution, e.g. ErrOutOfGas, ErrExecutionReverted

However if any consensus issue encountered, return the error directly with nil evm execution result.

type TxIndexProgress added in v1.13.11 

type TxIndexProgress struct {
	Indexed   uint64 // number of blocks whose transactions are indexed
	Remaining uint64 // number of blocks whose transactions are not indexed yet
}

TxIndexProgress is the struct describing the progress for transaction indexing.

func (TxIndexProgress) Done added in v1.13.11 

func (progress TxIndexProgress) Done() bool

Done returns an indicator if the transaction indexing is finished.

type UpdateHeadBlocksCallback added in v1.9.0 

type UpdateHeadBlocksCallback func(ethdb.KeyValueWriter, *types.Header) (*types.Header, bool)

UpdateHeadBlocksCallback is a callback function that is called by SetHead before head header is updated. The method will return the actual block it updated the head to (missing state) and a flag if setHead should continue rewinding till that forcefully (exceeded ancient limits)

type Validator added in v1.3.2 

type Validator interface {
	// ValidateBody validates the given block's content.
	ValidateBody(block *types.Block) error

	// ValidateState validates the given statedb and optionally the process result.
	ValidateState(block *types.Block, state *state.StateDB, res *ProcessResult, stateless bool) error
}

Validator is an interface which defines the standard for block validation. It is only responsible for validating block contents, as the header validation is done by the specific consensus engines.

type WriteStatus added in v1.4.0 

type WriteStatus byte

WriteStatus status of write 

const (
	NonStatTy WriteStatus = iota
	CanonStatTy
	SideStatTy
)

Source Files

View all Source files

Directories

Path Synopsis
Package asm provides support for dealing with EVM assembly instructions (e.g., disassembling them).
 Package asm provides support for dealing with EVM assembly instructions (e.g., disassembling them).
Package bloombits implements bloom filtering on batches of data.
 Package bloombits implements bloom filtering on batches of data.
Package forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
 Package forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
Package rawdb contains a collection of low level database accessors.
 Package rawdb contains a collection of low level database accessors.
ancienttest
Package state provides a caching layer atop the Ethereum state trie.
 Package state provides a caching layer atop the Ethereum state trie.
pruner
snapshot
Package snapshot implements a journalled, dynamic state dump.
 Package snapshot implements a journalled, dynamic state dump.
blobpool
Package blobpool implements the EIP-4844 blob transaction pool.
 Package blobpool implements the EIP-4844 blob transaction pool.
legacypool
Package legacypool implements the normal EVM execution transaction pool.
 Package legacypool implements the normal EVM execution transaction pool.
Package types contains data types related to Ethereum consensus.
 Package types contains data types related to Ethereum consensus.
vm
Package vm implements the Ethereum Virtual Machine.
 Package vm implements the Ethereum Virtual Machine.
runtime
Package runtime provides a basic execution model for executing EVM code.
 Package runtime provides a basic execution model for executing EVM code.

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.