github.com/Ethersocial/go-esn@v0.3.7/README.md (about) 1 ## Go EtherSocial 2 3 Official golang implementation of the EtherSocial protocol. 4 5 ## Building the source 6 7 For prerequisites and detailed build instructions please read the 8 [Installation Instructions](https://github.com/ethersocial/wiki/wiki/Building-EtherSocial) 9 on the wiki. 10 11 Building gesn requires both a Go (version 1.7 or later) and a C compiler. 12 You can install them using your favourite package manager. 13 Once the dependencies are installed, run 14 15 $ cd ~ 16 $ git clone https://github.com/ethersocial/go-esn 17 $ cd go-esn 18 $ chmod 755 build/* 19 $ make gesn 20 $ sudo cp ~/go-esn/build/bin/gesn /usr/local/bin/ 21 22 or, to build the full suite of utilities: 23 24 make all 25 26 ## Executables 27 28 The go-esn project comes with several wrappers/executables found in the `cmd` directory. 29 30 | Command | Description | 31 |:----------:|-------------| 32 | **`gesn`** | Our main EtherSocial CLI client. It is the entry point into the EtherSocial 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 EtherSocial network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `gesn --help` and the [CLI Wiki page](https://github.com/ethersocial/go-esn/wiki/Command-Line-Options) for command line options. | 33 | `abigen` | Source code generator to convert EtherSocial contract definitions into easy to use, compile-time type-safe Go packages. It operates on plain [EtherSocial contract ABIs](https://github.com/ethersocial/wiki/wiki/EtherSocial-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/ethersocial/go-esn/wiki/Native-DApps:-Go-bindings-to-EtherSocial-contracts) wiki page for details. | 34 | `bootnode` | Stripped down version of our EtherSocial 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. | 35 | `evm` | Developer utility version of the EVM (EtherSocial 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`). | 36 | `gethrpctest` | Developer utility tool to support our [ethereum/rpc-test](https://github.com/ethersocial/rpc-tests) test suite which validates baseline conformity to the [EtherSocial JSON RPC](https://github.com/ethersocial/wiki/wiki/JSON-RPC) specs. Please see the [test suite's readme](https://github.com/ethersocial/rpc-tests/blob/master/README.md) for details. | 37 | `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://github.com/ethersocial/wiki/wiki/RLP)) dumps (data encoding used by the EtherSocial protocol both network as well as consensus wise) to user friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). | 38 | `swarm` | swarm daemon and tools. This is the entrypoint for the swarm network. `swarm --help` for command line options and subcommands. See https://swarm-guide.readthedocs.io for swarm documentation. | 39 | `puppeth` | a CLI wizard that aids in creating a new EtherSocial network. | 40 41 ## Running gesn 42 43 Going through all the possible command line flags is out of scope here (please consult our 44 [CLI Wiki page](https://github.com/ethersocial/go-esn/wiki/Command-Line-Options)), but we've 45 enumerated a few common parameter combos to get you up to speed quickly on how you can run your 46 own Gesn instance. 47 48 ### Full node on the main EtherSocial network 49 50 By far the most common scenario is people wanting to simply interact with the EtherSocial network: 51 create accounts; transfer funds; deploy and interact with contracts. For this particular use-case 52 the user doesn't care about years-old historical data, so we can fast-sync quickly to the current 53 state of the network. To do so: 54 55 ``` 56 $ gesn --fast --cache=512 console 57 ``` 58 59 This command will: 60 61 * Start gesn in fast sync mode (default, can be changed with the `--syncmode` flag), causing it to 62 download more data in exchange for avoiding processing the entire history of the EtherSocial network, 63 which is very CPU intensive. 64 * Bump the memory allowance of the database to 512MB (`--cache=512`), which can help significantly in 65 sync times especially for HDD users. This flag is optional and you can set it as high or as low as 66 you'd like, though we'd recommend the 512MB - 2GB range. 67 * Start up Gesn's built-in interactive [JavaScript console](https://github.com/ethersocial/go-esn/wiki/JavaScript-Console), 68 (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/ethersocial/wiki/wiki/JavaScript-API) 69 as well as Gesn's own [management APIs](https://github.com/ethersocial/go-esn/wiki/Management-APIs). 70 This tool is optional and if you leave it out you can always attach to an already running Gesn instance 71 with `gesn attach`. 72 73 ### Full node on the EtherSocial test network 74 75 Transitioning towards developers, if you'd like to play around with creating EtherSocial contracts, you 76 almost certainly would like to do that without any real money involved until you get the hang of the 77 entire system. In other words, instead of attaching to the main network, you want to join the **test** 78 network with your node, which is fully equivalent to the main network, but with play-Ether only. 79 80 ``` 81 $ gesn --testnet --fast --cache=512 console 82 ``` 83 84 The `--fast`, `--cache` flags and `console` subcommand have the exact same meaning as above and they 85 are equally useful on the testnet too. Please see above for their explanations if you've skipped to 86 here. 87 88 Specifying the `--testnet` flag however will reconfigure your Gesn instance a bit: 89 90 * Instead of using the default data directory (`~/.ethersocial` on Linux for example), Gesn will nest 91 itself one level deeper into a `testnet` subfolder (`~/.ethersocial/testnet` on Linux). Note, on OSX 92 and Linux this also means that attaching to a running testnet node requires the use of a custom 93 endpoint since `gesn attach` will try to attach to a production node endpoint by default. E.g. 94 `gesn attach <datadir>/testnet/gesn.ipc`. Windows users are not affected by this. 95 * Instead of connecting the main EtherSocial network, the client will connect to the test network, 96 which uses different P2P bootnodes, different network IDs and genesis states. 97 98 *Note: Although there are some internal protective measures to prevent transactions from crossing 99 over between the main network and test network, you should make sure to always use separate accounts 100 for play-money and real-money. Unless you manually move accounts, Gesn will by default correctly 101 separate the two networks and will not make any accounts available between them.* 102 103 ### Configuration 104 105 As an alternative to passing the numerous flags to the `gesn` binary, you can also pass a configuration file via: 106 107 ``` 108 $ gesn --config /path/to/your_config.toml 109 ``` 110 111 To get an idea how the file should look like you can use the `dumpconfig` subcommand to export your existing configuration: 112 113 ``` 114 $ gesn --your-favourite-flags dumpconfig 115 ``` 116 117 *Note: This works only with gesn v1.6.0 and above.* 118 119 #### Docker quick start 120 121 One of the quickest ways to get EtherSocial up and running on your machine is by using Docker: 122 123 ``` 124 docker run -d --name ethersocial-node -v /Users/alice/ethersocial:/root \ 125 -p 9545:9545 -p 50505:50505 \ 126 ethereum/client-go --fast --cache=512 127 ``` 128 129 This will start gesn 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. 130 131 Do not forget `--rpcaddr 0.0.0.0`, if you want to access RPC from other containers and/or hosts. By default, `gesn` binds to the local interface and RPC endpoints is not accessible from the outside. 132 133 ### Programatically interfacing Gesn nodes 134 135 As a developer, sooner rather than later you'll want to start interacting with Gesn and the EtherSocial 136 network via your own programs and not manually through the console. To aid this, Geth has built-in 137 support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) and 138 [Geth specific APIs](https://github.com/ethereum/go-ethereum/wiki/Management-APIs)). These can be 139 exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows). 140 141 The IPC interface is enabled by default and exposes all the APIs supported by Gesn, whereas the HTTP 142 and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. 143 These can be turned on/off and configured as you'd expect. 144 145 HTTP based JSON-RPC API options: 146 147 * `--rpc` Enable the HTTP-RPC server 148 * `--rpcaddr` HTTP-RPC server listening interface (default: "localhost") 149 * `--rpcport` HTTP-RPC server listening port (default: 9545) 150 * `--rpcapi` API's offered over the HTTP-RPC interface (default: "eth,net,web3") 151 * `--rpccorsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 152 * `--ws` Enable the WS-RPC server 153 * `--wsaddr` WS-RPC server listening interface (default: "localhost") 154 * `--wsport` WS-RPC server listening port (default: 9546) 155 * `--wsapi` API's offered over the WS-RPC interface (default: "eth,net,web3") 156 * `--wsorigins` Origins from which to accept websockets requests 157 * `--ipcdisable` Disable the IPC-RPC server 158 * `--ipcapi` API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3") 159 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 160 161 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect 162 via HTTP, WS or IPC to a Gesn node configured with the above flags and you'll need to speak [JSON-RPC](http://www.jsonrpc.org/specification) 163 on all transports. You can reuse the same connection for multiple requests! 164 165 **Note: Please understand the security implications of opening up an HTTP/WS based transport before 166 doing so! Hackers on the internet are actively trying to subvert EtherSocial nodes with exposed APIs! 167 Further, all browser tabs can access locally running webservers, so malicious webpages could try to 168 subvert locally available APIs!** 169 170 ### Operating a private network 171 172 Maintaining your own private network is more involved as a lot of configurations taken for granted in 173 the official networks need to be manually set up. 174 175 #### Defining the private genesis state 176 177 First, you'll need to create the genesis state of your networks, which all nodes need to be aware of 178 and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`): 179 180 ```json 181 { 182 "config": { 183 "chainId": 0, 184 "homesteadBlock": 0, 185 "eip155Block": 0, 186 "eip158Block": 0 187 }, 188 "alloc" : {}, 189 "coinbase" : "0x0000000000000000000000000000000000000000", 190 "difficulty" : "0x20000", 191 "extraData" : "", 192 "gasLimit" : "0x2fefd8", 193 "nonce" : "0x0000000000000042", 194 "mixhash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 195 "parentHash" : "0x0000000000000000000000000000000000000000000000000000000000000000", 196 "timestamp" : "0x00" 197 } 198 ``` 199 200 The above fields should be fine for most purposes, although we'd recommend changing the `nonce` to 201 some random value so you prevent unknown remote nodes from being able to connect to you. If you'd 202 like to pre-fund some accounts for easier testing, you can populate the `alloc` field with account 203 configs: 204 205 ```json 206 "alloc": { 207 "0x0000000000000000000000000000000000000001": {"balance": "111111111"}, 208 "0x0000000000000000000000000000000000000002": {"balance": "222222222"} 209 } 210 ``` 211 212 With the genesis state defined in the above JSON file, you'll need to initialize **every** Gesn node 213 with it prior to starting it up to ensure all blockchain parameters are correctly set: 214 215 ``` 216 $ gesn init path/to/genesis.json 217 ``` 218 219 #### Creating the rendezvous point 220 221 With all nodes that you want to run initialized to the desired genesis state, you'll need to start a 222 bootstrap node that others can use to find each other in your network and/or over the internet. The 223 clean way is to configure and run a dedicated bootnode: 224 225 ``` 226 $ bootnode --genkey=boot.key 227 $ bootnode --nodekey=boot.key 228 ``` 229 230 With the bootnode online, it will display an [`enode` URL](https://github.com/ethereum/wiki/wiki/enode-url-format) 231 that other nodes can use to connect to it and exchange peer information. Make sure to replace the 232 displayed IP address information (most probably `[::]`) with your externally accessible IP to get the 233 actual `enode` URL. 234 235 *Note: You could also use a full fledged Gesn node as a bootnode, but it's the less recommended way.* 236 237 #### Starting up your member nodes 238 239 With the bootnode operational and externally reachable (you can try `telnet <ip> <port>` to ensure 240 it's indeed reachable), start every subsequent Gesn node pointed to the bootnode for peer discovery 241 via the `--bootnodes` flag. It will probably also be desirable to keep the data directory of your 242 private network separated, so do also specify a custom `--datadir` flag. 243 244 ``` 245 $ gesn --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 246 ``` 247 248 *Note: Since your network will be completely cut off from the main and test networks, you'll also 249 need to configure a miner to process transactions and create new blocks for you.* 250 251 #### Running a private miner 252 253 Mining on the public EtherSocial network is a complex task as it's only feasible using GPUs, requiring 254 an OpenCL or CUDA enabled `ethminer` instance. For information on such a setup, please consult the 255 [EtherMining subreddit](https://www.reddit.com/r/EtherMining/) and the [Genoil miner](https://github.com/Genoil/cpp-ethereum) 256 repository. 257 258 In a private network setting however, a single CPU miner instance is more than enough for practical 259 purposes as it can produce a stable stream of blocks at the correct intervals without needing heavy 260 resources (consider running on a single thread, no need for multiple ones either). To start a Gesn 261 instance for mining, run it with all your usual flags, extended by: 262 263 ``` 264 $ gesn <usual-flags> --mine --minerthreads=1 --etherbase=0x0000000000000000000000000000000000000000 265 ``` 266 267 Which will start mining blocks and transactions on a single CPU thread, crediting all proceedings to 268 the account specified by `--etherbase`. You can further tune the mining by changing the default gas 269 limit blocks converge to (`--targetgaslimit`) and the price transactions are accepted at (`--gasprice`). 270 271 ## Contribution 272 273 Thank you for considering to help out with the source code! We welcome contributions from 274 anyone on the internet, and are grateful for even the smallest of fixes! 275 276 If you'd like to contribute to go-esn, please fork, fix, commit and send a pull request 277 for the maintainers to review and merge into the main code base. If you wish to submit more 278 complex changes though, please check up with the core devs first on [our gitter channel](https://gitter.im/ethereum/go-ethereum) 279 to ensure those changes are in line with the general philosophy of the project and/or get some 280 early feedback which can make both your efforts much lighter as well as our review and merge 281 procedures quick and simple. 282 283 Please make sure your contributions adhere to our coding guidelines: 284 285 * 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/)). 286 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) guidelines. 287 * Pull requests need to be based on and opened against the `master` branch. 288 * Commit messages should be prefixed with the package(s) they modify. 289 * E.g. "eth, rpc: make trace configs optional" 290 291 Please see the [Developers' Guide](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide) 292 for more details on configuring your environment, managing project dependencies and testing procedures. 293 294 ## License 295 296 The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the 297 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), also 298 included in our repository in the `COPYING.LESSER` file. 299 300 The go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the 301 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also included 302 in our repository in the `COPYING` file.