github.com/theQRL/go-zond@v0.1.1/README.md (about) 1 ## Go Zond 2 3 Official Golang execution layer implementation of the Zond protocol. 4 5 [](https://goreportcard.com/report/github.com/theQRL/go-zond) 6 [](https://www.theqrl.org/discord) 7 8 **This code is a test release. All code, features and documentation are subject to change and may represent a work in progress** 9 10 ## Building the source 11 12 For prerequisites and detailed build instructions please read the [Installation Instructions](https://test-zond.theqrl.org/install). 13 14 Building `gzond` requires both a Go (version 1.21 or later) and a C compiler. You can install 15 them using your favourite package manager. Once the dependencies are installed, run 16 17 ```shell 18 make gzond 19 ``` 20 21 or, to build the full suite of utilities: 22 23 ```shell 24 make all 25 ``` 26 27 ## Executables 28 29 The go-zond project comes with several wrappers/executables found in the `cmd` 30 directory. 31 32 | Command | Description | 33 | :--------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 34 | **`gzond`** | Our main Zond CLI client. It is the entry point into the Zond 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 Zond network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. Based on geth, `gzond --help` and the [geth CLI page](https://geth.ethereum.org/docs/fundamentals/command-line-options) show command line options. | 35 | `clef` | Stand-alone signing tool, which can be used as a backend signer for `gzond`. | 36 | `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. | 37 | `abigen` | Source code generator to convert Zond contract definitions into easy-to-use, compile-time type-safe Go packages. It operates on plain [Zond contract ABIs](https://docs.soliditylang.org/en/develop/abi-spec.html) 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 [Native DApps](https://geth.ethereum.org/docs/developers/dapp-developer/native-bindings) page for details. | 38 | `bootnode` | Stripped down version of our Zond 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 | `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://ethereum.org/en/developers/docs/data-structures-and-encoding/rlp)) dumps (data encoding used by the Zond protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). | 41 42 ## Running `gzond` 43 44 Going through all the possible command line flags is out of scope here (please see our nascent [Zond Testnet docs](https://test-zond.theqrl.org) or consult the 45 [geth CLI Wiki page](https://geth.ethereum.org/docs/fundamentals/command-line-options)), 46 but we've enumerated a few common parameter combos to get you up to speed quickly 47 on how you can run your own `gzond` instance. 48 49 ### Hardware Requirements 50 51 Minimum: 52 53 * CPU with 2+ cores 54 * 4GB RAM 55 * 1TB free storage space to sync the Mainnet 56 * 8 MBit/sec download Internet service 57 58 Recommended: 59 60 * Fast CPU with 4+ cores 61 * 16GB+ RAM 62 * High-performance SSD with at least 1TB of free space 63 * 25+ MBit/sec download Internet service 64 65 ### Full node on the main Zond network 66 67 By far the most common scenario is people wanting to simply interact with the Zond 68 network: create accounts; transfer funds; deploy and interact with contracts. For this 69 particular use case, the user doesn't care about years-old historical data, so we can 70 sync quickly to the current state of the network. To do so: 71 72 ```shell 73 $ gzond console 74 ``` 75 76 This command will: 77 * Start `gzond` in snap sync mode (default, can be changed with the `--syncmode` flag), 78 causing it to download more data in exchange for avoiding processing the entire history 79 of the Zond network, which is very CPU intensive. 80 * Start the built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interacting-with-geth/javascript-console), 81 (via the trailing `console` subcommand) through which you can interact using [`web3` methods](https://github.com/ChainSafe/web3.js/blob/0.20.7/DOCUMENTATION.md) 82 (note: the `web3` version bundled within `gzond` is very old, and not up to date with official docs), 83 as well as `gzond`'s own [management APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc). 84 This tool is optional and if you leave it out you can always attach it to an already running 85 `gzond` instance with `gzond attach`. 86 87 ### Configuration 88 89 As an alternative to passing the numerous flags to the `gzond` binary, you can also pass a 90 configuration file via: 91 92 ```shell 93 $ gzond --config /path/to/your_config.toml 94 ``` 95 96 To get an idea of how the file should look like you can use the `dumpconfig` subcommand to 97 export your existing configuration: 98 99 ```shell 100 $ gzond --your-favourite-flags dumpconfig 101 ``` 102 103 #### Docker quick start 104 105 _Docker deployment in development_ 106 107 One of the quickest ways to get Zond up and running on your machine is by using 108 Docker: 109 110 ```shell 111 docker run -d --name zond-node -v /Users/alice/zond:/root \ 112 -p 8545:8545 -p 30303:30303 \ 113 zond/client-go 114 ``` 115 116 This will start `gzond` in snap-sync mode with a DB memory allowance of 1GB, as the 117 above command does. It will also create a persistent volume in your home directory for 118 saving your blockchain as well as map the default ports. There is also an `alpine` tag 119 available for a slim version of the image. 120 121 Do not forget `--http.addr 0.0.0.0`, if you want to access RPC from other containers 122 and/or hosts. By default, `gzond` binds to the local interface and RPC endpoints are not 123 accessible from the outside. 124 125 ### Programmatically interfacing `gzond` nodes 126 127 As a developer, sooner rather than later you'll want to start interacting with `gzond` and the 128 Zond network via your own programs and not manually through the console. To aid 129 this, `gzond` has built-in support for Ethereum-compatible, JSON-RPC based APIs ([standard APIs](https://ethereum.github.io/execution-apis/api-documentation/) 130 and [`gzond` specific APIs](https://geth.ethereum.org/docs/interacting-with-geth/rpc)). 131 These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based 132 platforms, and named pipes on Windows). 133 134 The IPC interface is enabled by default and exposes all the APIs supported by `gzond`, 135 whereas the HTTP and WS interfaces need to manually be enabled and only expose a 136 subset of APIs due to security reasons. These can be turned on/off and configured as 137 you'd expect. 138 139 HTTP based JSON-RPC API options: 140 141 * `--http` Enable the HTTP-RPC server 142 * `--http.addr` HTTP-RPC server listening interface (default: `localhost`) 143 * `--http.port` HTTP-RPC server listening port (default: `8545`) 144 * `--http.api` API's offered over the HTTP-RPC interface (default: `zond,net,web3`) 145 * `--http.corsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 146 * `--ws` Enable the WS-RPC server 147 * `--ws.addr` WS-RPC server listening interface (default: `localhost`) 148 * `--ws.port` WS-RPC server listening port (default: `8546`) 149 * `--ws.api` API's offered over the WS-RPC interface (default: `zond,net,web3`) 150 * `--ws.origins` Origins from which to accept WebSocket requests 151 * `--ipcdisable` Disable the IPC-RPC server 152 * `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,zond,miner,net,personal,txpool,web3`) 153 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 154 155 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to 156 connect via HTTP, WS or IPC to a `gzond` node configured with the above flags and you'll 157 need to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You 158 can reuse the same connection for multiple requests! 159 160 **Note: Please understand the security implications of opening up an HTTP/WS based 161 transport before doing so! Hackers on the internet are actively trying to subvert 162 Zond nodes with exposed APIs! Further, all browser tabs can access locally 163 running web servers, so malicious web pages could try to subvert locally available 164 APIs!** 165 166 ### Operating a private network 167 168 Maintaining your own private network is more involved as a lot of configurations taken for 169 granted in the official networks need to be manually set up. 170 171 #### Defining the private genesis state 172 173 First, you'll need to create the genesis state of your networks, which all nodes need to be 174 aware of and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`): 175 176 ```json 177 { 178 "config": { 179 "chainId": <arbitrary positive integer>, 180 "homesteadBlock": 0, 181 "eip150Block": 0, 182 "eip155Block": 0, 183 "eip158Block": 0, 184 "byzantiumBlock": 0, 185 "constantinopleBlock": 0, 186 "petersburgBlock": 0, 187 "istanbulBlock": 0, 188 "berlinBlock": 0, 189 "londonBlock": 0 190 }, 191 "alloc": {}, 192 "coinbase": "0x0000000000000000000000000000000000000000", 193 "difficulty": "0x20000", 194 "extraData": "", 195 "gasLimit": "0x2fefd8", 196 "nonce": "0x0000000000000042", 197 "mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000", 198 "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000", 199 "timestamp": "0x00" 200 } 201 ``` 202 203 The above fields should be fine for most purposes, although we'd recommend changing 204 the `nonce` to some random value so you prevent unknown remote nodes from being able 205 to connect to you. If you'd like to pre-fund some accounts for easier testing, create 206 the accounts and populate the `alloc` field with their addresses. 207 208 ```json 209 "alloc": { 210 "0x0000000000000000000000000000000000000001": { 211 "balance": "111111111" 212 }, 213 "0x0000000000000000000000000000000000000002": { 214 "balance": "222222222" 215 } 216 } 217 ``` 218 219 With the genesis state defined in the above JSON file, you'll need to initialize **every** 220 `gzond` node with it prior to starting it up to ensure all blockchain parameters are correctly 221 set: 222 223 ```shell 224 $ gzond init path/to/genesis.json 225 ``` 226 227 #### Creating the rendezvous point 228 229 With all nodes that you want to run initialized to the desired genesis state, you'll need to 230 start a bootstrap node that others can use to find each other in your network and/or over 231 the internet. The clean way is to configure and run a dedicated bootnode: 232 233 ```shell 234 $ bootnode --genkey=boot.key 235 $ bootnode --nodekey=boot.key 236 ``` 237 238 With the bootnode online, it will display an [`enode` URL](https://ethereum.org/en/developers/docs/networking-layer/network-addresses/#enode) 239 that other nodes can use to connect to it and exchange peer information. Make sure to 240 replace the displayed IP address information (most probably `[::]`) with your externally 241 accessible IP to get the actual `enode` URL. 242 243 *Note: You could also use a full-fledged `gzond` node as a bootnode, but it's the less 244 recommended way.* 245 246 #### Starting up your member nodes 247 248 With the bootnode operational and externally reachable (you can try 249 `telnet <ip> <port>` to ensure it's indeed reachable), start every subsequent `gzond` 250 node pointed to the bootnode for peer discovery via the `--bootnodes` flag. It will 251 probably also be desirable to keep the data directory of your private network separated, so 252 do also specify a custom `--datadir` flag. 253 254 ```shell 255 $ gzond --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 256 ``` 257 258 *Note: Since your network will be completely cut off from the main and test networks, you'll 259 also need to configure a miner to process transactions and create new blocks for you.* 260 261 #### Running a private miner 262 263 264 In a private network setting a single CPU miner instance is more than enough for 265 practical purposes as it can produce a stable stream of blocks at the correct intervals 266 without needing heavy resources (consider running on a single thread, no need for multiple 267 ones either). To start a `gzond` instance for mining, run it with all your usual flags, extended 268 by: 269 270 ```shell 271 $ gzond <usual-flags> --mine --miner.threads=1 --miner.etherbase=0x0000000000000000000000000000000000000000 272 ``` 273 274 Which will start mining blocks and transactions on a single CPU thread, crediting all 275 proceedings to the account specified by `--miner.etherbase`. You can further tune the mining 276 by changing the default gas limit blocks converge to (`--miner.targetgaslimit`) and the price 277 transactions are accepted at (`--miner.gasprice`). 278 279 ## Contribution 280 281 Thank you for considering helping out with the source code! We welcome contributions 282 from anyone on the internet, and are grateful for even the smallest of fixes! 283 284 If you'd like to contribute to go-zond, please fork, fix, commit and send a pull request 285 for the maintainers to review and merge into the main code base. If you wish to submit 286 more complex changes though, please check up with the core devs first on [our Discord Server](https://theqrl.org/discord) 287 to ensure those changes are in line with the general philosophy of the project and/or get 288 some early feedback which can make both your efforts much lighter as well as our review 289 and merge procedures quick and simple. 290 291 Please make sure your contributions adhere to our coding guidelines: 292 293 * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) 294 guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). 295 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) 296 guidelines. 297 * Pull requests need to be based on and opened against the `main` branch. 298 * Commit messages should be prefixed with the package(s) they modify. 299 * E.g. "zond, rpc: make trace configs optional" 300 301 ## License 302 303 The go-zond library (i.e. all code outside of the `cmd` directory) is licensed under the 304 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), 305 also included in our repository in the `COPYING.LESSER` file. 306 307 The go-zond binaries (i.e. all code inside of the `cmd` directory) are licensed under the 308 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also 309 included in our repository in the `COPYING` file.