blockchain

package
v1.9.0-rc.6 Latest Latest
Warning

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

 Go to latest Published: Jul 28, 2022 License: GPL-3.0 Imports: 47 Imported by: 110

Documentation

Overview

Package blockchain implements the canonical chain and the state transition model of Klaytn.

A Klaytn node starts to generate a chain from a genesis block and appends validated blocks transferred from other nodes or generated by the node. Each block containing transactions is validated and processed by each node transiting the global state of the system. The state transition containing EVM execution is triggered by transactions that containing transition messages for the state. Transactions are delivered by RPC servers or other nodes, managed by the tx pool and aggregated to a block. As well as the exact transaction process, Klaytn achieved the efficiency of the transaction processing through a caching logic. The cacheSender concurrently recovers and caches an address from a signature in the transaction which was one of the main bottlenecks of transaction processing.

Source files

Each file provides the following features

  • bad_blocks.go : keeps block hashes of bad blocks which are usually for hard forks.
  • block_validator.go : implements BlockValidator which is responsible for validation block headers and the processed state.
  • blockchain.go : implements the canonical chain of blocks and managing functions to support imports, reverts and reorganisations.
  • chain_indexer.go : implements ChainIndexer.
  • chain_makers.go : generates temporary blocks or chains to support SimulatedBackend.
  • error.go : defines errors frequently used in blockchain package.
  • events.go : defines event structs delivered between go-routines.
  • evm.go : creates an EVM with a given context for use.
  • gaspool.go : defines GasPool which tracks and manages the amount of gas available during the transaction execution.
  • gen_genesis.go : is auto-generated code by gencodec to marshal/unmarshal Genesis as/from JSON.
  • gen_genesis_account.go : is auto-generated code by gencodec to marshal/unmarshal GenesisAccount as/from JSON.
  • genesis.go : defines Genesis which specifies values of a genesis block and initial settings of the chain.
  • genesis_alloc.go : contains the genesis allocation of built-in genesis blocks.
  • headerchain.go : implements HeaderChain which makes a chain with block headers.
  • init_derive_sha.go : initialize a DeriveSha function with a specific type.
  • metrics.go : contains metrics used for blockchain package.
  • mkalloc.go : creates the genesis allocation constants in genesis_alloc.go.
  • state_processor.go : implements StateProcessor which takes care of transitioning state.
  • state_transition.go : implements a state transaction model worked with messages in transactions.
  • tx_cacher.go : recovers senders of transactions from signatures and caches the sender address.
  • tx_journal.go: keeps logs of transactions created by the local node.
  • tx_list.go : provides sorted map and list structures used in tx pool manipulation.
  • tx_pool.go : contains all currently known transactions and manages the transactions.
  • types.go : interfaces Validator and Processor which validate or process block data.

Index

Constants

View Source 
const (
	DefaultTriesInMemory = 128
	DefaultBlockInterval = 128
	MaxPrefetchTxs       = 20000

	// BlockChainVersion ensures that an incompatible database forces a resync from scratch.
	// Changelog:
	// - Version 4
	// The following incompatible database changes were added:
	//   * New scheme for contract code in order to separate the codes and trie nodes
	BlockChainVersion = 4
)
View Source 
const (

	// MaxTxDataSize is a heuristic limit of tx data size, and txPool rejects transactions over 32KB to prevent DOS attacks.
	MaxTxDataSize = 32 * 1024
)

Variables

