eth

package
v1.14.12 Latest Latest
Warning

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

Go to latest
Published: Nov 19, 2024 License: GPL-3.0 Imports: 58 Imported by: 1,707

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 v1.10.20

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 v1.10.20

func NewAdminAPI(eth *Ethereum) *AdminAPI

NewAdminAPI creates a new instance of AdminAPI.

func (*AdminAPI) ExportChain added in v1.10.20

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 v1.10.20

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

ImportChain imports a blockchain from a local file.

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 Config

type Config = ethconfig.Config

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

type DebugAPI added in v1.10.20

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 v1.10.20

func NewDebugAPI(eth *Ethereum) *DebugAPI

NewDebugAPI creates a new DebugAPI instance.

func (*DebugAPI) AccountRange added in v1.10.20

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 v1.10.20

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 added in v1.10.20

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 v1.10.20

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 v1.10.20

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 v1.10.20

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 v1.12.1

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

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

func (*DebugAPI) Preimage added in v1.10.20

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 v1.11.0

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) StorageRangeAt added in v1.10.20

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 added in v1.8.8

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

EthAPIBackend implements ethapi.Backend and tracers.Backend for full nodes

func (*EthAPIBackend) AccountManager added in v1.8.8

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

func (*EthAPIBackend) BlobBaseFee added in v1.14.0

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

func (*EthAPIBackend) BlockByHash added in v1.9.2

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

func (*EthAPIBackend) BlockByNumber added in v1.8.8

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

func (*EthAPIBackend) BlockByNumberOrHash added in v1.9.6

func (b *EthAPIBackend) BlockByNumberOrHash(ctx context.Context, blockNrOrHash rpc.BlockNumberOrHash) (*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.Header

func (*EthAPIBackend) CurrentHeader added in v1.9.19

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

func (*EthAPIBackend) Engine added in v1.9.19

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

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) FeeHistory added in v1.10.5

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 v1.11.0

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 added in v1.8.8

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

func (*EthAPIBackend) GetLogs added in v1.8.8

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

func (*EthAPIBackend) GetPoolNonce added in v1.8.8

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

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

func (*EthAPIBackend) GetTd added in v1.8.8

func (b *EthAPIBackend) GetTd(ctx context.Context, hash common.Hash) *big.Int

func (*EthAPIBackend) GetTransaction added in v1.9.0

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

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

An error will be returned if the transaction is not found, and background indexing for transactions is still in progress. The error is used to indicate the scenario explicitly that the transaction might be reachable shortly.

A null will be returned in the transaction is not found and background transaction indexing is already finished. The transaction is not existent from the perspective of node.

func (*EthAPIBackend) HeaderByHash added in v1.8.13

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

func (*EthAPIBackend) HeaderByNumber added in v1.8.8

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

func (*EthAPIBackend) HeaderByNumberOrHash added in v1.9.6

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

func (*EthAPIBackend) Pending added in v1.14.0

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

func (*EthAPIBackend) RPCEVMTimeout added in v1.10.10

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

func (*EthAPIBackend) RPCGasCap added in v1.8.24

func (b *EthAPIBackend) RPCGasCap() uint64

func (*EthAPIBackend) RPCTxFeeCap added in v1.9.16

func (b *EthAPIBackend) RPCTxFeeCap() float64

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) StateAndHeaderByNumberOrHash added in v1.9.6

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

func (*EthAPIBackend) StateAtBlock added in v1.10.0

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 v1.10.0

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 added in v1.8.8

func (b *EthAPIBackend) Stats() (runnable int, blocked 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) 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) SuggestGasTipCap added in v1.10.4

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

func (*EthAPIBackend) SyncProgress added in v1.10.9

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

func (*EthAPIBackend) TxPool added in v1.9.19

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

func (*EthAPIBackend) TxPoolContent added in v1.8.8

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

func (*EthAPIBackend) TxPoolContentFrom added in v1.10.5

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

func (*EthAPIBackend) UnprotectedAllowed added in v1.10.0

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 added in v1.4.0

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

func (s *Ethereum) AccountManager() *accounts.Manager

func (*Ethereum) ArchiveMode added in v1.9.0

func (s *Ethereum) ArchiveMode() bool

func (*Ethereum) BlockChain added in v1.3.1

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

func (*Ethereum) BloomIndexer added in v1.9.19

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

func (*Ethereum) ChainDb added in v1.1.0

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

func (*Ethereum) Downloader added in v0.9.17

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

func (*Ethereum) Engine added in v1.6.0

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

func (*Ethereum) EventMux

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

func (*Ethereum) IsListening

func (s *Ethereum) IsListening() bool

func (*Ethereum) Miner

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

func (*Ethereum) Protocols added in v1.4.0

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

Protocols returns all the currently configured network protocols to start.

func (*Ethereum) ResetWithGenesisBlock added in v0.9.17

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

func (*Ethereum) SetSynced added in v1.10.14

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) SyncMode added in v1.10.14

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

SyncMode retrieves the current sync mode, either explicitly set, or derived from the chain status.

func (*Ethereum) Synced added in v1.9.0

func (s *Ethereum) Synced() bool

func (*Ethereum) TxPool

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

type MinerAPI added in v1.10.20

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

MinerAPI provides an API to control the miner.

func NewMinerAPI added in v1.10.20

func NewMinerAPI(e *Ethereum) *MinerAPI

NewMinerAPI creates a new MinerAPI instance.

func (*MinerAPI) SetExtra added in v1.10.20

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 v1.10.20

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

SetGasLimit sets the gaslimit to target towards during mining.

func (*MinerAPI) SetGasPrice added in v1.10.20

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

SetGasPrice sets the minimum accepted gas price for the miner.

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.

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

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL