Documentation ¶
Overview ¶
Package eth implements the Ethereum protocol.
Package eth implements the Ethereum protocol.
Index ¶
- Constants
- Variables
- func CreateConsensusEngine(ctx *node.ServiceContext, config *Config, chainConfig *params.ChainConfig, ...) consensus.Engine
- func CreateDB(ctx *node.ServiceContext, config *Config, name string) (ethdb.Database, error)
- type BlockTraceResult
- type Config
- type ContractBackend
- func (b *ContractBackend) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNum *big.Int) ([]byte, error)
- func (b *ContractBackend) CodeAt(ctx context.Context, contract common.Address, blockNum *big.Int) ([]byte, error)
- func (b *ContractBackend) EstimateGas(ctx context.Context, msg ethereum.CallMsg) (*big.Int, error)
- func (b *ContractBackend) PendingCallContract(ctx context.Context, msg ethereum.CallMsg) ([]byte, error)
- func (b *ContractBackend) PendingCodeAt(ctx context.Context, contract common.Address) ([]byte, error)
- func (b *ContractBackend) PendingNonceAt(ctx context.Context, account common.Address) (nonce uint64, err error)
- func (b *ContractBackend) SendTransaction(ctx context.Context, tx *types.Transaction) error
- func (b *ContractBackend) SuggestGasPrice(ctx context.Context) (*big.Int, error)
- type EthApiBackend
- func (b *EthApiBackend) AccountManager() *accounts.Manager
- func (b *EthApiBackend) BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)
- func (b *EthApiBackend) ChainConfig() *params.ChainConfig
- func (b *EthApiBackend) ChainDb() ethdb.Database
- func (b *EthApiBackend) CurrentBlock() *types.Block
- func (b *EthApiBackend) Downloader() *downloader.Downloader
- func (b *EthApiBackend) EventMux() *event.TypeMux
- func (b *EthApiBackend) GetBlock(ctx context.Context, blockHash common.Hash) (*types.Block, error)
- func (b *EthApiBackend) GetEVM(ctx context.Context, msg core.Message, state ethapi.State, ...) (*vm.EVM, func() error, error)
- func (b *EthApiBackend) GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)
- func (b *EthApiBackend) GetPoolTransaction(hash common.Hash) *types.Transaction
- func (b *EthApiBackend) GetPoolTransactions() (types.Transactions, error)
- func (b *EthApiBackend) GetReceipts(ctx context.Context, blockHash common.Hash) (types.Receipts, error)
- func (b *EthApiBackend) GetTd(blockHash common.Hash) *big.Int
- func (b *EthApiBackend) HeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Header, error)
- func (b *EthApiBackend) ProtocolVersion() int
- func (b *EthApiBackend) RemoveTx(txHash common.Hash)
- func (b *EthApiBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error
- func (b *EthApiBackend) SetHead(number uint64)
- func (b *EthApiBackend) StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (ethapi.State, *types.Header, error)
- func (b *EthApiBackend) Stats() (pending int, queued int)
- func (b *EthApiBackend) SuggestPrice(ctx context.Context) (*big.Int, error)
- func (b *EthApiBackend) TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
- type EthApiState
- func (s EthApiState) GetBalance(ctx context.Context, addr common.Address) (*big.Int, error)
- func (s EthApiState) GetCode(ctx context.Context, addr common.Address) ([]byte, error)
- func (s EthApiState) GetNonce(ctx context.Context, addr common.Address) (uint64, error)
- func (s EthApiState) GetState(ctx context.Context, a common.Address, b common.Hash) (common.Hash, error)
- type EthNodeInfo
- type Ethereum
- func (s *Ethereum) APIs() []rpc.API
- func (s *Ethereum) AccountManager() *accounts.Manager
- func (s *Ethereum) AddLesServer(ls LesServer)
- func (s *Ethereum) BlockChain() *core.BlockChain
- func (s *Ethereum) ChainDb() ethdb.Database
- func (s *Ethereum) Downloader() *downloader.Downloader
- func (s *Ethereum) Engine() consensus.Engine
- func (s *Ethereum) EthVersion() int
- func (s *Ethereum) Etherbase() (eb common.Address, err error)
- func (s *Ethereum) EventMux() *event.TypeMux
- func (s *Ethereum) IsListening() bool
- func (s *Ethereum) IsMining() bool
- func (s *Ethereum) Miner() *miner.Miner
- func (s *Ethereum) NetVersion() uint64
- func (s *Ethereum) Protocols() []p2p.Protocol
- func (s *Ethereum) ResetWithGenesisBlock(gb *types.Block)
- func (self *Ethereum) SetEtherbase(etherbase common.Address)
- func (s *Ethereum) Start(srvr *p2p.Server) error
- func (s *Ethereum) StartMining(local bool) error
- func (s *Ethereum) Stop() error
- func (s *Ethereum) StopMining()
- func (s *Ethereum) TxPool() *core.TxPool
- type LesServer
- type PeerInfo
- type PrivateAdminAPI
- type PrivateDebugAPI
- func (api *PrivateDebugAPI) GetBadBlocks(ctx context.Context) ([]core.BadBlockArgs, error)
- func (api *PrivateDebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, error)
- func (api *PrivateDebugAPI) StorageRangeAt(ctx context.Context, blockHash common.Hash, txIndex int, ...) (StorageRangeResult, error)
- func (api *PrivateDebugAPI) TraceBlock(blockRlp []byte, config *vm.LogConfig) BlockTraceResult
- func (api *PrivateDebugAPI) TraceBlockByHash(hash common.Hash, config *vm.LogConfig) BlockTraceResult
- func (api *PrivateDebugAPI) TraceBlockByNumber(blockNr rpc.BlockNumber, config *vm.LogConfig) BlockTraceResult
- func (api *PrivateDebugAPI) TraceBlockFromFile(file string, config *vm.LogConfig) BlockTraceResult
- func (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, txHash common.Hash, config *TraceArgs) (interface{}, error)
- type PrivateMinerAPI
- func (api *PrivateMinerAPI) GetHashrate() uint64
- func (api *PrivateMinerAPI) SetEtherbase(etherbase common.Address) bool
- func (api *PrivateMinerAPI) SetExtra(extra string) (bool, error)
- func (api *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool
- func (api *PrivateMinerAPI) Start(threads *int) error
- func (api *PrivateMinerAPI) Stop() bool
- type ProtocolManager
- type PublicDebugAPI
- type PublicEthereumAPI
- type PublicMinerAPI
- type StorageRangeResult
- type TraceArgs
Constants ¶
const ( // Protocol messages belonging to eth/62 StatusMsg = 0x00 NewBlockHashesMsg = 0x01 TxMsg = 0x02 GetBlockHeadersMsg = 0x03 BlockHeadersMsg = 0x04 GetBlockBodiesMsg = 0x05 BlockBodiesMsg = 0x06 NewBlockMsg = 0x07 // Protocol messages belonging to eth/63 GetNodeDataMsg = 0x0d NodeDataMsg = 0x0e GetReceiptsMsg = 0x0f ReceiptsMsg = 0x10 )
eth protocol message codes
const ( ErrMsgTooLarge = iota ErrDecode ErrInvalidMsgCode ErrProtocolVersionMismatch ErrNetworkIdMismatch ErrGenesisBlockMismatch ErrNoStatusMsg ErrExtraStatusMsg ErrSuspendedPeer )
const ProtocolMaxMsgSize = 10 * 1024 * 1024 // Maximum cap on the size of a protocol message
Variables ¶
var DefaultConfig = Config{ SyncMode: downloader.FastSync, EthashCacheDir: "ethash", EthashCachesInMem: 2, EthashCachesOnDisk: 3, EthashDatasetsInMem: 1, EthashDatasetsOnDisk: 2, NetworkId: 1, LightPeers: 20, DatabaseCache: 128, GasPrice: big.NewInt(18 * params.Shannon), TxPool: core.DefaultTxPoolConfig, GPO: gasprice.Config{ Blocks: 10, Percentile: 50, }, }
DefaultConfig contains default settings for use on the Ethereum main net.
var ProtocolLengths = []uint64{17, 8}
Number of implemented message corresponding to different protocol versions.
var ProtocolName = "eth"
Official short name of the protocol used during capability negotiation.
var ProtocolVersions = []uint{eth63, eth62}
Supported versions of the eth protocol (first is primary).
Functions ¶
func CreateConsensusEngine ¶ added in v1.6.0
func CreateConsensusEngine(ctx *node.ServiceContext, config *Config, chainConfig *params.ChainConfig, db ethdb.Database) consensus.Engine
CreateConsensusEngine creates the required type of consensus engine instance for an Ethereum service
Types ¶
type BlockTraceResult ¶ added in v1.4.2
type BlockTraceResult struct { Validated bool `json:"validated"` StructLogs []ethapi.StructLogRes `json:"structLogs"` Error string `json:"error"` }
BlockTraceResult is the returned value when replaying a block to check for consensus results and full VM trace logs for all included transactions.
type Config ¶
type Config struct { // The genesis block, which is inserted if the database is empty. // If nil, the Ethereum main net block is used. Genesis *core.Genesis `toml:",omitempty"` // Protocol options NetworkId uint64 // Network ID to use for selecting peers to connect to SyncMode downloader.SyncMode // Light client options LightServ int `toml:",omitempty"` // Maximum percentage of time allowed for serving LES requests LightPeers int `toml:",omitempty"` // Maximum number of LES client peers MaxPeers int `toml:"-"` // Maximum number of global peers // Database options SkipBcVersionCheck bool `toml:"-"` DatabaseHandles int `toml:"-"` DatabaseCache int // Mining-related options Etherbase common.Address `toml:",omitempty"` MinerThreads int `toml:",omitempty"` ExtraData []byte `toml:",omitempty"` GasPrice *big.Int // Ethash options EthashCacheDir string EthashCachesInMem int EthashCachesOnDisk int EthashDatasetDir string EthashDatasetsInMem int EthashDatasetsOnDisk int // Transaction pool options TxPool core.TxPoolConfig // Gas Price Oracle options GPO gasprice.Config // Enables tracking of SHA3 preimages in the VM EnablePreimageRecording bool // Miscellaneous options DocRoot string `toml:"-"` PowFake bool `toml:"-"` PowTest bool `toml:"-"` }
func (Config) MarshalTOML ¶ added in v1.6.0
func (*Config) UnmarshalTOML ¶ added in v1.6.0
type ContractBackend ¶ added in v1.4.2
type ContractBackend struct {
// contains filtered or unexported fields
}
ContractBackend implements bind.ContractBackend with direct calls to Ethereum internals to support operating on contracts within subprotocols like eth and swarm.
Internally this backend uses the already exposed API endpoints of the Ethereum object. These should be rewritten to internal Go method calls when the Go API is refactored to support a clean library use.
func NewContractBackend ¶ added in v1.4.2
func NewContractBackend(apiBackend ethapi.Backend) *ContractBackend
NewContractBackend creates a new native contract backend using an existing Etheruem object.
func (*ContractBackend) CallContract ¶ added in v1.5.1
func (b *ContractBackend) CallContract(ctx context.Context, msg ethereum.CallMsg, blockNum *big.Int) ([]byte, error)
ContractCall implements bind.ContractCaller executing an Ethereum contract call with the specified data as the input. The pending flag requests execution against the pending block, not the stable head of the chain.
func (*ContractBackend) CodeAt ¶ added in v1.5.1
func (b *ContractBackend) CodeAt(ctx context.Context, contract common.Address, blockNum *big.Int) ([]byte, error)
CodeAt retrieves any code associated with the contract from the local API.
func (*ContractBackend) EstimateGas ¶ added in v1.5.1
EstimateGasLimit implements bind.ContractTransactor triing to estimate the gas needed to execute a specific transaction based on the current pending state of the backend blockchain. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.
func (*ContractBackend) PendingCallContract ¶ added in v1.5.1
func (b *ContractBackend) PendingCallContract(ctx context.Context, msg ethereum.CallMsg) ([]byte, error)
ContractCall implements bind.ContractCaller executing an Ethereum contract call with the specified data as the input. The pending flag requests execution against the pending block, not the stable head of the chain.
func (*ContractBackend) PendingCodeAt ¶ added in v1.5.1
func (b *ContractBackend) PendingCodeAt(ctx context.Context, contract common.Address) ([]byte, error)
CodeAt retrieves any code associated with the contract from the local API.
func (*ContractBackend) PendingNonceAt ¶ added in v1.5.1
func (b *ContractBackend) PendingNonceAt(ctx context.Context, account common.Address) (nonce uint64, err error)
PendingAccountNonce implements bind.ContractTransactor retrieving the current pending nonce associated with an account.
func (*ContractBackend) SendTransaction ¶ added in v1.4.2
func (b *ContractBackend) SendTransaction(ctx context.Context, tx *types.Transaction) error
SendTransaction implements bind.ContractTransactor injects the transaction into the pending pool for execution.
func (*ContractBackend) SuggestGasPrice ¶ added in v1.4.2
SuggestGasPrice implements bind.ContractTransactor retrieving the currently suggested gas price to allow a timely execution of a transaction.
type EthApiBackend ¶ added in v1.5.1
type EthApiBackend struct {
// contains filtered or unexported fields
}
EthApiBackend implements ethapi.Backend for full nodes
func (*EthApiBackend) AccountManager ¶ added in v1.5.1
func (b *EthApiBackend) AccountManager() *accounts.Manager
func (*EthApiBackend) BlockByNumber ¶ added in v1.5.1
func (b *EthApiBackend) BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)
func (*EthApiBackend) ChainConfig ¶ added in v1.5.1
func (b *EthApiBackend) ChainConfig() *params.ChainConfig
func (*EthApiBackend) ChainDb ¶ added in v1.5.1
func (b *EthApiBackend) ChainDb() ethdb.Database
func (*EthApiBackend) CurrentBlock ¶ added in v1.5.1
func (b *EthApiBackend) CurrentBlock() *types.Block
func (*EthApiBackend) Downloader ¶ added in v1.5.1
func (b *EthApiBackend) Downloader() *downloader.Downloader
func (*EthApiBackend) EventMux ¶ added in v1.5.1
func (b *EthApiBackend) EventMux() *event.TypeMux
func (*EthApiBackend) GetPoolNonce ¶ added in v1.5.1
func (*EthApiBackend) GetPoolTransaction ¶ added in v1.5.1
func (b *EthApiBackend) GetPoolTransaction(hash common.Hash) *types.Transaction
func (*EthApiBackend) GetPoolTransactions ¶ added in v1.5.1
func (b *EthApiBackend) GetPoolTransactions() (types.Transactions, error)
func (*EthApiBackend) GetReceipts ¶ added in v1.5.1
func (*EthApiBackend) GetTd ¶ added in v1.5.1
func (b *EthApiBackend) GetTd(blockHash common.Hash) *big.Int
func (*EthApiBackend) HeaderByNumber ¶ added in v1.5.1
func (b *EthApiBackend) HeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Header, error)
func (*EthApiBackend) ProtocolVersion ¶ added in v1.5.1
func (b *EthApiBackend) ProtocolVersion() int
func (*EthApiBackend) RemoveTx ¶ added in v1.5.1
func (b *EthApiBackend) RemoveTx(txHash common.Hash)
func (*EthApiBackend) SendTx ¶ added in v1.5.1
func (b *EthApiBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error
func (*EthApiBackend) SetHead ¶ added in v1.5.1
func (b *EthApiBackend) SetHead(number uint64)
func (*EthApiBackend) StateAndHeaderByNumber ¶ added in v1.5.1
func (b *EthApiBackend) StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (ethapi.State, *types.Header, error)
func (*EthApiBackend) Stats ¶ added in v1.5.1
func (b *EthApiBackend) Stats() (pending int, queued int)
func (*EthApiBackend) SuggestPrice ¶ added in v1.5.1
func (*EthApiBackend) TxPoolContent ¶ added in v1.5.1
func (b *EthApiBackend) TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
type EthApiState ¶ added in v1.5.1
type EthApiState struct {
// contains filtered or unexported fields
}
func (EthApiState) GetBalance ¶ added in v1.5.1
type EthNodeInfo ¶ added in v1.4.2
type EthNodeInfo struct { Network uint64 `json:"network"` // Ethereum network ID (1=Frontier, 2=Morden, Ropsten=3) Difficulty *big.Int `json:"difficulty"` // Total difficulty of the host's blockchain Genesis common.Hash `json:"genesis"` // SHA3 hash of the host's genesis block Head common.Hash `json:"head"` // SHA3 hash of the host's best owned block }
EthNodeInfo represents a short summary of the Ethereum sub-protocol metadata known about the host peer.
type Ethereum ¶
type Ethereum struct { ApiBackend *EthApiBackend // contains filtered or unexported fields }
Ethereum implements the Ethereum full node service.
func New ¶
func New(ctx *node.ServiceContext, config *Config) (*Ethereum, error)
New creates a new Ethereum object (including the initialisation of the common Ethereum object)
func (*Ethereum) APIs ¶ added in v1.4.2
APIs returns the collection of RPC services the ethereum package offers. NOTE, some of these services probably need to be moved to somewhere else.
func (*Ethereum) AccountManager ¶
func (*Ethereum) AddLesServer ¶ added in v1.5.1
func (*Ethereum) BlockChain ¶ added in v1.4.2
func (s *Ethereum) BlockChain() *core.BlockChain
func (*Ethereum) Downloader ¶
func (s *Ethereum) Downloader() *downloader.Downloader
func (*Ethereum) EthVersion ¶
func (*Ethereum) IsListening ¶
func (*Ethereum) NetVersion ¶
func (*Ethereum) Protocols ¶ added in v1.4.2
Protocols implements node.Service, returning all the currently configured network protocols to start.
func (*Ethereum) ResetWithGenesisBlock ¶
func (*Ethereum) SetEtherbase ¶ added in v0.9.38
set in js console via admin interface or wrapper from cli flags
func (*Ethereum) Start ¶
Start implements node.Service, starting all internal goroutines needed by the Ethereum protocol implementation.
func (*Ethereum) StartMining ¶
func (*Ethereum) Stop ¶
Stop implements node.Service, terminating all internal goroutines used by the Ethereum protocol.
func (*Ethereum) StopMining ¶
func (s *Ethereum) StopMining()
type PeerInfo ¶
type PeerInfo struct { Version int `json:"version"` // Ethereum protocol version negotiated Difficulty *big.Int `json:"difficulty"` // Total difficulty of the peer's blockchain Head string `json:"head"` // SHA3 hash of the peer's best owned block }
PeerInfo represents a short summary of the Ethereum sub-protocol metadata known about a connected peer.
type PrivateAdminAPI ¶ added in v1.4.2
type PrivateAdminAPI struct {
// contains filtered or unexported fields
}
PrivateAdminAPI is the collection of Etheruem full node-related APIs exposed over the private admin endpoint.
func NewPrivateAdminAPI ¶ added in v1.4.2
func NewPrivateAdminAPI(eth *Ethereum) *PrivateAdminAPI
NewPrivateAdminAPI creates a new API definition for the full node private admin methods of the Ethereum service.
func (*PrivateAdminAPI) ExportChain ¶ added in v1.4.2
func (api *PrivateAdminAPI) ExportChain(file string) (bool, error)
ExportChain exports the current blockchain into a local file.
func (*PrivateAdminAPI) ImportChain ¶ added in v1.4.2
func (api *PrivateAdminAPI) ImportChain(file string) (bool, error)
ImportChain imports a blockchain from a local file.
type PrivateDebugAPI ¶ added in v1.4.2
type PrivateDebugAPI struct {
// contains filtered or unexported fields
}
PrivateDebugAPI is the collection of Etheruem full node APIs exposed over the private debugging endpoint.
func NewPrivateDebugAPI ¶ added in v1.4.2
func NewPrivateDebugAPI(config *params.ChainConfig, eth *Ethereum) *PrivateDebugAPI
NewPrivateDebugAPI creates a new API definition for the full node-related private debug methods of the Ethereum service.
func (*PrivateDebugAPI) GetBadBlocks ¶ added in v1.6.0
func (api *PrivateDebugAPI) GetBadBlocks(ctx context.Context) ([]core.BadBlockArgs, error)
GetBadBLocks returns a list of the last 'bad blocks' that the client has seen on the network and returns them as a JSON list of block-hashes
func (*PrivateDebugAPI) Preimage ¶ added in v1.5.8
Preimage is a debug API function that returns the preimage for a sha3 hash, if known.
func (*PrivateDebugAPI) StorageRangeAt ¶ added in v1.6.4
func (api *PrivateDebugAPI) StorageRangeAt(ctx context.Context, blockHash common.Hash, txIndex int, contractAddress common.Address, keyStart hexutil.Bytes, maxResult int) (StorageRangeResult, error)
StorageRangeAt returns the storage at the given block height and transaction index.
func (*PrivateDebugAPI) TraceBlock ¶ added in v1.4.2
func (api *PrivateDebugAPI) TraceBlock(blockRlp []byte, config *vm.LogConfig) BlockTraceResult
TraceBlock processes the given block'api RLP but does not import the block in to the chain.
func (*PrivateDebugAPI) TraceBlockByHash ¶ added in v1.4.2
func (api *PrivateDebugAPI) TraceBlockByHash(hash common.Hash, config *vm.LogConfig) BlockTraceResult
TraceBlockByHash processes the block by hash.
func (*PrivateDebugAPI) TraceBlockByNumber ¶ added in v1.4.2
func (api *PrivateDebugAPI) TraceBlockByNumber(blockNr rpc.BlockNumber, config *vm.LogConfig) BlockTraceResult
TraceBlockByNumber processes the block by canonical block number.
func (*PrivateDebugAPI) TraceBlockFromFile ¶ added in v1.4.2
func (api *PrivateDebugAPI) TraceBlockFromFile(file string, config *vm.LogConfig) BlockTraceResult
TraceBlockFromFile loads the block'api RLP from the given file name and attempts to process it but does not import the block in to the chain.
func (*PrivateDebugAPI) TraceTransaction ¶ added in v1.4.2
func (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, txHash common.Hash, config *TraceArgs) (interface{}, error)
TraceTransaction returns the structured logs created during the execution of EVM and returns them as a JSON object.
type PrivateMinerAPI ¶ added in v1.4.2
type PrivateMinerAPI struct {
// contains filtered or unexported fields
}
PrivateMinerAPI provides private RPC methods to control the miner. These methods can be abused by external users and must be considered insecure for use by untrusted users.
func NewPrivateMinerAPI ¶ added in v1.4.2
func NewPrivateMinerAPI(e *Ethereum) *PrivateMinerAPI
NewPrivateMinerAPI create a new RPC service which controls the miner of this node.
func (*PrivateMinerAPI) GetHashrate ¶ added in v1.6.0
func (api *PrivateMinerAPI) GetHashrate() uint64
GetHashrate returns the current hashrate of the miner.
func (*PrivateMinerAPI) SetEtherbase ¶ added in v1.4.2
func (api *PrivateMinerAPI) SetEtherbase(etherbase common.Address) bool
SetEtherbase sets the etherbase of the miner
func (*PrivateMinerAPI) SetExtra ¶ added in v1.4.2
func (api *PrivateMinerAPI) SetExtra(extra string) (bool, error)
SetExtra sets the extra data string that is included when this miner mines a block.
func (*PrivateMinerAPI) SetGasPrice ¶ added in v1.4.2
func (api *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool
SetGasPrice sets the minimum accepted gas price for the miner.
func (*PrivateMinerAPI) Start ¶ added in v1.4.2
func (api *PrivateMinerAPI) Start(threads *int) error
Start the miner with the given number of threads. If threads is nil the number of workers started is equal to the number of logical CPUs that are usable by this process. If mining is already running, this method adjust the number of threads allowed to use.
func (*PrivateMinerAPI) Stop ¶ added in v1.4.2
func (api *PrivateMinerAPI) Stop() bool
Stop the miner
type ProtocolManager ¶
type ProtocolManager struct { SubProtocols []p2p.Protocol // contains filtered or unexported fields }
func NewProtocolManager ¶
func NewProtocolManager(config *params.ChainConfig, mode downloader.SyncMode, networkId uint64, maxPeers int, mux *event.TypeMux, txpool txPool, engine consensus.Engine, blockchain *core.BlockChain, chaindb ethdb.Database) (*ProtocolManager, error)
NewProtocolManager returns a new ethereum sub protocol manager. The Ethereum sub protocol manages peers capable with the ethereum network.
func (*ProtocolManager) BroadcastBlock ¶
func (pm *ProtocolManager) BroadcastBlock(block *types.Block, propagate bool)
BroadcastBlock will either propagate a block to a subset of it's peers, or will only announce it's availability (depending what's requested).
func (*ProtocolManager) BroadcastTx ¶
func (pm *ProtocolManager) BroadcastTx(hash common.Hash, tx *types.Transaction)
BroadcastTx will propagate a transaction to all peers which are not known to already have the given transaction.
func (*ProtocolManager) NodeInfo ¶ added in v1.4.2
func (self *ProtocolManager) NodeInfo() *EthNodeInfo
NodeInfo retrieves some protocol metadata about the running host node.
func (*ProtocolManager) Start ¶
func (pm *ProtocolManager) Start()
func (*ProtocolManager) Stop ¶
func (pm *ProtocolManager) Stop()
type PublicDebugAPI ¶ added in v1.4.2
type PublicDebugAPI struct {
// contains filtered or unexported fields
}
PublicDebugAPI is the collection of Etheruem full node APIs exposed over the public debugging endpoint.
func NewPublicDebugAPI ¶ added in v1.4.2
func NewPublicDebugAPI(eth *Ethereum) *PublicDebugAPI
NewPublicDebugAPI creates a new API definition for the full node- related public debug methods of the Ethereum service.
func (*PublicDebugAPI) DumpBlock ¶ added in v1.4.2
func (api *PublicDebugAPI) DumpBlock(blockNr rpc.BlockNumber) (state.Dump, error)
DumpBlock retrieves the entire state of the database at a given block.
type PublicEthereumAPI ¶ added in v1.4.2
type PublicEthereumAPI struct {
// contains filtered or unexported fields
}
PublicEthereumAPI provides an API to access Ethereum full node-related information.
func NewPublicEthereumAPI ¶ added in v1.4.2
func NewPublicEthereumAPI(e *Ethereum) *PublicEthereumAPI
NewPublicEthereumAPI creates a new Etheruem protocol API for full nodes.
func (*PublicEthereumAPI) Coinbase ¶ added in v1.4.2
func (api *PublicEthereumAPI) Coinbase() (common.Address, error)
Coinbase is the address that mining rewards will be send to (alias for Etherbase)
func (*PublicEthereumAPI) Etherbase ¶ added in v1.4.2
func (api *PublicEthereumAPI) Etherbase() (common.Address, error)
Etherbase is the address that mining rewards will be send to
func (*PublicEthereumAPI) Hashrate ¶ added in v1.4.2
func (api *PublicEthereumAPI) Hashrate() hexutil.Uint64
Hashrate returns the POW hashrate
type PublicMinerAPI ¶ added in v1.4.2
type PublicMinerAPI struct {
// contains filtered or unexported fields
}
PublicMinerAPI provides an API to control the miner. It offers only methods that operate on data that pose no security risk when it is publicly accessible.
func NewPublicMinerAPI ¶ added in v1.4.2
func NewPublicMinerAPI(e *Ethereum) *PublicMinerAPI
NewPublicMinerAPI create a new PublicMinerAPI instance.
func (*PublicMinerAPI) GetWork ¶ added in v1.4.2
func (api *PublicMinerAPI) GetWork() ([3]string, error)
GetWork returns a work package for external miner. The work package consists of 3 strings result[0], 32 bytes hex encoded current block header pow-hash result[1], 32 bytes hex encoded seed hash used for DAG result[2], 32 bytes hex encoded boundary condition ("target"), 2^256/difficulty
func (*PublicMinerAPI) Mining ¶ added in v1.4.2
func (api *PublicMinerAPI) Mining() bool
Mining returns an indication if this node is currently mining.
func (*PublicMinerAPI) SubmitHashrate ¶ added in v1.4.2
SubmitHashrate can be used for remote miners to submit their hash rate. This enables the node to report the combined hash rate of all miners which submit work through this node. It accepts the miner hash rate and an identifier which must be unique between nodes.
func (*PublicMinerAPI) SubmitWork ¶ added in v1.4.2
func (api *PublicMinerAPI) SubmitWork(nonce types.BlockNonce, solution, digest common.Hash) bool
SubmitWork can be used by external miner to submit their POW solution. It returns an indication if the work was accepted. Note, this is not an indication if the provided work was valid!
type StorageRangeResult ¶ added in v1.6.4
type StorageRangeResult struct { Storage storageMap `json:"storage"` NextKey *common.Hash `json:"nextKey"` // nil if Storage includes the last key in the trie. }
StorageRangeResult is the result of a debug_storageRangeAt API call.
Source Files ¶
Directories ¶
Path | Synopsis |
---|---|
Package downloader contains the manual full chain synchronisation.
|
Package downloader contains the manual full chain synchronisation. |
Package fetcher contains the block announcement based synchronisation.
|
Package fetcher contains the block announcement based synchronisation. |
Package filters implements an ethereum filtering system for block, transactions and log events.
|
Package filters implements an ethereum filtering system for block, transactions and log events. |