Documentation ¶
Overview ¶
Package core implements the Ethereum consensus protocol.
Index ¶
- Constants
- Variables
- func AccumulateRewards(statedb *state.StateDB, header *types.Header, uncles []*types.Header)
- func ApplyDAOHardFork(statedb *state.StateDB)
- func ApplyMessage(env vm.Environment, msg Message, gp *GasPool) ([]byte, *big.Int, error)
- func ApplyTransaction(config *ChainConfig, bc *BlockChain, gp *GasPool, ...) (*types.Receipt, vm.Logs, *big.Int, error)
- func CalcDifficulty(config *ChainConfig, time, parentTime uint64, ...) *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 Create(env vm.Environment, caller vm.ContractRef, code []byte, ...) (ret []byte, address common.Address, err error)
- func DefaultGenesisBlock() string
- 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, number uint64)
- func DeleteBlockReceipts(db ethdb.Database, hash common.Hash, number uint64)
- func DeleteBody(db ethdb.Database, hash common.Hash, number uint64)
- func DeleteCanonicalHash(db ethdb.Database, number uint64)
- func DeleteHeader(db ethdb.Database, hash common.Hash, number uint64)
- func DeleteReceipt(db ethdb.Database, hash common.Hash)
- func DeleteTd(db ethdb.Database, hash common.Hash, number uint64)
- func DeleteTransaction(db ethdb.Database, hash common.Hash)
- func Disassemble(script []byte) (asm []string)
- func GenerateChain(config *ChainConfig, parent *types.Block, db ethdb.Database, n int, ...) ([]*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, number uint64) *types.Block
- func GetBlockByHashOld(db ethdb.Database, hash common.Hash) *types.Block
- func GetBlockChainVersion(db ethdb.Database) int
- func GetBlockNumber(db ethdb.Database, hash common.Hash) uint64
- func GetBlockReceipts(db ethdb.Database, hash common.Hash, number uint64) types.Receipts
- func GetBody(db ethdb.Database, hash common.Hash, number uint64) *types.Body
- func GetBodyRLP(db ethdb.Database, hash common.Hash, number uint64) rlp.RawValue
- func GetCanonicalHash(db ethdb.Database, number uint64) common.Hash
- func GetHashFn(ref common.Hash, chain *BlockChain) func(n 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, number uint64) *types.Header
- func GetHeaderRLP(db ethdb.Database, hash common.Hash, number uint64) rlp.RawValue
- func GetMipmapBloom(db ethdb.Database, number, level uint64) types.Bloom
- func GetPrivateStateRoot(db ethdb.Database, blockRoot common.Hash) common.Hash
- func GetReceipt(db ethdb.Database, txHash common.Hash) *types.Receipt
- func GetTd(db ethdb.Database, hash common.Hash, number uint64) *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 MakeCallHelper() *callHelper
- func MessageCreatesContract(msg Message) bool
- func OlympicGenesisBlock() string
- func ParentError(hash common.Hash) error
- func TestNetGenesisBlock() string
- func Transfer(from, to vm.Account, amount *big.Int)
- func UncleError(format string, v ...interface{}) error
- func ValidateDAOHeaderExtraData(config *ChainConfig, header *types.Header) error
- func ValidateExtraData(chaindb ethdb.Database, bc *BlockChain, config *ChainConfig, ...) error
- func ValidateHeader(chaindb ethdb.Database, bc *BlockChain, config *ChainConfig, ...) error
- func WriteBlock(db ethdb.Database, block *types.Block) error
- func WriteBlockChainVersion(db ethdb.Database, vsn int)
- func WriteBlockReceipts(db ethdb.Database, hash common.Hash, number uint64, receipts types.Receipts) error
- func WriteBody(db ethdb.Database, hash common.Hash, number uint64, body *types.Body) error
- func WriteCanonicalHash(db ethdb.Database, hash common.Hash, number uint64) error
- func WriteChainConfig(db ethdb.Database, hash common.Hash, cfg *ChainConfig) error
- func WriteDefaultGenesisBlock(chainDb ethdb.Database) (*types.Block, 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(db ethdb.Database) (*types.Block, error)
- func WritePrivateStateRoot(db ethdb.Database, blockRoot, root common.Hash) error
- func WriteReceipts(db ethdb.Database, receipts types.Receipts) error
- func WriteTd(db ethdb.Database, hash common.Hash, number uint64, td *big.Int) error
- func WriteTestNetGenesisBlock(chainDb ethdb.Database) (*types.Block, error)
- func WriteTransactions(db ethdb.Database, block *types.Block) error
- type Backend
- type BadHashError
- type BlockChain
- func (self *BlockChain) Config() *ChainConfig
- 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, number uint64) *types.Block
- func (self *BlockChain) GetBlockByHash(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, number uint64) *types.Header
- func (self *BlockChain) GetHeaderByHash(hash common.Hash) *types.Header
- func (self *BlockChain) GetHeaderByNumber(number uint64) *types.Header
- func (self *BlockChain) GetTd(hash common.Hash, number uint64) *big.Int
- func (self *BlockChain) GetTdByHash(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, *state.StateDB, error)
- func (self *BlockChain) StateAt(root common.Hash) (*state.StateDB, *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) Number() *big.Int
- func (b *BlockGen) OffsetTime(seconds int64)
- func (b *BlockGen) PrevBlock(index int) *types.Block
- func (b *BlockGen) SetCoinbase(addr common.Address)
- func (b *BlockGen) 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(chaindb ethdb.Database, header, parent *types.Header) 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 ChainConfig
- type ChainEvent
- type ChainHeadEvent
- type ChainSideEvent
- type ChainSplitEvent
- type ChainUncleEvent
- type DeleteCallback
- type DualStateEnv
- type FakePow
- type Finiliser
- type GasLimitErr
- type GasPool
- type GasPriceChanged
- type GenesisAccount
- type HeaderChain
- func (hc *HeaderChain) CurrentHeader() *types.Header
- func (hc *HeaderChain) GetBlockHashesFromHash(hash common.Hash, max uint64) []common.Hash
- func (hc *HeaderChain) GetBlockNumber(hash common.Hash) uint64
- func (hc *HeaderChain) GetHeader(hash common.Hash, number uint64) *types.Header
- func (hc *HeaderChain) GetHeaderByHash(hash common.Hash) *types.Header
- func (hc *HeaderChain) GetHeaderByNumber(number uint64) *types.Header
- func (hc *HeaderChain) GetTd(hash common.Hash, number uint64) *big.Int
- func (hc *HeaderChain) GetTdByHash(hash common.Hash) *big.Int
- func (hc *HeaderChain) HasHeader(hash common.Hash) bool
- func (hc *HeaderChain) InsertHeaderChain(chain []*types.Header, checkFreq int, writeHeader WhCallback) (int, error)
- func (hc *HeaderChain) SetCurrentHeader(head *types.Header)
- func (hc *HeaderChain) SetGenesis(head *types.Header)
- func (hc *HeaderChain) SetHead(head uint64, delFn DeleteCallback)
- func (hc *HeaderChain) WriteHeader(header *types.Header) (status WriteStatus, err error)
- func (hc *HeaderChain) WriteTd(hash common.Hash, number uint64, td *big.Int) error
- type HeaderValidator
- type InvalidTxErr
- type KnownBlockError
- type Message
- type NewBlockEvent
- type NewMinedBlockEvent
- type NonceErr
- type ParentErr
- type PendingBlockEvent
- type PendingLogsEvent
- type PendingStateEvent
- type PrivateMessage
- type Processor
- type RemovedLogsEvent
- type RemovedTransactionEvent
- type StartMining
- type StateProcessor
- type StateTransition
- type TDError
- type TopMining
- type TxPool
- func (pool *TxPool) Add(tx *types.Transaction) error
- func (pool *TxPool) AddBatch(txs []*types.Transaction)
- func (pool *TxPool) Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
- func (pool *TxPool) Get(hash common.Hash) *types.Transaction
- func (pool *TxPool) Nonce(addr common.Address) uint64
- func (pool *TxPool) Pending() map[common.Address]types.Transactions
- func (pool *TxPool) Remove(hash common.Hash)
- func (pool *TxPool) RemoveBatch(txs types.Transactions)
- func (pool *TxPool) SetLocal(tx *types.Transaction)
- 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) 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) Origin() common.Address
- func (env *VMEnv) Pop()
- func (env *VMEnv) PrivateState() *state.StateDB
- func (env *VMEnv) PublicState() *state.StateDB
- func (env *VMEnv) Push(state *state.StateDB)
- func (env *VMEnv) ReadOnly() bool
- func (self *VMEnv) RevertToSnapshot(snapshot int)
- func (self *VMEnv) RuleSet() vm.RuleSet
- func (self *VMEnv) SetDepth(i int)
- func (self *VMEnv) SnapshotDatabase() int
- 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) Vm() vm.Vm
- type ValidationErr
- type Validator
- type ValueTransferError
- type WhCallback
- type WriteStatus
Examples ¶
Constants ¶
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") ErrInvalidGasPrice = errors.New("Gas price not 0") 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") ErrNonExistentAccount = errors.New("Account doesn't exist") )
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 ChainConfigNotFoundErr = errors.New("ChainConfig not found") // general config not found error
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 ¶
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 ApplyDAOHardFork ¶
ApplyDAOHardFork modifies the state database according to the DAO hard-fork rules, transferring all balances of a set of DAO accounts to a single refund contract.
func ApplyMessage ¶
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 ApplyTransaction ¶
func ApplyTransaction(config *ChainConfig, bc *BlockChain, gp *GasPool, publicState, privateState *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *big.Int, cfg vm.Config) (*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 ¶
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 DefaultGenesisBlock ¶
func DefaultGenesisBlock() string
DefaultGenesisBlock assembles a JSON string representing the default Ethereum genesis block.
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 ¶
DeleteBlock removes all block data associated with a hash.
func DeleteBlockReceipts ¶
DeleteBlockReceipts removes all receipt data associated with a block hash.
func DeleteBody ¶
DeleteBody removes all block body data associated with a hash.
func DeleteCanonicalHash ¶
DeleteCanonicalHash removes the number to hash canonical mapping.
func DeleteHeader ¶
DeleteHeader removes all block header data associated with a hash.
func DeleteReceipt ¶
DeleteReceipt removes all receipt data associated with a transaction hash.
func DeleteTransaction ¶
DeleteTransaction removes all transaction data associated with a hash.
func Disassemble ¶
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 ¶
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(nil, 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, MakeChainConfig(), FakePow{}, evmux, false) 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 GenesisBlockForTesting ¶
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 ¶
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 ¶
[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 ¶
GetBlockChainVersion reads the version number from db.
func GetBlockNumber ¶
GetBlockNumber returns the block number assigned to a block hash if the corresponding header is present in the database
func GetBlockReceipts ¶
GetBlockReceipts retrieves the receipts generated by the transactions included in a block given by its hash.
func GetBody ¶
GetBody retrieves the block body (transactons, uncles) corresponding to the hash, nil if none found.
func GetBodyRLP ¶
GetBodyRLP retrieves the block body (transactions and uncles) in RLP encoding.
func GetCanonicalHash ¶
GetCanonicalHash retrieves a hash assigned to a canonical block number.
func GetHashFn ¶
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 ¶
GetHeadBlockHash retrieves the hash of the current canonical head block.
func GetHeadFastBlockHash ¶
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 ¶
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 GetHeaderRLP ¶
GetHeaderRLP retrieves a block header in its raw RLP database encoding, or nil if the header's not found.
func GetMipmapBloom ¶
GetMipmapBloom returns a bloom filter using the number and level as input parameters. For available levels see MIPMapLevels.
func GetPrivateStateRoot ¶
func GetReceipt ¶
GetReceipt returns a receipt by hash
func GetTd ¶
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 ¶
IntrinsicGas computes the 'intrinsic gas' for a message with the given data.
func IsBadHashError ¶
func IsBlockNonceErr ¶
IsBlockNonceErr returns true for invalid block nonce errors.
func IsGasLimitErr ¶
func IsInvalidTxErr ¶
func IsKnownBlockErr ¶
func IsNonceErr ¶
func IsParentErr ¶
func IsUncleErr ¶
func IsValidationErr ¶
func IsValueTransferErr ¶
func MakeCallHelper ¶
func MakeCallHelper() *callHelper
MakeCallHelper returns a new callHelper
Example ¶
var ( // setup new pair of keys for the calls key, _ = crypto.GenerateKey() // create a new helper helper = MakeCallHelper() ) // Private contract address prvContractAddr := common.Address{1} // Initialise custom code for private contract helper.PrivateState.SetCode(prvContractAddr, common.Hex2Bytes("600a60005500")) // Public contract address pubContractAddr := common.Address{2} // Initialise custom code for public contract helper.PublicState.SetCode(pubContractAddr, common.Hex2Bytes("601460005500")) // Make a call to the private contract err := helper.MakeCall(true, key, prvContractAddr, nil) if err != nil { fmt.Println(err) } // Make a call to the public contract err = helper.MakeCall(false, key, pubContractAddr, nil) if err != nil { fmt.Println(err) }
Output: Private: 10 Public: 20
func MessageCreatesContract ¶
func OlympicGenesisBlock ¶
func OlympicGenesisBlock() string
OlympicGenesisBlock assembles a JSON string representing the Olympic genesis block.
func ParentError ¶
func TestNetGenesisBlock ¶
func TestNetGenesisBlock() string
TestNetGenesisBlock assembles a JSON string representing the Morden test net genenis block.
func UncleError ¶
func ValidateDAOHeaderExtraData ¶
func ValidateDAOHeaderExtraData(config *ChainConfig, header *types.Header) error
ValidateDAOHeaderExtraData validates the extra-data field of a block header to ensure it conforms to DAO hard-fork rules.
DAO hard-fork extension to the header validity:
a) if the node is no-fork, do not accept blocks in the [fork, fork+10) range with the fork specific extra-data set b) if the node is pro-fork, require blocks in the specific range to have the unique extra-data set.
func ValidateExtraData ¶
func ValidateExtraData(chaindb ethdb.Database, bc *BlockChain, config *ChainConfig, parent, header *types.Header) error
ValidateExtraData verifies the signature in the extra data field and ensures the signer is allowed to create blocks.
In Quorum blocks the Extra data field contains a signature created by the block creator. This signature is used to verify that the block is created by a party that is allowed to create blocks.
func ValidateHeader ¶
func ValidateHeader(chaindb ethdb.Database, bc *BlockChain, config *ChainConfig, header *types.Header, parent *types.Header, uncle, validateSignature bool) error
Validates a header. Returns an error if the header is invalid and verify if the block signature is from an allowed block creator.
See YP section 4.3.4. "Block Header Validity"
func WriteBlock ¶
WriteBlock serializes a block into the database, header and body separately.
func WriteBlockChainVersion ¶
WriteBlockChainVersion writes vsn as the version number to db.
func WriteBlockReceipts ¶
func WriteBlockReceipts(db ethdb.Database, hash common.Hash, number uint64, 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 WriteCanonicalHash ¶
WriteCanonicalHash stores the canonical hash for the given block number.
func WriteChainConfig ¶
WriteChainConfig writes the chain config settings to the database.
func WriteDefaultGenesisBlock ¶
WriteDefaultGenesisBlock assembles the official Ethereum genesis block and writes it - along with all associated state - into a chain database.
func WriteGenesisBlock ¶
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 ¶
WriteHeadBlockHash stores the head block's hash.
func WriteHeadFastBlockHash ¶
WriteHeadFastBlockHash stores the fast head block's hash.
func WriteHeadHeaderHash ¶
WriteHeadHeaderHash stores the head header's hash.
func WriteHeader ¶
WriteHeader serializes a block header into the database.
func WriteMipmapBloom ¶
WriteMapmapBloom writes each address included in the receipts' logs to the MIP bloom bin.
func WriteOlympicGenesisBlock ¶
WriteOlympicGenesisBlock assembles the Olympic genesis block and writes it along with all associated state into a chain database.
func WritePrivateStateRoot ¶
func WriteReceipts ¶
WriteReceipts stores a batch of transaction receipts into the database.
func WriteTestNetGenesisBlock ¶
WriteTestNetGenesisBlock assembles the Morden test network genesis block and writes it - along with all associated state - into a chain database.
func WriteTransactions ¶
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 BadHashError ¶
func (BadHashError) Error ¶
func (h BadHashError) Error() string
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, enableQuorumChecks bool) (*BlockChain, error)
NewBlockChain returns a fully initialised block chain using information available in the database. It initialiser the default Ethereum Validator and Processor.
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) 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) GetBlock ¶
GetBlock retrieves a block from the database by hash and number, caching it if found.
func (*BlockChain) GetBlockByHash ¶
func (self *BlockChain) GetBlockByHash(hash common.Hash) *types.Block
GetBlockByHash 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 ¶
GetBlockHashesFromHash retrieves a number of block hashes starting at a given hash, fetching towards the genesis block.
func (*BlockChain) GetBlocksFromHash ¶
[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) GetHeader ¶
GetHeader retrieves a block header from the database by hash and number, caching it if found.
func (*BlockChain) GetHeaderByHash ¶
func (self *BlockChain) GetHeaderByHash(hash common.Hash) *types.Header
GetHeaderByHash retrieves a block header from the database by hash, caching it if found.
func (*BlockChain) GetHeaderByNumber ¶
func (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 ¶
GetTd retrieves a block's total difficulty in the canonical chain from the database by hash and number, caching it if found.
func (*BlockChain) GetTdByHash ¶
func (self *BlockChain) GetTdByHash(hash common.Hash) *big.Int
GetTdByHash retrieves a block's total difficulty in the canonical chain from the database by hash, caching it if found.
func (*BlockChain) GetUnclesInChain ¶
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) (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 ¶
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) Processor ¶
func (self *BlockChain) Processor() Processor
Processor returns the current processor.
func (*BlockChain) Reset ¶
func (bc *BlockChain) Reset()
Reset purges the entire blockchain, restoring it to its genesis state.
func (*BlockChain) ResetWithGenesisBlock ¶
func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block)
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)
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) StateAt ¶
StateAt returns a new mutable state based on a particular point in time.
func (*BlockChain) Status ¶
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 ¶
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) OffsetTime ¶
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 ¶
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 ¶
SetCoinbase sets the coinbase of the generated block. It can be called at most once.
type BlockNonceErr ¶
BlockNonceErr indicates that a block's nonce is invalid.
func (*BlockNonceErr) Error ¶
func (err *BlockNonceErr) Error() string
type BlockValidator ¶
type BlockValidator struct {
// contains filtered or unexported fields
}
BlockValidator is responsible for validating block headers, uncles and processed state.
BlockValidator implements Validator.
func NewBlockValidator ¶
func NewBlockValidator(chaindb ethdb.Database, config *ChainConfig, blockchain *BlockChain, enableQuorumChecks bool) *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 finaliser. The finaliser 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 ¶
ValidateHeader validates the given header and, depending on the finaliser 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. For quorum it also verifies if the canonical hash in the blocks state points to a valid parent hash.
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 { HomesteadBlock *big.Int `json:"homesteadBlock"` // Homestead switch block (nil = no fork, 0 = already homestead) DAOForkBlock *big.Int `json:"daoForkBlock"` // TheDAO hard-fork switch block (nil = no fork) DAOForkSupport bool `json:"daoForkSupport"` // Whether the nodes supports or opposes the DAO hard-fork HomesteadGasRepriceBlock *big.Int `json:"homesteadGasRepriceBlock"` // Homestead gas reprice switch block (nil = no fork) HomesteadGasRepriceHash common.Hash `json:"homesteadGasRepriceHash"` // Homestead gas reprice switch block hash (fast sync aid) VmConfig vm.Config `json:"-"` }
ChainConfig is the core config which determines the blockchain settings.
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 GetChainConfig ¶
GetChainConfig will fetch the network settings based on the given hash.
func MakeChainConfig ¶
func MakeChainConfig() *ChainConfig
MakeChainConfig returns a new ChainConfig with the ethereum default chain settings.
func (*ChainConfig) GasTable ¶
func (c *ChainConfig) GasTable(num *big.Int) params.GasTable
GasTable returns the gas table corresponding to the current phase (homestead or homestead reprice).
The returned GasTable's fields shouldn't, under any circumstances, be changed.
func (*ChainConfig) IsHomestead ¶
func (c *ChainConfig) IsHomestead(num *big.Int) bool
IsHomestead returns whether num is either equal to the homestead block or greater.
type ChainHeadEvent ¶
type ChainSplitEvent ¶
ChainSplit is posted when a new head is detected
type ChainUncleEvent ¶
type DeleteCallback ¶
DeleteCallback is a callback function that is called by SetHead before each header is deleted.
type DualStateEnv ¶
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 ¶
type Finiliser ¶
Finiliser is an interface which finilises blocks.
Finilise attempts to finilise a block by checking its external state.
type GasLimitErr ¶
func (*GasLimitErr) Error ¶
func (err *GasLimitErr) Error() string
type GasPool ¶
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 ¶
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, 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 ¶
GetBlockHashesFromHash retrieves a number of block hashes starting at a given hash, fetching towards the genesis block.
func (*HeaderChain) GetBlockNumber ¶
func (hc *HeaderChain) GetBlockNumber(hash common.Hash) uint64
GetBlockNumber retrieves the block number belonging to the given hash from the cache or database
func (*HeaderChain) GetHeader ¶
GetHeader retrieves a block header from the database by hash and number, caching it if found.
func (*HeaderChain) GetHeaderByHash ¶
func (hc *HeaderChain) GetHeaderByHash(hash common.Hash) *types.Header
GetHeaderByHash retrieves a block header from the database by hash, caching it if found.
func (*HeaderChain) GetHeaderByNumber ¶
func (hc *HeaderChain) GetHeaderByNumber(number uint64) *types.Header
GetHeaderByNumber retrieves a block header from the database by number, caching it (associated with its hash) if found.
func (*HeaderChain) GetTd ¶
GetTd retrieves a block's total difficulty in the canonical chain from the database by hash and number, caching it if found.
func (*HeaderChain) GetTdByHash ¶
func (hc *HeaderChain) GetTdByHash(hash common.Hash) *big.Int
GetTdByHash retrieves a block's total difficulty in the canonical chain from the database by hash, caching it if found.
func (*HeaderChain) HasHeader ¶
func (hc *HeaderChain) HasHeader(hash common.Hash) 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 verify nonces, as well as because nonces can be verified sparsely, not needing to check each.
func (*HeaderChain) SetCurrentHeader ¶
func (hc *HeaderChain) SetCurrentHeader(head *types.Header)
SetCurrentHeader sets the current head header of the canonical chain.
func (*HeaderChain) SetGenesis ¶
func (hc *HeaderChain) SetGenesis(head *types.Header)
SetGenesis sets a new genesis block header for the chain
func (*HeaderChain) SetHead ¶
func (hc *HeaderChain) SetHead(head uint64, 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).
type HeaderValidator ¶
type HeaderValidator interface {
ValidateHeader(chaindb ethdb.Database, header, parent *types.Header) 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) FromFrontier() (common.Address, error) To() *common.Address GasPrice() *big.Int Gas() *big.Int Value() *big.Int Nonce() uint64 CheckNonce() bool Data() []byte }
Message represents a message sent to a contract.
type NewBlockEvent ¶
NewBlockEvent is posted when a block has been imported.
type NewMinedBlockEvent ¶
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 PendingLogsEvent ¶
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 PrivateMessage ¶
PrivateMessage implements a private message
type Processor ¶
type Processor interface {
Process(block *types.Block, publicState, privateState *state.StateDB, cfg vm.Config) (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 ¶
RemovedLogEvent is posted when a reorg happens
type RemovedTransactionEvent ¶
type RemovedTransactionEvent struct{ Txs types.Transactions }
RemovedTransactionEvent is posted when a reorg happens
type StateProcessor ¶
type StateProcessor struct {
// contains filtered or unexported fields
}
StateProcessor is a basic Processor, which takes care of transitioning state from one point to another.
StateProcessor implements Processor.
func NewStateProcessor ¶
func NewStateProcessor(config *ChainConfig, bc *BlockChain) *StateProcessor
NewStateProcessor initialises a new StateProcessor.
func (*StateProcessor) Process ¶
func (p *StateProcessor) Process(block *types.Block, publicState, privateState *state.StateDB, cfg vm.Config) (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 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 (pool *TxPool) Add(tx *types.Transaction) error
Add queues a single transaction in the pool if it is valid.
func (*TxPool) AddBatch ¶
func (pool *TxPool) AddBatch(txs []*types.Transaction)
AddBatch attempts to queue a batch of transactions.
func (*TxPool) Content ¶
func (pool *TxPool) Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
Content retrieves the data content of the transaction pool, returning all the pending as well as queued transactions, grouped by account and sorted by nonce.
func (*TxPool) Get ¶
func (pool *TxPool) Get(hash common.Hash) *types.Transaction
Get returns a transaction if it is contained in the pool and nil otherwise.
func (*TxPool) Nonce ¶
Nonce returns the nonce for the given addr from the pending state. Can only be used for local transactions.
func (*TxPool) Pending ¶
func (pool *TxPool) Pending() map[common.Address]types.Transactions
Pending retrieves all currently processable transactions, groupped by origin account and sorted by nonce. The returned transaction set is a copy and can be freely modified by calling code.
func (*TxPool) RemoveBatch ¶
func (pool *TxPool) RemoveBatch(txs types.Transactions)
RemoveBatch removes all given transactions from the pool.
func (*TxPool) SetLocal ¶
func (pool *TxPool) SetLocal(tx *types.Transaction)
SetLocal marks a transaction as local.
func (*TxPool) State ¶
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 NewEnv ¶
func NewEnv(publicState, privateState *state.StateDB, chainConfig *ChainConfig, chain *BlockChain, msg Message, header *types.Header, cfg vm.Config) *VMEnv
NewEnv creates a new environment for executing a transaction. In case the transaction is public its the responsibility from the caller to supply publicState for the privateState argument.
func (*VMEnv) BlockNumber ¶
func (*VMEnv) CanTransfer ¶
func (*VMEnv) DelegateCall ¶
func (*VMEnv) Difficulty ¶
func (*VMEnv) PrivateState ¶
func (*VMEnv) PublicState ¶
func (*VMEnv) RevertToSnapshot ¶
We only need to revert the current state because when we call from private public state it's read only, there wouldn't be anything to reset. (A)->(B)->C->(B): A failure in (B) wouldn't need to reset C, as C was flagged read only.
func (*VMEnv) SnapshotDatabase ¶
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 ¶
type Validator interface { HeaderValidator ValidateBlock(block *types.Block) 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.
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 ¶
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 SplitStatTy SideStatTy )
Source Files ¶
- asm.go
- block_validator.go
- blockchain.go
- blocks.go
- call_helper.go
- chain_makers.go
- chain_pow.go
- config.go
- dao.go
- database_util.go
- default_genesis.go
- error.go
- events.go
- execution.go
- fees.go
- gaspool.go
- genesis.go
- headerchain.go
- state_processor.go
- state_transition.go
- tx_list.go
- tx_pool.go
- types.go
- vm_env.go
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. |