core

package
v1.10.3-0...-ec03cfc Latest Latest
Warning

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

 Go to latest Published: Apr 24, 2021 License: LGPL-3.0 Imports: 60 Imported by: 0

Documentation

Overview

Package core implements the Ethereum consensus protocol.

Index

Constants

View Source 
const (
	// GenesisEpoch is the number of the genesis epoch.
	GenesisEpoch = 0
	// GenesisONEToken is the initial total number of ONE in the genesis block for mainnet.
	GenesisONEToken = 12600000000
	// ContractDeployerInitFund is the initial fund for the contract deployer account in testnet/devnet.
	ContractDeployerInitFund = 10000000000
	// InitFreeFund is the initial fund for permissioned accounts for testnet/devnet/
	InitFreeFund = 100
)
View Source 
const (

	// BlockChainVersion ensures that an incompatible database forces a resync from scratch.
	BlockChainVersion = 3
)
View Source 
const (
	// CxPoolSize is the maximum size of the pool
	CxPoolSize = 50
)

Variables

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

	// ErrShardStateNotMatch is returned if the calculated shardState hash not equal that in the block header
	ErrShardStateNotMatch = errors.New("shard state root hash not match")
)
View Source 
var (
	// ErrInvalidSender is returned if the transaction contains an invalid signature.
	ErrInvalidSender = errors.New("invalid sender")

	// ErrInvalidShard is returned if the transaction is for the wrong shard.
	ErrInvalidShard = errors.New("invalid shard")

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

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

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

	// ErrKnownTransaction is returned if a transaction that is already in the pool
	// attempting to be added to the pool.
	ErrKnownTransaction = errors.New("known transaction")

	// ErrInvalidMsgForStakingDirective is returned if a staking message does not
	// match the related directive
	ErrInvalidMsgForStakingDirective = errors.New("staking message does not match directive message")

	// ErrBlacklistFrom is returned if a transaction's from/source address is blacklisted
	ErrBlacklistFrom = errors.New("`from` address of transaction in blacklist")

	// ErrBlacklistTo is returned if a transaction's to/destination address is blacklisted
	ErrBlacklistTo = errors.New("`to` address of transaction in blacklist")
)
View Source 
var DefaultTxPoolConfig = TxPoolConfig{
	Journal:   "transactions.rlp",
	Rejournal: time.Hour,

	PriceLimit: 1,
	PriceBump:  10,

	AccountSlots: 16,
	GlobalSlots:  4096,
	AccountQueue: 64,
	GlobalQueue:  1024,

	Lifetime: 30 * time.Minute,

	Blacklist: map[common.Address]struct{}{},
}

DefaultTxPoolConfig contains the default configurations for the transaction pool.

View Source 
var (

	// ErrNoGenesis is the error when there is no genesis.
	ErrNoGenesis = errors.New("Genesis not found in chain")
)
View Source 
var (
	// GenesisFund is the initial total number of ONE (in atto) in the genesis block for mainnet.
	GenesisFund = new(big.Int).Mul(big.NewInt(GenesisONEToken), big.NewInt(denominations.One))
)

Functions

func ApplyIncomingReceipt 

func ApplyIncomingReceipt(
	config *params.ChainConfig, db *state.DB,
	header *block.Header, cxp *types.CXReceiptsProof,
) error

ApplyIncomingReceipt will add amount into ToAddress in the receipt

func ApplyStakingMessage 

func ApplyStakingMessage(evm *vm.EVM, msg Message, gp *GasPool, bc ChainContext) (uint64, error)

ApplyStakingMessage computes the new state for staking message

func ApplyStakingTransaction 

func ApplyStakingTransaction(
	config *params.ChainConfig, bc ChainContext, author *common.Address, gp *GasPool, statedb *state.DB,
	header *block.Header, tx *staking.StakingTransaction, usedGas *uint64, cfg vm.Config) (receipt *types.Receipt, gas uint64, err error)

ApplyStakingTransaction attempts to apply a staking transaction to the given state database and uses the input parameters for its environment. It returns the receipt for the staking transaction, gas used and an error if the transaction failed, indicating the block was invalid. staking transaction will use the code field in the account to store the staking information

func ApplyTransaction 

