core

package
v4.2.0-static+incompat... Latest Latest
Warning

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

 Go to latest Published: Jan 10, 2018 License: GPL-3.0 Imports: 40 Imported by: 0

Documentation

Overview

Package core implements the Ethereum consensus protocol.

Index

Examples

Constants

View Source 
const (

	// must be bumped when consensus algorithm is changed, this forces the upgradedb
	// command to be run (forces the blocks to be imported again using the new algorithm)
	BlockChainVersion = 3
)
View Source 
const SputnikVMExists = false

Variables

View Source 
var (
	DurationLimit          = big.NewInt(13) // The decision boundary on the blocktime duration used to determine whether difficulty should go up or not.
	ExpDiffPeriod          = big.NewInt(100000)
	MinimumDifficulty      = big.NewInt(131072)
	MinGasLimit            = big.NewInt(5000)    // Minimum the gas limit may ever be.
	TargetGasLimit         = big.NewInt(4712388) // The artificial target
	DifficultyBoundDivisor = big.NewInt(2048)    // The bound divisor of the difficulty, used in the update calculations.
	GasLimitBoundDivisor   = big.NewInt(1024)    // The bound divisor of the gas limit, used in update calculations.
)
View Source 
var (
	ErrChainConfigNotFound     = errors.New("chain config not found")
	ErrChainConfigForkNotFound = errors.New("chain config fork not found")

	ErrHashKnownBad  = errors.New("known bad hash")
	ErrHashKnownFork = validateError("known fork hash mismatch")
)
View Source 
var (
	BlockNumberErr   = errors.New("block number invalid")
	BlockFutureErr   = errors.New("block time is in the future")
	BlockTSTooBigErr = errors.New("block time too big")
	BlockEqualTSErr  = errors.New("block time stamp equal to previous")
)
View Source 
var (
	MaximumBlockReward = big.NewInt(5e+18) // that's shiny 5 ether

	DisinflationRateQuotient = big.NewInt(4)
	DisinflationRateDivisor  = big.NewInt(5)

	ErrConfiguration = errors.New("invalid configuration")
)
View Source 
var (
	TxGas                 = big.NewInt(21000) // Per transaction not creating a contract. NOTE: Not payable on data of calls between transactions.
	TxGasContractCreation = big.NewInt(53000) // Per transaction that creates a contract. NOTE: Not payable on data of calls between transactions.
	TxDataZeroGas         = big.NewInt(4)     // Per byte of data attached to a transaction that equals zero. NOTE: Not payable on data of calls between transactions.
	TxDataNonZeroGas      = big.NewInt(68)    // Per byte of data attached to a transaction that is not equal to zero. NOTE: Not payable on data of calls between transactions.
)
View Source 
var (
	// Transaction Pool Errors
	ErrInvalidSender      = errors.New("Invalid sender")
	ErrNonce              = errors.New("Nonce too low")
	ErrCheap              = errors.New("Gas price too low for acceptance")
	ErrBalance            = errors.New("Insufficient balance")
	ErrNonExistentAccount = errors.New("Account does not exist or account balance too low")
	ErrInsufficientFunds  = errors.New("Insufficient funds for gas * price + value")
	ErrIntrinsicGas       = errors.New("Intrinsic gas too low")
	ErrGasLimit           = errors.New("Exceeds block gas limit")
	ErrNegativeValue      = errors.New("Negative value")
)
View Source 
var DefaultDiehardGasTable = &vm.GasTable{
	ExtcodeSize:     big.NewInt(700),
	ExtcodeCopy:     big.NewInt(700),
	Balance:         big.NewInt(400),
	SLoad:           big.NewInt(200),
	Calls:           big.NewInt(700),
	Suicide:         big.NewInt(5000),
	ExpByte:         big.NewInt(50),
	CreateBySuicide: big.NewInt(25000),
}
View Source 
var DefaultGasRepriceGasTable = &vm.GasTable{
	ExtcodeSize:     big.NewInt(700),
	ExtcodeCopy:     big.NewInt(700),
	Balance:         big.NewInt(400),
	SLoad:           big.NewInt(200),
	Calls:           big.NewInt(700),
	Suicide:         big.NewInt(5000),
	ExpByte:         big.NewInt(10),
	CreateBySuicide: big.NewInt(25000),
}
View Source 
var DefaultHomeSteadGasTable = &vm.GasTable{
	ExtcodeSize:     big.NewInt(20),
	ExtcodeCopy:     big.NewInt(20),
	Balance:         big.NewInt(20),
	SLoad:           big.NewInt(50),
	Calls:           big.NewInt(40),
	Suicide:         big.NewInt(0),
	ExpByte:         big.NewInt(10),
	CreateBySuicide: nil,
}
View Source 
var (
	ErrNoGenesis = errors.New("Genesis not found in chain")
)
View Source 
var (
	MIPMapLevels = []uint64{1000000, 500000, 100000, 50000, 1000}
)
View Source 
var UseSputnikVM = false

Functions

func AccumulateRewards 

func AccumulateRewards(config *ChainConfig, statedb *state.StateDB, header *types.Header, uncles []*types.Header)

AccumulateRewards credits the coinbase of the given block with the mining reward. The total reward consists of the static block reward and rewards for included uncles. The coinbase of each uncle block is also rewarded.

func ApplyMessage 

