github.com/bloxroute-labs/bor@v0.1.4/README.md (about) 1 ## Go Ethereum 2 3 Official Golang implementation of the Ethereum protocol. 4 5 [](https://godoc.org/github.com/maticnetwork/bor) 6 [](https://goreportcard.com/report/github.com/maticnetwork/bor) 7 [](https://travis-ci.org/ethereum/go-ethereum) 8 [](https://discord.gg/nthXNEv) 9 10 Automated builds are available for stable releases and the unstable master branch. Binary 11 archives are published at https://geth.ethereum.org/downloads/. 12 13 ## Building the source 14 15 For prerequisites and detailed build instructions please read the [Installation Instructions](https://github.com/maticnetwork/bor/wiki/Building-Ethereum) on the wiki. 16 17 Building `bor` requires both a Go (version 1.10 or later) and a C compiler. You can install 18 them using your favourite package manager. Once the dependencies are installed, run 19 20 ```shell 21 make bor 22 ``` 23 24 or, to build the full suite of utilities: 25 26 ```shell 27 make all 28 ``` 29 30 ## Executables 31 32 The go-ethereum project comes with several wrappers/executables found in the `cmd` 33 directory. 34 35 | Command | Description | 36 | :-----------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | 37 | **`bor`** | 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/maticnetwork/bor/wiki/Command-Line-Options) for command line options. | 38 | `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/maticnetwork/bor/wiki/Native-DApps:-Go-bindings-to-Ethereum-contracts) wiki page for details. | 39 | `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. | 40 | `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`). | 41 | `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. | 42 | `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`). | 43 | `puppeth` | a CLI wizard that aids in creating a new Ethereum network. | 44 45 ## Running `bor` 46 47 Going through all the possible command line flags is out of scope here (please consult our 48 [CLI Wiki page](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options)), 49 but we've enumerated a few common parameter combos to get you up to speed quickly 50 on how you can run your own `bor` instance. 51 52 ### Full node on the main Ethereum network 53 54 By far the most common scenario is people wanting to simply interact with the Ethereum 55 network: create accounts; transfer funds; deploy and interact with contracts. For this 56 particular use-case the user doesn't care about years-old historical data, so we can 57 fast-sync quickly to the current state of the network. To do so: 58 59 ```shell 60 $ geth console 61 ``` 62 63 This command will: 64 65 - Start `geth` in fast sync mode (default, can be changed with the `--syncmode` flag), 66 causing it to download more data in exchange for avoiding processing the entire history 67 of the Ethereum network, which is very CPU intensive. 68 - Start up `geth`'s built-in interactive [JavaScript console](https://github.com/ethereum/go-ethereum/wiki/JavaScript-Console), 69 (via the trailing `console` subcommand) through which you can invoke all official [`web3` methods](https://github.com/ethereum/wiki/wiki/JavaScript-API) 70 as well as `geth`'s own [management APIs](https://github.com/ethereum/go-ethereum/wiki/Management-APIs). 71 This tool is optional and if you leave it out you can always attach to an already running 72 `geth` instance with `geth attach`. 73 74 ### A Full node on the Ethereum test network 75 76 Transitioning towards developers, if you'd like to play around with creating Ethereum 77 contracts, you almost certainly would like to do that without any real money involved until 78 you get the hang of the entire system. In other words, instead of attaching to the main 79 network, you want to join the **test** network with your node, which is fully equivalent to 80 the main network, but with play-Ether only. 81 82 ```shell 83 $ geth --testnet console 84 ``` 85 86 The `console` subcommand has the exact same meaning as above and they are equally 87 useful on the testnet too. Please see above for their explanations if you've skipped here. 88 89 Specifying the `--testnet` flag, however, will reconfigure your `geth` instance a bit: 90 91 - Instead of using the default data directory (`~/.ethereum` on Linux for example), `geth` 92 will nest itself one level deeper into a `testnet` subfolder (`~/.ethereum/testnet` on 93 Linux). Note, on OSX and Linux this also means that attaching to a running testnet node 94 requires the use of a custom endpoint since `geth attach` will try to attach to a 95 production node endpoint by default. E.g. 96 `geth attach <datadir>/testnet/bor.ipc`. Windows users are not affected by 97 this. 98 - Instead of connecting the main Ethereum network, the client will connect to the test 99 network, which uses different P2P bootnodes, different network IDs and genesis states. 100 101 _Note: Although there are some internal protective measures to prevent transactions from 102 crossing over between the main network and test network, you should make sure to always 103 use separate accounts for play-money and real-money. Unless you manually move 104 accounts, `geth` will by default correctly separate the two networks and will not make any 105 accounts available between them._ 106 107 ### Configuration 108 109 As an alternative to passing the numerous flags to the `bor` binary, you can also pass a 110 configuration file via: 111 112 ```shell 113 $ bor --config /path/to/your_config.toml 114 ``` 115 116 To get an idea how the file should look like you can use the `dumpconfig` subcommand to 117 export your existing configuration: 118 119 ```shell 120 $ bor --your-favourite-flags dumpconfig 121 ``` 122 123 _Note: This works only with `geth` v1.6.0 and above._ 124 125 ### Programmatically interfacing `bor` nodes 126 127 As a developer, sooner rather than later you'll want to start interacting with `geth` and the 128 Ethereum network via your own programs and not manually through the console. To aid 129 this, `geth` has built-in support for a JSON-RPC based APIs ([standard APIs](https://github.com/ethereum/wiki/wiki/JSON-RPC) 130 and [`bor` specific APIs](https://github.com/maticnetwork/bor/wiki/Management-APIs)). 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 `geth`, 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 - `--rpc` Enable the HTTP-RPC server 142 - `--rpcaddr` HTTP-RPC server listening interface (default: `localhost`) 143 - `--rpcport` HTTP-RPC server listening port (default: `8545`) 144 - `--rpcapi` API's offered over the HTTP-RPC interface (default: `eth,net,web3`) 145 - `--rpccorsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 146 - `--ws` Enable the WS-RPC server 147 - `--wsaddr` WS-RPC server listening interface (default: `localhost`) 148 - `--wsport` WS-RPC server listening port (default: `8546`) 149 - `--wsapi` API's offered over the WS-RPC interface (default: `eth,net,web3`) 150 - `--wsorigins` Origins from which to accept websockets requests 151 - `--ipcdisable` Disable the IPC-RPC server 152 - `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,shh,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 `geth` 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 Ethereum 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 ## License 167 168 The bor library (i.e. all code outside of the `cmd` directory) is licensed under the 169 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), 170 also included in our repository in the `COPYING.LESSER` file. 171 172 The bor binaries (i.e. all code inside of the `cmd` directory) is licensed under the 173 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also 174 included in our repository in the `COPYING` file.