View Source 
var (
	ErrNoGenesis    = errors.New("genesis not found in chain")
	ErrNotExistNode = errors.New("the node does not exist in cached node")
	ErrQuitBySignal = errors.New("quit by signal")
	ErrNotInWarmUp  = errors.New("not in warm up")
)
View Source 
var (
	// ErrKnownBlock is returned when a block to import is already known locally.
	ErrKnownBlock = errors.New("block already known")

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

	// ErrBlacklistedHash is returned if a block to import is on the blacklist.
	ErrBlacklistedHash = errors.New("blacklisted hash")

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

	// ErrInvalidSender is returned if the transaction contains an invalid signature.
	ErrInvalidSender = errors.New("invalid sender")

	// ErrInvalidFeePayer is returned if the transaction contains an invalid signature of the fee payer.
	ErrInvalidFeePayer = errors.New("invalid fee payer")

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

	// ErrUnderpriced is returned if a transaction's gas price is below the minimum
	// configured for the transaction pool.
	ErrUnderpriced = errors.New("transaction underpriced")

	// ErrReplaceUnderpriced is returned if a transaction is attempted to be replaced
	// with a different one without the required price bump.
	ErrReplaceUnderpriced = errors.New("replacement transaction underpriced")

	// ErrAlreadyNonceExistInPool is returned if there is another tx with the same nonce in the tx pool.
	ErrAlreadyNonceExistInPool = errors.New("there is another tx which has the same nonce in the tx pool")

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

	// ErrInsufficientFundsFrom is returned if the value of a transaction is higher than
	// the balance of the user's account.
	ErrInsufficientFundsFrom = errors.New("insufficient funds of the sender for value ")

	// ErrInsufficientFundsFeePayer is returned if the fee of a transaction is higher than
	// the balance of the fee payer's account.
	ErrInsufficientFundsFeePayer = errors.New("insufficient funds of the fee payer for gas * price")

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

	// ErrGasLimit is returned if a transaction's requested gas limit exceeds the
	// maximum allowance of the current block.
	ErrGasLimit = errors.New("exceeds block gas limit")

	// ErrNegativeValue is a sanity error to ensure noone is able to specify a
	// transaction with a negative value.
	ErrNegativeValue = errors.New("negative value")

	// ErrOversizedData is returned if the input data of a transaction is greater
	// than some meaningful limit a user might use. This is not a consensus error
	// making the transaction invalid, rather a DOS protection.
	ErrOversizedData = errors.New("oversized data")

	// ErrInvlidUnitPrice is returned if gas price of transaction is not equal to UnitPrice
	ErrInvalidUnitPrice = errors.New("invalid unit price")

	// ErrInvalidChainId is returned if the chain id of transaction is not equal to the chain id of the chain config.
	ErrInvalidChainId = errors.New("invalid chain id")

	// ErrNotYetImplementedAPI is returned if API is not yet implemented
	ErrNotYetImplementedAPI = errors.New("not yet implemented API")

	// ErrInvalidReceiptStatus is returned if status of receipt is invalid from GetVMerrFromReceiptStatus
	ErrInvalidReceiptStatus = errors.New("unknown receipt status")

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

	// ErrVMDefault is returned if status of receipt is ReceiptStatusErrDefault from GetVMerrFromReceiptStatus
	ErrVMDefault = errors.New("VM error occurs while running smart contract")

	// ErrAccountCreationPrevented is returned if account creation is inserted in the service chain's txpool.
	ErrAccountCreationPrevented = errors.New("account creation is prevented for the service chain")

	// ErrInvalidTracer is returned if the tracer type is not vm.InternalTxTracer
	ErrInvalidTracer = errors.New("tracer type is invalid for internal transaction tracing")

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

	// 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 fee per gas higher than max priority fee per gas")

	// ErrInvalidGasFeeCap is returned if gas fee cap of transaction is not equal to UnitPrice
	ErrInvalidGasFeeCap = errors.New("invalid gas fee cap. It must be set to the same value as gas unit price")

	// ErrInvalidGasTipCap is returned if gas tip cap of transaction is not equal to UnitPrice
	ErrInvalidGasTipCap = errors.New("invalid gas tip cap. It must be set to the same value as gas unit price")

	// ErrFeeCapBelowBaseFee is returned if gas fee cap of transaction is lower than gas unit price.
	ErrFeeCapBelowBaseFee = errors.New("invalid gas fee cap. It must be set to value greater than or equal to baseFee")

	// ErrGasPriceBelowBaseFee is returned if gas price of transaction is lower than gas unit price.
	ErrGasPriceBelowBaseFee = errors.New("invalid gas price. It must be set to value greater than or equal to baseFee")
)
View Source 
var BadHashes = map[common.Hash]bool{}

BadHashes represent a set of manually tracked bad hashes (usually hard forks)

View Source 
var DefaultSpamThrottlerConfig = &ThrottlerConfig{
	ActivateTxPoolSize: 1000,
	TargetFailRatio:    20,
	ThrottleTPS:        100,
	MaxCandidates:      10000,

	IncreaseWeight:      5,
	DecreaseWeight:      1,
	InitialThreshold:    500,
	MinimumThreshold:    100,
	ThresholdAdjustment: 5,
	ThrottleSeconds:     300,
}
View Source 
var DefaultTxPoolConfig = TxPoolConfig{
	Journal:         "transactions.rlp",
	JournalInterval: time.Hour,

	PriceLimit: 1,
	PriceBump:  10,

	ExecSlotsAccount:    16,
	ExecSlotsAll:        4096,
	NonExecSlotsAccount: 64,
	NonExecSlotsAll:     1024,

	KeepLocals: false,
	Lifetime:   5 * time.Minute,
}

DefaultTxPoolConfig contains the default configurations for the transaction pool.

Functions

func ApplyMessage 

func ApplyMessage(evm *vm.EVM, msg Message) ([]byte, uint64, kerror)

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 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 CheckBlockChainVersion added in v1.2.0 

func CheckBlockChainVersion(chainDB database.DBManager) error

CheckBlockChainVersion checks the version of the current database and upgrade if possible.

func GenerateChain 

