github.com/edxfund/validator@v1.8.16-0.20181020093046-c1def72855da/README_CN.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://godoc.org/github.com/EDXFund/Validator) 8 [![Go Report Card](https://goreportcard.com/badge/github.com/EDXFund/Validator)](https://goreportcard.com/report/github.com/EDXFund/Validator) 9 [![Travis](https://travis-ci.org/ethereum/go-ethereum.svg?branch=master)](https://travis-ci.org/ethereum/go-ethereum) 10 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/ethereum/go-ethereum?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge) 11 12 Automated builds are available for stable releases and the unstable master branch. 13 Binary 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 18 [Installation Instructions](https://github.com/EDXFund/Validator/wiki/Building-Ethereum) 19 on the wiki. 20 21 Building geth requires both a Go (version 1.7 or later) and a C compiler. 22 You can install them using your favourite package manager. 23 Once the dependencies are installed, run 24 25 make geth 26 27 or, to build the full suite of utilities: 28 29 make all 30 31 ## Executables 32 33 The go-ethereum project comes with several wrappers/executables found in the `cmd` directory. 34 35 | Command | Description | 36 |:----------:|-------------| 37 | **`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/EDXFund/Validator/wiki/Command-Line-Options) for command line options. | 38 | `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/EDXFund/Validator/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) wiki page for details. | 39 | `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. | 40 | `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`). | 41 | `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. | 42 | `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`). | 43 | `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/EDXFund/Validator/tree/master/swarm) for more information. | 44 | `puppeth` | a CLI wizard that aids in creating a new Ethereum network. | 45 46 ## Running geth 47 48 Going through all the possible command line flags is out of scope here (please consult our 49 [CLI Wiki page](https://github.com/EDXFund/Validator/wiki/Command-Line-Options)), but we've 50 enumerated a few common parameter combos to get you up to speed quickly on how you can run your 51 own Geth instance. 52 53 ### Full node on the main Ethereum network 54 55 By far the most common scenario is people wanting to simply interact with the Ethereum network: 56 create accounts; transfer funds; deploy and interact with contracts. For this particular use-case 57 the user doesn't care about years-old historical data, so we can fast-sync quickly to the current 58 state of the network. To do so: 59 60 ``` 61 $ geth console 62 ``` 63 64 This command will: 65 66 * Start geth in fast sync mode (default, can be changed with the `--syncmode` flag), causing it to 67 download more data in exchange for avoiding processing the entire history of the Ethereum network, 68 which is very CPU intensive. 69 * Start up Geth's built-in interactive [JavaScript console](https://github.com/EDXFund/Validator/wiki/JavaScript-Console), 70 (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/ethereum/wiki/wiki/JavaScript-API) 71 as well as Geth's own [management APIs](https://github.com/EDXFund/Validator/wiki/Management-APIs). 72 This tool is optional and if you leave it out you can always attach to an already running Geth instance 73 with `geth attach`. 74 75 ### Full node on the Ethereum test network 76 77 Transitioning towards developers, if you'd like to play around with creating Ethereum contracts, you 78 almost certainly would like to do that without any real money involved until you get the hang of the 79 entire system. In other words, instead of attaching to the main network, you want to join the **test** 80 network with your node, which is fully equivalent to the main network, but with play-Ether only. 81 82 ``` 83 $ geth --testnet console 84 ``` 85 86 The `console` subcommand have the exact same meaning as above and they are equally useful on the 87 testnet too. Please see above for their explanations if you've skipped to here. 88 89 Specifying the `--testnet` flag however will reconfigure your Geth instance a bit: 90 91 * Instead of using the default data directory (`~/.ethereum` on Linux for example), Geth will nest 92 itself one level deeper into a `testnet` subfolder (`~/.ethereum/testnet` on Linux). Note, on OSX 93 and Linux this also means that attaching to a running testnet node requires the use of a custom 94 endpoint since `geth attach` will try to attach to a production node endpoint by default. E.g. 95 `geth attach <datadir>/testnet/geth.ipc`. Windows users are not affected by this. 96 * Instead of connecting the main Ethereum network, the client will connect to the test network, 97 which uses different P2P bootnodes, different network IDs and genesis states. 98 99 *Note: Although there are some internal protective measures to prevent transactions from crossing 100 over between the main network and test network, you should make sure to always use separate accounts 101 for play-money and real-money. Unless you manually move accounts, Geth will by default correctly 102 separate the two networks and will not make any accounts available between them.* 103 104 ### Full node on the Rinkeby test network 105 106 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. 107 108 ``` 109 $ geth --rinkeby console 110 ``` 111 112 ### Configuration 113 114 As an alternative to passing the numerous flags to the `geth` binary, you can also pass a configuration file via: 115 116 ``` 117 $ geth --config /path/to/your_config.toml 118 ``` 119 120 To get an idea how the file should look like you can use the `dumpconfig` subcommand to export your existing configuration: 121 122 ``` 123 $ geth --your-favourite-flags dumpconfig 124 ``` 125 126 *Note: This works only with geth v1.6.0 and above.* 127 128 #### Docker quick start 129 130 One of the quickest ways to get Ethereum up and running on your machine is by using Docker: 131 132 ``` 133 docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \ 134 -p 8545:8545 -p 30303:30303 \ 135 ethereum/client-go 136 ``` 137 138 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. 139 140 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. 141 142 ### Programatically interfacing Geth nodes 143 144 As a developer, sooner rather than later you'll want to start interacting with Geth and the Ethereum 145 network via your own programs and not manually through the console. To aid this, Geth has built-in 146 support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) and 147 [Geth specific APIs](https://github.com/EDXFund/Validator/wiki/Management-APIs)). These can be 148 exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows). 149 150 The IPC interface is enabled by default and exposes all the APIs supported by Geth, whereas the HTTP 151 and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. 152 These can be turned on/off and configured as you'd expect. 153 154 HTTP based JSON-RPC API options: 155 156 * `--rpc` Enable the HTTP-RPC server 157 * `--rpcaddr` HTTP-RPC server listening interface (default: "localhost") 158 * `--rpcport` HTTP-RPC server listening port (default: 8545) 159 * `--rpcapi` API's offered over the HTTP-RPC interface (default: "eth,net,web3") 160 * `--rpccorsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 161 * `--ws` Enable the WS-RPC server 162 * `--wsaddr` WS-RPC server listening interface (default: "localhost") 163 * `--wsport` WS-RPC server listening port (default: 8546) 164 * `--wsapi` API's offered over the WS-RPC interface (default: "eth,net,web3") 165 * `--wsorigins` Origins from which to accept websockets requests 166 * `--ipcdisable` Disable the IPC-RPC server 167 * `--ipcapi` API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3") 168 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 169 170 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect 171 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) 172 on all transports. You can reuse the same connection for multiple requests! 173 174 **Note: Please understand the security implications of opening up an HTTP/WS based transport before 175 doing so! Hackers on the internet are actively trying to subvert Ethereum nodes with exposed APIs! 176 Further, all browser tabs can access locally running webservers, so malicious webpages could try to 177 subvert locally available APIs!** 178 179 ### 操作一个私有网络 180 181 要维护私有网络,你需要比应用公网花费更多的精力--有大量的在公网上理所当然的配置,你需要手动配置。 182 183 #### 定义创世区块 184 185 首先,您需要创建您网络的创世区块--这个创世区块需要被网络中所有的节点识别和认可。这可以由一个小的JSON文件来定义: (例如: 命名为 `genesis.json`): 186 187 ```json 188 { 189 "config": { 190 "chainId": 0, 191 "homesteadBlock": 0, 192 "eip155Block": 0, 193 "eip158Block": 0 194 }, 195 "alloc" : {}, 196 "coinbase" : "0x0000000000000000000000000000000000000000", 197 "difficulty" : "0x20000", 198 "extraData" : "", 199 "gasLimit" : "0x2fefd8", 200 "nonce" : "0x0000000000000042", 201 "mixhash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 202 "parentHash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 203 "timestamp" : "0x00" 204 } 205 ``` 206 207 上述字段在大部分情形下是适用的,不过我们推荐把 `nonce` 字段设置成一个随机数据,免得未知的远程节点连接到您的网络。如果您想要预先设置一些账户来方便测试,您需要填写 `alloc` 字段来配置帐户: 208 209 ```json 210 "alloc": { 211 "0x0000000000000000000000000000000000000001": {"balance": "111111111"}, 212 "0x0000000000000000000000000000000000000002": {"balance": "222222222"} 213 } 214 ``` 215 216 上述 JSON 文件定义了创世状态,在 **任何** 一个Geth节点启动前,您需要用同样的状态来初始化,以保证所有的区块链参数都是设置正确的: 217 218 ``` 219 $ geth init path/to/genesis.json 220 ``` 221 222 #### 创建相聚点 223 224 当所有的节点都已经用设计好的创世区块初始化完毕后,您需要启动一个起始节点,所有的节点都可以通过这个起始节点相互发现。最清楚的方式就是启动一个专用的起始节点: 225 226 ``` 227 $ bootnode --genkey=boot.key 228 $ bootnode --nodekey=boot.key 229 ``` 230 231 当起始节点在线时,它将会显示一个 [`enode` URL](https://github.com/ethereum/wiki/wiki/enode-url-format) 232 以便让其它节点连接它,并且通过它相互交换端点信息。请确保使用您的真实的IP地址替换enode URL中的IP地址域(最可能是 `[::]`) 。 233 234 *备注: 您可以用一个全功能的Geth节点作为起始节点,不过并不推荐这样做* 235 236 #### 启动您的节点 237 238 当起始节点工作,并且可以通过外网访问后 (您可以通过 `telnet <ip> <port>` 来确认是否确实可访问), 启动后续的每一个Geth节点,每个Geth节点通过 `--bootnodes` 标识指向起始节点,来实现端点发现。很可能,您希望单独存储私有网络的数据,通过指定`--datadir`参数来实现数据的单独存储: 239 240 ``` 241 $ geth --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 242 ``` 243 244 *备注: 由于您的网络完全从主网中脱离了,您需要配置一个矿工来为您实现交易处理和区块创建。* 245 246 #### 运行私有矿工 247 248 在以太坊公网上执行一个挖矿任务是复杂的,只有通过GPU才可行,需要一个由OpenCL或是CUDA使能的 `ethminer` 实例. 想要了解这个的安装,请咨询 249 [EtherMining subreddit](https://www.reddit.com/r/EtherMining/) 以及[Genoil miner](https://github.com/Genoil/cpp-ethereum) 250 仓库. 251 252 不过在一个私有网络里,仅为了验证的目的而言,一个CPU挖矿的实例就足够产生稳定的区块流,不需要大量的资源(考虑运行在单个线程、无需多线程)。要启动一个Geth的挖矿实例,用你常用的参数启动,另外再加上一个扩展参数 253 254 ``` 255 $ geth <常用参数> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000 256 ``` 257 258 这将在启动单线程的CPU挖矿实例,工作帐户由 `--etherbase`指定。 你可以通过参数 (`--targetgaslimit`) 进一步调节默认燃料限制;通过参数 (`--gasprice`) 调整接收的最低Gas价格 259 260 ## Contribution 261 262 Thank you for considering to help out with the source code! We welcome contributions from 263 anyone on the internet, and are grateful for even the smallest of fixes! 264 265 If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request 266 for the maintainers to review and merge into the main code base. If you wish to submit more 267 complex changes though, please check up with the core devs first on [our gitter channel](https://gitter.im/ethereum/go-ethereum) 268 to ensure those changes are in line with the general philosophy of the project and/or get some 269 early feedback which can make both your efforts much lighter as well as our review and merge 270 procedures quick and simple. 271 272 Please make sure your contributions adhere to our coding guidelines: 273 274 * 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/)). 275 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. 276 * Pull requests need to be based on and opened against the `master` branch. 277 * Commit messages should be prefixed with the package(s) they modify. 278 * E.g. "eth, rpc: make trace configs optional" 279 280 Please see the [Developers' Guide](https://github.com/EDXFund/Validator/wiki/Developers'-Guide) 281 for more details on configuring your environment, managing project dependencies and testing procedures. 282 283 ## License 284 285 The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the 286 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), also 287 included in our repository in the `COPYING.LESSER` file. 288 289 The go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the 290 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also included 291 in our repository in the `COPYING` file.