Documentation
¶
Overview ¶
Package core implements the Ethereum consensus protocol.
Index ¶
- Constants
- Variables
- func ApplyTransaction(config *params.ChainConfig, bc ChainContext, author *common.Address, ...) (*types.Receipt, error)
- func CalcGasLimit(parentGasLimit, desiredLimit uint64) uint64
- func CanTransfer(db vm.StateDB, addr common.Address, amount *big.Int) bool
- func CommitGenesisState(db ethdb.Database, triedb *trie.Database, blockhash common.Hash) error
- func GenerateChain(config *params.ChainConfig, parent *types.Block, engine consensus.Engine, ...) ([]*types.Block, []types.Receipts)
- func GenerateChainWithGenesis(genesis *Genesis, engine consensus.Engine, n int, gen func(int, *BlockGen)) (ethdb.Database, []*types.Block, []types.Receipts)
- func GetHashFn(ref *types.Header, chain ChainContext) func(n uint64) common.Hash
- func IntrinsicGas(data []byte, accessList types.AccessList, isContractCreation bool, ...) (uint64, error)
- func LoadCliqueConfig(db ethdb.Database, genesis *Genesis) (*params.CliqueConfig, error)
- func NewEVMBlockContext(header *types.Header, chain ChainContext, author *common.Address) vm.BlockContext
- func NewEVMTxContext(msg *Message) vm.TxContext
- func SetupGenesisBlock(db ethdb.Database, triedb *trie.Database, genesis *Genesis) (*params.ChainConfig, common.Hash, error)
- func SetupGenesisBlockWithOverride(db ethdb.Database, triedb *trie.Database, genesis *Genesis, ...) (*params.ChainConfig, common.Hash, error)
- func Transfer(db vm.StateDB, sender, recipient common.Address, amount *big.Int)
- type BlockChain
- func (bc *BlockChain) Config() *params.ChainConfig
- func (bc *BlockChain) ContractCode(hash common.Hash) ([]byte, error)
- func (bc *BlockChain) ContractCodeWithPrefix(hash common.Hash) ([]byte, error)
- func (bc *BlockChain) CurrentBlock() *types.Header
- func (bc *BlockChain) CurrentFinalBlock() *types.Header
- func (bc *BlockChain) CurrentHeader() *types.Header
- func (bc *BlockChain) CurrentSafeBlock() *types.Header
- func (bc *BlockChain) CurrentSnapBlock() *types.Header
- func (bc *BlockChain) Engine() consensus.Engine
- func (bc *BlockChain) Export(w io.Writer) error
- func (bc *BlockChain) ExportN(w io.Writer, first uint64, last uint64) error
- func (bc *BlockChain) GasLimit() uint64
- func (bc *BlockChain) Genesis() *types.Block
- func (bc *BlockChain) GetAncestor(hash common.Hash, number, ancestor uint64, maxNonCanonical *uint64) (common.Hash, uint64)
- func (bc *BlockChain) GetBlock(hash common.Hash, number uint64) *types.Block
- func (bc *BlockChain) GetBlockByHash(hash common.Hash) *types.Block
- func (bc *BlockChain) GetBlockByNumber(number uint64) *types.Block
- func (bc *BlockChain) GetBlocksFromHash(hash common.Hash, n int) (blocks []*types.Block)
- func (bc *BlockChain) GetBody(hash common.Hash) *types.Body
- func (bc *BlockChain) GetBodyRLP(hash common.Hash) rlp.RawValue
- func (bc *BlockChain) GetCanonicalHash(number uint64) common.Hash
- func (bc *BlockChain) GetHeader(hash common.Hash, number uint64) *types.Header
- func (bc *BlockChain) GetHeaderByHash(hash common.Hash) *types.Header
- func (bc *BlockChain) GetHeaderByNumber(number uint64) *types.Header
- func (bc *BlockChain) GetHeadersFrom(number, count uint64) []rlp.RawValue
- func (bc *BlockChain) GetReceiptsByHash(hash common.Hash) types.Receipts
- func (bc *BlockChain) GetTd(hash common.Hash, number uint64) *big.Int
- func (bc *BlockChain) GetTransactionLookup(hash common.Hash) *rawdb.LegacyTxLookupEntry
- func (bc *BlockChain) GetUnclesInChain(block *types.Block, length int) []*types.Header
- func (bc *BlockChain) GetVMConfig() *vm.Config
- func (bc *BlockChain) HasBlock(hash common.Hash, number uint64) bool
- func (bc *BlockChain) HasBlockAndState(hash common.Hash, number uint64) bool
- func (bc *BlockChain) HasFastBlock(hash common.Hash, number uint64) bool
- func (bc *BlockChain) HasHeader(hash common.Hash, number uint64) bool
- func (bc *BlockChain) HasState(hash common.Hash) bool
- func (bc *BlockChain) InsertBlockWithoutSetHead(block *types.Block) error
- func (bc *BlockChain) InsertChain(chain types.Blocks) (int, error)
- func (bc *BlockChain) InsertHeaderChain(chain []*types.Header, checkFreq int) (int, error)
- func (bc *BlockChain) InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts, ancientLimit uint64) (int, error)
- func (bc *BlockChain) Processor() Processor
- func (bc *BlockChain) Reset() error
- func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block) error
- func (bc *BlockChain) SetBlockValidatorAndProcessorForTesting(v Validator, p Processor)
- func (bc *BlockChain) SetCanonical(head *types.Block) (common.Hash, error)
- func (bc *BlockChain) SetFinalized(header *types.Header)
- func (bc *BlockChain) SetHead(head uint64) error
- func (bc *BlockChain) SetHeadWithTimestamp(timestamp uint64) error
- func (bc *BlockChain) SetSafe(header *types.Header)
- func (bc *BlockChain) SetTrieFlushInterval(interval time.Duration)
- func (bc *BlockChain) SetTxLookupLimit(limit uint64)
- func (bc *BlockChain) SnapSyncCommitHead(hash common.Hash) error
- func (bc *BlockChain) Snapshots() *snapshot.Tree
- func (bc *BlockChain) State() (*state.StateDB, error)
- func (bc *BlockChain) StateAt(root common.Hash) (*state.StateDB, error)
- func (bc *BlockChain) StateCache() state.Database
- func (bc *BlockChain) Stop()
- func (bc *BlockChain) StopInsert()
- func (bc *BlockChain) SubscribeBlockProcessingEvent(ch chan<- bool) event.Subscription
- func (bc *BlockChain) SubscribeChainEvent(ch chan<- ChainEvent) event.Subscription
- func (bc *BlockChain) SubscribeChainHeadEvent(ch chan<- ChainHeadEvent) event.Subscription
- func (bc *BlockChain) SubscribeChainSideEvent(ch chan<- ChainSideEvent) event.Subscription
- func (bc *BlockChain) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
- func (bc *BlockChain) SubscribeRemovedLogsEvent(ch chan<- RemovedLogsEvent) event.Subscription
- func (bc *BlockChain) TrieDB() *trie.Database
- func (bc *BlockChain) TrieNode(hash common.Hash) ([]byte, error)
- func (bc *BlockChain) TxLookupLimit() uint64
- func (bc *BlockChain) Validator() Validator
- func (bc *BlockChain) WriteBlockAndSetHead(block *types.Block, receipts []*types.Receipt, logs []*types.Log, ...) (status WriteStatus, err error)
- type BlockGen
- func (b *BlockGen) AddTx(tx *types.Transaction)
- func (b *BlockGen) AddTxWithChain(bc *BlockChain, tx *types.Transaction)
- func (b *BlockGen) AddTxWithVMConfig(tx *types.Transaction, config vm.Config)
- func (b *BlockGen) AddUncheckedReceipt(receipt *types.Receipt)
- func (b *BlockGen) AddUncheckedTx(tx *types.Transaction)
- func (b *BlockGen) AddUncle(h *types.Header)
- func (b *BlockGen) AddWithdrawal(w *types.Withdrawal) uint64
- func (b *BlockGen) BaseFee() *big.Int
- func (b *BlockGen) GetBalance(addr common.Address) *big.Int
- func (b *BlockGen) Number() *big.Int
- func (b *BlockGen) OffsetTime(seconds int64)
- func (b *BlockGen) PrevBlock(index int) *types.Block
- func (b *BlockGen) SetCoinbase(addr common.Address)
- func (b *BlockGen) SetDifficulty(diff *big.Int)
- func (b *BlockGen) SetExtra(data []byte)
- func (b *BlockGen) SetNonce(nonce types.BlockNonce)
- func (b *BlockGen) SetPoS()
- func (b *BlockGen) Timestamp() uint64
- func (b *BlockGen) TxNonce(addr common.Address) uint64
- type BlockValidator
- type BloomIndexer
- type CacheConfig
- type ChainContext
- type ChainEvent
- type ChainHeadEvent
- type ChainIndexer
- func (c *ChainIndexer) AddCheckpoint(section uint64, shead common.Hash)
- func (c *ChainIndexer) AddChildIndexer(indexer *ChainIndexer)
- func (c *ChainIndexer) Close() error
- func (c *ChainIndexer) Prune(threshold uint64) error
- func (c *ChainIndexer) SectionHead(section uint64) common.Hash
- func (c *ChainIndexer) Sections() (uint64, uint64, common.Hash)
- func (c *ChainIndexer) Start(chain ChainIndexerChain)
- type ChainIndexerBackend
- type ChainIndexerChain
- type ChainOverrides
- type ChainReader
- type ChainSideEvent
- type DeleteBlockContentCallback
- type ExecutionResult
- type ForkChoice
- type GasPool
- type Genesis
- func DefaultGenesisBlock() *Genesis
- func DefaultGoerliGenesisBlock() *Genesis
- func DefaultRinkebyGenesisBlock() *Genesis
- func DefaultSepoliaGenesisBlock() *Genesis
- func DeveloperGenesisBlock(period uint64, gasLimit uint64, faucet common.Address) *Genesis
- func ReadGenesis(db ethdb.Database) (*Genesis, error)
- type GenesisAccount
- type GenesisAlloc
- type GenesisMismatchError
- type HeaderChain
- func (hc *HeaderChain) Config() *params.ChainConfig
- func (hc *HeaderChain) CurrentHeader() *types.Header
- func (hc *HeaderChain) Engine() consensus.Engine
- func (hc *HeaderChain) GetAncestor(hash common.Hash, number, ancestor uint64, maxNonCanonical *uint64) (common.Hash, uint64)
- func (hc *HeaderChain) GetBlock(hash common.Hash, number uint64) *types.Block
- func (hc *HeaderChain) GetBlockNumber(hash common.Hash) *uint64
- func (hc *HeaderChain) GetCanonicalHash(number uint64) common.Hash
- func (hc *HeaderChain) GetHeader(hash common.Hash, number uint64) *types.Header
- func (hc *HeaderChain) GetHeaderByHash(hash common.Hash) *types.Header
- func (hc *HeaderChain) GetHeaderByNumber(number uint64) *types.Header
- func (hc *HeaderChain) GetHeadersFrom(number, count uint64) []rlp.RawValue
- func (hc *HeaderChain) GetTd(hash common.Hash, number uint64) *big.Int
- func (hc *HeaderChain) HasHeader(hash common.Hash, number uint64) bool
- func (hc *HeaderChain) InsertHeaderChain(chain []*types.Header, start time.Time, forker *ForkChoice) (WriteStatus, error)
- func (hc *HeaderChain) Reorg(headers []*types.Header) error
- func (hc *HeaderChain) SetCurrentHeader(head *types.Header)
- func (hc *HeaderChain) SetGenesis(head *types.Header)
- func (hc *HeaderChain) SetHead(head uint64, updateFn UpdateHeadBlocksCallback, ...)
- func (hc *HeaderChain) SetHeadWithTimestamp(time uint64, updateFn UpdateHeadBlocksCallback, ...)
- func (hc *HeaderChain) ValidateHeaderChain(chain []*types.Header, checkFreq int) (int, error)
- func (hc *HeaderChain) WriteHeaders(headers []*types.Header) (int, error)
- type Message
- type NewMinedBlockEvent
- type NewTxsEvent
- type Prefetcher
- type Processor
- type RemovedLogsEvent
- type StateProcessor
- type StateTransition
- type UpdateHeadBlocksCallback
- type Validator
- type WriteStatus
Examples ¶
Constants ¶
const ( TriesInMemory = 128 // 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 )
const KilnAllocData = `` /* 38014-byte string literal not displayed */
Variables ¶
var ( // ErrKnownBlock is returned when a block to import is already known locally. ErrKnownBlock = errors.New("block already known") // ErrBannedHash is returned if a block to import is on the banned list. ErrBannedHash = errors.New("banned hash") // ErrNoGenesis is returned when there is no Genesis Block. ErrNoGenesis = errors.New("genesis not found in chain") )
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") )
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.
var BadHashes = map[common.Hash]bool{ common.HexToHash("05bef30ef572270f654746da22639a7a0c97dd97a7050b9e252391996aaeb689"): true, common.HexToHash("7d05d08cbc596a2e5e4f13b80a743e53e09221b5323c3a61946b20873e58583f"): true, }
BadHashes represent a set of manually tracked bad hashes (usually hard forks)
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 CalcGasLimit ¶ added in v0.8.4
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
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 CommitGenesisState ¶ added in v1.10.17
CommitGenesisState loads the stored genesis state with the given block hash and commits it into the provided trie database.
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() ) // Ensure that key1 has some funds in the genesis block. gspec := &Genesis{ Config: ¶ms.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, ethash.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, nil, ethash.NewFaker(), vm.Config{}, nil, 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 GetHashFn ¶ added in v1.4.0
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 bool, isHomestead, isEIP2028 bool, isEIP3860 bool) (uint64, error)
IntrinsicGas computes the 'intrinsic gas' for a message with the given data.
func LoadCliqueConfig ¶ added in v1.11.0
LoadCliqueConfig loads the stored clique config if the chain config is already present in database, otherwise, return the config in the provided genesis specification. Note the returned clique config can be nil if we are not in the clique network.
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
NewEVMTxContext creates a new transaction context for a single transaction.
func SetupGenesisBlock ¶ added in v1.6.0
func SetupGenesisBlock(db ethdb.Database, triedb *trie.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
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, shouldPreserve func(header *types.Header) 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) Config ¶ added in v1.4.1
func (bc *BlockChain) Config() *params.ChainConfig
Config retrieves the chain's fork configuration.
func (*BlockChain) ContractCode ¶ added in v1.9.20
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.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
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
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
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
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
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
GetTransactionLookup retrieves the lookup associate with the given transaction hash from the cache or database.
func (*BlockChain) GetUnclesInChain ¶ added in v1.3.1
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) InsertBlockWithoutSetHead ¶ added in v1.10.14
func (bc *BlockChain) InsertBlockWithoutSetHead(block *types.Block) 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
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 ¶ 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
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 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) 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 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) 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) SetTxLookupLimit ¶ added in v1.9.14
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) 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
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) SubscribeChainSideEvent ¶ added in v1.7.0
func (bc *BlockChain) SubscribeChainSideEvent(ch chan<- ChainSideEvent) event.Subscription
SubscribeChainSideEvent registers a subscription of ChainSideEvent.
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() *trie.Database
TrieDB retrieves the low level trie database used for data storage.
func (*BlockChain) TrieNode ¶ added in v1.8.0
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.9.14
func (bc *BlockChain) TxLookupLimit() uint64
TxLookupLimit retrieves the txlookup limit used by blockchain to prune stale transaction indices.
func (*BlockChain) Validator ¶ added in v1.3.2
func (bc *BlockChain) Validator() Validator
Validator returns the current validator.
func (*BlockChain) WriteBlockAndSetHead ¶ added in v1.10.14
func (bc *BlockChain) WriteBlockAndSetHead(block *types.Block, receipts []*types.Receipt, logs []*types.Log, state *state.StateDB, emitHeadEvent bool) (status WriteStatus, err error)
WriteBlockAndSetHead writes the given block and all associated state to the database, and applies the block as the new chain head.
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.
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
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) 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
BaseFee returns the EIP-1559 base fee of the block being generated.
func (*BlockGen) GetBalance ¶ added in v1.10.2
GetBalance returns the balance of the given address at the generated block.
func (*BlockGen) Number ¶ added in v1.4.0
Number returns the block number of the block being generated.
func (*BlockGen) OffsetTime ¶ added in v1.2.2
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
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
SetCoinbase sets the coinbase of the generated block. It can be called at most once.
func (*BlockGen) SetDifficulty ¶ added in v1.9.0
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
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) SetPoS ¶ added in v1.11.0
func (b *BlockGen) SetPoS()
SetPos makes the header a PoS-header (0 difficulty)
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, engine consensus.Engine) *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, 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.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
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.
type CacheConfig ¶ added in v1.8.0
type CacheConfig struct { 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 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 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 that's resident in a blockchain.
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 ChainHeadEvent ¶ added in v0.9.17
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 {
OverrideShanghai *uint64
}
ChainOverrides contains the changes to chain config.
type ChainReader ¶ added in v1.10.14
type ChainReader interface { // Config retrieves the header chain's chain configuration. Config() *params.ChainConfig // GetTd returns the total difficulty of a local block. GetTd(common.Hash, uint64) *big.Int }
ChainReader defines a small collection of methods needed to access the local blockchain during header verification. It's implemented by both blockchain and lightchain.
type ChainSideEvent ¶ added in v0.9.17
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 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 ¶ added in v0.9.17
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 ForkChoice ¶ added in v1.10.14
type ForkChoice struct {
// contains filtered or unexported fields
}
ForkChoice is the fork chooser based on the highest total difficulty of the chain(the fork choice used in the eth1) and the external fork choice (the fork choice used in the eth2). This main goal of this ForkChoice is not only for offering fork choice during the eth1/2 merge phase, but also keep the compatibility for all other proof-of-work networks.
func NewForkChoice ¶ added in v1.10.14
func NewForkChoice(chainReader ChainReader, preserve func(header *types.Header) bool) *ForkChoice
func (*ForkChoice) ReorgNeeded ¶ added in v1.10.14
ReorgNeeded returns whether the reorg should be applied based on the given external header and local canonical chain. In the td mode, the new head is chosen if the corresponding total difficulty is higher. In the extern mode, the trusted header is always selected as the head.
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.
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 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 ¶ added in v1.4.0
func DefaultGenesisBlock() *Genesis
DefaultGenesisBlock returns the Ethereum main net genesis block.
func DefaultGoerliGenesisBlock ¶ added in v1.8.23
func DefaultGoerliGenesisBlock() *Genesis
DefaultGoerliGenesisBlock returns the Görli network genesis block.
func DefaultRinkebyGenesisBlock ¶ added in v1.6.1
func DefaultRinkebyGenesisBlock() *Genesis
DefaultRinkebyGenesisBlock returns the Rinkeby 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
DeveloperGenesisBlock returns the 'geth --dev' genesis block.
func (*Genesis) Commit ¶ added in v1.6.0
Commit writes the block and state of a genesis specification to the database. The block is committed as the canonical head block.
func (Genesis) MarshalJSON ¶ added in v1.6.0
MarshalJSON marshals as JSON.
func (*Genesis) MustCommit ¶ added in v1.6.0
MustCommit writes the genesis block and state to db, panicking on error. The block is committed as the canonical head block. Note the state changes will be committed in hash-based scheme, use Commit if path-scheme is preferred.
func (*Genesis) ToBlock ¶ added in v1.6.0
ToBlock returns the genesis block according to genesis specification.
func (*Genesis) UnmarshalJSON ¶ added in v1.6.0
UnmarshalJSON unmarshals from JSON.
type GenesisAccount ¶ added in v1.2.2
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 ¶ added in v1.6.0
func (g GenesisAccount) MarshalJSON() ([]byte, error)
MarshalJSON marshals as JSON.
func (*GenesisAccount) UnmarshalJSON ¶ added in v1.6.0
func (g *GenesisAccount) UnmarshalJSON(input []byte) error
UnmarshalJSON unmarshals from JSON.
type GenesisAlloc ¶ added in v1.6.0
type GenesisAlloc map[common.Address]GenesisAccount
GenesisAlloc specifies the initial state that is part of the genesis block.
func (*GenesisAlloc) UnmarshalJSON ¶ added in v1.6.7
func (ga *GenesisAlloc) UnmarshalJSON(data []byte) error
type GenesisMismatchError ¶ added in v1.6.0
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 that is shared by core.BlockChain and light.LightChain. It is not usable in itself, only as a part of either structure.
HeaderChain is responsible for maintaining the header chain including the header query and updating.
The components maintained by headerchain includes: (1) total difficulty (2) header (3) block hash -> number mapping (4) canonical number -> hash mapping and (5) head header flag.
It is not thread safe either, 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
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
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
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, forker *ForkChoice) (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 (*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 // When SkipAccountCheckss is true, the message nonce is not checked against the // account nonce in state. It also disables checking that the sender is an EOA. // This field will be set to true for operations like RPC eth_call. SkipAccountChecks 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 NewMinedBlockEvent ¶ added in v0.8.4
NewMinedBlockEvent is posted when a block has been imported.
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 *uint32) }
Prefetcher is an interface for pre-caching transaction signatures and state.
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) (types.Receipts, []*types.Log, uint64, error) }
Processor is an interface for processing blocks using a given initial state.
type RemovedLogsEvent ¶ added in v1.4.0
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, bc *BlockChain, engine consensus.Engine) *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) (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 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.
- Nonce handling
- Pre pay gas
- Create a new state object if the recipient is nil
- Value transfer
== If contract creation ==
4a. Attempt to run transaction data 4b. If valid, use result as code for the new state object
== end ==
- Run Script section
- 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 UpdateHeadBlocksCallback ¶ added in v1.9.0
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 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 ¶ added in v1.4.0
type WriteStatus byte
WriteStatus status of write
const ( NonStatTy WriteStatus = iota CanonStatTy SideStatTy )
Source Files
¶
- block_validator.go
- blockchain.go
- blockchain_insert.go
- blockchain_reader.go
- blocks.go
- bloom_indexer.go
- chain_indexer.go
- chain_makers.go
- error.go
- events.go
- evm.go
- forkchoice.go
- gaspool.go
- gen_genesis.go
- gen_genesis_account.go
- genesis.go
- genesis_alloc.go
- headerchain.go
- sender_cacher.go
- state_prefetcher.go
- state_processor.go
- state_transition.go
- types.go
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. |
Package state provides a caching layer atop the Ethereum state trie.
|
Package state provides a caching layer atop the Ethereum state trie. |
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. |
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. |