github.com/codingfuture/orig-energi3@v0.8.4/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 FutoIn CID 8 9 Local build from the source is supported via [FutoIn CID](https://futoin.org/docs/cid/). 10 11 cid prepare 12 cid build 13 cid package 14 15 ### (Optional) Build with Vagrant 16 17 A consistent build environment can be provided with Vagrant. 18 19 vagrant up 20 vagrant ssh builder 21 cd /vagrant 22 23 From within the Vagrant environment, follow the steps to build with FutoIn CID. 24 25 ### (Optional) Build with Docker 26 27 A consistent build environment can be provided with Docker. Release builds are produced through this process. 28 29 docker build -t energi3 . 30 31 ## Executables 32 33 The Energi Core project comes with several wrappers/executables found in the `cmd` directory. 34 35 | Command | Description | 36 |:----------:|-------------| 37 | **`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. | 38 | `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. | 39 | `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. | 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 | `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. | 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 Energi 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/ethereum/go-ethereum/tree/master/swarm) for more information. | 44 | `puppeth` | a CLI wizard that aids in creating a new Energi network. | 45 46 ## Running energi3 47 48 Going through all the possible command line flags is out of scope here (please consult upstream 49 [CLI Wiki page](https://github.com/ethereum/go-ethereum/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 Energi Core instance. 52 53 ### Full node on the main Energi network 54 55 By far the most common scenario is people wanting to simply interact with the Energi 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 $ energi3 console 62 ``` 63 64 This command will: 65 66 * Start energi3 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 Energi network, 68 which is very CPU intensive. 69 * Start up Energi Core's built-in interactive [JavaScript console](https://github.com/ethereum/go-ethereum/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 Energi Core's own [management APIs](https://github.com/ethereum/go-ethereum/wiki/Management-APIs). 72 This tool is optional and if you leave it out you can always attach to an already running Energi Core instance 73 with `energi3 attach`. 74 75 ### Full node on the Energi test network 76 77 Transitioning towards developers, if you'd like to play around with creating Energi 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 $ energi3 --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 Energi Core instance a bit: 90 91 * Instead of using the default data directory (`~/.ethereum` on Linux for example), Energi Core 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 `energi3 attach` will try to attach to a production node endpoint by default. E.g. 95 `energi3 attach <datadir>/testnet/energi3.ipc`. Windows users are not affected by this. 96 * Instead of connecting the main Energi 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, Energi Core will by default correctly 102 separate the two networks and will not make any accounts available between them.* 103 ` 104 105 ### Configuration 106 107 As an alternative to passing the numerous flags to the `energi3` binary, you can also pass a configuration file via: 108 109 ``` 110 $ energi3 --config /path/to/your_config.toml 111 ``` 112 113 To get an idea how the file should look like you can use the `dumpconfig` subcommand to export your existing configuration: 114 115 ``` 116 $ energi3 --your-favourite-flags dumpconfig 117 ``` 118 119 *Note: This works only with energi3 v1.6.0 and above.* 120 121 #### Docker quick start 122 123 One of the quickest ways to get Energi up and running on your machine is by using Docker: 124 125 ``` 126 docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \ 127 -p 39796:39796 -p 39797:39797 \ 128 ethereum/client-go 129 ``` 130 131 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. 132 133 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. 134 135 ### Programatically interfacing Energi Core nodes 136 137 As a developer, sooner rather than later you'll want to start interacting with Energi Core and the Energi 138 network via your own programs and not manually through the console. To aid this, Energi Core has built-in 139 support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) and 140 [Energi Core specific APIs](https://github.com/ethereum/go-ethereum/wiki/Management-APIs)). These can be 141 exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows). 142 143 The IPC interface is enabled by default and exposes all the APIs supported by Energi Core, whereas the HTTP 144 and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. 145 These can be turned on/off and configured as you'd expect. 146 147 HTTP based JSON-RPC API options: 148 149 * `--rpc` Enable the HTTP-RPC server 150 * `--rpcaddr` HTTP-RPC server listening interface (default: "localhost") 151 * `--rpcport` HTTP-RPC server listening port (default: 39796) 152 * `--rpcapi` API's offered over the HTTP-RPC interface (default: "eth,net,web3") 153 * `--rpccorsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 154 * `--ws` Enable the WS-RPC server 155 * `--wsaddr` WS-RPC server listening interface (default: "localhost") 156 * `--wsport` WS-RPC server listening port (default: 39795) 157 * `--wsapi` API's offered over the WS-RPC interface (default: "eth,net,web3") 158 * `--wsorigins` Origins from which to accept websockets requests 159 * `--ipcdisable` Disable the IPC-RPC server 160 * `--ipcapi` API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3") 161 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 162 163 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect 164 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) 165 on all transports. You can reuse the same connection for multiple requests! 166 167 **Note: Please understand the security implications of opening up an HTTP/WS based transport before 168 doing so! Hackers on the internet are actively trying to subvert Ethereum nodes with exposed APIs! 169 Further, all browser tabs can access locally running webservers, so malicious webpages could try to 170 subvert locally available APIs!** 171 172 ### Operating a private network 173 174 Maintaining your own private network is more involved as a lot of configurations taken for granted in 175 the official networks need to be manually set up. 176 177 #### Defining the private genesis state 178 179 First, you'll need to create the genesis state of your networks, which all nodes need to be aware of 180 and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`): 181 182 ```json 183 { 184 "config": { 185 "chainId": 0, 186 "homesteadBlock": 0, 187 "eip155Block": 0, 188 "eip158Block": 0 189 }, 190 "alloc" : {}, 191 "coinbase" : "0x0000000000000000000000000000000000000000", 192 "difficulty" : "0x20000", 193 "extraData" : "", 194 "gasLimit" : "0x2fefd8", 195 "nonce" : "0x0000000000000042", 196 "mixhash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 197 "parentHash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 198 "timestamp" : "0x00" 199 } 200 ``` 201 202 The above fields should be fine for most purposes, although we'd recommend changing the `nonce` to 203 some random value so you prevent unknown remote nodes from being able to connect to you. If you'd 204 like to pre-fund some accounts for easier testing, you can populate the `alloc` field with account 205 configs: 206 207 ```json 208 "alloc": { 209 "0x0000000000000000000000000000000000000001": {"balance": "111111111"}, 210 "0x0000000000000000000000000000000000000002": {"balance": "222222222"} 211 } 212 ``` 213 214 With the genesis state defined in the above JSON file, you'll need to initialize **every** Energi Core node 215 with it prior to starting it up to ensure all blockchain parameters are correctly set: 216 217 ``` 218 $ energi3 init path/to/genesis.json 219 ``` 220 221 #### Creating the rendezvous point 222 223 With all nodes that you want to run initialized to the desired genesis state, you'll need to start a 224 bootstrap node that others can use to find each other in your network and/or over the internet. The 225 clean way is to configure and run a dedicated bootnode: 226 227 ``` 228 $ bootnode --genkey=boot.key 229 $ bootnode --nodekey=boot.key 230 ``` 231 232 With the bootnode online, it will display an [`enode` URL](https://github.com/ethereum/wiki/wiki/enode-url-format) 233 that other nodes can use to connect to it and exchange peer information. Make sure to replace the 234 displayed IP address information (most probably `[::]`) with your externally accessible IP to get the 235 actual `enode` URL. 236 237 *Note: You could also use a full fledged Energi Core node as a bootnode, but it's the less recommended way.* 238 239 #### Starting up your member nodes 240 241 With the bootnode operational and externally reachable (you can try `telnet <ip> <port>` to ensure 242 it's indeed reachable), start every subsequent Energi Core node pointed to the bootnode for peer discovery 243 via the `--bootnodes` flag. It will probably also be desirable to keep the data directory of your 244 private network separated, so do also specify a custom `--datadir` flag. 245 246 ``` 247 $ energi3 --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 248 ``` 249 250 *Note: Since your network will be completely cut off from the main and test networks, you'll also 251 need to configure a miner to process transactions and create new blocks for you.* 252 253 ## License 254 255 The Energi Core library (i.e. all code outside of the `cmd` directory) is licensed under the 256 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), also 257 included in our repository in the `COPYING.LESSER` file. 258 259 The Energi Core binaries (i.e. all code inside of the `cmd` directory) is licensed under the 260 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also included 261 in our repository in the `COPYING` file.