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