func ApplyMessage(env vm.Environment, msg Message, gp *GasPool) ([]byte, *big.Int, 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 ApplyMultiVmTransaction 

func ApplyMultiVmTransaction(config *ChainConfig, bc *BlockChain, gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, totalUsedGas *big.Int) (*types.Receipt, evm.Logs, *big.Int, error)

func ApplyTransaction 

func ApplyTransaction(config *ChainConfig, bc *BlockChain, gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *big.Int) (*types.Receipt, vm.Logs, *big.Int, error)

ApplyTransaction attempts to apply a transaction to the given state database and uses the input parameters for its environment.

ApplyTransactions returns the generated receipts and vm logs during the execution of the state transition phase.

func CalcDifficulty 

func CalcDifficulty(config *ChainConfig, time, parentTime uint64, parentNumber, parentDiff *big.Int) *big.Int

CalcDifficulty is the difficulty adjustment algorithm. It returns the difficulty that a new block should have when created at time given the parent block's time and difficulty.

func CalcGasLimit 

func CalcGasLimit(parent *types.Block) *big.Int

CalcGasLimit computes the gas limit of the next block after parent. The result may be modified by the caller. This is miner strategy, not consensus protocol.

func Call 

func Call(env vm.Environment, caller vm.ContractRef, addr common.Address, input []byte, gas, gasPrice, value *big.Int) (ret []byte, err error)

Call executes within the given contract

func CallCode 

func CallCode(env vm.Environment, caller vm.ContractRef, addr common.Address, input []byte, gas, gasPrice, value *big.Int) (ret []byte, err error)

CallCode executes the given address' code as the given contract address

func Create 

func Create(env vm.Environment, caller vm.ContractRef, code []byte, gas, gasPrice, value *big.Int) (ret []byte, address common.Address, err error)

Create creates a new contract with the given code

func DelegateCall 

func DelegateCall(env vm.Environment, caller vm.ContractRef, addr common.Address, input []byte, gas, gasPrice *big.Int) (ret []byte, err error)

DelegateCall is equivalent to CallCode except that sender and value propagates from parent scope to child scope

func DeleteBlock 

func DeleteBlock(db ethdb.Database, hash common.Hash)

DeleteBlock removes all block data associated with a hash.

func DeleteBlockReceipts 

func DeleteBlockReceipts(db ethdb.Database, hash common.Hash)

DeleteBlockReceipts removes all receipt data associated with a block hash.

func DeleteBody 

func DeleteBody(db ethdb.Database, hash common.Hash)

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash 

func DeleteCanonicalHash(db ethdb.Database, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteHeader 

func DeleteHeader(db ethdb.Database, hash common.Hash)

DeleteHeader removes all block header data associated with a hash.

func DeleteReceipt 

func DeleteReceipt(db ethdb.Database, hash common.Hash)

DeleteReceipt removes all receipt data associated with a transaction hash.

func DeleteTd 

func DeleteTd(db ethdb.Database, hash common.Hash)

DeleteTd removes all block total difficulty data associated with a hash.

func DeleteTransaction 

func DeleteTransaction(db ethdb.Database, hash common.Hash)

DeleteTransaction removes all transaction data associated with a hash.

func Disassemble 

func Disassemble(script []byte) (asm []string)

func GenerateChain 

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

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

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

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

Example 
MinGasLimit = big.NewInt(125000) // Minimum the gas limit may ever be.

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

// Ensure that key1 has some funds in the genesis block.
genesis := WriteGenesisBlockForTesting(db, GenesisAccount{addr1, big.NewInt(1000000)})

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

// Import the chain. This runs all block validation rules.
evmux := &event.TypeMux{}
blockchain, _ := NewBlockChain(db, testChainConfig(), FakePow{}, evmux)
if i, err := blockchain.InsertChain(chain); err != nil {
	fmt.Printf("insert error (block %d): %v\n", chain[i].NumberU64(), err)
	return
}

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

Output:

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

func GetBlock 

func GetBlock(db ethdb.Database, hash common.Hash) *types.Block

GetBlock retrieves an entire block corresponding to the hash, assembling it back from the stored header and body. If either the header or body could not be retrieved nil is returned.

Note, due to concurrent download of header and block body the header and thus canonical hash can be stored in the database but the body data not (yet).

func GetBlockByHashOld 

func GetBlockByHashOld(db ethdb.Database, hash common.Hash) *types.Block

[deprecated by the header/block split, remove eventually] GetBlockByHashOld returns the old combined block corresponding to the hash or nil if not found. This method is only used by the upgrade mechanism to access the old combined block representation. It will be dropped after the network transitions to eth/63.

func GetBlockChainVersion 

func GetBlockChainVersion(db ethdb.Database) int

GetBlockChainVersion reads the version number from db.

func GetBlockEra 

func GetBlockEra(blockNum, eraLength *big.Int) *big.Int

GetBlockEra gets which "Era" a given block is within, given an era length (ecip-1017 has era=5,000,000 blocks) Returns a zero-index era number, so "Era 1": 0, "Era 2": 1, "Era 3": 2 ...

func GetBlockReceipts 

func GetBlockReceipts(db ethdb.Database, hash common.Hash) types.Receipts

GetBlockReceipts retrieves the receipts generated by the transactions included in a block given by its hash.

func GetBlockUncleRewardByEra 

func GetBlockUncleRewardByEra(era *big.Int, header, uncle *types.Header) *big.Int

GetBlockUncleRewardByEra gets called _for each uncle miner_ associated with a winner block's uncles.

func GetBlockWinnerRewardByEra 

func GetBlockWinnerRewardByEra(era *big.Int) *big.Int

GetRewardByEra gets a block reward at disinflation rate. Constants MaxBlockReward, DisinflationRateQuotient, and DisinflationRateDivisor assumed.

func GetBlockWinnerRewardForUnclesByEra 

func GetBlockWinnerRewardForUnclesByEra(era *big.Int, uncles []*types.Header) *big.Int

GetBlockWinnerRewardForUnclesByEra gets called _per winner_, and accumulates rewards for each included uncle. Assumes uncles have been validated and limited (@ func (v *BlockValidator) VerifyUncles).

func GetBody 

func GetBody(db ethdb.Database, hash common.Hash) *types.Body

GetBody retrieves the block body (transactons, uncles) corresponding to the hash, nil if none found.

func GetBodyRLP 

func GetBodyRLP(db ethdb.Database, hash common.Hash) rlp.RawValue

GetBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.

func GetCanonicalHash 

func GetCanonicalHash(db ethdb.Database, number uint64) common.Hash

GetCanonicalHash retrieves a hash assigned to a canonical block number.

func GetHashFn 

func GetHashFn(ref common.Hash, chain *BlockChain) func(n uint64) common.Hash

GetHashFn returns a function for which the VM env can query block hashes through up to the limit defined by the Yellow Paper and uses the given block chain to query for information.

func GetHeadBlockHash 

func GetHeadBlockHash(db ethdb.Database) common.Hash

GetHeadBlockHash retrieves the hash of the current canonical head block.

func GetHeadFastBlockHash 

func GetHeadFastBlockHash(db ethdb.Database) common.Hash

GetHeadFastBlockHash retrieves the hash of the current canonical head block during fast synchronization. The difference between this and GetHeadBlockHash is that whereas the last block hash is only updated upon a full block import, the last fast hash is updated when importing pre-processed blocks.

func GetHeadHeaderHash 

func GetHeadHeaderHash(db ethdb.Database) common.Hash

GetHeadHeaderHash retrieves the hash of the current canonical head block's header. The difference between this and GetHeadBlockHash is that whereas the last block hash is only updated upon a full block import, the last header hash is updated already at header import, allowing head tracking for the light synchronization mechanism.

func GetHeader 

func GetHeader(db ethdb.Database, hash common.Hash) *types.Header

GetHeader retrieves the block header corresponding to the hash, nil if none found.

func GetHeaderRLP 

func GetHeaderRLP(db ethdb.Database, hash common.Hash) rlp.RawValue

GetHeaderRLP retrieves a block header in its raw RLP database encoding, or nil if the header's not found.

func GetMipmapBloom 

func GetMipmapBloom(db ethdb.Database, number, level uint64) types.Bloom

GetMipmapBloom returns a bloom filter using the number and level as input parameters. For available levels see MIPMapLevels.

func GetReceipt 

func GetReceipt(db ethdb.Database, txHash common.Hash) *types.Receipt

GetReceipt returns a receipt by hash

func GetTd 

func GetTd(db ethdb.Database, hash common.Hash) *big.Int

GetTd retrieves a block's total difficulty corresponding to the hash, nil if none found.

func GetTransaction 

func GetTransaction(db ethdb.Database, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)

GetTransaction retrieves a specific transaction from the database, along with its added positional metadata.

func IntrinsicGas 

func IntrinsicGas(data []byte, contractCreation, homestead bool) *big.Int

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

func IsBlockNonceErr 

func IsBlockNonceErr(err error) bool

IsBlockNonceErr returns true for invalid block nonce errors.

func IsGasLimitErr 

func IsGasLimitErr(err error) bool

func IsInvalidTxErr 

func IsInvalidTxErr(err error) bool

func IsKnownBlockErr 

func IsKnownBlockErr(e error) bool

func IsNonceErr 

func IsNonceErr(err error) bool

func IsParentErr 

func IsParentErr(err error) bool

func IsTDError 

func IsTDError(e error) bool

func IsUncleErr 

func IsUncleErr(err error) bool

func IsValidateError 

func IsValidateError(err error) bool

IsValidateError eturns whether err is a validation error.

func IsValueTransferErr 

func IsValueTransferErr(e error) bool

func MessageCreatesContract 

func MessageCreatesContract(msg Message) bool

func ParentError 

func ParentError(hash common.Hash) error

func ParseBootstrapNodeStrings 

func ParseBootstrapNodeStrings(nodeStrings []string) []*discover.Node

ParseBootstrapNodeStrings is a helper function to parse stringified bs nodes, ie []"enode://e809c4a2fec7daed400e5e28564e23693b23b2cc5a019b612505631bbe7b9ccf709c1796d2a3d29ef2b045f210caf51e3c4f5b6d3587d43ad5d6397526fa6179@174.112.32.157:30303",... to usable Nodes. It takes a slice of strings and returns a slice of Nodes.

func Transfer 

func Transfer(from, to vm.Account, amount *big.Int)

generic transfer method

func UncleError 

func UncleError(format string, v ...interface{}) error

func ValidateHeader 

func ValidateHeader(config *ChainConfig, pow pow.PoW, header *types.Header, parent *types.Header, checkPow, uncle bool) error

Validates a header. Returns an error if the header is invalid.

See YP section 4.3.4. "Block Header Validity"

func WriteBlock 

func WriteBlock(db ethdb.Database, block *types.Block) error

WriteBlock serializes a block into the database, header and body separately.

func WriteBlockChainVersion 

func WriteBlockChainVersion(db ethdb.Database, vsn int)

WriteBlockChainVersion writes vsn as the version number to db.

func WriteBlockReceipts 

func WriteBlockReceipts(db ethdb.Database, hash common.Hash, receipts types.Receipts) error

WriteBlockReceipts stores all the transaction receipts belonging to a block as a single receipt slice. This is used during chain reorganisations for rescheduling dropped transactions.

func WriteBody 

func WriteBody(db ethdb.Database, hash common.Hash, body *types.Body) error

WriteBody serializes the body of a block into the database.

func WriteCanonicalHash 

func WriteCanonicalHash(db ethdb.Database, hash common.Hash, number uint64) error

WriteCanonicalHash stores the canonical hash for the given block number.

func WriteGenesisBlock 

func WriteGenesisBlock(chainDb ethdb.Database, genesis *GenesisDump) (*types.Block, error)

WriteGenesisBlock writes the genesis block to the database as block number 0

func WriteGenesisBlockForTesting 

func WriteGenesisBlockForTesting(db ethdb.Database, accounts ...GenesisAccount) *types.Block

func WriteHeadBlockHash 

func WriteHeadBlockHash(db ethdb.Database, hash common.Hash) error

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash 

func WriteHeadFastBlockHash(db ethdb.Database, hash common.Hash) error

WriteHeadFastBlockHash stores the fast head block's hash.

func WriteHeadHeaderHash 

func WriteHeadHeaderHash(db ethdb.Database, hash common.Hash) error

WriteHeadHeaderHash stores the head header's hash.

func WriteHeader 

func WriteHeader(db ethdb.Database, header *types.Header) error

WriteHeader serializes a block header into the database.

func WriteMipmapBloom 

func WriteMipmapBloom(db ethdb.Database, number uint64, receipts types.Receipts) error

WriteMapmapBloom writes each address included in the receipts' logs to the MIP bloom bin.

func WriteReceipts 

func WriteReceipts(db ethdb.Database, receipts types.Receipts) error

WriteReceipts stores a batch of transaction receipts into the database.

func WriteTd 

func WriteTd(db ethdb.Database, hash common.Hash, td *big.Int) error

WriteTd serializes the total difficulty of a block into the database.

func WriteTransactions 

func WriteTransactions(db ethdb.Database, block *types.Block) error

WriteTransactions stores the transactions associated with a specific block into the given database. Beside writing the transaction, the function also stores a metadata entry along with the transaction, detailing the position of this within the blockchain.

Types

type Backend 

type Backend interface {
	AccountManager() *accounts.Manager
	BlockChain() *BlockChain
	TxPool() *TxPool
	ChainDb() ethdb.Database
	DappDb() ethdb.Database
	EventMux() *event.TypeMux
}

Backend is an interface defining the basic functionality for an operable node with all the functionality to be a functional, valid Ethereum operator.

TODO Remove this

type BadHash 

type BadHash struct {
	Block *big.Int
	Hash  common.Hash
}

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(chainDb ethdb.Database, config *ChainConfig, pow pow.PoW, mux *event.TypeMux) (*BlockChain, error)

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

func NewBlockChainDryrun 

func NewBlockChainDryrun(chainDb ethdb.Database, config *ChainConfig, pow pow.PoW, mux *event.TypeMux) (*BlockChain, error)

func (*BlockChain) AuxValidator 

func (self *BlockChain) AuxValidator() pow.PoW

AuxValidator returns the auxiliary validator (Proof of work atm)

func (*BlockChain) Config 

func (self *BlockChain) Config() *ChainConfig

Config retrieves the blockchain's chain configuration.

func (*BlockChain) CurrentBlock 

func (self *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 (self *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 (self *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) Export 

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

Export writes the active chain to the given writer.

func (*BlockChain) ExportN 

func (self *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 (self *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) GasLimit 

func (self *BlockChain) GasLimit() *big.Int

GasLimit returns the gas limit of the current HEAD block.

func (*BlockChain) Genesis 

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

Accessors

func (*BlockChain) GetBlock 

func (self *BlockChain) GetBlock(hash common.Hash) *types.Block

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

func (*BlockChain) GetBlockByNumber 

func (self *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 (self *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 (self *BlockChain) GetBlocksFromHash(hash common.Hash, n int) (blocks []*types.Block)

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

func (*BlockChain) GetBody 

func (self *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 (self *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) GetEventMux 

func (self *BlockChain) GetEventMux() *event.TypeMux

func (*BlockChain) GetHeader 

func (self *BlockChain) GetHeader(hash common.Hash) *types.Header

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

func (*BlockChain) GetHeaderByNumber 

func (self *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) GetTd 

func (self *BlockChain) GetTd(hash common.Hash) *big.Int

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

func (*BlockChain) GetUnclesInChain 

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

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

func (*BlockChain) HasBlock 

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

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

func (*BlockChain) HasBlockAndState 

func (bc *BlockChain) HasBlockAndState(hash common.Hash) 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) bool

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

func (*BlockChain) InsertChain 

func (self *BlockChain) InsertChain(chain types.Blocks) (chainIndex int, err error)

InsertChain inserts the given chain into the canonical chain or, otherwise, create a fork. If the err return is not nil then chainIndex points to the cause in chain.

func (*BlockChain) InsertHeaderChain 

func (self *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 (self *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) LastBlockHash 

func (self *BlockChain) LastBlockHash() common.Hash

LastBlockHash return the hash of the HEAD block.

func (*BlockChain) LoadLastState 

func (self *BlockChain) LoadLastState(dryrun bool) error

loadLastState loads the last known chain state from the database. This method assumes that the chain manager mutex is held.

func (*BlockChain) Processor 

func (self *BlockChain) Processor() Processor

Processor returns the current processor.

func (*BlockChain) PurgeAbove 

func (bc *BlockChain) PurgeAbove(n uint64)

PurgeAbove works like SetHead, but instead of rm'ing head <-> bc.currentBlock, it removes all stored blockchain data n -> *anyexistingblockdata* TODO: possibly replace with kv database iterator

func (*BlockChain) Recovery 

func (self *BlockChain) Recovery(from int, increment int) (checkpoint uint64)

Recovery progressively validates the health of stored blockchain data. Soft resets should only be called in case of probable corrupted or invalid stored data, and which are invalid for known or expected reasons. It requires that the blockchain state be loaded so that cached head values are available, eg CurrentBlock(), etc.

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 (self *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) 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 (self *BlockChain) SetProcessor(processor Processor)

SetProcessor sets the processor required for making state modifications.

func (*BlockChain) SetValidator 

func (self *BlockChain) SetValidator(validator Validator)

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

func (*BlockChain) State 

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

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

func (*BlockChain) StateAt 

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

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

func (*BlockChain) Status 

func (self *BlockChain) Status() (td *big.Int, currentBlock common.Hash, genesisBlock common.Hash)

Status returns status information about the current chain such as the HEAD Td, the HEAD hash and the hash of the genesis block.

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

func (self *BlockChain) Validator() Validator

Validator returns the current validator.

func (*BlockChain) WriteBlock 

func (self *BlockChain) WriteBlock(block *types.Block) (status WriteStatus, err error)

WriteBlock writes the block to the chain.

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

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

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

AddUncheckedReceipts 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 *types.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) OffsetTime 

func (b *BlockGen) OffsetTime(seconds int64)

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

func (*BlockGen) PrevBlock 

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

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

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

type BlockNonceErr struct {
	Number *big.Int
	Hash   common.Hash
	Nonce  uint64
}

BlockNonceErr indicates that a block's nonce is invalid.

func (*BlockNonceErr) Error 

func (err *BlockNonceErr) Error() string

type BlockValidator 

type BlockValidator struct {
	Pow pow.PoW // Proof of work used for validating
	// contains filtered or unexported fields
}

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

BlockValidator implements Validator.

func NewBlockValidator 

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

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

func (*BlockValidator) ValidateBlock 

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

ValidateBlock validates the given block's header and uncles and verifies the the block header's transaction and uncle roots.

ValidateBlock does not validate the header's pow. The pow work validated separately so we can process them in parallel.

ValidateBlock also validates and makes sure that any previous state (or present) state that might or might not be present is checked to make sure that fast sync has done it's job proper. This prevents the block validator form accepting false positives where a header is present but the state is not.

func (*BlockValidator) ValidateHeader 

func (v *BlockValidator) ValidateHeader(header, parent *types.Header, checkPow bool) error

ValidateHeader validates the given header and, depending on the pow arg, checks the proof of work of the given header. Returns an error if the validation failed.

func (*BlockValidator) ValidateState 

func (v *BlockValidator) ValidateState(block, parent *types.Block, statedb *state.StateDB, receipts types.Receipts, usedGas *big.Int) (err 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.

func (*BlockValidator) VerifyUncles 

func (v *BlockValidator) VerifyUncles(block, parent *types.Block) error

VerifyUncles verifies the given block's uncles and applies the Ethereum consensus rules to the various block headers included; it will return an error if any of the included uncle headers were invalid. It returns an error if the validation failed.

type ChainConfig 

type ChainConfig struct {
	// Forks holds fork block requirements. See ErrHashKnownFork.
	Forks Forks `json:"forks"`

	// BadHashes holds well known blocks with consensus issues. See ErrHashKnownBad.
	BadHashes []*BadHash `json:"badHashes"`
}

ChainConfig is stored in the database on a per block basis. This means that any network, identified by its genesis block, can have its own set of configuration options.

func MakeChainConfig 

func MakeChainConfig() *ChainConfig

MakeChainConfig returns a new ChainConfig with the ethereum default chain settings.

func MakeDiehardChainConfig 

func MakeDiehardChainConfig() *ChainConfig

func (*ChainConfig) ForkByName 

func (c *ChainConfig) ForkByName(name string) *Fork

ForkByName looks up a Fork by its name, assumed to be unique

func (*ChainConfig) GasTable 

func (c *ChainConfig) GasTable(num *big.Int) *vm.GasTable

GasTable returns the gas table corresponding to the current fork The returned GasTable's fields shouldn't, under any circumstances, be changed.

func (*ChainConfig) GetChainID 

func (c *ChainConfig) GetChainID() *big.Int

GetChainID gets the chainID for a chainconfig. It assumes chain configuration has a "Diehard" fork. It assumes eip155 will only be set on the "Diehard" fork. It returns big.Int zero-value if no chainID is set for eip155, which means that it implicitly assumes to be only called for blocks >= Diehard fork block num. If called/configured "incorrectly" it will "pass the buck" by returning a non-error (ie zero value).

func (*ChainConfig) GetFeature 

func (c *ChainConfig) GetFeature(num *big.Int, id string) (*ForkFeature, *Fork, bool)

GetFeature looks up fork features by id, where id can (currently) be [difficulty, gastable, eip155]. GetFeature returns the feature|nil, the latest fork configuring a given id, and if the given feature id was found at all If queried feature is not found, returns ForkFeature{}, Fork{}, false. If queried block number and/or feature is a zero-value, returns ForkFeature{}, Fork{}, false.

func (*ChainConfig) GetSigner 

func (c *ChainConfig) GetSigner(blockNumber *big.Int) types.Signer

func (*ChainConfig) HasFeature 

func (c *ChainConfig) HasFeature(id string) (*ForkFeature, *Fork, bool)

HasFeature looks up if fork feature exists on any fork at any block in the configuration. In case of multiple same-'id'd features, returns latest (assuming forks are sorted).

func (*ChainConfig) HeaderCheck 

func (c *ChainConfig) HeaderCheck(h *types.Header) error

func (*ChainConfig) IsDiehard 

func (c *ChainConfig) IsDiehard(num *big.Int) bool

IsDiehard returns whether num is greater than or equal to the Diehard block, but less than explosion.

func (*ChainConfig) IsExplosion 

func (c *ChainConfig) IsExplosion(num *big.Int) bool

IsExplosion returns whether num is either equal to the explosion block or greater.

func (*ChainConfig) IsHomestead 

func (c *ChainConfig) IsHomestead(num *big.Int) bool

IsHomestead returns whether num is either equal to the homestead block or greater.

func (*ChainConfig) SortForks 

func (c *ChainConfig) SortForks() *ChainConfig

SortForks sorts a ChainConfiguration's forks by block number smallest to bigget (chronologically). This should need be called only once after construction

type ChainEvent 

type ChainEvent struct {
	Block *types.Block
	Hash  common.Hash
	Logs  vm.Logs
}

type ChainFeatureConfigOptions 

type ChainFeatureConfigOptions map[string]interface{}

These are the raw key-value configuration options made available by an external JSON file.

type ChainHeadEvent 

type ChainHeadEvent struct{ Block *types.Block }

type ChainInsertEvent 

type ChainInsertEvent struct {
	Processed       int
	Queued          int
	Ignored         int
	TxCount         int
	LastNumber      uint64
	LastHash        common.Hash
	Elasped         time.Duration
	LatestBlockTime time.Time
}

type ChainSideEvent 

type ChainSideEvent struct {
	Block *types.Block
	Logs  vm.Logs
}

type ChainSplitEvent 

type ChainSplitEvent struct {
	Block *types.Block
	Logs  vm.Logs
}

ChainSplit is posted when a new head is detected

type ChainUncleEvent 

type ChainUncleEvent struct {
	Block *types.Block
}

TODO: no usages found in project files

type DeleteCallback 

type DeleteCallback func(common.Hash)

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

type DifficultyConfig 

type DifficultyConfig struct {
	Name    string                 `json:"name"`
	Options map[string]interface{} `json:"options"`
}

Difficulty allows passing configurable options to a given difficulty algorithm.

type FakePow 

type FakePow struct{}

FakePow is a non-validating proof of work implementation. It returns true from Verify for any block.

func (FakePow) GetHashrate 

func (f FakePow) GetHashrate() int64

func (FakePow) Search 

func (f FakePow) Search(block pow.Block, stop <-chan struct{}, index int) (uint64, []byte)

func (FakePow) Turbo 

func (f FakePow) Turbo(bool)

func (FakePow) Verify 

func (f FakePow) Verify(block pow.Block) bool

type Fork 

type Fork struct {
	Name string `json:"name"`
	// Block is the block number where the hard-fork commences on
	// the Ethereum network.
	Block *big.Int `json:"block"`
	// Used to improve sync for a known network split
	RequiredHash common.Hash `json:"requiredHash"`
	// Configurable features.
	Features []*ForkFeature `json:"features"`
}

type ForkFeature 

type ForkFeature struct {
	ID      string                    `json:"id"`
	Options ChainFeatureConfigOptions `json:"options"` // no * because they have to be iterable(?)

	ParsedOptions map[string]interface{} `json:"-"` // don't include in JSON dumps, since its for holding parsed JSON in mem
	// contains filtered or unexported fields
}

ForkFeatures are designed to decouple the implementation feature upgrades from Forks themselves. For example, there are several 'set-gasprice' features, each using a different gastable, as well as protocol upgrades including 'eip155', 'ecip1010', ... etc.

func (*ForkFeature) GetBigInt 

func (o *ForkFeature) GetBigInt(name string) (*big.Int, bool)

GetBigInt gets and option value for an options with key 'name', returning value as a *big.Int and ok if it exists.

func (*ForkFeature) GetString 

func (o *ForkFeature) GetString(name string) (string, bool)

GetString gets and option value for an options with key 'name', returning value as a string.

type Forks 

type Forks []*Fork

Forks implements sort interface, sorting by block number

func (Forks) Len 

func (fs Forks) Len() int

func (Forks) Less 

func (fs Forks) Less(i, j int) bool

func (Forks) Swap 

func (fs Forks) Swap(i, j int)

type GasLimitErr 

type GasLimitErr struct {
	Have, Want *big.Int
}

func (*GasLimitErr) Error 

func (err *GasLimitErr) Error() string

type GasPool 

type GasPool big.Int

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 *big.Int) *GasPool

AddGas makes gas available for execution.

func (*GasPool) String 

func (gp *GasPool) String() string

func (*GasPool) SubGas 

func (gp *GasPool) SubGas(amount *big.Int) error

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

type GasPriceChanged 

type GasPriceChanged struct{ Price *big.Int }

type GenesisAccount 

type GenesisAccount struct {
	Address common.Address `json:"address"`
	Balance *big.Int       `json:"balance"`
}

type GenesisDump 

type GenesisDump struct {
	Nonce      prefixedHex `json:"nonce"`
	Timestamp  prefixedHex `json:"timestamp"`
	ParentHash prefixedHex `json:"parentHash"`
	ExtraData  prefixedHex `json:"extraData"`
	GasLimit   prefixedHex `json:"gasLimit"`
	Difficulty prefixedHex `json:"difficulty"`
	Mixhash    prefixedHex `json:"mixhash"`
	Coinbase   prefixedHex `json:"coinbase"`

	// Alloc maps accounts by their address.
	Alloc map[hex]*GenesisDumpAlloc `json:"alloc"`
}

GenesisDump is the geth JSON format. https://github.com/ethereumproject/wiki/wiki/Ethereum-Chain-Spec-Format#subformat-genesis

func MakeGenesisDump 

func MakeGenesisDump(chaindb ethdb.Database) (*GenesisDump, error)

MakeGenesisDump makes a genesis dump

func (*GenesisDump) Header 

func (g *GenesisDump) Header() (*types.Header, error)

Header returns the mapping.

type GenesisDumpAlloc 

type GenesisDumpAlloc struct {
	Code    prefixedHex `json:"-"` // skip field for json encode
	Storage map[hex]hex `json:"-"`
	Balance string      `json:"balance"` // decimal string
}

GenesisDumpAlloc is a GenesisDump.Alloc entry.

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 *ChainConfig, mux *event.TypeMux, getValidator getHeaderValidatorFn, 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) 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) 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) GetHeader 

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

GetHeader 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) *big.Int

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

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

func (*HeaderChain) InsertHeaderChain 

func (hc *HeaderChain) InsertHeaderChain(chain []*types.Header, checkFreq int, writeHeader WhCallback) (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) PurgeAbove 

func (hc *HeaderChain) PurgeAbove(n uint64, delFn DeleteCallback)

PurgeAbove remove blockchain data above given head 'n'. Similar to hc.SetHead, but uses hardcoded 2048 scan range to check for existing blockchain above last found existing head. TODO: possibly replace with kv database iterator

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, delFn DeleteCallback)

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

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 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, td *big.Int) error

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

type HeaderChainInsertEvent 

type HeaderChainInsertEvent struct {
	Processed  int
	Ignored    int
	LastNumber uint64
	LastHash   common.Hash
	Elasped    time.Duration
}

type HeaderValidator 

type HeaderValidator interface {
	ValidateHeader(header, parent *types.Header, checkPow bool) error
}

HeaderValidator is an interface for validating headers only

ValidateHeader validates the given header and parent and returns an error if it failed to do so.

type InvalidTxErr 

type InvalidTxErr struct {
	Message string
}

func InvalidTxError 

func InvalidTxError(err error) *InvalidTxErr

func (*InvalidTxErr) Error 

func (err *InvalidTxErr) Error() string

type KnownBlockError 

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

func (*KnownBlockError) Error 

func (self *KnownBlockError) Error() string

type Message 

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

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

	Nonce() uint64
	Data() []byte
}