func ApplyTransaction(config *params.ChainConfig, bc ChainContext, author *common.Address, gp *GasPool, statedb *state.DB, header *block.Header, tx *types.Transaction, usedGas *uint64, cfg vm.Config) (*types.Receipt, *types.CXReceipt, uint64, 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 

func CalcGasLimit(parent *types.Block, gasFloor, gasCeil uint64) uint64

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

func 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 EncodeGenesisConfig 

func EncodeGenesisConfig(fileName string) string

EncodeGenesisConfig converts json file into binary format for genesis block

func GenerateChain 

func GenerateChain(
	config *params.ChainConfig, parent *types.Block,
	engine consensus_engine.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.

func GetHashFn 

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

GetHashFn returns a GetHashFunc which retrieves header hashes by number

func GetInitialFunds 

func GetInitialFunds(shardID uint32) *big.Int

GetInitialFunds for a given shard

func IntrinsicGas 

func IntrinsicGas(data []byte, contractCreation, homestead, istanbul, isValidatorCreation bool) (uint64, error)

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

func IsEpochBlock 

func IsEpochBlock(block *types.Block) bool

IsEpochBlock returns whether this block is the first block of an epoch. by checking if the previous block is the last block of the previous epoch

func IsValidator 

func IsValidator(db vm.StateDB, addr common.Address) bool

IsValidator determines whether it is a validator address or not

func NewEVMContext 

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

NewEVMContext creates a new context for use in the EVM.

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 StakingToMessage 

func StakingToMessage(
	tx *staking.StakingTransaction, blockNum *big.Int,
) (types.Message, error)

StakingToMessage returns the staking transaction as a core.Message. requires a signer to derive the sender. put it here to avoid cyclic import

func StringToBigInt 

func StringToBigInt(s string, base int) *big.Int

StringToBigInt converts a string to BigInt

func Transfer 

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

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

func VerifyAndCollectRewardsFromDelegation 

func VerifyAndCollectRewardsFromDelegation(
	stateDB vm.StateDB, delegations []staking.DelegationIndex,
) ([]*staking.ValidatorWrapper, *big.Int, error)

VerifyAndCollectRewardsFromDelegation verifies and collects rewards from the given delegation slice using the stateDB. It returns all of the edited validatorWrappers and the sum total of the rewards.

Note that this function never updates the stateDB, it only reads from stateDB.

func VerifyAndCreateValidatorFromMsg 

func VerifyAndCreateValidatorFromMsg(
	stateDB vm.StateDB, chainContext ChainContext, epoch *big.Int, blockNum *big.Int, msg *staking.CreateValidator,
) (*staking.ValidatorWrapper, error)

VerifyAndCreateValidatorFromMsg verifies the create validator message using the stateDB, epoch, & blocknumber and returns the validatorWrapper created in the process.

Note that this function never updates the stateDB, it only reads from stateDB.

func VerifyAndDelegateFromMsg 

func VerifyAndDelegateFromMsg(
	stateDB vm.StateDB, epoch *big.Int, msg *staking.Delegate, delegations []staking.DelegationIndex, redelegation bool,
) ([]*staking.ValidatorWrapper, *big.Int, map[common.Address]*big.Int, error)

VerifyAndDelegateFromMsg verifies the delegate message using the stateDB and returns the balance to be deducted by the delegator as well as the validatorWrapper with the delegation applied to it.

Note that this function never updates the stateDB, it only reads from stateDB.

func VerifyAndEditValidatorFromMsg 

func VerifyAndEditValidatorFromMsg(
	stateDB vm.StateDB, chainContext ChainContext,
	epoch, blockNum *big.Int, msg *staking.EditValidator,
) (*staking.ValidatorWrapper, error)

VerifyAndEditValidatorFromMsg verifies the edit validator message using the stateDB, chainContext and returns the edited validatorWrapper.

Note that this function never updates the stateDB, it only reads from stateDB.

func VerifyAndUndelegateFromMsg 

func VerifyAndUndelegateFromMsg(
	stateDB vm.StateDB, epoch *big.Int, msg *staking.Undelegate,
) (*staking.ValidatorWrapper, error)

VerifyAndUndelegateFromMsg verifies the undelegate validator message using the stateDB & chainContext and returns the edited validatorWrapper with the undelegation applied to it.

Note that this function never updates the stateDB, it only reads from stateDB.

Types

type BadBlock 

type BadBlock struct {
	Block  *types.Block
	Reason error
}

BadBlock ..

func (BadBlock) MarshalJSON 

func (b BadBlock) MarshalJSON() ([]byte, error)

MarshalJSON ..

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 ethdb.Database, cacheConfig *CacheConfig, chainConfig *params.ChainConfig,
	engine consensus_engine.Engine, vmConfig vm.Config,
	shouldPreserve func(block *types.Block) bool,
) (*BlockChain, error)

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

func (bc *BlockChain) AddPendingCrossLinks(pendingCLs []types.CrossLink) (int, error)

AddPendingCrossLinks appends pending crosslinks

func (*BlockChain) AddPendingSlashingCandidates 

func (bc *BlockChain) AddPendingSlashingCandidates(
	candidates slash.Records,
) error

AddPendingSlashingCandidates appends pending slashing candidates

func (*BlockChain) BadBlocks 

func (bc *BlockChain) BadBlocks() []BadBlock

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

func (*BlockChain) CXMerkleProof 

func (bc *BlockChain) CXMerkleProof(toShardID uint32, block *types.Block) (*types.CXMerkleProof, error)

CXMerkleProof calculates the cross shard transaction merkle proof of a given destination shard

func (*BlockChain) ChainDb 

func (bc *BlockChain) ChainDb() ethdb.Database

ChainDb returns the database

func (*BlockChain) CommitOffChainData 

func (bc *BlockChain) CommitOffChainData(
	batch rawdb.DatabaseWriter,
	block *types.Block,
	receipts []*types.Receipt,
	cxReceipts []*types.CXReceipt,
	payout reward.Reader,
	state *state.DB,
) (status WriteStatus, err error)

CommitOffChainData write off chain data of a block onto db writer.

func (*BlockChain) ComputeAndUpdateAPR 

func (bc *BlockChain) ComputeAndUpdateAPR(
	block *types.Block, now *big.Int,
	wrapper *staking.ValidatorWrapper, stats *staking.ValidatorStats,
) error

ComputeAndUpdateAPR ...

func (*BlockChain) Config 

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

Config retrieves the blockchain's chain configuration.

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

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

func (*BlockChain) DelegatorsInformation 

func (bc *BlockChain) DelegatorsInformation(addr common.Address) []*staking.Delegation

DelegatorsInformation returns up to date information of delegators of a given validator address 

func (bc *BlockChain) DeleteCrossLinks(cls []types.CrossLink) error

DeleteCrossLinks removes the hashes of crosslinks by shardID and blockNum combination key 

func (bc *BlockChain) DeleteFromPendingCrossLinks(crossLinks []types.CrossLink) (int, error)

DeleteFromPendingCrossLinks delete pending crosslinks that already committed (i.e. passed in the params)

func (*BlockChain) DeleteFromPendingSlashingCandidates 

func (bc *BlockChain) DeleteFromPendingSlashingCandidates(
	processed slash.Records,
) error

DeleteFromPendingSlashingCandidates ..

func (*BlockChain) Engine 

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

Engine retrieves the blockchain's consensus engine.

func (*BlockChain) Export 

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

Export writes the active chain to the given writer.

func (*BlockChain) ExportN 

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

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

func (*BlockChain) GasLimit 

func (bc *BlockChain) GasLimit() uint64

GasLimit returns the gas limit of the current HEAD block.

func (*BlockChain) Genesis 

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

Genesis retrieves the chain's genesis block.

func (*BlockChain) GetAncestor 

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

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

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

func (*BlockChain) GetBlock 

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

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

func (*BlockChain) GetBlockByHash 

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

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

func (*BlockChain) GetBlockByNumber 

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

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

func (*BlockChain) GetBlockHashesFromHash 

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

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

func (*BlockChain) GetBlocksFromHash 

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

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

func (*BlockChain) GetBody 

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

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

func (*BlockChain) GetBodyRLP 

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

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

func (*BlockChain) GetECDSAFromCoinbase 

func (bc *BlockChain) GetECDSAFromCoinbase(header *block.Header) (common.Address, error)

GetECDSAFromCoinbase retrieve corresponding ecdsa address from Coinbase Address

func (*BlockChain) GetEpochBlockNumber 

func (bc *BlockChain) GetEpochBlockNumber(epoch *big.Int) (*big.Int, error)

GetEpochBlockNumber returns the first block number of the given epoch.

func (*BlockChain) GetHeader 

func (bc *BlockChain) GetHeader(hash common.Hash, number uint64) *block.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) *block.Header

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

