import "github.com/etclabscore/core-geth"
Package ethereum defines interfaces for interacting with Ethereum.
NotFound is returned by API methods if the requested item does not exist.
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 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 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 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 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 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.
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.
GasPricer wraps the gas price oracle, which monitors the blockchain to determine the optimal gas price given current fee market conditions.
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 interface { PendingCallContract(ctx context.Context, call CallMsg) ([]byte, error) }
PendingContractCaller can be used to perform calls against the pending state.
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 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 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 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 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 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.
Path | Synopsis |
---|---|
accounts | Package accounts implements high level Ethereum account management. |
accounts/abi | Package abi implements the Ethereum ABI (Application Binary Interface). |
accounts/abi/bind | Package bind generates Ethereum contract Go bindings. |
accounts/abi/bind/backends | |
accounts/external | |
accounts/keystore | Package keystore implements encrypted storage of secp256k1 private keys. |
accounts/scwallet | |
accounts/usbwallet | Package usbwallet implements support for USB hardware wallets. |
accounts/usbwallet/trezor | Package trezor contains the wire protocol. |
common | Package common contains various helper functions. |
common/bitutil | Package bitutil implements fast bitwise operations. |
common/compiler | Package compiler wraps the Solidity and Vyper compiler executables (solc; vyper). |
common/fdlimit | |
common/hexutil | Package hexutil implements hex encoding with 0x prefix. |
common/math | Package math provides integer math utilities. |
common/mclock | Package mclock is a wrapper for a monotonic clock source |
common/prque | Package prque implements a priority queue data structure supporting arbitrary value types and int64 priorities. |
consensus | Package consensus implements different Ethereum consensus engines. |
consensus/clique | Package clique implements the proof-of-authority consensus engine. |
consensus/ethash | |
consensus/misc | |
console | |
console/prompt | |
core | Package core implements the Ethereum consensus protocol. |
core/asm | Provides support for dealing with EVM assembly instructions (e.g., disassembling them). |
core/bloombits | Package bloombits implements bloom filtering on batches of data. |
core/forkid | Package forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124). |
core/rawdb | Package rawdb contains a collection of low level database accessors. |
core/state | Package state provides a caching layer atop the Ethereum state trie. |
core/state/snapshot | Package snapshot implements a journalled, dynamic state dump. |
core/types | Package types contains data types related to Ethereum consensus. |
core/vm | Package vm implements the Ethereum Virtual Machine. |
core/vm/runtime | Package runtime provides a basic execution model for executing EVM code. |
crypto | |
crypto/blake2b | Package blake2b implements the BLAKE2b hash algorithm defined by RFC 7693 and the extendable output function (XOF) BLAKE2Xb. |
crypto/bls12381 | |
crypto/bn256 | Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve. |
crypto/bn256/cloudflare | Package bn256 implements a particular bilinear group at the 128-bit security level. |
crypto/bn256/google | Package bn256 implements a particular bilinear group. |
crypto/ecies | |
crypto/secp256k1 | Package secp256k1 wraps the bitcoin secp256k1 C library. |
eth | Package eth implements the Ethereum protocol. |
ethclient | Package ethclient provides a client for the Ethereum RPC API. |
ethdb | Package ethdb defines the interfaces for an Ethereum data store. |
ethdb/dbtest | |
ethdb/leveldb | Package leveldb implements the key-value database layer based on LevelDB. |
ethdb/memorydb | Package memorydb implements the key-value database layer based on memory maps. |
eth/downloader | Package downloader contains the manual full chain synchronisation. |
eth/fetcher | Package fetcher contains the announcement based header, blocks or transaction synchronisation. |
eth/filters | Package filters implements an ethereum filtering system for block, transactions and log events. |
eth/gasprice | |
ethstats | Package ethstats implements the network stats reporting service. |
eth/tracers | Package tracers is a collection of JavaScript transaction tracers. |
event | Package event deals with subscriptions to real-time events. |
graphql | Package graphql provides a GraphQL interface to Ethereum node data. |
les | Package les implements the Light Ethereum Subprotocol. |
les/checkpointoracle | Package checkpointoracle is a wrapper of checkpoint oracle contract with additional rules defined. |
les/flowcontrol | Package flowcontrol implements a client side flow control mechanism |
les/utils | |
light | Package light implements on-demand retrieval capable state and chain objects for the Ethereum Light Client. |
log | Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable. |
metrics | Go port of Coda Hale's Metrics library |
metrics/exp | Hook 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/prometheus | Package prometheus exposes go-metrics into a Prometheus format. |
miner | Package miner implements Ethereum block creation and mining. |
mobile | Package geth contains the simplified mobile APIs to go-ethereum. |
node | Package node sets up multi-protocol Ethereum nodes. |
p2p | Package p2p implements the Ethereum p2p network protocols. |
p2p/discover | Package discover implements the Node Discovery Protocol. |
p2p/discover/v4wire | Package v4wire implements the Discovery v4 Wire Protocol. |
p2p/discover/v5wire | |
p2p/discv5 | Package discv5 is a prototype implementation of Discvery v5. |
p2p/dnsdisc | Package dnsdisc implements node discovery via DNS (EIP-1459). |
p2p/enode | |
p2p/enr | Package enr implements Ethereum Node Records as defined in EIP-778. |
p2p/nat | Package nat provides access to common network port mapping protocols. |
p2p/netutil | Package netutil contains extensions to the net package. |
p2p/nodestate | |
p2p/rlpx | Package rlpx implements the RLPx transport protocol. |
p2p/simulations | Package simulations simulates p2p networks. |
p2p/simulations/adapters | |
p2p/simulations/examples | |
p2p/simulations/pipes | |
params | |
params/confp | |
params/confp/generic | Package generic implements logic that should be applied for all data types available as configuration parameter implementations. |
params/confp/tconvert | Package tconvert and included logic should be removed eventually. |
params/types | |
params/types/aleth | |
params/types/coregeth | |
params/types/ctypes | |
params/types/genesisT | |
params/types/goethereum | |
params/types/internal | |
params/types/multigeth | |
params/types/parity | |
params/types/pyethereum | |
params/vars | |
rlp | Package rlp implements the RLP serialization format. |
rpc | Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports. |
tests | Package tests implements execution of Ethereum JSON tests. |
trie | Package trie implements Merkle Patricia Tries. |
Package ethereum imports 5 packages (graph). Updated 2021-01-22. Refresh now. Tools for package owners.