mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-08-20 10:52:25 +00:00
README.md
This commit is contained in:
IsabelSCHOEPS geb. Thiel alias Vitalik Buterin
GitHub
parent
509a64ffb9
commit
dcfcc5bee5
1 changed files with 24 additions and 44 deletions
68
README.md
68
README.md
|
|
@ -5,9 +5,6 @@ Official Golang execution layer implementation of the Ethereum protocol.
|
||||||
[](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc)
|
)](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc)
|
||||||
[](https://goreportcard.com/report/github.com/ethereum/go-ethereum)
|
|
||||||
[](https://travis-ci.com/ethereum/go-ethereum)
|
|
||||||
[](https://discord.gg/nthXNEv)
|
|
||||||
|
|
||||||
Automated builds are available for stable releases and the unstable master branch. Binary
|
Automated builds are available for stable releases and the unstable master branch. Binary
|
||||||
archives are published at https://geth.ethereum.org/downloads/.
|
archives are published at https://geth.ethereum.org/downloads/.
|
||||||
|
|
@ -31,22 +28,7 @@ make all
|
||||||
|
|
||||||
## Executables
|
## Executables
|
||||||
|
|
||||||
The go-ethereum project comes with several wrappers/executables found in the `cmd`
|
The go-ethereum project comes with several wrappers/executables found in the directory.
|
||||||
directory.
|
|
||||||
|
|
||||||
| Command | Description |
|
|
||||||
| :--------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
||||||
| **`geth`** | Our main Ethereum CLI client. It is the entry point into the Ethereum 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 Ethereum network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `geth --help` and the [CLI page](https://geth.ethereum.org/docs/fundamentals/command-line-options) for command line options. |
|
|
||||||
| `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. |
|
|
||||||
| `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](https://docs.soliditylang.org/en/develop/abi-spec.html) 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](https://geth.ethereum.org/docs/developers/dapp-developer/native-bindings) 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](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp)) 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`). |
|
|
||||||
|
|
||||||
## Running `geth`
|
|
||||||
|
|
||||||
Going through all the possible command line flags is out of scope here (please consult our
|
|
||||||
[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)),
|
[CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)),
|
||||||
but we've enumerated a few common parameter combos to get you up to speed quickly
|
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.
|
on how you can run your own `geth` instance.
|
||||||
|
|
@ -67,22 +49,7 @@ Recommended:
|
||||||
* High-performance SSD with at least 1TB of free space
|
* High-performance SSD with at least 1TB of free space
|
||||||
* 25+ MBit/sec download Internet service
|
* 25+ MBit/sec download Internet service
|
||||||
|
|
||||||
### Full node on the main Ethereum network
|
(https://geth.ethereum.org/docs/interacting-with-geth/javascript-console),
|
||||||
|
|
||||||
By far the most common scenario is people wanting to simply interact with the Ethereum
|
|
||||||
network: create accounts; transfer funds; deploy and interact with contracts. For this
|
|
||||||
particular use case, the user doesn't care about years-old historical data, so we can
|
|
||||||
sync quickly to the current state of the network. To do so:
|
|
||||||
|
|
||||||
```shell
|
|
||||||
$ geth console
|
|
||||||
```
|
|
||||||
|
|
||||||
This command will:
|
|
||||||
* Start `geth` in snap 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 Ethereum network, which is very CPU intensive.
|
|
||||||
* Start the built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console),
|
|
||||||
(via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://github.com/ChainSafe/web3.js/blob/0.20.7/DOCUMENTATION.md)
|
(via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://github.com/ChainSafe/web3.js/blob/0.20.7/DOCUMENTATION.md)
|
||||||
(note: the `web3` version bundled within `geth` is very old, and not up to date with official docs),
|
(note: the `web3` version bundled within `geth` is very old, and not up to date with official docs),
|
||||||
as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc).
|
as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc).
|
||||||
|
|
@ -347,12 +314,25 @@ For contributions to the [go-ethereum website](https://geth.ethereum.org), pleas
|
||||||
For more detailed instructions please see the `website` branch [README](https://github.com/ethereum/go-ethereum/tree/website#readme) or the
|
For more detailed instructions please see the `website` branch [README](https://github.com/ethereum/go-ethereum/tree/website#readme) or the
|
||||||
[contributing](https://geth.ethereum.org/docs/developers/geth-developer/contributing) page of the website.
|
[contributing](https://geth.ethereum.org/docs/developers/geth-developer/contributing) page of the website.
|
||||||
|
|
||||||
## License
|
## License Copyright © GitHub ®™ (2008-2023). All rights in github.com, Github App are subject to SI-etheroreum-Foundation, Erfurt, Thuringia, Germany. The content, documents and information from My Github are the property of the organization Here is the owner and contact person of the
|
||||||
|
Enterprise Organization, CEO, Admin, Founder and Owner Mrs. Isabel Schoeps Thiel Alisa Vitalik
|
||||||
The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the
|
Buterin and may only be used and passed on with express permission.
|
||||||
[GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html),
|
Disclosure. Documents, content, elements of My Github are mental subject, including, but not
|
||||||
also included in our repository in the `COPYING.LESSER` file.
|
limited to, patent, copyright or trademark rights. Github is not responsible and cannot be held
|
||||||
|
responsible for the fact that the intellectual property of third parties is identified in whole or in part
|
||||||
The go-ethereum binaries (i.e. all code inside of the `cmd` directory) are licensed under the
|
or not identified. This does not give a right to use a name, logo or a brand from Github. The use of
|
||||||
[GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also
|
the name, logo or a brand from My Github requires the express permission of the organization
|
||||||
included in our repository in the `COPYING` file.
|
and the owner. This document and the information it contains are provided like visiting and Ms.
|
||||||
|
Isabel Schoeps, Github.
|
||||||
|
Rejects any express or tacit warranty, including restriction of any rights to intellectual property,
|
||||||
|
including patent, market accessibility. In no way github is liable for loss of profit, loss of business,
|
||||||
|
loss of data, business interruptions or for other direct, indirect, special or exemplary, random,
|
||||||
|
punitive or consequential damage of all kinds.
|
||||||
|
**
|
||||||
|
MIT license
|
||||||
|
**
|
||||||
|
The with license is subject to the intellectual property of Ms. Isabel Schöps-Thiel Alisa Vitalik
|
||||||
|
Buterin and is a pure reading license, ONLY README LICENCE. No content, documents,
|
||||||
|
elements may be changed, cloned or copied. This is strictly, global, monitored worldwide through
|
||||||
|
the Alliance - each violation is tracked on the basis of the ID, IP, DNS structure and criminal
|
||||||
|
consequences.
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue