go-ethereum – github.com/ethereum/go-ethereum Index | Files | Directories

package ethereum

import "github.com/ethereum/go-ethereum"

Package ethereum defines interfaces for interacting with Ethereum.

Index

Variables

var NotFound = errors.New("not found")

NotFound is returned by API methods if the requested item does not exist.

Types

type BlockNumberReader

type BlockNumberReader interface {
	BlockNumber(ctx context.Context) (uint64, error)
}

BlockNumberReader provides access to the current block number.

type CallMsg

type CallMsg struct {
	From      common.Address  // the sender of the 'transaction'
	To        *common.Address // the destination contract (nil for contract creation)
	Gas       uint64          // if 0, the call executes with near-infinite gas
	GasPrice  *big.Int        // wei <-> gas exchange ratio
	GasFeeCap *big.Int        // EIP-1559 fee cap per gas.
	GasTipCap *big.Int        // EIP-1559 tip per gas.
	Value     *big.Int        // amount of wei sent along with the call
	Data      []byte          // input data, usually an ABI-encoded contract method invocation

	AccessList types.AccessList // EIP-2930 access list.

	// For BlobTxType
	BlobGasFeeCap *big.Int
	BlobHashes    []common.Hash

	// For SetCodeTxType
	AuthorizationList []types.SetCodeAuthorization
}

CallMsg contains parameters for contract calls.

type ChainIDReader

type ChainIDReader interface {
	ChainID(ctx context.Context) (*big.Int, error)
}

ChainIDReader provides access to the chain ID.

type ChainReader

type ChainReader interface {
	BlockByHash(ctx context.Context, hash common.Hash) (*types.Block, error)
	BlockByNumber(ctx context.Context, number *big.Int) (*types.Block, error)
	HeaderByHash(ctx context.Context, hash common.Hash) (*types.Header, error)
	HeaderByNumber(ctx context.Context, number *big.Int) (*types.Header, error)
	TransactionCount(ctx context.Context, blockHash common.Hash) (uint, error)
	TransactionInBlock(ctx context.Context, blockHash common.Hash, index uint) (*types.Transaction, error)

	// This method subscribes to notifications about changes of the head block of
	// the canonical chain.
	SubscribeNewHead(ctx context.Context, ch chan<- *types.Header) (Subscription, error)
}

ChainReader provides access to the blockchain. The methods in this interface access raw data from either the canonical chain (when requesting by block number) or any blockchain fork that was previously downloaded and processed by the node. The block number argument can be nil to select the latest canonical block. Reading block headers should be preferred over full blocks whenever possible.

The returned error is NotFound if the requested item does not exist.

type ChainStateReader

type ChainStateReader interface {
	BalanceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (*big.Int, error)
	StorageAt(ctx context.Context, account common.Address, key common.Hash, blockNumber *big.Int) ([]byte, error)
	CodeAt(ctx context.Context, account common.Address, blockNumber *big.Int) ([]byte, error)
	NonceAt(ctx context.Context, account common.Address, blockNumber *big.Int) (uint64, error)
}

ChainStateReader wraps access to the state trie of the canonical blockchain. Note that implementations of the interface may be unable to return state values for old blocks. In many cases, using CallContract can be preferable to reading raw contract storage.

type ChainSyncReader

type ChainSyncReader interface {
	SyncProgress(ctx context.Context) (*SyncProgress, error)
}

ChainSyncReader wraps access to the node's current sync status. If there's no sync currently running, it returns nil.

type ContractCaller

type ContractCaller interface {
	CallContract(ctx context.Context, call CallMsg, blockNumber *big.Int) ([]byte, error)
}

A ContractCaller provides contract calls, essentially transactions that are executed by the EVM but not mined into the blockchain. ContractCall is a low-level method to execute such calls. For applications which are structured around specific contracts, the abigen tool provides a nicer, properly typed way to perform calls.

type FeeHistory

type FeeHistory struct {
	OldestBlock  *big.Int     // block corresponding to first response value
	Reward       [][]*big.Int // list every txs priority fee per block
	BaseFee      []*big.Int   // list of each block's base fee
	GasUsedRatio []float64    // ratio of gas used out of the total available limit
}

FeeHistory provides recent fee market data that consumers can use to determine a reasonable maxPriorityFeePerGas value.

type FeeHistoryReader

type FeeHistoryReader interface {
	FeeHistory(ctx context.Context, blockCount uint64, lastBlock *big.Int, rewardPercentiles []float64) (*FeeHistory, error)
}

FeeHistoryReader provides access to the fee history oracle.

type FilterQuery