func GenerateChain(config *params.ChainConfig, parent *types.Block, engine consensus.Engine, db database.DBManager, 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 added to the generator become part of the block. If gen is nil, the blocks will be empty.

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.

func GenesisBlockForTesting 

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

GenesisBlockForTesting creates and writes a block in which addr has the given peb 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 GetInternalTxTrace added in v1.5.2 

func GetInternalTxTrace(tracer vm.Tracer) (*vm.InternalTxTrace, error)

func GetSpamThrottler added in v1.7.3 

func GetSpamThrottler() *throttler

func GetVMerrFromReceiptStatus 

func GetVMerrFromReceiptStatus(status uint) (errTxFailed error)

GetVMerrFromReceiptStatus returns VM error according to status of receipt.

func InitDeriveSha 

func InitDeriveSha(deriveShaImpl int)

func NewEVMContext 

func NewEVMContext(msg Message, header *types.Header, chain ChainContext, author *common.Address) vm.Context

NewEVMContext creates a new context for use in the EVM.

func RegisterMigrationPrerequisites added in v1.5.0 

func RegisterMigrationPrerequisites(f func(uint64) error)

func SetGenesisGovernance added in v1.1.0 

func SetGenesisGovernance(genesis *Genesis) []byte

func SetReceiptsData 

func SetReceiptsData(config *params.ChainConfig, block *types.Block, receipts types.Receipts) error

SetReceiptsData computes all the non-consensus fields of the receipts

func SetupGenesisBlock 

func SetupGenesisBlock(db database.DBManager, genesis *Genesis, networkId uint64, isPrivate, overwriteGenesis bool) (*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, baobab if specified  |  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 BadBlockArgs 

type BadBlockArgs struct {
	Hash  common.Hash  `json:"hash"`
	Block *types.Block `json:"block"`
}

BadBlockArgs represents the entries in the list returned when bad blocks are queried.

type BlockChain 

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 

func NewBlockChain(db database.DBManager, cacheConfig *CacheConfig, chainConfig *params.ChainConfig, engine consensus.Engine, vmConfig vm.Config) (*BlockChain, error)

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

func (*BlockChain) ApplyTransaction added in v1.3.0 

func (bc *BlockChain) ApplyTransaction(chainConfig *params.ChainConfig, author *common.Address, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *uint64, vmConfig *vm.Config) (*types.Receipt, uint64, *vm.InternalTxTrace, 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 (*BlockChain) BadBlocks 

func (bc *BlockChain) BadBlocks() ([]BadBlockArgs, error)

BadBlocks returns a list of the last 'bad blocks' that the client has seen on the network

func (*BlockChain) BlockSubscriptionLoop added in v1.5.3 

func (bc *BlockChain) BlockSubscriptionLoop(pool *TxPool)

BlockSubscriptionLoop subscribes blocks from a redis server and processes them. This method is only for KES nodes.

func (*BlockChain) CloseBlockSubscriptionLoop added in v1.5.3 

func (bc *BlockChain) CloseBlockSubscriptionLoop()

CloseBlockSubscriptionLoop closes BlockSubscriptionLoop.

func (*BlockChain) Config 

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

Config retrieves the blockchain's chain configuration.

func (*BlockChain) ContractCode added in v1.9.0 

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

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

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

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

func (*BlockChain) Genesis 

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

Genesis retrieves the chain's genesis block.

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

func (bc *BlockChain) GetBlockNumber(hash common.Hash) *uint64

GetBlockNumber retrieves a blockNumber from the database by hash, caching it if found.

func (*BlockChain) GetBlockReceiptsInCache 

func (bc *BlockChain) GetBlockReceiptsInCache(blockHash common.Hash) types.Receipts

GetBlockReceiptsInCache returns receipt of txHash in cache.

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) GetContractStorageRoot added in v1.6.0 

func (bc *BlockChain) GetContractStorageRoot(block *types.Block, db state.Database, contractAddr common.Address) (common.Hash, error)

GetContractStorageRoot returns the storage root of a contract based on the given block.

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

func (bc *BlockChain) GetLogsByHash(hash common.Hash) [][]*types.Log

GetLogsByHash retrieves the logs for all receipts in a given block.

func (*BlockChain) GetReceiptByTxHash 

func (bc *BlockChain) GetReceiptByTxHash(txHash common.Hash) *types.Receipt

GetReceiptByTxHash retrieves a receipt for a given transaction hash.

func (*BlockChain) GetReceiptsByBlockHash 

func (bc *BlockChain) GetReceiptsByBlockHash(blockHash common.Hash) types.Receipts

GetReceiptsByBlockHash retrieves the receipts for all transactions with given block hash.

func (*BlockChain) GetTd 

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

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

func (*BlockChain) GetTdByHash 

func (bc *BlockChain) GetTdByHash(hash common.Hash) *big.Int

GetTdByHash retrieves a block's total blockscore in the canonical chain from the database by hash, caching it if found.

func (*BlockChain) GetTxAndLookupInfo 

func (bc *BlockChain) GetTxAndLookupInfo(txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)

GetTxAndLookupInfo retrieves a tx and lookup info for a given transaction hash.

func (*BlockChain) GetTxAndLookupInfoInCache 

func (bc *BlockChain) GetTxAndLookupInfoInCache(hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)

GetTxAndLookupInfoInCache retrieves a tx and lookup info for a given transaction hash in cache.

func (*BlockChain) GetTxLookupInfoAndReceipt 

func (bc *BlockChain) GetTxLookupInfoAndReceipt(txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, *types.Receipt)

GetTxLookupInfoAndReceipt retrieves a tx and lookup info and receipt for a given transaction hash.

func (*BlockChain) GetTxLookupInfoAndReceiptInCache 

func (bc *BlockChain) GetTxLookupInfoAndReceiptInCache(txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, *types.Receipt)

GetTxLookupInfoAndReceiptInCache retrieves a tx and lookup info and receipt for a given transaction hash in cache.

func (*BlockChain) GetTxReceiptInCache 

func (bc *BlockChain) GetTxReceiptInCache(txHash common.Hash) *types.Receipt

GetTxReceiptInCache returns receipt of txHash in cache.

func (*BlockChain) HasBadBlock 

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

istanbul BFT

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) 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) (int, error)

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

func (*BlockChain) IsParallelDBWrite 

func (bc *BlockChain) IsParallelDBWrite() bool

IsParallelDBWrite returns if parallel write is enabled or not. If enabled, data written in WriteBlockWithState is being written in parallel manner.

func (*BlockChain) IsSenderTxHashIndexingEnabled 

func (bc *BlockChain) IsSenderTxHashIndexingEnabled() bool

IsSenderTxHashIndexingEnabled returns if storing senderTxHash to txHash mapping information is enabled or not.

func (*BlockChain) PostChainEvents 

func (bc *BlockChain) PostChainEvents(events []interface{}, logs []*types.Log)

PostChainEvents iterates over the events generated by a chain insertion and posts them into the event feed. TODO: Should not expose PostChainEvents. The chain events should be posted in WriteBlock.

func (*BlockChain) PrepareStateMigration added in v1.5.0 

func (bc *BlockChain) PrepareStateMigration() error

PrepareStateMigration sets prepareStateMigration to be called in checkStartStateMigration.

func (*BlockChain) Processor 

func (bc *BlockChain) Processor() Processor

Processor returns the current processor.

func (*BlockChain) ProposerPolicy added in v1.1.0 

func (bc *BlockChain) ProposerPolicy() uint64

func (*BlockChain) RLockGCCachedNode added in v1.4.0 

func (bc *BlockChain) RLockGCCachedNode()

RLockGCCachedNode locks the GC lock of CachedNode.

func (*BlockChain) RUnlockGCCachedNode added in v1.4.0 

func (bc *BlockChain) RUnlockGCCachedNode()

RUnlockGCCachedNode unlocks the GC lock of CachedNode.

func (*BlockChain) Reset 

func (bc *BlockChain) Reset() error

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

func (*BlockChain) ResetWithGenesisBlock 

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

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

func (*BlockChain) Rollback 

func (bc *BlockChain) Rollback(chain []common.Hash)

Rollback is designed to remove a chain of links from the database that aren't certain enough to be valid.

func (*BlockChain) SaveTrieNodeCacheToDisk added in v1.5.3 

func (bc *BlockChain) SaveTrieNodeCacheToDisk() error

func (*BlockChain) SetBaseFeeDenominator added in v1.9.0 

func (bc *BlockChain) SetBaseFeeDenominator(val uint64)

func (*BlockChain) SetCanonicalBlock added in v1.5.3 

func (bc *BlockChain) SetCanonicalBlock(blockNum uint64)

SetCanonicalBlock resets the canonical as the block with the given block number. It works as rewinding the head block to the previous one, but does not delete the data.

func (*BlockChain) SetGasTarget added in v1.9.0 

func (bc *BlockChain) SetGasTarget(val uint64)

func (*BlockChain) SetHead 

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

SetHead rewinds the local chain to a new head with the extra condition that the rewind must pass the specified state root. The method will try to delete minimal data from disk whilst retaining chain consistency.

func (*BlockChain) SetLowerBoundBaseFee added in v1.9.0 

func (bc *BlockChain) SetLowerBoundBaseFee(val uint64)

func (*BlockChain) SetMaxBlockGasUsedForBaseFee added in v1.9.0 

func (bc *BlockChain) SetMaxBlockGasUsedForBaseFee(val uint64)

func (*BlockChain) SetProposerPolicy added in v1.1.0 

func (bc *BlockChain) SetProposerPolicy(val uint64)

func (*BlockChain) SetUpperBoundBaseFee added in v1.9.0 

func (bc *BlockChain) SetUpperBoundBaseFee(val uint64)

func (*BlockChain) SetUseGiniCoeff added in v1.1.0 

func (bc *BlockChain) SetUseGiniCoeff(val bool)

func (*BlockChain) ShouldTryInserting added in v1.3.0 

func (bc *BlockChain) ShouldTryInserting(block *types.Block) bool

