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