Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package eth implements the Ethereum protocol.
Index ¶
- Constants
 - Variables
 - func CreateConsensusEngine(ctx *node.ServiceContext, chainConfig *params.ChainConfig, ...) consensus.Engine
 - func NewBloomIndexer(db ethdb.Database, size, confirms uint64) *core.ChainIndexer
 - type AccountRangeResult
 - type BadBlockArgs
 - type BloomIndexer
 - type Config
 - type EthAPIBackend
 - func (b *EthAPIBackend) AccountManager() *accounts.Manager
 - func (b *EthAPIBackend) BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
 - func (b *EthAPIBackend) BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)
 - func (b *EthAPIBackend) BloomStatus() (uint64, uint64)
 - 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) ExtRPCEnabled() bool
 - func (b *EthAPIBackend) GetEVM(ctx context.Context, msg core.Message, state *state.StateDB, ...) (*vm.EVM, func() error, error)
 - func (b *EthAPIBackend) GetLogs(ctx context.Context, hash common.Hash) ([][]*types.Log, 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, hash common.Hash) (types.Receipts, error)
 - func (b *EthAPIBackend) GetTd(blockHash common.Hash) *big.Int
 - func (b *EthAPIBackend) GetTransaction(ctx context.Context, txHash common.Hash) (*types.Transaction, common.Hash, uint64, uint64, error)
 - func (b *EthAPIBackend) HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
 - func (b *EthAPIBackend) HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)
 - func (b *EthAPIBackend) ProtocolVersion() int
 - func (b *EthAPIBackend) RPCGasCap() *big.Int
 - func (b *EthAPIBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error
 - func (b *EthAPIBackend) ServiceFilter(ctx context.Context, session *bloombits.MatcherSession)
 - func (b *EthAPIBackend) SetHead(number uint64)
 - func (b *EthAPIBackend) StateAndHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*state.StateDB, *types.Header, error)
 - func (b *EthAPIBackend) Stats() (pending int, queued int)
 - func (b *EthAPIBackend) SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
 - func (b *EthAPIBackend) SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
 - func (b *EthAPIBackend) SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
 - func (b *EthAPIBackend) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
 - func (b *EthAPIBackend) SubscribeNewTxsEvent(ch chan<- core.NewTxsEvent) event.Subscription
 - func (b *EthAPIBackend) SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription
 - 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 Ethereum
 - func (s *Ethereum) APIs() []rpc.API
 - func (s *Ethereum) AccountManager() *accounts.Manager
 - func (s *Ethereum) AddLesServer(ls LesServer)
 - func (s *Ethereum) ArchiveMode() bool
 - 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 (s *Ethereum) SetContractBackend(backend bind.ContractBackend)
 - func (s *Ethereum) SetEtherbase(etherbase common.Address)
 - func (s *Ethereum) Start(srvr *p2p.Server) error
 - func (s *Ethereum) StartMining(threads int) error
 - func (s *Ethereum) Stop() error
 - func (s *Ethereum) StopMining()
 - func (s *Ethereum) Synced() bool
 - func (s *Ethereum) TxPool() *core.TxPool
 
- type LesServer
 - type NodeInfo
 - type PeerInfo
 - type PrivateAdminAPI
 - type PrivateDebugAPI
 - func (api *PrivateDebugAPI) AccountRange(ctx context.Context, start *common.Hash, maxResults int) (AccountRangeResult, error)
 - func (api *PrivateDebugAPI) GetBadBlocks(ctx context.Context) ([]*BadBlockArgs, error)
 - func (api *PrivateDebugAPI) GetModifiedAccountsByHash(startHash common.Hash, endHash *common.Hash) ([]common.Address, error)
 - func (api *PrivateDebugAPI) GetModifiedAccountsByNumber(startNum uint64, endNum *uint64) ([]common.Address, error)
 - func (api *PrivateDebugAPI) Preimage(ctx context.Context, hash common.Hash) (hexutil.Bytes, error)
 - func (api *PrivateDebugAPI) StandardTraceBadBlockToFile(ctx context.Context, hash common.Hash, config *StdTraceConfig) ([]string, error)
 - func (api *PrivateDebugAPI) StandardTraceBlockToFile(ctx context.Context, hash common.Hash, config *StdTraceConfig) ([]string, error)
 - func (api *PrivateDebugAPI) StorageRangeAt(ctx context.Context, blockHash common.Hash, txIndex int, ...) (StorageRangeResult, error)
 - func (api *PrivateDebugAPI) TraceBadBlock(ctx context.Context, hash common.Hash, config *TraceConfig) ([]*txTraceResult, error)
 - func (api *PrivateDebugAPI) TraceBlock(ctx context.Context, blob []byte, config *TraceConfig) ([]*txTraceResult, error)
 - func (api *PrivateDebugAPI) TraceBlockByHash(ctx context.Context, hash common.Hash, config *TraceConfig) ([]*txTraceResult, error)
 - func (api *PrivateDebugAPI) TraceBlockByNumber(ctx context.Context, number rpc.BlockNumber, config *TraceConfig) ([]*txTraceResult, error)
 - func (api *PrivateDebugAPI) TraceBlockFromFile(ctx context.Context, file string, config *TraceConfig) ([]*txTraceResult, error)
 - func (api *PrivateDebugAPI) TraceChain(ctx context.Context, start, end rpc.BlockNumber, config *TraceConfig) (*rpc.Subscription, error)
 - func (api *PrivateDebugAPI) TraceTransaction(ctx context.Context, hash common.Hash, config *TraceConfig) (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) SetRecommitInterval(interval int)
 - func (api *PrivateMinerAPI) Start(threads *int) error
 - func (api *PrivateMinerAPI) Stop()
 