func (*BlockChain) GetHeaderByNumber 

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

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

func (*BlockChain) GetMaxGarbageCollectedBlockNumber 

func (bc *BlockChain) GetMaxGarbageCollectedBlockNumber() int64

GetMaxGarbageCollectedBlockNumber ..

func (*BlockChain) GetReceiptsByHash 

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

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

func (*BlockChain) GetTd 

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

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

func (*BlockChain) GetTdByHash 

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

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

func (*BlockChain) GetUnclesInChain 

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

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

func (*BlockChain) GetVMConfig 

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

GetVMConfig returns the block chain VM config.

func (*BlockChain) GetVdfByNumber 

func (bc *BlockChain) GetVdfByNumber(number uint64) []byte

GetVdfByNumber retrieves the rand seed given the block number, return 0 if not exist

func (*BlockChain) GetVrfByNumber 

func (bc *BlockChain) GetVrfByNumber(number uint64) []byte

GetVrfByNumber retrieves the randomness preimage given the block number, return 0 if not exist

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, verifyHeaders bool) (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 []*block.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) IsSameLeaderAsPreviousBlock 

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

IsSameLeaderAsPreviousBlock retrieves a block from the database by number, caching it

func (*BlockChain) IsSpent 

func (bc *BlockChain) IsSpent(cxp *types.CXReceiptsProof) bool

IsSpent checks whether a CXReceiptsProof is unspent 

func (bc *BlockChain) LastContinuousCrossLink(batch rawdb.DatabaseWriter, shardID uint32) error

LastContinuousCrossLink saves the last crosslink of a shard This function will update the latest crosslink in the sense that any previous block's crosslink is received up to this point there is no missing hole between genesis to this crosslink of given shardID

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

