Documentation ¶
Overview ¶
Package core implements the Ethereum consensus protocol.
Index ¶
- Constants
- Variables
- func AccumulateRewards(statedb *state.StateDB, header *types.Header, uncles []*types.Header)
- func ApplyMessage(env vm.Environment, msg Message, gp *GasPool) ([]byte, *big.Int, error)
- func ApplyTransaction(bc *BlockChain, gp *GasPool, statedb *state.StateDB, header *types.Header, ...) (*types.Receipt, vm.Logs, *big.Int, error)
- func CalcDifficulty(time, parentTime uint64, parentNumber, parentDiff *big.Int) *big.Int
- func CalcGasLimit(parent *types.Block) *big.Int
- func Call(env vm.Environment, caller vm.ContractRef, addr common.Address, input []byte, ...) (ret []byte, err error)
- func CallCode(env vm.Environment, caller vm.ContractRef, addr common.Address, input []byte, ...) (ret []byte, err error)
- func Canary(statedb *state.StateDB) bool
- func Create(env vm.Environment, caller vm.ContractRef, code []byte, ...) (ret []byte, address common.Address, err error)
- func DelegateCall(env vm.Environment, caller vm.ContractRef, addr common.Address, input []byte, ...) (ret []byte, err error)
- func DeleteBlock(db ethdb.Database, hash common.Hash)
- func DeleteBlockReceipts(db ethdb.Database, hash common.Hash)
- func DeleteBody(db ethdb.Database, hash common.Hash)
- func DeleteCanonicalHash(db ethdb.Database, number uint64)
- func DeleteHeader(db ethdb.Database, hash common.Hash)
- func DeleteReceipt(db ethdb.Database, hash common.Hash)
- func DeleteTd(db ethdb.Database, hash common.Hash)
- func DeleteTransaction(db ethdb.Database, hash common.Hash)
- func Disassemble(script []byte) (asm []string)
- func GenerateChain(parent *types.Block, db ethdb.Database, n int, gen func(int, *BlockGen)) ([]*types.Block, []types.Receipts)
- func GenesisBlockForTesting(db ethdb.Database, addr common.Address, balance *big.Int) *types.Block
- func GetBlock(db ethdb.Database, hash common.Hash) *types.Block
- func GetBlockByHashOld(db ethdb.Database, hash common.Hash) *types.Block
- func GetBlockReceipts(db ethdb.Database, hash common.Hash) types.Receipts
- func GetBody(db ethdb.Database, hash common.Hash) *types.Body
- func GetBodyRLP(db ethdb.Database, hash common.Hash) rlp.RawValue
- func GetCanonicalHash(db ethdb.Database, number uint64) common.Hash
- func GetHeadBlockHash(db ethdb.Database) common.Hash
- func GetHeadFastBlockHash(db ethdb.Database) common.Hash
- func GetHeadHeaderHash(db ethdb.Database) common.Hash
- func GetHeader(db ethdb.Database, hash common.Hash) *types.Header
- func GetHeaderRLP(db ethdb.Database, hash common.Hash) rlp.RawValue
- func GetMipmapBloom(db ethdb.Database, number, level uint64) types.Bloom
- func GetReceipt(db ethdb.Database, txHash common.Hash) *types.Receipt
- func GetTd(db ethdb.Database, hash common.Hash) *big.Int
- func GetTransaction(db ethdb.Database, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
- func IntrinsicGas(data []byte, contractCreation, homestead bool) *big.Int
- func IsBadHashError(err error) bool
- func IsBlockNonceErr(err error) bool
- func IsGasLimitErr(err error) bool
- func IsInvalidTxErr(err error) bool
- func IsKnownBlockErr(e error) bool
- func IsNonceErr(err error) bool
- func IsParentErr(err error) bool
- func IsTDError(e error) bool
- func IsUncleErr(err error) bool
- func IsValidationErr(err error) bool
- func IsValueTransferErr(e error) bool
- func MessageCreatesContract(msg Message) bool
- func NewDefaultGenesisReader() (io.Reader, error)
- func ParentError(hash common.Hash) error
- func ReportBlock(block *types.Block, err error)
- func Transfer(from, to vm.Account, amount *big.Int)
- func UncleError(format string, v ...interface{}) error
- func ValidateHeader(pow pow.PoW, header *types.Header, parent *types.Header, checkPow, uncle bool) error
- func WriteBlock(db ethdb.Database, block *types.Block) error
- func WriteBlockReceipts(db ethdb.Database, hash common.Hash, receipts types.Receipts) error
- func WriteBody(db ethdb.Database, hash common.Hash, body *types.Body) error
- func WriteCanonicalHash(db ethdb.Database, hash common.Hash, number uint64) error
- func WriteGenesisBlock(chainDb ethdb.Database, reader io.Reader) (*types.Block, error)
- func WriteGenesisBlockForTesting(db ethdb.Database, accounts ...GenesisAccount) *types.Block
- func WriteHeadBlockHash(db ethdb.Database, hash common.Hash) error
- func WriteHeadFastBlockHash(db ethdb.Database, hash common.Hash) error
- func WriteHeadHeaderHash(db ethdb.Database, hash common.Hash) error
- func WriteHeader(db ethdb.Database, header *types.Header) error
- func WriteMipmapBloom(db ethdb.Database, number uint64, receipts types.Receipts) error
- func WriteOlympicGenesisBlock(chainDb ethdb.Database, nonce uint64) (*types.Block, error)
- func WriteReceipts(db ethdb.Database, receipts types.Receipts) error
- func WriteTd(db ethdb.Database, hash common.Hash, td *big.Int) error
- func WriteTestNetGenesisBlock(chainDb ethdb.Database, nonce uint64) (*types.Block, error)
- func WriteTransactions(db ethdb.Database, block *types.Block) error
- type Backend
- type BadHashError
- type BlockChain
- func (self *BlockChain) AuxValidator() pow.PoW
- func (self *BlockChain) CurrentBlock() *types.Block
- func (self *BlockChain) CurrentFastBlock() *types.Block
- func (self *BlockChain) CurrentHeader() *types.Header
- func (self *BlockChain) Export(w io.Writer) error
- func (self *BlockChain) ExportN(w io.Writer, first uint64, last uint64) error
- func (self *BlockChain) FastSyncCommitHead(hash common.Hash) error
- func (self *BlockChain) GasLimit() *big.Int
- func (bc *BlockChain) Genesis() *types.Block
- func (self *BlockChain) GetBlock(hash common.Hash) *types.Block
- func (self *BlockChain) GetBlockByNumber(number uint64) *types.Block
- func (self *BlockChain) GetBlockHashesFromHash(hash common.Hash, max uint64) []common.Hash
- func (self *BlockChain) GetBlocksFromHash(hash common.Hash, n int) (blocks []*types.Block)
- func (self *BlockChain) GetBody(hash common.Hash) *types.Body
- func (self *BlockChain) GetBodyRLP(hash common.Hash) rlp.RawValue
- func (self *BlockChain) GetHeader(hash common.Hash) *types.Header
- func (self *BlockChain) GetHeaderByNumber(number uint64) *types.Header
- func (self *BlockChain) GetTd(hash common.Hash) *big.Int
- func (self *BlockChain) GetUnclesInChain(block *types.Block, length int) []*types.Header
- func (bc *BlockChain) HasBlock(hash common.Hash) bool
- func (bc *BlockChain) HasBlockAndState(hash common.Hash) bool
- func (bc *BlockChain) HasHeader(hash common.Hash) bool
- func (self *BlockChain) InsertChain(chain types.Blocks) (int, error)
- func (self *BlockChain) InsertHeaderChain(chain []*types.Header, checkFreq int) (int, error)
- func (self *BlockChain) InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts) (int, error)
- func (self *BlockChain) LastBlockHash() common.Hash
- func (self *BlockChain) Processor() Processor
- func (bc *BlockChain) Reset()
- func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block)
- func (self *BlockChain) Rollback(chain []common.Hash)
- func (bc *BlockChain) SetHead(head uint64)
- func (self *BlockChain) SetProcessor(processor Processor)
- func (self *BlockChain) SetValidator(validator Validator)
- func (self *BlockChain) State() (*state.StateDB, error)
- func (self *BlockChain) Status() (td *big.Int, currentBlock common.Hash, genesisBlock common.Hash)
- func (bc *BlockChain) Stop()
- func (self *BlockChain) Validator() Validator
- func (self *BlockChain) WriteBlock(block *types.Block) (status writeStatus, err error)
- type BlockGen
- func (b *BlockGen) AddTx(tx *types.Transaction)
- func (b *BlockGen) AddUncheckedReceipt(receipt *types.Receipt)
- func (b *BlockGen) AddUncle(h *types.Header)
- func (b *BlockGen) OffsetTime(seconds int64)
- func (b *BlockGen) PrevBlock(index int) *types.Block
- func (b *BlockGen) SetCoinbase(addr common.Address)
- func (b *BlockGen) SetExtra(data []byte)
- func (b *BlockGen) TxNonce(addr common.Address) uint64
- type BlockNonceErr
- type BlockValidator
- func (v *BlockValidator) ValidateBlock(block *types.Block) error
- func (v *BlockValidator) ValidateHeader(header, parent *types.Header, checkPow bool) error
- func (v *BlockValidator) ValidateState(block, parent *types.Block, statedb *state.StateDB, receipts types.Receipts, ...) (err error)
- func (v *BlockValidator) VerifyUncles(block, parent *types.Block) error
- type ChainEvent
- type ChainHeadEvent
- type ChainSideEvent
- type ChainSplitEvent
- type ChainUncleEvent
- type FakePow
- type GasLimitErr
- type GasPool
- type GasPriceChanged
- type GenesisAccount
- type InvalidTxErr
- type KnownBlockError
- type Message
- type NewBlockEvent
- type NewMinedBlockEvent
- type NonceErr
- type ParentErr
- type PendingBlockEvent
- type Processor
- type RemovedTransactionEvent
- type StartMining
- type StateProcessor
- type StateTransition
- type TDError
- type TopMining
- type TxPool
- func (self *TxPool) Add(tx *types.Transaction) error
- func (self *TxPool) AddTransactions(txs []*types.Transaction)
- func (self *TxPool) GetQueuedTransactions() types.Transactions
- func (tp *TxPool) GetTransaction(hash common.Hash) *types.Transaction
- func (self *TxPool) GetTransactions() (txs types.Transactions)
- func (self *TxPool) RemoveTransactions(txs types.Transactions)
- func (pool *TxPool) RemoveTx(hash common.Hash)
- func (pool *TxPool) State() *state.ManagedState
- func (pool *TxPool) Stats() (pending int, queued int)
- func (pool *TxPool) Stop()
- type TxPostEvent
- type TxPreEvent
- type UncleErr
- type VMEnv
- func (self *VMEnv) AddLog(log *vm.Log)
- func (self *VMEnv) AddStructLog(log vm.StructLog)
- func (self *VMEnv) BlockNumber() *big.Int
- func (self *VMEnv) Call(me vm.ContractRef, addr common.Address, data []byte, ...) ([]byte, error)
- func (self *VMEnv) CallCode(me vm.ContractRef, addr common.Address, data []byte, ...) ([]byte, error)
- func (self *VMEnv) CanTransfer(from common.Address, balance *big.Int) bool
- func (self *VMEnv) Coinbase() common.Address
- func (self *VMEnv) Create(me vm.ContractRef, data []byte, gas, price, value *big.Int) ([]byte, common.Address, error)
- func (self *VMEnv) Db() vm.Database
- func (self *VMEnv) DelegateCall(me vm.ContractRef, addr common.Address, data []byte, gas, price *big.Int) ([]byte, error)
- func (self *VMEnv) Depth() int
- func (self *VMEnv) Difficulty() *big.Int
- func (self *VMEnv) GasLimit() *big.Int
- func (self *VMEnv) GetHash(n uint64) common.Hash
- func (self *VMEnv) MakeSnapshot() vm.Database
- func (self *VMEnv) Origin() common.Address
- func (self *VMEnv) SetDepth(i int)
- func (self *VMEnv) SetSnapshot(copy vm.Database)
- func (self *VMEnv) SetVmType(t vm.Type)
- func (self *VMEnv) StructLogs() []vm.StructLog
- func (self *VMEnv) Time() *big.Int
- func (self *VMEnv) Transfer(from, to vm.Account, amount *big.Int)
- func (self *VMEnv) Value() *big.Int
- func (self *VMEnv) VmType() vm.Type
- type ValidationErr
- type Validator
- type ValueTransferError
Examples ¶
Constants ¶
const ( NonStatTy writeStatus = iota CanonStatTy SplitStatTy SideStatTy )
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 )
Variables ¶
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") )
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") )
var BadHashes = map[common.Hash]bool{ common.HexToHash("05bef30ef572270f654746da22639a7a0c97dd97a7050b9e252391996aaeb689"): true, }
Set of manually tracked bad hashes (usually hard forks)
var (
Big0 = big.NewInt(0)
)
var BlockReward *big.Int = big.NewInt(5e+18)
var DisableBadBlockReporting = true
DisabledBadBlockReporting can be set to prevent blocks being reported.
var (
ErrNoGenesis = errors.New("Genesis not found in chain")
)
var (
ExpDiffPeriod = big.NewInt(100000)
)
var (
MIPMapLevels = []uint64{1000000, 500000, 100000, 50000, 1000}
)
Functions ¶
func AccumulateRewards ¶ added in v0.9.18
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 ¶ added in v0.9.18
func ApplyTransaction ¶ added in v1.3.2
func ApplyTransaction(bc *BlockChain, gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *big.Int) (*types.Receipt, vm.Logs, *big.Int, error)
ApplyTransaction attemps 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 ¶
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 ¶ added in v0.8.4
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 ¶ added in v1.3.1
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 ¶ added in v1.3.1
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 Canary ¶ added in v0.9.34
Canary will check the 0'd address of the 4 contracts above. If two or more are set to anything other than a 0 the canary dies a horrible death.
func Create ¶ added in v1.3.1
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 ¶ added in v1.3.4
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 ¶ added in v1.2.2
DeleteBlock removes all block data associated with a hash.
func DeleteBlockReceipts ¶ added in v1.3.2
DeleteBlockReceipts removes all receipt data associated with a block hash.
func DeleteBody ¶ added in v1.2.2
DeleteBody removes all block body data associated with a hash.
func DeleteCanonicalHash ¶ added in v1.2.2
DeleteCanonicalHash removes the number to hash canonical mapping.
func DeleteHeader ¶ added in v1.2.2
DeleteHeader removes all block header data associated with a hash.
func DeleteReceipt ¶ added in v1.2.2
DeleteReceipt removes all receipt data associated with a transaction hash.
func DeleteTd ¶ added in v1.2.2
DeleteTd removes all block total difficulty data associated with a hash.
func DeleteTransaction ¶ added in v1.2.2
DeleteTransaction removes all transaction data associated with a hash.
func Disassemble ¶
func GenerateChain ¶ added in v0.9.34
func GenerateChain(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 ¶
params.MinGasLimit = big.NewInt(125000) // Minimum the gas limit may ever be. params.GenesisGasLimit = big.NewInt(3141592) // Gas limit of the Genesis block. 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(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), params.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), params.TxGas, nil, nil).SignECDSA(key1) tx2, _ := types.NewTransaction(gen.TxNonce(addr2), addr3, big.NewInt(1000), params.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, FakePow{}, evmux) if i, err := blockchain.InsertChain(chain); err != nil { fmt.Printf("insert error (block %d): %v\n", i, 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 GenesisBlockForTesting ¶ added in v0.9.34
GenesisBlockForTesting creates a block in which addr has the given wei balance. The state trie of the block is written to db. the passed db needs to contain a state root
func GetBlock ¶ added in v1.2.2
GetBlock retrieves an entire block corresponding to the hash, assembling it back from the stored header and body.
func GetBlockByHashOld ¶ added in v1.2.2
[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 GetBlockReceipts ¶ added in v0.9.39
GetBlockReceipts retrieves the receipts generated by the transactions included in a block given by its hash.
func GetBody ¶ added in v1.2.2
GetBody retrieves the block body (transactons, uncles) corresponding to the hash, nil if none found.
func GetBodyRLP ¶ added in v1.2.2
GetBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
func GetCanonicalHash ¶ added in v1.2.2
GetCanonicalHash retrieves a hash assigned to a canonical block number.
func GetHeadBlockHash ¶ added in v1.2.2
GetHeadBlockHash retrieves the hash of the current canonical head block.
func GetHeadFastBlockHash ¶ added in v1.3.1
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 ¶ added in v1.2.2
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 ¶ added in v1.2.2
GetHeader retrieves the block header corresponding to the hash, nil if none found.
func GetHeaderRLP ¶ added in v1.2.2
GetHeaderRLP retrieves a block header in its raw RLP database encoding, or nil if the header's not found.
func GetMipmapBloom ¶ added in v1.3.1
GetMipmapBloom returns a bloom filter using the number and level as input parameters. For available levels see MIPMapLevels.
func GetReceipt ¶ added in v0.9.36
GetReceipt returns a receipt by hash
func GetTd ¶ added in v1.2.2
GetTd retrieves a block's total difficulty corresponding to the hash, nil if none found.
func GetTransaction ¶ added in v1.2.2
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 ¶ added in v0.9.18
IntrinsicGas computes the 'intrisic gas' for a message with the given data.
func IsBadHashError ¶ added in v1.2.2
func IsBlockNonceErr ¶ added in v0.9.34
IsBlockNonceErr returns true for invalid block nonce errors.
func IsGasLimitErr ¶
func IsInvalidTxErr ¶ added in v0.9.18
func IsKnownBlockErr ¶
func IsNonceErr ¶
func IsParentErr ¶
func IsUncleErr ¶
func IsValidationErr ¶
func IsValueTransferErr ¶ added in v0.9.18
func MessageCreatesContract ¶
func NewDefaultGenesisReader ¶ added in v1.0.1
func ParentError ¶
func ReportBlock ¶ added in v0.9.36
ReportBlock reports the block to the block reporting tool found at badblocks.ethdev.com
func UncleError ¶
func ValidateHeader ¶ added in v0.9.34
func ValidateHeader(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 ¶ added in v0.9.39
WriteBlock serializes a block into the database, header and body separately.
func WriteBlockReceipts ¶ added in v1.3.2
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 WriteCanonicalHash ¶ added in v1.2.2
WriteCanonicalHash stores the canonical hash for the given block number.
func WriteGenesisBlock ¶ added in v0.9.39
WriteGenesisBlock writes the genesis block to the database as block number 0
func WriteGenesisBlockForTesting ¶ added in v0.9.39
func WriteGenesisBlockForTesting(db ethdb.Database, accounts ...GenesisAccount) *types.Block
func WriteHeadBlockHash ¶ added in v1.2.2
WriteHeadBlockHash stores the head block's hash.
func WriteHeadFastBlockHash ¶ added in v1.3.1
WriteHeadFastBlockHash stores the fast head block's hash.
func WriteHeadHeaderHash ¶ added in v1.2.2
WriteHeadHeaderHash stores the head header's hash.
func WriteHeader ¶ added in v1.2.2
WriteHeader serializes a block header into the database.
func WriteMipmapBloom ¶ added in v1.3.1
WriteMapmapBloom writes each address included in the receipts' logs to the MIP bloom bin.
func WriteOlympicGenesisBlock ¶ added in v1.3.1
func WriteReceipts ¶ added in v1.3.2
WriteReceipts stores a batch of transaction receipts into the database.
func WriteTd ¶ added in v1.2.2
WriteTd serializes the total difficulty of a block into the database.
func WriteTestNetGenesisBlock ¶ added in v0.9.39
func WriteTransactions ¶ added in v1.3.2
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 ¶ added in v0.8.4
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 BadHashError ¶ added in v1.2.2
func (BadHashError) Error ¶ added in v1.2.2
func (h BadHashError) Error() string
type BlockChain ¶ added in v1.3.1
type BlockChain struct {
// contains filtered or unexported fields
}
BlockChain represents the canonical chain given a database with a genesis block. The Blockchain manages chain imports, reverts, chain reorganisations.
Importing blocks in to the block chain happens according to the set of rules defined by the two stage Validator. Processing of blocks is done using the Processor which processes the included transaction. The validation of the state is done in the second part of the Validator. Failing results in aborting of the import.
The BlockChain also helps in returning blocks from **any** chain included in the database as well as blocks that represents the canonical chain. It's important to note that GetBlock can return any block and does not need to be included in the canonical one where as GetBlockByNumber always represents the canonical chain.
func NewBlockChain ¶ added in v1.3.1
NewBlockChain returns a fully initialised block chain using information available in the database. It initialiser the default Ethereum Validator and Processor.
func (*BlockChain) AuxValidator ¶ added in v1.3.2
func (self *BlockChain) AuxValidator() pow.PoW
AuxValidator returns the auxiliary validator (Proof of work atm)
func (*BlockChain) CurrentBlock ¶ added in v1.3.1
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 ¶ added in v1.3.1
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 ¶ added in v1.3.1
func (self *BlockChain) CurrentHeader() *types.Header
CurrentHeader retrieves the current head header of the canonical chain. The header is retrieved from the blockchain's internal cache.
func (*BlockChain) Export ¶ added in v1.3.1
func (self *BlockChain) Export(w io.Writer) error
Export writes the active chain to the given writer.
func (*BlockChain) ExportN ¶ added in v1.3.1
ExportN writes a subset of the active chain to the given writer.
func (*BlockChain) FastSyncCommitHead ¶ added in v1.3.1
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 ¶ added in v1.3.1
func (self *BlockChain) GasLimit() *big.Int
GasLimit returns the gas limit of the current HEAD block.
func (*BlockChain) GetBlock ¶ added in v1.3.1
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 ¶ added in v1.3.1
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 ¶ added in v1.3.1
GetBlockHashesFromHash retrieves a number of block hashes starting at a given hash, fetching towards the genesis block.
func (*BlockChain) GetBlocksFromHash ¶ added in v1.3.1
[deprecated by eth/62] GetBlocksFromHash returns the block corresponding to hash and up to n-1 ancestors.
func (*BlockChain) GetBody ¶ added in v1.3.1
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 ¶ added in v1.3.1
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) GetHeader ¶ added in v1.3.1
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 ¶ added in v1.3.1
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 ¶ added in v1.3.1
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 ¶ added in v1.3.1
GetUnclesInChain retrieves all the uncles from a given block backwards until a specific distance is reached.
func (*BlockChain) HasBlock ¶ added in v1.3.1
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 ¶ added in v1.3.3
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 ¶ added in v1.3.1
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 ¶ added in v1.3.1
func (self *BlockChain) InsertChain(chain types.Blocks) (int, error)
InsertChain will attempt to insert the given chain in to the canonical chain or, otherwise, create a fork. It an error is returned it will return the index number of the failing block as well an error describing what went wrong (for possible errors see core/errors.go).
func (*BlockChain) InsertHeaderChain ¶ added in v1.3.1
InsertHeaderChain attempts to insert the given header chain in to the local chain, possibly creating a reorg. If an error is returned, it will return the index number of the failing header as well an error describing what went wrong.
The verify parameter can be used to fine tune whether nonce verification should be done or not. The reason behind the optional check is because some of the header retrieval mechanisms already need to verfy nonces, as well as because nonces can be verified sparsely, not needing to check each.
func (*BlockChain) InsertReceiptChain ¶ added in v1.3.1
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 ¶ added in v1.3.1
func (self *BlockChain) LastBlockHash() common.Hash
LastBlockHash return the hash of the HEAD block.
func (*BlockChain) Processor ¶ added in v1.3.2
func (self *BlockChain) Processor() Processor
Processor returns the current processor.
func (*BlockChain) Reset ¶ added in v1.3.1
func (bc *BlockChain) Reset()
Reset purges the entire blockchain, restoring it to its genesis state.
func (*BlockChain) ResetWithGenesisBlock ¶ added in v1.3.1
func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block)
ResetWithGenesisBlock purges the entire blockchain, restoring it to the specified genesis state.
func (*BlockChain) Rollback ¶ added in v1.3.1
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 ¶ added in v1.3.1
func (bc *BlockChain) SetHead(head uint64)
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 ¶ added in v1.3.1
func (self *BlockChain) SetProcessor(processor Processor)
SetProcessor sets the processor required for making state modifications.
func (*BlockChain) SetValidator ¶ added in v1.3.2
func (self *BlockChain) SetValidator(validator Validator)
SetValidator sets the validator which is used to validate incoming blocks.
func (*BlockChain) State ¶ added in v1.3.1
func (self *BlockChain) State() (*state.StateDB, error)
State returns a new mutable state based on the current HEAD block.
func (*BlockChain) Status ¶ added in v1.3.1
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 ¶ added in v1.3.1
func (bc *BlockChain) Stop()
Stop stops the blockchain service. If any imports are currently in progress it will abort them using the procInterrupt.
func (*BlockChain) Validator ¶ added in v1.3.2
func (self *BlockChain) Validator() Validator
Validator returns the current validator.
func (*BlockChain) WriteBlock ¶ added in v1.3.1
func (self *BlockChain) WriteBlock(block *types.Block) (status writeStatus, err error)
WriteBlock writes the block to the chain.
type BlockGen ¶ added in v0.9.34
type BlockGen struct {
// contains filtered or unexported fields
}
BlockGen creates blocks for testing. See GenerateChain for a detailed explanation.
func (*BlockGen) AddTx ¶ added in v0.9.34
func (b *BlockGen) AddTx(tx *types.Transaction)
AddTx adds a transaction to the generated block. If no coinbase has been set, the block's coinbase is set to the zero address.
AddTx panics if the transaction cannot be executed. In addition to the protocol-imposed limitations (gas limit, etc.), there are some further limitations on the content of transactions that can be added. Notably, contract code relying on the BLOCKHASH instruction will panic during execution.
func (*BlockGen) AddUncheckedReceipt ¶ added in v1.3.1
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 conjuction with raw block insertion.
func (*BlockGen) OffsetTime ¶ added in v1.2.2
OffsetTime modifies the time instance of a block, implicitly changing its associated difficulty. It's useful to test scenarios where forking is not tied to chain length directly.
func (*BlockGen) PrevBlock ¶ added in v0.9.34
PrevBlock returns a previously generated block by number. It panics if num is greater or equal to the number of the block being generated. For index -1, PrevBlock returns the parent block given to GenerateChain.
func (*BlockGen) SetCoinbase ¶ added in v0.9.34
SetCoinbase sets the coinbase of the generated block. It can be called at most once.
type BlockNonceErr ¶ added in v0.9.34
BlockNonceErr indicates that a block's nonce is invalid.
func (*BlockNonceErr) Error ¶ added in v0.9.34
func (err *BlockNonceErr) Error() string
type BlockValidator ¶ added in v1.3.2
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 ¶ added in v1.3.2
func NewBlockValidator(blockchain *BlockChain, pow pow.PoW) *BlockValidator
NewBlockValidator returns a new block validator which is safe for re-use
func (*BlockValidator) ValidateBlock ¶ added in v1.3.2
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 seperately so we can process them in paralel.
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 ¶ added in v1.3.2
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 ¶ added in v1.3.2
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 succes otherwise nil and an error is returned.
func (*BlockValidator) VerifyUncles ¶ added in v1.3.2
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 ChainEvent ¶ added in v0.8.4
type ChainHeadEvent ¶ added in v0.9.18
type ChainSideEvent ¶ added in v0.9.18
type ChainSplitEvent ¶ added in v0.8.4
ChainSplit is posted when a new head is detected
type ChainUncleEvent ¶ added in v0.9.18
type FakePow ¶ added in v0.9.18
type FakePow struct{}
FakePow is a non-validating proof of work implementation. It returns true from Verify for any block.
func (FakePow) GetHashrate ¶ added in v0.9.18
type GasLimitErr ¶
func (*GasLimitErr) Error ¶
func (err *GasLimitErr) Error() string
type GasPool ¶ added in v1.0.3
GasPool tracks the amount of gas available during execution of the transactions in a block. The zero value is a pool with zero gas available.
type GasPriceChanged ¶ added in v0.9.20
type GenesisAccount ¶ added in v1.2.2
type InvalidTxErr ¶ added in v0.9.18
type InvalidTxErr struct {
Message string
}
func InvalidTxError ¶ added in v0.9.18
func InvalidTxError(err error) *InvalidTxErr
func (*InvalidTxErr) Error ¶ added in v0.9.18
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) FromFrontier() (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 ¶
NewBlockEvent is posted when a block has been imported.
type NewMinedBlockEvent ¶ added in v0.8.4
NewMinedBlockEvent is posted when a block has been imported.
type NonceErr ¶
func NonceError ¶
type ParentErr ¶
type ParentErr struct {
Message string
}
Parent error. In case a parent is unknown this error will be thrown by the block manager
type PendingBlockEvent ¶ added in v0.8.4
type Processor ¶ added in v1.3.2
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 RemovedTransactionEvent ¶ added in v1.2.2
type RemovedTransactionEvent struct{ Txs types.Transactions }
RemovedTransactionEvent is posted when a reorg happens
type StateProcessor ¶ added in v1.3.2
type StateProcessor struct {
// contains filtered or unexported fields
}
func NewStateProcessor ¶ added in v1.3.2
func NewStateProcessor(bc *BlockChain) *StateProcessor
func (*StateProcessor) Process ¶ added in v1.3.2
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
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 (*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 ¶ added in v0.8.4
func (self *TxPool) AddTransactions(txs []*types.Transaction)
AddTransactions attempts to queue all valid transactions in txs.
func (*TxPool) GetQueuedTransactions ¶ added in v0.9.18
func (self *TxPool) GetQueuedTransactions() types.Transactions
GetQueuedTransactions returns all non-processable transactions.
func (*TxPool) GetTransaction ¶ added in v0.9.18
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 ¶ added in v0.8.4
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 ¶ added in v0.9.18
func (self *TxPool) RemoveTransactions(txs types.Transactions)
RemoveTransactions removes all given transactions from the pool.
func (*TxPool) RemoveTx ¶ added in v1.0.1
RemoveTx removes the transaction with the given hash from the pool.
func (*TxPool) State ¶ added in v0.9.34
func (pool *TxPool) State() *state.ManagedState
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 VMEnv ¶
type VMEnv struct {
// contains filtered or unexported fields
}
func (*VMEnv) AddStructLog ¶ added in v0.9.34
func (*VMEnv) BlockNumber ¶
func (*VMEnv) CanTransfer ¶ added in v1.1.0
func (*VMEnv) DelegateCall ¶ added in v1.3.4
func (*VMEnv) Difficulty ¶
func (*VMEnv) MakeSnapshot ¶ added in v1.3.1
func (*VMEnv) SetSnapshot ¶ added in v1.3.1
func (*VMEnv) StructLogs ¶ added in v0.9.34
type ValidationErr ¶
type ValidationErr struct {
Message string
}
Block validation error. If any validation fails, this error will be thrown
func ValidationError ¶
func ValidationError(format string, v ...interface{}) *ValidationErr
func (*ValidationErr) Error ¶
func (err *ValidationErr) Error() string
type Validator ¶ added in v1.3.2
type Validator interface { ValidateBlock(block *types.Block) error ValidateHeader(header, parent *types.Header, checkPow bool) error ValidateState(block, parent *types.Block, state *state.StateDB, receipts types.Receipts, usedGas *big.Int) 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.
ValidateStack validates the given statedb and optionally the receipts and gas used. The implementor should decide what to do with the given input.
type ValueTransferError ¶ added in v0.9.18
type ValueTransferError struct {
// contains filtered or unexported fields
}
func ValueTransferErr ¶ added in v0.9.18
func ValueTransferErr(str string, v ...interface{}) *ValueTransferError
func (*ValueTransferError) Error ¶ added in v0.9.18
func (self *ValueTransferError) Error() string
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
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. |
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. |