github.com/0xsequence/ethkit@v1.25.0/go-ethereum/README.md (about) 1 ## NOTE on Use and Licensing 2 3 The ethkit project enclosed in this repository is built on a modified version of the [go-ethereum](https://github.com/ethereum/go-ethereum) project. 4 5 Enclosed under github.com/0xsequence/ethkit/go-ethereum you will find this README and COPYING.LESSER (LGPLv3) license for the go-ethereum source. 6 7 As stated under https://www.gnu.org/licenses/gpl-faq.html#LGPLStaticVsDynamic : 8 9 > Does the LGPL have different requirements for statically vs dynamically linked modules with a covered work? 10 11 > For the purpose of complying with the LGPL (any extant version: v2, v2.1 or v3): 12 13 > If you statically link against an LGPLed library, you must also provide your application in an object (not necessarily source) format, so that a user has the opportunity to modify the library and relink the application. 14 15 As per license of the original work, please note that all vendored and modified go-ethereum source code (under github.com/0xsequence/ethkit/go-ethereum) is licensed under LGPLv3. 16 17 Please see https://github.com/0xsequence/ethkit/blob/master/LICENSE for licensing details on the remainder of the ethkit project, which is licensed under MIT. 18 19 20 Original README follows below: 21 22 --- 23 --- 24 --- 25 26 ## Go Ethereum 27 28 Official Golang implementation of the Ethereum protocol. 29 30 [](https://pkg.go.dev/github.com/ethereum/go-ethereum?tab=doc) 33 [](https://goreportcard.com/report/github.com/ethereum/go-ethereum) 34 [](https://travis-ci.com/ethereum/go-ethereum) 35 [](https://discord.gg/nthXNEv) 36 37 Automated builds are available for stable releases and the unstable master branch. Binary 38 archives are published at https://geth.ethereum.org/downloads/. 39 40 ## Building the source 41 42 For prerequisites and detailed build instructions please read the [Installation Instructions](https://geth.ethereum.org/docs/install-and-build/installing-geth). 43 44 Building `geth` requires both a Go (version 1.16 or later) and a C compiler. You can install 45 them using your favourite package manager. Once the dependencies are installed, run 46 47 ```shell 48 make geth 49 ``` 50 51 or, to build the full suite of utilities: 52 53 ```shell 54 make all 55 ``` 56 57 ## Executables 58 59 The go-ethereum project comes with several wrappers/executables found in the `cmd` 60 directory. 61 62 | Command | Description | 63 | :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 64 | **`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 page](https://geth.ethereum.org/docs/interface/command-line-options) for command line options. | 65 | `clef` | Stand-alone signing tool, which can be used as a backend signer for `geth`. | 66 | `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. | 67 | `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://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 our [Native DApps](https://geth.ethereum.org/docs/dapp/native-bindings) page for details. | 68 | `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. | 69 | `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`). | 70 | `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 Ethereum protocol both network as well as consensus wise) to user-friendlier hierarchical representation (e.g. `rlpdump --hex CE0183FFFFFFC4C304050583616263`). | 71 | `puppeth` | a CLI wizard that aids in creating a new Ethereum network. | 72 73 ## Running `geth` 74 75 Going through all the possible command line flags is out of scope here (please consult our 76 [CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)), 77 but we've enumerated a few common parameter combos to get you up to speed quickly 78 on how you can run your own `geth` instance. 79 80 ### Hardware Requirements 81 82 Minimum: 83 84 * CPU with 2+ cores 85 * 4GB RAM 86 * 1TB free storage space to sync the Mainnet 87 * 8 MBit/sec download Internet service 88 89 Recommended: 90 91 * Fast CPU with 4+ cores 92 * 16GB+ RAM 93 * High Performance SSD with at least 1TB free space 94 * 25+ MBit/sec download Internet service 95 96 ### Full node on the main Ethereum network 97 98 By far the most common scenario is people wanting to simply interact with the Ethereum 99 network: create accounts; transfer funds; deploy and interact with contracts. For this 100 particular use-case the user doesn't care about years-old historical data, so we can 101 sync quickly to the current state of the network. To do so: 102 103 ```shell 104 $ geth console 105 ``` 106 107 This command will: 108 * Start `geth` in snap sync mode (default, can be changed with the `--syncmode` flag), 109 causing it to download more data in exchange for avoiding processing the entire history 110 of the Ethereum network, which is very CPU intensive. 111 * Start up `geth`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console), 112 (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) 113 (note: the `web3` version bundled within `geth` is very old, and not up to date with official docs), 114 as well as `geth`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server). 115 This tool is optional and if you leave it out you can always attach to an already running 116 `geth` instance with `geth attach`. 117 118 ### A Full node on the Görli test network 119 120 Transitioning towards developers, if you'd like to play around with creating Ethereum 121 contracts, you almost certainly would like to do that without any real money involved until 122 you get the hang of the entire system. In other words, instead of attaching to the main 123 network, you want to join the **test** network with your node, which is fully equivalent to 124 the main network, but with play-Ether only. 125 126 ```shell 127 $ geth --goerli console 128 ``` 129 130 The `console` subcommand has the exact same meaning as above and they are equally 131 useful on the testnet too. Please, see above for their explanations if you've skipped here. 132 133 Specifying the `--goerli` flag, however, will reconfigure your `geth` instance a bit: 134 135 * Instead of connecting the main Ethereum network, the client will connect to the Görli 136 test network, which uses different P2P bootnodes, different network IDs and genesis 137 states. 138 * Instead of using the default data directory (`~/.ethereum` on Linux for example), `geth` 139 will nest itself one level deeper into a `goerli` subfolder (`~/.ethereum/goerli` on 140 Linux). Note, on OSX and Linux this also means that attaching to a running testnet node 141 requires the use of a custom endpoint since `geth attach` will try to attach to a 142 production node endpoint by default, e.g., 143 `geth attach <datadir>/goerli/geth.ipc`. Windows users are not affected by 144 this. 145 146 *Note: Although there are some internal protective measures to prevent transactions from 147 crossing over between the main network and test network, you should make sure to always 148 use separate accounts for play-money and real-money. Unless you manually move 149 accounts, `geth` will by default correctly separate the two networks and will not make any 150 accounts available between them.* 151 152 ### Full node on the Rinkeby test network 153 154 Go Ethereum also supports connecting to the older proof-of-authority based test network 155 called [*Rinkeby*](https://www.rinkeby.io) which is operated by members of the community. 156 157 ```shell 158 $ geth --rinkeby console 159 ``` 160 161 ### Full node on the Ropsten test network 162 163 In addition to Görli and Rinkeby, Geth also supports the ancient Ropsten testnet. The 164 Ropsten test network is based on the Ethash proof-of-work consensus algorithm. As such, 165 it has certain extra overhead and is more susceptible to reorganization attacks due to the 166 network's low difficulty/security. 167 168 ```shell 169 $ geth --ropsten console 170 ``` 171 172 *Note: Older Geth configurations store the Ropsten database in the `testnet` subdirectory.* 173 174 ### Configuration 175 176 As an alternative to passing the numerous flags to the `geth` binary, you can also pass a 177 configuration file via: 178 179 ```shell 180 $ geth --config /path/to/your_config.toml 181 ``` 182 183 To get an idea how the file should look like you can use the `dumpconfig` subcommand to 184 export your existing configuration: 185 186 ```shell 187 $ geth --your-favourite-flags dumpconfig 188 ``` 189 190 *Note: This works only with `geth` v1.6.0 and above.* 191 192 #### Docker quick start 193 194 One of the quickest ways to get Ethereum up and running on your machine is by using 195 Docker: 196 197 ```shell 198 docker run -d --name ethereum-node -v /Users/alice/ethereum:/root \ 199 -p 8545:8545 -p 30303:30303 \ 200 ethereum/client-go 201 ``` 202 203 This will start `geth` in snap-sync mode with a DB memory allowance of 1GB just as the 204 above command does. It will also create a persistent volume in your home directory for 205 saving your blockchain as well as map the default ports. There is also an `alpine` tag 206 available for a slim version of the image. 207 208 Do not forget `--http.addr 0.0.0.0`, if you want to access RPC from other containers 209 and/or hosts. By default, `geth` binds to the local interface and RPC endpoints are not 210 accessible from the outside. 211 212 ### Programmatically interfacing `geth` nodes 213 214 As a developer, sooner rather than later you'll want to start interacting with `geth` and the 215 Ethereum network via your own programs and not manually through the console. To aid 216 this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://ethereum.github.io/execution-apis/api-documentation/) 217 and [`geth` specific APIs](https://geth.ethereum.org/docs/rpc/server)). 218 These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based 219 platforms, and named pipes on Windows). 220 221 The IPC interface is enabled by default and exposes all the APIs supported by `geth`, 222 whereas the HTTP and WS interfaces need to manually be enabled and only expose a 223 subset of APIs due to security reasons. These can be turned on/off and configured as 224 you'd expect. 225 226 HTTP based JSON-RPC API options: 227 228 * `--http` Enable the HTTP-RPC server 229 * `--http.addr` HTTP-RPC server listening interface (default: `localhost`) 230 * `--http.port` HTTP-RPC server listening port (default: `8545`) 231 * `--http.api` API's offered over the HTTP-RPC interface (default: `eth,net,web3`) 232 * `--http.corsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 233 * `--ws` Enable the WS-RPC server 234 * `--ws.addr` WS-RPC server listening interface (default: `localhost`) 235 * `--ws.port` WS-RPC server listening port (default: `8546`) 236 * `--ws.api` API's offered over the WS-RPC interface (default: `eth,net,web3`) 237 * `--ws.origins` Origins from which to accept websockets requests 238 * `--ipcdisable` Disable the IPC-RPC server 239 * `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,txpool,web3`) 240 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 241 242 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to 243 connect via HTTP, WS or IPC to a `geth` node configured with the above flags and you'll 244 need to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You 245 can reuse the same connection for multiple requests! 246 247 **Note: Please understand the security implications of opening up an HTTP/WS based 248 transport before doing so! Hackers on the internet are actively trying to subvert 249 Ethereum nodes with exposed APIs! Further, all browser tabs can access locally 250 running web servers, so malicious web pages could try to subvert locally available 251 APIs!** 252 253 ### Operating a private network 254 255 Maintaining your own private network is more involved as a lot of configurations taken for 256 granted in the official networks need to be manually set up. 257 258 #### Defining the private genesis state 259 260 First, you'll need to create the genesis state of your networks, which all nodes need to be 261 aware of and agree upon. This consists of a small JSON file (e.g. call it `genesis.json`): 262 263 ```json 264 { 265 "config": { 266 "chainId": <arbitrary positive integer>, 267 "homesteadBlock": 0, 268 "eip150Block": 0, 269 "eip155Block": 0, 270 "eip158Block": 0, 271 "byzantiumBlock": 0, 272 "constantinopleBlock": 0, 273 "petersburgBlock": 0, 274 "istanbulBlock": 0, 275 "berlinBlock": 0, 276 "londonBlock": 0 277 }, 278 "alloc": {}, 279 "coinbase": "0x0000000000000000000000000000000000000000", 280 "difficulty": "0x20000", 281 "extraData": "", 282 "gasLimit": "0x2fefd8", 283 "nonce": "0x0000000000000042", 284 "mixhash": "0x0000000000000000000000000000000000000000000000000000000000000000", 285 "parentHash": "0x0000000000000000000000000000000000000000000000000000000000000000", 286 "timestamp": "0x00" 287 } 288 ``` 289 290 The above fields should be fine for most purposes, although we'd recommend changing 291 the `nonce` to some random value so you prevent unknown remote nodes from being able 292 to connect to you. If you'd like to pre-fund some accounts for easier testing, create 293 the accounts and populate the `alloc` field with their addresses. 294 295 ```json 296 "alloc": { 297 "0x0000000000000000000000000000000000000001": { 298 "balance": "111111111" 299 }, 300 "0x0000000000000000000000000000000000000002": { 301 "balance": "222222222" 302 } 303 } 304 ``` 305 306 With the genesis state defined in the above JSON file, you'll need to initialize **every** 307 `geth` node with it prior to starting it up to ensure all blockchain parameters are correctly 308 set: 309 310 ```shell 311 $ geth init path/to/genesis.json 312 ``` 313 314 #### Creating the rendezvous point 315 316 With all nodes that you want to run initialized to the desired genesis state, you'll need to 317 start a bootstrap node that others can use to find each other in your network and/or over 318 the internet. The clean way is to configure and run a dedicated bootnode: 319 320 ```shell 321 $ bootnode --genkey=boot.key 322 $ bootnode --nodekey=boot.key 323 ``` 324 325 With the bootnode online, it will display an [`enode` URL](https://ethereum.org/en/developers/docs/networking-layer/network-addresses/#enode) 326 that other nodes can use to connect to it and exchange peer information. Make sure to 327 replace the displayed IP address information (most probably `[::]`) with your externally 328 accessible IP to get the actual `enode` URL. 329 330 *Note: You could also use a full-fledged `geth` node as a bootnode, but it's the less 331 recommended way.* 332 333 #### Starting up your member nodes 334 335 With the bootnode operational and externally reachable (you can try 336 `telnet <ip> <port>` to ensure it's indeed reachable), start every subsequent `geth` 337 node pointed to the bootnode for peer discovery via the `--bootnodes` flag. It will 338 probably also be desirable to keep the data directory of your private network separated, so 339 do also specify a custom `--datadir` flag. 340 341 ```shell 342 $ geth --datadir=path/to/custom/data/folder --bootnodes=<bootnode-enode-url-from-above> 343 ``` 344 345 *Note: Since your network will be completely cut off from the main and test networks, you'll 346 also need to configure a miner to process transactions and create new blocks for you.* 347 348 #### Running a private miner 349 350 Mining on the public Ethereum network is a complex task as it's only feasible using GPUs, 351 requiring an OpenCL or CUDA enabled `ethminer` instance. For information on such a 352 setup, please consult the [EtherMining subreddit](https://www.reddit.com/r/EtherMining/) 353 and the [ethminer](https://github.com/ethereum-mining/ethminer) repository. 354 355 In a private network setting, however a single CPU miner instance is more than enough for 356 practical purposes as it can produce a stable stream of blocks at the correct intervals 357 without needing heavy resources (consider running on a single thread, no need for multiple 358 ones either). To start a `geth` instance for mining, run it with all your usual flags, extended 359 by: 360 361 ```shell 362 $ geth <usual-flags> --mine --miner.threads=1 --miner.etherbase=0x0000000000000000000000000000000000000000 363 ``` 364 365 Which will start mining blocks and transactions on a single CPU thread, crediting all 366 proceedings to the account specified by `--miner.etherbase`. You can further tune the mining 367 by changing the default gas limit blocks converge to (`--miner.targetgaslimit`) and the price 368 transactions are accepted at (`--miner.gasprice`). 369 370 ## Contribution 371 372 Thank you for considering to help out with the source code! We welcome contributions 373 from anyone on the internet, and are grateful for even the smallest of fixes! 374 375 If you'd like to contribute to go-ethereum, please fork, fix, commit and send a pull request 376 for the maintainers to review and merge into the main code base. If you wish to submit 377 more complex changes though, please check up with the core devs first on [our Discord Server](https://discord.gg/invite/nthXNEv) 378 to ensure those changes are in line with the general philosophy of the project and/or get 379 some early feedback which can make both your efforts much lighter as well as our review 380 and merge procedures quick and simple. 381 382 Please make sure your contributions adhere to our coding guidelines: 383 384 * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) 385 guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). 386 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) 387 guidelines. 388 * Pull requests need to be based on and opened against the `master` branch. 389 * Commit messages should be prefixed with the package(s) they modify. 390 * E.g. "eth, rpc: make trace configs optional" 391 392 Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide) 393 for more details on configuring your environment, managing project dependencies, and 394 testing procedures. 395 396 ## License 397 398 The go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the 399 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), 400 also included in our repository in the `COPYING.LESSER` file. 401 402 The go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the 403 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also 404 included in our repository in the `COPYING` file.