Message represents a message sent to a contract.

type NewBlockEvent 

type NewBlockEvent struct{ Block *types.Block }

NewBlockEvent is posted when a block has been imported.

type NewMinedBlockEvent 

type NewMinedBlockEvent struct{ Block *types.Block }

NewMinedBlockEvent is posted when a block has been imported.

type NonceErr 

type NonceErr struct {
	Message string
	Is, Exp uint64
}

func NonceError 

func NonceError(is, exp uint64) *NonceErr

func (*NonceErr) Error 

func (err *NonceErr) Error() string

type ParentErr 

type ParentErr struct {
	Message string
}

Parent error. In case a parent is unknown this error will be thrown by the block manager

func (*ParentErr) Error 

func (err *ParentErr) Error() string

type PendingBlockEvent 

type PendingBlockEvent struct {
	Block *types.Block
	Logs  vm.Logs
}

TODO: no usages found in project files

type PendingLogsEvent 

type PendingLogsEvent struct {
	Logs vm.Logs
}

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 Processor 

type Processor interface {
	Process(block *types.Block, statedb *state.StateDB) (types.Receipts, vm.Logs, *big.Int, 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 vm.Logs }

RemovedLogEvent is posted when a reorg happens

type RemovedTransactionEvent 

type RemovedTransactionEvent struct{ Txs types.Transactions }

RemovedTransactionEvent is posted when a reorg happens

type StartMining 

type StartMining struct{}

Mining operation events

type StateConfig 

type StateConfig struct {
	StartingNonce uint64 `json:"startingNonce,omitempty"`
}

StateConfig hold variable data for statedb.

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 *ChainConfig, bc *BlockChain) *StateProcessor

NewStateProcessor initialises a new StateProcessor.

func (*StateProcessor) Process 

func (p *StateProcessor) Process(block *types.Block, statedb *state.StateDB) (types.Receipts, vm.Logs, *big.Int, 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
}

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 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(env vm.Environment, msg Message, gp *GasPool) *StateTransition

NewStateTransition initialises and returns a new state transition object.

func (*StateTransition) TransitionDb 

func (self *StateTransition) TransitionDb() (ret []byte, requiredGas, usedGas *big.Int, err error)

TransitionDb will move the state by applying the message against the given environment.

type StopMining 

type StopMining struct{}

type SufficientChainConfig 

type SufficientChainConfig struct {
	ID              string           `json:"id,omitempty"` // deprecated in favor of 'Identity', method decoding should id -> identity
	Identity        string           `json:"identity"`
	Name            string           `json:"name,omitempty"`
	State           *StateConfig     `json:"state"`     // don't omitempty for clarity of potential custom options
	Network         int              `json:"network"`   // eth.NetworkId (mainnet=1, morden=2)
	Consensus       string           `json:"consensus"` // pow type (ethash OR ethash-test)
	Genesis         *GenesisDump     `json:"genesis"`
	ChainConfig     *ChainConfig     `json:"chainConfig"`
	Bootstrap       []string         `json:"bootstrap"`
	ParsedBootstrap []*discover.Node `json:"-"`
}