- type ProtocolManager
 - type PublicDebugAPI
 - type PublicEthereumAPI
 - type PublicMinerAPI
 - type StdTraceConfig
 - type StorageRangeResult
 - type TraceConfig
 
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 AccountRangeMaxResults = 256
    AccountRangeMaxResults is the maximum number of results to be returned per call
Variables ¶
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.
var ProtocolVersions = []uint{eth63}
    ProtocolVersions are the supported versions of the eth protocol (first is primary).
Functions ¶
func CreateConsensusEngine ¶ added in v1.6.0
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 ¶ added in v1.7.0
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 ¶ added in v1.9.1
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 ¶ added in v1.8.11
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 ¶ added in v1.7.0
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 ¶ added in v1.7.0
func (b *BloomIndexer) Commit() error
Commit implements core.ChainIndexerBackend, finalizing the bloom section and writing it out into the database.
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
	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
}
    func (Config) MarshalTOML ¶ added in v1.6.0
MarshalTOML marshals as TOML.
func (*Config) UnmarshalTOML ¶ added in v1.6.0
UnmarshalTOML unmarshals from TOML.
type EthAPIBackend ¶ added in v1.8.8
type EthAPIBackend struct {
	// contains filtered or unexported fields
}
    EthAPIBackend implements ethapi.Backend for full nodes