type FilterQuery struct {
	BlockHash *common.Hash     // used by eth_getLogs, return logs only from block with this hash
	FromBlock *big.Int         // beginning of the queried range, nil means genesis block
	ToBlock   *big.Int         // end of the range, nil means latest block
	Addresses []common.Address // restricts matches to events created by specific contracts

	// The Topic list restricts matches to particular event topics. Each event has a list
	// of topics. Topics matches a prefix of that list. An empty element slice matches any
	// topic. Non-empty elements represent an alternative that matches any of the
	// contained topics.
	//
	// Examples:
	// {} or nil          matches any topic list
	// {{A}}              matches topic A in first position
	// {{}, {B}}          matches any topic in first position AND B in second position
	// {{A}, {B}}         matches topic A in first position AND B in second position
	// {{A, B}, {C, D}}   matches topic (A OR B) in first position AND (C OR D) in second position
	Topics [][]common.Hash
}

FilterQuery contains options for contract log filtering.

type GasEstimator

type GasEstimator interface {
	EstimateGas(ctx context.Context, call CallMsg) (uint64, error)
}

GasEstimator wraps EstimateGas, which tries to estimate the gas needed to execute a specific transaction based on the pending state. There is no guarantee that this is the true gas limit requirement as other transactions may be added or removed by miners, but it should provide a basis for setting a reasonable default.

type GasPricer

type GasPricer interface {
	SuggestGasPrice(ctx context.Context) (*big.Int, error)
}

GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.

type GasPricer1559

type GasPricer1559 interface {
	SuggestGasTipCap(ctx context.Context) (*big.Int, error)
}

GasPricer1559 provides access to the EIP-1559 gas price oracle.

type LogFilterer

type LogFilterer interface {
	FilterLogs(ctx context.Context, q FilterQuery) ([]types.Log, error)
	SubscribeFilterLogs(ctx context.Context, q FilterQuery, ch chan<- types.Log) (Subscription, error)
}

LogFilterer provides access to contract log events using a one-off query or continuous event subscription.

Logs received through a streaming query subscription may have Removed set to true, indicating that the log was reverted due to a chain reorganisation.

type PendingContractCaller

type PendingContractCaller interface {
	PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error)
}

PendingContractCaller can be used to perform calls against the pending state.

type PendingStateEventer

type PendingStateEventer interface {
	SubscribePendingTransactions(ctx context.Context, ch chan<- *types.Transaction) (Subscription, error)
}

A PendingStateEventer provides access to real time notifications about changes to the pending state.

type PendingStateReader

type PendingStateReader interface {
	PendingBalanceAt(ctx context.Context, account common.Address) (*big.Int, error)
	PendingStorageAt(ctx context.Context, account common.Address, key common.Hash) ([]byte, error)
	PendingCodeAt(ctx context.Context, account common.Address) ([]byte, error)
	PendingNonceAt(ctx context.Context, account common.Address) (uint64, error)
	PendingTransactionCount(ctx context.Context) (uint, error)
}

A PendingStateReader provides access to the pending state, which is the result of all known executable transactions which have not yet been included in the blockchain. It is commonly used to display the result of ’unconfirmed’ actions (e.g. wallet value transfers) initiated by the user. The PendingNonceAt operation is a good way to retrieve the next available transaction nonce for a specific account.

type Subscription

type Subscription interface {
	// Unsubscribe cancels the sending of events to the data channel
	// and closes the error channel.
	Unsubscribe()
	// Err returns the subscription error channel. The error channel receives
	// a value if there is an issue with the subscription (e.g. the network connection
	// delivering the events has been closed). Only one value will ever be sent.
	// The error channel is closed by Unsubscribe.
	Err() <-chan error
}

Subscription represents an event subscription where events are delivered on a data channel.

type SyncProgress

type SyncProgress struct {
	StartingBlock uint64 // Block number where sync began
	CurrentBlock  uint64 // Current block number where sync is at
	HighestBlock  uint64 // Highest alleged block number in the chain

	// "fast sync" fields. These used to be sent by geth, but are no longer used
	// since version v1.10.
	PulledStates uint64 // Number of state trie entries already downloaded
	KnownStates  uint64 // Total number of state trie entries known about

	// "snap sync" fields.
	SyncedAccounts      uint64 // Number of accounts downloaded
	SyncedAccountBytes  uint64 // Number of account trie bytes persisted to disk
	SyncedBytecodes     uint64 // Number of bytecodes downloaded
	SyncedBytecodeBytes uint64 // Number of bytecode bytes downloaded
	SyncedStorage       uint64 // Number of storage slots downloaded
	SyncedStorageBytes  uint64 // Number of storage trie bytes persisted to disk

	HealedTrienodes     uint64 // Number of state trie nodes downloaded
	HealedTrienodeBytes uint64 // Number of state trie bytes persisted to disk
	HealedBytecodes     uint64 // Number of bytecodes downloaded
	HealedBytecodeBytes uint64 // Number of bytecodes persisted to disk

	HealingTrienodes uint64 // Number of state trie nodes pending
	HealingBytecode  uint64 // Number of bytecodes pending

	// "transaction indexing" fields
	TxIndexFinishedBlocks  uint64 // Number of blocks whose transactions are already indexed
	TxIndexRemainingBlocks uint64 // Number of blocks whose transactions are not indexed yet
}

