eth

package
v0.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 1, 2023 License: GPL-3.0 Imports: 51 Imported by: 1

Documentation

Overview

Package eth implements the Ethereum protocol.

Index

Constants

View Source 
const AccountRangeMaxResults = 256

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

Variables

This section is empty.

Functions

This section is empty.

Types

type AdminAPI 

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

AdminAPI is the collection of Ethereum full node related APIs for node administration.

func NewAdminAPI 

func NewAdminAPI(eth *Ethereum) *AdminAPI

NewAdminAPI creates a new instance of AdminAPI.

func (*AdminAPI) ExportChain 

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

func (api *AdminAPI) ImportChain(file string) (bool, error)

ImportChain imports a blockchain from a local file.

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 Config 

type Config = ethconfig.Config

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

type DebugAPI 

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

DebugAPI is the collection of Ethereum full node APIs for debugging the protocol.

func NewDebugAPI 

func NewDebugAPI(eth *Ethereum) *DebugAPI

NewDebugAPI creates a new DebugAPI instance.

func (*DebugAPI) AccountRange 

func (api *DebugAPI) AccountRange(blockNrOrHash rpc.BlockNumberOrHash, start hexutil.Bytes, maxResults int, nocode, nostorage, incompletes bool) (state.IteratorDump, error)

AccountRange enumerates all accounts in the given block and start point in paging request

func (*DebugAPI) DumpBlock 

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

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

func (*DebugAPI) GetAccessibleState 

func (api *DebugAPI) GetAccessibleState(from, to rpc.BlockNumber) (uint64, error)

GetAccessibleState returns the first number where the node has accessible state on disk. Note this being the post-state of that block and the pre-state of the next block. The (from, to) parameters are the sequence of blocks to search, which can go either forwards or backwards

func (*DebugAPI) GetBadBlocks 

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

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

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

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

func (api *DebugAPI) SetTrieFlushInterval(interval string) error

SetTrieFlushInterval configures how often in-memory tries are persisted to disk. The value is in terms of block processing time, not wall clock.

func (*DebugAPI) StorageRangeAt 

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

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.Header

func (*EthAPIBackend) CurrentHeader 

func (b *EthAPIBackend) CurrentHeader() *types.Header

func (*EthAPIBackend) Engine 

func (b *EthAPIBackend) Engine() consensus.Engine

func (*EthAPIBackend) EventMux 

func (b *EthAPIBackend) EventMux() *event.TypeMux

func (*EthAPIBackend) ExtRPCEnabled 

func (b *EthAPIBackend) ExtRPCEnabled() bool

func (*EthAPIBackend) FeeHistory 

func (b *EthAPIBackend) FeeHistory(ctx context.Context, blockCount uint64, lastBlock rpc.BlockNumber, rewardPercentiles []float64) (firstBlock *big.Int, reward [][]*big.Int, baseFee []*big.Int, gasUsedRatio []float64, err error)

func (*EthAPIBackend) GetBody 

func (b *EthAPIBackend) GetBody(ctx context.Context, hash common.Hash, number rpc.BlockNumber) (*types.Body, error)

GetBody returns body of a block. It does not resolve special block numbers.

func (*EthAPIBackend) GetEVM 

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

func (*EthAPIBackend) GetLogs 

func (b *EthAPIBackend) GetLogs(ctx context.Context, hash common.Hash, number uint64) ([][]*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(ctx context.Context, hash 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) Miner 

func (b *EthAPIBackend) Miner() *miner.Miner

func (*EthAPIBackend) NodeKitChainIdValue added in v0.6.0 

func (b *EthAPIBackend) NodeKitChainIdValue() string

func (*EthAPIBackend) NodeKitWSEndpoint 

func (b *EthAPIBackend) NodeKitWSEndpoint() string

func (*EthAPIBackend) PendingBlockAndReceipts 

func (b *EthAPIBackend) PendingBlockAndReceipts() (*types.Block, types.Receipts)

func (*EthAPIBackend) RPCEVMTimeout 

func (b *EthAPIBackend) RPCEVMTimeout() time.Duration

func (*EthAPIBackend) RPCGasCap 

func (b *EthAPIBackend) RPCGasCap() uint64

func (*EthAPIBackend) RPCTxFeeCap 

func (b *EthAPIBackend) RPCTxFeeCap() float64

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

func (b *EthAPIBackend) StartMining(threads int) error

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

func (b *EthAPIBackend) StateAtBlock(ctx context.Context, block *types.Block, reexec uint64, base *state.StateDB, readOnly bool, preferDisk bool) (*state.StateDB, tracers.StateReleaseFunc, error)

func (*EthAPIBackend) StateAtTransaction 

func (b *EthAPIBackend) StateAtTransaction(ctx context.Context, block *types.Block, txIndex int, reexec uint64) (*core.Message, vm.BlockContext, *state.StateDB, tracers.StateReleaseFunc, 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) SuggestGasTipCap 

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

func (*EthAPIBackend) SyncProgress 

func (b *EthAPIBackend) SyncProgress() ethereum.SyncProgress

func (*EthAPIBackend) TxPool 

func (b *EthAPIBackend) TxPool() *txpool.TxPool

func (*EthAPIBackend) TxPoolContent 

func (b *EthAPIBackend) TxPoolContent() (map[common.Address]types.Transactions, map[common.Address]types.Transactions)

func (*EthAPIBackend) TxPoolContentFrom 

func (b *EthAPIBackend) TxPoolContentFrom(addr common.Address) (types.Transactions, types.Transactions)

func (*EthAPIBackend) UnprotectedAllowed 

func (b *EthAPIBackend) UnprotectedAllowed() bool

type Ethereum 

type Ethereum struct {
	APIBackend *EthAPIBackend
	// contains filtered or unexported fields
}

Ethereum implements the Ethereum full node service.

func New 

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

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

func (*Ethereum) APIs 

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

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

func (s *Ethereum) ArchiveMode() bool

func (*Ethereum) BlockChain 

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

func (*Ethereum) BloomIndexer 

func (s *Ethereum) BloomIndexer() *core.ChainIndexer

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

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

func (*Ethereum) Miner 

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

func (*Ethereum) Protocols 

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

Protocols returns all the currently configured network protocols to start.

func (*Ethereum) ResetWithGenesisBlock 

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

func (*Ethereum) SetEtherbase 

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

SetEtherbase sets the mining reward address.

func (*Ethereum) SetSynced 

func (s *Ethereum) SetSynced()

func (*Ethereum) Start 

func (s *Ethereum) Start() error

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

func (*Ethereum) StartMining 

func (s *Ethereum) StartMining(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) StateAtBlock 

func (eth *Ethereum) StateAtBlock(ctx context.Context, block *types.Block, reexec uint64, base *state.StateDB, readOnly bool, preferDisk bool) (statedb *state.StateDB, release tracers.StateReleaseFunc, err error)

StateAtBlock retrieves the state database associated with a certain block. If no state is locally available for the given block, a number of blocks are attempted to be reexecuted to generate the desired state. The optional base layer statedb can be provided which is regarded as the statedb of the parent block.

An additional release function will be returned if the requested state is available. Release is expected to be invoked when the returned state is no longer needed. Its purpose is to prevent resource leaking. Though it can be noop in some cases.

Parameters:

  • block: The block for which we want the state(state = block.Root)
  • reexec: The maximum number of blocks to reprocess trying to obtain the desired state
  • base: If the caller is tracing multiple blocks, the caller can provide the parent state continuously from the callsite.
  • readOnly: If true, then the live 'blockchain' state database is used. No mutation should be made from caller, e.g. perform Commit or other 'save-to-disk' changes. Otherwise, the trash generated by caller may be persisted permanently.
  • preferDisk: this arg can be used by the caller to signal that even though the 'base' is provided, it would be preferable to start from a fresh state, if we have it on disk.

func (*Ethereum) Stop 

func (s *Ethereum) Stop() error

Stop implements node.Lifecycle, 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) SyncMode 

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

func (*Ethereum) Synced 

func (s *Ethereum) Synced() bool

func (*Ethereum) TxPool 

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

type EthereumAPI 

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

EthereumAPI provides an API to access Ethereum full node-related information.

func NewEthereumAPI 

func NewEthereumAPI(e *Ethereum) *EthereumAPI

NewEthereumAPI creates a new Ethereum protocol API for full nodes.

func (*EthereumAPI) Coinbase 

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

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

func (*EthereumAPI) Etherbase 

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

Etherbase is the address that mining rewards will be send to.

func (*EthereumAPI) Hashrate 

func (api *EthereumAPI) Hashrate() hexutil.Uint64

Hashrate returns the POW hashrate.

func (*EthereumAPI) Mining 

func (api *EthereumAPI) Mining() bool

Mining returns an indication if this node is currently mining.

type MinerAPI 

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

MinerAPI provides an API to control the miner.

func NewMinerAPI 

func NewMinerAPI(e *Ethereum) *MinerAPI

NewMinerAPI create a new MinerAPI instance.

func (*MinerAPI) SetEtherbase 

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

SetEtherbase sets the etherbase of the miner.

func (*MinerAPI) SetExtra 

func (api *MinerAPI) SetExtra(extra string) (bool, error)

SetExtra sets the extra data string that is included when this miner mines a block.

func (*MinerAPI) SetGasLimit 

func (api *MinerAPI) SetGasLimit(gasLimit hexutil.Uint64) bool

SetGasLimit sets the gaslimit to target towards during mining.

func (*MinerAPI) SetGasPrice 

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

SetGasPrice sets the minimum accepted gas price for the miner.

func (*MinerAPI) SetRecommitInterval 

func (api *MinerAPI) SetRecommitInterval(interval int)

SetRecommitInterval updates the interval for miner sealing work recommitting.

func (*MinerAPI) Start 

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

func (api *MinerAPI) Stop()

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

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.

Source Files

View all Source files

Directories

Path Synopsis
Package catalyst implements the temporary eth1/eth2 RPC integration.
 Package catalyst implements the temporary eth1/eth2 RPC integration.
Package downloader contains the manual full chain synchronisation.
 Package downloader contains the manual full chain synchronisation.
Package ethconfig contains the configuration of the ETH and LES protocols.
 Package ethconfig contains the configuration of the ETH and LES protocols.
Package fetcher contains the announcement based header, blocks or transaction synchronisation.
 Package fetcher contains the announcement based header, 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.
protocols
eth
snap
Package tracers is a manager for transaction tracing engines.
 Package tracers is a manager for transaction tracing engines.
internal/tracetest
js
js/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
 Package tracers contains the actual JavaScript tracer assets.
logger
native

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.