SufficientChainConfig holds necessary data for externalizing a given blockchain configuration. 

var (
	DefaultConfigMainnet *SufficientChainConfig
	DefaultConfigMorden  *SufficientChainConfig
)

func ReadExternalChainConfigFromFile 

func ReadExternalChainConfigFromFile(incomingPath string) (*SufficientChainConfig, error)

ReadExternalChainConfigFromFile reads a flagged external json file for blockchain configuration. It returns a valid and full ("hard") configuration or an error.

func (*SufficientChainConfig) IsValid 

func (c *SufficientChainConfig) IsValid() (string, bool)

func (*SufficientChainConfig) WriteToJSONFile 

func (c *SufficientChainConfig) WriteToJSONFile(path string) error

WriteToJSONFile writes a given config to a specified file path. It doesn't run any checks on the file path so make sure that's already squeaky clean.

type TDError 

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

func (*TDError) Error 

func (self *TDError) Error() string

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 *ChainConfig, eventMux *event.TypeMux, currentStateFn stateFn, gasLimitFn func() *big.Int) *TxPool

func (*TxPool) Add 

func (self *TxPool) Add(tx *types.Transaction) error

Add queues a single transaction in the pool if it is valid.

func (*TxPool) AddTransactions 

func (self *TxPool) AddTransactions(txs []*types.Transaction)

AddTransactions attempts to queue all valid transactions in txs.

func (*TxPool) Content 

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

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

func (*TxPool) GetQueuedTransactions 

func (self *TxPool) GetQueuedTransactions() types.Transactions

GetQueuedTransactions returns all non-processable transactions.

func (*TxPool) GetTransaction 

func (tp *TxPool) GetTransaction(hash common.Hash) *types.Transaction

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

func (*TxPool) GetTransactions 

func (self *TxPool) GetTransactions() (txs types.Transactions)

GetTransactions returns all currently processable transactions. The returned slice may be modified by the caller.

func (*TxPool) RemoveTransactions 

func (self *TxPool) RemoveTransactions(txs types.Transactions)

RemoveTransactions removes all given transactions from the pool.

func (*TxPool) RemoveTx 

func (pool *TxPool) RemoveTx(hash common.Hash)

RemoveTx removes the transaction with the given hash from the pool.

func (*TxPool) SetLocal 

func (pool *TxPool) SetLocal(tx *types.Transaction)

SetLocal marks a transaction as local, skipping gas price 

check against local miner minimum in the future

func (*TxPool) State 

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

func (*TxPool) Stats 

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

func (*TxPool) Stop 

func (pool *TxPool) Stop()

type TxPostEvent 

type TxPostEvent struct{ Tx *types.Transaction }

