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

Package Files

interfaces.go

Variables

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

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

type CallMsg Uses

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
    Value    *big.Int        // amount of wei sent along with the call
    Data     []byte          // input data, usually an ABI-encoded contract method invocation
}

CallMsg contains parameters for contract calls.

type ChainReader Uses

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 Uses

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 Uses

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 Uses

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 FilterQuery Uses

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 Uses

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 Uses

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 LogFilterer Uses

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 Uses

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

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

type PendingStateEventer Uses

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 Uses

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 Uses

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 Uses

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
    PulledStates  uint64 // Number of state trie entries already downloaded
    KnownStates   uint64 // Total number of state trie entries known about
}

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

type TransactionReader Uses

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 Uses

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.

Directories

PathSynopsis
accountsPackage accounts implements high level Ethereum account management.
accounts/abiPackage abi implements the Ethereum ABI (Application Binary Interface).
accounts/abi/bindPackage bind generates Ethereum contract Go bindings.
accounts/abi/bind/backends
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.
cmd/abigen
cmd/bootnodebootnode runs a bootstrap node for the Ethereum Discovery Protocol.
cmd/checkpoint-admincheckpoint-admin is a utility that can be used to query checkpoint information and register stable checkpoints into an oracle contract.
cmd/clef
cmd/devp2p
cmd/ethkey
cmd/evmevm executes EVM code snippets.
cmd/evm/internal/compiler
cmd/faucetfaucet is a Ether faucet backed by a light client.
cmd/gethgeth is the official command-line client for Ethereum.
cmd/p2psimp2psim provides a command-line client for a simulation HTTP API.
cmd/puppethpuppeth is a command to assemble and maintain private networks.
cmd/rlpdumprlpdump is a pretty-printer for RLP data.
cmd/utilsPackage utils contains internal helper functions for go-ethereum commands.
cmd/wnode
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/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/cliquePackage clique implements the proof-of-authority consensus engine.
consensus/ethashPackage ethash implements the ethash proof-of-work consensus engine.
consensus/misc
console
contracts/checkpointoraclePackage checkpointoracle is a an on-chain light client checkpoint oracle.
contracts/checkpointoracle/contract
corePackage core implements the Ethereum consensus protocol.
core/asmProvides support for dealing with EVM assembly instructions (e.g., disassembling them).
core/bloombitsPackage bloombits implements bloom filtering on batches of data.
core/forkidPackage forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
core/rawdbPackage rawdb contains a collection of low level database accessors.
core/statePackage state provides a caching layer atop the Ethereum state trie.
core/typesPackage types contains data types related to Ethereum consensus.
core/vmPackage vm implements the Ethereum Virtual Machine.
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/googlePackage bn256 implements a particular bilinear group.
crypto/ecies
crypto/secp256k1Package secp256k1 wraps the bitcoin secp256k1 C library.
dashboard
ethPackage eth implements the Ethereum protocol.
ethclientPackage ethclient provides a client for the Ethereum RPC API.
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.
eth/downloaderPackage downloader contains the manual full chain synchronisation.
eth/fetcherPackage fetcher contains the block announcement based synchronisation.
eth/filtersPackage filters implements an ethereum filtering system for block, transactions and log events.
eth/gasprice
ethstatsPackage ethstats implements the network stats reporting service.
eth/tracersPackage tracers is a collection of JavaScript transaction tracers.
eth/tracers/internal/tracersPackage tracers contains the actual JavaScript tracer assets.
eventPackage event deals with subscriptions to real-time events.
graphqlPackage graphql provides a GraphQL interface to Ethereum node data.
internal/build
internal/cmdtest
internal/debugPackage debug interfaces Go runtime debugging facilities.
internal/ethapiPackage ethapi implements the general Ethereum API functions.
internal/guidePackage guide is a small test suite to ensure snippets in the dev guide work.
internal/jsrePackage jsre provides execution environment for JavaScript.
internal/jsre/depsPackage deps contains the console JavaScript dependencies Go embedded.
internal/testlogPackage testlog provides a log handler for unit tests.
internal/web3extpackage web3ext contains geth specific web3.js extensions.
lesPackage les implements the Light Ethereum Subprotocol.
les/flowcontrolPackage flowcontrol implements a client side flow control mechanism
lightPackage light implements on-demand retrieval capable state and chain objects for the Ethereum Light Client.
logPackage log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
metricsGo port of Coda Hale's Metrics library
metrics/expHook go-metrics into expvar on any /debug/metrics request, load all vars from the registry into expvar, and execute regular expvar handler
metrics/influxdb
metrics/librato
metrics/prometheusPackage prometheus exposes go-metrics into a Prometheus format.
minerPackage miner implements Ethereum block creation and mining.
mobilePackage geth contains the simplified mobile APIs to go-ethereum.
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/discv5Package discv5 implements the RLPx v5 Topic Discovery Protocol.
p2p/enode
p2p/enrPackage enr implements Ethereum Node Records as defined in EIP-778.
p2p/natPackage nat provides access to common network port mapping protocols.
p2p/netutilPackage netutil contains extensions to the net package.
p2p/simulationsPackage simulations simulates p2p networks.
p2p/simulations/adapters
p2p/simulations/examples
p2p/simulations/pipes
p2p/testing
params
rlpPackage rlp implements the RLP serialization format.
rpcPackage rpc implements bi-directional JSON-RPC 2.0 on multiple transports.
signer/core
signer/fourbytePackage fourbyte contains the 4byte database.
signer/rules
signer/rules/depsPackage deps contains the console JavaScript dependencies Go embedded.
signer/storage
testsPackage tests implements execution of Ethereum JSON tests.
triePackage trie implements Merkle Patricia Tries.
vendor/github.com/go-stack/stackPackage stack implements utilities to capture, manipulate, and format call stacks.
vendor/github.com/pborman/uuidThe uuid package generates and inspects UUIDs.
vendor/gopkg.in/check.v1Package check is a rich testing extension for Go's testing package.
vendor/gopkg.in/urfave/cli.v1Package cli provides a minimal framework for creating and organizing command line Go applications.
whisper/mailserverPackage mailserver provides a naive, example mailserver implementation
whisper/shhclient
whisper/whisperv6

Package ethereum imports 5 packages (graph) and is imported by 1158 packages. Updated 2019-09-20. Refresh now. Tools for package owners.