ethereum

package module
v0.0.0-...-979e23b Latest Latest
Warning

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

 Go to latest Published: Mar 26, 2024 License: GPL-3.0 Imports: 5 Imported by: 0

README

Go Ronin

Official Golang execution layer implementation of the Ronin protocol. It is a fork of Go Ethereum - https://github.com/aymantaybi/ronin and EVM compatible.

Ronin consensus uses Proof of Staked Authority, a combination of dPoS and PoA, to increase the level of decentralization and allows the token holders to join the network as validators

Check out the whitepaper for more information.

Discord

Executables

The go-ethereum project comes with several wrappers/executables found in the cmd directory.

Command Description
ronin Our main Ronin CLI client. It is the entry point into the Ronin network (main-, test- or private net), capable of running as a full node (default), archive node (retaining all historical state) or a light node (retrieving data live). It can be used by other processes as a gateway into the Ronin network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. ronin --help and the CLI page for command line options.
clef Stand-alone signing tool, which can be used as a backend signer for ronin.
devp2p Utilities to interact with nodes on the networking layer, without running a full blockchain.
abigen Source code generator to convert Ethereum contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain Ethereum contract ABIs with expanded functionality if the contract bytecode is also available. However, it also accepts Solidity source files, making development much more streamlined. Please see our Native DApps page for details.
bootnode Stripped down version of our Ethereum client implementation that only takes part in the network node discovery protocol, but does not run any of the higher level application protocols. It can be used as a lightweight bootstrap node to aid in finding peers in private networks.
evm Developer utility version of the EVM (Ethereum Virtual Machine) that is capable of running bytecode snippets within a configurable environment and execution mode. Its purpose is to allow isolated, fine-grained debugging of EVM opcodes (e.g. evm --code 60ff60ff --debug run).
rlpdump Developer utility tool to convert binary RLP (Recursive Length Prefix) dumps (data encoding used by the Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. rlpdump --hex CE0183FFFFFFC4C304050583616263).
puppeth a CLI wizard that aids in creating a new Ethereum network.

Running ronin

Going through all the possible command line flags is out of scope here (please consult our CLI Wiki page), but we've enumerated a few common parameter combos to get you up to speed quickly on how you can run your own geth instance.

Requirements

Running a full Ronin node:

  • CPU: Equivalent of 8 AWS vCPU
  • RAM: 16GB
  • Storage: At least 1 TB high-speed SSD
  • Network: Reliable IPv4 or IPv6 network connection, with an open public port

Running an archive Ronin node:

  • CPU: Equivalent of 8 AWS vCPU
  • RAM: 16GB
  • Storage: At least 5 TB high-speed SSD
  • Network: Reliable IPv4 or IPv6 network connection, with an open public port

Building the source

Building ronin requires both a Go (version 1.17 or later) and a C compiler. You can install them using your favourite package manager. Once the dependencies are installed, run

make ronin

or, to build the full suite of utilities:

make all

Init genesis

Before running a full node, init genesis block is necessary

ronin init genesis/mainnet.json --datadir /opt/ronin

Full node on the main Ronin network

$ ronin --http.api eth,net,web3,consortium --networkid 2020 --discovery.dns enrtree://AIGOFYDZH6BGVVALVJLRPHSOYJ434MPFVVQFXJDXHW5ZYORPTGKUI@nodes.roninchain.com --datadir /opt/ronin --port 30303 --http --http.corsdomain '*' --http.addr 0.0.0.0 --http.port 8545 --http.vhosts '*' --ws --ws.addr 0.0.0.0 --ws.port 8546 --ws.origins '*'

This command will:

  • Start ronin in full sync mode (default, can be changed with the --syncmode flag), causing it to download more data in exchange for avoiding processing the entire history of the Ronin network, which is very CPU intensive.

Configuration

As an alternative to passing the numerous flags to the ronin binary, you can also pass a configuration file via:

$ ronin --config /path/to/your_config.toml

To get an idea of how the file should look like you can use the dumpconfig subcommand to export your existing configuration:

$ ronin --your-favourite-flags dumpconfig

Programmatically interfacing ronin nodes

As a developer, sooner rather than later you'll want to start interacting with ronin and the Ronin network via your own programs and not manually through the console. To aid this, ronin has built-in support for a JSON-RPC based APIs which are the same as Ethereum that can be found at (standard APIs and ronin specific APIs). These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based platforms, and named pipes on Windows).

The IPC interface is enabled by default and exposes all the APIs supported by ronin, whereas the HTTP and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. These can be turned on/off and configured as you'd expect.

HTTP based JSON-RPC API options:

  • --http Enable the HTTP-RPC server
  • --http.addr HTTP-RPC server listening interface (default: localhost)
  • --http.port HTTP-RPC server listening port (default: 8545)
  • --http.api API's offered over the HTTP-RPC interface (default: eth,net,web3)
  • --http.corsdomain Comma separated list of domains from which to accept cross origin requests (browser enforced)
  • --ws Enable the WS-RPC server
  • --ws.addr WS-RPC server listening interface (default: localhost)
  • --ws.port WS-RPC server listening port (default: 8546)
  • --ws.api API's offered over the WS-RPC interface (default: eth,net,web3)
  • --ws.origins Origins from which to accept websockets requests
  • --ipcdisable Disable the IPC-RPC server
  • --ipcapi API's offered over the IPC-RPC interface (default: admin,debug,eth,miner,net,personal,shh,txpool,web3)
  • --ipcpath Filename for IPC socket/pipe within the datadir (explicit paths escape it)

You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect via HTTP, WS or IPC to a geth node configured with the above flags and you'll need to speak JSON-RPC on all transports. You can reuse the same connection for multiple requests!

Note: Please understand the security implications of opening up an HTTP/WS based transport before doing so! Hackers on the internet are actively trying to subvert Ethereum nodes with exposed APIs! Further, all browser tabs can access locally running web servers, so malicious web pages could try to subvert locally available APIs!

How to contribute

Contribution guidelines

  • Quality: Code in the Ronin project should meet the style guidelines, with sufficient test-cases, descriptive commit messages, evidence that the contribution does not break any compatibility commitments or cause adverse feature interactions, and evidence of high-quality peer-review.
  • Size: The Ronin project's culture is one of small pull-requests, regularly submitted. The larger a pull-request, the more likely it is that you will be asked to resubmit as a series of self-contained and individually reviewable smaller PRs.
  • Maintainability: If the feature will require ongoing maintenance (eg support for a particular branch of database), we may ask you to accept responsibility for maintaining this feature
  • Commit message: Commit messages of Ronin project follows https://www.conventionalcommits.org/en/v1.0.0/

Submit an issue

  • Create a new issue
  • Comment on the issue (if you'd like to be assigned to it) - that way our team can assign the issue to you
  • If you do not have a specific contribution in mind, you can also browse the issues labelled as help wanted
  • Issues that additionally have the good first issue label are considered ideal for first-timers

Submit your PR

  • After your changes are committed to your GitHub fork, submit a pull request (PR) to the master branch of the axieinfinity/ronin repo
  • In your PR description, reference the issue it resolves (see linking a pull request to an issue using a keyword)
    • ex: [FIXES #123] feat: update out of date content

Wait for review

  • The team reviews every PR
  • Acceptable PRs will be approved & merged into the master branch

Release

License

The go-ethereum library (i.e. all code outside of the cmd directory) is licensed under the GNU Lesser General Public License v3.0, also included in our repository in the COPYING.LESSER file.

The go-ethereum binaries (i.e. all code inside of the cmd directory) is licensed under the GNU General Public License v3.0, also included in our repository in the COPYING file.

Documentation

Overview

Package ethereum defines interfaces for interacting with Ethereum.

Index

Constants

This section is empty.

Variables

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

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

Functions

This section is empty.

Types

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.
}

CallMsg contains parameters for contract calls.

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

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

View all Source files

Directories

Path Synopsis
Package accounts implements high level Ethereum account management.
 Package accounts implements high level Ethereum account management.
abi
Package abi implements the Ethereum ABI (Application Binary Interface).
 Package abi implements the Ethereum ABI (Application Binary Interface).
abi/bind
Package bind generates Ethereum contract Go bindings.
 Package bind generates Ethereum contract Go bindings.
abi/bind/backends
bls
external
keystore
Package keystore implements encrypted storage of secp256k1 private keys.
 Package keystore implements encrypted storage of secp256k1 private keys.
scwallet
usbwallet
Package usbwallet implements support for USB hardware wallets.
 Package usbwallet implements support for USB hardware wallets.
usbwallet/trezor
Package trezor contains the wire protocol.
 Package trezor contains the wire protocol.
cmd
abidump
abigen
bootnode
bootnode runs a bootstrap node for the Ethereum Discovery Protocol.
 bootnode runs a bootstrap node for the Ethereum Discovery Protocol.
checkpoint-admin
checkpoint-admin is a utility that can be used to query checkpoint information and register stable checkpoints into an oracle contract.
 checkpoint-admin is a utility that can be used to query checkpoint information and register stable checkpoints into an oracle contract.
clef
devp2p
devp2p/internal/ethtest
devp2p/internal/v4test
devp2p/internal/v5test
ethkey
evm
evm executes EVM code snippets.
 evm executes EVM code snippets.
evm/internal/compiler
evm/internal/t8ntool
faucet
faucet is an Ether faucet backed by a light client.
 faucet is an Ether faucet backed by a light client.
p2psim
p2psim provides a command-line client for a simulation HTTP API.
 p2psim provides a command-line client for a simulation HTTP API.
puppeth
puppeth is a command to assemble and maintain private networks.
 puppeth is a command to assemble and maintain private networks.
rlpdump
rlpdump is a pretty-printer for RLP data.
 rlpdump is a pretty-printer for RLP data.
ronin
geth is the official command-line client for Ethereum.
 geth is the official command-line client for Ethereum.
utils
Package utils contains internal helper functions for go-ethereum commands.
 Package utils contains internal helper functions for go-ethereum commands.
Package common contains various helper functions.
 Package common contains various helper functions.
bitutil
Package bitutil implements fast bitwise operations.
 Package bitutil implements fast bitwise operations.
compiler
Package compiler wraps the Solidity and Vyper compiler executables (solc; vyper).
 Package compiler wraps the Solidity and Vyper compiler executables (solc; vyper).
fdlimit
hexutil
Package hexutil implements hex encoding with 0x prefix.
 Package hexutil implements hex encoding with 0x prefix.
math
Package math provides integer math utilities.
 Package math provides integer math utilities.
mclock
Package mclock is a wrapper for a monotonic clock source
 Package mclock is a wrapper for a monotonic clock source
prque
Package prque implements a priority queue data structure supporting arbitrary value types and int64 priorities.
 Package prque implements a priority queue data structure supporting arbitrary value types and int64 priorities.
Package consensus implements different Ethereum consensus engines.
 Package consensus implements different Ethereum consensus engines.
clique
Package clique implements the proof-of-authority consensus engine.
 Package clique implements the proof-of-authority consensus engine.
consortium
consortium/common
consortium/generated_contracts/finality_tracking
consortium/generated_contracts/profile
consortium/generated_contracts/ronin_validator_set
consortium/generated_contracts/slash_indicator
consortium/v1
Package v1 implements the proof-of-authority consensus engine.
 Package v1 implements the proof-of-authority consensus engine.
consortium/v2
consortium/v2/finality
ethash
Package ethash implements the ethash proof-of-work consensus engine.
 Package ethash implements the ethash proof-of-work consensus engine.
misc
prompt
contracts
checkpointoracle
Package checkpointoracle is a an on-chain light client checkpoint oracle.
 Package checkpointoracle is a an on-chain light client checkpoint oracle.
checkpointoracle/contract
Package core implements the Ethereum consensus protocol.
 Package core implements the Ethereum consensus protocol.
asm
Provides support for dealing with EVM assembly instructions (e.g., disassembling them).
 Provides support for dealing with EVM assembly instructions (e.g., disassembling them).
bloombits
Package bloombits implements bloom filtering on batches of data.
 Package bloombits implements bloom filtering on batches of data.
forkid
Package forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
 Package forkid implements EIP-2124 (https://eips.ethereum.org/EIPS/eip-2124).
rawdb
Package rawdb contains a collection of low level database accessors.
 Package rawdb contains a collection of low level database accessors.
state
Package state provides a caching layer atop the Ethereum state trie.
 Package state provides a caching layer atop the Ethereum state trie.
state/pruner
state/snapshot
Package snapshot implements a journalled, dynamic state dump.
 Package snapshot implements a journalled, dynamic state dump.
types
Package types contains data types related to Ethereum consensus.
 Package types contains data types related to Ethereum consensus.
vm
Package vm implements the Ethereum Virtual Machine.
 Package vm implements the Ethereum Virtual Machine.
vm/runtime
Package runtime provides a basic execution model for executing EVM code.
 Package runtime provides a basic execution model for executing EVM code.
vote
blake2b
Package blake2b implements the BLAKE2b hash algorithm defined by RFC 7693 and the extendable output function (XOF) BLAKE2Xb.
 Package blake2b implements the BLAKE2b hash algorithm defined by RFC 7693 and the extendable output function (XOF) BLAKE2Xb.
bls
Package bls implements a go-wrapper around a library implementing the BLS12-381 curve and signature scheme.
 Package bls implements a go-wrapper around a library implementing the BLS12-381 curve and signature scheme.
bls/blst
Package blst implements a go-wrapper around a library implementing the BLS12-381 curve and signature scheme.
 Package blst implements a go-wrapper around a library implementing the BLS12-381 curve and signature scheme.
bls/common
Package common provides the BLS interfaces that are implemented by the various BLS wrappers.
 Package common provides the BLS interfaces that are implemented by the various BLS wrappers.
bls/common/mock
Package mock is a generated GoMock package.
 Package mock is a generated GoMock package.
bls12381
bn256
Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve.
 Package bn256 implements the Optimal Ate pairing over a 256-bit Barreto-Naehrig curve.
bn256/cloudflare
Package bn256 implements a particular bilinear group at the 128-bit security level.
 Package bn256 implements a particular bilinear group at the 128-bit security level.
bn256/google
Package bn256 implements a particular bilinear group.
 Package bn256 implements a particular bilinear group.
ecies
rand
Package rand defines methods of obtaining random number generators.
 Package rand defines methods of obtaining random number generators.
secp256k1
Package secp256k1 wraps the bitcoin secp256k1 C library.
 Package secp256k1 wraps the bitcoin secp256k1 C library.
signify
eth
Package eth implements the Ethereum protocol.
 Package eth implements the Ethereum protocol.
catalyst
Package catalyst implements the temporary eth1/eth2 RPC integration.
 Package catalyst implements the temporary eth1/eth2 RPC integration.
downloader
Package downloader contains the manual full chain synchronisation.
 Package downloader contains the manual full chain synchronisation.
ethconfig
Package ethconfig contains the configuration of the ETH and LES protocols.
 Package ethconfig contains the configuration of the ETH and LES protocols.
fetcher
Package fetcher contains the announcement based header, blocks or transaction synchronisation.
 Package fetcher contains the announcement based header, blocks or transaction synchronisation.
filters
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.
gasestimator
gasprice
protocols
protocols/eth
protocols/ronin
protocols/snap
tracers
Package tracers is a manager for transaction tracing engines.
 Package tracers is a manager for transaction tracing engines.
tracers/internal/tracetest
tracers/js
tracers/js/internal/tracers
Package tracers contains the actual JavaScript tracer assets.
 Package tracers contains the actual JavaScript tracer assets.
tracers/logger
tracers/native
Package ethclient provides a client for the Ethereum RPC API.
 Package ethclient provides a client for the Ethereum RPC API.
gethclient
Package gethclient provides an RPC client for geth-specific APIs.
 Package gethclient provides an RPC client for geth-specific APIs.
Package ethdb defines the interfaces for an Ethereum data store.
 Package ethdb defines the interfaces for an Ethereum data store.
dbtest
leveldb
Package leveldb implements the key-value database layer based on LevelDB.
 Package leveldb implements the key-value database layer based on LevelDB.
memorydb
Package memorydb implements the key-value database layer based on memory maps.
 Package memorydb implements the key-value database layer based on memory maps.
pebble
Package pebble implements the key-value database layer based on pebble.
 Package pebble implements the key-value database layer based on pebble.
Package ethstats implements the network stats reporting service.
 Package ethstats implements the network stats reporting service.
Package event deals with subscriptions to real-time events.
 Package event deals with subscriptions to real-time events.
Package graphql provides a GraphQL interface to Ethereum node data.
 Package graphql provides a GraphQL interface to Ethereum node data.
internal
build
cmdtest
debug
Package debug interfaces Go runtime debugging facilities.
 Package debug interfaces Go runtime debugging facilities.
ethapi
Package ethapi implements the general Ethereum API functions.
 Package ethapi implements the general Ethereum API functions.
flags
guide
Package guide is a small test suite to ensure snippets in the dev guide work.
 Package guide is a small test suite to ensure snippets in the dev guide work.
jsre
Package jsre provides execution environment for JavaScript.
 Package jsre provides execution environment for JavaScript.
jsre/deps
Package deps contains the console JavaScript dependencies Go embedded.
 Package deps contains the console JavaScript dependencies Go embedded.
syncx
Package syncx contains exotic synchronization primitives.
 Package syncx contains exotic synchronization primitives.
testlog
Package testlog provides a log handler for unit tests.
 Package testlog provides a log handler for unit tests.
utesting
Package utesting provides a standalone replacement for package testing.
 Package utesting provides a standalone replacement for package testing.
web3ext
package web3ext contains geth specific web3.js extensions.
 package web3ext contains geth specific web3.js extensions.
les
Package les implements the Light Ethereum Subprotocol.
 Package les implements the Light Ethereum Subprotocol.
checkpointoracle
Package checkpointoracle is a wrapper of checkpoint oracle contract with additional rules defined.
 Package checkpointoracle is a wrapper of checkpoint oracle contract with additional rules defined.
downloader
This is a temporary package whilst working on the eth/66 blocking refactors.
 This is a temporary package whilst working on the eth/66 blocking refactors.
fetcher
This is a temporary package whilst working on the eth/66 blocking refactors.
 This is a temporary package whilst working on the eth/66 blocking refactors.
flowcontrol
Package flowcontrol implements a client side flow control mechanism
 Package flowcontrol implements a client side flow control mechanism
utils
vflux
vflux/client
vflux/server
Package light implements on-demand retrieval capable state and chain objects for the Ethereum Light Client.
 Package light implements on-demand retrieval capable state and chain objects for the Ethereum Light Client.
Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
 Package log15 provides an opinionated, simple toolkit for best-practice logging that is both human and machine readable.
Go port of Coda Hale's Metrics library
 Go port of Coda Hale's Metrics library
exp
Hook go-metrics into expvar on any /debug/metrics request, load all vars from the registry into expvar, and execute regular expvar handler
 Hook go-metrics into expvar on any /debug/metrics request, load all vars from the registry into expvar, and execute regular expvar handler
influxdb
The go-ethereum library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 The go-ethereum library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
librato
prometheus
Package prometheus exposes go-metrics into a Prometheus format.
 Package prometheus exposes go-metrics into a Prometheus format.
Package miner implements Ethereum block creation and mining.
 Package miner implements Ethereum block creation and mining.
stress/1559
This file contains a miner stress test for eip 1559.
 This file contains a miner stress test for eip 1559.
stress/clique
This file contains a miner stress test based on the Clique consensus engine.
 This file contains a miner stress test based on the Clique consensus engine.
stress/ethash
This file contains a miner stress test based on the Ethash consensus engine.
 This file contains a miner stress test based on the Ethash consensus engine.
Package geth contains the simplified mobile APIs to go-ethereum.
 Package geth contains the simplified mobile APIs to go-ethereum.
Package node sets up multi-protocol Ethereum nodes.
 Package node sets up multi-protocol Ethereum nodes.
p2p
Package p2p implements the Ethereum p2p network protocols.
 Package p2p implements the Ethereum p2p network protocols.
discover
Package discover implements the Node Discovery Protocol.
 Package discover implements the Node Discovery Protocol.
discover/v4wire
Package v4wire implements the Discovery v4 Wire Protocol.
 Package v4wire implements the Discovery v4 Wire Protocol.
discover/v5wire
dnsdisc
Package dnsdisc implements node discovery via DNS (EIP-1459).
 Package dnsdisc implements node discovery via DNS (EIP-1459).
enode
enr
Package enr implements Ethereum Node Records as defined in EIP-778.
 Package enr implements Ethereum Node Records as defined in EIP-778.
msgrate
Package msgrate allows estimating the throughput of peers for more balanced syncs.
 Package msgrate allows estimating the throughput of peers for more balanced syncs.
nat
Package nat provides access to common network port mapping protocols.
 Package nat provides access to common network port mapping protocols.
netutil
Package netutil contains extensions to the net package.
 Package netutil contains extensions to the net package.
nodestate
rlpx
Package rlpx implements the RLPx transport protocol.
 Package rlpx implements the RLPx transport protocol.
simulations
Package simulations simulates p2p networks.
 Package simulations simulates p2p networks.
simulations/adapters
simulations/examples
simulations/pipes
tracker
Package rlp implements the RLP serialization format.
 Package rlp implements the RLP serialization format.
Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports.
 Package rpc implements bi-directional JSON-RPC 2.0 on multiple transports.
signer
core
core/apitypes
fourbyte
Package fourbyte contains the 4byte database.
 Package fourbyte contains the 4byte database.
rules
storage
Package tests implements execution of Ethereum JSON tests.
 Package tests implements execution of Ethereum JSON tests.
fuzzers/abi
fuzzers/bitutil
fuzzers/bls12381
fuzzers/difficulty
fuzzers/difficulty/debug
fuzzers/keystore
fuzzers/les
fuzzers/les/debug
fuzzers/rangeproof
fuzzers/rangeproof/debug
fuzzers/rlp
fuzzers/runtime
fuzzers/secp256k1
fuzzers/stacktrie
fuzzers/stacktrie/debug
fuzzers/trie
fuzzers/txfetcher
fuzzers/vflux
fuzzers/vflux/debug
Package trie implements Merkle Patricia Tries.
 Package trie implements Merkle Patricia Tries.

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.