TxPostEvent is posted when a transaction has been processed.

type TxPreEvent 

type TxPreEvent struct{ Tx *types.Transaction }

TxPreEvent is posted when a transaction enters the transaction pool.

type UncleErr 

type UncleErr struct {
	Message string
}

func (*UncleErr) Error 

func (err *UncleErr) Error() string

type VMEnv 

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

func NewEnv 

func NewEnv(state *state.StateDB, chainConfig *ChainConfig, chain *BlockChain, msg Message, header *types.Header) *VMEnv

func (*VMEnv) AddLog 

func (self *VMEnv) AddLog(log *vm.Log)

func (*VMEnv) BlockNumber 

func (self *VMEnv) BlockNumber() *big.Int

func (*VMEnv) Call 

func (self *VMEnv) Call(me vm.ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error)

func (*VMEnv) CallCode 

func (self *VMEnv) CallCode(me vm.ContractRef, addr common.Address, data []byte, gas, price, value *big.Int) ([]byte, error)

func (*VMEnv) CanTransfer 

func (self *VMEnv) CanTransfer(from common.Address, balance *big.Int) bool

func (*VMEnv) Coinbase 

func (self *VMEnv) Coinbase() common.Address

func (*VMEnv) Create 

func (self *VMEnv) Create(me vm.ContractRef, data []byte, gas, price, value *big.Int) ([]byte, common.Address, error)

