eth

package
v1.16.64 Latest Latest
Warning

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

 Go to latest Published: Dec 25, 2025 License: GPL-3.0, BSD-3-Clause Imports: 65 Imported by: 3

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 added in v0.15.3 

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

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

func NewAdminAPI added in v0.15.3 

func NewAdminAPI(eth *Ethereum) *AdminAPI

NewAdminAPI creates a new instance of AdminAPI.

func (*AdminAPI) ExportChain added in v0.15.3 

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 added in v0.15.3 

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 added in v0.15.3 

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

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

func NewDebugAPI added in v0.15.3 

func NewDebugAPI(eth *Ethereum) *DebugAPI

NewDebugAPI creates a new DebugAPI instance.

func (*DebugAPI) AccountRange added in v0.15.3 

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

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

func (*DebugAPI) DumpBlock added in v0.15.3 

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

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

func (*DebugAPI) ExecutionWitness added in v1.16.35 

func (api *DebugAPI) ExecutionWitness(bn rpc.BlockNumber) (*stateless.ExtWitness, error)

func (*DebugAPI) ExecutionWitnessByHash added in v1.16.35 

func (api *DebugAPI) ExecutionWitnessByHash(hash common.Hash) (*stateless.ExtWitness, error)

func (*DebugAPI) GetAccessibleState added in v0.15.3 

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 added in v0.15.3 

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 added in v0.15.3 

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 added in v0.15.3 

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) GetTrieFlushInterval added in v0.15.3 

func (api *DebugAPI) GetTrieFlushInterval() (string, error)

GetTrieFlushInterval gets the current value of in-memory trie flush interval

func (*DebugAPI) Preimage added in v0.15.3 

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 added in v0.15.3 

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. If the value is shorter than the block generation time, or even 0 or negative, the node will flush trie after processing each block (effectively archive mode).

func (*DebugAPI) StateSize added in v1.16.35 

func (api *DebugAPI) StateSize(blockHashOrNumber *rpc.BlockNumberOrHash) (interface{}, error)

StateSize returns the current state size statistics from the state size tracker. Returns an error if the state size tracker is not initialized or if stats are not ready.

func (*DebugAPI) StorageRangeAt added in v0.15.3 

func (api *DebugAPI) StorageRangeAt(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash, 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 and tracers.Backend for full nodes

func (*EthAPIBackend) AccountManager 

func (b *EthAPIBackend) AccountManager() *accounts.Manager

func (*EthAPIBackend) BlobBaseFee added in v0.15.3 

func (b *EthAPIBackend) BlobBaseFee(ctx context.Context) *big.Int

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 added in v0.15.3 

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

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 added in v0.15.3 

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

func (*EthAPIBackend) CurrentView added in v0.15.3 

func (b *EthAPIBackend) CurrentView() *filtermaps.ChainView

func (*EthAPIBackend) Engine added in v0.15.3 

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

func (*EthAPIBackend) ExtRPCEnabled 

func (b *EthAPIBackend) ExtRPCEnabled() bool

func (*EthAPIBackend) FeeHistory added in v0.15.3 

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, baseFeePerBlobGas []*big.Int, blobGasUsedRatio []float64, err error)

func (*EthAPIBackend) GetBody added in v0.15.3 

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) GetCanonicalReceipt added in v0.15.3 

func (b *EthAPIBackend) GetCanonicalReceipt(tx *types.Transaction, blockHash common.Hash, blockNumber, blockIndex uint64) (*types.Receipt, error)

func (*EthAPIBackend) GetCanonicalTransaction added in v0.15.3 

func (b *EthAPIBackend) GetCanonicalTransaction(txHash common.Hash) (bool, *types.Transaction, common.Hash, uint64, uint64)

GetCanonicalTransaction retrieves the lookup along with the transaction itself associate with the given transaction hash.

A null will be returned if the transaction is not found. The transaction is not existent from the node's perspective. This can be due to the transaction indexer not being finished. The caller must explicitly check the indexer progress.

Notably, only the transaction in the canonical chain is visible.

func (*EthAPIBackend) GetEVM 