func (bc *BlockChain) Processor() Processor

Processor returns the current processor.

func (*BlockChain) ReadBlockRewardAccumulator 

func (bc *BlockChain) ReadBlockRewardAccumulator(number uint64) (*big.Int, error)

ReadBlockRewardAccumulator must only be called on beaconchain Note that block rewards are only for staking era.

func (*BlockChain) ReadCXReceipts 

func (bc *BlockChain) ReadCXReceipts(shardID uint32, blockNum uint64, blockHash common.Hash) (types.CXReceipts, error)

ReadCXReceipts retrieves the cross shard transaction receipts of a given shard

func (*BlockChain) ReadCommitSig 

func (bc *BlockChain) ReadCommitSig(blockNum uint64) ([]byte, error)

ReadCommitSig retrieves the commit signature on a block. 

func (bc *BlockChain) ReadCrossLink(shardID uint32, blockNum uint64) (*types.CrossLink, error)

ReadCrossLink retrieves crosslink given shardID and blockNum.

func (*BlockChain) ReadDelegationsByDelegator 

func (bc *BlockChain) ReadDelegationsByDelegator(
	delegator common.Address,
) (m staking.DelegationIndexes, err error)

ReadDelegationsByDelegator reads the addresses of validators delegated by a delegator

func (*BlockChain) ReadDelegationsByDelegatorAt 

func (bc *BlockChain) ReadDelegationsByDelegatorAt(
	delegator common.Address, blockNum *big.Int,
) (m staking.DelegationIndexes, err error)

ReadDelegationsByDelegatorAt reads the addresses of validators delegated by a delegator at a given block

func (*BlockChain) ReadEpochVdfBlockNum 

func (bc *BlockChain) ReadEpochVdfBlockNum(epoch *big.Int) (*big.Int, error)

ReadEpochVdfBlockNum retrieves block number with valid VDF for the specified epoch

func (*BlockChain) ReadEpochVrfBlockNums 

func (bc *BlockChain) ReadEpochVrfBlockNums(epoch *big.Int) ([]uint64, error)

ReadEpochVrfBlockNums retrieves block numbers with valid VRF for the specified epoch 

func (bc *BlockChain) ReadPendingCrossLinks() ([]types.CrossLink, error)

ReadPendingCrossLinks retrieves pending crosslinks

func (*BlockChain) ReadPendingSlashingCandidates 

func (bc *BlockChain) ReadPendingSlashingCandidates() slash.Records

ReadPendingSlashingCandidates retrieves pending slashing candidates 

func (bc *BlockChain) ReadShardLastCrossLink(shardID uint32) (*types.CrossLink, error)

ReadShardLastCrossLink retrieves the last crosslink of a shard.

func (*BlockChain) ReadShardState 

func (bc *BlockChain) ReadShardState(epoch *big.Int) (*shard.State, error)

ReadShardState retrieves sharding state given the epoch number.

func (*BlockChain) ReadTxLookupEntry 

func (bc *BlockChain) ReadTxLookupEntry(txID common.Hash) (common.Hash, uint64, uint64)

ReadTxLookupEntry returns where the given transaction resides in the chain, as a (block hash, block number, index in transaction list) triple. returns 0, 0 if not found

func (*BlockChain) ReadValidatorInformation 

func (bc *BlockChain) ReadValidatorInformation(
	addr common.Address,
) (*staking.ValidatorWrapper, error)

ReadValidatorInformation reads staking information of given validator address

func (*BlockChain) ReadValidatorInformationAtRoot 

func (bc *BlockChain) ReadValidatorInformationAtRoot(
	addr common.Address, root common.Hash,
) (*staking.ValidatorWrapper, error)

ReadValidatorInformationAtRoot reads staking information of given validatorWrapper at a specific state root

func (*BlockChain) ReadValidatorInformationAtState 

func (bc *BlockChain) ReadValidatorInformationAtState(
	addr common.Address, state *state.DB,
) (*staking.ValidatorWrapper, error)

ReadValidatorInformationAtState reads staking information of given validatorWrapper at a specific state root

func (*BlockChain) ReadValidatorList 

func (bc *BlockChain) ReadValidatorList() ([]common.Address, error)

ReadValidatorList reads the addresses of current all validators

func (*BlockChain) ReadValidatorSnapshot 

func (bc *BlockChain) ReadValidatorSnapshot(
	addr common.Address,
) (*staking.ValidatorSnapshot, error)

ReadValidatorSnapshot reads the snapshot staking information of given validator address

func (*BlockChain) ReadValidatorSnapshotAtEpoch 

func (bc *BlockChain) ReadValidatorSnapshotAtEpoch(
	epoch *big.Int,
	addr common.Address,
) (*staking.ValidatorSnapshot, error)

ReadValidatorSnapshotAtEpoch reads the snapshot staking validator information of given validator address

func (*BlockChain) ReadValidatorStats 

func (bc *BlockChain) ReadValidatorStats(
	addr common.Address,
) (*staking.ValidatorStats, error)

ReadValidatorStats reads the stats of a validator

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

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

func (*BlockChain) SetHead 

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

SetHead rewinds the local chain to a new head. In the case of headers, everything above the new head will be deleted and the new one set. In the case of blocks though, the head may be further rewound if block bodies are missing (non-archive nodes after a fast sync).

func (*BlockChain) SetProcessor 

func (bc *BlockChain) SetProcessor(processor Processor)

SetProcessor sets the processor required for making state modifications.

func (*BlockChain) SetValidator 

func (bc *BlockChain) SetValidator(validator Validator)

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

func (*BlockChain) ShardID 

func (bc *BlockChain) ShardID() uint32

ShardID returns the shard Id of the blockchain. TODO: use a better solution before resharding shuffle nodes to different shards

func (*BlockChain) State 

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

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

func (*BlockChain) StateAt 

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

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

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

func (bc *BlockChain) StoreEpochBlockNumber(
	epoch *big.Int, blockNum *big.Int,
) error

StoreEpochBlockNumber stores the given epoch-first block number.

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

func (bc *BlockChain) SuperCommitteeForNextEpoch(
	beacon consensus_engine.ChainReader,
	header *block.Header,
	isVerify bool,
) (*shard.State, error)

SuperCommitteeForNextEpoch ... isVerify=true means validators use it to verify isVerify=false means leader is to propose

func (*BlockChain) TrieNode 

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

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

func (*BlockChain) UpdateBlockRewardAccumulator 

func (bc *BlockChain) UpdateBlockRewardAccumulator(
	batch rawdb.DatabaseWriter, diff *big.Int, number uint64,
) error

UpdateBlockRewardAccumulator .. Note: this should only be called within the blockchain insert process.

func (*BlockChain) UpdateStakingMetaData 

func (bc *BlockChain) UpdateStakingMetaData(
	batch rawdb.DatabaseWriter, block *types.Block,
	state *state.DB, epoch, newEpoch *big.Int,
) (newValidators []common.Address, err error)

UpdateStakingMetaData updates the metadata of validators and delegations, including the full validator list and delegation indexes. Note: this should only be called within the blockchain insert process.

func (*BlockChain) UpdateValidatorSnapshots 

func (bc *BlockChain) UpdateValidatorSnapshots(
	batch rawdb.DatabaseWriter, epoch *big.Int, state *state.DB, newValidators []common.Address,
) error

UpdateValidatorSnapshots updates the content snapshot of all validators Note: this should only be called within the blockchain insert process.

func (*BlockChain) UpdateValidatorVotingPower 

func (bc *BlockChain) UpdateValidatorVotingPower(
	batch rawdb.DatabaseWriter,
	block *types.Block,
	newEpochSuperCommittee, currentEpochSuperCommittee *shard.State,
	state *state.DB,
) (map[common.Address]*staking.ValidatorStats, error)

UpdateValidatorVotingPower writes the voting power for the committees

func (*BlockChain) ValidateNewBlock 

func (bc *BlockChain) ValidateNewBlock(block *types.Block) error

ValidateNewBlock validates new block.

func (*BlockChain) Validator 

func (bc *BlockChain) Validator() Validator

Validator returns the current validator.

func (*BlockChain) ValidatorCandidates 

func (bc *BlockChain) ValidatorCandidates() []common.Address

ValidatorCandidates returns the up to date validator candidates for next epoch

func (*BlockChain) WriteBlockRewardAccumulator 

func (bc *BlockChain) WriteBlockRewardAccumulator(
	batch rawdb.DatabaseWriter, reward *big.Int, number uint64,
) error

WriteBlockRewardAccumulator directly writes the BlockRewardAccumulator value Note: this should only be called once during staking launch.

func (*BlockChain) WriteBlockWithState 

func (bc *BlockChain) WriteBlockWithState(
	block *types.Block, receipts []*types.Receipt,
	cxReceipts []*types.CXReceipt,
	paid reward.Reader,
	state *state.DB,
) (status WriteStatus, err error)

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

func (*BlockChain) WriteBlockWithoutState 

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

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

func (*BlockChain) WriteCXReceiptsProofSpent 

func (bc *BlockChain) WriteCXReceiptsProofSpent(db rawdb.DatabaseWriter, cxps []*types.CXReceiptsProof) error

WriteCXReceiptsProofSpent mark the CXReceiptsProof list with given unspent status true: unspent, false: spent

func (*BlockChain) WriteCommitSig 

func (bc *BlockChain) WriteCommitSig(blockNum uint64, lastCommits []byte) error

WriteCommitSig saves the commits signatures signed on a block. 

func (bc *BlockChain) WriteCrossLinks(batch rawdb.DatabaseWriter, cls []types.CrossLink) error

WriteCrossLinks saves the hashes of crosslinks by shardID and blockNum combination key

func (*BlockChain) WriteEpochVdfBlockNum 

func (bc *BlockChain) WriteEpochVdfBlockNum(epoch *big.Int, blockNum *big.Int) error

WriteEpochVdfBlockNum saves block number with valid VDF for the specified epoch

func (*BlockChain) WriteEpochVrfBlockNums 

func (bc *BlockChain) WriteEpochVrfBlockNums(epoch *big.Int, vrfNumbers []uint64) error

WriteEpochVrfBlockNums saves block numbers with valid VRF for the specified epoch 

func (bc *BlockChain) WritePendingCrossLinks(crossLinks []types.CrossLink) error

WritePendingCrossLinks saves the pending crosslinks

func (*BlockChain) WriteShardStateBytes 

func (bc *BlockChain) WriteShardStateBytes(db rawdb.DatabaseWriter,
	epoch *big.Int, shardState []byte,
) (*shard.State, error)

WriteShardStateBytes saves the given sharding state under the given epoch number.

func (*BlockChain) WriteValidatorList 

func (bc *BlockChain) WriteValidatorList(
	db rawdb.DatabaseWriter, addrs []common.Address,
) error

WriteValidatorList writes the list of validator addresses to database Note: this should only be called within the blockchain insert process.

func (*BlockChain) WriteValidatorSnapshot 

func (bc *BlockChain) WriteValidatorSnapshot(
	batch rawdb.DatabaseWriter, snapshot *staking.ValidatorSnapshot,
) error

WriteValidatorSnapshot writes the snapshot of provided validator

type BlockGen 

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

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

func (*BlockGen) AddTx 

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

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

AddTx panics if the transaction cannot be executed. In addition to the protocol-imposed limitations (gas limit, etc.), there are some further limitations on the content of transactions that can be added. Notably, contract code relying on the BLOCKHASH instruction will panic during execution.

func (*BlockGen) AddTxWithChain 

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

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

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

func (*BlockGen) 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) AddUncle 

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

AddUncle adds an uncle header to the generated block.

func (*BlockGen) Number 

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

Number returns the block number of the block being generated.

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

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

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

func (*BlockGen) SetExtra 

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

SetExtra sets the extra data field of the generated block.

func (*BlockGen) SetShardID 

func (b *BlockGen) SetShardID(shardID uint32)

SetShardID sets the shardID field of the generated block.

func (*BlockGen) TxNonce 

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

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

type BlockValidator 

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

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

BlockValidator implements validator.

func NewBlockValidator 

