eth

Documentation

Overview

Package eth implements the Ethereum protocol.

Index

• func RemoveContents(dir string) error
• type Config
• type Ethereum
  • func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error)
  • func (s *Ethereum) APIs() []rpc.API
  • func (s *Ethereum) ChainConfig() *chain.Config
  • func (s *Ethereum) ChainDB() kv.RwDB
  • func (s *Ethereum) ChainKV() kv.RwDB
  • func (s *Ethereum) Etherbase() (eb libcommon.Address, err error)
  • func (backend *Ethereum) Init(stack *node.Node, config *ethconfig.Config) error
  • func (s *Ethereum) IsMining() bool
  • func (s *Ethereum) NetPeerCount() (uint64, error)
  • func (s *Ethereum) NetVersion() (uint64, error)
  • func (s *Ethereum) NodesInfo(limit int) (*remote.NodesInfoReply, error)
  • func (s *Ethereum) Notifications() *shards.Notifications
  • func (s *Ethereum) Peers(ctx context.Context) (*remote.PeersReply, error)
  • func (s *Ethereum) Protocols() []p2p.Protocol
  • func (s *Ethereum) SentryControlServer() *sentry.MultiClient
  • func (s *Ethereum) SentryCtx() context.Context
  • func (s *Ethereum) StagedSync() *sync_stages.Sync
  • func (s *Ethereum) Start() error
  • func (s *Ethereum) StartMining(ctx context.Context, db kv.RwDB, mining *sync_stages.Sync, ...) error
  • func (s *Ethereum) Stop() error

Functions

func RemoveContents

func RemoveContents(dir string) error

RemoveContents is like os.RemoveAll, but preserve dir itself

Types

type Config

type Config = ethconfig.Config

Config contains the configuration options of the ETH protocol. Deprecated: use ethconfig.Config instead.

type Ethereum

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

Ethereum implements the Ethereum full node service.

func New

func New(stack *node.Node, config *ethconfig.Config) (*Ethereum, error)

New creates a new Ethereum object (including the initialisation of the common Ethereum object)

func (*Ethereum) APIs

func (s *Ethereum) APIs() []rpc.API

func (*Ethereum) ChainConfig

func (s *Ethereum) ChainConfig() *chain.Config

func (*Ethereum) ChainDB

func (s *Ethereum) ChainDB() kv.RwDB

func (*Ethereum) ChainKV

func (s *Ethereum) ChainKV() kv.RwDB

func (*Ethereum) Etherbase

func (s *Ethereum) Etherbase() (eb libcommon.Address, err error)

func (*Ethereum) Init

func (backend *Ethereum) Init(stack *node.Node, config *ethconfig.Config) error

func (*Ethereum) IsMining

func (s *Ethereum) IsMining() bool

func (*Ethereum) NetPeerCount

func (s *Ethereum) NetPeerCount() (uint64, error)

func (*Ethereum) NetVersion

func (s *Ethereum) NetVersion() (uint64, error)

func (*Ethereum) NodesInfo

func (s *Ethereum) NodesInfo(limit int) (*remote.NodesInfoReply, error)

func (*Ethereum) Notifications

func (s *Ethereum) Notifications() *shards.Notifications

func (*Ethereum) Peers

func (s *Ethereum) Peers(ctx context.Context) (*remote.PeersReply, error)

func (*Ethereum) Protocols

func (s *Ethereum) Protocols() []p2p.Protocol

Protocols returns all the currently configured network protocols to start.

func (*Ethereum) SentryControlServer

func (s *Ethereum) SentryControlServer() *sentry.MultiClient

func (*Ethereum) SentryCtx

func (s *Ethereum) SentryCtx() context.Context

func (*Ethereum) StagedSync

func (s *Ethereum) StagedSync() *sync_stages.Sync

func (*Ethereum) Start

func (s *Ethereum) Start() error

Start implements node.Lifecycle, starting all internal goroutines needed by the Ethereum protocol implementation.

func (*Ethereum) StartMining

func (s *Ethereum) StartMining(ctx context.Context, db kv.RwDB, mining *sync_stages.Sync, cfg params.MiningConfig, gasPrice *uint256.Int, quitCh chan struct{}, tmpDir string) error

StartMining starts the miner with the given number of CPU threads. If mining is already running, this method adjust the number of threads allowed to use and updates the minimum price required by the transaction pool.

func (*Ethereum) Stop

func (s *Ethereum) Stop() error

Stop implements node.Service, terminating all internal goroutines used by the Ethereum protocol.