ShouldTryInserting returns the state whether the block should be inserted. If a node doesn't have the given block or the block number of given block is higher than the node's head block, it can try inserting the block.

func (*BlockChain) Snapshots added in v1.9.0 

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

Snapshots returns the blockchain snapshot tree.

func (*BlockChain) StartCollectingTrieStats added in v1.6.0 

func (bc *BlockChain) StartCollectingTrieStats(contractAddr common.Address) error

StartCollectingTrieStats collects state or storage trie statistics.

func (*BlockChain) StartContractWarmUp added in v1.6.0 

func (bc *BlockChain) StartContractWarmUp(contractAddr common.Address) error

StartContractWarmUp retrieves a storage trie of the latest state root and caches the trie corresponding to the given contract address.

func (*BlockChain) StartStateMigration added in v1.5.0 

func (bc *BlockChain) StartStateMigration(number uint64, root common.Hash) error

StartStateMigration checks prerequisites, configures DB and starts migration.

func (*BlockChain) StartWarmUp added in v1.5.0 

func (bc *BlockChain) StartWarmUp() error

StartWarmUp retrieves all state/storage tries of the latest state root and caches the tries.

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) StateAtWithGCLock added in v1.4.0 

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

StateAtWithGCLock returns a new mutable state based on a particular point in time with read lock of the state nodes.

func (*BlockChain) StateAtWithPersistent added in v1.5.0 

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

StateAtWithPersistent returns a new mutable state based on a particular point in time with persistent trie nodes.

func (*BlockChain) StateCache 

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

StateCache returns the caching database underpinning the blockchain instance.

func (*BlockChain) StateMigrationStatus added in v1.5.0 

func (bc *BlockChain) StateMigrationStatus() (bool, uint64, int, int, int, float64, error)

StateMigrationStatus returns if it is in migration, the block number of in migration, number of committed blocks and number of pending blocks

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) StopStateMigration added in v1.5.0 

func (bc *BlockChain) StopStateMigration() error

func (*BlockChain) StopWarmUp added in v1.5.0 

func (bc *BlockChain) StopWarmUp() error

StopWarmUp stops the warming up process.

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) 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) 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) UseGiniCoeff added in v1.1.0 

func (bc *BlockChain) UseGiniCoeff() bool

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, stateDB *state.StateDB) (WriteResult, error)

WriteBlockWithState writes the block and all associated state to the database. If we are to use writeBlockWithState alone, we should use mutex to protect internal state.

func (*BlockChain) WriteBlockWithoutState 

func (bc *BlockChain) WriteBlockWithoutState(block *types.Block, td *big.Int)

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

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. In gxhash, arbitrary address is used as a block author's 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. In gxhash, arbitrary address is used as a block author's 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) 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.3.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) 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 blockscore. 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) SetExtra 

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

SetExtra sets the extra data field of the generated block.

func (*BlockGen) SetRewardbase 

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

SetRewardbase sets the rewardbase field of the generated block.

func (*BlockGen) SetVoteData 

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

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, parent *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 CacheConfig 

type CacheConfig struct {
	// TODO-Klaytn-Issue1666 Need to check the benefit of trie caching.
	ArchiveMode          bool                         // If true, state trie is not pruned and always written to database
	CacheSize            int                          // Size of in-memory cache of a trie (MiB) to flush matured singleton trie nodes to disk
	BlockInterval        uint                         // Block interval to flush the trie. Each interval state trie will be flushed into disk
	TriesInMemory        uint64                       // Maximum number of recent state tries according to its block number
	SenderTxHashIndexing bool                         // Enables saving senderTxHash to txHash mapping information to database and cache
	TrieNodeCacheConfig  *statedb.TrieNodeCacheConfig // Configures trie node cache
	SnapshotCacheSize    int                          // Memory allowance (MB) to use for caching snapshot entries in memory
}

CacheConfig contains the configuration values for the 1) stateDB caching and 2) trie caching/pruning resident in a blockchain.

type ChainContext 

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

	// GetHeader returns the hash corresponding to their hash.
	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
	Receipts         types.Receipts
	Logs             []*types.Log
	InternalTxTraces []*vm.InternalTxTrace
}

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 ChainEventLoop 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 NewChainIndexer 

func NewChainIndexer(chainDB, indexDB database.DBManager, 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) AddChildIndexer 

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

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

func (*ChainIndexer) AddKnownSectionHead 

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

AddKnownSectionHead marks a new section head as known/processed if it is newer than the already known best section head

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(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(header *types.Header)

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

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

ChainIndexerChain interface is used for connecting the indexer to a blockchain

type ChainSideEvent 

type ChainSideEvent struct {
	Block *types.Block
}

type DeleteBlockContentCallback added in v1.8.0 

type DeleteBlockContentCallback func(common.Hash, uint64)

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

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"`
	Timestamp  uint64              `json:"timestamp"`
	ExtraData  []byte              `json:"extraData"`
	Governance []byte              `json:"governanceData"`
	BlockScore *big.Int            `json:"blockScore"`
	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"`
}

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

