core

package
v1.3.1 Latest Latest
Warning

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

 Go to latest Published: Oct 31, 2015 License: GPL-3.0 Imports: 38 Imported by: 12

Documentation

Overview

Package core implements the Ethereum consensus protocol.

Index

Examples

Constants

View Source 
const (
	NonStatTy writeStatus = iota
	CanonStatTy
	SplitStatTy
	SideStatTy
)
View Source 
const (
	// must be bumped when consensus algorithm is changed, this forces the upgradedb
	// command to be run (forces the blocks to be imported again using the new algorithm)
	BlockChainVersion = 3
)

Variables

View Source 
var (
	ExpDiffPeriod = big.NewInt(100000)

	MIPMapLevels = []uint64{1000000, 500000, 100000, 50000, 1000}
)
View Source 
var (
	BlockNumberErr   = errors.New("block number invalid")
	BlockFutureErr   = errors.New("block time is in the future")
	BlockTSTooBigErr = errors.New("block time too big")
	BlockEqualTSErr  = errors.New("block time stamp equal to previous")
)
View Source 
var (
	// Transaction Pool Errors
	ErrInvalidSender      = errors.New("Invalid sender")
	ErrNonce              = errors.New("Nonce too low")
	ErrCheap              = errors.New("Gas price too low for acceptance")
	ErrBalance            = errors.New("Insufficient balance")
	ErrNonExistentAccount = errors.New("Account does not exist or account balance too low")
	ErrInsufficientFunds  = errors.New("Insufficient funds for gas * price + value")
	ErrIntrinsicGas       = errors.New("Intrinsic gas too low")
	ErrGasLimit           = errors.New("Exceeds block gas limit")
	ErrNegativeValue      = errors.New("Negative value")
)
View Source 
var BadHashes = map[common.Hash]bool{
	common.HexToHash("05bef30ef572270f654746da22639a7a0c97dd97a7050b9e252391996aaeb689"): true,
}

Set of manually tracked bad hashes (usually hard forks)

View Source 
var BlockReward *big.Int = big.NewInt(5e+18)
View Source 
var DisableBadBlockReporting = true

DisabledBadBlockReporting can be set to prevent blocks being reported.

View Source 
var (
	ErrNoGenesis = errors.New("Genesis not found in chain")
)

Functions

func AccumulateRewards 

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

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

func ApplyMessage 

func ApplyMessage(env vm.Environment, msg Message, gp *GasPool) ([]byte, *big.Int, error)

func CalcDifficulty 

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

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

func CalcGasLimit 

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

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

func Call added in v1.3.1 

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

Call executes within the given contract

func CallCode added in v1.3.1 

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

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

func Canary 

func Canary(statedb *state.StateDB) bool

Canary will check the 0'd address of the 4 contracts above. If two or more are set to anything other than a 0 the canary dies a horrible death.

func Create added in v1.3.1 

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

Create creates a new contract with the given code

func DeleteBlock added in v1.2.2 

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

DeleteBlock removes all block data associated with a hash.

func DeleteBody added in v1.2.2 

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

DeleteBody removes all block body data associated with a hash.

func DeleteCanonicalHash added in v1.2.2 

func DeleteCanonicalHash(db ethdb.Database, number uint64)

DeleteCanonicalHash removes the number to hash canonical mapping.

func DeleteHeader added in v1.2.2 

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

DeleteHeader removes all block header data associated with a hash.

func DeleteReceipt added in v1.2.2 

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

Delete a receipts from the database

func DeleteTd added in v1.2.2 

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

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

func DeleteTransaction added in v1.2.2 

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

func Disassemble 

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

func GenerateChain 

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

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

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

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

Example 
params.MinGasLimit = big.NewInt(125000)      // Minimum the gas limit may ever be.
params.GenesisGasLimit = big.NewInt(3141592) // Gas limit of the Genesis block.

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

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

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

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