func (*VMEnv) Db 

func (self *VMEnv) Db() vm.Database

func (*VMEnv) DelegateCall 

func (self *VMEnv) DelegateCall(me vm.ContractRef, addr common.Address, data []byte, gas, price *big.Int) ([]byte, error)

func (*VMEnv) Depth 

func (self *VMEnv) Depth() int

func (*VMEnv) Difficulty 

func (self *VMEnv) Difficulty() *big.Int

func (*VMEnv) GasLimit 

func (self *VMEnv) GasLimit() *big.Int

func (*VMEnv) GetHash 

func (self *VMEnv) GetHash(n uint64) common.Hash

func (*VMEnv) Origin 

func (self *VMEnv) Origin() common.Address

func (*VMEnv) RevertToSnapshot 

func (self *VMEnv) RevertToSnapshot(snapshot int)

func (*VMEnv) RuleSet 

func (self *VMEnv) RuleSet() vm.RuleSet

func (*VMEnv) SetDepth 

func (self *VMEnv) SetDepth(i int)

func (*VMEnv) SnapshotDatabase 

func (self *VMEnv) SnapshotDatabase() int

func (*VMEnv) Time 

func (self *VMEnv) Time() *big.Int

func (*VMEnv) Transfer 

func (self *VMEnv) Transfer(from, to vm.Account, amount *big.Int)

func (*VMEnv) Value 

func (self *VMEnv) Value() *big.Int

func (*VMEnv) Vm 

func (self *VMEnv) Vm() vm.Vm

type Validator 

type Validator interface {
	HeaderValidator
	ValidateBlock(block *types.Block) error
	ValidateState(block, parent *types.Block, state *state.StateDB, receipts types.Receipts, usedGas *big.Int) error
	VerifyUncles(block, parent *types.Block) error
}

Validator is an interface which defines the standard for block validation.

The validator is responsible for validating incoming block or, if desired, validates headers for fast validation.

ValidateBlock validates the given block and should return an error if it failed to do so and should be used for "full" validation.

ValidateHeader validates the given header and parent and returns an error if it failed to do so.

ValidateState validates the given statedb and optionally the receipts and gas used. The implementer should decide what to do with the given input.

type ValueTransferError 

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

func ValueTransferErr 

func ValueTransferErr(str string, v ...interface{}) *ValueTransferError

func (*ValueTransferError) Error 

func (self *ValueTransferError) Error() string

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 WriteStatus 

type WriteStatus byte
const (
	NonStatTy WriteStatus = iota
	CanonStatTy
	SideStatTy
)

Source Files

View all Source files

Directories

Path Synopsis
Package assets is generated by github.com/omeid/go-resources
 Package assets is generated by github.com/omeid/go-resources
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.