Documentation ¶
Overview ¶
Package core implements the Ethereum consensus protocol.
Index ¶
- Constants
- Variables
- func ApplyMessage(evm *vm.EVM, msg Message, gp *GasPool) ([]byte, *big.Int, bool, error)
- func ApplyTransaction(config *params.ChainConfig, bc *BlockChain, author *common.Address, ...) (*types.Receipt, *big.Int, error)
- func CalcGasLimit(parent *types.Block) *big.Int
- func CanTransfer(db vm.StateDB, addr common.Address, amount *big.Int) bool
- func DeleteBlock(db DatabaseDeleter, hash common.Hash, number uint64)
- func DeleteBlockReceipts(db DatabaseDeleter, hash common.Hash, number uint64)
- func DeleteBody(db DatabaseDeleter, hash common.Hash, number uint64)
- func DeleteCanonicalHash(db DatabaseDeleter, number uint64)
- func DeleteHeader(db DatabaseDeleter, hash common.Hash, number uint64)
- func DeleteTd(db DatabaseDeleter, hash common.Hash, number uint64)
- func DeleteTxLookupEntry(db DatabaseDeleter, hash common.Hash)
- func FindCommonAncestor(db DatabaseReader, a, b *types.Header) *types.Header
- func GenerateChain(config *params.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 DatabaseReader, hash common.Hash, number uint64) *types.Block
- func GetBlockChainVersion(db DatabaseReader) int
- func GetBlockNumber(db DatabaseReader, hash common.Hash) uint64
- func GetBlockReceipts(db DatabaseReader, hash common.Hash, number uint64) types.Receipts
- func GetBloomBits(db DatabaseReader, bit uint, section uint64, head common.Hash) []byte
- func GetBody(db DatabaseReader, hash common.Hash, number uint64) *types.Body
- func GetBodyRLP(db DatabaseReader, hash common.Hash, number uint64) rlp.RawValue
- func GetCanonicalHash(db DatabaseReader, number uint64) common.Hash
- func GetChainConfig(db DatabaseReader, hash common.Hash) (*params.ChainConfig, error)
- func GetHashFn(ref *types.Header, chain ChainContext) func(n uint64) common.Hash
- func GetHeadBlockHash(db DatabaseReader) common.Hash
- func GetHeadFastBlockHash(db DatabaseReader) common.Hash
- func GetHeadHeaderHash(db DatabaseReader) common.Hash
- func GetHeader(db DatabaseReader, hash common.Hash, number uint64) *types.Header
- func GetHeaderRLP(db DatabaseReader, hash common.Hash, number uint64) rlp.RawValue
- func GetReceipt(db DatabaseReader, hash common.Hash) (*types.Receipt, common.Hash, uint64, uint64)
- func GetTd(db DatabaseReader, hash common.Hash, number uint64) *big.Int
- func GetTransaction(db DatabaseReader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
- func GetTxLookupEntry(db DatabaseReader, hash common.Hash) (common.Hash, uint64, uint64)
- func IntrinsicGas(data []byte, contractCreation, homestead bool) *big.Int
- func NewEVMContext(msg Message, header *types.Header, chain ChainContext, author *common.Address) vm.Context
- func PreimageTable(db ethdb.Database) ethdb.Database
- func SetReceiptsData(config *params.ChainConfig, block *types.Block, receipts types.Receipts)
- func SetupGenesisBlock(db ethdb.Database, genesis *Genesis) (*params.ChainConfig, common.Hash, error)
- func Transfer(db vm.StateDB, sender, recipient common.Address, amount *big.Int)
- func WriteBlock(db ethdb.Putter, block *types.Block) error
- func WriteBlockChainVersion(db ethdb.Putter, vsn int)
- func WriteBlockReceipts(db ethdb.Putter, hash common.Hash, number uint64, receipts types.Receipts) error
- func WriteBloomBits(db ethdb.Putter, bit uint, section uint64, head common.Hash, bits []byte)
- func WriteBody(db ethdb.Putter, hash common.Hash, number uint64, body *types.Body) error
- func WriteBodyRLP(db ethdb.Putter, hash common.Hash, number uint64, rlp rlp.RawValue) error
- func WriteCanonicalHash(db ethdb.Putter, hash common.Hash, number uint64) error
- func WriteChainConfig(db ethdb.Putter, hash common.Hash, cfg *params.ChainConfig) error
- func WriteHeadBlockHash(db ethdb.Putter, hash common.Hash) error
- func WriteHeadFastBlockHash(db ethdb.Putter, hash common.Hash) error
- func WriteHeadHeaderHash(db ethdb.Putter, hash common.Hash) error
- func WriteHeader(db ethdb.Putter, header *types.Header) error
- func WritePreimages(db ethdb.Database, number uint64, preimages map[common.Hash][]byte) error
- func WriteTd(db ethdb.Putter, hash common.Hash, number uint64, td *big.Int) error
- func WriteTxLookupEntries(db ethdb.Putter, block *types.Block) error
- type BadBlockArgs
- type BlockChain
- func (bc *BlockChain) BadBlocks() ([]BadBlockArgs, error)
- func (bc *BlockChain) Config() *params.ChainConfig
- func (bc *BlockChain) CurrentBlock() *types.Block
- func (bc *BlockChain) CurrentFastBlock() *types.Block
- func (bc *BlockChain) CurrentHeader() *types.Header
- func (bc *BlockChain) Engine() consensus.Engine
- func (bc *BlockChain) Export(w io.Writer) error
- func (bc *BlockChain) ExportN(w io.Writer, first uint64, last uint64) error
- func (bc *BlockChain) FastSyncCommitHead(hash common.Hash) error
- func (bc *BlockChain) GasLimit() *big.Int
- func (bc *BlockChain) Genesis() *types.Block
- func (bc *BlockChain) GetBlock(hash common.Hash, number uint64) *types.Block
- func (bc *BlockChain) GetBlockByHash(hash common.Hash) *types.Block
- func (bc *BlockChain) GetBlockByNumber(number uint64) *types.Block
- func (bc *BlockChain) GetBlockHashesFromHash(hash common.Hash, max uint64) []common.Hash
- func (bc *BlockChain) GetBlocksFromHash(hash common.Hash, n int) (blocks []*types.Block)
- func (bc *BlockChain) GetBody(hash common.Hash) *types.Body
- func (bc *BlockChain) GetBodyRLP(hash common.Hash) rlp.RawValue
- func (bc *BlockChain) GetHeader(hash common.Hash, number uint64) *types.Header
- func (bc *BlockChain) GetHeaderByHash(hash common.Hash) *types.Header
- func (bc *BlockChain) GetHeaderByNumber(number uint64) *types.Header
- func (bc *BlockChain) GetTd(hash common.Hash, number uint64) *big.Int
- func (bc *BlockChain) GetTdByHash(hash common.Hash) *big.Int
- func (bc *BlockChain) GetUnclesInChain(block *types.Block, length int) []*types.Header
- func (bc *BlockChain) HasBlock(hash common.Hash, number uint64) bool
- func (bc *BlockChain) HasBlockAndState(hash common.Hash) bool
- func (bc *BlockChain) HasHeader(hash common.Hash, number uint64) bool
- func (bc *BlockChain) InsertChain(chain types.Blocks) (int, error)
- func (bc *BlockChain) InsertHeaderChain(chain []*types.Header, checkFreq int) (int, error)
- func (bc *BlockChain) InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts) (int, error)
- func (bc *BlockChain) LastBlockHash() common.Hash
- func (bc *BlockChain) PostChainEvents(events []interface{}, logs []*types.Log)
- func (bc *BlockChain) Processor() Processor
- func (bc *BlockChain) Reset() error
- func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block) error
- func (bc *BlockChain) Rollback(chain []common.Hash)
- func (bc *BlockChain) SetHead(head uint64) error
- func (bc *BlockChain) SetProcessor(processor Processor)
- func (bc *BlockChain) SetValidator(validator Validator)
- func (bc *BlockChain) State() (*state.StateDB, error)
- func (bc *BlockChain) StateAt(root common.Hash) (*state.StateDB, error)
- func (bc *BlockChain) Status() (td *big.Int, currentBlock common.Hash, genesisBlock common.Hash)
- func (bc *BlockChain) Stop()
- func (bc *BlockChain) SubscribeChainEvent(ch chan<- ChainEvent) event.Subscription
- func (bc *BlockChain) SubscribeChainHeadEvent(ch chan<- ChainHeadEvent) event.Subscription
- func (bc *BlockChain) SubscribeChainSideEvent(ch chan<- ChainSideEvent) event.Subscription
- func (bc *BlockChain) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
- func (bc *BlockChain) SubscribeRemovedLogsEvent(ch chan<- RemovedLogsEvent) event.Subscription
- func (bc *BlockChain) Validator() Validator
- func (bc *BlockChain) WriteBlockAndState(block *types.Block, receipts []*types.Receipt, state *state.StateDB) (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 BlockValidator
- type ChainContext
- type ChainEvent
- type ChainHeadEvent
- type ChainIndexer
- type ChainIndexerBackend
- type ChainSideEvent
- type DatabaseDeleter
- type DatabaseReader
- type DeleteCallback
- type GasPool
- type Genesis
- type GenesisAccount
- type GenesisAlloc
- type GenesisMismatchError
- type HeaderChain
- func (hc *HeaderChain) Config() *params.ChainConfig
- func (hc *HeaderChain) CurrentHeader() *types.Header
- func (hc *HeaderChain) Engine() consensus.Engine
- func (hc *HeaderChain) GetBlock(hash common.Hash, number uint64) *types.Block
- 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, number uint64) bool
- func (hc *HeaderChain) InsertHeaderChain(chain []*types.Header, writeHeader WhCallback, start time.Time) (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) ValidateHeaderChain(chain []*types.Header, checkFreq int) (int, error)
- 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 Message
- type NewMinedBlockEvent
- type PendingLogsEvent
- type PendingStateEvent
- type Processor
- type RemovedLogsEvent
- type RemovedTransactionEvent
- type StateProcessor
- type StateTransition
- type TxPool
- func (pool *TxPool) AddLocal(tx *types.Transaction) error
- func (pool *TxPool) AddLocals(txs []*types.Transaction) error
- func (pool *TxPool) AddRemote(tx *types.Transaction) error
- func (pool *TxPool) AddRemotes(txs []*types.Transaction) error
- func (pool *TxPool) Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
- func (pool *TxPool) GasPrice() *big.Int
- func (pool *TxPool) Get(hash common.Hash) *types.Transaction
- func (pool *TxPool) Pending() (map[common.Address]types.Transactions, error)
- func (pool *TxPool) SetGasPrice(price *big.Int)
- func (pool *TxPool) State() *state.ManagedState
- func (pool *TxPool) Stats() (int, int)
- func (pool *TxPool) Stop()
- func (pool *TxPool) SubscribeTxPreEvent(ch chan<- TxPreEvent) event.Subscription
- type TxPoolConfig
- type TxPreEvent
- type Validator
- type WhCallback
- type WriteStatus
Examples ¶
Constants ¶
const (
// BlockChainVersion ensures that an incompatible database forces a resync from scratch.
BlockChainVersion = 3
)
Variables ¶
var ( // Chain index prefixes (use `i` + single byte to avoid mixing data types). BloomBitsIndexPrefix = []byte("iB") // BloomBitsIndexPrefix is the data table of a chain indexer to track its progress ErrChainConfigNotFound = errors.New("ChainConfig not found") // general config not found error )
var ( // ErrKnownBlock is returned when a block to import is already known locally. ErrKnownBlock = errors.New("block already known") // ErrGasLimitReached is returned by the gas pool if the amount of gas required // by a transaction is higher than what's left in the block. ErrGasLimitReached = errors.New("gas limit reached") // ErrBlacklistedHash is returned if a block to import is on the blacklist. ErrBlacklistedHash = errors.New("blacklisted hash") // ErrNonceTooHigh is returned if the nonce of a transaction is higher than the // next one expected based on the local chain. ErrNonceTooHigh = errors.New("nonce too high") )
var ( // ErrInvalidSender is returned if the transaction contains an invalid signature. ErrInvalidSender = errors.New("invalid sender") // ErrNonceTooLow is returned if the nonce of a transaction is lower than the // one present in the local chain. ErrNonceTooLow = errors.New("nonce too low") // ErrUnderpriced is returned if a transaction's gas price is below the minimum // configured for the transaction pool. ErrUnderpriced = errors.New("transaction underpriced") // ErrReplaceUnderpriced is returned if a transaction is attempted to be replaced // with a different one without the required price bump. ErrReplaceUnderpriced = errors.New("replacement transaction underpriced") // ErrInsufficientFunds is returned if the total cost of executing a transaction // is higher than the balance of the user's account. ErrInsufficientFunds = errors.New("insufficient funds for gas * price + value") // ErrIntrinsicGas is returned if the transaction is specified to use less gas // than required to start the invocation. ErrIntrinsicGas = errors.New("intrinsic gas too low") // ErrGasLimit is returned if a transaction's requested gas limit exceeds the // maximum allowance of the current block. ErrGasLimit = errors.New("exceeds block gas limit") // ErrNegativeValue is a sanity error to ensure noone is able to specify a // transaction with a negative value. ErrNegativeValue = errors.New("negative value") // ErrOversizedData is returned if the input data of a transaction is greater // than some meaningful limit a user might use. This is not a consensus error // making the transaction invalid, rather a DOS protection. ErrOversizedData = errors.New("oversized data") )
var BadHashes = map[common.Hash]bool{ common.HexToHash("05bef30ef572270f654746da22639a7a0c97dd97a7050b9e252391996aaeb689"): true, common.HexToHash("7d05d08cbc596a2e5e4f13b80a743e53e09221b5323c3a61946b20873e58583f"): true, }
BadHashes represent a set of manually tracked bad hashes (usually hard forks)
var (
Big0 = big.NewInt(0)
)
var BlockReward = big.NewInt(5e+18)
var DefaultTxPoolConfig = TxPoolConfig{ Journal: "transactions.rlp", Rejournal: time.Hour, PriceLimit: 1, PriceBump: 10, AccountSlots: 16, GlobalSlots: 4096, AccountQueue: 64, GlobalQueue: 1024, Lifetime: 3 * time.Hour, }
DefaultTxPoolConfig contains the default configurations for the transaction pool.
var (
ErrNoGenesis = errors.New("Genesis not found in chain")
)
Functions ¶
func ApplyMessage ¶ added in v0.9.18
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 ¶ added in v1.3.2
func ApplyTransaction(config *params.ChainConfig, bc *BlockChain, author *common.Address, gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *big.Int, cfg vm.Config) (*types.Receipt, *big.Int, error)
ApplyTransaction attempts to apply a transaction to the given state database and uses the input parameters for its environment. It returns the receipt for the transaction, gas used and an error if the transaction failed, indicating the block was invalid.
func CalcGasLimit ¶ 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 CanTransfer ¶ added in v1.5.5
CanTransfer checks wether there are enough funds in the address' account to make a transfer. This does not take the necessary gas in to account to make the transfer valid.
func DeleteBlock ¶ added in v1.2.2
func DeleteBlock(db DatabaseDeleter, hash common.Hash, number uint64)
DeleteBlock removes all block data associated with a hash.
func DeleteBlockReceipts ¶ added in v1.3.2
func DeleteBlockReceipts(db DatabaseDeleter, hash common.Hash, number uint64)
DeleteBlockReceipts removes all receipt data associated with a block hash.
func DeleteBody ¶ added in v1.2.2
func DeleteBody(db DatabaseDeleter, hash common.Hash, number uint64)
DeleteBody removes all block body data associated with a hash.
func DeleteCanonicalHash ¶ added in v1.2.2
func DeleteCanonicalHash(db DatabaseDeleter, number uint64)
DeleteCanonicalHash removes the number to hash canonical mapping.
func DeleteHeader ¶ added in v1.2.2
func DeleteHeader(db DatabaseDeleter, hash common.Hash, number uint64)
DeleteHeader removes all block header data associated with a hash.
func DeleteTd ¶ added in v1.2.2
func DeleteTd(db DatabaseDeleter, hash common.Hash, number uint64)
DeleteTd removes all block total difficulty data associated with a hash.
func DeleteTxLookupEntry ¶ added in v1.7.0
func DeleteTxLookupEntry(db DatabaseDeleter, hash common.Hash)
DeleteTxLookupEntry removes all transaction data associated with a hash.
func FindCommonAncestor ¶ added in v1.5.0
func FindCommonAncestor(db DatabaseReader, a, b *types.Header) *types.Header
FindCommonAncestor returns the last common ancestor of two block headers
func GenerateChain ¶ added in v0.9.34
func GenerateChain(config *params.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 ¶
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. gspec := &Genesis{ Config: ¶ms.ChainConfig{HomesteadBlock: new(big.Int)}, Alloc: GenesisAlloc{addr1: {Balance: big.NewInt(1000000)}}, } genesis := gspec.MustCommit(db) // 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. signer := types.HomesteadSigner{} chain, _ := GenerateChain(gspec.Config, genesis, db, 5, func(i int, gen *BlockGen) { switch i { case 0: // In block 1, addr1 sends addr2 some ether. tx, _ := types.SignTx(types.NewTransaction(gen.TxNonce(addr1), addr2, big.NewInt(10000), bigTxGas, nil, nil), signer, key1) gen.AddTx(tx) case 1: // In block 2, addr1 sends some more ether to addr2. // addr2 passes it on to addr3. tx1, _ := types.SignTx(types.NewTransaction(gen.TxNonce(addr1), addr2, big.NewInt(1000), bigTxGas, nil, nil), signer, key1) tx2, _ := types.SignTx(types.NewTransaction(gen.TxNonce(addr2), addr3, big.NewInt(1000), bigTxGas, nil, nil), signer, 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. blockchain, _ := NewBlockChain(db, gspec.Config, ethash.NewFaker(), vm.Config{}) defer blockchain.Stop() 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 ¶ added in v0.9.34
GenesisBlockForTesting creates and writes a block in which addr has the given wei balance.
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. 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 GetBlockChainVersion ¶ added in v1.4.0
func GetBlockChainVersion(db DatabaseReader) int
GetBlockChainVersion reads the version number from db.
func GetBlockNumber ¶ added in v1.5.0
func GetBlockNumber(db DatabaseReader, hash common.Hash) uint64
GetBlockNumber returns the block number assigned to a block hash if the corresponding header is present in the database
func GetBlockReceipts ¶ added in v0.9.39
GetBlockReceipts retrieves the receipts generated by the transactions included in a block given by its hash.
func GetBloomBits ¶ added in v1.7.0
GetBloomBits retrieves the compressed bloom bit vector belonging to the given section and bit index from the.
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
func GetCanonicalHash(db DatabaseReader, number uint64) common.Hash
GetCanonicalHash retrieves a hash assigned to a canonical block number.
func GetChainConfig ¶ added in v1.4.0
func GetChainConfig(db DatabaseReader, hash common.Hash) (*params.ChainConfig, error)
GetChainConfig will fetch the network settings based on the given hash.
func GetHashFn ¶ added in v1.4.0
GetHashFn returns a GetHashFunc which retrieves header hashes by number
func GetHeadBlockHash ¶ added in v1.2.2
func GetHeadBlockHash(db DatabaseReader) common.Hash
GetHeadBlockHash retrieves the hash of the current canonical head block.
func GetHeadFastBlockHash ¶ added in v1.3.1
func GetHeadFastBlockHash(db DatabaseReader) common.Hash
GetHeadFastBlockHash retrieves the hash of the current canonical head block during fast synchronization. The difference between this and GetHeadBlockHash is that whereas the last block hash is only updated upon a full block import, the last fast hash is updated when importing pre-processed blocks.
func GetHeadHeaderHash ¶ added in v1.2.2
func GetHeadHeaderHash(db DatabaseReader) common.Hash
GetHeadHeaderHash retrieves the hash of the current canonical head block's header. The difference between this and GetHeadBlockHash is that whereas the last block hash is only updated upon a full block import, the last header hash is updated already at header import, allowing head tracking for the light synchronization mechanism.
func GetHeader ¶ 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 GetReceipt ¶ added in v0.9.36
GetReceipt retrieves a specific transaction receipt from the database, along with its added positional metadata.
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 DatabaseReader, hash common.Hash) (*types.Transaction, common.Hash, uint64, uint64)
GetTransaction retrieves a specific transaction from the database, along with its added positional metadata.
func GetTxLookupEntry ¶ added in v1.7.0
GetTxLookupEntry retrieves the positional metadata associated with a transaction hash to allow retrieving the transaction or receipt by hash.
func IntrinsicGas ¶ added in v0.9.18
IntrinsicGas computes the 'intrinsic gas' for a message with the given data.
TODO convert to uint64
func NewEVMContext ¶ added in v1.5.5
func NewEVMContext(msg Message, header *types.Header, chain ChainContext, author *common.Address) vm.Context
NewEVMContext creates a new context for use in the EVM.
func PreimageTable ¶ added in v1.5.8
PreimageTable returns a Database instance with the key prefix for preimage entries.
func SetReceiptsData ¶ added in v1.5.0
SetReceiptsData computes all the non-consensus fields of the receipts
func SetupGenesisBlock ¶ added in v1.6.0
func SetupGenesisBlock(db ethdb.Database, genesis *Genesis) (*params.ChainConfig, common.Hash, error)
SetupGenesisBlock writes or updates the genesis block in db. The block that will be used is:
genesis == nil genesis != nil +------------------------------------------ db has no genesis | main-net default | genesis db has genesis | from DB | genesis (if compatible)
The stored chain configuration will be updated if it is compatible (i.e. does not specify a fork block below the local head block). In case of a conflict, the error is a *params.ConfigCompatError and the new, unwritten config is returned.
The returned chain configuration is never nil.
func Transfer ¶ added in v1.3.1
Transfer subtracts amount from sender and adds amount to recipient using the given Db
func WriteBlock ¶ added in v0.9.39
WriteBlock serializes a block into the database, header and body separately.
func WriteBlockChainVersion ¶ added in v1.4.0
WriteBlockChainVersion writes vsn as the version number to db.
func WriteBlockReceipts ¶ added in v1.3.2
func WriteBlockReceipts(db ethdb.Putter, 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 WriteBloomBits ¶ added in v1.7.0
WriteBloomBits writes the compressed bloom bits vector belonging to the given section and bit index.
func WriteBodyRLP ¶ added in v1.5.0
WriteBodyRLP writes a serialized body of a block into the database.
func WriteCanonicalHash ¶ added in v1.2.2
WriteCanonicalHash stores the canonical hash for the given block number.
func WriteChainConfig ¶ added in v1.4.0
WriteChainConfig writes the chain config settings to the database.
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 WritePreimages ¶ added in v1.5.8
WritePreimages writes the provided set of preimages to the database. `number` is the current block number, and is used for debug messages only.
Types ¶
type BadBlockArgs ¶ added in v1.6.0
BadBlockArgs represents the entries in the list returned when bad blocks are queried.
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
func NewBlockChain(chainDb ethdb.Database, config *params.ChainConfig, engine consensus.Engine, vmConfig vm.Config) (*BlockChain, error)
NewBlockChain returns a fully initialised block chain using information available in the database. It initialises the default Ethereum Validator and Processor.
func (*BlockChain) BadBlocks ¶ added in v1.6.0
func (bc *BlockChain) BadBlocks() ([]BadBlockArgs, error)
BadBlocks returns a list of the last 'bad blocks' that the client has seen on the network
func (*BlockChain) Config ¶ added in v1.4.1
func (bc *BlockChain) Config() *params.ChainConfig
Config retrieves the blockchain's chain configuration.
func (*BlockChain) CurrentBlock ¶ added in v1.3.1
func (bc *BlockChain) CurrentBlock() *types.Block
CurrentBlock retrieves the current head block of the canonical chain. The block is retrieved from the blockchain's internal cache.
func (*BlockChain) CurrentFastBlock ¶ added in v1.3.1
func (bc *BlockChain) CurrentFastBlock() *types.Block
CurrentFastBlock retrieves the current fast-sync head block of the canonical chain. The block is retrieved from the blockchain's internal cache.
func (*BlockChain) CurrentHeader ¶ added in v1.3.1
func (bc *BlockChain) CurrentHeader() *types.Header
CurrentHeader retrieves the current head header of the canonical chain. The header is retrieved from the HeaderChain's internal cache.
func (*BlockChain) Engine ¶ added in v1.6.0
func (bc *BlockChain) Engine() consensus.Engine
Engine retrieves the blockchain's consensus engine.
func (*BlockChain) Export ¶ added in v1.3.1
func (bc *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 (bc *BlockChain) FastSyncCommitHead(hash common.Hash) error
FastSyncCommitHead sets the current head block to the one defined by the hash irrelevant what the chain contents were prior.
func (*BlockChain) GasLimit ¶ added in v1.3.1
func (bc *BlockChain) GasLimit() *big.Int
GasLimit returns the gas limit of the current HEAD block.
func (*BlockChain) Genesis ¶ added in v1.3.1
func (bc *BlockChain) Genesis() *types.Block
Genesis retrieves the chain's genesis block.
func (*BlockChain) GetBlock ¶ added in v1.3.1
GetBlock retrieves a block from the database by hash and number, caching it if found.
func (*BlockChain) GetBlockByHash ¶ added in v1.5.0
func (bc *BlockChain) GetBlockByHash(hash common.Hash) *types.Block
GetBlockByHash retrieves a block from the database by hash, caching it if found.
func (*BlockChain) GetBlockByNumber ¶ added in v1.3.1
func (bc *BlockChain) GetBlockByNumber(number uint64) *types.Block
GetBlockByNumber retrieves a block from the database by number, caching it (associated with its hash) if found.
func (*BlockChain) GetBlockHashesFromHash ¶ 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
GetBlocksFromHash returns the block corresponding to hash and up to n-1 ancestors. [deprecated by eth/62]
func (*BlockChain) GetBody ¶ added in v1.3.1
func (bc *BlockChain) GetBody(hash common.Hash) *types.Body
GetBody retrieves a block body (transactions and uncles) from the database by hash, caching it if found.
func (*BlockChain) GetBodyRLP ¶ added in v1.3.1
func (bc *BlockChain) GetBodyRLP(hash common.Hash) rlp.RawValue
GetBodyRLP retrieves a block body in RLP encoding from the database by hash, caching it if found.
func (*BlockChain) GetHeader ¶ added in v1.3.1
GetHeader retrieves a block header from the database by hash and number, caching it if found.
func (*BlockChain) GetHeaderByHash ¶ added in v1.5.0
func (bc *BlockChain) GetHeaderByHash(hash common.Hash) *types.Header
GetHeaderByHash retrieves a block header from the database by hash, caching it if found.
func (*BlockChain) GetHeaderByNumber ¶ added in v1.3.1
func (bc *BlockChain) GetHeaderByNumber(number uint64) *types.Header
GetHeaderByNumber retrieves a block header from the database by number, caching it (associated with its hash) if found.
func (*BlockChain) GetTd ¶ added in v1.3.1
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 ¶ added in v1.5.0
func (bc *BlockChain) GetTdByHash(hash common.Hash) *big.Int
GetTdByHash retrieves a block's total difficulty in the canonical chain from the database by hash, caching it if found.
func (*BlockChain) GetUnclesInChain ¶ 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, number uint64) bool
HasBlock checks if a block is fully present in the database or not.
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, number uint64) 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 (bc *BlockChain) InsertChain(chain types.Blocks) (int, error)
InsertChain attempts to insert the given batch of blocks in to the canonical chain or, otherwise, create a fork. If an error is returned it will return the index number of the failing block as well an error describing what went wrong.
After insertion is done, all accumulated events will be fired.
func (*BlockChain) InsertHeaderChain ¶ 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 verify nonces, as well as because nonces can be verified sparsely, not needing to check each.
func (*BlockChain) InsertReceiptChain ¶ added in v1.3.1
func (bc *BlockChain) InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts) (int, error)
InsertReceiptChain attempts to complete an already existing header chain with transaction and receipt data.
func (*BlockChain) LastBlockHash ¶ added in v1.3.1
func (bc *BlockChain) LastBlockHash() common.Hash
LastBlockHash return the hash of the HEAD block.
func (*BlockChain) PostChainEvents ¶ added in v1.7.0
func (bc *BlockChain) PostChainEvents(events []interface{}, logs []*types.Log)
PostChainEvents iterates over the events generated by a chain insertion and posts them into the event feed. TODO: Should not expose PostChainEvents. The chain events should be posted in WriteBlock.
func (*BlockChain) Processor ¶ added in v1.3.2
func (bc *BlockChain) Processor() Processor
Processor returns the current processor.
func (*BlockChain) Reset ¶ added in v1.3.1
func (bc *BlockChain) Reset() error
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) error
ResetWithGenesisBlock purges the entire blockchain, restoring it to the specified genesis state.
func (*BlockChain) Rollback ¶ added in v1.3.1
func (bc *BlockChain) Rollback(chain []common.Hash)
Rollback is designed to remove a chain of links from the database that aren't certain enough to be valid.
func (*BlockChain) SetHead ¶ added in v1.3.1
func (bc *BlockChain) SetHead(head uint64) error
SetHead rewinds the local chain to a new head. In the case of headers, everything above the new head will be deleted and the new one set. In the case of blocks though, the head may be further rewound if block bodies are missing (non-archive nodes after a fast sync).
func (*BlockChain) SetProcessor ¶ added in v1.3.1
func (bc *BlockChain) SetProcessor(processor Processor)
SetProcessor sets the processor required for making state modifications.
func (*BlockChain) SetValidator ¶ added in v1.3.2
func (bc *BlockChain) SetValidator(validator Validator)
SetValidator sets the validator which is used to validate incoming blocks.
func (*BlockChain) State ¶ added in v1.3.1
func (bc *BlockChain) State() (*state.StateDB, error)
State returns a new mutable state based on the current HEAD block.
func (*BlockChain) StateAt ¶ added in v1.4.14
StateAt returns a new mutable state based on a particular point in time.
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) SubscribeChainEvent ¶ added in v1.7.0
func (bc *BlockChain) SubscribeChainEvent(ch chan<- ChainEvent) event.Subscription
SubscribeChainEvent registers a subscription of ChainEvent.
func (*BlockChain) SubscribeChainHeadEvent ¶ added in v1.7.0
func (bc *BlockChain) SubscribeChainHeadEvent(ch chan<- ChainHeadEvent) event.Subscription
SubscribeChainHeadEvent registers a subscription of ChainHeadEvent.
func (*BlockChain) SubscribeChainSideEvent ¶ added in v1.7.0
func (bc *BlockChain) SubscribeChainSideEvent(ch chan<- ChainSideEvent) event.Subscription
SubscribeChainSideEvent registers a subscription of ChainSideEvent.
func (*BlockChain) SubscribeLogsEvent ¶ added in v1.7.0
func (bc *BlockChain) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
SubscribeLogsEvent registers a subscription of []*types.Log.
func (*BlockChain) SubscribeRemovedLogsEvent ¶ added in v1.7.0
func (bc *BlockChain) SubscribeRemovedLogsEvent(ch chan<- RemovedLogsEvent) event.Subscription
SubscribeRemovedLogsEvent registers a subscription of RemovedLogsEvent.
func (*BlockChain) Validator ¶ added in v1.3.2
func (bc *BlockChain) Validator() Validator
Validator returns the current validator.
func (*BlockChain) WriteBlockAndState ¶ added in v1.7.0
func (bc *BlockChain) WriteBlockAndState(block *types.Block, receipts []*types.Receipt, state *state.StateDB) (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
AddUncheckedReceipt forcefully adds a receipts to the block without a backing transaction.
AddUncheckedReceipt will cause consensus failures when used during real chain processing. This is best used in conjunction with raw block insertion.
func (*BlockGen) Number ¶ added in v1.4.0
Number returns the block number of the block being generated.
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 BlockValidator ¶ added in v1.3.2
type BlockValidator struct {
// 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(config *params.ChainConfig, blockchain *BlockChain, engine consensus.Engine) *BlockValidator
NewBlockValidator returns a new block validator which is safe for re-use
func (*BlockValidator) ValidateBody ¶ added in v1.6.0
func (v *BlockValidator) ValidateBody(block *types.Block) error
ValidateBody validates the given block's uncles and verifies the the block header's transaction and uncle roots. The headers are assumed to be already validated at this point.
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) error
ValidateState validates the various changes that happen after a state transition, such as amount of used gas, the receipt roots and the state root itself. ValidateState returns a database batch if the validation was a success otherwise nil and an error is returned.
type ChainContext ¶ added in v1.6.0
type ChainContext interface { // Engine retrieves the chain's consensus engine. Engine() consensus.Engine // GetHeader returns the hash corresponding to their hash. GetHeader(common.Hash, uint64) *types.Header }
ChainContext supports retrieving headers and consensus parameters from the current blockchain to be used during transaction processing.
type ChainEvent ¶ added in v0.8.4
type ChainHeadEvent ¶ added in v0.9.18
type ChainIndexer ¶ added in v1.7.0
type ChainIndexer struct {
// contains filtered or unexported fields
}
ChainIndexer does a post-processing job for equally sized sections of the canonical chain (like BlooomBits and CHT structures). A ChainIndexer is connected to the blockchain through the event system by starting a ChainEventLoop in a goroutine.
Further child ChainIndexers can be added which use the output of the parent section indexer. These child indexers receive new head notifications only after an entire section has been finished or in case of rollbacks that might affect already finished sections.
func NewChainIndexer ¶ added in v1.7.0
func NewChainIndexer(chainDb, indexDb ethdb.Database, backend ChainIndexerBackend, section, confirm uint64, throttling time.Duration, kind string) *ChainIndexer
NewChainIndexer creates a new chain indexer to do background processing on chain segments of a given size after certain number of confirmations passed. The throttling parameter might be used to prevent database thrashing.
func (*ChainIndexer) AddChildIndexer ¶ added in v1.7.0
func (c *ChainIndexer) AddChildIndexer(indexer *ChainIndexer)
AddChildIndexer adds a child ChainIndexer that can use the output of this one
func (*ChainIndexer) Close ¶ added in v1.7.0
func (c *ChainIndexer) Close() error
Close tears down all goroutines belonging to the indexer and returns any error that might have occurred internally.
func (*ChainIndexer) Sections ¶ added in v1.7.0
func (c *ChainIndexer) Sections() (uint64, uint64, common.Hash)
Sections returns the number of processed sections maintained by the indexer and also the information about the last header indexed for potential canonical verifications.
func (*ChainIndexer) Start ¶ added in v1.7.0
func (c *ChainIndexer) Start(currentHeader *types.Header, chainEventer func(ch chan<- ChainEvent) event.Subscription)
Start creates a goroutine to feed chain head events into the indexer for cascading background processing. Children do not need to be started, they are notified about new events by their parents.
type ChainIndexerBackend ¶ added in v1.7.0
type ChainIndexerBackend interface { // Reset initiates the processing of a new chain segment, potentially terminating // any partially completed operations (in case of a reorg). Reset(section uint64) // Process crunches through the next header in the chain segment. The caller // will ensure a sequential order of headers. Process(header *types.Header) // Commit finalizes the section metadata and stores it into the database. Commit() error }
ChainIndexerBackend defines the methods needed to process chain segments in the background and write the segment results into the database. These can be used to create filter blooms or CHTs.
type ChainSideEvent ¶ added in v0.9.18
type DatabaseDeleter ¶ added in v1.7.0
DatabaseDeleter wraps the Delete method of a backing data store.
type DatabaseReader ¶ added in v1.7.0
DatabaseReader wraps the Get method of a backing data store.
type DeleteCallback ¶ added in v1.4.0
DeleteCallback is a callback function that is called by SetHead before each header is deleted.
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 Genesis ¶
type Genesis struct { Config *params.ChainConfig `json:"config"` Nonce uint64 `json:"nonce"` Timestamp uint64 `json:"timestamp"` ExtraData []byte `json:"extraData"` GasLimit uint64 `json:"gasLimit" gencodec:"required"` Difficulty *big.Int `json:"difficulty" gencodec:"required"` Mixhash common.Hash `json:"mixHash"` Coinbase common.Address `json:"coinbase"` Alloc GenesisAlloc `json:"alloc" gencodec:"required"` // These fields are used for consensus tests. Please don't use them // in actual genesis blocks. Number uint64 `json:"number"` GasUsed uint64 `json:"gasUsed"` ParentHash common.Hash `json:"parentHash"` }
Genesis specifies the header fields, state of a genesis block. It also defines hard fork switch-over blocks through the chain configuration.
func DefaultGenesisBlock ¶ added in v1.4.0
func DefaultGenesisBlock() *Genesis
DefaultGenesisBlock returns the Ethereum main net genesis block.
func DefaultRinkebyGenesisBlock ¶ added in v1.6.1
func DefaultRinkebyGenesisBlock() *Genesis
DefaultRinkebyGenesisBlock returns the Rinkeby network genesis block.
func DefaultTestnetGenesisBlock ¶ added in v1.5.3
func DefaultTestnetGenesisBlock() *Genesis
DefaultTestnetGenesisBlock returns the Ropsten network genesis block.
func DevGenesisBlock ¶ added in v1.5.7
func DevGenesisBlock() *Genesis
DevGenesisBlock returns the 'geth --dev' genesis block.
func (*Genesis) Commit ¶ added in v1.6.0
Commit writes the block and state of a genesis specification to the database. The block is committed as the canonical head block.
func (Genesis) MarshalJSON ¶ added in v1.6.0
func (*Genesis) MustCommit ¶ added in v1.6.0
MustCommit writes the genesis block and state to db, panicking on error. The block is committed as the canonical head block.
func (*Genesis) ToBlock ¶ added in v1.6.0
ToBlock creates the block and state of a genesis specification.
func (*Genesis) UnmarshalJSON ¶ added in v1.6.0
type GenesisAccount ¶ added in v1.2.2
type GenesisAccount struct { Code []byte `json:"code,omitempty"` Storage map[common.Hash]common.Hash `json:"storage,omitempty"` Balance *big.Int `json:"balance" gencodec:"required"` Nonce uint64 `json:"nonce,omitempty"` PrivateKey []byte `json:"secretKey,omitempty"` // for tests }
GenesisAccount is an account in the state of the genesis block.
func (GenesisAccount) MarshalJSON ¶ added in v1.6.0
func (g GenesisAccount) MarshalJSON() ([]byte, error)
func (*GenesisAccount) UnmarshalJSON ¶ added in v1.6.0
func (g *GenesisAccount) UnmarshalJSON(input []byte) error
type GenesisAlloc ¶ added in v1.6.0
type GenesisAlloc map[common.Address]GenesisAccount
GenesisAlloc specifies the initial state that is part of the genesis block.
func (*GenesisAlloc) UnmarshalJSON ¶ added in v1.6.7
func (ga *GenesisAlloc) UnmarshalJSON(data []byte) error
type GenesisMismatchError ¶ added in v1.6.0
GenesisMismatchError is raised when trying to overwrite an existing genesis block with an incompatible one.
func (*GenesisMismatchError) Error ¶ added in v1.6.0
func (e *GenesisMismatchError) Error() string
type HeaderChain ¶ added in v1.4.0
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 ¶ added in v1.4.0
func NewHeaderChain(chainDb ethdb.Database, config *params.ChainConfig, engine consensus.Engine, procInterrupt func() bool) (*HeaderChain, error)
NewHeaderChain creates a new HeaderChain structure.
getValidator should return the parent's validator procInterrupt points to the parent's interrupt semaphore wg points to the parent's shutdown wait group
func (*HeaderChain) Config ¶ added in v1.6.0
func (hc *HeaderChain) Config() *params.ChainConfig
Config retrieves the header chain's chain configuration.
func (*HeaderChain) CurrentHeader ¶ added in v1.4.0
func (hc *HeaderChain) CurrentHeader() *types.Header
CurrentHeader retrieves the current head header of the canonical chain. The header is retrieved from the HeaderChain's internal cache.
func (*HeaderChain) Engine ¶ added in v1.6.0
func (hc *HeaderChain) Engine() consensus.Engine
Engine retrieves the header chain's consensus engine.
func (*HeaderChain) GetBlock ¶ added in v1.6.0
GetBlock implements consensus.ChainReader, and returns nil for every input as a header chain does not have blocks available for retrieval.
func (*HeaderChain) GetBlockHashesFromHash ¶ added in v1.4.0
GetBlockHashesFromHash retrieves a number of block hashes starting at a given hash, fetching towards the genesis block.
func (*HeaderChain) GetBlockNumber ¶ added in v1.5.0
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 ¶ added in v1.4.0
GetHeader retrieves a block header from the database by hash and number, caching it if found.
func (*HeaderChain) GetHeaderByHash ¶ added in v1.5.0
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 ¶ added in v1.4.0
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 ¶ added in v1.4.0
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 ¶ added in v1.5.0
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 ¶ added in v1.4.0
func (hc *HeaderChain) HasHeader(hash common.Hash, number uint64) bool
HasHeader checks if a block header is present in the database or not.
func (*HeaderChain) InsertHeaderChain ¶ added in v1.4.0
func (hc *HeaderChain) InsertHeaderChain(chain []*types.Header, writeHeader WhCallback, start time.Time) (int, error)
InsertHeaderChain attempts to insert the given header chain in to the local chain, possibly creating a reorg. If an error is returned, it will return the index number of the failing header as well an error describing what went wrong.
The verify parameter can be used to fine tune whether nonce verification should be done or not. The reason behind the optional check is because some of the header retrieval mechanisms already need to verfy nonces, as well as because nonces can be verified sparsely, not needing to check each.
func (*HeaderChain) SetCurrentHeader ¶ added in v1.4.0
func (hc *HeaderChain) SetCurrentHeader(head *types.Header)
SetCurrentHeader sets the current head header of the canonical chain.
func (*HeaderChain) SetGenesis ¶ added in v1.4.0
func (hc *HeaderChain) SetGenesis(head *types.Header)
SetGenesis sets a new genesis block header for the chain
func (*HeaderChain) SetHead ¶ added in v1.4.0
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) ValidateHeaderChain ¶ added in v1.6.0
func (*HeaderChain) WriteHeader ¶ added in v1.4.0
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 Message ¶
type Message interface { From() common.Address //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 NewMinedBlockEvent ¶ added in v0.8.4
NewMinedBlockEvent is posted when a block has been imported.
type PendingLogsEvent ¶ added in v1.4.0
PendingLogsEvent is posted pre mining and notifies of pending logs.
type PendingStateEvent ¶ added in v1.4.0
type PendingStateEvent struct{}
PendingStateEvent is posted pre mining and notifies of pending state changes.
type Processor ¶ added in v1.3.2
type Processor interface {
Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, *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 ¶ added in v1.4.0
RemovedLogsEvent is posted when a reorg happens
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
}
StateProcessor is a basic Processor, which takes care of transitioning state from one point to another.
StateProcessor implements Processor.
func NewStateProcessor ¶ added in v1.3.2
func NewStateProcessor(config *params.ChainConfig, bc *BlockChain, engine consensus.Engine) *StateProcessor
NewStateProcessor initialises a new StateProcessor.
func (*StateProcessor) Process ¶ added in v1.3.2
func (p *StateProcessor) Process(block *types.Block, statedb *state.StateDB, cfg vm.Config) (types.Receipts, []*types.Log, *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(evm *vm.EVM, msg Message, gp *GasPool) *StateTransition
NewStateTransition initialises and returns a new state transition object.
func (*StateTransition) TransitionDb ¶ added in v1.4.0
func (st *StateTransition) TransitionDb() (ret []byte, requiredGas, usedGas *big.Int, failed bool, err error)
TransitionDb will transition the state by applying the current message and returning the result including the required gas for the operation as well as the used gas. It returns an error if it failed. An error indicates a consensus issue.
type TxPool ¶
type TxPool struct {
// contains filtered or unexported fields
}
TxPool contains all currently known transactions. Transactions enter the pool when they are received from the network or submitted locally. They exit the pool when they are included in the blockchain.
The pool separates processable transactions (which can be applied to the current state) and future transactions. Transactions move between those two states over time as they are received and processed.
func NewTxPool ¶
func NewTxPool(config TxPoolConfig, chainconfig *params.ChainConfig, chain blockChain) *TxPool
NewTxPool creates a new transaction pool to gather, sort and filter inbound trnsactions from the network.
func (*TxPool) AddLocal ¶ added in v1.6.7
func (pool *TxPool) AddLocal(tx *types.Transaction) error
AddLocal enqueues a single transaction into the pool if it is valid, marking the sender as a local one in the mean time, ensuring it goes around the local pricing constraints.
func (*TxPool) AddLocals ¶ added in v1.6.7
func (pool *TxPool) AddLocals(txs []*types.Transaction) error
AddLocals enqueues a batch of transactions into the pool if they are valid, marking the senders as a local ones in the mean time, ensuring they go around the local pricing constraints.
func (*TxPool) AddRemote ¶ added in v1.6.7
func (pool *TxPool) AddRemote(tx *types.Transaction) error
AddRemote enqueues a single transaction into the pool if it is valid. If the sender is not among the locally tracked ones, full pricing constraints will apply.
func (*TxPool) AddRemotes ¶ added in v1.6.7
func (pool *TxPool) AddRemotes(txs []*types.Transaction) error
AddRemotes enqueues a batch of transactions into the pool if they are valid. If the senders are not among the locally tracked ones, full pricing constraints will apply.
func (*TxPool) Content ¶ added in v1.4.0
func (pool *TxPool) Content() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
Content retrieves the data content of the transaction pool, returning all the pending as well as queued transactions, grouped by account and sorted by nonce.
func (*TxPool) GasPrice ¶ added in v1.6.2
GasPrice returns the current gas price enforced by the transaction pool.
func (*TxPool) Get ¶ added in v1.4.17
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) Pending ¶ added in v1.4.17
Pending retrieves all currently processable transactions, groupped by origin account and sorted by nonce. The returned transaction set is a copy and can be freely modified by calling code.
func (*TxPool) SetGasPrice ¶ added in v1.6.2
SetGasPrice updates the minimum price required by the transaction pool for a new transaction, and drops all transactions below this threshold.
func (*TxPool) State ¶ added in v0.9.34
func (pool *TxPool) State() *state.ManagedState
State returns the virtual managed state of the transaction pool.
func (*TxPool) Stats ¶ added in v0.9.36
Stats retrieves the current pool stats, namely the number of pending and the number of queued (non-executable) transactions.
func (*TxPool) SubscribeTxPreEvent ¶ added in v1.7.0
func (pool *TxPool) SubscribeTxPreEvent(ch chan<- TxPreEvent) event.Subscription
SubscribeTxPreEvent registers a subscription of TxPreEvent and starts sending event to the given channel.
type TxPoolConfig ¶ added in v1.6.2
type TxPoolConfig struct { NoLocals bool // Whether local transaction handling should be disabled Journal string // Journal of local transactions to survive node restarts Rejournal time.Duration // Time interval to regenerate the local transaction journal PriceLimit uint64 // Minimum gas price to enforce for acceptance into the pool PriceBump uint64 // Minimum price bump percentage to replace an already existing transaction (nonce) AccountSlots uint64 // Minimum number of executable transaction slots guaranteed per account GlobalSlots uint64 // Maximum number of executable transaction slots for all accounts AccountQueue uint64 // Maximum number of non-executable transaction slots permitted per account GlobalQueue uint64 // Maximum number of non-executable transaction slots for all accounts Lifetime time.Duration // Maximum amount of time non-executable transaction are queued }
TxPoolConfig are the configuration parameters of the transaction pool.
type TxPreEvent ¶
type TxPreEvent struct{ Tx *types.Transaction }
TxPreEvent is posted when a transaction enters the transaction pool.
type Validator ¶ added in v1.3.2
type Validator interface { // ValidateBody validates the given block's content. ValidateBody(block *types.Block) error // ValidateState validates the given statedb and optionally the receipts and // gas used. ValidateState(block, parent *types.Block, state *state.StateDB, receipts types.Receipts, usedGas *big.Int) error }
Validator is an interface which defines the standard for block validation. It is only responsible for validating block contents, as the header validation is done by the specific consensus engines.
type WhCallback ¶ added in v1.4.0
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 ¶ added in v1.4.0
type WriteStatus byte
WriteStatus status of write
const ( NonStatTy WriteStatus = iota CanonStatTy SideStatTy )
Source Files ¶
- block_validator.go
- blockchain.go
- blocks.go
- chain_indexer.go
- chain_makers.go
- database_util.go
- error.go
- events.go
- evm.go
- fees.go
- gaspool.go
- gen_genesis.go
- gen_genesis_account.go
- genesis.go
- genesis_alloc.go
- headerchain.go
- state_processor.go
- state_transition.go
- tx_journal.go
- tx_list.go
- tx_pool.go
- types.go
Directories ¶
Path | Synopsis |
---|---|
Provides support for dealing with EVM assembly instructions (e.g., disassembling them).
|
Provides support for dealing with EVM assembly instructions (e.g., disassembling them). |
Package bloombits implements bloom filtering on batches of data.
|
Package bloombits implements bloom filtering on batches of data. |
Package state provides 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. |