state, _ := chainman.State()
fmt.Printf("last block: #%d\n", chainman.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 

func GenesisBlockForTesting(db ethdb.Database, addr common.Address, balance *big.Int) *types.Block

GenesisBlockForTesting creates a block in which addr has the given wei balance. The state trie of the block is written to db. the passed db needs to contain a state root

func GetBlock added in v1.2.2 

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

GetBlock retrieves an entire block corresponding to the hash, assembling it back from the stored header and body.

func GetBlockByHashOld added in v1.2.2 

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

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

func GetBlockReceipts added in v0.9.39 

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

GetBlockReceipts returns the receipts generated by the transactions included in block's given hash.

func GetBody added in v1.2.2 

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

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

func GetBodyRLP added in v1.2.2 

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

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

func GetCanonicalHash added in v1.2.2 

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

GetCanonicalHash retrieves a hash assigned to a canonical block number.

func GetHeadBlockHash added in v1.2.2 

func GetHeadBlockHash(db ethdb.Database) common.Hash

GetHeadBlockHash retrieves the hash of the current canonical head block.

func GetHeadFastBlockHash added in v1.3.1 

func GetHeadFastBlockHash(db ethdb.Database) common.Hash

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

func GetHeadHeaderHash added in v1.2.2 

func GetHeadHeaderHash(db ethdb.Database) common.Hash

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

func GetHeader added in v1.2.2 

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

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

func GetHeaderRLP added in v1.2.2 

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

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

func GetMipmapBloom added in v1.3.1 

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

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

func GetReceipt 

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

GetReceipt returns a receipt by hash

func GetTd added in v1.2.2 

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

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

func GetTransaction added in v1.2.2 

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

func IntrinsicGas 

func IntrinsicGas(data []byte) *big.Int

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

func IsBadHashError added in v1.2.2 

func IsBadHashError(err error) bool

func IsBlockNonceErr 

func IsBlockNonceErr(err error) bool

IsBlockNonceErr returns true for invalid block nonce errors.

func IsGasLimitErr added in v1.3.1 

func IsGasLimitErr(err error) bool

func IsInvalidTxErr 

func IsInvalidTxErr(err error) bool

func IsKnownBlockErr 

func IsKnownBlockErr(e error) bool

func IsNonceErr 

func IsNonceErr(err error) bool

func IsParentErr 

func IsParentErr(err error) bool

func IsTDError 

func IsTDError(e error) bool

func IsUncleErr 

func IsUncleErr(err error) bool

func IsValidationErr 

func IsValidationErr(err error) bool

func IsValueTransferErr 

func IsValueTransferErr(e error) bool

func MessageCreatesContract 

func MessageCreatesContract(msg Message) bool

func NewDefaultGenesisReader added in v1.0.1 

func NewDefaultGenesisReader() (io.Reader, error)

func ParentError 

func ParentError(hash common.Hash) error

func PutBlockReceipts added in v0.9.39 

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

PutBlockReceipts stores the block's transactions associated receipts and stores them by block hash in a single slice. This is required for forks and chain reorgs

func PutReceipts 

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

PutReceipts stores the receipts in the current database

func PutTransactions 

func PutTransactions(db ethdb.Database, block *types.Block, txs types.Transactions) error

PutTransactions stores the transactions in the given database

func ReportBlock 

func ReportBlock(block *types.Block, err error)

ReportBlock reports the block to the block reporting tool found at badblocks.ethdev.com

func Transfer added in v1.3.1 

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

generic transfer method

func UncleError 

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

func ValidateHeader 

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

See YP section 4.3.4. "Block Header Validity" Validates a header. Returns an error if the header is invalid.

func WriteBlock added in v0.9.39 

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

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

func WriteBody added in v1.2.2 

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

WriteBody serializes the body of a block into the database.

func WriteCanonicalHash added in v1.2.2 

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

WriteCanonicalHash stores the canonical hash for the given block number.

func WriteGenesisBlock added in v0.9.39 

func WriteGenesisBlock(chainDb ethdb.Database, reader io.Reader) (*types.Block, error)

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

func WriteGenesisBlockForTesting added in v0.9.39 

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

func WriteHeadBlockHash added in v1.2.2 

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

WriteHeadBlockHash stores the head block's hash.

func WriteHeadFastBlockHash added in v1.3.1 

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

WriteHeadFastBlockHash stores the fast head block's hash.

func WriteHeadHeaderHash added in v1.2.2 

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

WriteHeadHeaderHash stores the head header's hash.

func WriteHeader added in v1.2.2 

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

WriteHeader serializes a block header into the database.

func WriteMipmapBloom added in v1.3.1 

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

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

func WriteOlympicGenesisBlock added in v1.3.1 

func WriteOlympicGenesisBlock(chainDb ethdb.Database, nonce uint64) (*types.Block, error)

func WriteTd added in v1.2.2 

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

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

func WriteTestNetGenesisBlock added in v0.9.39 

func WriteTestNetGenesisBlock(chainDb ethdb.Database, nonce uint64) (*types.Block, error)

Types

type Backend 

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

TODO move this to types?

type BadHashError added in v1.2.2 

type BadHashError common.Hash

func (BadHashError) Error added in v1.2.2 

func (h BadHashError) Error() string

type BlockChain added in v1.3.1 

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

func NewBlockChain added in v1.3.1 

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

func (*BlockChain) CurrentBlock added in v1.3.1 

func (self *BlockChain) CurrentBlock() *types.Block

CurrentBlock retrieves the current head block of the canonical chain. The block is retrieved from the blockchain's internal cache.

func (*BlockChain) CurrentFastBlock added in v1.3.1 

func (self *BlockChain) CurrentFastBlock() *types.Block

CurrentFastBlock retrieves the current fast-sync head block of the canonical chain. The block is retrieved from the blockchain's internal cache.

func (*BlockChain) CurrentHeader added in v1.3.1 

func (self *BlockChain) CurrentHeader() *types.Header

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

func (*BlockChain) Export added in v1.3.1 

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

Export writes the active chain to the given writer.

func (*BlockChain) ExportN added in v1.3.1 

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

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

func (*BlockChain) FastSyncCommitHead added in v1.3.1 

func (self *BlockChain) FastSyncCommitHead(hash common.Hash) error

FastSyncCommitHead sets the current head block to the one defined by the hash irrelevant what the chain contents were prior.

func (*BlockChain) GasLimit added in v1.3.1 

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

func (*BlockChain) Genesis added in v1.3.1 

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

Accessors

func (*BlockChain) GetBlock added in v1.3.1 

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

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

func (*BlockChain) GetBlockByNumber added in v1.3.1 

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

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

func (*BlockChain) GetBlockHashesFromHash added in v1.3.1 

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

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

func (*BlockChain) GetBlocksFromHash added in v1.3.1 

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

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

func (*BlockChain) GetBody added in v1.3.1 

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

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

func (*BlockChain) GetBodyRLP added in v1.3.1 

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

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

func (*BlockChain) GetHeader added in v1.3.1 

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

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

func (*BlockChain) GetHeaderByNumber added in v1.3.1 

func (self *BlockChain) GetHeaderByNumber(number uint64) *types.Header

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

func (*BlockChain) GetTd added in v1.3.1 

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

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

func (*BlockChain) GetUnclesInChain added in v1.3.1 

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

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

func (*BlockChain) HasBlock added in v1.3.1 

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

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

func (*BlockChain) HasHeader added in v1.3.1 

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

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

func (*BlockChain) InsertChain added in v1.3.1 

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

InsertChain will attempt to insert the given chain in to the canonical chain or, otherwise, create a fork. It an error is returned it will return the index number of the failing block as well an error describing what went wrong (for possible errors see core/errors.go).

func (*BlockChain) InsertHeaderChain added in v1.3.1 

func (self *BlockChain) InsertHeaderChain(chain []*types.Header, checkFreq int) (int, error)

InsertHeaderChain attempts to insert the given header chain in to the local chain, possibly creating a reorg. If an error is returned, it will return the index number of the failing header as well an error describing what went wrong.

The verify parameter can be used to fine tune whether nonce verification should be done or not. The reason behind the optional check is because some of the header retrieval mechanisms already need to verfy nonces, as well as because nonces can be verified sparsely, not needing to check each.

func (*BlockChain) InsertReceiptChain added in v1.3.1 

func (self *BlockChain) InsertReceiptChain(blockChain types.Blocks, receiptChain []types.Receipts) (int, error)

InsertReceiptChain attempts to complete an already existing header chain with transaction and receipt data.

func (*BlockChain) LastBlockHash added in v1.3.1 

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

func (*BlockChain) Reset added in v1.3.1 

func (bc *BlockChain) Reset()

Reset purges the entire blockchain, restoring it to its genesis state.

func (*BlockChain) ResetWithGenesisBlock added in v1.3.1 

func (bc *BlockChain) ResetWithGenesisBlock(genesis *types.Block)

ResetWithGenesisBlock purges the entire blockchain, restoring it to the specified genesis state.

func (*BlockChain) Rollback added in v1.3.1 

func (self *BlockChain) Rollback(chain []common.Hash)

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

func (*BlockChain) SetHead added in v1.3.1 

func (bc *BlockChain) SetHead(head uint64)

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

func (*BlockChain) SetProcessor added in v1.3.1 

func (self *BlockChain) SetProcessor(proc types.BlockProcessor)

func (*BlockChain) State added in v1.3.1 

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

func (*BlockChain) Status added in v1.3.1 

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

func (*BlockChain) Stop added in v1.3.1 

func (bc *BlockChain) Stop()

func (*BlockChain) WriteBlock added in v1.3.1 

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

WriteBlock writes the block to the chain.

type BlockGen 

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 added in v1.3.1 

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

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

AddUncheckedReceipts will cause consensus failures when used during real chain processing. This is best used in conjuction with raw block insertion.

func (*BlockGen) AddUncle 

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

AddUncle adds an uncle header to the generated block.

func (*BlockGen) OffsetTime added in v1.2.2 

func (b *BlockGen) OffsetTime(seconds int64)

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

func (*BlockGen) PrevBlock 

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

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

func (*BlockGen) SetCoinbase 

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

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

func (*BlockGen) SetExtra 

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

SetExtra sets the extra data field of the generated block.

func (*BlockGen) TxNonce 

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

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

type BlockNonceErr 

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

BlockNonceErr indicates that a block's nonce is invalid.

func (*BlockNonceErr) Error 

func (err *BlockNonceErr) Error() string

type BlockProcessor 

type BlockProcessor struct {

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

func NewBlockProcessor 

func NewBlockProcessor(db ethdb.Database, pow pow.PoW, blockchain *BlockChain, eventMux *event.TypeMux) *BlockProcessor

func (*BlockProcessor) ApplyTransaction 

func (self *BlockProcessor) ApplyTransaction(gp *GasPool, statedb *state.StateDB, header *types.Header, tx *types.Transaction, usedGas *big.Int, transientProcess bool) (*types.Receipt, *big.Int, error)

func (*BlockProcessor) ApplyTransactions 

func (self *BlockProcessor) ApplyTransactions(gp *GasPool, statedb *state.StateDB, block *types.Block, txs types.Transactions, transientProcess bool) (types.Receipts, error)

func (*BlockProcessor) BlockChain added in v1.3.1 

func (self *BlockProcessor) BlockChain() *BlockChain

func (*BlockProcessor) GetBlockReceipts 

func (sm *BlockProcessor) GetBlockReceipts(bhash common.Hash) types.Receipts

GetBlockReceipts returns the receipts beloniging to the block hash

func (*BlockProcessor) GetLogs 

func (sm *BlockProcessor) GetLogs(block *types.Block) (logs vm.Logs, err error)

GetLogs returns the logs of the given block. This method is using a two step approach where it tries to get it from the (updated) method which gets them from the receipts or the depricated way by re-processing the block.

func (*BlockProcessor) Process 

func (sm *BlockProcessor) Process(block *types.Block) (logs vm.Logs, receipts types.Receipts, err error)

Process block will attempt to process the given block's transactions and applies them on top of the block's parent state (given it exists) and will return wether it was successful or not.

func (*BlockProcessor) RetryProcess 

func (sm *BlockProcessor) RetryProcess(block *types.Block) (logs vm.Logs, err error)

func (*BlockProcessor) TransitionState 

func (sm *BlockProcessor) TransitionState(statedb *state.StateDB, parent, block *types.Block, transientProcess bool) (receipts types.Receipts, err error)

func (*BlockProcessor) ValidateHeader added in v1.3.1 

func (sm *BlockProcessor) ValidateHeader(header *types.Header, checkPow, uncle bool) error

ValidateHeader verifies the validity of a header, relying on the database and POW behind the block processor.

func (*BlockProcessor) ValidateHeaderWithParent added in v1.3.1 

func (sm *BlockProcessor) ValidateHeaderWithParent(header, parent *types.Header, checkPow, uncle bool) error

ValidateHeaderWithParent verifies the validity of a header, relying on the database and POW behind the block processor.

func (*BlockProcessor) VerifyUncles 

func (sm *BlockProcessor) VerifyUncles(statedb *state.StateDB, block, parent *types.Block) error

type ChainEvent 

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

type ChainHeadEvent 

type ChainHeadEvent struct{ Block *types.Block }

type ChainSideEvent 

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

type ChainSplitEvent 

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

ChainSplit is posted when a new head is detected

type ChainUncleEvent 

type ChainUncleEvent struct {
	Block *types.Block
}

type FakePow 

type FakePow struct{}

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

func (FakePow) GetHashrate 

func (f FakePow) GetHashrate() int64

func (FakePow) Search 

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

func (FakePow) Turbo 

func (f FakePow) Turbo(bool)

func (FakePow) Verify 

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

type GasLimitErr added in v1.3.1 

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

func (*GasLimitErr) Error added in v1.3.1 

func (err *GasLimitErr) Error() string

type GasPool added in v1.0.3 

type GasPool big.Int

GasPool tracks the amount of gas available during execution of the transactions in a block. The zero value is a pool with zero gas available.

func (*GasPool) AddGas added in v1.0.3 

func (gp *GasPool) AddGas(amount *big.Int) *GasPool

AddGas makes gas available for execution.

func (*GasPool) String added in v1.3.1 

func (gp *GasPool) String() string

func (*GasPool) SubGas added in v1.0.3 

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

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

type GasPriceChanged 

type GasPriceChanged struct{ Price *big.Int }

type GenesisAccount added in v1.2.2 

type GenesisAccount struct {
	Address common.Address
	Balance *big.Int
}

type InvalidTxErr 

type InvalidTxErr struct {
	Message string
}

func InvalidTxError 

func InvalidTxError(err error) *InvalidTxErr

func (*InvalidTxErr) Error 

func (err *InvalidTxErr) Error() string

type KnownBlockError 

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

func (*KnownBlockError) Error 

func (self *KnownBlockError) Error() string

type Message 

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

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

	Nonce() uint64
	Data() []byte
}

Message represents a message sent to a contract.

type NewBlockEvent 

type NewBlockEvent struct{ Block *types.Block }

NewBlockEvent is posted when a block has been imported.

type NewMinedBlockEvent 

type NewMinedBlockEvent struct{ Block *types.Block }

NewMinedBlockEvent is posted when a block has been imported.

type NonceErr 

type NonceErr struct {
	Message string
	Is, Exp uint64
}

func NonceError 

func NonceError(is, exp uint64) *NonceErr

func (*NonceErr) Error 

func (err *NonceErr) Error() string

type ParentErr 

type ParentErr struct {
	Message string
}

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

func (*ParentErr) Error 

func (err *ParentErr) Error() string

type PendingBlockEvent 

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

type RemovedTransactionEvent added in v1.2.2 

type RemovedTransactionEvent struct{ Txs types.Transactions }

RemovedTransactionEvent is posted when a reorg happens

type StartMining 

type StartMining struct{}

Mining operation events

type StateTransition 

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

The State Transitioning Model

A state transition is a change made when a transaction is applied to the current world state The state transitioning model does all all the necessary work to work out a valid new state root.

1) Nonce handling 2) Pre pay gas 3) Create a new state object if the recipient is \0*32 4) Value transfer == If contract creation == 