SyncProgress gives progress indications when the node is synchronising with the Ethereum network.

func (SyncProgress) Done

func (prog SyncProgress) Done() bool

Done returns the indicator if the initial sync is finished or not.

type TransactionReader

type TransactionReader interface {
	// TransactionByHash checks the pool of pending transactions in addition to the
	// blockchain. The isPending return value indicates whether the transaction has been
	// mined yet. Note that the transaction may not be part of the canonical chain even if
	// it's not pending.
	TransactionByHash(ctx context.Context, txHash common.Hash) (tx *types.Transaction, isPending bool, err error)
	// TransactionReceipt returns the receipt of a mined transaction. Note that the
	// transaction may not be included in the current canonical chain even if a receipt
	// exists.
	TransactionReceipt(ctx context.Context, txHash common.Hash) (*types.Receipt, error)
}

TransactionReader provides access to past transactions and their receipts. Implementations may impose arbitrary restrictions on the transactions and receipts that can be retrieved. Historic transactions may not be available.

Avoid relying on this interface if possible. Contract logs (through the LogFilterer interface) are more reliable and usually safer in the presence of chain reorganisations.

The returned error is NotFound if the requested item does not exist.

type TransactionSender

type TransactionSender interface {
	SendTransaction(ctx context.Context, tx *types.Transaction) error
}

TransactionSender wraps transaction sending. The SendTransaction method injects a signed transaction into the pending transaction pool for execution. If the transaction was a contract creation, the TransactionReceipt method can be used to retrieve the contract address after the transaction has been mined.

The transaction must be signed and have a valid nonce to be included. Consumers of the API can use package accounts to maintain local private keys and need can retrieve the next available nonce using PendingNonceAt.

Source Files

interfaces.go

Directories