func DefaultBaobabGenesisBlock 

func DefaultBaobabGenesisBlock() *Genesis

DefaultBaobabGenesisBlock returns the Baobab testnet genesis block.

func DefaultGenesisBlock 

func DefaultGenesisBlock() *Genesis

DefaultGenesisBlock returns the Cypress mainnet genesis block. It is also used for default genesis block.

func (*Genesis) Commit 

func (g *Genesis) Commit(baseStateRoot common.Hash, db database.DBManager) (*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) MarshalJSON 

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

MarshalJSON marshals as JSON.

func (*Genesis) MustCommit 

func (g *Genesis) MustCommit(db database.DBManager) *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(baseStateRoot common.Hash, db database.DBManager) *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) 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 (*GenesisAlloc) UnmarshalJSON 

func (ga *GenesisAlloc) UnmarshalJSON(data []byte) error

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 GovernanceSet 

type GovernanceSet map[string]interface{}

type HeaderChain 

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

HeaderChain implements the basic block header chain logic that is shared by blockchain.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 database.DBManager, config *params.ChainConfig, engine consensus.Engine, procInterrupt func() bool) (*HeaderChain, error)

NewHeaderChain creates a new HeaderChain structure. 

getValidator should return the parent's validator
procInterrupt points to the parent's interrupt semaphore
wg points to the parent's shutdown wait group

func (*HeaderChain) Config 

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

Config retrieves the header chain's chain configuration.

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

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

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

func (*HeaderChain) GetTdByHash 

func (hc *HeaderChain) GetTdByHash(hash common.Hash) *big.Int

GetTdByHash retrieves a block's total blockscore in the canonical chain from the database by hash, caching it if found.

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.

func (*HeaderChain) InsertHeaderChain 

func (hc *HeaderChain) InsertHeaderChain(chain []*types.Header, writeHeader WhCallback, start time.Time) (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 verfy nonces, as well as because nonces can be verified sparsely, not needing to check each.

func (*HeaderChain) SetCurrentHeader 

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

SetCurrentHeader sets the current head header of the canonical chain.

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

func (*HeaderChain) State 

func (hc *HeaderChain) State() (*state.StateDB, error)

func (*HeaderChain) ValidateHeaderChain 

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

func (*HeaderChain) WriteHeader 

func (hc *HeaderChain) WriteHeader(header *types.Header) (status WriteStatus, err error)

WriteHeader writes a header into the local chain, given that its parent is already known. If the total blockscore of the newly inserted header becomes greater than the current known TD, the canonical chain is re-routed.

Note: This method is not concurrent-safe with inserting blocks simultaneously into the chain, as side effects caused by reorganisations cannot be emulated without the real blocks. Hence, writing headers directly should only be done in two scenarios: pure-header mode of operation (light clients), or properly separated header/block phases (non-archive clients).

func (*HeaderChain) WriteTd 

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

WriteTd stores a block's total blockscore into the database, also caching it along the way.

type Message 

type Message interface {
	// ValidatedSender returns the sender of the transaction.
	// The returned sender should be derived by calling AsMessageAccountKeyPicker().
	ValidatedSender() common.Address

	// ValidatedFeePayer returns the fee payer of the transaction.
	// The returned fee payer should be derived by calling AsMessageAccountKeyPicker().
	ValidatedFeePayer() common.Address

	// ValidatedIntrinsicGas returns the intrinsic gas of the transaction.
	// The returned intrinsic gas should be derived by calling AsMessageAccountKeyPicker().
	ValidatedIntrinsicGas() uint64

	// FeeRatio returns a ratio of tx fee paid by the fee payer in percentage.
	// For example, if it is 30, 30% of tx fee will be paid by the fee payer.
	// 70% will be paid by the sender.
	FeeRatio() (types.FeeRatio, bool)

	// FromFrontier() (common.Address, error)
	To() *common.Address

	Hash() common.Hash

	GasPrice() *big.Int

	// For TxTypeEthereumDynamicFee
	GasTipCap() *big.Int
	GasFeeCap() *big.Int
	EffectiveGasTip(baseFee *big.Int) *big.Int
	EffectiveGasPrice(header *types.Header) *big.Int

	Gas() uint64
	Value() *big.Int

	Nonce() uint64
	CheckNonce() bool
	Data() []byte

	// IntrinsicGas returns `intrinsic gas` based on the tx type.
	// This value is used to differentiate tx fee based on the tx type.
	IntrinsicGas(currentBlockNumber uint64) (uint64, error)

	// Type returns the transaction type of the message.
	Type() types.TxType

	// Validate performs additional validation for each transaction type
	Validate(stateDB types.StateDB, currentBlockNumber uint64) error

	// Execute performs execution of the transaction according to the transaction type.
	Execute(vm types.VM, stateDB types.StateDB, currentBlockNumber uint64, gas uint64, value *big.Int) ([]byte, uint64, error)
}

Message represents a message sent to a contract.

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 PendingLogsEvent 

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

PendingLogsEvent is posted pre mining and notifies of pending logs.

type PendingStateEvent 

type PendingStateEvent struct{}

PendingStateEvent is posted pre mining and notifies of pending state changes.

type Prefetcher added in v1.6.0 

type Prefetcher interface {
	// Prefetch processes the state changes according to the Klaytn 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)
	PrefetchTx(block *types.Block, ti int, stateDB *state.StateDB, cfg vm.Config, interrupt *uint32)
}

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

type ProcessStats added in v1.6.0 

type ProcessStats struct {
	BeforeApplyTxs time.Time
	AfterApplyTxs  time.Time
	AfterFinalize  time.Time
}

ProcessStats includes the time statistics regarding StateProcessor.Process.

type Processor 

type Processor interface {
	// Process processes the state changes according to the Klaytn rules by running
	// the transaction messages using the statedb and applying any rewards to
	// the processor (coinbase).
	Process(block *types.Block, stateDB *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, uint64, []*vm.InternalTxTrace, ProcessStats, error)
}

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

type RemovedLogsEvent 

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

RemovedLogsEvent is posted when a reorg happens

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, []*vm.InternalTxTrace, ProcessStats, error)

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

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
}

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 \0*32 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 == 5) Run Script section 6) Derive new state root

