github.com/tacshi/go-ethereum@v0.0.0-20230616113857-84a434e20921/README.md (about) 1 ## Go Ethereum 2 3 Official Golang execution layer implementation of the Ethereum protocol. 4 5 [](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc) 8 [](https://goreportcard.com/report/github.com/ethereum/go-ethereum) 9 [](https://travis-ci.com/ethereum/go-ethereum) 10 [](https://discord.gg/nthXNEv) 11 12 Automated builds are available for stable releases and the unstable master branch. Binary 13 archives are published at https://geth.ethereum.org/downloads/. 14 15 ## Building the source 16 17 For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/getting-started/installing-geth). 18 19 Building `geth` requires both a Go (version 1.19 or later) and a C compiler. You can install 20 them using your favourite package manager. Once the dependencies are installed, run 21 22 ```shell 23 make geth 24 ``` 25 26 or, to build the full suite of utilities: 27 28 ```shell 29 make all 30 ``` 31 32 ## Executables 33 34 The go-ethereum project comes with several wrappers/executables found in the `cmd` 35 directory. 36 37 | Command | Description | 38 | :--------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 39 | **`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/interface/command-line-options) for command line options. | 40 | `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. | 41 | `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. | 42 | `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/dapp/native-bindings) page for details. | 43 | `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. | 44 | `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`). | 45 | `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`). | 46 47 ## Running `geth` 48 49 Going through all the possible command line flags is out of scope here (please consult our 50 [CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)), 51 but we've enumerated a few common parameter combos to get you up to speed quickly 52 on how you can run your own `geth` instance. 53 54 ### Hardware Requirements 55 56 Minimum: 57 58 * CPU with 2+ cores 59 * 4GB RAM 60 * 1TB free storage space to sync the Mainnet 61 * 8 MBit/sec download Internet service 62 63 Recommended: 64 65 * Fast CPU with 4+ cores 66 * 16GB+ RAM 67 * High-performance SSD with at least 1TB of free space 68 * 25+ MBit/sec download Internet service 69 70 ### Full node on the main Ethereum network 71 72 By far the most common scenario is people wanting to simply interact with the Ethereum 73 network: create accounts; transfer funds; deploy and interact with contracts. For this 74 particular use case, the user doesn't care about years-old historical data, so we can 75 sync quickly to the current state of the network. To do so: 76 77 ```shell 78 $ geth console 79 ``` 80 81 This command will: 82 * Start `geth` in snap sync mode (default, can be changed with the `--syncmode` flag), 83 causing it to download more data in exchange for avoiding processing the entire history 84 of the Ethereum network, which is very CPU intensive. 85 * Start the built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console), 86 (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) 87 (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), 88 as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server). 89 This tool is optional and if you leave it out you can always attach it to an already running 90 `geth` instance with `geth attach`. 91 92 ### A Full node on the Görli test network 93 94 Transitioning towards developers, if you'd like to play around with creating Ethereum 95 contracts, you almost certainly would like to do that without any real money involved until 96 you get the hang of the entire system. In other words, instead of attaching to the main 97 network, you want to join the **test** network with your node, which is fully equivalent to 98 the main network, but with play-Ether only. 99 100 ```shell 101 $ geth --goerli console 102 ``` 103 104 The `console` subcommand has the same meaning as above and is equally 105 useful on the testnet too. 106 107 Specifying the `--goerli` flag, however, will reconfigure your `geth` instance a bit: 108 109 * Instead of connecting to the main Ethereum network, the client will connect to the Görli 110 test network, which uses different P2P bootnodes, different network IDs and genesis 111 states. 112 * Instead of using the default data directory (`~/.ethereum` on Linux for example), `geth` 113 will nest itself one level deeper into a `goerli` subfolder (`~/.ethereum/goerli` on 114 Linux). Note, on OSX and Linux this also means that attaching to a running testnet node 115 requires the use of a custom endpoint since `geth attach` will try to attach to a 116 production node endpoint by default, e.g., 117 `geth attach <datadir>/goerli/geth.ipc`. Windows users are not affected by 118 this. 119 120 *Note: Although some internal protective measures prevent transactions from 121 crossing over between the main network and test network, you should always 122 use separate accounts for play and real money. Unless you manually move 123 accounts, `geth` will by default correctly separate the two networks and will not make any 124 accounts available between them.* 125 126 ### Full node on the Rinkeby test network 127 128 Go Ethereum also supports connecting to the older proof-of-authority based test network 129 called [*Rinkeby*](https://www.rinkeby.io) which is operated by members of the community. 130 131 ```shell 132 $ geth --rinkeby console 133 ``` 134 135 ### Configuration 136 137 As an alternative to passing the numerous flags to the `geth` binary, you can also pass a 138 configuration file via: 139 140 ```shell 141 $ geth --config /path/to/your_config.toml 142 ``` 143 144 To get an idea of how the file should look like you can use the `dumpconfig` subcommand to 145 export your existing configuration: 146 147 ```shell 148 $ geth --your-favourite-flags dumpconfig 149 ``` 150 151 *Note: This works only with `geth` v1.6.0 and above.* 152 153 #### Docker quick start 154 155 One of the quickest ways to get Ethereum up and running on your machine is by using 156 Docker: 157 158 ```shell 159 docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \ 160 -p 8545:8545 -p 30303:30303 \ 161 ethereum/client-go 162 ``` 163 164 This will start `geth` in snap-sync mode with a DB memory allowance of 1GB, as the 165 above command does. It will also create a persistent volume in your home directory for 166 saving your blockchain as well as map the default ports. There is also an `alpine` tag 167 available for a slim version of the image. 168 169 Do not forget `--http.addr 0.0.0.0`, if you want to access RPC from other containers 170 and/or hosts. By default, `geth` binds to the local interface and RPC endpoints are not 171 accessible from the outside. 172 173 ### Programmatically interfacing `geth` nodes 174 175 As a developer, sooner rather than later you'll want to start interacting with `geth` and the 176 Ethereum network via your own programs and not manually through the console. To aid 177 this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://ethereum.github.io/execution-apis/api-documentation/) 178 and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)). 179 These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based 180 platforms, and named pipes on Windows). 181 182 The IPC interface is enabled by default and exposes all the APIs supported by `geth`, 183 whereas the HTTP and WS interfaces need to manually be enabled and only expose a 184 subset of APIs due to security reasons. These can be turned on/off and configured as 185 you'd expect. 186 187 HTTP based JSON-RPC API options: 188 189 * `--http` Enable the HTTP-RPC server 190 * `--http.addr` HTTP-RPC server listening interface (default: `localhost`) 191 * `--http.port` HTTP-RPC server listening port (default: `8545`) 192 * `--http.api` API's offered over the HTTP-RPC interface (default: `eth,net,web3`) 193 * `--http.corsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 194 * `--ws` Enable the WS-RPC server 195 * `--ws.addr` WS-RPC server listening interface (default: `localhost`) 196 * `--ws.port` WS-RPC server listening port (default: `8546`) 197 * `--ws.api` API's offered over the WS-RPC interface (default: `eth,net,web3`) 198 * `--ws.origins` Origins from which to accept WebSocket requests 199 * `--ipcdisable` Disable the IPC-RPC server 200 * `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,txpool,web3`) 201 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 202 203 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to 204 connect via HTTP, WS or IPC to a `geth` node configured with the above flags and you'll 205 need to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You 206 can reuse the same connection for multiple requests! 207 208 **Note: Please understand the security implications of opening up an HTTP/WS based 209 transport before doing so! Hackers on the internet are actively trying to subvert 210 Ethereum nodes with exposed APIs! Further, all browser tabs can access locally 211 running web servers, so malicious web pages could try to subvert locally available 212 APIs!** 213 214 ### Operating a private network 215 216 Maintaining your own private network is more involved as a lot of configurations taken for 217 granted in the official networks need to be manually set up. 218 219 #### Defining the private genesis state 220 221 First, you'll need to create the genesis state of your networks, which all nodes need to be 222 aware of and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`): 223 224 ```json 225 { 226 "config": { 227 "chainId": <arbitrary positive integer>, 228 "homesteadBlock": 0, 229 "eip150Block": 0, 230 "eip155Block": 0, 231 "eip158Block": 0, 232 "byzantiumBlock": 0, 233 "constantinopleBlock": 0, 234 "petersburgBlock": 0, 235 "istanbulBlock": 0, 236 "berlinBlock": 0, 237 "londonBlock": 0 238 }, 239 "alloc": {}, 240 "coinbase": "0x0000000000000000000000000000000000000000", 241 "difficulty": "0x20000", 242 "extraData": "", 243 "gasLimit": "0x2fefd8", 244 "nonce": "0x0000000000000042", 245 "mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000", 246 "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000", 247 "timestamp": "0x00" 248 } 249 ``` 250 251 The above fields should be fine for most purposes, although we'd recommend changing 252 the `nonce` to some random value so you prevent unknown remote nodes from being able 253 to connect to you. If you'd like to pre-fund some accounts for easier testing, create 254 the accounts and populate the `alloc` field with their addresses. 255 256 ```json 257 "alloc": { 258 "0x0000000000000000000000000000000000000001": { 259 "balance": "111111111" 260 }, 261 "0x0000000000000000000000000000000000000002": { 262 "balance": "222222222" 263 } 264 } 265 ``` 266 267 With the genesis state defined in the above JSON file, you'll need to initialize **every** 268 `geth` node with it prior to starting it up to ensure all blockchain parameters are correctly 269 set: 270 271 ```shell 272 $ geth init path/to/genesis.json 273 ``` 274 275 #### Creating the rendezvous point 276 277 With all nodes that you want to run initialized to the desired genesis state, you'll need to 278 start a bootstrap node that others can use to find each other in your network and/or over 279 the internet. The clean way is to configure and run a dedicated bootnode: 280 281 ```shell 282 $ bootnode --genkey=boot.key 283 $ bootnode --nodekey=boot.key 284 ``` 285 286 With the bootnode online, it will display an [`enode` URL](https://ethereum.org/en/developers/docs/networking-layer/network-addresses/#enode) 287 that other nodes can use to connect to it and exchange peer information. Make sure to 288 replace the displayed IP address information (most probably `[::]`) with your externally 289 accessible IP to get the actual `enode` URL. 290 291 *Note: You could also use a full-fledged `geth` node as a bootnode, but it's the less 292 recommended way.* 293 294 #### Starting up your member nodes 295 296 With the bootnode operational and externally reachable (you can try 297 `telnet <ip> <port>` to ensure it's indeed reachable), start every subsequent `geth` 298 node pointed to the bootnode for peer discovery via the `--bootnodes` flag. It will 299 probably also be desirable to keep the data directory of your private network separated, so 300 do also specify a custom `--datadir` flag. 301 302 ```shell 303 $ geth --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 304 ``` 305 306 *Note: Since your network will be completely cut off from the main and test networks, you'll 307 also need to configure a miner to process transactions and create new blocks for you.* 308 309 #### Running a private miner 310 311 312 In a private network setting a single CPU miner instance is more than enough for 313 practical purposes as it can produce a stable stream of blocks at the correct intervals 314 without needing heavy resources (consider running on a single thread, no need for multiple 315 ones either). To start a `geth` instance for mining, run it with all your usual flags, extended 316 by: 317 318 ```shell 319 $ geth <usual-flags> --mine --miner.threads=1 --miner.etherbase=0x0000000000000000000000000000000000000000 320 ``` 321 322 Which will start mining blocks and transactions on a single CPU thread, crediting all 323 proceedings to the account specified by `--miner.etherbase`. You can further tune the mining 324 by changing the default gas limit blocks converge to (`--miner.targetgaslimit`) and the price 325 transactions are accepted at (`--miner.gasprice`). 326 327 ## Contribution 328 329 Thank you for considering helping out with the source code! We welcome contributions 330 from anyone on the internet, and are grateful for even the smallest of fixes! 331 332 If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request 333 for the maintainers to review and merge into the main code base. If you wish to submit 334 more complex changes though, please check up with the core devs first on [our Discord Server](https://discord.gg/invite/nthXNEv) 335 to ensure those changes are in line with the general philosophy of the project and/or get 336 some early feedback which can make both your efforts much lighter as well as our review 337 and merge procedures quick and simple. 338 339 Please make sure your contributions adhere to our coding guidelines: 340 341 * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) 342 guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). 343 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) 344 guidelines. 345 * Pull requests need to be based on and opened against the `master` branch. 346 * Commit messages should be prefixed with the package(s) they modify. 347 * E.g. "eth, rpc: make trace configs optional" 348 349 Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/geth-developer/dev-guide) 350 for more details on configuring your environment, managing project dependencies, and 351 testing procedures. 352 353 ### Contributing to geth.ethereum.org 354 355 For contributions to the [go-ethereum website](https://geth.ethereum.org), please checkout and raise pull requests against the `website` branch. 356 For more detailed instructions please see the `website` branch [README](https://github.com/ethereum/go-ethereum/tree/website#readme) or the 357 [contributing](https://geth.ethereum.org/docs/developers/geth-developer/contributing) page of the website. 358 359 ## License 360 361 The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the 362 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), 363 also included in our repository in the `COPYING.LESSER` file. 364 365 The go-ethereum binaries (i.e. all code inside of the `cmd` directory) are licensed under the 366 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also 367 included in our repository in the `COPYING` file.