github.com/energicryptocurrency/go-energi@v1.1.7/README.md (about) 1 ## Energi Core 2 3 Official golang implementation of the Energi Core based on Ethereum protocol. 4 5 ## Building the source 6 7 ### Build with Makefile 8 9 make all 10 11 ### (Optional) Build with Docker 12 13 A consistent build environment can be provided with Docker. Release builds are produced through this process. 14 15 docker build -t energi3 . 16 17 ## Executables 18 19 The Energi Core project comes with several wrappers/executables found in the `cmd` directory. 20 21 | Command | Description | 22 |:----------:|-------------| 23 | **`energi3`** | Our main Energi CLI client. It is the entry point into the Energi 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 Energi network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `energi3 --help` and the [CLI Wiki page](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options) for command line options. | 24 | `abigen` | Source code generator to convert Energi 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. | 25 | `bootnode` | Stripped down version of our Energi 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. | 26 | `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`). | 27 | `energi3rpctest` | 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. | 28 | `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://github.com/ethereum/wiki/wiki/RLP)) dumps (data encoding used by the Energi protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). | 29 | `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. | 30 | `puppeth` | a CLI wizard that aids in creating a new Energi network. | 31 32 ## Running energi3 33 34 Going through all the possible command line flags is out of scope here (please consult upstream 35 [CLI Wiki page](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)), but we've 36 enumerated a few common parameter combos to get you up to speed quickly on how you can run your 37 own Energi Core instance. 38 39 ### Full node on the main Energi network 40 41 By far the most common scenario is people wanting to simply interact with the Energi network: 42 create accounts; transfer funds; deploy and interact with contracts. For this particular use-case 43 the user doesn't care about years-old historical data, so we can fast-sync quickly to the current 44 state of the network. To do so: 45 46 ``` 47 $ energi3 console 48 ``` 49 50 This command will: 51 52 * Start energi3 in fast sync mode (default, can be changed with the `--syncmode` flag), causing it to 53 download more data in exchange for avoiding processing the entire history of the Energi network, 54 which is very CPU intensive. 55 * Start up Energi Core's built-in interactive [JavaScript console](https://github.com/ethereum/go-ethereum/wiki/JavaScript-Console), 56 (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/ethereum/wiki/wiki/JavaScript-API) 57 as well as Energi Core's own [management APIs](https://github.com/ethereum/go-ethereum/wiki/Management-APIs). 58 This tool is optional and if you leave it out you can always attach to an already running Energi Core instance 59 with `energi3 attach`. 60 61 ### Full node on the Energi test network 62 63 Transitioning towards developers, if you'd like to play around with creating Energi contracts, you 64 almost certainly would like to do that without any real money involved until you get the hang of the 65 entire system. In other words, instead of attaching to the main network, you want to join the **test** 66 network with your node, which is fully equivalent to the main network, but with play-Ether only. 67 68 ``` 69 $ energi3 --testnet console 70 ``` 71 72 The `console` subcommand have the exact same meaning as above and they are equally useful on the 73 testnet too. Please see above for their explanations if you've skipped to here. 74 75 Specifying the `--testnet` flag however will reconfigure your Energi Core instance a bit: 76 77 * Instead of using the default data directory (`~/.ethereum` on Linux for example), Energi Core will nest 78 itself one level deeper into a `testnet` subfolder (`~/.ethereum/testnet` on Linux). Note, on OSX 79 and Linux this also means that attaching to a running testnet node requires the use of a custom 80 endpoint since `energi3 attach` will try to attach to a production node endpoint by default. E.g. 81 `energi3 attach <datadir>/testnet/energi3.ipc`. Windows users are not affected by this. 82 * Instead of connecting the main Energi network, the client will connect to the test network, 83 which uses different P2P bootnodes, different network IDs and genesis states. 84 85 *Note: Although there are some internal protective measures to prevent transactions from crossing 86 over between the main network and test network, you should make sure to always use separate accounts 87 for play-money and real-money. Unless you manually move accounts, Energi Core will by default correctly 88 separate the two networks and will not make any accounts available between them.* 89 ` 90 91 ### Configuration 92 93 As an alternative to passing the numerous flags to the `energi3` binary, you can also pass a configuration file via: 94 95 ``` 96 $ energi3 --config /path/to/your_config.toml 97 ``` 98 99 To get an idea how the file should look like you can use the `dumpconfig` subcommand to export your existing configuration: 100 101 ``` 102 $ energi3 --your-favourite-flags dumpconfig 103 ``` 104 105 *Note: This works only with energi3 v1.6.0 and above.* 106 107 #### Docker quick start 108 109 One of the quickest ways to get Energi up and running on your machine is by using Docker: 110 111 ``` 112 docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \ 113 -p 39796:39796 -p 39797:39797 \ 114 ethereum/client-go 115 ``` 116 117 This will start energi3 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. 118 119 Do not forget `--rpcaddr 0.0.0.0`, if you want to access RPC from other containers and/or hosts. By default, `energi3` binds to the local interface and RPC endpoints is not accessible from the outside. 120 121 ### Programatically interfacing Energi Core nodes 122 123 As a developer, sooner rather than later you'll want to start interacting with Energi Core and the Energi 124 network via your own programs and not manually through the console. To aid this, Energi Core has built-in 125 support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) and 126 [Energi Core specific APIs](https://github.com/ethereum/go-ethereum/wiki/Management-APIs)). These can be 127 exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows). 128 129 The IPC interface is enabled by default and exposes all the APIs supported by Energi Core, whereas the HTTP 130 and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. 131 These can be turned on/off and configured as you'd expect. 132 133 HTTP based JSON-RPC API options: 134 135 * `--rpc` Enable the HTTP-RPC server 136 * `--rpcaddr` HTTP-RPC server listening interface (default: "localhost") 137 * `--rpcport` HTTP-RPC server listening port (default: 39796) 138 * `--rpcapi` API's offered over the HTTP-RPC interface (default: "eth,net,web3") 139 * `--rpccorsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 140 * `--ws` Enable the WS-RPC server 141 * `--wsaddr` WS-RPC server listening interface (default: "localhost") 142 * `--wsport` WS-RPC server listening port (default: 39795) 143 * `--wsapi` API's offered over the WS-RPC interface (default: "eth,net,web3") 144 * `--wsorigins` Origins from which to accept websockets requests 145 * `--ipcdisable` Disable the IPC-RPC server 146 * `--ipcapi` API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3") 147 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 148 149 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect 150 via HTTP, WS or IPC to a Energi Core node configured with the above flags and you'll need to speak [JSON-RPC](https://www.jsonrpc.org/specification) 151 on all transports. You can reuse the same connection for multiple requests! 152 153 **Note: Please understand the security implications of opening up an HTTP/WS based transport before 154 doing so! Hackers on the internet are actively trying to subvert Ethereum nodes with exposed APIs! 155 Further, all browser tabs can access locally running webservers, so malicious webpages could try to 156 subvert locally available APIs!** 157 158 ### Operating a private network 159 160 Maintaining your own private network is more involved as a lot of configurations taken for granted in 161 the official networks need to be manually set up. 162 163 #### Defining the private genesis state 164 165 First, you'll need to create the genesis state of your networks, which all nodes need to be aware of 166 and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`): 167 168 ```json 169 { 170 "config": { 171 "chainId": 0, 172 "homesteadBlock": 0, 173 "eip155Block": 0, 174 "eip158Block": 0 175 }, 176 "alloc" : {}, 177 "coinbase" : "0x0000000000000000000000000000000000000000", 178 "difficulty" : "0x20000", 179 "extraData" : "", 180 "gasLimit" : "0x2fefd8", 181 "nonce" : "0x0000000000000042", 182 "mixhash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 183 "parentHash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 184 "timestamp" : "0x00" 185 } 186 ``` 187 188 The above fields should be fine for most purposes, although we'd recommend changing the `nonce` to 189 some random value so you prevent unknown remote nodes from being able to connect to you. If you'd 190 like to pre-fund some accounts for easier testing, you can populate the `alloc` field with account 191 configs: 192 193 ```json 194 "alloc": { 195 "0x0000000000000000000000000000000000000001": {"balance": "111111111"}, 196 "0x0000000000000000000000000000000000000002": {"balance": "222222222"} 197 } 198 ``` 199 200 With the genesis state defined in the above JSON file, you'll need to initialize **every** Energi Core node 201 with it prior to starting it up to ensure all blockchain parameters are correctly set: 202 203 ``` 204 $ energi3 init path/to/genesis.json 205 ``` 206 207 #### Creating the rendezvous point 208 209 With all nodes that you want to run initialized to the desired genesis state, you'll need to start a 210 bootstrap node that others can use to find each other in your network and/or over the internet. The 211 clean way is to configure and run a dedicated bootnode: 212 213 ``` 214 $ bootnode --genkey=boot.key 215 $ bootnode --nodekey=boot.key 216 ``` 217 218 With the bootnode online, it will display an [`enode` URL](https://github.com/ethereum/wiki/wiki/enode-url-format) 219 that other nodes can use to connect to it and exchange peer information. Make sure to replace the 220 displayed IP address information (most probably `[::]`) with your externally accessible IP to get the 221 actual `enode` URL. 222 223 *Note: You could also use a full fledged Energi Core node as a bootnode, but it's the less recommended way.* 224 225 #### Starting up your member nodes 226 227 With the bootnode operational and externally reachable (you can try `telnet <ip> <port>` to ensure 228 it's indeed reachable), start every subsequent Energi Core node pointed to the bootnode for peer discovery 229 via the `--bootnodes` flag. It will probably also be desirable to keep the data directory of your 230 private network separated, so do also specify a custom `--datadir` flag. 231 232 ``` 233 $ energi3 --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 234 ``` 235 236 *Note: Since your network will be completely cut off from the main and test networks, you'll also 237 need to configure a miner to process transactions and create new blocks for you.* 238 239 #### `truffle build` issues 240 241 There is an apparent bug in truffle that causes it to clear the `build` directory (delete all it's contents), before building the contracts. Please do not use `truffle build` without a way to restore the contents of the build directory (e.g. `git restore`) as needed. 242 243 ## License 244 245 The Energi Core library (i.e. all code outside of the `cmd` directory) is licensed under the 246 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), also 247 included in our repository in the `COPYING.LESSER` file. 248 249 The Energi Core binaries (i.e. all code inside of the `cmd` directory) is licensed under the 250 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also included 251 in our repository in the `COPYING` file.