func (b *EthAPIBackend) GetEVM(ctx context.Context, state *state.StateDB, header *types.Header, vmConfig *vm.Config, blockCtx *vm.BlockContext) *vm.EVM

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) 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 added in v0.15.3 

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

func (*EthAPIBackend) HistoryPruningCutoff added in v0.15.3 

func (b *EthAPIBackend) HistoryPruningCutoff() uint64

func (*EthAPIBackend) NewMatcherBackend added in v0.15.3 

func (b *EthAPIBackend) NewMatcherBackend() filtermaps.MatcherBackend

func (*EthAPIBackend) Pending added in v0.15.3 

func (b *EthAPIBackend) Pending() (*types.Block, types.Receipts, *state.StateDB)

func (*EthAPIBackend) RPCEVMTimeout added in v0.15.3 

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

func (*EthAPIBackend) RPCGasCap 

func (b *EthAPIBackend) RPCGasCap() uint64

func (*EthAPIBackend) RPCTxFeeCap added in v0.15.3 

func (b *EthAPIBackend) RPCTxFeeCap() float64

func (*EthAPIBackend) RPCTxSyncDefaultTimeout added in v1.16.39 

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

func (*EthAPIBackend) RPCTxSyncMaxTimeout added in v1.16.39 

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

func (*EthAPIBackend) SendTx 

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

func (*EthAPIBackend) SetHead 

func (b *EthAPIBackend) SetHead(number uint64)

func (*EthAPIBackend) StateAndHeaderByNumber 

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

func (*EthAPIBackend) StateAndHeaderByNumberOrHash added in v0.15.3 

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

func (*EthAPIBackend) StateAtBlock added in v0.15.3 

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 added in v0.15.3 

func (b *EthAPIBackend) StateAtTransaction(ctx context.Context, block *types.Block, txIndex int, reexec uint64) (*types.Transaction, vm.BlockContext, *state.StateDB, tracers.StateReleaseFunc, error)

func (*EthAPIBackend) Stats 

func (b *EthAPIBackend) Stats() (runnable int, blocked 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) 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) SubscribeRemovedLogsEvent 

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

func (*EthAPIBackend) SuggestGasTipCap added in v0.15.3 

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

func (*EthAPIBackend) SyncProgress added in v0.15.3 

func (b *EthAPIBackend) SyncProgress(ctx context.Context) ethereum.SyncProgress

func (*EthAPIBackend) TxIndexDone added in v0.15.3 

func (b *EthAPIBackend) TxIndexDone() bool

TxIndexDone returns true if the transaction indexer has finished indexing.

func (*EthAPIBackend) TxPool added in v0.15.3 

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

func (*EthAPIBackend) TxPoolContent 

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

func (*EthAPIBackend) TxPoolContentFrom added in v0.15.3 

func (b *EthAPIBackend) TxPoolContentFrom(addr common.Address) ([]*types.Transaction, []*types.Transaction)

func (*EthAPIBackend) UnprotectedAllowed added in v0.15.3 

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), whose lifecycle will be managed by the provided node.

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) BlobTxPool added in v0.15.3 

func (s *Ethereum) BlobTxPool() *blobpool.BlobPool

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

func (s *Ethereum) IsListening() bool

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) SetSynced added in v0.15.3 

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

func (s *Ethereum) Stop() error

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

func (*Ethereum) Synced 

func (s *Ethereum) Synced() bool

func (*Ethereum) TxPool 

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

type MinerAPI added in v0.15.3 

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

MinerAPI provides an API to control the miner.

func NewMinerAPI added in v0.15.3 

func NewMinerAPI(e *Ethereum) *MinerAPI

NewMinerAPI creates a new MinerAPI instance.

func (*MinerAPI) SetExtra added in v0.15.3 

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 added in v0.15.3 

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

SetGasLimit sets the gaslimit to target towards during mining.

func (*MinerAPI) SetGasPrice added in v0.15.3 

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

SetGasPrice sets the minimum accepted gas price for the miner.

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 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
internal
internal/tracetest
js
js/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
 Package tracers contains the actual JavaScript tracer assets.
live
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.