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