core

package
v1.5.1 Latest Latest
Warning

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

 Go to latest Published: Jan 9, 2026 License: GPL-3.0, LGPL-3.0 Imports: 59 Imported by: 0

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 (
	// 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")

	// 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")

	// ErrPlatONTxNotSupportTracing is returned if tracing an inner tx.
	ErrPlatONTxNotSupportTracing = errors.New("PlatON-inner transactions' tracing are not currently supported")
)

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 (
	// ErrKnownBlock is returned when a block to import is already known locally.
	ErrKnownBlock = errors.New("block already known")
)
View Source 
var (
	ErrNoGenesis = errors.New("Genesis not found in chain")
)
View Source 
var SenderCacher = NewTxSenderCacher(runtime.NumCPU())

senderCacher is a concurrent transaction sender recoverer anc cacher.

Functions

func ApplyTransaction 

func ApplyTransaction(config *params.ChainConfig, bc ChainContext, 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 CalcGasCeil added in v1.5.0 

func CalcGasCeil(parent *types.Block, db snapshotdb.DB) uint64

func CalcGasLimit 

func CalcGasLimit(parent *types.Block, gasFloor uint64, db snapshotdb.DB) uint64

CalcGasLimit computes the gas limit of the next block after parent. It aims to keep the baseline gas above the provided floor, and increase it towards the ceil if the blocks are full. If the ceil is exceeded, it will always decrease the gas allowance.

func CalcGasLimit1559 added in v1.5.0 

func CalcGasLimit1559(parentGasLimit, desiredLimit uint64) uint64

CalcGasLimit1559 calculates the next block gas limit under 1559 rules.

func CanTransfer 

func CanTransfer(db vm.StateDB, addr common.Address, amount *big.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 GenerateChain 

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 
// TODO test
/*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      = ethdb.NewMemDatabase()
)

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

// 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, consensus.NewFaker(), db, 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, nil, gspec.Config, consensus.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))*/

func GenerateChainWithGenesis added in v1.5.1 

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 GenesisBlockForTesting 

func GenesisBlockForTesting(db ethdb.Database, addr common.Address, balance *big.Int) *types.Block

GenesisBlockForTesting creates and writes a block in which addr has the given wei balance.

func GetHashFn 

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

GetHashFn returns a GetHashFunc which retrieves header hashes by number

func GetNonceFn added in v1.2.0 

func GetNonceFn(ref *types.Header, chain ChainContext) func(n uint64) []byte

func IntrinsicGas 

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

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

func LoadGenesisChainConfig added in v1.5.1 

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

func NewEVMBlockContext added in v1.3.2 

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

NewEVMBlockContext creates a new context for use in the EVM.

func NewEVMTxContext added in v1.3.2 

func NewEVMTxContext(msg Message) vm.TxContext

NewEVMTxContext creates a new transaction context for a single transaction.

func NewExecutor added in v1.0.0 

func NewExecutor(chainConfig *params.ChainConfig, chainContext ChainContext, vmCfg vm.Config)

func NewTxSenderCacher added in v1.0.0 

func NewTxSenderCacher(threads int) *txSenderCacher

todoewTxSenderCacher creates a new transaction sender background cacher and starts as many processing goroutines as allowed by the GOMAXPROCS on construction.

func SetupGenesisBlock 

func SetupGenesisBlock(db ethdb.Database, snapshotBaseDB snapshotdb.BaseDB, 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 Transfer 

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

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

Types

type BlockChain 

type BlockChain struct {
	BlockFeed        event.Feed
	BlockExecuteFeed event.Feed
	// 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 GenerateBlockChain added in v0.7.0 

func GenerateBlockChain(gspec *Genesis, parent *types.Block, engine consensus.Engine, db ethdb.Database, n int, gen func(int, *BlockGen)) *BlockChain

func GenerateBlockChain2 added in v0.7.1 

func GenerateBlockChain2(gspec *Genesis, parent *types.Block, engine consensus.Engine, db ethdb.Database, n int, gen func(int, *BlockGen)) (*BlockChain, []*types.Block)

func GenerateBlockChain3 added in v1.4.1 

func GenerateBlockChain3(config *params.ChainConfig, parent *types.Block, engine consensus.Engine, chain *BlockChain, n int, gen func(int, *BlockGen)) *BlockChain

func NewBlockChain 

func NewBlockChain(db ethdb.Database, cacheConfig *CacheConfig, genesis *Genesis, snapshotBaseDB snapshotdb.BaseDB, engine consensus.Engine, vmConfig vm.Config, shouldPreserve func(block *types.Block) bool, 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) CacheConfig added in v0.7.1 

func (bc *BlockChain) CacheConfig() *CacheConfig

Config retrieves the blockchain's chain configuration.

func (*BlockChain) Config 

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

Config retrieves the chain's fork configuration.

func (*BlockChain) ContractCode added in v1.3.2 

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

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

func (*BlockChain) ContractCodeWithPrefix added in v1.3.2 

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 

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

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

func (*BlockChain) CurrentFastBlock 

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

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

func (*BlockChain) CurrentHeader 

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) DisableDBGC added in v0.7.4 

func (bc *BlockChain) DisableDBGC()

DisableDBGC disable database garbage collection.

func (*BlockChain) EnableDBGC added in v0.7.4 

func (bc *BlockChain) EnableDBGC()

EnableDBGC enable database garbage collection.

func (*BlockChain) Engine 

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

Engine retrieves the blockchain's consensus engine.

func (*BlockChain) Export 

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

Export writes the active chain to the given writer.

func (*BlockChain) ExportN 

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 

func (bc *BlockChain) GasLimit() uint64

GasLimit returns the gas limit of the current HEAD block.

func (*BlockChain) Genesis 

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

Genesis retrieves the chain's genesis block.

func (*BlockChain) GetAncestor 

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 

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 

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 

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

func (bc *BlockChain) GetBlockHashesFromHash(hash common.Hash, max uint64) []common.Hash

GetBlockHashesFromHash retrieves a number of block hashes starting at a given hash, fetching towards the genesis block.

func (*BlockChain) GetBlocksFromHash 

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 

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 

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.1.3 

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

GetCanonicalHash returns the canonical hash for a given block number

func (*BlockChain) GetHeader 

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 

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 

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.5.1 

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 

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

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

func (*BlockChain) GetTransactionLookup added in v1.3.0 

func (bc *BlockChain) GetTransactionLookup(hash common.Hash) *rawdb.LegacyTxLookupEntry

GetTransactionLookup retrieves the lookup associate with the given transaction hash from the cache or database.

func (*BlockChain) GetVMConfig added in v1.0.0 

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

GetVMConfig returns the block chain VM config.

func (*BlockChain) HasBlock 

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 

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.5.0 

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 

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 

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

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

func (*BlockChain) InsertChain 

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 

func (bc *BlockChain) InsertHeaderChain(chain []*types.Header, checkFreq int) (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.

The verify parameter can be used to fine tune whether nonce verification should be done or not. The reason behind the optional check is because some of the header retrieval mechanisms already need to verify nonces, as well as because nonces can be verified sparsely, not needing to check each.

func (*BlockChain) InsertReceiptChain 

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) ProcessDirectly added in v0.7.0 

func (bc *BlockChain) ProcessDirectly(block *types.Block, state *state.StateDB, parent *types.Block) (types.Receipts, error)

joey.lyu

func (*BlockChain) Processor 

func (bc *BlockChain) Processor() Processor

Processor returns the current processor.

func (*BlockChain) SetBlockValidatorAndProcessorForTesting added in v1.5.1 

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

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

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

func (*BlockChain) SetProcessor 

func (bc *BlockChain) SetProcessor(processor Processor)

SetProcessor sets the processor required for making state modifications.

func (*BlockChain) SetTxLookupLimit added in v1.3.0 

func (bc *BlockChain) SetTxLookupLimit(limit uint64)

SetTxLookupLimit is responsible for updating the txlookup limit to the original one stored in db if the new mismatches with the old one.

func (*BlockChain) SetValidator 

func (bc *BlockChain) SetValidator(validator Validator)

SetValidator sets the validator which is used to validate incoming blocks.

func (*BlockChain) SnapSyncCommitHead added in v1.5.1 

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.4.1 

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

Snapshots returns the blockchain snapshot tree.

func (*BlockChain) State 

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

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

func (*BlockChain) StateAt 

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.0.0 

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

StateCache returns the caching database underpinning the blockchain instance.

func (*BlockChain) Stop 

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.3.2 

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

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

SubscribeChainEvent registers a subscription of ChainEvent.

func (*BlockChain) SubscribeChainHeadEvent 

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

SubscribeChainHeadEvent registers a subscription of ChainHeadEvent.

func (*BlockChain) SubscribeChainSideEvent 

func (bc *BlockChain) SubscribeChainSideEvent(ch chan<- ChainSideEvent) event.Subscription

SubscribeChainSideEvent registers a subscription of ChainSideEvent.

func (*BlockChain) SubscribeExecuteBlocksEvent added in v1.0.0 

func (bc *BlockChain) SubscribeExecuteBlocksEvent(ch chan<- *types.Block) event.Subscription

SubscribeLogsEvent registers a subscription of *types.Block.

func (*BlockChain) SubscribeLogsEvent 

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

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

func (*BlockChain) SubscribeRemovedLogsEvent 

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

SubscribeRemovedLogsEvent registers a subscription of RemovedLogsEvent.

func (*BlockChain) SubscribeWriteStateBlocksEvent added in v1.0.0 

func (bc *BlockChain) SubscribeWriteStateBlocksEvent(ch chan<- *types.Block) event.Subscription

SubscribeLogsEvent registers a subscription of *types.Block.

func (*BlockChain) TrieDB added in v1.5.1 

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

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

func (*BlockChain) TrieNode 

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

TrieNode retrieves a blob of data associated with a trie node either from ephemeral in-memory cache, or from persistent storage.

func (*BlockChain) TxLookupLimit added in v1.3.0 

func (bc *BlockChain) TxLookupLimit() uint64

TxLookupLimit retrieves the txlookup limit used by blockchain to prune stale transaction indices.

func (*BlockChain) Validator 

func (bc *BlockChain) Validator() Validator

Validator returns the current validator.

func (*BlockChain) WriteBlockWithState 

func (bc *BlockChain) WriteBlockWithState(block *types.Block, receipts []*types.Receipt, logs []*types.Log, state *state.StateDB, emitHeadEvent bool, cbftBridgeUpdateChainState func()) error

WriteBlockWithState writes the block and all associated state to the database.

func (*BlockChain) WriteBlockWithoutState 

func (bc *BlockChain) WriteBlockWithoutState(block *types.Block) (err error)

WriteBlockWithoutState writes only the block and its metadata to the database, but does not write any state. This is used to construct competing side forks up to the point where they exceed the canonical total difficulty.

type BlockChainCache added in v0.7.0 

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

func NewBlockChainCache added in v0.7.0 

func NewBlockChainCache(blockChain *BlockChain) *BlockChainCache

func (*BlockChainCache) AddSealBlock added in v0.7.1 

func (bcc *BlockChainCache) AddSealBlock(hash common.Hash, number uint64)

func (*BlockChainCache) ClearCache added in v0.7.0 

func (bcc *BlockChainCache) ClearCache(block *types.Block)

Get the StateDB instance of the corresponding block

func (*BlockChainCache) CurrentBlock added in v0.7.0 

func (pbc *BlockChainCache) CurrentBlock() *types.Block

func (*BlockChainCache) Execute added in v0.7.1 

func (bcc *BlockChainCache) Execute(block *types.Block, parent *types.Block) error

func (*BlockChainCache) GetBlock added in v0.7.0 

func (pbc *BlockChainCache) GetBlock(hash common.Hash, number uint64) *types.Block

func (*BlockChainCache) GetBlockInMemory added in v0.7.0 

func (pbc *BlockChainCache) GetBlockInMemory(hash common.Hash, number uint64) *types.Block

func (*BlockChainCache) GetState added in v0.7.0 

func (bcc *BlockChainCache) GetState(header *types.Header) (*state.StateDB, error)

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

func (*BlockChainCache) MakeStateDB added in v0.7.0 

func (bcc *BlockChainCache) MakeStateDB(block *types.Block) (*state.StateDB, error)

Get the StateDB instance of the corresponding block

func (*BlockChainCache) MakeStateDBByHeader added in v0.7.3 

func (bcc *BlockChainCache) MakeStateDBByHeader(header *types.Header) (*state.StateDB, error)

func (*BlockChainCache) ReadOnlyStateDB added in v0.7.3 

func (pbc *BlockChainCache) ReadOnlyStateDB(sealHash common.Hash) *state.StateDB

func (*BlockChainCache) ReadReceipts added in v0.7.0 

func (bcc *BlockChainCache) ReadReceipts(sealHash common.Hash) []*types.Receipt

Read the Receipt collection from the cache map.

func (*BlockChainCache) ReadStateDB added in v0.7.0 

func (pbc *BlockChainCache) ReadStateDB(sealHash common.Hash) *state.StateDB

Read the StateDB instance from the cache map

func (*BlockChainCache) Stop added in v1.3.1 

func (bcc *BlockChainCache) Stop()

func (*BlockChainCache) WriteBlock added in v0.7.1 

func (bcc *BlockChainCache) WriteBlock(block *types.Block) error

func (*BlockChainCache) WriteReceipts added in v0.7.0 

func (pbc *BlockChainCache) WriteReceipts(sealHash common.Hash, receipts []*types.Receipt, blockNum uint64)

Write Receipt to the cache

func (*BlockChainCache) WriteStateDB added in v0.7.0 

func (bcc *BlockChainCache) WriteStateDB(sealHash common.Hash, stateDB *state.StateDB, blockNum uint64)

Write a StateDB instance to the cache

type BlockChainReactor added in v0.7.1 

type BlockChainReactor struct {
	NodeId enode.IDv0 // The nodeId of current node
	// contains filtered or unexported fields
}

func GetReactorInstance added in v0.7.1 

func GetReactorInstance() *BlockChainReactor

Getting the global bcr single instance

func NewBlockChainReactor added in v0.7.1 

func NewBlockChainReactor(mux *event.TypeMux, chainId *big.Int) *BlockChainReactor

func (*BlockChainReactor) BeginBlocker added in v0.7.1 

func (bcr *BlockChainReactor) BeginBlocker(header *types.Header, state xcom.StateDB) error

Called before every block has not executed all txs

func (*BlockChainReactor) Close added in v0.7.1 

func (bcr *BlockChainReactor) Close()

func (*BlockChainReactor) EndBlocker added in v0.7.1 

func (bcr *BlockChainReactor) EndBlocker(header *types.Header, state xcom.StateDB) error

Called after every block had executed all txs

func (*BlockChainReactor) Flush added in v0.7.1 

func (bcr *BlockChainReactor) Flush(header *types.Header) error

func (*BlockChainReactor) GetChainID added in v1.0.0 

func (bcr *BlockChainReactor) GetChainID() *big.Int

func (*BlockChainReactor) GetLastNumber added in v0.7.1 

func (bcr *BlockChainReactor) GetLastNumber(blockNumber uint64) uint64

func (*BlockChainReactor) GetValidator added in v0.7.1 

func (bcr *BlockChainReactor) GetValidator(blockNumber uint64) (*cbfttypes.Validators, error)

func (*BlockChainReactor) IsCandidateNode added in v0.7.1 

func (bcr *BlockChainReactor) IsCandidateNode(nodeID enode.IDv0) bool

func (*BlockChainReactor) NewBlock added in v1.5.0 

func (bcr *BlockChainReactor) NewBlock(header *types.Header, state xcom.StateDB, blockHash common.Hash) error

func (*BlockChainReactor) OnCommit added in v0.7.3 

func (bcr *BlockChainReactor) OnCommit(block *types.Block) error

func (*BlockChainReactor) PrepareHeaderNonce added in v1.5.0 

func (bcr *BlockChainReactor) PrepareHeaderNonce(header *types.Header) error

func (*BlockChainReactor) RegisterPlugin added in v0.7.1 

func (bcr *BlockChainReactor) RegisterPlugin(pluginRule int, plugin plugin.BasePlugin)

func (*BlockChainReactor) SetBeginRule added in v0.7.1 

func (bcr *BlockChainReactor) SetBeginRule(rule []int)

func (*BlockChainReactor) SetEndRule added in v0.7.1 

func (bcr *BlockChainReactor) SetEndRule(rule []int)

func (*BlockChainReactor) SetPluginEventMux added in v0.7.1 

func (bcr *BlockChainReactor) SetPluginEventMux()

func (*BlockChainReactor) SetPrivateKey added in v0.7.1 

func (bcr *BlockChainReactor) SetPrivateKey(privateKey *ecdsa.PrivateKey)

func (*BlockChainReactor) SetVRFhandler added in v0.7.3 

func (bcr *BlockChainReactor) SetVRFhandler(vher *handler.VrfHandler)

func (*BlockChainReactor) SetWorkerCoinBase added in v0.7.1 

func (bcr *BlockChainReactor) SetWorkerCoinBase(header *types.Header, nodeId enode.IDv0)

func (*BlockChainReactor) Sign added in v0.7.1 

func (bcr *BlockChainReactor) Sign(msg interface{}) error

func (*BlockChainReactor) Start added in v0.7.1 

func (bcr *BlockChainReactor) Start(mode string)

func (*BlockChainReactor) VerifyHeader added in v0.7.1 

func (bcr *BlockChainReactor) VerifyHeader(header *types.Header, stateDB *state.StateDB) error

func (*BlockChainReactor) VerifySign added in v0.7.1 

func (bcr *BlockChainReactor) VerifySign(msg interface{}) error

func (*BlockChainReactor) VerifyTx added in v0.7.3 

func (bcr *BlockChainReactor) VerifyTx(tx *types.Transaction, to common.Address, rules params.Rules) error

type BlockGen 

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

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

func (*BlockGen) AddTx 

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.

func (*BlockGen) AddTxWithChain 

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.5.1 

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 

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.0.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) AddWithdrawal added in v1.5.1 

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

AddWithdrawal adds a withdrawal to the generated block.

func (*BlockGen) BaseFee added in v1.5.0 

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

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

func (*BlockGen) GetBalance added in v1.5.0 

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

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

func (*BlockGen) Number 

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

Number returns the block number of the block being generated.

func (*BlockGen) OffsetTime 

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 

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) SetActiveVersion added in v1.4.1 

func (b *BlockGen) SetActiveVersion(version uint32)

func (*BlockGen) SetCoinbase 

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

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

func (*BlockGen) SetExtra 

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

SetExtra sets the extra data field of the generated block.

func (*BlockGen) SetNonce 

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

SetNonce sets the nonce field of the generated block.

func (*BlockGen) TxNonce 

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 

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

BlockValidator is responsible for validating block headers and processed state.

BlockValidator implements Validator.

func NewBlockValidator 

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

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

func (*BlockValidator) ValidateBody 

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

ValidateBody verifies the block header's transaction. The headers are assumed to be already validated at this point.

func (*BlockValidator) ValidateState 

func (v *BlockValidator) ValidateState(block *types.Block, statedb *state.StateDB, receipts types.Receipts, usedGas uint64) 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. ValidateState returns a database batch if the validation was a success otherwise nil and an error is returned.

type BloomIndexer added in v1.4.1 

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.4.1 

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.4.1 

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.4.1 

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.4.1 

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 

type CacheConfig struct {
	Disabled bool // Whether to disable trie write caching (archive node)

	TrieCleanLimit     int           // Memory allowance (MB) to use for caching trie nodes in memory
	TrieCleanJournal   string        // Disk journal for saving clean cache entries.
	TrieCleanRejournal time.Duration // Time interval to dump clean cache to disk periodically
	TrieDirtyLimit     int           // Memory limit (MB) at which to flush the current in-memory trie to disk
	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

	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

	Preimages bool // Whether to store preimage of trie key to the disk

	BodyCacheLimit  int
	BlockCacheLimit int
	MaxFutureBlocks int
	BadBlockLimit   int
	TriesInMemory   int

	DBDisabledGC common.AtomicBool // Whether to disable database garbage collection
	DBGCInterval uint64            // Block interval for database garbage collection
	DBGCTimeout  time.Duration
	DBGCMpt      bool
	DBGCBlock    int
}

CacheConfig contains the configuration values for the trie database that's resident in a blockchain.

type ChainContext 

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 

type ChainEvent struct {
	Block *types.Block
	Hash  common.Hash
	Logs  []*types.Log
}

type ChainHeadEvent 

type ChainHeadEvent struct{ Block *types.Block }

type ChainIndexer 

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.4.1 

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 

func NewChainIndexer(chainDb, 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 

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 

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

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

func (*ChainIndexer) Close 

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

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 

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 

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 

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
}

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 

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.5.1 

type ChainOverrides struct {
	OverrideShanghai *uint64
}

ChainOverrides contains the changes to chain config.

type ChainSideEvent 

type ChainSideEvent struct {
	Block *types.Block
}

type CleanBatch added in v0.7.4 

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

func (*CleanBatch) Delete added in v0.7.4 

func (cb *CleanBatch) Delete(key []byte) error

func (*CleanBatch) ValueSize added in v0.7.4 

func (cb *CleanBatch) ValueSize() int

func (*CleanBatch) WriteAndRest added in v0.7.4 

func (cb *CleanBatch) WriteAndRest() error

type Cleaner added in v0.7.4 

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

func NewCleaner added in v0.7.4 

func NewCleaner(blockchain *BlockChain, interval uint64, cleanTimeout time.Duration, gcMpt bool) *Cleaner

func (*Cleaner) Cleanup added in v0.7.4 

func (c *Cleaner) Cleanup()

func (*Cleaner) NeedCleanup added in v0.7.4 

func (c *Cleaner) NeedCleanup() bool

func (*Cleaner) Stop added in v0.7.4 

func (c *Cleaner) Stop()

type CleanupEvent added in v0.7.4 

type CleanupEvent struct{}

type DeleteBlockContentCallback added in v1.1.1 

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.0.0 

type ExecutionResult struct {
	UsedGas    uint64 // Total used gas but include the refunded gas
	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 

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.0.0 

func (result *ExecutionResult) Failed() bool

Failed returns the indicator whether the execution is successful or not

func (*ExecutionResult) Return added in v1.0.0 

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.0.0 

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.0.0 

func (result *ExecutionResult) Unwrap() error

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

type Executor added in v1.0.0 

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

func GetExecutor added in v1.0.0 

func GetExecutor() *Executor

func (*Executor) ExecuteTransactions added in v1.0.0 

func (exe *Executor) ExecuteTransactions(ctx *ParallelContext) error

type GasPool 

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 

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

AddGas makes gas available for execution.

func (*GasPool) Gas 

func (gp *GasPool) Gas() uint64

Gas returns the amount of gas remaining in the pool.

func (*GasPool) String 

func (gp *GasPool) String() string

func (*GasPool) SubGas 

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"`
	EconomicModel *params.EconomicModel `json:"economicModel"`
	Nonce         []byte                `json:"nonce"`
	Timestamp     uint64                `json:"timestamp"`
	ExtraData     []byte                `json:"extraData"`
	GasLimit      uint64                `json:"gasLimit"   gencodec:"required"`
	Coinbase      common.Address        `json:"coinbase"`
	Alloc         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"`
}

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

func DefaultGenesisBlock 

func DefaultGenesisBlock() *Genesis

DefaultGenesisBlock returns the PlatON main net genesis block.

func DefaultGrapeGenesisBlock added in v0.7.0 

func DefaultGrapeGenesisBlock() *Genesis

func DefaultTestnetGenesisBlock 

func DefaultTestnetGenesisBlock() *Genesis

DefaultTestnetGenesisBlock returns the PlatON test net genesis block.

func GenesisForTesting added in v1.5.1 

func GenesisForTesting(addr common.Address, balance *big.Int) *Genesis

func (*Genesis) Commit 

func (g *Genesis) Commit(db ethdb.Database, sdb snapshotdb.BaseDB) (*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) InitGenesisAndSetEconomicConfig added in v1.0.0 

func (g *Genesis) InitGenesisAndSetEconomicConfig(path string) error

this is only use to private chain

func (Genesis) MarshalJSON 

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

MarshalJSON marshals as JSON

func (*Genesis) MustCommit 

func (g *Genesis) MustCommit(db ethdb.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 

func (g *Genesis) ToBlock(db ethdb.Database, sdb snapshotdb.BaseDB) *types.Block

ToBlock creates the genesis block and writes state of a genesis specification to the given database (or discards it if nil).

func (*Genesis) UnmarshalAddressHRP added in v1.0.0 

func (g *Genesis) UnmarshalAddressHRP(r io.Reader) (string, error)

func (*Genesis) UnmarshalEconomicConfigExtend added in v1.3.0 

func (g *Genesis) UnmarshalEconomicConfigExtend(r io.Reader) error

func (*Genesis) UnmarshalJSON 

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

UnmarshalJSON unmarshals from JSON.

type GenesisAccount 

type GenesisAccount struct {
	Code       []byte                      `json:"code,omitempty"`
	Storage    map[common.Hash]common.Hash `json:"storage,omitempty"`
	Balance    *big.Int                    `json:"balance" gencodec:"required"`
	Nonce      uint64                      `json:"nonce,omitempty"`
	PrivateKey []byte                      `json:"secretKey,omitempty"` // for tests
}

GenesisAccount is an account in the state of the genesis block.

func (GenesisAccount) MarshalJSON 

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

MarshalJSON marshals as JSON.

func (*GenesisAccount) UnmarshalJSON 

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

UnmarshalJSON unmarshals from JSON.

type GenesisAlloc 

type GenesisAlloc map[common.Address]GenesisAccount

GenesisAlloc specifies the initial state that is part of the genesis block.

func Alloc added in v0.7.0 

func Alloc() GenesisAlloc

type GenesisMismatchError 

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 

func (e *GenesisMismatchError) Error() string

type HeaderChain 

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

HeaderChain implements the basic block header chain logic that is shared by core.BlockChain and light.LightChain. It is not usable in itself, only as a part of either structure. It is not thread safe either, the encapsulating chain structures should do the necessary mutex locking/unlocking.

func NewHeaderChain 

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 

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

Config retrieves the header chain's chain configuration.

func (*HeaderChain) CurrentBlock added in v0.7.3 

func (hc *HeaderChain) CurrentBlock() *types.Block

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

func (*HeaderChain) CurrentHeader 

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 

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

Engine retrieves the header chain's consensus engine.

func (*HeaderChain) GetAncestor 

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 

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

func (hc *HeaderChain) GetBlockHashesFromHash(hash common.Hash, max uint64) []common.Hash

GetBlockHashesFromHash retrieves a number of block hashes starting at a given hash, fetching towards the genesis block.

func (*HeaderChain) GetBlockNumber 

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.1.3 

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

func (*HeaderChain) GetHeader 

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 

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 

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.5.1 

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

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 

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

InsertHeaderChain inserts the given headers.

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

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 

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

SetGenesis sets a new genesis block header for the chain

func (*HeaderChain) SetHead 

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

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

type Message 

type Message interface {
	From() common.Address
	To() *common.Address

	GasPrice() *big.Int
	GasFeeCap() *big.Int
	GasTipCap() *big.Int
	Gas() uint64
	Value() *big.Int

	Nonce() uint64
	IsFake() bool
	Data() []byte
	AccessList() types.AccessList
}

Message represents a message sent to a contract.

type MiningConfig added in v0.7.1 

type MiningConfig struct {
	MiningLogAtDepth       uint
	TxChanSize             int
	ChainHeadChanSize      int
	ChainSideChanSize      int
	ResultQueueSize        int
	ResubmitAdjustChanSize int
	MinRecommitInterval    time.Duration
	MaxRecommitInterval    time.Duration
	IntervalAdjustRatio    float64
	IntervalAdjustBias     float64
	StaleThreshold         uint64
	DefaultCommitRatio     float64
}

mining related configuration

type NewMinedBlockEvent 

type NewMinedBlockEvent struct{ Block *types.Block }

NewMinedBlockEvent is posted when a block has been imported.

type NewTxsEvent 

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

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

type ParallelContext added in v1.0.0 

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

func NewParallelContext added in v1.0.0 

func NewParallelContext(state *state.StateDB, header *types.Header, blockHash common.Hash, gp *GasPool, packNewBlock bool, signer types.Signer, tempContractCache map[common.Address]struct{}) *ParallelContext

func (*ParallelContext) AddEarnings added in v1.0.0 

func (ctx *ParallelContext) AddEarnings(earning *big.Int)

func (*ParallelContext) AddGasPool added in v1.0.0 

func (ctx *ParallelContext) AddGasPool(amount uint64)

func (*ParallelContext) AddPackedTx added in v1.0.0 

func (ctx *ParallelContext) AddPackedTx(tx *types.Transaction)

func (*ParallelContext) AddReceipt added in v1.0.0 

func (ctx *ParallelContext) AddReceipt(receipt *types.Receipt)

func (*ParallelContext) CumulateBlockGasUsed added in v1.0.0 

func (ctx *ParallelContext) CumulateBlockGasUsed(txGasUsed uint64)

func (*ParallelContext) GetBlockGasUsed added in v1.0.0 

func (ctx *ParallelContext) GetBlockGasUsed() uint64

func (*ParallelContext) GetBlockGasUsedHolder added in v1.0.0 

func (ctx *ParallelContext) GetBlockGasUsedHolder() *uint64

func (*ParallelContext) GetBlockHash added in v1.0.0 

func (ctx *ParallelContext) GetBlockHash() common.Hash

func (*ParallelContext) GetEarnings added in v1.0.0 

func (ctx *ParallelContext) GetEarnings() *big.Int

func (*ParallelContext) GetGasPool added in v1.0.0 

func (ctx *ParallelContext) GetGasPool() *GasPool

func (*ParallelContext) GetHeader added in v1.0.0 

func (ctx *ParallelContext) GetHeader() *types.Header

func (*ParallelContext) GetLogs added in v1.0.0 

func (ctx *ParallelContext) GetLogs() []*types.Log

func (*ParallelContext) GetPackedTxList added in v1.0.0 

func (ctx *ParallelContext) GetPackedTxList() []*types.Transaction

func (*ParallelContext) GetReceipts added in v1.0.0 

func (ctx *ParallelContext) GetReceipts() types.Receipts

func (*ParallelContext) GetResults added in v1.0.0 

func (ctx *ParallelContext) GetResults() []*Result

func (*ParallelContext) GetState added in v1.0.0 

func (ctx *ParallelContext) GetState() *state.StateDB

func (*ParallelContext) GetTx added in v1.0.0 

func (ctx *ParallelContext) GetTx(idx int) *types.Transaction

func (*ParallelContext) GetTxList added in v1.0.0 

func (ctx *ParallelContext) GetTxList() []*types.Transaction

func (*ParallelContext) IsTimeout added in v1.0.0 

func (ctx *ParallelContext) IsTimeout() bool

func (*ParallelContext) SetBlockDeadline added in v1.0.0 

func (ctx *ParallelContext) SetBlockDeadline(blockDeadline time.Time)

func (*ParallelContext) SetBlockGasUsedHolder added in v1.0.0 

func (ctx *ParallelContext) SetBlockGasUsedHolder(blockGasUsedHolder *uint64)

func (*ParallelContext) SetPoppedAddress added in v1.0.0 

func (ctx *ParallelContext) SetPoppedAddress(poppedAddress common.Address)

func (*ParallelContext) SetResult added in v1.0.0 

func (ctx *ParallelContext) SetResult(idx int, result *Result)

func (*ParallelContext) SetTxList added in v1.0.0 

func (ctx *ParallelContext) SetTxList(txs []*types.Transaction)

type ParallelStateProcessor added in v1.0.0 

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

func NewParallelStateProcessor added in v1.0.0 

func NewParallelStateProcessor(config *params.ChainConfig, bc *BlockChain, engine consensus.Engine) *ParallelStateProcessor

func (*ParallelStateProcessor) Process added in v1.0.0 

func (p *ParallelStateProcessor) Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, uint64, error)

type Processor 

type Processor interface {
	Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, uint64, error)
}

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