4a) Attempt to run transaction data
4b) If valid, use result as code for the new state object

== end == 5) Run Script section 6) Derive new state root

type TDError 

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

func (*TDError) Error 

func (self *TDError) Error() string

type TopMining 

type TopMining struct{}

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

func (*TxPool) Add 

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

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

func (*TxPool) AddTransactions 

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

AddTransactions attempts to queue all valid transactions in txs.

func (*TxPool) GetQueuedTransactions 

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

GetQueuedTransactions returns all non-processable transactions.

func (*TxPool) GetTransaction 

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

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

func (*TxPool) GetTransactions 

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

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

func (*TxPool) RemoveTransactions 

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

RemoveTransactions removes all given transactions from the pool.

func (*TxPool) RemoveTx added in v1.0.1 

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

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

func (*TxPool) State 

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

func (*TxPool) Stats 

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

func (*TxPool) Stop 

func (pool *TxPool) Stop()

type TxPostEvent 

type TxPostEvent struct{ Tx *types.Transaction }

TxPostEvent is posted when a transaction has been processed.

type TxPreEvent 

type TxPreEvent struct{ Tx *types.Transaction }

TxPreEvent is posted when a transaction enters the transaction pool.

type UncleErr 

type UncleErr struct {
	Message string
}

func (*UncleErr) Error 

