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