func NewBlockValidator(config *params.ChainConfig, blockchain *BlockChain, engine consensus_engine.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 root. The headers are assumed to be already validated at this point.

func (*BlockValidator) ValidateCXReceiptsProof 

func (v *BlockValidator) ValidateCXReceiptsProof(cxp *types.CXReceiptsProof) error

ValidateCXReceiptsProof checks whether the given CXReceiptsProof is consistency with itself

func (*BlockValidator) ValidateHeader 

func (v *BlockValidator) ValidateHeader(block *types.Block, seal bool) error

ValidateHeader checks whether a header conforms to the consensus rules of a given engine. Verifying the seal may be done optionally here, or explicitly via the VerifySeal method.

func (*BlockValidator) ValidateHeaders 

func (v *BlockValidator) ValidateHeaders(chain []*types.Block) (chan<- struct{}, <-chan error)

ValidateHeaders verifies a batch of blocks' headers concurrently. The method returns a quit channel to abort the operations and a results channel to retrieve the async verifications

func (*BlockValidator) ValidateState 

func (v *BlockValidator) ValidateState(block *types.Block, statedb *state.DB, receipts types.Receipts, cxReceipts types.CXReceipts, 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 {
	Disabled      bool          // Whether to disable trie write caching (archive node)
	TrieNodeLimit int           // Memory limit (MB) at which to flush the current in-memory trie to disk
	TrieTimeLimit time.Duration // Time limit after which to flush the current in-memory trie to disk
}

CacheConfig contains the configuration values for the trie caching/pruning that's resident in a blockchain.

type ChainContext 

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

	// GetHeader returns the hash corresponding to their hash.
	GetHeader(common.Hash, uint64) *block.Header

	// ReadDelegationsByDelegator returns the validators list of a delegator
	ReadDelegationsByDelegator(common.Address) (staking.DelegationIndexes, error)

	// ReadValidatorSnapshot returns the snapshot of validator at the beginning of current epoch.
	ReadValidatorSnapshot(common.Address) (*staking.ValidatorSnapshot, error)

	// ReadValidatorList returns the list of all validators
	ReadValidatorList() ([]common.Address, error)
}

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

type ChainEvent 

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

ChainEvent is the struct of chain event.

type ChainHeadEvent 

type ChainHeadEvent struct{ Block *types.Block }

ChainHeadEvent is the struct of chain head event.

type ChainIndexer 

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

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

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

func NewChainIndexer 

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 

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

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

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

func (*ChainIndexer) AddChildIndexer 

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

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

func (*ChainIndexer) Close 

func (c *ChainIndexer) Close() error

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

func (*ChainIndexer) SectionHead 

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

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

func (*ChainIndexer) Sections 

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

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

func (*ChainIndexer) Start 

func (c *ChainIndexer) Start(chain ChainIndexerChain)

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

type ChainIndexerBackend 

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

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

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

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

type ChainIndexerChain 

type ChainIndexerChain interface {
	// CurrentHeader retrieves the latest locally known header.
	CurrentHeader() *block.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 ChainSideEvent 

type ChainSideEvent struct {
	Block *types.Block
}

ChainSideEvent is chain side event.

type CxEntry 

type CxEntry struct {
	BlockHash common.Hash
	ToShardID uint32
}

CxEntry represents the egress receipt's blockHash and ToShardID

type CxPool 

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

CxPool is to hold a pool of block outgoing receipts to be resend in next round broadcast When a user/client doesn't find the destination shard get the money from cross shard tx it can send RPC call along with txID to allow the any validator to add the corresponding block's receipts to be resent

func NewCxPool 

func NewCxPool(limit int) *CxPool

NewCxPool creates a new CxPool

func (*CxPool) Add 

func (cxPool *CxPool) Add(entry CxEntry) bool

Add add element into the pool if not exceed limit

func (*CxPool) Clear 

func (cxPool *CxPool) Clear()

Clear empty the pool

func (*CxPool) Pool 

func (cxPool *CxPool) Pool() mapset.Set

Pool returns the pool of blockHashes of missing receipts

func (*CxPool) Size 

func (cxPool *CxPool) Size() int

Size return size of the pool

type DeleteCallback 

type DeleteCallback func(rawdb.DatabaseDeleter, common.Hash, uint64) error

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

type ExecutionResult 

type ExecutionResult struct {
	ReturnData []byte
	UsedGas    uint64
	VMErr      error
}

ExecutionResult is the return value from a transaction committed to the DB

func ApplyMessage 

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

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

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

func (*ExecutionResult) Failed 

func (result *ExecutionResult) Failed() bool

Failed returns the indicator whether the execution is successful or not

func (*ExecutionResult) Return 

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 

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 

func (result *ExecutionResult) Unwrap() error

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

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"`
	Factory        blockfactory.Factory `json:"-"`
	Nonce          uint64               `json:"nonce"`
	ShardID        uint32               `json:"shardID"`
	Timestamp      uint64               `json:"timestamp"`
	ExtraData      []byte               `json:"extraData"`
	GasLimit       uint64               `json:"gasLimit"       gencodec:"required"`
	Mixhash        common.Hash          `json:"mixHash"`
	Coinbase       common.Address       `json:"coinbase"`
	Alloc          GenesisAlloc         `json:"alloc"          gencodec:"required"`
	ShardStateHash common.Hash          `json:"shardStateHash" gencodec:"required"`
	ShardState     shard.State          `json:"shardState"     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 GetGenesisSpec 

func GetGenesisSpec(shardID uint32) *Genesis

GetGenesisSpec for a given shard

func NewGenesisSpec 

func NewGenesisSpec(netType nodeconfig.NetworkType, shardID uint32) *Genesis

NewGenesisSpec creates a new genesis spec for the given network type and shard ID. Note that the shard state is NOT initialized.

func (*Genesis) Commit 

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

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

func (Genesis) MarshalJSON 

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

MarshalJSON marshals as JSON.

func (*Genesis) MustCommit 

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

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

func (*Genesis) ToBlock 

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

UnmarshalJSON is to deserialize the data into GenesisAlloc.

type GenesisItem 

type GenesisItem struct {
	Addr    *big.Int
	Balance *big.Int
}

GenesisItem represents one genesis block transaction

type GenesisMismatchError 

type GenesisMismatchError struct {
	Stored, New common.Hash
}

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

func (*GenesisMismatchError) Error 

func (e *GenesisMismatchError) Error() string

type HeaderChain 

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

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

func NewHeaderChain 

func NewHeaderChain(chainDb ethdb.Database, config *params.ChainConfig, engine consensus_engine.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() *block.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

Engine retrieves the header chain's consensus engine.

func (*HeaderChain) GetAncestor 

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

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

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

func (*HeaderChain) GetBlock 

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

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

func (*HeaderChain) GetBlockHashesFromHash 

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

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

func (*HeaderChain) GetBlockNumber 

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

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

func (*HeaderChain) GetHeader 

func (hc *HeaderChain) GetHeader(hash common.Hash, number uint64) *block.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) *block.Header

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

func (*HeaderChain) GetHeaderByNumber 

func (hc *HeaderChain) GetHeaderByNumber(number uint64) *block.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 difficulty 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 difficulty 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 []*block.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 *block.Header) error

SetCurrentHeader sets the current head header of the canonical chain.

func (*HeaderChain) SetGenesis 

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

SetGenesis sets a new genesis block header for the chain

func (*HeaderChain) SetHead 

func (hc *HeaderChain) SetHead(head uint64, delFn DeleteCallback) error

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

func (*HeaderChain) ValidateHeaderChain 

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

ValidateHeaderChain validates header chain.

func (*HeaderChain) WriteHeader 

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

WriteHeader writes a header into the local chain, given that its parent is already known. If the total difficulty 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) error

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

type Message 

type Message interface {
	From() common.Address
	//FromFrontier() (common.Address, error)
	To() *common.Address

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

	Nonce() uint64
	CheckNonce() bool
	Data() []byte
	Type() types.TransactionType
	BlockNum() *big.Int
}

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 Processor 

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

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

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

type RemovedLogsEvent 

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

RemovedLogsEvent is posted when a reorg happens

type 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.Engine,
) *StateProcessor

NewStateProcessor initialises a new StateProcessor.

func (*StateProcessor) Process 

func (p *StateProcessor) Process(
	block *types.Block, statedb *state.DB, cfg vm.Config,
) (
	types.Receipts, types.CXReceipts,
	[]*types.Log, uint64, reward.Reader, 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 is the State Transitioning Model which is described as follows:

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, gp *GasPool, bc ChainContext) *StateTransition

NewStateTransition initialises and returns a new state transition object.

func (*StateTransition) StakingTransitionDb 

func (st *StateTransition) StakingTransitionDb() (usedGas uint64, err error)

StakingTransitionDb will transition the state by applying the staking message and returning the result including the used gas. It returns an error if failed. It is used for staking transaction only

func (*StateTransition) TransitionDb 

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

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 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, txErrorSink *types.TransactionErrorSink,
) *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.PoolTransaction) 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.PoolTransactions) []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.PoolTransaction) 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.PoolTransactions) []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) Content 

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

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

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

func (*TxPool) GetTxPoolSize 

func (pool *TxPool) GetTxPoolSize() uint64

GetTxPoolSize returns tx pool size.

func (*TxPool) Locals 

func (pool *TxPool) Locals() []common.Address

Locals retrieves the accounts currently considered local by the pool.

func (*TxPool) Pending 

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

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

func (*TxPool) Queued 

func (pool *TxPool) Queued() (map[common.Address]types.PoolTransactions, error)

Queued retrieves all currently non-executable transactions, grouped 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 minimum price required by the transaction pool for a new transaction, and drops all transactions below this threshold.

func (*TxPool) State 

func (pool *TxPool) State() *state.ManagedState

State returns the virtual managed state of the transaction pool.

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) 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 {
	Locals    []common.Address // Addresses that should be treated by default as local
	NoLocals  bool             // Whether local transaction handling should be disabled
	Journal   string           // Journal of local transactions to survive node restarts
	Rejournal 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)

	AccountSlots uint64 // Number of executable transaction slots guaranteed per account
	GlobalSlots  uint64 // Maximum number of executable transaction slots for all accounts
	AccountQueue uint64 // Maximum number of non-executable transaction slots permitted per account
	GlobalQueue  uint64 // Maximum number of non-executable transaction slots for all accounts

	Lifetime time.Duration // Maximum amount of time non-executable transaction are queued

	Blacklist map[common.Address]struct{} // Set of accounts that cannot be a part of any transaction
}

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

Constants for TxStatus.

type Validator 

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

	// ValidateState validates the given statedb and optionally the receipts and
	// gas used.
	ValidateState(block *types.Block, state *state.DB, receipts types.Receipts, cxs types.CXReceipts, usedGas uint64) error

	// ValidateHeader checks whether a header conforms to the consensus rules of a
	// given engine. Verifying the seal may be done optionally here, or explicitly
	// via the VerifySeal method.
	ValidateHeader(block *types.Block, seal bool) error

	// ValidateHeaders verifies a batch of blocks' headers concurrently. The method returns a quit channel
	// to abort the operations and a results channel to retrieve the async verifications
	ValidateHeaders(chain []*types.Block) (chan<- struct{}, <-chan error)

	// ValidateCXReceiptsProof checks whether the given CXReceiptsProof is consistency with itself
	ValidateCXReceiptsProof(cxp *types.CXReceiptsProof) 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(*block.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 WriteStatus 

type WriteStatus byte

WriteStatus status of write 

const (
	NonStatTy WriteStatus = iota
	CanonStatTy
	SideStatTy
)

Constants for WriteStatus

Source Files

View all Source files

Directories

Path Synopsis
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.
Package types contains data types related to Ethereum consensus.
 Package types contains data types related to Ethereum consensus.
vm
Package vm implements the Ethereum Virtual Machine.
 Package vm implements the Ethereum Virtual Machine.
runtime
Package runtime provides a basic execution model for executing EVM code.
 Package runtime provides a basic execution model for executing EVM code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.