func (*EthAPIBackend) AccountManager ¶ added in v1.8.8
func (b *EthAPIBackend) AccountManager() *accounts.Manager
func (*EthAPIBackend) BlockByHash ¶ added in v1.9.2
func (*EthAPIBackend) BlockByNumber ¶ added in v1.8.8
func (b *EthAPIBackend) BlockByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Block, error)
func (*EthAPIBackend) BloomStatus ¶ added in v1.8.8
func (b *EthAPIBackend) BloomStatus() (uint64, uint64)
func (*EthAPIBackend) ChainConfig ¶ added in v1.8.8
func (b *EthAPIBackend) ChainConfig() *params.ChainConfig
ChainConfig returns the active chain configuration.
func (*EthAPIBackend) ChainDb ¶ added in v1.8.8
func (b *EthAPIBackend) ChainDb() ethdb.Database
func (*EthAPIBackend) CurrentBlock ¶ added in v1.8.8
func (b *EthAPIBackend) CurrentBlock() *types.Block
func (*EthAPIBackend) Downloader ¶ added in v1.8.8
func (b *EthAPIBackend) Downloader() *downloader.Downloader
func (*EthAPIBackend) EventMux ¶ added in v1.8.8
func (b *EthAPIBackend) EventMux() *event.TypeMux
func (*EthAPIBackend) ExtRPCEnabled ¶ added in v1.9.0
func (b *EthAPIBackend) ExtRPCEnabled() bool
func (*EthAPIBackend) GetPoolNonce ¶ added in v1.8.8
func (*EthAPIBackend) GetPoolTransaction ¶ added in v1.8.8
func (b *EthAPIBackend) GetPoolTransaction(hash common.Hash) *types.Transaction
func (*EthAPIBackend) GetPoolTransactions ¶ added in v1.8.8
func (b *EthAPIBackend) GetPoolTransactions() (types.Transactions, error)
func (*EthAPIBackend) GetReceipts ¶ added in v1.8.8
func (*EthAPIBackend) GetTd ¶ added in v1.8.8
func (b *EthAPIBackend) GetTd(blockHash common.Hash) *big.Int
func (*EthAPIBackend) GetTransaction ¶ added in v1.9.0
func (*EthAPIBackend) HeaderByHash ¶ added in v1.8.13
func (*EthAPIBackend) HeaderByNumber ¶ added in v1.8.8
func (b *EthAPIBackend) HeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*types.Header, error)
func (*EthAPIBackend) ProtocolVersion ¶ added in v1.8.8
func (b *EthAPIBackend) ProtocolVersion() int
func (*EthAPIBackend) RPCGasCap ¶ added in v1.8.24
func (b *EthAPIBackend) RPCGasCap() *big.Int
func (*EthAPIBackend) SendTx ¶ added in v1.8.8
func (b *EthAPIBackend) SendTx(ctx context.Context, signedTx *types.Transaction) error
func (*EthAPIBackend) ServiceFilter ¶ added in v1.8.8
func (b *EthAPIBackend) ServiceFilter(ctx context.Context, session *bloombits.MatcherSession)
func (*EthAPIBackend) SetHead ¶ added in v1.8.8
func (b *EthAPIBackend) SetHead(number uint64)
func (*EthAPIBackend) StateAndHeaderByNumber ¶ added in v1.8.8
func (b *EthAPIBackend) StateAndHeaderByNumber(ctx context.Context, number rpc.BlockNumber) (*state.StateDB, *types.Header, error)
func (*EthAPIBackend) Stats ¶ added in v1.8.8
func (b *EthAPIBackend) Stats() (pending int, queued int)
func (*EthAPIBackend) SubscribeChainEvent ¶ added in v1.8.8
func (b *EthAPIBackend) SubscribeChainEvent(ch chan<- core.ChainEvent) event.Subscription
func (*EthAPIBackend) SubscribeChainHeadEvent ¶ added in v1.8.8
func (b *EthAPIBackend) SubscribeChainHeadEvent(ch chan<- core.ChainHeadEvent) event.Subscription
func (*EthAPIBackend) SubscribeChainSideEvent ¶ added in v1.8.8
func (b *EthAPIBackend) SubscribeChainSideEvent(ch chan<- core.ChainSideEvent) event.Subscription
func (*EthAPIBackend) SubscribeLogsEvent ¶ added in v1.8.8
func (b *EthAPIBackend) SubscribeLogsEvent(ch chan<- []*types.Log) event.Subscription
func (*EthAPIBackend) SubscribeNewTxsEvent ¶ added in v1.8.9
func (b *EthAPIBackend) SubscribeNewTxsEvent(ch chan<- core.NewTxsEvent) event.Subscription
func (*EthAPIBackend) SubscribeRemovedLogsEvent ¶ added in v1.8.8
func (b *EthAPIBackend) SubscribeRemovedLogsEvent(ch chan<- core.RemovedLogsEvent) event.Subscription
func (*EthAPIBackend) SuggestPrice ¶ added in v1.8.8
func (*EthAPIBackend) TxPoolContent ¶ added in v1.8.8
func (b *EthAPIBackend) TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)
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.0
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 ¶ added in v0.9.17
func (*Ethereum) AddLesServer ¶ added in v1.5.0
func (*Ethereum) ArchiveMode ¶ added in v1.9.0
func (*Ethereum) BlockChain ¶ added in v1.3.1
func (s *Ethereum) BlockChain() *core.BlockChain
func (*Ethereum) Downloader ¶ added in v0.9.17
func (s *Ethereum) Downloader() *downloader.Downloader
func (*Ethereum) EthVersion ¶ added in v0.9.17
func (*Ethereum) IsListening ¶
func (*Ethereum) NetVersion ¶ added in v0.9.17
func (*Ethereum) Protocols ¶ added in v1.4.0
Protocols implements node.Service, returning all the currently configured network protocols to start.
func (*Ethereum) ResetWithGenesisBlock ¶ added in v0.9.17
func (*Ethereum) SetContractBackend ¶ added in v1.9.0
func (s *Ethereum) SetContractBackend(backend bind.ContractBackend)
SetClient sets a rpc client which connecting to our local node.
func (*Ethereum) SetEtherbase ¶ added in v0.9.36
SetEtherbase sets the mining reward address.
func (*Ethereum) Start ¶
Start implements node.Service, starting all internal goroutines needed by the Ethereum protocol implementation.
func (*Ethereum) StartMining ¶ added in v0.9.17
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 ¶
Stop implements node.Service, terminating all internal goroutines used by the Ethereum protocol.
func (*Ethereum) StopMining ¶ added in v0.9.17
func (s *Ethereum) StopMining()
StopMining terminates the miner, both at the consensus engine level as well as at the block creation level.
type LesServer ¶ added in v1.5.0
type LesServer interface {
	Start(srvr *p2p.Server)
	Stop()
	APIs() []rpc.API
	Protocols() []p2p.Protocol
	SetBloomBitsIndexer(bbIndexer *core.ChainIndexer)
	SetContractBackend(bind.ContractBackend)
}
    type NodeInfo ¶ added in v0.9.17
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 ¶ added in v0.9.17
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.0
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 ¶ added in v1.4.0
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.0
func (api *PrivateAdminAPI) ExportChain(file string) (bool, error)
ExportChain exports the current blockchain into a local file.
func (*PrivateAdminAPI) ImportChain ¶ added in v1.4.0
func (api *PrivateAdminAPI) ImportChain(file string) (bool, error)
ImportChain imports a blockchain from a local file.
type PrivateDebugAPI ¶ added in v1.4.0
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 ¶ added in v1.4.0
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 ¶ added in v1.9.1
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 ¶ added in v1.6.0
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 ¶ added in v1.7.3
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 ¶ added in v1.7.3
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 ¶ added in v1.5.8
Preimage is a debug API function that returns the preimage for a sha3 hash, if known.
func (*PrivateDebugAPI) StandardTraceBadBlockToFile ¶ added in v1.8.20
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 ¶ added in v1.8.20
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 ¶ added in v1.6.1
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 ¶ added in v1.8.17
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 ¶ added in v1.4.0
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 ¶ added in v1.4.0
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 ¶ added in v1.4.0
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 ¶ added in v1.4.0
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 ¶ added in v1.8.0
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 ¶ added in v1.4.0
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 ¶ added in v1.4.0
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.0
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.0
func (api *PrivateMinerAPI) SetEtherbase(etherbase common.Address) bool
SetEtherbase sets the etherbase of the miner
func (*PrivateMinerAPI) SetExtra ¶ added in v1.4.0
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.0
func (api *PrivateMinerAPI) SetGasPrice(gasPrice hexutil.Big) bool
SetGasPrice sets the minimum accepted gas price for the miner.
func (*PrivateMinerAPI) SetRecommitInterval ¶ added in v1.8.14
func (api *PrivateMinerAPI) SetRecommitInterval(interval int)
SetRecommitInterval updates the interval for miner sealing work recommitting.
func (*PrivateMinerAPI) Start ¶ added in v1.4.0
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 ¶ added in v1.4.0
func (api *PrivateMinerAPI) Stop()
Stop terminates the miner, both at the consensus engine level as well as at the block creation level.
type ProtocolManager ¶ added in v0.9.17
type ProtocolManager struct {
	// contains filtered or unexported fields
}
    func NewProtocolManager ¶ added in v0.9.17
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 ¶ added in v0.9.17
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) BroadcastTxs ¶ added in v1.8.9
func (pm *ProtocolManager) BroadcastTxs(txs types.Transactions)
BroadcastTxs will propagate a batch of transactions to all peers which are not known to already have the given transaction.
func (*ProtocolManager) NodeInfo ¶ added in v1.3.2
func (pm *ProtocolManager) NodeInfo() *NodeInfo
NodeInfo retrieves some protocol metadata about the running host node.
func (*ProtocolManager) Start ¶ added in v0.9.17
func (pm *ProtocolManager) Start(maxPeers int)
func (*ProtocolManager) Stop ¶ added in v0.9.17
func (pm *ProtocolManager) Stop()
type PublicDebugAPI ¶ added in v1.4.0
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 ¶ added in v1.4.0
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.0
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.0
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.0
func NewPublicEthereumAPI(e *Ethereum) *PublicEthereumAPI
NewPublicEthereumAPI creates a new Ethereum protocol API for full nodes.
func (*PublicEthereumAPI) ChainId ¶ added in v1.8.17
func (api *PublicEthereumAPI) ChainId() hexutil.Uint64
ChainId is the EIP-155 replay-protection chain id for the current ethereum chain config.
func (*PublicEthereumAPI) Coinbase ¶ added in v1.4.0
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.0
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.0
func (api *PublicEthereumAPI) Hashrate() hexutil.Uint64
Hashrate returns the POW hashrate
type PublicMinerAPI ¶ added in v1.4.0
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.0
func NewPublicMinerAPI(e *Ethereum) *PublicMinerAPI
NewPublicMinerAPI create a new PublicMinerAPI instance.
func (*PublicMinerAPI) Mining ¶ added in v1.4.0
func (api *PublicMinerAPI) Mining() bool
Mining returns an indication if this node is currently mining.
type StdTraceConfig ¶ added in v1.8.20
StdTraceConfig holds extra parameters to standard-json trace functions.
type StorageRangeResult ¶ added in v1.6.1
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. | 
| 
       Package tracers is a collection of JavaScript transaction tracers. 
         | 
      Package tracers is a collection of JavaScript transaction tracers. | 
| 
         
          
            internal/tracers
            
            
          
           
      Package tracers contains the actual JavaScript tracer assets. 
         | 
      Package tracers contains the actual JavaScript tracer assets. |