github.com/electroneum/electroneum-sc@v0.0.0-20230105223411-3bc1d078281e/README.md (about) 1 # Electroneum Smart Chain 2 3 Electroneum Smart Chain implementation based on go-ethereum. 4 5 Electroneum Smart Chain is EVM-compatible, supports all the existing Ethereum tooling, provides nearly instant transaction verification and 1-block finality with a modified version of the Istanbul Byzantine Fault Torerance (IBFT) consensus protocol. 6 7 ## Key Features 8 9 ### IBFT Consensus Protocol 10 11 Electroneum Smart Chain implements a modified version of the standard IBFT proof of authority consensus protocol, making it the perfect consensus algorithm for public blockchains with a consortium of publicly-known validators participating in the block creation. Existing validators propose and vote to add or remove validators through our on-chain voting system. 12 13 This state-of-the-art consensus protocol features: 14 15 - **Immediate Finality:** blocks are final, meaning there are no forks or concurrent alt-chains, and valid blocks must be in the main chain 16 - **Nearly Instant Confirmations:** blocks are created every 5 seconds 17 - **Dynamic Validator Set:** validators can be added or removed from the network by an on-chain voting mechanism 18 - **Optimal Byzantine Resilience:** the protocol can withstand up to `(n-1)/3` Byzantine validators, where 19 `n` is the number of validators 20 21 ### EVM-Compatible 22 23 Electroneum Smart Chain supports all the existing Ethereum tooling, smart contracts, decentralized applications and regular applications based on the Ethereum JSON RPC, such as MetaMask. 24 25 ### Cross-chain Bridge 26 27 Electroneum Smart Chain supports cross-chain transfers between our legacy Electroneum Blockchain and the Smart Chain. All users, exchanges and other services providers can seemlessly transfer their funds over to the Electroneum Smart Chain, free of charge. 28 29 30 ## Building the source 31 32 For prerequisites and detailed build instructions please read the [Installation Instructions](https://github.com/electroneum/electroneum-sc/wiki/Install-and-Build). 33 34 Building `etn-sc` requires both a Go (version 1.16 or later) and a C compiler. You can install 35 them using your favourite package manager. Once the dependencies are installed, run 36 37 ```shell 38 make etn-sc 39 ``` 40 41 or, to build the full suite of utilities: 42 43 ```shell 44 make all 45 ``` 46 47 ## Executables 48 49 The electroneum-sc project comes with several wrappers/executables found in the `cmd` 50 directory. 51 52 | Command | Description | 53 | :-----------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | 54 | **`etn-sc`** | Our main Electroneum Smart Chain CLI client. It is the entry point into the Electroneum-SC 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 Electroneum-SC network via JSON RPC endpoints exposed on top of HTTP, WebSocket and/or IPC transports. `etn-sc --help` and the [CLI page](https://geth.ethereum.org/docs/interface/command-line-options) for command line options. | 55 | `clef` | Stand-alone signing tool, which can be used as a backend signer for `etn-sc`. | 56 | `devp2p` | Utilities to interact with nodes on the networking layer, without running a full blockchain. | 57 | `abigen` | Source code generator to convert Electroneum 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. | 58 | `bootnode` | Stripped down version of our Electroneum-SC 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. | 59 | `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`). | 60 | `rlpdump` | Developer utility tool to convert binary RLP ([Recursive Length Prefix](https://eth.wiki/en/fundamentals/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`). | 61 | `puppeth` | a CLI wizard that aids in creating a new Electroneum-SC network. | 62 63 ## Running `etn-sc` 64 65 Going through all the possible command line flags is out of scope here (please consult our 66 [CLI Wiki page](https://geth.ethereum.org/docs/interface/command-line-options)), 67 but we've enumerated a few common parameter combos to get you up to speed quickly 68 on how you can run your own `etn-sc` instance. 69 70 ### Hardware Requirements 71 72 Minimum: 73 74 * CPU with 2+ cores 75 * 4GB RAM 76 * 8 MBit/sec download Internet service 77 78 Recommended: 79 80 * Fast CPU with 4+ cores 81 * 16GB+ RAM 82 * High Performance SSD 83 * 25+ MBit/sec download Internet service 84 85 ### Full node on the main Electroneum Smart Chain network 86 87 By far the most common scenario is people wanting to simply interact with the Electroneum Smart Chain 88 network: create accounts; transfer funds; deploy and interact with contracts. For this 89 particular use-case the user doesn't care about years-old historical data, so we can 90 sync quickly to the current state of the network. To do so: 91 92 ```shell 93 $ etn-sc console 94 ``` 95 96 This command will: 97 * Start `etn-sc` in snap sync mode (default, can be changed with the `--syncmode` flag), 98 causing it to download more data in exchange for avoiding processing the entire history 99 of the Electroneum Smart Chain network, which is very CPU intensive. 100 * Start up `etn-sc`'s built-in interactive [JavaScript console](https://geth.ethereum.org/docs/interface/javascript-console), 101 (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) 102 (note: the `web3` version bundled within `etn-sc` is very old, and not up to date with official docs), 103 as well as `etn-sc`'s own [management APIs](https://geth.ethereum.org/docs/rpc/server). 104 This tool is optional and if you leave it out you can always attach to an already running 105 `etn-sc` instance with `etn-sc attach`. 106 107 ### Full node on the test network 108 109 Transitioning towards developers, if you'd like to play around with creating Electroneum 110 contracts, you almost certainly would like to do that without any real cryptocurrency involved until 111 you get the hang of the entire system. In other words, instead of attaching to the main 112 network, you want to join the **test** network with your node, which is fully equivalent to 113 the main network, but with play-ETN only. 114 115 ```shell 116 $ etn-sc --testnet console 117 ``` 118 119 The `console` subcommand has the exact same meaning as above and they are equally 120 useful on the testnet too. Please, see above for their explanations if you've skipped here. 121 122 Specifying the `--testnet` flag, however, will reconfigure your `etn-sc` instance a bit: 123 124 * Instead of connecting the main Electroneum Smart Chain network, the client will connect to the test network, which uses different P2P bootnodes, different network IDs and genesis 125 states. 126 * Instead of using the default data directory (`~/.electroneum` on Linux for example), `etn-sc` 127 will nest itself one level deeper into a `testnet` subfolder (`~/.ethereum/testnet` on 128 Linux). Note, on OSX and Linux this also means that attaching to a running testnet node 129 requires the use of a custom endpoint since `etn-sc attach` will try to attach to a 130 production node endpoint by default, e.g., 131 `etn-sc attach <datadir>/testnet/etn-sc.ipc`. Windows users are not affected by 132 this. 133 134 *Note: Although there are some internal protective measures to prevent transactions from 135 crossing over between the main network and test network, you should make sure to always 136 use separate accounts for play-cryptocurrency and real-cryptocurrency. Unless you manually move 137 accounts, `etn-sc` will by default correctly separate the two networks and will not make any 138 accounts available between them.* 139 140 ### Configuration 141 142 As an alternative to passing the numerous flags to the `etn-sc` binary, you can also pass a 143 configuration file via: 144 145 ```shell 146 $ etn-sc --config /path/to/your_config.toml 147 ``` 148 149 To get an idea how the file should look like you can use the `dumpconfig` subcommand to 150 export your existing configuration: 151 152 ```shell 153 $ etn-sc --your-favourite-flags dumpconfig 154 ``` 155 ### Docker quick start 156 157 One of the quickest ways to get Electroneum Smart Chain up and running on your machine is by using 158 Docker: 159 160 ```shell 161 docker run -d --name etn-sc-node -v /Users/alice/electroneum:/root \ 162 -p 8545:8545 -p 30303:30303 \ 163 electroneum/client-go 164 ``` 165 166 This will start `etn-sc` in snap-sync mode with a DB memory allowance of 1GB just as the 167 above command does. It will also create a persistent volume in your home directory for 168 saving your blockchain as well as map the default ports. There is also an `alpine` tag 169 available for a slim version of the image. 170 171 Do not forget `--http.addr 0.0.0.0`, if you want to access RPC from other containers 172 and/or hosts. By default, `etn-sc` binds to the local interface and RPC endpoints are not 173 accessible from the outside. 174 175 ### Programmatically interfacing `etn-sc` nodes 176 177 As a developer, sooner rather than later you'll want to start interacting with `etn-sc` and the 178 Electroneum Smart Chain network via your own programs and not manually through the console. To aid 179 this, `etn-sc` has built-in support for a JSON-RPC based APIs ([standard APIs](https://eth.wiki/json-rpc/API) 180 and [`etn-sc` specific APIs](https://geth.ethereum.org/docs/rpc/server)). 181 These can be exposed via HTTP, WebSockets and IPC (UNIX sockets on UNIX based 182 platforms, and named pipes on Windows). 183 184 The IPC interface is enabled by default and exposes all the APIs supported by `etn-sc`, 185 whereas the HTTP and WS interfaces need to manually be enabled and only expose a 186 subset of APIs due to security reasons. These can be turned on/off and configured as 187 you'd expect. 188 189 HTTP based JSON-RPC API options: 190 191 * `--http` Enable the HTTP-RPC server 192 * `--http.addr` HTTP-RPC server listening interface (default: `localhost`) 193 * `--http.port` HTTP-RPC server listening port (default: `8545`) 194 * `--http.api` API's offered over the HTTP-RPC interface (default: `eth,net,web3`) 195 * `--http.corsdomain` Comma separated list of domains from which to accept cross origin requests (browser enforced) 196 * `--ws` Enable the WS-RPC server 197 * `--ws.addr` WS-RPC server listening interface (default: `localhost`) 198 * `--ws.port` WS-RPC server listening port (default: `8546`) 199 * `--ws.api` API's offered over the WS-RPC interface (default: `eth,net,web3`) 200 * `--ws.origins` Origins from which to accept websockets requests 201 * `--ipcdisable` Disable the IPC-RPC server 202 * `--ipcapi` API's offered over the IPC-RPC interface (default: `admin,debug,eth,miner,net,personal,shh,txpool,web3`) 203 * `--ipcpath` Filename for IPC socket/pipe within the datadir (explicit paths escape it) 204 205 You'll need to use your own programming environments' capabilities (libraries, tools, etc) to 206 connect via HTTP, WS or IPC to a `etn-sc` node configured with the above flags and you'll 207 need to speak [JSON-RPC](https://www.jsonrpc.org/specification) on all transports. You 208 can reuse the same connection for multiple requests! 209 210 **Note: Please understand the security implications of opening up an HTTP/WS based 211 transport before doing so! Hackers on the internet are actively trying to subvert 212 Electroneum nodes with exposed APIs! Further, all browser tabs can access locally 213 running web servers, so malicious web pages could try to subvert locally available 214 APIs!** 215 216 ## Contribution 217 218 Thank you for considering to help out with the source code! We welcome contributions 219 from anyone on the internet, and are grateful for even the smallest of fixes! 220 221 If you'd like to contribute to electroneum-sc, please fork, fix, commit and send a pull request 222 for the maintainers to review and merge into the main code base. If you wish to submit 223 more complex changes though, please check up with the core devs first on [our Discord Server](https://discord.gg/invite/nthXNEv) 224 to ensure those changes are in line with the general philosophy of the project and/or get 225 some early feedback which can make both your efforts much lighter as well as our review 226 and merge procedures quick and simple. 227 228 Please make sure your contributions adhere to our coding guidelines: 229 230 * Code must adhere to the official Go [formatting](https://golang.org/doc/effective_go.html#formatting) 231 guidelines (i.e. uses [gofmt](https://golang.org/cmd/gofmt/)). 232 * Code must be documented adhering to the official Go [commentary](https://golang.org/doc/effective_go.html#commentary) 233 guidelines. 234 * Pull requests need to be based on and opened against the `master` branch. 235 * Commit messages should be prefixed with the package(s) they modify. 236 * E.g. "etn, rpc: make trace configs optional" 237 238 Please see the [Developers' Guide](https://geth.ethereum.org/docs/developers/devguide) 239 for more details on configuring your environment, managing project dependencies, and 240 testing procedures. 241 242 ## License 243 244 The electroneum-sc and go-ethereum library (i.e. all code outside of the `cmd` directory) is licensed under the 245 [GNU Lesser General Public License v3.0](https://www.gnu.org/licenses/lgpl-3.0.en.html), 246 also included in our repository in the `COPYING.LESSER` file. 247 248 The electroneum-sc and go-ethereum binaries (i.e. all code inside of the `cmd` directory) is licensed under the 249 [GNU General Public License v3.0](https://www.gnu.org/licenses/gpl-3.0.en.html), also 250 included in our repository in the `COPYING` file.