PathSynopsis
accountsPackage accounts implements high level Ethereum account management.
accounts/abiPackage abi implements the Ethereum ABI (Application Binary Interface).
accounts/abi/abigenPackage abigen generates Ethereum contract Go bindings.
accounts/abi/bindPackage bind is the runtime for abigen v1 generated contract bindings.
accounts/abi/bind/backends
accounts/abi/bind/v2Package bind implements utilities for interacting with Solidity contracts.
accounts/abi/bind/v2/internal
accounts/external
accounts/keystorePackage keystore implements encrypted storage of secp256k1 private keys.
accounts/scwallet
accounts/usbwalletPackage usbwallet implements support for USB hardware wallets.
accounts/usbwallet/trezorPackage trezor contains the wire protocol.
beacon
beacon/blsync
beacon/engine
beacon/light
beacon/light/api
beacon/light/request
beacon/light/sync
beacon/merklePackage merkle implements proof verifications in binary merkle trees.
beacon/params
beacon/typesPackage types implements a few types of the beacon chain for light client usage.
cmd
cmd/abidump
cmd/abigen
cmd/blsync
cmd/clef
cmd/devp2p
cmd/devp2p/internal
cmd/era
cmd/ethkey
cmd/evmevm executes EVM code snippets.
cmd/evm/internal
cmd/gethgeth is a command-line client for Ethereum.
cmd/rlpdumprlpdump is a pretty-printer for RLP data.
cmd/utilsPackage utils contains internal helper functions for go-ethereum commands.
cmd/workload
commonPackage common contains various helper functions.
common/bitutilPackage bitutil implements fast bitwise operations.
common/compilerPackage compiler wraps the Solidity and Vyper compiler executables (solc; vyper).
common/fdlimit
common/hexutilPackage hexutil implements hex encoding with 0x prefix.
common/lruPackage lru implements generically-typed LRU caches.
common/mathPackage math provides integer math utilities.
common/mclockPackage mclock is a wrapper for a monotonic clock source
common/prquePackage prque implements a priority queue data structure supporting arbitrary value types and int64 priorities.
consensusPackage consensus implements different Ethereum consensus engines.
consensus/beacon
consensus/cliquePackage clique implements the proof-of-authority consensus engine.
consensus/ethashPackage ethash implements the ethash proof-of-work consensus engine.
consensus/misc
consensus/misc/eip1559
consensus/misc/eip4844
console
console/prompt
corePackage core implements the Ethereum consensus protocol.
core/filtermaps
core/forkidPackage forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
core/history
core/rawdbPackage rawdb contains a collection of low level database accessors.
core/rawdb/ancienttest
core/statePackage state provides a caching layer atop the Ethereum state trie.
core/stateless
core/state/pruner
core/state/snapshotPackage snapshot implements a journalled, dynamic state dump.
core/tracingPackage tracing defines hooks for 'live tracing' of block processing and transaction execution.
core/txpool
core/txpool/blobpoolPackage blobpool implements the EIP-4844 blob transaction pool.
core/txpool/legacypoolPackage legacypool implements the normal EVM execution transaction pool.
core/txpool/localsPackage locals implements tracking for "local" transactions
core/typesPackage types contains data types related to Ethereum consensus.
core/vmPackage vm implements the Ethereum Virtual Machine.
core/vm/program
core/vm/runtimePackage runtime provides a basic execution model for executing EVM code.
crypto
crypto/blake2bPackage blake2b implements the BLAKE2b hash algorithm defined by RFC 7693 and the extendable output function (XOF) BLAKE2Xb.
crypto/bn256Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve.
crypto/bn256/cloudflarePackage bn256 implements a particular bilinear group at the 128-bit security level.
crypto/bn256/gnark
crypto/bn256/googlePackage bn256 implements a particular bilinear group.
crypto/ecies
crypto/kzg4844Package kzg4844 implements the KZG crypto for EIP-4844.
crypto/secp256k1Package secp256k1 wraps the bitcoin secp256k1 C library.
crypto/signify
ethPackage eth implements the Ethereum protocol.
eth/catalystPackage catalyst implements the temporary eth1/eth2 RPC integration.
ethclientPackage ethclient provides a client for the Ethereum RPC API.
ethclient/gethclientPackage gethclient provides an RPC client for geth-specific APIs.
ethclient/simulated
ethdbPackage ethdb defines the interfaces for an Ethereum data store.
ethdb/dbtest
ethdb/leveldbPackage leveldb implements the key-value database layer based on LevelDB.
ethdb/memorydbPackage memorydb implements the key-value database layer based on memory maps.
ethdb/pebblePackage pebble implements the key-value database layer based on pebble.
ethdb/remotedbPackage remotedb implements the key-value database layer based on a remote geth node.
eth/downloaderPackage downloader contains the manual full chain synchronisation.
eth/ethconfigPackage ethconfig contains the configuration of the ETH and LES protocols.
eth/fetcher
eth/filtersPackage filters implements an ethereum filtering system for block, transactions and log events.
eth/gasestimator
eth/gasprice
eth/protocols
eth/protocols/eth
eth/protocols/snap
ethstatsPackage ethstats implements the network stats reporting service.
eth/tracers
eth/tracers/internal
eth/tracers/js
eth/tracers/js/internal
eth/tracers/live
eth/tracers/logger
eth/tracers/native
eventPackage event deals with subscriptions to real-time events.
graphqlPackage graphql provides a GraphQL interface to Ethereum node data.
graphql/internal
internal
log
metrics
metrics/exp
metrics/influxdb
metrics/internal
metrics/prometheusPackage prometheus exposes go-metrics into a Prometheus format.
minerPackage miner implements Ethereum block creation and mining.
nodePackage node sets up multi-protocol Ethereum nodes.
p2pPackage p2p implements the Ethereum p2p network protocols.
p2p/discoverPackage discover implements the Node Discovery Protocol.
p2p/discover/v4wirePackage v4wire implements the Discovery v4 Wire Protocol.
p2p/discover/v5wire
p2p/dnsdiscPackage dnsdisc implements node discovery via DNS (EIP-1459).
p2p/enode
p2p/enrPackage enr implements Ethereum Node Records as defined in EIP-778.
p2p/msgratePackage msgrate allows estimating the throughput of peers for more balanced syncs.
p2p/natPackage nat provides access to common network port mapping protocols.
p2p/netutilPackage netutil contains extensions to the net package.
p2p/pipes
p2p/rlpxPackage rlpx implements the RLPx transport protocol.
p2p/tracker
params
params/forks
rlpPackage rlp implements the RLP serialization format.
rlp/internal
rlp/rlpgen
rpcPackage rpc implements bi-directional JSON-RPC 2.0 on multiple transports.
signer
signer/core
signer/core/apitypes
signer/fourbytePackage fourbyte contains the 4byte database.
signer/rules
signer/storage
testsPackage tests implements execution of Ethereum JSON tests.
tests/fuzzers
tests/fuzzers/bls12381
tests/fuzzers/bn256
tests/fuzzers/difficulty
tests/fuzzers/rangeproof
tests/fuzzers/secp256k1
tests/fuzzers/txfetcher
triePackage trie implements Merkle Patricia Tries.
triedb
triedb/database
triedb/hashdb
triedb/pathdb
trie/trienode
trie/utils
version
Version
v1.15.11 (latest)
Published
May 5, 2025
Platform
linux/amd64
Imports
5 packages
Last checked
15 hours ago

Tools for package owners.