gitlab.com/lightnet1/evrynet-node@v1.1.0/README.md (about) 1 ## Go Evrynet 2 3 Official Golang implementation of the Evrynet protocol. 4 5 [](https://godoc.org/github.com/ethereum/go-ethereum) 8 [](https://goreportcard.com/report/github.com/ethereum/go-ethereum) 9 [](https://travis-ci.org/ethereum/go-ethereum) 10 [](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://github.com/Evrynetlabs/evrynet-node/wiki/Building-Evrynet) on the wiki. 18 19 Building `gev` requires both a Go (version 1.12 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 gev 24 ``` 25 26 or, to build the full suite of utilities: 27 28 ```shell 29 make all 30 ``` 31 32 ## Executables 33 34 The evrynet-node project comes with several wrappers/executables found in the `cmd` 35 directory. 36 37 | Command | Description | 38 | :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 39 | **`gev`** | Our main Evrynet CLI client. It is the entry point into the Evrynet 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 Evrynet network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `gev --help` and the [CLI Wiki page](https://github.com/Evrynetlabs/evrynet-node/wiki/Command-Line-Options) for command line options. | 40 | `abigen` | Source code generator to convert Evrynet contract definitions into easy to use, compile-time type-safe Go packages. | 41 | `bootnode` | Stripped down version of our Evrynet 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 (Evrynet 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`). | 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 [Evrynet JSON RPC](https://github.com/Evrynetlabs/evrynet-node/wiki/JSON-RPC) 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://github.com/ethereum/wiki/wiki/RLP)) dumps (data encoding used by the Evrynet 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 Evrynet network. | 46 47 ## Running `gev` 48 49 Going through all the possible command line flags is out of scope here (please consult our 50 [CLI Wiki page](https://github.com/Evrynetlabs/evrynet-node/wiki/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 `gev` instance. 53 54 ### Full node on the main Evrynet network 55 56 By far the most common scenario is people wanting to simply interact with the Evrynet 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 $ gev console 63 ``` 64 65 This command will: 66 * Start `gev` 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 Evrynet network, which is very CPU intensive. 69 * Start up `gev`'s built-in interactive [JavaScript console](https://github.com/Evrynetlabs/evrynet-node/wiki/JavaScript-Console), 70 (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/Evrynetlabs/evrynet-node/wiki/JavaScript-API) 71 as well as `gev`'s own [management APIs](https://github.com/Evrynetlabs/evrynet-node/wiki/Management-API). 72 This tool is optional and if you leave it out you can always attach to an already running 73 `gev` instance with `gev attach`. 74 75 ### Running a custom local node 76 77 build gev at the root folder of evrynet-node by running the command: 78 ```shell 79 $ make gev 80 ``` 81 82 the executable will be able to find at 83 ``` 84 build/bin/gev 85 ``` 86 87 create data dir to store eth data 88 ``` 89 make dir ~/testgev 90 ``` 91 92 create a genesis block file with chainID and initial balance [Read here](https://github.com/Evrynetlabs/evrynet-node/wiki/Genesis-file) 93 94 init the blockchain 95 ```shell 96 build/bin/gev --networkid 15 --datadir ~/testgev/ init ~/testgev/CustomGenesis.json 97 ``` 98 99 from now on, the node can be start with 100 ```shell 101 build/bin/gev --rpc --networkid 15 --datadir ~/testgev/ console 102 ``` 103 104 to start mining, at the console, run ```miner.start()``` with n is the number of CPU alloc for mining 105 106 ### Configuration 107 108 As an alternative to passing the numerous flags to the `gev` binary, you can also pass a 109 configuration file via: 110 111 ```shell 112 $ gev --config /path/to/your_config.toml 113 ``` 114 115 To get an idea how the file should look like you can use the `dumpconfig` subcommand to 116 export your existing configuration: 117 118 ```shell 119 $ gev --your-favourite-flags dumpconfig 120 ``` 121 122 #### Docker quick start 123 124 One of the quickest ways to get Evrynet up and running on your machine is by using 125 Docker: 126 127 ```shell 128 $ docker image build -f ./Dockerfile -t evrynet-node:local . 129 $ docker run --name evrynet-node-local --publish 8545:8545 --publish 8546:8546 --publish 8547:8547 --publish 30303:30303 --detach evrynet-node:local 130 ``` 131 132 This will start `gev` in full-sync mode. It will also create a persistent volume in your home directory for 133 saving your blockchain as well as map the default ports. There is also an `alpine` tag 134 available for a slim version of the image. 135 136 Do not forget `--rpcaddr 0.0.0.0`, if you want to access RPC from other containers 137 and/or hosts. By default, `gev` binds to the local interface and RPC endpoints is not 138 accessible from the outside. 139 140 ### Programmatically interfacing `gev` nodes 141 142 As a developer, sooner rather than later you'll want to start interacting with `gev` and the 143 Evrynet network via your own programs and not manually through the console. To aid 144 this, `gev` has built-in support for a JSON-RPC based APIs ([standard APIs](https://github.com/Evrynetlabs/evrynet-node/wiki/JSON-RPC) 145 and [`gev` specific APIs](https://github.com/Evrynetlabs/evrynet-node/wiki/Management-API)). 146 These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based 147 platforms, and named pipes on Windows). 148 149 The IPC interface is enabled by default and exposes all the APIs supported by `gev`, 150 whereas the HTTP and WS interfaces need to manually be enabled and only expose a 151 subset of APIs due to security reasons. These can be turned on/off and configured as 152 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 171 connect via HTTP, WS or IPC to a `gev` node configured with the above flags and you'll 172 need to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You 173 can reuse the same connection for multiple requests! 174 175 **Note: Please understand the security implications of opening up an HTTP/WS based 176 transport before doing so! Hackers on the internet are actively trying to subvert 177 Evrynet nodes with exposed APIs! Further, all browser tabs can access locally 178 running web servers, so malicious web pages could try to subvert locally available 179 APIs!** 180 181 ### Operating a private network 182 183 Maintaining your own private network is more involved as a lot of configurations taken for 184 granted in the official networks need to be manually set up. 185 186 #### Defining the private genesis state 187 188 First, you'll need to create the genesis state of your networks, which all nodes need to be 189 aware of and agree upon ([Read here](https://github.com/Evrynetlabs/evrynet-node/wiki/Genesis-file)). This consists of a small JSON file (e.g. call it `genesis.json`): 190 191 The above fields should be fine for most purposes, although we'd recommend changing 192 the `nonce` to some random value so you prevent unknown remote nodes from being able 193 to connect to you. If you'd like to pre-fund some accounts for easier testing, you can 194 populate the `alloc` field with account configs: 195 196 ```json 197 "alloc": { 198 "0x0000000000000000000000000000000000000001": { 199 "balance": "111111111" 200 }, 201 "0x0000000000000000000000000000000000000002": { 202 "balance": "222222222" 203 } 204 } 205 ``` 206 207 With the genesis state defined in the above JSON file, you'll need to initialize **every** 208 `gev` node with it prior to starting it up to ensure all blockchain parameters are correctly 209 set: 210 211 ```shell 212 $ gev init path/to/genesis.json 213 ``` 214 215 #### Creating the rendezvous point 216 217 With all nodes that you want to run initialized to the desired genesis state, you'll need to 218 start a bootstrap node that others can use to find each other in your network and/or over 219 the internet. The clean way is to configure and run a dedicated bootnode: 220 221 ```shell 222 $ bootnode --genkey=boot.key 223 $ bootnode --nodekey=boot.key 224 ``` 225 226 With the bootnode online, it will display an [`enode` URL](https://github.com/ethereum/wiki/wiki/enode-url-format) 227 that other nodes can use to connect to it and exchange peer information. Make sure to 228 replace the displayed IP address information (most probably `[::]`) with your externally 229 accessible IP to get the actual `enode` URL. 230 231 *Note: You could also use a full-fledged `gev` node as a bootnode, but it's the less 232 recommended way.* 233 234 #### Starting up your member nodes 235 236 With the bootnode operational and externally reachable (you can try 237 `telnet <ip> <port>` to ensure it's indeed reachable), start every subsequent `gev` 238 node pointed to the bootnode for peer discovery via the `--bootnodes` flag. It will 239 probably also be desirable to keep the data directory of your private network separated, so 240 do also specify a custom `--datadir` flag. 241 242 ```shell 243 $ gev --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 244 ``` 245 246 *Note: Since your network will be completely cut off from the main and test networks, you'll 247 also need to configure a miner to process transactions and create new blocks for you.* 248 249 #### Running a private miner 250 251 Mining on the public Evrynet network is a complex task as it's only feasible using GPUs, 252 requiring an OpenCL or CUDA enabled `ethminer` instance. For information on such a 253 setup, please consult the [EtherMining subreddit](https://www.reddit.com/r/EtherMining/). 254 255 In a private network setting, however a single CPU miner instance is more than enough for 256 practical purposes as it can produce a stable stream of blocks at the correct intervals 257 without needing heavy resources (consider running on a single thread, no need for multiple 258 ones either). To start a `gev` instance for mining, run it with all your usual flags, extended 259 by: 260 261 ```shell 262 $ gev <usual-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000 263 ``` 264 265 Which will start mining blocks and transactions on a single CPU thread, crediting all 266 proceedings to the account specified by `--etherbase`. You can further tune the mining 267 by changing the default gas limit blocks converge to (`--targetgaslimit`) and the price 268 transactions are accepted at (`--gasprice`). 269 270 ## Contribution 271 272 Thank you for considering to help out with the source code! We welcome contributions 273 from anyone on the internet, and are grateful for even the smallest of fixes! 274 275 If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request 276 for the maintainers to review and merge into the main code base. If you wish to submit 277 more complex changes though, please check up with the core devs first on [our gitter channel](https://gitter.im/ethereum/go-ethereum) 278 to ensure those changes are in line with the general philosophy of the project and/or get 279 some early feedback which can make both your efforts much lighter as well as our review 280 and merge procedures quick and simple. 281 282 Please make sure your contributions adhere to our coding guidelines: 283 284 * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) 285 guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). 286 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) 287 guidelines. 288 * Pull requests need to be based on and opened against the `master` branch. 289 * Commit messages should be prefixed with the package(s) they modify. 290 * E.g. "gev, rpc: make trace configs optional" 291 292 ## License 293 294 The evrynet-node library (i.e. all code outside of the `cmd` directory) is licensed under the 295 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), 296 also included in our repository in the `COPYING.LESSER` file. 297 298 The evrynet-node binaries (i.e. all code inside of the `cmd` directory) is licensed under the 299 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also 300 included in our repository in the `COPYING` file. 301 302 ## Running