Documentation

Overview

    Package eth implements the Ethereum protocol.

    Index

    Constants

    View Source
    const (
    	StatusMsg          = 0x00
    	NewBlockHashesMsg  = 0x01
    	TransactionMsg     = 0x02
    	GetBlockHeadersMsg = 0x03
    	BlockHeadersMsg    = 0x04
    	GetBlockBodiesMsg  = 0x05
    	BlockBodiesMsg     = 0x06
    	NewBlockMsg        = 0x07
    	GetNodeDataMsg     = 0x0d
    	NodeDataMsg        = 0x0e
    	GetReceiptsMsg     = 0x0f
    	ReceiptsMsg        = 0x10
    
    	// New protocol message codes introduced in eth65
    	//
    	// Previously these message ids were used by some legacy and unsupported
    	// eth protocols, reown them here.
    	NewPooledTransactionHashesMsg = 0x08
    	GetPooledTransactionsMsg      = 0x09
    	PooledTransactionsMsg         = 0x0a
    )

      eth protocol message codes

      View Source
      const (
      	ErrMsgTooLarge = iota
      	ErrDecode
      	ErrInvalidMsgCode
      	ErrProtocolVersionMismatch
      	ErrNetworkIDMismatch
      	ErrGenesisMismatch
      	ErrForkIDRejected
      	ErrNoStatusMsg
      	ErrExtraStatusMsg
      )
      View Source
      const AccountRangeMaxResults = 256

        AccountRangeMaxResults is the maximum number of results to be returned per call

        Variables

        View Source
        var DefaultConfig = Config{
        	SyncMode: downloader.FastSync,
        	Ethash: ethash.Config{
        		CacheDir:       "ethash",
        		CachesInMem:    2,
        		CachesOnDisk:   3,
        		DatasetsInMem:  1,
        		DatasetsOnDisk: 2,
        	},
        	NetworkId:          1,
        	LightPeers:         100,
        	UltraLightFraction: 75,
        	DatabaseCache:      512,
        	TrieCleanCache:     256,
        	TrieDirtyCache:     256,
        	TrieTimeout:        60 * time.Minute,
        	Miner: miner.Config{
        		GasFloor: 8000000,
        		GasCeil:  8000000,
        		GasPrice: big.NewInt(params.GWei),
        		Recommit: 3 * time.Second,
        	},
        	TxPool: core.DefaultTxPoolConfig,
        	GPO: gasprice.Config{
        		Blocks:     20,
        		Percentile: 60,
        	},
        }

          DefaultConfig contains default settings for use on the Ethereum main net.

          View Source
          var ProtocolVersions = []uint{eth65, eth64, eth63}

            ProtocolVersions are the supported versions of the eth protocol (first is primary).

            Functions

            func CreateConsensusEngine

            func CreateConsensusEngine(ctx *node.ServiceContext, chainConfig *params.ChainConfig, config *ethash.Config, notify []string, noverify bool, db ethdb.Database) consensus.Engine

              CreateConsensusEngine creates the required type of consensus engine instance for an Ethereum service

              func NewBloomIndexer

              func NewBloomIndexer(db ethdb.Database, size, confirms uint64) *core.ChainIndexer

                NewBloomIndexer returns a chain indexer that generates bloom bits data for the canonical chain for fast logs filtering.

                Types

                type AccountRangeResult

                type AccountRangeResult struct {
                	Accounts map[common.Hash]*common.Address `json:"accounts"`
                	Next     common.Hash                     `json:"next"`
                }

                  AccountRangeResult returns a mapping from the hash of an account addresses to its preimage. It will return the JSON null if no preimage is found. Since a query can return a limited amount of results, a "next" field is also present for paging.

                  type BadBlockArgs

                  type BadBlockArgs struct {
                  	Hash  common.Hash            `json:"hash"`
                  	Block map[string]interface{} `json:"block"`
                  	RLP   string                 `json:"rlp"`
                  }

                    BadBlockArgs represents the entries in the list returned when bad blocks are queried.

                    type BloomIndexer

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

                      BloomIndexer implements a core.ChainIndexer, building up a rotated bloom bits index for the Ethereum header bloom filters, permitting blazing fast filtering.

                      func (*BloomIndexer) Commit

                      func (b *BloomIndexer) Commit() error

                        Commit implements core.ChainIndexerBackend, finalizing the bloom section and writing it out into the database.

                        func (*BloomIndexer) Process

                        func (b *BloomIndexer) Process(ctx context.Context, header *types.Header) error

                          Process implements core.ChainIndexerBackend, adding a new header's bloom into the index.

                          func (*BloomIndexer) Reset

                          func (b *BloomIndexer) Reset(ctx context.Context, section uint64, lastSectionHead common.Hash) error

                            Reset implements core.ChainIndexerBackend, starting a new bloombits index section.

                            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
                            
                            	// This can be set to list of enrtree:// URLs which will be queried for
                            	// for nodes to connect to.
                            	DiscoveryURLs []string
                            
                            	NoPruning  bool // Whether to disable pruning and flush everything to disk
                            	NoPrefetch bool // Whether to disable prefetching and only load state on demand
                            
                            	// Whitelist of required block number -> hash values to accept
                            	Whitelist map[uint64]common.Hash `toml:"-"`
                            
                            	// Light client options
                            	LightServ    int `toml:",omitempty"` // Maximum percentage of time allowed for serving LES requests
                            	LightIngress int `toml:",omitempty"` // Incoming bandwidth limit for light servers
                            	LightEgress  int `toml:",omitempty"` // Outgoing bandwidth limit for light servers
                            	LightPeers   int `toml:",omitempty"` // Maximum number of LES client peers
                            
                            	// Ultra Light client options
                            	UltraLightServers      []string `toml:",omitempty"` // List of trusted ultra light servers
                            	UltraLightFraction     int      `toml:",omitempty"` // Percentage of trusted servers to accept an announcement
                            	UltraLightOnlyAnnounce bool     `toml:",omitempty"` // Whether to only announce headers, or also serve them
                            
                            	// Database options
                            	SkipBcVersionCheck bool `toml:"-"`
                            	DatabaseHandles    int  `toml:"-"`
                            	DatabaseCache      int
                            	DatabaseFreezer    string
                            
                            	TrieCleanCache int
                            	TrieDirtyCache int
                            	TrieTimeout    time.Duration
                            
                            	// Mining options
                            	Miner miner.Config
                            
                            	// Ethash options
                            	Ethash ethash.Config
                            
                            	// 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:"-"`
                            
                            	// Type of the EWASM interpreter ("" for default)
                            	EWASMInterpreter string
                            
                            	// Type of the EVM interpreter ("" for default)
                            	EVMInterpreter string
                            
                            	// RPCGasCap is the global gas cap for eth-call variants.
                            	RPCGasCap *big.Int `toml:",omitempty"`
                            
                            	// Checkpoint is a hardcoded checkpoint which can be nil.
                            	Checkpoint *params.TrustedCheckpoint `toml:",omitempty"`
                            
                            	// CheckpointOracle is the configuration for checkpoint oracle.
                            	CheckpointOracle *params.CheckpointOracleConfig `toml:",omitempty"`
                            
                            	// Istanbul block override (TODO: remove after the fork)
                            	OverrideIstanbul *big.Int `toml:",omitempty"`
                            
                            	// MuirGlacier block override (TODO: remove after the fork)
                            	OverrideMuirGlacier *big.Int `toml:",omitempty"`
                            }

                            func (Config) MarshalTOML

                            func (c Config) MarshalTOML() (interface{}, error)

                              MarshalTOML marshals as TOML.

                              func (*Config) UnmarshalTOML

                              func (c *Config) UnmarshalTOML(unmarshal func(interface{}) error) error

                                UnmarshalTOML unmarshals from TOML.

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

                                  func (b *EthAPIBackend) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)

                                  func (*EthAPIBackend) BlockByNumber

                                  func (b *EthAPIBackend) BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)

                                  func (*EthAPIBackend) BlockByNumberOrHash

                                  func (b *EthAPIBackend) BlockByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Block, error)

                                  func (*EthAPIBackend) BloomStatus

                                  func (b *EthAPIBackend) BloomStatus() (uint64, uint64)

                                  func (*EthAPIBackend) ChainConfig

                                  func (b *EthAPIBackend) ChainConfig() *params.ChainConfig

                                    ChainConfig returns the active chain configuration.

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

                                    func (b *EthAPIBackend) ExtRPCEnabled() bool

                                    func (*EthAPIBackend) GetEVM

                                    func (b *EthAPIBackend) GetEVM(ctx context.Context, msg core.Message, state *state.StateDB, header *types.Header) (*vm.EVM, func() error, error)

                                    func (*EthAPIBackend) GetLogs

                                    func (b *EthAPIBackend) GetLogs(ctx context.Context, hash common.Hash) ([][]*types.Log, error)

                                    func (*EthAPIBackend) GetPoolNonce

                                    func (b *EthAPIBackend) GetPoolNonce(ctx context.Context, addr common.Address) (uint64, error)

                                    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 (b *EthAPIBackend) GetReceipts(ctx context.Context, hash common.Hash) (types.Receipts, error)

                                    func (*EthAPIBackend) GetTd

                                    func (b *EthAPIBackend) GetTd(blockHash common.Hash) *big.Int

                                    func (*EthAPIBackend) GetTransaction

                                    func (b *EthAPIBackend) GetTransaction(ctx context.Context, txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, error)

                                    func (*EthAPIBackend) HeaderByHash

                                    func (b *EthAPIBackend) HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)

                                    func (*EthAPIBackend) HeaderByNumber

                                    func (b *EthAPIBackend) HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)

                                    func (*EthAPIBackend) HeaderByNumberOrHash

                                    func (b *EthAPIBackend) HeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*types.Header, error)

                                    func (*EthAPIBackend) ProtocolVersion

                                    func (b *EthAPIBackend) ProtocolVersion() int

                                    func (*EthAPIBackend) RPCGasCap

                                    func (b *EthAPIBackend) RPCGasCap() *big.Int

                                    func (*EthAPIBackend) SendTx

                                    func (b *EthAPIBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error

                                    func (*EthAPIBackend) ServiceFilter

                                    func (b *EthAPIBackend) ServiceFilter(ctx context.Context, session *bloombits.MatcherSession)

                                    func (*EthAPIBackend) SetHead

                                    func (b *EthAPIBackend) SetHead(number uint64)

                                    func (*EthAPIBackend) StateAndHeaderByNumber

                                    func (b *EthAPIBackend) StateAndHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*state.StateDB, *types.Header, error)

                                    func (*EthAPIBackend) StateAndHeaderByNumberOrHash

                                    func (b *EthAPIBackend) StateAndHeaderByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*state.StateDB, *types.Header, error)

                                    func (*EthAPIBackend) Stats

                                    func (b *EthAPIBackend) Stats() (pending int, queued int)

                                    func (*EthAPIBackend) SubscribeChainEvent

                                    func (b *EthAPIBackend) SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription

                                    func (*EthAPIBackend) SubscribeChainHeadEvent

                                    func (b *EthAPIBackend) SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription

                                    func (*EthAPIBackend) SubscribeChainSideEvent

                                    func (b *EthAPIBackend) SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription

                                    func (*EthAPIBackend) SubscribeLogsEvent

                                    func (b *EthAPIBackend) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription

                                    func (*EthAPIBackend) SubscribeNewTxsEvent

                                    func (b *EthAPIBackend) SubscribeNewTxsEvent(ch chan<- core.NewTxsEvent) event.Subscription

                                    func (*EthAPIBackend) SubscribePendingLogsEvent

                                    func (b *EthAPIBackend) SubscribePendingLogsEvent(ch chan<- []*types.Log) event.Subscription

                                    func (*EthAPIBackend) SubscribeRemovedLogsEvent

                                    func (b *EthAPIBackend) SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription

                                    func (*EthAPIBackend) SuggestPrice

                                    func (b *EthAPIBackend) SuggestPrice(ctx context.Context) (*big.Int, error)

                                    func (*EthAPIBackend) TxPoolContent

                                    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

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

                                          APIs return 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 (s *Ethereum) AccountManager() *accounts.Manager

                                          func (*Ethereum) AddLesServer

                                          func (s *Ethereum) AddLesServer(ls LesServer)

                                          func (*Ethereum) ArchiveMode

                                          func (s *Ethereum) ArchiveMode() bool

                                          func (*Ethereum) BlockChain

                                          func (s *Ethereum) BlockChain() *core.BlockChain

                                          func (*Ethereum) ChainDb

                                          func (s *Ethereum) ChainDb() ethdb.Database

                                          func (*Ethereum) Downloader

                                          func (s *Ethereum) Downloader() *downloader.Downloader

                                          func (*Ethereum) Engine

                                          func (s *Ethereum) Engine() consensus.Engine

                                          func (*Ethereum) EthVersion

                                          func (s *Ethereum) EthVersion() int

                                          func (*Ethereum) Etherbase

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

                                          func (*Ethereum) EventMux

                                          func (s *Ethereum) EventMux() *event.TypeMux

                                          func (*Ethereum) IsListening

                                          func (s *Ethereum) IsListening() bool

                                          func (*Ethereum) IsMining

                                          func (s *Ethereum) IsMining() bool

                                          func (*Ethereum) Miner

                                          func (s *Ethereum) Miner() *miner.Miner

                                          func (*Ethereum) NetVersion

                                          func (s *Ethereum) NetVersion() uint64

                                          func (*Ethereum) Protocols

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

                                            Protocols implements node.Service, returning all the currently configured network protocols to start.

                                            func (*Ethereum) ResetWithGenesisBlock

                                            func (s *Ethereum) ResetWithGenesisBlock(gb *types.Block)

                                            func (*Ethereum) SetContractBackend

                                            func (s *Ethereum) SetContractBackend(backend bind.ContractBackend)

                                              SetClient sets a rpc client which connecting to our local node.

                                              func (*Ethereum) SetEtherbase

                                              func (s *Ethereum) SetEtherbase(etherbase common.Address)

                                                SetEtherbase sets the mining reward address.

                                                func (*Ethereum) Start

                                                func (s *Ethereum) Start(srvr *p2p.Server) error

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

                                                  func (*Ethereum) StartMining

                                                  func (s *Ethereum) StartMining(threads int) 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.

                                                      func (*Ethereum) StopMining

                                                      func (s *Ethereum) StopMining()

                                                        StopMining terminates the miner, both at the consensus engine level as well as at the block creation level.

                                                        func (*Ethereum) Synced

                                                        func (s *Ethereum) Synced() bool

                                                        func (*Ethereum) TxPool

                                                        func (s *Ethereum) TxPool() *core.TxPool

                                                        type LesServer

                                                        type LesServer interface {
                                                        	Start(srvr *p2p.Server)
                                                        	Stop()
                                                        	APIs() []rpc.API
                                                        	Protocols() []p2p.Protocol
                                                        	SetBloomBitsIndexer(bbIndexer *core.ChainIndexer)
                                                        	SetContractBackend(bind.ContractBackend)
                                                        }

                                                        type NodeInfo

                                                        type NodeInfo struct {
                                                        	Network    uint64              `json:"network"`    // Ethereum network ID (1=Frontier, 2=Morden, Ropsten=3, Rinkeby=4)
                                                        	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
                                                        	Config     *params.ChainConfig `json:"config"`     // Chain configuration for the fork rules
                                                        	Head       common.Hash         `json:"head"`       // SHA3 hash of the host's best owned block
                                                        }

                                                          NodeInfo represents a short summary of the Ethereum sub-protocol metadata known about the host peer.

                                                          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 Ethereum 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, first *uint64, last *uint64) (bool, error)

                                                                  ExportChain exports the current blockchain into a local file, or a range of blocks if first and last are non-nil

                                                                  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 Ethereum full node APIs exposed over the private debugging endpoint.

                                                                      func NewPrivateDebugAPI

                                                                      func NewPrivateDebugAPI(eth *Ethereum) *PrivateDebugAPI

                                                                        NewPrivateDebugAPI creates a new API definition for the full node-related private debug methods of the Ethereum service.

                                                                        func (*PrivateDebugAPI) AccountRange

                                                                        func (api *PrivateDebugAPI) AccountRange(ctx context.Context, start *common.Hash, maxResults int) (AccountRangeResult, error)

                                                                          AccountRange enumerates all accounts in the latest state

                                                                          func (*PrivateDebugAPI) GetBadBlocks

                                                                          func (api *PrivateDebugAPI) GetBadBlocks(ctx context.Context) ([]*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) GetModifiedAccountsByHash

                                                                            func (api *PrivateDebugAPI) GetModifiedAccountsByHash(startHash common.Hash, endHash *common.Hash) ([]common.Address, error)

                                                                              GetModifiedAccountsByHash returns all accounts that have changed between the two blocks specified. A change is defined as a difference in nonce, balance, code hash, or storage hash.

                                                                              With one parameter, returns the list of accounts modified in the specified block.

                                                                              func (*PrivateDebugAPI) GetModifiedAccountsByNumber

                                                                              func (api *PrivateDebugAPI) GetModifiedAccountsByNumber(startNum uint64, endNum *uint64) ([]common.Address, error)

                                                                                GetModifiedAccountsByNumber returns all accounts that have changed between the two blocks specified. A change is defined as a difference in nonce, balance, code hash, or storage hash.

                                                                                With one parameter, returns the list of accounts modified in the specified block.

                                                                                func (*PrivateDebugAPI) Preimage

                                                                                func (api *PrivateDebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, error)

                                                                                  Preimage is a debug API function that returns the preimage for a sha3 hash, if known.

                                                                                  func (*PrivateDebugAPI) StandardTraceBadBlockToFile

                                                                                  func (api *PrivateDebugAPI) StandardTraceBadBlockToFile(ctx context.Context, hash common.Hash, config *StdTraceConfig) ([]string, error)

                                                                                    StandardTraceBadBlockToFile dumps the structured logs created during the execution of EVM against a block pulled from the pool of bad ones to the local file system and returns a list of files to the caller.

                                                                                    func (*PrivateDebugAPI) StandardTraceBlockToFile

                                                                                    func (api *PrivateDebugAPI) StandardTraceBlockToFile(ctx context.Context, hash common.Hash, config *StdTraceConfig) ([]string, error)

                                                                                      StandardTraceBlockToFile dumps the structured logs created during the execution of EVM to the local file system and returns a list of files to the caller.

                                                                                      func (*PrivateDebugAPI) StorageRangeAt

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

                                                                                        func (api *PrivateDebugAPI) TraceBadBlock(ctx context.Context, hash common.Hash, config *TraceConfig) ([]*txTraceResult, error)

                                                                                          TraceBadBlockByHash returns the structured logs created during the execution of EVM against a block pulled from the pool of bad ones and returns them as a JSON object.

                                                                                          func (*PrivateDebugAPI) TraceBlock

                                                                                          func (api *PrivateDebugAPI) TraceBlock(ctx context.Context, blob []byte, config *TraceConfig) ([]*txTraceResult, error)

                                                                                            TraceBlock returns the structured logs created during the execution of EVM and returns them as a JSON object.

                                                                                            func (*PrivateDebugAPI) TraceBlockByHash

                                                                                            func (api *PrivateDebugAPI) TraceBlockByHash(ctx context.Context, hash common.Hash, config *TraceConfig) ([]*txTraceResult, error)

                                                                                              TraceBlockByHash returns the structured logs created during the execution of EVM and returns them as a JSON object.

                                                                                              func (*PrivateDebugAPI) TraceBlockByNumber

                                                                                              func (api *PrivateDebugAPI) TraceBlockByNumber(ctx context.Context, number rpc.BlockNumber, config *TraceConfig) ([]*txTraceResult, error)

                                                                                                TraceBlockByNumber returns the structured logs created during the execution of EVM and returns them as a JSON object.

                                                                                                func (*PrivateDebugAPI) TraceBlockFromFile

                                                                                                func (api *PrivateDebugAPI) TraceBlockFromFile(ctx context.Context, file string, config *TraceConfig) ([]*txTraceResult, error)

                                                                                                  TraceBlockFromFile returns the structured logs created during the execution of EVM and returns them as a JSON object.

                                                                                                  func (*PrivateDebugAPI) TraceChain

                                                                                                  func (api *PrivateDebugAPI) TraceChain(ctx context.Context, start, end rpc.BlockNumber, config *TraceConfig) (*rpc.Subscription, error)

                                                                                                    TraceChain returns the structured logs created during the execution of EVM between two blocks (excluding start) and returns them as a JSON object.

                                                                                                    func (*PrivateDebugAPI) TraceTransaction

                                                                                                    func (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, hash common.Hash, config *TraceConfig) (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) GetHashrate

                                                                                                          func (api *PrivateMinerAPI) GetHashrate() uint64

                                                                                                            GetHashrate returns the current hashrate of the miner.

                                                                                                            func (*PrivateMinerAPI) SetEtherbase

                                                                                                            func (api *PrivateMinerAPI) SetEtherbase(etherbase common.Address) bool

                                                                                                              SetEtherbase sets the etherbase of the miner

                                                                                                              func (*PrivateMinerAPI) SetExtra

                                                                                                              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

                                                                                                                func (api *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool

                                                                                                                  SetGasPrice sets the minimum accepted gas price for the miner.

                                                                                                                  func (*PrivateMinerAPI) SetRecommitInterval

                                                                                                                  func (api *PrivateMinerAPI) SetRecommitInterval(interval int)

                                                                                                                    SetRecommitInterval updates the interval for miner sealing work recommitting.

                                                                                                                    func (*PrivateMinerAPI) Start

                                                                                                                    func (api *PrivateMinerAPI) Start(threads *int) error

                                                                                                                      Start starts 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 and updates the minimum price required by the transaction pool.

                                                                                                                      func (*PrivateMinerAPI) Stop

                                                                                                                      func (api *PrivateMinerAPI) Stop()

                                                                                                                        Stop terminates the miner, both at the consensus engine level as well as at the block creation level.

                                                                                                                        type ProtocolManager

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

                                                                                                                        func NewProtocolManager

                                                                                                                        func NewProtocolManager(config *params.ChainConfig, checkpoint *params.TrustedCheckpoint, mode downloader.SyncMode, networkID uint64, mux *event.TypeMux, txpool txPool, engine consensus.Engine, blockchain *core.BlockChain, chaindb ethdb.Database, cacheLimit int, whitelist map[uint64]common.Hash) (*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 its peers, or will only announce its availability (depending what's requested).

                                                                                                                            func (*ProtocolManager) BroadcastTransactions

                                                                                                                            func (pm *ProtocolManager) BroadcastTransactions(txs types.Transactions, propagate bool)

                                                                                                                              BroadcastTransactions will propagate a batch of transactions to all peers which are not known to already have the given transaction.

                                                                                                                              func (*ProtocolManager) NodeInfo

                                                                                                                              func (pm *ProtocolManager) NodeInfo() *NodeInfo

                                                                                                                                NodeInfo retrieves some protocol metadata about the running host node.

                                                                                                                                func (*ProtocolManager) Start

                                                                                                                                func (pm *ProtocolManager) Start(maxPeers int)

                                                                                                                                func (*ProtocolManager) Stop

                                                                                                                                func (pm *ProtocolManager) Stop()

                                                                                                                                type PublicDebugAPI

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

                                                                                                                                  PublicDebugAPI is the collection of Ethereum 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.

                                                                                                                                    func (*PublicDebugAPI) DumpBlock

                                                                                                                                    func (api *PublicDebugAPI) DumpBlock(blockNr rpc.BlockNumber) (state.Dump, error)

                                                                                                                                      DumpBlock retrieves the entire state of the database at a given block.

                                                                                                                                      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 Ethereum protocol API for full nodes.

                                                                                                                                          func (*PublicEthereumAPI) ChainId

                                                                                                                                          func (api *PublicEthereumAPI) ChainId() hexutil.Uint64

                                                                                                                                            ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.

                                                                                                                                            func (*PublicEthereumAPI) Coinbase

                                                                                                                                            func (api *PublicEthereumAPI) Coinbase() (common.Address, error)

                                                                                                                                              Coinbase is the address that mining rewards will be send to (alias for Etherbase)

                                                                                                                                              func (*PublicEthereumAPI) Etherbase

                                                                                                                                              func (api *PublicEthereumAPI) Etherbase() (common.Address, error)

                                                                                                                                                Etherbase is the address that mining rewards will be send to

                                                                                                                                                func (*PublicEthereumAPI) Hashrate

                                                                                                                                                func (api *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) Mining

                                                                                                                                                      func (api *PublicMinerAPI) Mining() bool

                                                                                                                                                        Mining returns an indication if this node is currently mining.

                                                                                                                                                        type StdTraceConfig

                                                                                                                                                        type StdTraceConfig struct {
                                                                                                                                                        	*vm.LogConfig
                                                                                                                                                        	Reexec *uint64
                                                                                                                                                        	TxHash common.Hash
                                                                                                                                                        }

                                                                                                                                                          StdTraceConfig holds extra parameters to standard-json trace functions.

                                                                                                                                                          type StorageRangeResult

                                                                                                                                                          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.

                                                                                                                                                            type TraceConfig

                                                                                                                                                            type TraceConfig struct {
                                                                                                                                                            	*vm.LogConfig
                                                                                                                                                            	Tracer  *string
                                                                                                                                                            	Timeout *string
                                                                                                                                                            	Reexec  *uint64
                                                                                                                                                            }

                                                                                                                                                              TraceConfig holds extra parameters to trace functions.

                                                                                                                                                              Directories

                                                                                                                                                              Path Synopsis
                                                                                                                                                              Package downloader contains the manual full chain synchronisation.
                                                                                                                                                              Package downloader contains the manual full chain synchronisation.
                                                                                                                                                              Package fetcher contains the announcement based blocks or transaction synchronisation.
                                                                                                                                                              Package fetcher contains the announcement based blocks or transaction 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.
                                                                                                                                                              Package tracers is a collection of JavaScript transaction tracers.
                                                                                                                                                              Package tracers is a collection of JavaScript transaction tracers.