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