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