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