func (err *UncleErr) Error() string

type VMEnv 

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

func NewEnv 

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

func (*VMEnv) AddLog 

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

func (*VMEnv) AddStructLog 

func (self *VMEnv) AddStructLog(log vm.StructLog)

func (*VMEnv) BlockNumber 

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

func (*VMEnv) Call 

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

func (*VMEnv) CallCode 

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

func (*VMEnv) CanTransfer added in v1.1.0 

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

func (*VMEnv) Coinbase 

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

func (*VMEnv) Create 

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

func (*VMEnv) Db added in v1.3.1 

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

func (*VMEnv) Depth 

func (self *VMEnv) Depth() int

func (*VMEnv) Difficulty 

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

func (*VMEnv) GasLimit 

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

func (*VMEnv) GetHash 

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

func (*VMEnv) MakeSnapshot added in v1.3.1 

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

func (*VMEnv) Origin 

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

func (*VMEnv) SetDepth 

func (self *VMEnv) SetDepth(i int)

func (*VMEnv) SetSnapshot added in v1.3.1 

func (self *VMEnv) SetSnapshot(copy vm.Database)

func (*VMEnv) SetVmType 

func (self *VMEnv) SetVmType(t vm.Type)

func (*VMEnv) StructLogs 

func (self *VMEnv) StructLogs() []vm.StructLog

func (*VMEnv) Time 

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

func (*VMEnv) Transfer 

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

func (*VMEnv) Value 

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

func (*VMEnv) VmType 

func (self *VMEnv) VmType() vm.Type

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

Source Files

View all Source files

Directories

Path Synopsis
Package state provides a caching layer atop the Ethereum state trie.
 Package state provides a caching layer atop the Ethereum state trie.
Package types contains data types related to Ethereum consensus.
 Package types contains data types related to Ethereum consensus.
Package vm implements the Ethereum Virtual Machine.
 Package vm implements the Ethereum Virtual Machine.

Jump to

Keyboard shortcuts

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