Documentation ¶
Overview ¶
Package eth implements the Ethereum protocol.
Package eth implements the Ethereum protocol.
Index ¶
- Constants
- Variables
- func CreateDB(ctx *node.ServiceContext, config *Config, name string) (ethdb.Database, error)
- func CreatePoW(config *Config) (pow.PoW, error)
- func SetupGenesisBlock(chainDb *ethdb.Database, config *Config) 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) 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) GetVMEnv(ctx context.Context, msg core.Message, state ethapi.State, ...) (*vm.EVM, func() error, error)
- 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) 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() int
- func (s *Ethereum) Pow() pow.PoW
- 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 (self *Ethereum) StartAutoDAG()
- func (s *Ethereum) StartMining(threads int) error
- func (s *Ethereum) Stop() error
- func (self *Ethereum) StopAutoDAG()
- func (s *Ethereum) StopMining()
- func (s *Ethereum) TxPool() *core.TxPool
- func (s *Ethereum) WaitForShutdown()
- type LesServer
- type PeerInfo
- type PrivateAdminAPI
- type PrivateDebugAPI
- func (api *PrivateDebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, 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(number uint64, 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 (s *PrivateMinerAPI) MakeDAG(blockNr rpc.BlockNumber) (bool, error)
- func (s *PrivateMinerAPI) SetEtherbase(etherbase common.Address) bool
- func (s *PrivateMinerAPI) SetExtra(extra string) (bool, error)
- func (s *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool
- func (s *PrivateMinerAPI) Start(threads *int) (bool, error)
- func (s *PrivateMinerAPI) StartAutoDAG() bool
- func (s *PrivateMinerAPI) Stop() bool
- func (s *PrivateMinerAPI) StopAutoDAG() bool
- type ProtocolManager
- type PublicDebugAPI
- type PublicEthereumAPI
- type PublicMinerAPI
- type TraceArgs
Constants ¶
const ( NetworkId = 88 ProtocolMaxMsgSize = 10 * 1024 * 1024 // Maximum cap on the size of a protocol message )
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 )
Variables ¶
var EnableBadBlockReporting = false
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 ¶
Types ¶
type BlockTraceResult ¶
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 { ChainConfig *params.ChainConfig // chain configuration NetworkId int // Network ID to use for selecting peers to connect to Genesis string // Genesis JSON to seed the chain database with FastSync bool // Enables the state download based fast synchronisation algorithm LightMode bool // Running in light client mode LightServ int // Maximum percentage of time allowed for serving LES requests LightPeers int // Maximum number of LES client peers MaxPeers int // Maximum number of global peers SkipBcVersionCheck bool // e.g. blockchain export DatabaseCache int DatabaseHandles int DocRoot string AutoDAG bool PowFake bool PowTest bool ExtraData []byte Etherbase common.Address GasPrice *big.Int MinerThreads int SolcPath string GpoMinGasPrice *big.Int GpoMaxGasPrice *big.Int GpoFullBlockRatio int GpobaseStepDown int GpobaseStepUp int GpobaseCorrectionFactor int EnablePreimageRecording bool TestGenesisBlock *types.Block // Genesis block to seed the chain database with (testing only!) TestGenesisState ethdb.Database // Genesis state to seed the database with (testing only!) }
type ContractBackend ¶
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 ¶
func NewContractBackend(apiBackend ethapi.Backend) *ContractBackend
NewContractBackend creates a new native contract backend using an existing Etheruem object.
func (*ContractBackend) CallContract ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
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 ¶
SuggestGasPrice implements bind.ContractTransactor retrieving the currently suggested gas price to allow a timely execution of a transaction.
type EthApiBackend ¶
type EthApiBackend struct {
// contains filtered or unexported fields
}
EthApiBackend implements ethapi.Backend for full nodes
func (*EthApiBackend) AccountManager ¶
func (b *EthApiBackend) AccountManager() *accounts.Manager
func (*EthApiBackend) BlockByNumber ¶
func (b *EthApiBackend) BlockByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Block, error)
func (*EthApiBackend) ChainConfig ¶
func (b *EthApiBackend) ChainConfig() *params.ChainConfig
func (*EthApiBackend) ChainDb ¶
func (b *EthApiBackend) ChainDb() ethdb.Database
func (*EthApiBackend) CurrentBlock ¶
func (b *EthApiBackend) CurrentBlock() *types.Block
func (*EthApiBackend) Downloader ¶
func (b *EthApiBackend) Downloader() *downloader.Downloader
func (*EthApiBackend) EventMux ¶
func (b *EthApiBackend) EventMux() *event.TypeMux
func (*EthApiBackend) GetPoolNonce ¶
func (*EthApiBackend) GetPoolTransaction ¶
func (b *EthApiBackend) GetPoolTransaction(hash common.Hash) *types.Transaction
func (*EthApiBackend) GetPoolTransactions ¶
func (b *EthApiBackend) GetPoolTransactions() (types.Transactions, error)
func (*EthApiBackend) GetReceipts ¶
func (*EthApiBackend) HeaderByNumber ¶
func (b *EthApiBackend) HeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (*types.Header, error)
func (*EthApiBackend) ProtocolVersion ¶
func (b *EthApiBackend) ProtocolVersion() int
func (*EthApiBackend) RemoveTx ¶
func (b *EthApiBackend) RemoveTx(txHash common.Hash)
func (*EthApiBackend) SendTx ¶
func (b *EthApiBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error
func (*EthApiBackend) SetHead ¶
func (b *EthApiBackend) SetHead(number uint64)
func (*EthApiBackend) StateAndHeaderByNumber ¶
func (b *EthApiBackend) StateAndHeaderByNumber(ctx context.Context, blockNr rpc.BlockNumber) (ethapi.State, *types.Header, error)
func (*EthApiBackend) Stats ¶
func (b *EthApiBackend) Stats() (pending int, queued int)
func (*EthApiBackend) SuggestPrice ¶
func (*EthApiBackend) TxPoolContent ¶
func (b *EthApiBackend) TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
type EthApiState ¶
type EthApiState struct {
// contains filtered or unexported fields
}
func (EthApiState) GetBalance ¶
type EthNodeInfo ¶
type EthNodeInfo struct { Network int `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 Mining bool MinerThreads int AutoDAG bool // 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 ¶
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 ¶
func (*Ethereum) BlockChain ¶
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 ¶
Protocols implements node.Service, returning all the currently configured network protocols to start.
func (*Ethereum) ResetWithGenesisBlock ¶
func (*Ethereum) SetEtherbase ¶
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) StartAutoDAG ¶
func (self *Ethereum) StartAutoDAG()
StartAutoDAG() spawns a go routine that checks the DAG every autoDAGcheckInterval by default that is 10 times per epoch in epoch n, if we past autoDAGepochHeight within-epoch blocks, it calls ethash.MakeDAG to pregenerate the DAG for the next epoch n+1 if it does not exist yet as well as remove the DAG for epoch n-1 the loop quits if autodagquit channel is closed, it can safely restart and stop any number of times. For any more sophisticated pattern of DAG generation, use CLI subcommand makedag
func (*Ethereum) StartMining ¶
func (*Ethereum) Stop ¶
Stop implements node.Service, terminating all internal goroutines used by the Ethereum protocol.
func (*Ethereum) StopAutoDAG ¶
func (self *Ethereum) StopAutoDAG()
stopAutoDAG stops automatic DAG pregeneration by quitting the loop
func (*Ethereum) StopMining ¶
func (s *Ethereum) StopMining()
func (*Ethereum) WaitForShutdown ¶
func (s *Ethereum) WaitForShutdown()
This function will wait for a shutdown and resumes main thread execution
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 ¶
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 ¶
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 ¶
func (api *PrivateAdminAPI) ExportChain(file string) (bool, error)
ExportChain exports the current blockchain into a local file.
func (*PrivateAdminAPI) ImportChain ¶
func (api *PrivateAdminAPI) ImportChain(file string) (bool, error)
ImportChain imports a blockchain from a local file.
type PrivateDebugAPI ¶
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 ¶
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) Preimage ¶ added in v1.5.11
Preimage is a debug API function that returns the preimage for a sha3 hash, if known.
func (*PrivateDebugAPI) TraceBlock ¶
func (api *PrivateDebugAPI) TraceBlock(blockRlp []byte, config *vm.LogConfig) BlockTraceResult
TraceBlock processes the given block's RLP but does not import the block in to the chain.
func (*PrivateDebugAPI) TraceBlockByHash ¶
func (api *PrivateDebugAPI) TraceBlockByHash(hash common.Hash, config *vm.LogConfig) BlockTraceResult
TraceBlockByHash processes the block by hash.
func (*PrivateDebugAPI) TraceBlockByNumber ¶
func (api *PrivateDebugAPI) TraceBlockByNumber(number uint64, config *vm.LogConfig) BlockTraceResult
TraceBlockByNumber processes the block by canonical block number.
func (*PrivateDebugAPI) TraceBlockFromFile ¶
func (api *PrivateDebugAPI) TraceBlockFromFile(file string, config *vm.LogConfig) BlockTraceResult
TraceBlockFromFile loads the block's RLP from the given file name and attempts to process it but does not import the block in to the chain.
func (*PrivateDebugAPI) TraceTransaction ¶
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 ¶
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 ¶
func NewPrivateMinerAPI(e *Ethereum) *PrivateMinerAPI
NewPrivateMinerAPI create a new RPC service which controls the miner of this node.
func (*PrivateMinerAPI) MakeDAG ¶
func (s *PrivateMinerAPI) MakeDAG(blockNr rpc.BlockNumber) (bool, error)
MakeDAG creates the new DAG for the given block number
func (*PrivateMinerAPI) SetEtherbase ¶
func (s *PrivateMinerAPI) SetEtherbase(etherbase common.Address) bool
SetEtherbase sets the etherbase of the miner
func (*PrivateMinerAPI) SetExtra ¶
func (s *PrivateMinerAPI) SetExtra(extra string) (bool, error)
SetExtra sets the extra data string that is included when this miner mines a block.
func (*PrivateMinerAPI) SetGasPrice ¶
func (s *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool
SetGasPrice sets the minimum accepted gas price for the miner.
func (*PrivateMinerAPI) Start ¶
func (s *PrivateMinerAPI) Start(threads *int) (bool, 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 CPU's that are usable by this process.
func (*PrivateMinerAPI) StartAutoDAG ¶
func (s *PrivateMinerAPI) StartAutoDAG() bool
StartAutoDAG starts auto DAG generation. This will prevent the DAG generating on epoch change which will cause the node to stop mining during the generation process.
func (*PrivateMinerAPI) StopAutoDAG ¶
func (s *PrivateMinerAPI) StopAutoDAG() bool
StopAutoDAG stops auto DAG generation
type ProtocolManager ¶
type ProtocolManager struct { SubProtocols []p2p.Protocol // contains filtered or unexported fields }
func NewProtocolManager ¶
func NewProtocolManager(config *params.ChainConfig, fastSync bool, networkId int, maxPeers int, mux *event.TypeMux, txpool txPool, pow pow.PoW, 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 ¶
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 ¶
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 ¶
func NewPublicDebugAPI(eth *Ethereum) *PublicDebugAPI
NewPublicDebugAPI creates a new API definition for the full node- related public debug methods of the Ethereum service.
type PublicEthereumAPI ¶
type PublicEthereumAPI struct {
// contains filtered or unexported fields
}
PublicEthereumAPI provides an API to access Ethereum full node-related information.
func NewPublicEthereumAPI ¶
func NewPublicEthereumAPI(e *Ethereum) *PublicEthereumAPI
NewPublicEthereumAPI creates a new Etheruem protocol API for full nodes.
func (*PublicEthereumAPI) Coinbase ¶
func (s *PublicEthereumAPI) Coinbase() (common.Address, error)
Coinbase is the address that mining rewards will be send to (alias for Etherbase)
func (*PublicEthereumAPI) Etherbase ¶
func (s *PublicEthereumAPI) Etherbase() (common.Address, error)
Etherbase is the address that mining rewards will be send to
func (*PublicEthereumAPI) Hashrate ¶
func (s *PublicEthereumAPI) Hashrate() hexutil.Uint64
Hashrate returns the POW hashrate
type PublicMinerAPI ¶
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 ¶
func NewPublicMinerAPI(e *Ethereum) *PublicMinerAPI
NewPublicMinerAPI create a new PublicMinerAPI instance.
func (*PublicMinerAPI) GetWork ¶
func (s *PublicMinerAPI) GetWork() (work [3]string, err 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 ¶
func (s *PublicMinerAPI) Mining() bool
Mining returns an indication if this node is currently mining.
func (*PublicMinerAPI) SubmitHashrate ¶
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 ¶
func (s *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!
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. |