func NewStateTransition 

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

NewStateTransition initialises and returns a new state transition object.

func (*StateTransition) TransitionDb 

func (st *StateTransition) TransitionDb() (ret []byte, usedGas uint64, kerr kerror)

TransitionDb will transition the state by applying the current message and returning the result including the used gas. It returns an error if failed. An error indicates a consensus issue.

type ThrottlerConfig added in v1.7.3 

type ThrottlerConfig struct {
	ActivateTxPoolSize uint `json:"activate_tx_pool_size"`
	TargetFailRatio    uint `json:"target_fail_ratio"`
	ThrottleTPS        uint `json:"throttle_tps"`
	MaxCandidates      uint `json:"max_candidates"`

	IncreaseWeight      int `json:"increase_weight"`
	DecreaseWeight      int `json:"decrease_weight"`
	InitialThreshold    int `json:"initial_threshold"`
	MinimumThreshold    int `json:"minimum_threshold"`
	ThresholdAdjustment int `json:"threshold_adjustment"`
	ThrottleSeconds     int `json:"throttle_seconds"`
}

type TransactionLookup 

type TransactionLookup struct {
	Tx *types.Transaction
	*database.TxLookupEntry
}

type TxPool 

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

TxPool contains all currently known transactions. Transactions enter the pool when they are received from the network or submitted locally. They exit the pool when they are included in the blockchain.

The pool separates processable transactions (which can be applied to the current state) and future transactions. Transactions move between those two states over time as they are received and processed.

func NewTxPool 

func NewTxPool(config TxPoolConfig, chainconfig *params.ChainConfig, chain blockChain) *TxPool

NewTxPool creates a new transaction pool to gather, sort and filter inbound transactions from the network.

func (*TxPool) AddLocal 

func (pool *TxPool) AddLocal(tx *types.Transaction) error

AddLocal enqueues a single transaction into the pool if it is valid, marking the sender as a local one in the mean time, ensuring it goes around the local pricing constraints.

func (*TxPool) AddLocals 

func (pool *TxPool) AddLocals(txs []*types.Transaction) []error

AddLocals enqueues a batch of transactions into the pool if they are valid, marking the senders as a local ones in the mean time, ensuring they go around the local pricing constraints.

func (*TxPool) AddRemote 

func (pool *TxPool) AddRemote(tx *types.Transaction) error

AddRemote enqueues a single transaction into the pool if it is valid. If the sender is not among the locally tracked ones, full pricing constraints will apply.

func (*TxPool) AddRemotes 

func (pool *TxPool) AddRemotes(txs []*types.Transaction) []error

AddRemotes enqueues a batch of transactions into the pool if they are valid. If the senders are not among the locally tracked ones, full pricing constraints will apply.

func (*TxPool) CachedPendingTxsByCount 

func (pool *TxPool) CachedPendingTxsByCount(count int) types.Transactions

CachedPendingTxByCount retrieves about number of currently processable transactions by requested count, grouped by origin account and sorted by nonce.

func (*TxPool) Content 

func (pool *TxPool) Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)

Content retrieves the data content of the transaction pool, returning all the pending as well as queued transactions, grouped by account and sorted by nonce.

func (*TxPool) GasPrice 

func (pool *TxPool) GasPrice() *big.Int

GasPrice returns the current gas price enforced by the transaction pool.

func (*TxPool) Get 

func (pool *TxPool) Get(hash common.Hash) *types.Transaction

Get returns a transaction if it is contained in the pool and nil otherwise.

func (*TxPool) GetPendingNonce 

func (pool *TxPool) GetPendingNonce(addr common.Address) uint64

GetPendingNonce is a method to check the last nonce value of pending in external API. Use getPendingNonce to get the nonce value inside txpool because it catches the lock.

func (*TxPool) HandleTxMsg 

func (pool *TxPool) HandleTxMsg(txs types.Transactions)

HandleTxMsg transfers transactions to a channel where handleTxMsg calls AddRemotes to handle them. This is made not to wait from the results from TxPool.AddRemotes.

func (*TxPool) Pending 

func (pool *TxPool) Pending() (map[common.Address]types.Transactions, error)

Pending retrieves all currently processable transactions, groupped by origin account and sorted by nonce. The returned transaction set is a copy and can be freely modified by calling code.

func (*TxPool) SetGasPrice 

func (pool *TxPool) SetGasPrice(price *big.Int)

SetGasPrice updates the gas price of the transaction pool for new transactions, and drops all old transactions.

func (*TxPool) StartSpamThrottler added in v1.7.3 

func (pool *TxPool) StartSpamThrottler(conf *ThrottlerConfig) error

func (*TxPool) Stats 

func (pool *TxPool) Stats() (int, int)

Stats retrieves the current pool stats, namely the number of pending and the number of queued (non-executable) transactions.

func (*TxPool) Status 

func (pool *TxPool) Status(hashes []common.Hash) []TxStatus

Status returns the status (unknown/pending/queued) of a batch of transactions identified by their hashes.

func (*TxPool) Stop 

func (pool *TxPool) Stop()

Stop terminates the transaction pool.

func (*TxPool) StopSpamThrottler added in v1.7.3 

func (pool *TxPool) StopSpamThrottler()

func (*TxPool) SubscribeNewTxsEvent 

func (pool *TxPool) SubscribeNewTxsEvent(ch chan<- NewTxsEvent) event.Subscription

SubscribeNewTxsEvent registers a subscription of NewTxsEvent and starts sending event to the given channel.

type TxPoolConfig 

type TxPoolConfig struct {
	NoLocals           bool          // Whether local transaction handling should be disabled
	AllowLocalAnchorTx bool          // if this is true, the txpool allow locally submitted anchor transactions
	DenyRemoteTx       bool          // Denies remote transactions receiving from other peers
	Journal            string        // Journal of local transactions to survive node restarts
	JournalInterval    time.Duration // Time interval to regenerate the local transaction journal

	PriceLimit uint64 // Minimum gas price to enforce for acceptance into the pool
	PriceBump  uint64 // Minimum price bump percentage to replace an already existing transaction (nonce)

	ExecSlotsAccount    uint64 // Number of executable transaction slots guaranteed per account
	ExecSlotsAll        uint64 // Maximum number of executable transaction slots for all accounts
	NonExecSlotsAccount uint64 // Maximum number of non-executable transaction slots permitted per account
	NonExecSlotsAll     uint64 // Maximum number of non-executable transaction slots for all accounts

	KeepLocals bool          // Disables removing timed-out local transactions
	Lifetime   time.Duration // Maximum amount of time non-executable transaction are queued

	NoAccountCreation            bool // Whether account creation transactions should be disabled
	EnableSpamThrottlerAtRuntime bool // Enable txpool spam throttler at runtime
}

TxPoolConfig are the configuration parameters of the transaction pool.

type TxStatus 

type TxStatus uint

TxStatus is the current status of a transaction as seen by the pool. 

const (
	TxStatusUnknown TxStatus = iota
	TxStatusQueued
	TxStatusPending
	// for Les
	TxStatusIncluded
)

type UpdateHeadBlocksCallback added in v1.8.0 

type UpdateHeadBlocksCallback func(*types.Header) error

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, parent *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 WhCallback 

type WhCallback func(*types.Header) error

WhCallback is a callback function for inserting individual headers. A callback is used for two reasons: first, in a LightChain, status should be processed and light chain events sent, while in a BlockChain this is not necessary since chain events are sent after inserting blocks. Second, the header writes should be protected by the parent chain mutex individually.

type WriteResult added in v1.6.0 

type WriteResult struct {
	Status         WriteStatus
	TotalWriteTime time.Duration
	TrieWriteTime  time.Duration
}

WriteResult includes the block write status and related statistics.

type WriteStatus 

type WriteStatus byte

WriteStatus status of write 

const (
	NonStatTy WriteStatus = iota
	CanonStatTy
	SideStatTy
)

TODO-Klaytn-Issue264 If we are using istanbul BFT, then we always have a canonical chain. 

Later we may be able to remove 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 state provides an uppermost caching layer of the Klaytn state trie.
 Package state provides an uppermost caching layer of the Klaytn state trie.
Package types contains data types related to Klatyn consensus.
 Package types contains data types related to Klatyn consensus.
account
Package account implements Account used in Klaytn.
 Package account implements Account used in Klaytn.
accountkey
Package accountkey implements the AccountKey used in Klaytn.
 Package accountkey implements the AccountKey used in Klaytn.
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.