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