Process takes the block to be processed and the statedb upon which the initial state is based. It should return the receipts generated, amount of gas used in the process and return an error if any of the internal rules failed.

type RemovedLogsEvent 

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

RemovedLogsEvent is posted when a reorg happens

type Result added in v1.0.0 

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

type StateProcessor 

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 

func NewStateProcessor(config *params.ChainConfig, bc *BlockChain, engine consensus.Engine) *StateProcessor

NewStateProcessor initialises a new StateProcessor.

func (*StateProcessor) Process 

func (p *StateProcessor) Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, uint64, error)

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

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 

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** error which aborts the execution, e.g. ErrOutOfGas, ErrExecutionReverted

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

type TaskArgs added in v1.0.0 

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

type TxDag added in v1.0.0 

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

func NewTxDag added in v1.0.0 

func NewTxDag(signer types.Signer) *TxDag

func (*TxDag) HasNext added in v1.0.0 

func (txDag *TxDag) HasNext() bool

func (*TxDag) IsContract added in v1.0.0 

func (txDag *TxDag) IsContract(idx int) bool

func (*TxDag) MakeDagGraph added in v1.0.0 

func (txDag *TxDag) MakeDagGraph(ctx *ParallelContext, exe *Executor) error

func (*TxDag) Next added in v1.0.0 

func (txDag *TxDag) Next() []int

type UpdateHeadBlocksCallback added in v1.1.1 

type UpdateHeadBlocksCallback func(ethdb.KeyValueWriter, *types.Header) (uint64, 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 

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

	// ValidateState validates the given statedb and optionally the receipts and
	// gas used.
	ValidateState(block *types.Block, state *state.StateDB, receipts types.Receipts, usedGas uint64) 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 

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 rawdb contains a collection of low level database accessors.
 Package rawdb contains a collection of low level database accessors.
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.
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.