github.com/MaynardMiner/ethereumprogpow@v1.8.23/README.md (about) 1 # Ethereum ProgPoW 2 3 ![Ethereum ProgPoW](ethereumprogpow.png) 4 5 [![Travis](https://travis-ci.org/ethereumprogpow/ethereumprogpow.svg?branch=master)](https://travis-ci.org/ethereumprogpow/ethereumprogpow) 6 [![Discord](https://img.shields.io/badge/discord-join%20chat-blue.svg)](https://discord.gg/ZYfFbMH) 7 8 Ethereum ProgPoW, an ethereum node client created for miners and decentralized network 9 10 ## What is Ethereum ProgPoW? 11 12 [Ethereum ProgPoW](https://ethereumprogpow.com) is an alternative ethereum node software to provide miner’s voting tool for secure, decentralized network against potential ASIC threat. By adopting ProgPoW, a Programmatic Proof-of-Work extension for Ethash algorithm, Ethereum ProgPoW can fulfill its vision to support sustainable, scalable network operation under transparent open source development. 13 14 ## Building the source 15 16 Building geth requires both a Go (version 1.9 or later) and a C compiler. (For ubuntu install build-essential and golang-1.10-go from apt package manager) 17 You can install them using your favourite package manager. 18 Once the dependencies are installed, run 19 20 make geth 21 22 or, to build the full suite of utilities: 23 24 make all 25 26 ## Executables 27 28 The ethereumprogpow project comes with several wrappers/executables found in the `cmd` directory. 29 30 | Command | Description | 31 |:----------:|-------------| 32 | **`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/ethereumprogpow/ethereumprogpow/wiki/Command-Line-Options) for command line options. | 33 34 ## Running geth 35 36 Going through all the possible command line flags is out of scope here (please consult our 37 [CLI Wiki page](https://github.com/ethereumprogpow/ethereumprogpow/wiki/Command-Line-Options)), but we've 38 enumerated a few common parameter combos to get you up to speed quickly on how you can run your 39 own Geth instance. 40 41 ### Full node on the main Ethereum (ProgPoW) network 42 43 By far the most common scenario is people wanting to simply interact with the Ethereum network: 44 create accounts; transfer funds; deploy and interact with contracts. For this particular use-case 45 the user doesn't care about years-old historical data, so we can fast-sync quickly to the current 46 state of the network. To do so: 47 48 ``` 49 $ geth 50 ``` 51 52 This command will: 53 54 * Start geth in fast sync mode (default, can be changed with the `--syncmode` flag), causing it to 55 download more data in exchange for avoiding processing the entire history of the Ethereum network, 56 which is very CPU intensive. 57 * Start up Geth's built-in interactive [JavaScript console](https://github.com/ethereumprogpow/ethereumprogpow/wiki/JavaScript-Console), 58 (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/ethereum/wiki/wiki/JavaScript-API) 59 as well as Geth's own [management APIs](https://github.com/ethereumprogpow/ethereumprogpow/wiki/Management-APIs). 60 This tool is optional and if you leave it out you can always attach to an already running Geth instance 61 with `geth attach`. 62 63 ### Full node on the Gangnam ProgPoW test network 64 65 Transitioning towards developers, if you'd like to play around with creating Ethereum contracts, you 66 almost certainly would like to do that without any real money involved until you get the hang of the 67 entire system. In other words, instead of attaching to the main network, you want to join the **test** 68 network with your node, which is fully equivalent to the main network, but with play-Ether only. 69 70 ``` 71 $ geth --gangnam 72 ``` 73 74 The `console` subcommand have the exact same meaning as above and they are equally useful on the 75 testnet too. Please see above for their explanations if you've skipped to here. 76 77 Specifying the `--testnet` flag however will reconfigure your Geth instance a bit: 78 79 * Instead of using the default data directory (`~/.ethereum` on Linux for example), Geth will nest 80 itself one level deeper into a `testnet` subfolder (`~/.ethereum/testnet` on Linux). Note, on OSX 81 and Linux this also means that attaching to a running testnet node requires the use of a custom 82 endpoint since `geth attach` will try to attach to a production node endpoint by default. E.g. 83 `geth attach <datadir>/testnet/geth.ipc`. Windows users are not affected by this. 84 * Instead of connecting the main Ethereum network, the client will connect to the test network, 85 which uses different P2P bootnodes, different network IDs and genesis states. 86 87 *Note: Although there are some internal protective measures to prevent transactions from crossing 88 over between the main network and test network, you should make sure to always use separate accounts 89 for play-money and real-money. Unless you manually move accounts, Geth will by default correctly 90 separate the two networks and will not make any accounts available between them.* 91 92 ### Configuration 93 94 As an alternative to passing the numerous flags to the `geth` binary, you can also pass a configuration file via: 95 96 ``` 97 $ geth --config /path/to/your_config.toml 98 ``` 99 100 To get an idea how the file should look like you can use the `dumpconfig` subcommand to export your existing configuration: 101 102 ``` 103 $ geth --your-favourite-flags dumpconfig 104 ``` 105 106 *Note: This works only with geth v1.6.0 and above.* 107 108 #### Docker quick start 109 110 One of the quickest ways to get Ethereum up and running on your machine is by using Docker: 111 112 ``` 113 docker run -d --name ethereum-node -v /Users/alice/ethereumprogpow:/root \ 114 -p 8545:8545 -p 30303:30303 \ 115 ethereumprogpow/ethereumprogpow 116 ``` 117 118 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. 119 120 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. 121 122 ### Programatically interfacing Geth nodes 123 124 As a developer, sooner rather than later you'll want to start interacting with Geth and the Ethereum 125 network via your own programs and not manually through the console. To aid this, Geth has built-in 126 support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) and 127 [Geth specific APIs](https://github.com/ethereumprogpow/ethereumprogpow/wiki/Management-APIs)). These can be 128 exposed via HTTP, WebSockets and IPC (unix sockets on unix based platforms, and named pipes on Windows). 129 130 The IPC interface is enabled by default and exposes all the APIs supported by Geth, whereas the HTTP 131 and WS interfaces need to manually be enabled and only expose a subset of APIs due to security reasons. 132 These can be turned on/off and configured as you'd expect. 133 134 HTTP based JSON-RPC API options: 135 136 * `--rpc` Enable the HTTP-RPC server 137 * `--rpcaddr` HTTP-RPC server listening interface (default: "localhost") 138 * `--rpcport` HTTP-RPC server listening port (default: 8545) 139 * `--rpcapi` API's offered over the HTTP-RPC interface (default: "eth,net,web3") 140 * `--rpccorsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 141 * `--ws` Enable the WS-RPC server 142 * `--wsaddr` WS-RPC server listening interface (default: "localhost") 143 * `--wsport` WS-RPC server listening port (default: 8546) 144 * `--wsapi` API's offered over the WS-RPC interface (default: "eth,net,web3") 145 * `--wsorigins` Origins from which to accept websockets requests 146 * `--ipcdisable` Disable the IPC-RPC server 147 * `--ipcapi` API's offered over the IPC-RPC interface (default: "admin,debug,eth,miner,net,personal,shh,txpool,web3") 148 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 149 150 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to connect 151 via HTTP, WS or IPC to a Geth node configured with the above flags and you'll need to speak [JSON-RPC](https://www.jsonrpc.org/specification) 152 on all transports. You can reuse the same connection for multiple requests! 153 154 **Note: Please understand the security implications of opening up an HTTP/WS based transport before 155 doing so! Hackers on the internet are actively trying to subvert Ethereum nodes with exposed APIs! 156 Further, all browser tabs can access locally running webservers, so malicious webpages could try to 157 subvert locally available APIs!** 158 159 ## Development Process 160 161 This Github repository contains the source code of releases. 162 163 At the early stage in Ethereum ProgPoW's development, we won't often make changes and updates to our codebase as an effort to serve our client as stable as possible. 164 165 We expect this to change in the future. 166 167 ## Contacting the Ethereum ProgPoW Code maintainers 168 169 If you want to report a non-confidential issue with Ethereum ProgPoW, please use the 170 [GitHub issue system](https://github.com/ethereumprogpow/ethereumprogpow/issues). 171 172 If you want to report a security vulnerability, please send an e-mail to <info@ethereumprogpow.com>. 173 174 For any other questions or issues, please send e-mail to <info@ethereumprogpow.com>. 175 176 ## License 177 178 The ethereumprogpow library (i.e. all code outside of the `cmd` directory) is licensed under the 179 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), also 180 included in our repository in the `COPYING.LESSER` file. 181 182 The ethereumprogpow binaries (i.e. all code inside of the `cmd` directory) is licensed under the 183 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also included 184 in our repository in the `COPYING` file.